problem_id
stringlengths 18
22
| source
stringclasses 1
value | task_type
stringclasses 1
value | in_source_id
stringlengths 13
58
| prompt
stringlengths 1.1k
25.4k
| golden_diff
stringlengths 145
5.13k
| verification_info
stringlengths 582
39.1k
| num_tokens
int64 271
4.1k
| num_tokens_diff
int64 47
1.02k
|
|---|---|---|---|---|---|---|---|---|
gh_patches_debug_56500
|
rasdani/github-patches
|
git_diff
|
canonical__microk8s-2048
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Microk8s on armhf architecture
Hi all,
The armhf binary is missing and not available right now, which means that some users cannot install microk8s on Ubuntu. For example, if you use the armhf image for Raspberry Pi, you cannot install microk8s:
> ubuntu@battlecruiser:~$ sudo snap install microk8s --classic
> error: snap "microk8s" is not available on stable for this architecture (armhf)
> but exists on other architectures (amd64, arm64, ppc64el).
It would be really good if we could also get the build compiled for this architecture and make officially available.
Cheers,
- Calvin
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `scripts/wrappers/common/utils.py`
Content:
```
1 import getpass
2 import json
3 import os
4 import platform
5 import subprocess
6 import sys
7 import time
8 from pathlib import Path
9
10 import click
11 import yaml
12
13 kubeconfig = "--kubeconfig=" + os.path.expandvars("${SNAP_DATA}/credentials/client.config")
14
15
16 def get_current_arch():
17 # architecture mapping
18 arch_mapping = {"aarch64": "arm64", "x86_64": "amd64"}
19
20 return arch_mapping[platform.machine()]
21
22
23 def snap_data() -> Path:
24 try:
25 return Path(os.environ["SNAP_DATA"])
26 except KeyError:
27 return Path("/var/snap/microk8s/current")
28
29
30 def run(*args, die=True):
31 # Add wrappers to $PATH
32 env = os.environ.copy()
33 env["PATH"] += ":%s" % os.environ["SNAP"]
34 result = subprocess.run(
35 args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env
36 )
37
38 try:
39 result.check_returncode()
40 except subprocess.CalledProcessError as err:
41 if die:
42 if result.stderr:
43 print(result.stderr.decode("utf-8"))
44 print(err)
45 sys.exit(1)
46 else:
47 raise
48
49 return result.stdout.decode("utf-8")
50
51
52 def is_cluster_ready():
53 try:
54 service_output = kubectl_get("all")
55 node_output = kubectl_get("nodes")
56 # Make sure to compare with the word " Ready " with spaces.
57 if " Ready " in node_output and "service/kubernetes" in service_output:
58 return True
59 else:
60 return False
61 except Exception:
62 return False
63
64
65 def is_ha_enabled():
66 ha_lock = os.path.expandvars("${SNAP_DATA}/var/lock/ha-cluster")
67 return os.path.isfile(ha_lock)
68
69
70 def get_dqlite_info():
71 cluster_dir = os.path.expandvars("${SNAP_DATA}/var/kubernetes/backend")
72 snap_path = os.environ.get("SNAP")
73
74 info = []
75
76 if not is_ha_enabled():
77 return info
78
79 waits = 10
80 while waits > 0:
81 try:
82 with open("{}/info.yaml".format(cluster_dir), mode="r") as f:
83 data = yaml.load(f, Loader=yaml.FullLoader)
84 out = subprocess.check_output(
85 "{snappath}/bin/dqlite -s file://{dbdir}/cluster.yaml -c {dbdir}/cluster.crt "
86 "-k {dbdir}/cluster.key -f json k8s .cluster".format(
87 snappath=snap_path, dbdir=cluster_dir
88 ).split(),
89 timeout=4,
90 )
91 if data["Address"] in out.decode():
92 break
93 else:
94 time.sleep(5)
95 waits -= 1
96 except (subprocess.CalledProcessError, subprocess.TimeoutExpired):
97 time.sleep(2)
98 waits -= 1
99
100 if waits == 0:
101 return info
102
103 nodes = json.loads(out.decode())
104 for n in nodes:
105 if n["Role"] == 0:
106 info.append((n["Address"], "voter"))
107 if n["Role"] == 1:
108 info.append((n["Address"], "standby"))
109 if n["Role"] == 2:
110 info.append((n["Address"], "spare"))
111 return info
112
113
114 def is_cluster_locked():
115 if (snap_data() / "var/lock/clustered.lock").exists():
116 click.echo("This MicroK8s deployment is acting as a node in a cluster.")
117 click.echo("Please use the master node.")
118 sys.exit(1)
119
120
121 def wait_for_ready(timeout):
122 start_time = time.time()
123
124 while True:
125 if is_cluster_ready():
126 return True
127 elif timeout and time.time() > start_time + timeout:
128 return False
129 else:
130 time.sleep(2)
131
132
133 def exit_if_stopped():
134 stoppedLockFile = os.path.expandvars("${SNAP_DATA}/var/lock/stopped.lock")
135 if os.path.isfile(stoppedLockFile):
136 print("microk8s is not running, try microk8s start")
137 exit(0)
138
139
140 def exit_if_no_permission():
141 user = getpass.getuser()
142 # test if we can access the default kubeconfig
143 clientConfigFile = os.path.expandvars("${SNAP_DATA}/credentials/client.config")
144 if not os.access(clientConfigFile, os.R_OK):
145 print("Insufficient permissions to access MicroK8s.")
146 print(
147 "You can either try again with sudo or add the user {} to the 'microk8s' group:".format(
148 user
149 )
150 )
151 print("")
152 print(" sudo usermod -a -G microk8s {}".format(user))
153 print(" sudo chown -f -R $USER ~/.kube")
154 print("")
155 print(
156 "After this, reload the user groups either via a reboot or by running 'newgrp microk8s'."
157 )
158 exit(1)
159
160
161 def ensure_started():
162 if (snap_data() / "var/lock/stopped.lock").exists():
163 click.echo("microk8s is not running, try microk8s start", err=True)
164 sys.exit(1)
165
166
167 def kubectl_get(cmd, namespace="--all-namespaces"):
168 if namespace == "--all-namespaces":
169 return run("kubectl", kubeconfig, "get", cmd, "--all-namespaces", die=False)
170 else:
171 return run("kubectl", kubeconfig, "get", cmd, "-n", namespace, die=False)
172
173
174 def kubectl_get_clusterroles():
175 return run(
176 "kubectl", kubeconfig, "get", "clusterroles", "--show-kind", "--no-headers", die=False
177 )
178
179
180 def get_available_addons(arch):
181 addon_dataset = os.path.expandvars("${SNAP}/addon-lists.yaml")
182 available = []
183 with open(addon_dataset, "r") as file:
184 # The FullLoader parameter handles the conversion from YAML
185 # scalar values to Python the dictionary format
186 addons = yaml.load(file, Loader=yaml.FullLoader)
187 for addon in addons["microk8s-addons"]["addons"]:
188 if arch in addon["supported_architectures"]:
189 available.append(addon)
190
191 available = sorted(available, key=lambda k: k["name"])
192 return available
193
194
195 def get_addon_by_name(addons, name):
196 filtered_addon = []
197 for addon in addons:
198 if name == addon["name"]:
199 filtered_addon.append(addon)
200 return filtered_addon
201
202
203 def is_service_expected_to_start(service):
204 """
205 Check if a service is supposed to start
206 :param service: the service name
207 :return: True if the service is meant to start
208 """
209 lock_path = os.path.expandvars("${SNAP_DATA}/var/lock")
210 lock = "{}/{}".format(lock_path, service)
211 return os.path.exists(lock_path) and not os.path.isfile(lock)
212
213
214 def set_service_expected_to_start(service, start=True):
215 """
216 Check if a service is not expected to start.
217 :param service: the service name
218 :param start: should the service start or not
219 """
220 lock_path = os.path.expandvars("${SNAP_DATA}/var/lock")
221 lock = "{}/{}".format(lock_path, service)
222 if start:
223 os.remove(lock)
224 else:
225 fd = os.open(lock, os.O_CREAT, mode=0o700)
226 os.close(fd)
227
228
229 def check_help_flag(addons: list) -> bool:
230 """Checks to see if a help message needs to be printed for an addon.
231
232 Not all addons check for help flags themselves. Until they do, intercept
233 calls to print help text and print out a generic message to that effect.
234 """
235 addon = addons[0]
236 if any(arg in addons for arg in ("-h", "--help")) and addon != "kubeflow":
237 print("Addon %s does not yet have a help message." % addon)
238 print("For more information about it, visit https://microk8s.io/docs/addons")
239 return True
240 return False
241
242
243 def xable(action: str, addons: list, xabled_addons: list):
244 """Enables or disables the given addons.
245
246 Collated into a single function since the logic is identical other than
247 the script names.
248 """
249 actions = Path(__file__).absolute().parent / "../../../actions"
250 existing_addons = {sh.with_suffix("").name[7:] for sh in actions.glob("enable.*.sh")}
251
252 # Backwards compatibility with enabling multiple addons at once, e.g.
253 # `microk8s.enable foo bar:"baz"`
254 if all(a.split(":")[0] in existing_addons for a in addons) and len(addons) > 1:
255 for addon in addons:
256 if addon in xabled_addons and addon != "kubeflow":
257 click.echo("Addon %s is already %sd." % (addon, action))
258 else:
259 addon, *args = addon.split(":")
260 wait_for_ready(timeout=30)
261 p = subprocess.run([str(actions / ("%s.%s.sh" % (action, addon)))] + args)
262 if p.returncode:
263 sys.exit(p.returncode)
264 wait_for_ready(timeout=30)
265
266 # The new way of xabling addons, that allows for unix-style argument passing,
267 # such as `microk8s.enable foo --bar`.
268 else:
269 addon, *args = addons[0].split(":")
270
271 if addon in xabled_addons and addon != "kubeflow":
272 click.echo("Addon %s is already %sd." % (addon, action))
273 sys.exit(0)
274
275 if addon not in existing_addons:
276 click.echo("Nothing to do for `%s`." % addon, err=True)
277 sys.exit(1)
278
279 if args and addons[1:]:
280 click.echo(
281 "Can't pass string arguments and flag arguments simultaneously!\n"
282 "{0} an addon with only one argument style at a time:\n"
283 "\n"
284 " microk8s {1} foo:'bar'\n"
285 "or\n"
286 " microk8s {1} foo --bar\n".format(action.title(), action)
287 )
288 sys.exit(1)
289
290 wait_for_ready(timeout=30)
291 script = [str(actions / ("%s.%s.sh" % (action, addon)))]
292 if args:
293 p = subprocess.run(script + args)
294 else:
295 p = subprocess.run(script + list(addons[1:]))
296
297 if p.returncode:
298 sys.exit(p.returncode)
299
300 wait_for_ready(timeout=30)
301
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/scripts/wrappers/common/utils.py b/scripts/wrappers/common/utils.py
--- a/scripts/wrappers/common/utils.py
+++ b/scripts/wrappers/common/utils.py
@@ -15,7 +15,7 @@
def get_current_arch():
# architecture mapping
- arch_mapping = {"aarch64": "arm64", "x86_64": "amd64"}
+ arch_mapping = {"aarch64": "arm64", "armv7l": "armhf", "x86_64": "amd64"}
return arch_mapping[platform.machine()]
|
{"golden_diff": "diff --git a/scripts/wrappers/common/utils.py b/scripts/wrappers/common/utils.py\n--- a/scripts/wrappers/common/utils.py\n+++ b/scripts/wrappers/common/utils.py\n@@ -15,7 +15,7 @@\n \n def get_current_arch():\n # architecture mapping\n- arch_mapping = {\"aarch64\": \"arm64\", \"x86_64\": \"amd64\"}\n+ arch_mapping = {\"aarch64\": \"arm64\", \"armv7l\": \"armhf\", \"x86_64\": \"amd64\"}\n \n return arch_mapping[platform.machine()]\n", "issue": "Microk8s on armhf architecture\nHi all, \r\n\r\nThe armhf binary is missing and not available right now, which means that some users cannot install microk8s on Ubuntu. For example, if you use the armhf image for Raspberry Pi, you cannot install microk8s: \r\n\r\n> ubuntu@battlecruiser:~$ sudo snap install microk8s --classic\r\n> error: snap \"microk8s\" is not available on stable for this architecture (armhf)\r\n> but exists on other architectures (amd64, arm64, ppc64el).\r\n\r\nIt would be really good if we could also get the build compiled for this architecture and make officially available. \r\n\r\nCheers,\r\n\r\n- Calvin \n", "before_files": [{"content": "import getpass\nimport json\nimport os\nimport platform\nimport subprocess\nimport sys\nimport time\nfrom pathlib import Path\n\nimport click\nimport yaml\n\nkubeconfig = \"--kubeconfig=\" + os.path.expandvars(\"${SNAP_DATA}/credentials/client.config\")\n\n\ndef get_current_arch():\n # architecture mapping\n arch_mapping = {\"aarch64\": \"arm64\", \"x86_64\": \"amd64\"}\n\n return arch_mapping[platform.machine()]\n\n\ndef snap_data() -> Path:\n try:\n return Path(os.environ[\"SNAP_DATA\"])\n except KeyError:\n return Path(\"/var/snap/microk8s/current\")\n\n\ndef run(*args, die=True):\n # Add wrappers to $PATH\n env = os.environ.copy()\n env[\"PATH\"] += \":%s\" % os.environ[\"SNAP\"]\n result = subprocess.run(\n args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env\n )\n\n try:\n result.check_returncode()\n except subprocess.CalledProcessError as err:\n if die:\n if result.stderr:\n print(result.stderr.decode(\"utf-8\"))\n print(err)\n sys.exit(1)\n else:\n raise\n\n return result.stdout.decode(\"utf-8\")\n\n\ndef is_cluster_ready():\n try:\n service_output = kubectl_get(\"all\")\n node_output = kubectl_get(\"nodes\")\n # Make sure to compare with the word \" Ready \" with spaces.\n if \" Ready \" in node_output and \"service/kubernetes\" in service_output:\n return True\n else:\n return False\n except Exception:\n return False\n\n\ndef is_ha_enabled():\n ha_lock = os.path.expandvars(\"${SNAP_DATA}/var/lock/ha-cluster\")\n return os.path.isfile(ha_lock)\n\n\ndef get_dqlite_info():\n cluster_dir = os.path.expandvars(\"${SNAP_DATA}/var/kubernetes/backend\")\n snap_path = os.environ.get(\"SNAP\")\n\n info = []\n\n if not is_ha_enabled():\n return info\n\n waits = 10\n while waits > 0:\n try:\n with open(\"{}/info.yaml\".format(cluster_dir), mode=\"r\") as f:\n data = yaml.load(f, Loader=yaml.FullLoader)\n out = subprocess.check_output(\n \"{snappath}/bin/dqlite -s file://{dbdir}/cluster.yaml -c {dbdir}/cluster.crt \"\n \"-k {dbdir}/cluster.key -f json k8s .cluster\".format(\n snappath=snap_path, dbdir=cluster_dir\n ).split(),\n timeout=4,\n )\n if data[\"Address\"] in out.decode():\n break\n else:\n time.sleep(5)\n waits -= 1\n except (subprocess.CalledProcessError, subprocess.TimeoutExpired):\n time.sleep(2)\n waits -= 1\n\n if waits == 0:\n return info\n\n nodes = json.loads(out.decode())\n for n in nodes:\n if n[\"Role\"] == 0:\n info.append((n[\"Address\"], \"voter\"))\n if n[\"Role\"] == 1:\n info.append((n[\"Address\"], \"standby\"))\n if n[\"Role\"] == 2:\n info.append((n[\"Address\"], \"spare\"))\n return info\n\n\ndef is_cluster_locked():\n if (snap_data() / \"var/lock/clustered.lock\").exists():\n click.echo(\"This MicroK8s deployment is acting as a node in a cluster.\")\n click.echo(\"Please use the master node.\")\n sys.exit(1)\n\n\ndef wait_for_ready(timeout):\n start_time = time.time()\n\n while True:\n if is_cluster_ready():\n return True\n elif timeout and time.time() > start_time + timeout:\n return False\n else:\n time.sleep(2)\n\n\ndef exit_if_stopped():\n stoppedLockFile = os.path.expandvars(\"${SNAP_DATA}/var/lock/stopped.lock\")\n if os.path.isfile(stoppedLockFile):\n print(\"microk8s is not running, try microk8s start\")\n exit(0)\n\n\ndef exit_if_no_permission():\n user = getpass.getuser()\n # test if we can access the default kubeconfig\n clientConfigFile = os.path.expandvars(\"${SNAP_DATA}/credentials/client.config\")\n if not os.access(clientConfigFile, os.R_OK):\n print(\"Insufficient permissions to access MicroK8s.\")\n print(\n \"You can either try again with sudo or add the user {} to the 'microk8s' group:\".format(\n user\n )\n )\n print(\"\")\n print(\" sudo usermod -a -G microk8s {}\".format(user))\n print(\" sudo chown -f -R $USER ~/.kube\")\n print(\"\")\n print(\n \"After this, reload the user groups either via a reboot or by running 'newgrp microk8s'.\"\n )\n exit(1)\n\n\ndef ensure_started():\n if (snap_data() / \"var/lock/stopped.lock\").exists():\n click.echo(\"microk8s is not running, try microk8s start\", err=True)\n sys.exit(1)\n\n\ndef kubectl_get(cmd, namespace=\"--all-namespaces\"):\n if namespace == \"--all-namespaces\":\n return run(\"kubectl\", kubeconfig, \"get\", cmd, \"--all-namespaces\", die=False)\n else:\n return run(\"kubectl\", kubeconfig, \"get\", cmd, \"-n\", namespace, die=False)\n\n\ndef kubectl_get_clusterroles():\n return run(\n \"kubectl\", kubeconfig, \"get\", \"clusterroles\", \"--show-kind\", \"--no-headers\", die=False\n )\n\n\ndef get_available_addons(arch):\n addon_dataset = os.path.expandvars(\"${SNAP}/addon-lists.yaml\")\n available = []\n with open(addon_dataset, \"r\") as file:\n # The FullLoader parameter handles the conversion from YAML\n # scalar values to Python the dictionary format\n addons = yaml.load(file, Loader=yaml.FullLoader)\n for addon in addons[\"microk8s-addons\"][\"addons\"]:\n if arch in addon[\"supported_architectures\"]:\n available.append(addon)\n\n available = sorted(available, key=lambda k: k[\"name\"])\n return available\n\n\ndef get_addon_by_name(addons, name):\n filtered_addon = []\n for addon in addons:\n if name == addon[\"name\"]:\n filtered_addon.append(addon)\n return filtered_addon\n\n\ndef is_service_expected_to_start(service):\n \"\"\"\n Check if a service is supposed to start\n :param service: the service name\n :return: True if the service is meant to start\n \"\"\"\n lock_path = os.path.expandvars(\"${SNAP_DATA}/var/lock\")\n lock = \"{}/{}\".format(lock_path, service)\n return os.path.exists(lock_path) and not os.path.isfile(lock)\n\n\ndef set_service_expected_to_start(service, start=True):\n \"\"\"\n Check if a service is not expected to start.\n :param service: the service name\n :param start: should the service start or not\n \"\"\"\n lock_path = os.path.expandvars(\"${SNAP_DATA}/var/lock\")\n lock = \"{}/{}\".format(lock_path, service)\n if start:\n os.remove(lock)\n else:\n fd = os.open(lock, os.O_CREAT, mode=0o700)\n os.close(fd)\n\n\ndef check_help_flag(addons: list) -> bool:\n \"\"\"Checks to see if a help message needs to be printed for an addon.\n\n Not all addons check for help flags themselves. Until they do, intercept\n calls to print help text and print out a generic message to that effect.\n \"\"\"\n addon = addons[0]\n if any(arg in addons for arg in (\"-h\", \"--help\")) and addon != \"kubeflow\":\n print(\"Addon %s does not yet have a help message.\" % addon)\n print(\"For more information about it, visit https://microk8s.io/docs/addons\")\n return True\n return False\n\n\ndef xable(action: str, addons: list, xabled_addons: list):\n \"\"\"Enables or disables the given addons.\n\n Collated into a single function since the logic is identical other than\n the script names.\n \"\"\"\n actions = Path(__file__).absolute().parent / \"../../../actions\"\n existing_addons = {sh.with_suffix(\"\").name[7:] for sh in actions.glob(\"enable.*.sh\")}\n\n # Backwards compatibility with enabling multiple addons at once, e.g.\n # `microk8s.enable foo bar:\"baz\"`\n if all(a.split(\":\")[0] in existing_addons for a in addons) and len(addons) > 1:\n for addon in addons:\n if addon in xabled_addons and addon != \"kubeflow\":\n click.echo(\"Addon %s is already %sd.\" % (addon, action))\n else:\n addon, *args = addon.split(\":\")\n wait_for_ready(timeout=30)\n p = subprocess.run([str(actions / (\"%s.%s.sh\" % (action, addon)))] + args)\n if p.returncode:\n sys.exit(p.returncode)\n wait_for_ready(timeout=30)\n\n # The new way of xabling addons, that allows for unix-style argument passing,\n # such as `microk8s.enable foo --bar`.\n else:\n addon, *args = addons[0].split(\":\")\n\n if addon in xabled_addons and addon != \"kubeflow\":\n click.echo(\"Addon %s is already %sd.\" % (addon, action))\n sys.exit(0)\n\n if addon not in existing_addons:\n click.echo(\"Nothing to do for `%s`.\" % addon, err=True)\n sys.exit(1)\n\n if args and addons[1:]:\n click.echo(\n \"Can't pass string arguments and flag arguments simultaneously!\\n\"\n \"{0} an addon with only one argument style at a time:\\n\"\n \"\\n\"\n \" microk8s {1} foo:'bar'\\n\"\n \"or\\n\"\n \" microk8s {1} foo --bar\\n\".format(action.title(), action)\n )\n sys.exit(1)\n\n wait_for_ready(timeout=30)\n script = [str(actions / (\"%s.%s.sh\" % (action, addon)))]\n if args:\n p = subprocess.run(script + args)\n else:\n p = subprocess.run(script + list(addons[1:]))\n\n if p.returncode:\n sys.exit(p.returncode)\n\n wait_for_ready(timeout=30)\n", "path": "scripts/wrappers/common/utils.py"}], "after_files": [{"content": "import getpass\nimport json\nimport os\nimport platform\nimport subprocess\nimport sys\nimport time\nfrom pathlib import Path\n\nimport click\nimport yaml\n\nkubeconfig = \"--kubeconfig=\" + os.path.expandvars(\"${SNAP_DATA}/credentials/client.config\")\n\n\ndef get_current_arch():\n # architecture mapping\n arch_mapping = {\"aarch64\": \"arm64\", \"armv7l\": \"armhf\", \"x86_64\": \"amd64\"}\n\n return arch_mapping[platform.machine()]\n\n\ndef snap_data() -> Path:\n try:\n return Path(os.environ[\"SNAP_DATA\"])\n except KeyError:\n return Path(\"/var/snap/microk8s/current\")\n\n\ndef run(*args, die=True):\n # Add wrappers to $PATH\n env = os.environ.copy()\n env[\"PATH\"] += \":%s\" % os.environ[\"SNAP\"]\n result = subprocess.run(\n args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env\n )\n\n try:\n result.check_returncode()\n except subprocess.CalledProcessError as err:\n if die:\n if result.stderr:\n print(result.stderr.decode(\"utf-8\"))\n print(err)\n sys.exit(1)\n else:\n raise\n\n return result.stdout.decode(\"utf-8\")\n\n\ndef is_cluster_ready():\n try:\n service_output = kubectl_get(\"all\")\n node_output = kubectl_get(\"nodes\")\n # Make sure to compare with the word \" Ready \" with spaces.\n if \" Ready \" in node_output and \"service/kubernetes\" in service_output:\n return True\n else:\n return False\n except Exception:\n return False\n\n\ndef is_ha_enabled():\n ha_lock = os.path.expandvars(\"${SNAP_DATA}/var/lock/ha-cluster\")\n return os.path.isfile(ha_lock)\n\n\ndef get_dqlite_info():\n cluster_dir = os.path.expandvars(\"${SNAP_DATA}/var/kubernetes/backend\")\n snap_path = os.environ.get(\"SNAP\")\n\n info = []\n\n if not is_ha_enabled():\n return info\n\n waits = 10\n while waits > 0:\n try:\n with open(\"{}/info.yaml\".format(cluster_dir), mode=\"r\") as f:\n data = yaml.load(f, Loader=yaml.FullLoader)\n out = subprocess.check_output(\n \"{snappath}/bin/dqlite -s file://{dbdir}/cluster.yaml -c {dbdir}/cluster.crt \"\n \"-k {dbdir}/cluster.key -f json k8s .cluster\".format(\n snappath=snap_path, dbdir=cluster_dir\n ).split(),\n timeout=4,\n )\n if data[\"Address\"] in out.decode():\n break\n else:\n time.sleep(5)\n waits -= 1\n except (subprocess.CalledProcessError, subprocess.TimeoutExpired):\n time.sleep(2)\n waits -= 1\n\n if waits == 0:\n return info\n\n nodes = json.loads(out.decode())\n for n in nodes:\n if n[\"Role\"] == 0:\n info.append((n[\"Address\"], \"voter\"))\n if n[\"Role\"] == 1:\n info.append((n[\"Address\"], \"standby\"))\n if n[\"Role\"] == 2:\n info.append((n[\"Address\"], \"spare\"))\n return info\n\n\ndef is_cluster_locked():\n if (snap_data() / \"var/lock/clustered.lock\").exists():\n click.echo(\"This MicroK8s deployment is acting as a node in a cluster.\")\n click.echo(\"Please use the master node.\")\n sys.exit(1)\n\n\ndef wait_for_ready(timeout):\n start_time = time.time()\n\n while True:\n if is_cluster_ready():\n return True\n elif timeout and time.time() > start_time + timeout:\n return False\n else:\n time.sleep(2)\n\n\ndef exit_if_stopped():\n stoppedLockFile = os.path.expandvars(\"${SNAP_DATA}/var/lock/stopped.lock\")\n if os.path.isfile(stoppedLockFile):\n print(\"microk8s is not running, try microk8s start\")\n exit(0)\n\n\ndef exit_if_no_permission():\n user = getpass.getuser()\n # test if we can access the default kubeconfig\n clientConfigFile = os.path.expandvars(\"${SNAP_DATA}/credentials/client.config\")\n if not os.access(clientConfigFile, os.R_OK):\n print(\"Insufficient permissions to access MicroK8s.\")\n print(\n \"You can either try again with sudo or add the user {} to the 'microk8s' group:\".format(\n user\n )\n )\n print(\"\")\n print(\" sudo usermod -a -G microk8s {}\".format(user))\n print(\" sudo chown -f -R $USER ~/.kube\")\n print(\"\")\n print(\n \"After this, reload the user groups either via a reboot or by running 'newgrp microk8s'.\"\n )\n exit(1)\n\n\ndef ensure_started():\n if (snap_data() / \"var/lock/stopped.lock\").exists():\n click.echo(\"microk8s is not running, try microk8s start\", err=True)\n sys.exit(1)\n\n\ndef kubectl_get(cmd, namespace=\"--all-namespaces\"):\n if namespace == \"--all-namespaces\":\n return run(\"kubectl\", kubeconfig, \"get\", cmd, \"--all-namespaces\", die=False)\n else:\n return run(\"kubectl\", kubeconfig, \"get\", cmd, \"-n\", namespace, die=False)\n\n\ndef kubectl_get_clusterroles():\n return run(\n \"kubectl\", kubeconfig, \"get\", \"clusterroles\", \"--show-kind\", \"--no-headers\", die=False\n )\n\n\ndef get_available_addons(arch):\n addon_dataset = os.path.expandvars(\"${SNAP}/addon-lists.yaml\")\n available = []\n with open(addon_dataset, \"r\") as file:\n # The FullLoader parameter handles the conversion from YAML\n # scalar values to Python the dictionary format\n addons = yaml.load(file, Loader=yaml.FullLoader)\n for addon in addons[\"microk8s-addons\"][\"addons\"]:\n if arch in addon[\"supported_architectures\"]:\n available.append(addon)\n\n available = sorted(available, key=lambda k: k[\"name\"])\n return available\n\n\ndef get_addon_by_name(addons, name):\n filtered_addon = []\n for addon in addons:\n if name == addon[\"name\"]:\n filtered_addon.append(addon)\n return filtered_addon\n\n\ndef is_service_expected_to_start(service):\n \"\"\"\n Check if a service is supposed to start\n :param service: the service name\n :return: True if the service is meant to start\n \"\"\"\n lock_path = os.path.expandvars(\"${SNAP_DATA}/var/lock\")\n lock = \"{}/{}\".format(lock_path, service)\n return os.path.exists(lock_path) and not os.path.isfile(lock)\n\n\ndef set_service_expected_to_start(service, start=True):\n \"\"\"\n Check if a service is not expected to start.\n :param service: the service name\n :param start: should the service start or not\n \"\"\"\n lock_path = os.path.expandvars(\"${SNAP_DATA}/var/lock\")\n lock = \"{}/{}\".format(lock_path, service)\n if start:\n os.remove(lock)\n else:\n fd = os.open(lock, os.O_CREAT, mode=0o700)\n os.close(fd)\n\n\ndef check_help_flag(addons: list) -> bool:\n \"\"\"Checks to see if a help message needs to be printed for an addon.\n\n Not all addons check for help flags themselves. Until they do, intercept\n calls to print help text and print out a generic message to that effect.\n \"\"\"\n addon = addons[0]\n if any(arg in addons for arg in (\"-h\", \"--help\")) and addon != \"kubeflow\":\n print(\"Addon %s does not yet have a help message.\" % addon)\n print(\"For more information about it, visit https://microk8s.io/docs/addons\")\n return True\n return False\n\n\ndef xable(action: str, addons: list, xabled_addons: list):\n \"\"\"Enables or disables the given addons.\n\n Collated into a single function since the logic is identical other than\n the script names.\n \"\"\"\n actions = Path(__file__).absolute().parent / \"../../../actions\"\n existing_addons = {sh.with_suffix(\"\").name[7:] for sh in actions.glob(\"enable.*.sh\")}\n\n # Backwards compatibility with enabling multiple addons at once, e.g.\n # `microk8s.enable foo bar:\"baz\"`\n if all(a.split(\":\")[0] in existing_addons for a in addons) and len(addons) > 1:\n for addon in addons:\n if addon in xabled_addons and addon != \"kubeflow\":\n click.echo(\"Addon %s is already %sd.\" % (addon, action))\n else:\n addon, *args = addon.split(\":\")\n wait_for_ready(timeout=30)\n p = subprocess.run([str(actions / (\"%s.%s.sh\" % (action, addon)))] + args)\n if p.returncode:\n sys.exit(p.returncode)\n wait_for_ready(timeout=30)\n\n # The new way of xabling addons, that allows for unix-style argument passing,\n # such as `microk8s.enable foo --bar`.\n else:\n addon, *args = addons[0].split(\":\")\n\n if addon in xabled_addons and addon != \"kubeflow\":\n click.echo(\"Addon %s is already %sd.\" % (addon, action))\n sys.exit(0)\n\n if addon not in existing_addons:\n click.echo(\"Nothing to do for `%s`.\" % addon, err=True)\n sys.exit(1)\n\n if args and addons[1:]:\n click.echo(\n \"Can't pass string arguments and flag arguments simultaneously!\\n\"\n \"{0} an addon with only one argument style at a time:\\n\"\n \"\\n\"\n \" microk8s {1} foo:'bar'\\n\"\n \"or\\n\"\n \" microk8s {1} foo --bar\\n\".format(action.title(), action)\n )\n sys.exit(1)\n\n wait_for_ready(timeout=30)\n script = [str(actions / (\"%s.%s.sh\" % (action, addon)))]\n if args:\n p = subprocess.run(script + args)\n else:\n p = subprocess.run(script + list(addons[1:]))\n\n if p.returncode:\n sys.exit(p.returncode)\n\n wait_for_ready(timeout=30)\n", "path": "scripts/wrappers/common/utils.py"}]}
| 3,557 | 140 |
gh_patches_debug_16189
|
rasdani/github-patches
|
git_diff
|
HypothesisWorks__hypothesis-1711
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Move over to new pytest plugin API
We're currently using `pytest.mark.hookwrapper` in our pytest plugin. According to @RonnyPfannschmidt this API is soon to be deprecated and we should be using ` pytest.hookimpl(hookwrapper=True)` instead.
Hopefully this should be a simple matter of changing the code over to use the new decorator, but it's Hypothesis development so I'm sure something exciting will break. 😆 😢
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `hypothesis-python/src/hypothesis/extra/pytestplugin.py`
Content:
```
1 # coding=utf-8
2 #
3 # This file is part of Hypothesis, which may be found at
4 # https://github.com/HypothesisWorks/hypothesis-python
5 #
6 # Most of this work is copyright (C) 2013-2018 David R. MacIver
7 # ([email protected]), but it contains contributions by others. See
8 # CONTRIBUTING.rst for a full list of people who may hold copyright, and
9 # consult the git log if you need to determine who owns an individual
10 # contribution.
11 #
12 # This Source Code Form is subject to the terms of the Mozilla Public License,
13 # v. 2.0. If a copy of the MPL was not distributed with this file, You can
14 # obtain one at http://mozilla.org/MPL/2.0/.
15 #
16 # END HEADER
17
18 from __future__ import absolute_import, division, print_function
19
20 from distutils.version import LooseVersion
21
22 import pytest
23
24 from hypothesis import Verbosity, core, settings
25 from hypothesis._settings import note_deprecation
26 from hypothesis.internal.compat import OrderedDict, text_type
27 from hypothesis.internal.detection import is_hypothesis_test
28 from hypothesis.reporting import default as default_reporter, with_reporter
29 from hypothesis.statistics import collector
30
31 LOAD_PROFILE_OPTION = "--hypothesis-profile"
32 VERBOSITY_OPTION = "--hypothesis-verbosity"
33 PRINT_STATISTICS_OPTION = "--hypothesis-show-statistics"
34 SEED_OPTION = "--hypothesis-seed"
35
36
37 class StoringReporter(object):
38 def __init__(self, config):
39 self.config = config
40 self.results = []
41
42 def __call__(self, msg):
43 if self.config.getoption("capture", "fd") == "no":
44 default_reporter(msg)
45 if not isinstance(msg, text_type):
46 msg = repr(msg)
47 self.results.append(msg)
48
49
50 def pytest_addoption(parser):
51 group = parser.getgroup("hypothesis", "Hypothesis")
52 group.addoption(
53 LOAD_PROFILE_OPTION,
54 action="store",
55 help="Load in a registered hypothesis.settings profile",
56 )
57 group.addoption(
58 VERBOSITY_OPTION,
59 action="store",
60 choices=[opt.name for opt in Verbosity],
61 help="Override profile with verbosity setting specified",
62 )
63 group.addoption(
64 PRINT_STATISTICS_OPTION,
65 action="store_true",
66 help="Configure when statistics are printed",
67 default=False,
68 )
69 group.addoption(
70 SEED_OPTION, action="store", help="Set a seed to use for all Hypothesis tests"
71 )
72
73
74 def pytest_report_header(config):
75 profile = config.getoption(LOAD_PROFILE_OPTION)
76 if not profile:
77 profile = settings._current_profile
78 settings_str = settings.get_profile(profile).show_changed()
79 if settings_str != "":
80 settings_str = " -> %s" % (settings_str)
81 return "hypothesis profile %r%s" % (profile, settings_str)
82
83
84 def pytest_configure(config):
85 core.running_under_pytest = True
86 profile = config.getoption(LOAD_PROFILE_OPTION)
87 if profile:
88 settings.load_profile(profile)
89 verbosity_name = config.getoption(VERBOSITY_OPTION)
90 if verbosity_name:
91 verbosity_value = Verbosity[verbosity_name]
92 profile_name = "%s-with-%s-verbosity" % (
93 settings._current_profile,
94 verbosity_name,
95 )
96 # register_profile creates a new profile, exactly like the current one,
97 # with the extra values given (in this case 'verbosity')
98 settings.register_profile(profile_name, verbosity=verbosity_value)
99 settings.load_profile(profile_name)
100 seed = config.getoption(SEED_OPTION)
101 if seed is not None:
102 try:
103 seed = int(seed)
104 except ValueError:
105 pass
106 core.global_force_seed = seed
107 config.addinivalue_line("markers", "hypothesis: Tests which use hypothesis.")
108
109
110 gathered_statistics = OrderedDict() # type: dict
111
112
113 @pytest.mark.hookwrapper
114 def pytest_runtest_call(item):
115 if not (hasattr(item, "obj") and is_hypothesis_test(item.obj)):
116 yield
117 else:
118 store = StoringReporter(item.config)
119
120 def note_statistics(stats):
121 lines = [item.nodeid + ":", ""] + stats.get_description() + [""]
122 gathered_statistics[item.nodeid] = lines
123 item.hypothesis_statistics = lines
124
125 with collector.with_value(note_statistics):
126 with with_reporter(store):
127 yield
128 if store.results:
129 item.hypothesis_report_information = list(store.results)
130
131
132 @pytest.mark.hookwrapper
133 def pytest_runtest_makereport(item, call):
134 report = (yield).get_result()
135 if hasattr(item, "hypothesis_report_information"):
136 report.sections.append(
137 ("Hypothesis", "\n".join(item.hypothesis_report_information))
138 )
139 if hasattr(item, "hypothesis_statistics") and report.when == "teardown":
140 # Running on pytest < 3.5 where user_properties doesn't exist, fall
141 # back on the global gathered_statistics (which breaks under xdist)
142 if hasattr(report, "user_properties"): # pragma: no branch
143 val = ("hypothesis-stats", item.hypothesis_statistics)
144 # Workaround for https://github.com/pytest-dev/pytest/issues/4034
145 if isinstance(report.user_properties, tuple):
146 report.user_properties += (val,)
147 else:
148 report.user_properties.append(val)
149
150
151 def pytest_terminal_summary(terminalreporter):
152 if not terminalreporter.config.getoption(PRINT_STATISTICS_OPTION):
153 return
154 terminalreporter.section("Hypothesis Statistics")
155
156 if LooseVersion(pytest.__version__) < "3.5": # pragma: no cover
157 if not gathered_statistics:
158 terminalreporter.write_line(
159 "Reporting Hypothesis statistics with pytest-xdist enabled "
160 "requires pytest >= 3.5"
161 )
162 for lines in gathered_statistics.values():
163 for li in lines:
164 terminalreporter.write_line(li)
165 return
166
167 # terminalreporter.stats is a dict, where the empty string appears to
168 # always be the key for a list of _pytest.reports.TestReport objects
169 # (where we stored the statistics data in pytest_runtest_makereport above)
170 for test_report in terminalreporter.stats.get("", []):
171 for name, lines in test_report.user_properties:
172 if name == "hypothesis-stats" and test_report.when == "teardown":
173 for li in lines:
174 terminalreporter.write_line(li)
175
176
177 def pytest_collection_modifyitems(items):
178 for item in items:
179 if not isinstance(item, pytest.Function):
180 continue
181 if is_hypothesis_test(item.obj):
182 item.add_marker("hypothesis")
183 if getattr(item.obj, "is_hypothesis_strategy_function", False):
184
185 def note_strategy_is_not_test(*args, **kwargs):
186 note_deprecation(
187 "%s is a function that returns a Hypothesis strategy, "
188 "but pytest has collected it as a test function. This "
189 "is useless as the function body will never be executed."
190 "To define a test function, use @given instead of "
191 "@composite." % (item.nodeid,),
192 since="2018-11-02",
193 )
194
195 item.obj = note_strategy_is_not_test
196
197
198 def load():
199 pass
200
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/hypothesis-python/src/hypothesis/extra/pytestplugin.py b/hypothesis-python/src/hypothesis/extra/pytestplugin.py
--- a/hypothesis-python/src/hypothesis/extra/pytestplugin.py
+++ b/hypothesis-python/src/hypothesis/extra/pytestplugin.py
@@ -110,7 +110,7 @@
gathered_statistics = OrderedDict() # type: dict
[email protected]
[email protected](hookwrapper=True)
def pytest_runtest_call(item):
if not (hasattr(item, "obj") and is_hypothesis_test(item.obj)):
yield
@@ -129,7 +129,7 @@
item.hypothesis_report_information = list(store.results)
[email protected]
[email protected](hookwrapper=True)
def pytest_runtest_makereport(item, call):
report = (yield).get_result()
if hasattr(item, "hypothesis_report_information"):
|
{"golden_diff": "diff --git a/hypothesis-python/src/hypothesis/extra/pytestplugin.py b/hypothesis-python/src/hypothesis/extra/pytestplugin.py\n--- a/hypothesis-python/src/hypothesis/extra/pytestplugin.py\n+++ b/hypothesis-python/src/hypothesis/extra/pytestplugin.py\n@@ -110,7 +110,7 @@\n gathered_statistics = OrderedDict() # type: dict\n \n \[email protected]\[email protected](hookwrapper=True)\n def pytest_runtest_call(item):\n if not (hasattr(item, \"obj\") and is_hypothesis_test(item.obj)):\n yield\n@@ -129,7 +129,7 @@\n item.hypothesis_report_information = list(store.results)\n \n \[email protected]\[email protected](hookwrapper=True)\n def pytest_runtest_makereport(item, call):\n report = (yield).get_result()\n if hasattr(item, \"hypothesis_report_information\"):\n", "issue": "Move over to new pytest plugin API\nWe're currently using `pytest.mark.hookwrapper` in our pytest plugin. According to @RonnyPfannschmidt this API is soon to be deprecated and we should be using ` pytest.hookimpl(hookwrapper=True)` instead.\r\n\r\nHopefully this should be a simple matter of changing the code over to use the new decorator, but it's Hypothesis development so I'm sure something exciting will break. \ud83d\ude06 \ud83d\ude22 \n", "before_files": [{"content": "# coding=utf-8\n#\n# This file is part of Hypothesis, which may be found at\n# https://github.com/HypothesisWorks/hypothesis-python\n#\n# Most of this work is copyright (C) 2013-2018 David R. MacIver\n# ([email protected]), but it contains contributions by others. See\n# CONTRIBUTING.rst for a full list of people who may hold copyright, and\n# consult the git log if you need to determine who owns an individual\n# contribution.\n#\n# This Source Code Form is subject to the terms of the Mozilla Public License,\n# v. 2.0. If a copy of the MPL was not distributed with this file, You can\n# obtain one at http://mozilla.org/MPL/2.0/.\n#\n# END HEADER\n\nfrom __future__ import absolute_import, division, print_function\n\nfrom distutils.version import LooseVersion\n\nimport pytest\n\nfrom hypothesis import Verbosity, core, settings\nfrom hypothesis._settings import note_deprecation\nfrom hypothesis.internal.compat import OrderedDict, text_type\nfrom hypothesis.internal.detection import is_hypothesis_test\nfrom hypothesis.reporting import default as default_reporter, with_reporter\nfrom hypothesis.statistics import collector\n\nLOAD_PROFILE_OPTION = \"--hypothesis-profile\"\nVERBOSITY_OPTION = \"--hypothesis-verbosity\"\nPRINT_STATISTICS_OPTION = \"--hypothesis-show-statistics\"\nSEED_OPTION = \"--hypothesis-seed\"\n\n\nclass StoringReporter(object):\n def __init__(self, config):\n self.config = config\n self.results = []\n\n def __call__(self, msg):\n if self.config.getoption(\"capture\", \"fd\") == \"no\":\n default_reporter(msg)\n if not isinstance(msg, text_type):\n msg = repr(msg)\n self.results.append(msg)\n\n\ndef pytest_addoption(parser):\n group = parser.getgroup(\"hypothesis\", \"Hypothesis\")\n group.addoption(\n LOAD_PROFILE_OPTION,\n action=\"store\",\n help=\"Load in a registered hypothesis.settings profile\",\n )\n group.addoption(\n VERBOSITY_OPTION,\n action=\"store\",\n choices=[opt.name for opt in Verbosity],\n help=\"Override profile with verbosity setting specified\",\n )\n group.addoption(\n PRINT_STATISTICS_OPTION,\n action=\"store_true\",\n help=\"Configure when statistics are printed\",\n default=False,\n )\n group.addoption(\n SEED_OPTION, action=\"store\", help=\"Set a seed to use for all Hypothesis tests\"\n )\n\n\ndef pytest_report_header(config):\n profile = config.getoption(LOAD_PROFILE_OPTION)\n if not profile:\n profile = settings._current_profile\n settings_str = settings.get_profile(profile).show_changed()\n if settings_str != \"\":\n settings_str = \" -> %s\" % (settings_str)\n return \"hypothesis profile %r%s\" % (profile, settings_str)\n\n\ndef pytest_configure(config):\n core.running_under_pytest = True\n profile = config.getoption(LOAD_PROFILE_OPTION)\n if profile:\n settings.load_profile(profile)\n verbosity_name = config.getoption(VERBOSITY_OPTION)\n if verbosity_name:\n verbosity_value = Verbosity[verbosity_name]\n profile_name = \"%s-with-%s-verbosity\" % (\n settings._current_profile,\n verbosity_name,\n )\n # register_profile creates a new profile, exactly like the current one,\n # with the extra values given (in this case 'verbosity')\n settings.register_profile(profile_name, verbosity=verbosity_value)\n settings.load_profile(profile_name)\n seed = config.getoption(SEED_OPTION)\n if seed is not None:\n try:\n seed = int(seed)\n except ValueError:\n pass\n core.global_force_seed = seed\n config.addinivalue_line(\"markers\", \"hypothesis: Tests which use hypothesis.\")\n\n\ngathered_statistics = OrderedDict() # type: dict\n\n\[email protected]\ndef pytest_runtest_call(item):\n if not (hasattr(item, \"obj\") and is_hypothesis_test(item.obj)):\n yield\n else:\n store = StoringReporter(item.config)\n\n def note_statistics(stats):\n lines = [item.nodeid + \":\", \"\"] + stats.get_description() + [\"\"]\n gathered_statistics[item.nodeid] = lines\n item.hypothesis_statistics = lines\n\n with collector.with_value(note_statistics):\n with with_reporter(store):\n yield\n if store.results:\n item.hypothesis_report_information = list(store.results)\n\n\[email protected]\ndef pytest_runtest_makereport(item, call):\n report = (yield).get_result()\n if hasattr(item, \"hypothesis_report_information\"):\n report.sections.append(\n (\"Hypothesis\", \"\\n\".join(item.hypothesis_report_information))\n )\n if hasattr(item, \"hypothesis_statistics\") and report.when == \"teardown\":\n # Running on pytest < 3.5 where user_properties doesn't exist, fall\n # back on the global gathered_statistics (which breaks under xdist)\n if hasattr(report, \"user_properties\"): # pragma: no branch\n val = (\"hypothesis-stats\", item.hypothesis_statistics)\n # Workaround for https://github.com/pytest-dev/pytest/issues/4034\n if isinstance(report.user_properties, tuple):\n report.user_properties += (val,)\n else:\n report.user_properties.append(val)\n\n\ndef pytest_terminal_summary(terminalreporter):\n if not terminalreporter.config.getoption(PRINT_STATISTICS_OPTION):\n return\n terminalreporter.section(\"Hypothesis Statistics\")\n\n if LooseVersion(pytest.__version__) < \"3.5\": # pragma: no cover\n if not gathered_statistics:\n terminalreporter.write_line(\n \"Reporting Hypothesis statistics with pytest-xdist enabled \"\n \"requires pytest >= 3.5\"\n )\n for lines in gathered_statistics.values():\n for li in lines:\n terminalreporter.write_line(li)\n return\n\n # terminalreporter.stats is a dict, where the empty string appears to\n # always be the key for a list of _pytest.reports.TestReport objects\n # (where we stored the statistics data in pytest_runtest_makereport above)\n for test_report in terminalreporter.stats.get(\"\", []):\n for name, lines in test_report.user_properties:\n if name == \"hypothesis-stats\" and test_report.when == \"teardown\":\n for li in lines:\n terminalreporter.write_line(li)\n\n\ndef pytest_collection_modifyitems(items):\n for item in items:\n if not isinstance(item, pytest.Function):\n continue\n if is_hypothesis_test(item.obj):\n item.add_marker(\"hypothesis\")\n if getattr(item.obj, \"is_hypothesis_strategy_function\", False):\n\n def note_strategy_is_not_test(*args, **kwargs):\n note_deprecation(\n \"%s is a function that returns a Hypothesis strategy, \"\n \"but pytest has collected it as a test function. This \"\n \"is useless as the function body will never be executed.\"\n \"To define a test function, use @given instead of \"\n \"@composite.\" % (item.nodeid,),\n since=\"2018-11-02\",\n )\n\n item.obj = note_strategy_is_not_test\n\n\ndef load():\n pass\n", "path": "hypothesis-python/src/hypothesis/extra/pytestplugin.py"}], "after_files": [{"content": "# coding=utf-8\n#\n# This file is part of Hypothesis, which may be found at\n# https://github.com/HypothesisWorks/hypothesis-python\n#\n# Most of this work is copyright (C) 2013-2018 David R. MacIver\n# ([email protected]), but it contains contributions by others. See\n# CONTRIBUTING.rst for a full list of people who may hold copyright, and\n# consult the git log if you need to determine who owns an individual\n# contribution.\n#\n# This Source Code Form is subject to the terms of the Mozilla Public License,\n# v. 2.0. If a copy of the MPL was not distributed with this file, You can\n# obtain one at http://mozilla.org/MPL/2.0/.\n#\n# END HEADER\n\nfrom __future__ import absolute_import, division, print_function\n\nfrom distutils.version import LooseVersion\n\nimport pytest\n\nfrom hypothesis import Verbosity, core, settings\nfrom hypothesis._settings import note_deprecation\nfrom hypothesis.internal.compat import OrderedDict, text_type\nfrom hypothesis.internal.detection import is_hypothesis_test\nfrom hypothesis.reporting import default as default_reporter, with_reporter\nfrom hypothesis.statistics import collector\n\nLOAD_PROFILE_OPTION = \"--hypothesis-profile\"\nVERBOSITY_OPTION = \"--hypothesis-verbosity\"\nPRINT_STATISTICS_OPTION = \"--hypothesis-show-statistics\"\nSEED_OPTION = \"--hypothesis-seed\"\n\n\nclass StoringReporter(object):\n def __init__(self, config):\n self.config = config\n self.results = []\n\n def __call__(self, msg):\n if self.config.getoption(\"capture\", \"fd\") == \"no\":\n default_reporter(msg)\n if not isinstance(msg, text_type):\n msg = repr(msg)\n self.results.append(msg)\n\n\ndef pytest_addoption(parser):\n group = parser.getgroup(\"hypothesis\", \"Hypothesis\")\n group.addoption(\n LOAD_PROFILE_OPTION,\n action=\"store\",\n help=\"Load in a registered hypothesis.settings profile\",\n )\n group.addoption(\n VERBOSITY_OPTION,\n action=\"store\",\n choices=[opt.name for opt in Verbosity],\n help=\"Override profile with verbosity setting specified\",\n )\n group.addoption(\n PRINT_STATISTICS_OPTION,\n action=\"store_true\",\n help=\"Configure when statistics are printed\",\n default=False,\n )\n group.addoption(\n SEED_OPTION, action=\"store\", help=\"Set a seed to use for all Hypothesis tests\"\n )\n\n\ndef pytest_report_header(config):\n profile = config.getoption(LOAD_PROFILE_OPTION)\n if not profile:\n profile = settings._current_profile\n settings_str = settings.get_profile(profile).show_changed()\n if settings_str != \"\":\n settings_str = \" -> %s\" % (settings_str)\n return \"hypothesis profile %r%s\" % (profile, settings_str)\n\n\ndef pytest_configure(config):\n core.running_under_pytest = True\n profile = config.getoption(LOAD_PROFILE_OPTION)\n if profile:\n settings.load_profile(profile)\n verbosity_name = config.getoption(VERBOSITY_OPTION)\n if verbosity_name:\n verbosity_value = Verbosity[verbosity_name]\n profile_name = \"%s-with-%s-verbosity\" % (\n settings._current_profile,\n verbosity_name,\n )\n # register_profile creates a new profile, exactly like the current one,\n # with the extra values given (in this case 'verbosity')\n settings.register_profile(profile_name, verbosity=verbosity_value)\n settings.load_profile(profile_name)\n seed = config.getoption(SEED_OPTION)\n if seed is not None:\n try:\n seed = int(seed)\n except ValueError:\n pass\n core.global_force_seed = seed\n config.addinivalue_line(\"markers\", \"hypothesis: Tests which use hypothesis.\")\n\n\ngathered_statistics = OrderedDict() # type: dict\n\n\[email protected](hookwrapper=True)\ndef pytest_runtest_call(item):\n if not (hasattr(item, \"obj\") and is_hypothesis_test(item.obj)):\n yield\n else:\n store = StoringReporter(item.config)\n\n def note_statistics(stats):\n lines = [item.nodeid + \":\", \"\"] + stats.get_description() + [\"\"]\n gathered_statistics[item.nodeid] = lines\n item.hypothesis_statistics = lines\n\n with collector.with_value(note_statistics):\n with with_reporter(store):\n yield\n if store.results:\n item.hypothesis_report_information = list(store.results)\n\n\[email protected](hookwrapper=True)\ndef pytest_runtest_makereport(item, call):\n report = (yield).get_result()\n if hasattr(item, \"hypothesis_report_information\"):\n report.sections.append(\n (\"Hypothesis\", \"\\n\".join(item.hypothesis_report_information))\n )\n if hasattr(item, \"hypothesis_statistics\") and report.when == \"teardown\":\n # Running on pytest < 3.5 where user_properties doesn't exist, fall\n # back on the global gathered_statistics (which breaks under xdist)\n if hasattr(report, \"user_properties\"): # pragma: no branch\n val = (\"hypothesis-stats\", item.hypothesis_statistics)\n # Workaround for https://github.com/pytest-dev/pytest/issues/4034\n if isinstance(report.user_properties, tuple):\n report.user_properties += (val,)\n else:\n report.user_properties.append(val)\n\n\ndef pytest_terminal_summary(terminalreporter):\n if not terminalreporter.config.getoption(PRINT_STATISTICS_OPTION):\n return\n terminalreporter.section(\"Hypothesis Statistics\")\n\n if LooseVersion(pytest.__version__) < \"3.5\": # pragma: no cover\n if not gathered_statistics:\n terminalreporter.write_line(\n \"Reporting Hypothesis statistics with pytest-xdist enabled \"\n \"requires pytest >= 3.5\"\n )\n for lines in gathered_statistics.values():\n for li in lines:\n terminalreporter.write_line(li)\n return\n\n # terminalreporter.stats is a dict, where the empty string appears to\n # always be the key for a list of _pytest.reports.TestReport objects\n # (where we stored the statistics data in pytest_runtest_makereport above)\n for test_report in terminalreporter.stats.get(\"\", []):\n for name, lines in test_report.user_properties:\n if name == \"hypothesis-stats\" and test_report.when == \"teardown\":\n for li in lines:\n terminalreporter.write_line(li)\n\n\ndef pytest_collection_modifyitems(items):\n for item in items:\n if not isinstance(item, pytest.Function):\n continue\n if is_hypothesis_test(item.obj):\n item.add_marker(\"hypothesis\")\n if getattr(item.obj, \"is_hypothesis_strategy_function\", False):\n\n def note_strategy_is_not_test(*args, **kwargs):\n note_deprecation(\n \"%s is a function that returns a Hypothesis strategy, \"\n \"but pytest has collected it as a test function. This \"\n \"is useless as the function body will never be executed.\"\n \"To define a test function, use @given instead of \"\n \"@composite.\" % (item.nodeid,),\n since=\"2018-11-02\",\n )\n\n item.obj = note_strategy_is_not_test\n\n\ndef load():\n pass\n", "path": "hypothesis-python/src/hypothesis/extra/pytestplugin.py"}]}
| 2,458 | 222 |
gh_patches_debug_21294
|
rasdani/github-patches
|
git_diff
|
rucio__rucio-952
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
setup_clients.py classifiers needs to be a list, not tuples
Motivation
----------
Classifiers were changed to tuple, which does not work, needs to be a list.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `setup_rucio_client.py`
Content:
```
1 # Copyright 2014-2018 CERN for the benefit of the ATLAS collaboration.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14 #
15 # Authors:
16 # - Vincent Garonne <[email protected]>, 2014-2018
17 # - Martin Barisits <[email protected]>, 2017
18
19 import os
20 import re
21 import shutil
22 import subprocess
23 import sys
24
25 from distutils.command.sdist import sdist as _sdist # pylint:disable=no-name-in-module,import-error
26 from setuptools import setup
27
28 sys.path.insert(0, os.path.abspath('lib/'))
29
30 from rucio import version # noqa
31
32 if sys.version_info < (2, 5):
33 print('ERROR: Rucio requires at least Python 2.6 to run.')
34 sys.exit(1)
35 sys.path.insert(0, os.path.abspath('lib/'))
36
37
38 # Arguments to the setup script to build Basic/Lite distributions
39 COPY_ARGS = sys.argv[1:]
40 NAME = 'rucio-clients'
41 IS_RELEASE = False
42 PACKAGES = ['rucio', 'rucio.client', 'rucio.common',
43 'rucio.rse.protocols', 'rucio.rse', 'rucio.tests']
44 REQUIREMENTS_FILES = ['tools/pip-requires-client']
45 DESCRIPTION = "Rucio Client Lite Package"
46 DATA_FILES = [('etc/', ['etc/rse-accounts.cfg.template', 'etc/rucio.cfg.template', 'etc/rucio.cfg.atlas.client.template']),
47 ('tools/', ['tools/pip-requires-client', ]), ]
48
49 SCRIPTS = ['bin/rucio', 'bin/rucio-admin']
50 if os.path.exists('build/'):
51 shutil.rmtree('build/')
52 if os.path.exists('lib/rucio_clients.egg-info/'):
53 shutil.rmtree('lib/rucio_clients.egg-info/')
54 if os.path.exists('lib/rucio.egg-info/'):
55 shutil.rmtree('lib/rucio.egg-info/')
56
57 SSH_EXTRAS = ['paramiko==1.18.4']
58 KERBEROS_EXTRAS = ['kerberos>=1.2.5', 'pykerberos>=1.1.14', 'requests-kerberos>=0.11.0']
59 SWIFT_EXTRAS = ['python-swiftclient>=3.5.0', ]
60 EXTRAS_REQUIRES = dict(ssh=SSH_EXTRAS,
61 kerberos=KERBEROS_EXTRAS,
62 swift=SWIFT_EXTRAS)
63
64 if '--release' in COPY_ARGS:
65 IS_RELEASE = True
66 COPY_ARGS.remove('--release')
67
68
69 # If Sphinx is installed on the box running setup.py,
70 # enable setup.py to build the documentation, otherwise,
71 # just ignore it
72 cmdclass = {}
73
74 try:
75 from sphinx.setup_command import BuildDoc
76
77 class local_BuildDoc(BuildDoc):
78 '''
79 local_BuildDoc
80 '''
81 def run(self):
82 '''
83 run
84 '''
85 for builder in ['html']: # 'man','latex'
86 self.builder = builder
87 self.finalize_options()
88 BuildDoc.run(self)
89 cmdclass['build_sphinx'] = local_BuildDoc
90 except Exception:
91 pass
92
93
94 def get_reqs_from_file(requirements_file):
95 '''
96 get_reqs_from_file
97 '''
98 if os.path.exists(requirements_file):
99 return open(requirements_file, 'r').read().split('\n')
100 return []
101
102
103 def parse_requirements(requirements_files):
104 '''
105 parse_requirements
106 '''
107 requirements = []
108 for requirements_file in requirements_files:
109 for line in get_reqs_from_file(requirements_file):
110 if re.match(r'\s*-e\s+', line):
111 requirements.append(re.sub(r'\s*-e\s+.*#egg=(.*)$', r'\1', line))
112 elif re.match(r'\s*-f\s+', line):
113 pass
114 else:
115 requirements.append(line)
116 return requirements
117
118
119 def parse_dependency_links(requirements_files):
120 '''
121 parse_dependency_links
122 '''
123 dependency_links = []
124 for requirements_file in requirements_files:
125 for line in get_reqs_from_file(requirements_file):
126 if re.match(r'(\s*#)|(\s*$)', line):
127 continue
128 if re.match(r'\s*-[ef]\s+', line):
129 dependency_links.append(re.sub(r'\s*-[ef]\s+', '', line))
130 return dependency_links
131
132
133 def write_requirements():
134 '''
135 write_requirements
136 '''
137 venv = os.environ.get('VIRTUAL_ENV', None)
138 if venv is not None:
139 req_file = open("requirements.txt", "w")
140 output = subprocess.Popen(["pip", "freeze", "-l"], stdout=subprocess.PIPE)
141 requirements = output.communicate()[0].strip()
142 req_file.write(requirements)
143 req_file.close()
144
145
146 REQUIRES = parse_requirements(requirements_files=REQUIREMENTS_FILES)
147 DEPEND_LINKS = parse_dependency_links(requirements_files=REQUIREMENTS_FILES)
148
149
150 class CustomSdist(_sdist):
151 '''
152 CustomSdist
153 '''
154 user_options = [
155 ('packaging=', None, "Some option to indicate what should be packaged")
156 ] + _sdist.user_options
157
158 def __init__(self, *args, **kwargs):
159 '''
160 __init__
161 '''
162 _sdist.__init__(self, *args, **kwargs)
163 self.packaging = "default value for this option"
164
165 def get_file_list(self):
166 '''
167 get_file_list
168 '''
169 print("Chosen packaging option: " + NAME)
170 self.distribution.data_files = DATA_FILES
171 _sdist.get_file_list(self)
172
173
174 cmdclass['sdist'] = CustomSdist
175
176 setup(
177 name=NAME,
178 version=version.version_string(),
179 packages=PACKAGES,
180 package_dir={'': 'lib'},
181 data_files=DATA_FILES,
182 script_args=COPY_ARGS,
183 cmdclass=cmdclass,
184 include_package_data=True,
185 scripts=SCRIPTS,
186 # doc=cmdclass,
187 author="Rucio",
188 author_email="[email protected]",
189 description=DESCRIPTION,
190 license="Apache License, Version 2.0",
191 url="http://rucio.cern.ch/",
192 python_requires=">=2.6, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
193 classifiers=(
194 'Development Status :: 5 - Production/Stable',
195 'License :: OSI Approved :: Apache Software License',
196 'Intended Audience :: Information Technology',
197 'Intended Audience :: System Administrators',
198 'Operating System :: POSIX :: Linux',
199 'Natural Language :: English',
200 'Programming Language :: Python',
201 'Programming Language :: Python :: 2.6',
202 'Programming Language :: Python :: 2.7',
203 'Programming Language :: Python :: 3',
204 'Programming Language :: Python :: 3.4',
205 'Programming Language :: Python :: 3.5',
206 'Programming Language :: Python :: 3.6',
207 'Programming Language :: Python :: Implementation :: CPython',
208 'Programming Language :: Python :: Implementation :: PyPy',
209 'Environment :: No Input/Output (Daemon)'
210 ),
211 install_requires=REQUIRES,
212 extras_require=EXTRAS_REQUIRES,
213 dependency_links=DEPEND_LINKS,
214 )
215
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/setup_rucio_client.py b/setup_rucio_client.py
--- a/setup_rucio_client.py
+++ b/setup_rucio_client.py
@@ -190,7 +190,7 @@
license="Apache License, Version 2.0",
url="http://rucio.cern.ch/",
python_requires=">=2.6, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
- classifiers=(
+ classifiers=[
'Development Status :: 5 - Production/Stable',
'License :: OSI Approved :: Apache Software License',
'Intended Audience :: Information Technology',
@@ -207,7 +207,7 @@
'Programming Language :: Python :: Implementation :: CPython',
'Programming Language :: Python :: Implementation :: PyPy',
'Environment :: No Input/Output (Daemon)'
- ),
+ ],
install_requires=REQUIRES,
extras_require=EXTRAS_REQUIRES,
dependency_links=DEPEND_LINKS,
|
{"golden_diff": "diff --git a/setup_rucio_client.py b/setup_rucio_client.py\n--- a/setup_rucio_client.py\n+++ b/setup_rucio_client.py\n@@ -190,7 +190,7 @@\n license=\"Apache License, Version 2.0\",\n url=\"http://rucio.cern.ch/\",\n python_requires=\">=2.6, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*\",\n- classifiers=(\n+ classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'License :: OSI Approved :: Apache Software License',\n 'Intended Audience :: Information Technology',\n@@ -207,7 +207,7 @@\n 'Programming Language :: Python :: Implementation :: CPython',\n 'Programming Language :: Python :: Implementation :: PyPy',\n 'Environment :: No Input/Output (Daemon)'\n- ),\n+ ],\n install_requires=REQUIRES,\n extras_require=EXTRAS_REQUIRES,\n dependency_links=DEPEND_LINKS,\n", "issue": "setup_clients.py classifiers needs to be a list, not tuples\nMotivation\r\n----------\r\nClassifiers were changed to tuple, which does not work, needs to be a list.\n", "before_files": [{"content": "# Copyright 2014-2018 CERN for the benefit of the ATLAS collaboration.\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#\n# Authors:\n# - Vincent Garonne <[email protected]>, 2014-2018\n# - Martin Barisits <[email protected]>, 2017\n\nimport os\nimport re\nimport shutil\nimport subprocess\nimport sys\n\nfrom distutils.command.sdist import sdist as _sdist # pylint:disable=no-name-in-module,import-error\nfrom setuptools import setup\n\nsys.path.insert(0, os.path.abspath('lib/'))\n\nfrom rucio import version # noqa\n\nif sys.version_info < (2, 5):\n print('ERROR: Rucio requires at least Python 2.6 to run.')\n sys.exit(1)\nsys.path.insert(0, os.path.abspath('lib/'))\n\n\n# Arguments to the setup script to build Basic/Lite distributions\nCOPY_ARGS = sys.argv[1:]\nNAME = 'rucio-clients'\nIS_RELEASE = False\nPACKAGES = ['rucio', 'rucio.client', 'rucio.common',\n 'rucio.rse.protocols', 'rucio.rse', 'rucio.tests']\nREQUIREMENTS_FILES = ['tools/pip-requires-client']\nDESCRIPTION = \"Rucio Client Lite Package\"\nDATA_FILES = [('etc/', ['etc/rse-accounts.cfg.template', 'etc/rucio.cfg.template', 'etc/rucio.cfg.atlas.client.template']),\n ('tools/', ['tools/pip-requires-client', ]), ]\n\nSCRIPTS = ['bin/rucio', 'bin/rucio-admin']\nif os.path.exists('build/'):\n shutil.rmtree('build/')\nif os.path.exists('lib/rucio_clients.egg-info/'):\n shutil.rmtree('lib/rucio_clients.egg-info/')\nif os.path.exists('lib/rucio.egg-info/'):\n shutil.rmtree('lib/rucio.egg-info/')\n\nSSH_EXTRAS = ['paramiko==1.18.4']\nKERBEROS_EXTRAS = ['kerberos>=1.2.5', 'pykerberos>=1.1.14', 'requests-kerberos>=0.11.0']\nSWIFT_EXTRAS = ['python-swiftclient>=3.5.0', ]\nEXTRAS_REQUIRES = dict(ssh=SSH_EXTRAS,\n kerberos=KERBEROS_EXTRAS,\n swift=SWIFT_EXTRAS)\n\nif '--release' in COPY_ARGS:\n IS_RELEASE = True\n COPY_ARGS.remove('--release')\n\n\n# If Sphinx is installed on the box running setup.py,\n# enable setup.py to build the documentation, otherwise,\n# just ignore it\ncmdclass = {}\n\ntry:\n from sphinx.setup_command import BuildDoc\n\n class local_BuildDoc(BuildDoc):\n '''\n local_BuildDoc\n '''\n def run(self):\n '''\n run\n '''\n for builder in ['html']: # 'man','latex'\n self.builder = builder\n self.finalize_options()\n BuildDoc.run(self)\n cmdclass['build_sphinx'] = local_BuildDoc\nexcept Exception:\n pass\n\n\ndef get_reqs_from_file(requirements_file):\n '''\n get_reqs_from_file\n '''\n if os.path.exists(requirements_file):\n return open(requirements_file, 'r').read().split('\\n')\n return []\n\n\ndef parse_requirements(requirements_files):\n '''\n parse_requirements\n '''\n requirements = []\n for requirements_file in requirements_files:\n for line in get_reqs_from_file(requirements_file):\n if re.match(r'\\s*-e\\s+', line):\n requirements.append(re.sub(r'\\s*-e\\s+.*#egg=(.*)$', r'\\1', line))\n elif re.match(r'\\s*-f\\s+', line):\n pass\n else:\n requirements.append(line)\n return requirements\n\n\ndef parse_dependency_links(requirements_files):\n '''\n parse_dependency_links\n '''\n dependency_links = []\n for requirements_file in requirements_files:\n for line in get_reqs_from_file(requirements_file):\n if re.match(r'(\\s*#)|(\\s*$)', line):\n continue\n if re.match(r'\\s*-[ef]\\s+', line):\n dependency_links.append(re.sub(r'\\s*-[ef]\\s+', '', line))\n return dependency_links\n\n\ndef write_requirements():\n '''\n write_requirements\n '''\n venv = os.environ.get('VIRTUAL_ENV', None)\n if venv is not None:\n req_file = open(\"requirements.txt\", \"w\")\n output = subprocess.Popen([\"pip\", \"freeze\", \"-l\"], stdout=subprocess.PIPE)\n requirements = output.communicate()[0].strip()\n req_file.write(requirements)\n req_file.close()\n\n\nREQUIRES = parse_requirements(requirements_files=REQUIREMENTS_FILES)\nDEPEND_LINKS = parse_dependency_links(requirements_files=REQUIREMENTS_FILES)\n\n\nclass CustomSdist(_sdist):\n '''\n CustomSdist\n '''\n user_options = [\n ('packaging=', None, \"Some option to indicate what should be packaged\")\n ] + _sdist.user_options\n\n def __init__(self, *args, **kwargs):\n '''\n __init__\n '''\n _sdist.__init__(self, *args, **kwargs)\n self.packaging = \"default value for this option\"\n\n def get_file_list(self):\n '''\n get_file_list\n '''\n print(\"Chosen packaging option: \" + NAME)\n self.distribution.data_files = DATA_FILES\n _sdist.get_file_list(self)\n\n\ncmdclass['sdist'] = CustomSdist\n\nsetup(\n name=NAME,\n version=version.version_string(),\n packages=PACKAGES,\n package_dir={'': 'lib'},\n data_files=DATA_FILES,\n script_args=COPY_ARGS,\n cmdclass=cmdclass,\n include_package_data=True,\n scripts=SCRIPTS,\n # doc=cmdclass,\n author=\"Rucio\",\n author_email=\"[email protected]\",\n description=DESCRIPTION,\n license=\"Apache License, Version 2.0\",\n url=\"http://rucio.cern.ch/\",\n python_requires=\">=2.6, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*\",\n classifiers=(\n 'Development Status :: 5 - Production/Stable',\n 'License :: OSI Approved :: Apache Software License',\n 'Intended Audience :: Information Technology',\n 'Intended Audience :: System Administrators',\n 'Operating System :: POSIX :: Linux',\n 'Natural Language :: English',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 2.6',\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 :: Implementation :: CPython',\n 'Programming Language :: Python :: Implementation :: PyPy',\n 'Environment :: No Input/Output (Daemon)'\n ),\n install_requires=REQUIRES,\n extras_require=EXTRAS_REQUIRES,\n dependency_links=DEPEND_LINKS,\n)\n", "path": "setup_rucio_client.py"}], "after_files": [{"content": "# Copyright 2014-2018 CERN for the benefit of the ATLAS collaboration.\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#\n# Authors:\n# - Vincent Garonne <[email protected]>, 2014-2018\n# - Martin Barisits <[email protected]>, 2017\n\nimport os\nimport re\nimport shutil\nimport subprocess\nimport sys\n\nfrom distutils.command.sdist import sdist as _sdist # pylint:disable=no-name-in-module,import-error\nfrom setuptools import setup\n\nsys.path.insert(0, os.path.abspath('lib/'))\n\nfrom rucio import version # noqa\n\nif sys.version_info < (2, 5):\n print('ERROR: Rucio requires at least Python 2.6 to run.')\n sys.exit(1)\nsys.path.insert(0, os.path.abspath('lib/'))\n\n\n# Arguments to the setup script to build Basic/Lite distributions\nCOPY_ARGS = sys.argv[1:]\nNAME = 'rucio-clients'\nIS_RELEASE = False\nPACKAGES = ['rucio', 'rucio.client', 'rucio.common',\n 'rucio.rse.protocols', 'rucio.rse', 'rucio.tests']\nREQUIREMENTS_FILES = ['tools/pip-requires-client']\nDESCRIPTION = \"Rucio Client Lite Package\"\nDATA_FILES = [('etc/', ['etc/rse-accounts.cfg.template', 'etc/rucio.cfg.template', 'etc/rucio.cfg.atlas.client.template']),\n ('tools/', ['tools/pip-requires-client', ]), ]\n\nSCRIPTS = ['bin/rucio', 'bin/rucio-admin']\nif os.path.exists('build/'):\n shutil.rmtree('build/')\nif os.path.exists('lib/rucio_clients.egg-info/'):\n shutil.rmtree('lib/rucio_clients.egg-info/')\nif os.path.exists('lib/rucio.egg-info/'):\n shutil.rmtree('lib/rucio.egg-info/')\n\nSSH_EXTRAS = ['paramiko==1.18.4']\nKERBEROS_EXTRAS = ['kerberos>=1.2.5', 'pykerberos>=1.1.14', 'requests-kerberos>=0.11.0']\nSWIFT_EXTRAS = ['python-swiftclient>=3.5.0', ]\nEXTRAS_REQUIRES = dict(ssh=SSH_EXTRAS,\n kerberos=KERBEROS_EXTRAS,\n swift=SWIFT_EXTRAS)\n\nif '--release' in COPY_ARGS:\n IS_RELEASE = True\n COPY_ARGS.remove('--release')\n\n\n# If Sphinx is installed on the box running setup.py,\n# enable setup.py to build the documentation, otherwise,\n# just ignore it\ncmdclass = {}\n\ntry:\n from sphinx.setup_command import BuildDoc\n\n class local_BuildDoc(BuildDoc):\n '''\n local_BuildDoc\n '''\n def run(self):\n '''\n run\n '''\n for builder in ['html']: # 'man','latex'\n self.builder = builder\n self.finalize_options()\n BuildDoc.run(self)\n cmdclass['build_sphinx'] = local_BuildDoc\nexcept Exception:\n pass\n\n\ndef get_reqs_from_file(requirements_file):\n '''\n get_reqs_from_file\n '''\n if os.path.exists(requirements_file):\n return open(requirements_file, 'r').read().split('\\n')\n return []\n\n\ndef parse_requirements(requirements_files):\n '''\n parse_requirements\n '''\n requirements = []\n for requirements_file in requirements_files:\n for line in get_reqs_from_file(requirements_file):\n if re.match(r'\\s*-e\\s+', line):\n requirements.append(re.sub(r'\\s*-e\\s+.*#egg=(.*)$', r'\\1', line))\n elif re.match(r'\\s*-f\\s+', line):\n pass\n else:\n requirements.append(line)\n return requirements\n\n\ndef parse_dependency_links(requirements_files):\n '''\n parse_dependency_links\n '''\n dependency_links = []\n for requirements_file in requirements_files:\n for line in get_reqs_from_file(requirements_file):\n if re.match(r'(\\s*#)|(\\s*$)', line):\n continue\n if re.match(r'\\s*-[ef]\\s+', line):\n dependency_links.append(re.sub(r'\\s*-[ef]\\s+', '', line))\n return dependency_links\n\n\ndef write_requirements():\n '''\n write_requirements\n '''\n venv = os.environ.get('VIRTUAL_ENV', None)\n if venv is not None:\n req_file = open(\"requirements.txt\", \"w\")\n output = subprocess.Popen([\"pip\", \"freeze\", \"-l\"], stdout=subprocess.PIPE)\n requirements = output.communicate()[0].strip()\n req_file.write(requirements)\n req_file.close()\n\n\nREQUIRES = parse_requirements(requirements_files=REQUIREMENTS_FILES)\nDEPEND_LINKS = parse_dependency_links(requirements_files=REQUIREMENTS_FILES)\n\n\nclass CustomSdist(_sdist):\n '''\n CustomSdist\n '''\n user_options = [\n ('packaging=', None, \"Some option to indicate what should be packaged\")\n ] + _sdist.user_options\n\n def __init__(self, *args, **kwargs):\n '''\n __init__\n '''\n _sdist.__init__(self, *args, **kwargs)\n self.packaging = \"default value for this option\"\n\n def get_file_list(self):\n '''\n get_file_list\n '''\n print(\"Chosen packaging option: \" + NAME)\n self.distribution.data_files = DATA_FILES\n _sdist.get_file_list(self)\n\n\ncmdclass['sdist'] = CustomSdist\n\nsetup(\n name=NAME,\n version=version.version_string(),\n packages=PACKAGES,\n package_dir={'': 'lib'},\n data_files=DATA_FILES,\n script_args=COPY_ARGS,\n cmdclass=cmdclass,\n include_package_data=True,\n scripts=SCRIPTS,\n # doc=cmdclass,\n author=\"Rucio\",\n author_email=\"[email protected]\",\n description=DESCRIPTION,\n license=\"Apache License, Version 2.0\",\n url=\"http://rucio.cern.ch/\",\n python_requires=\">=2.6, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*\",\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'License :: OSI Approved :: Apache Software License',\n 'Intended Audience :: Information Technology',\n 'Intended Audience :: System Administrators',\n 'Operating System :: POSIX :: Linux',\n 'Natural Language :: English',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 2.6',\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 :: Implementation :: CPython',\n 'Programming Language :: Python :: Implementation :: PyPy',\n 'Environment :: No Input/Output (Daemon)'\n ],\n install_requires=REQUIRES,\n extras_require=EXTRAS_REQUIRES,\n dependency_links=DEPEND_LINKS,\n)\n", "path": "setup_rucio_client.py"}]}
| 2,527 | 223 |
gh_patches_debug_1009
|
rasdani/github-patches
|
git_diff
|
pypa__pip-9333
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Move slow check_manifest out of .pre-commit-config.yaml
The check-manifest pre-commit hook is by far the slowest of the checks, in particular when committing a few files.
When pre-commit is installed locally as a pre-commit hook, it tends to slow down the development flow significantly.
Could we move it out of the default pre-commit config to a regular CI check ?
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `noxfile.py`
Content:
```
1 """Automation using nox.
2 """
3
4 # The following comment should be removed at some point in the future.
5 # mypy: disallow-untyped-defs=False
6
7 import glob
8 import os
9 import shutil
10 import sys
11 from pathlib import Path
12
13 import nox
14
15 sys.path.append(".")
16 from tools.automation import release # isort:skip # noqa
17 sys.path.pop()
18
19 nox.options.reuse_existing_virtualenvs = True
20 nox.options.sessions = ["lint"]
21
22 LOCATIONS = {
23 "common-wheels": "tests/data/common_wheels",
24 "protected-pip": "tools/tox_pip.py",
25 }
26 REQUIREMENTS = {
27 "docs": "tools/requirements/docs.txt",
28 "tests": "tools/requirements/tests.txt",
29 "common-wheels": "tools/requirements/tests-common_wheels.txt",
30 }
31
32 AUTHORS_FILE = "AUTHORS.txt"
33 VERSION_FILE = "src/pip/__init__.py"
34
35
36 def run_with_protected_pip(session, *arguments):
37 """Do a session.run("pip", *arguments), using a "protected" pip.
38
39 This invokes a wrapper script, that forwards calls to original virtualenv
40 (stable) version, and not the code being tested. This ensures pip being
41 used is not the code being tested.
42 """
43 env = {"VIRTUAL_ENV": session.virtualenv.location}
44
45 command = ("python", LOCATIONS["protected-pip"]) + arguments
46 kwargs = {"env": env, "silent": True}
47 session.run(*command, **kwargs)
48
49
50 def should_update_common_wheels():
51 # If the cache hasn't been created, create it.
52 if not os.path.exists(LOCATIONS["common-wheels"]):
53 return True
54
55 # If the requirements was updated after cache, we'll repopulate it.
56 cache_last_populated_at = os.path.getmtime(LOCATIONS["common-wheels"])
57 requirements_updated_at = os.path.getmtime(REQUIREMENTS["common-wheels"])
58 need_to_repopulate = requirements_updated_at > cache_last_populated_at
59
60 # Clear the stale cache.
61 if need_to_repopulate:
62 shutil.rmtree(LOCATIONS["common-wheels"], ignore_errors=True)
63
64 return need_to_repopulate
65
66
67 # -----------------------------------------------------------------------------
68 # Development Commands
69 # These are currently prototypes to evaluate whether we want to switch over
70 # completely to nox for all our automation. Contributors should prefer using
71 # `tox -e ...` until this note is removed.
72 # -----------------------------------------------------------------------------
73 @nox.session(python=["3.6", "3.7", "3.8", "3.9", "pypy3"])
74 def test(session):
75 # Get the common wheels.
76 if should_update_common_wheels():
77 run_with_protected_pip(
78 session,
79 "wheel",
80 "-w", LOCATIONS["common-wheels"],
81 "-r", REQUIREMENTS["common-wheels"],
82 )
83 else:
84 msg = (
85 "Re-using existing common-wheels at {}."
86 .format(LOCATIONS["common-wheels"])
87 )
88 session.log(msg)
89
90 # Build source distribution
91 sdist_dir = os.path.join(session.virtualenv.location, "sdist")
92 if os.path.exists(sdist_dir):
93 shutil.rmtree(sdist_dir, ignore_errors=True)
94 session.run(
95 "python", "setup.py", "sdist",
96 "--formats=zip", "--dist-dir", sdist_dir,
97 silent=True,
98 )
99 generated_files = os.listdir(sdist_dir)
100 assert len(generated_files) == 1
101 generated_sdist = os.path.join(sdist_dir, generated_files[0])
102
103 # Install source distribution
104 run_with_protected_pip(session, "install", generated_sdist)
105
106 # Install test dependencies
107 run_with_protected_pip(session, "install", "-r", REQUIREMENTS["tests"])
108
109 # Parallelize tests as much as possible, by default.
110 arguments = session.posargs or ["-n", "auto"]
111
112 # Run the tests
113 # LC_CTYPE is set to get UTF-8 output inside of the subprocesses that our
114 # tests use.
115 session.run("pytest", *arguments, env={"LC_CTYPE": "en_US.UTF-8"})
116
117
118 @nox.session
119 def docs(session):
120 session.install("-e", ".")
121 session.install("-r", REQUIREMENTS["docs"])
122
123 def get_sphinx_build_command(kind):
124 # Having the conf.py in the docs/html is weird but needed because we
125 # can not use a different configuration directory vs source directory
126 # on RTD currently. So, we'll pass "-c docs/html" here.
127 # See https://github.com/rtfd/readthedocs.org/issues/1543.
128 return [
129 "sphinx-build",
130 "-W",
131 "-c", "docs/html", # see note above
132 "-d", "docs/build/doctrees/" + kind,
133 "-b", kind,
134 "docs/" + kind,
135 "docs/build/" + kind,
136 ]
137
138 session.run(*get_sphinx_build_command("html"))
139 session.run(*get_sphinx_build_command("man"))
140
141
142 @nox.session
143 def lint(session):
144 session.install("pre-commit")
145
146 if session.posargs:
147 args = session.posargs + ["--all-files"]
148 else:
149 args = ["--all-files", "--show-diff-on-failure"]
150
151 session.run("pre-commit", "run", *args)
152
153
154 @nox.session
155 def vendoring(session):
156 session.install("vendoring>=0.3.0")
157
158 if "--upgrade" not in session.posargs:
159 session.run("vendoring", "sync", ".", "-v")
160 return
161
162 def pinned_requirements(path):
163 for line in path.read_text().splitlines():
164 one, two = line.split("==", 1)
165 name = one.strip()
166 version = two.split("#")[0].strip()
167 yield name, version
168
169 vendor_txt = Path("src/pip/_vendor/vendor.txt")
170 for name, old_version in pinned_requirements(vendor_txt):
171 if name == "setuptools":
172 continue
173
174 # update requirements.txt
175 session.run("vendoring", "update", ".", name)
176
177 # get the updated version
178 new_version = old_version
179 for inner_name, inner_version in pinned_requirements(vendor_txt):
180 if inner_name == name:
181 # this is a dedicated assignment, to make flake8 happy
182 new_version = inner_version
183 break
184 else:
185 session.error(f"Could not find {name} in {vendor_txt}")
186
187 # check if the version changed.
188 if new_version == old_version:
189 continue # no change, nothing more to do here.
190
191 # synchronize the contents
192 session.run("vendoring", "sync", ".")
193
194 # Determine the correct message
195 message = f"Upgrade {name} to {new_version}"
196
197 # Write our news fragment
198 news_file = Path("news") / (name + ".vendor.rst")
199 news_file.write_text(message + "\n") # "\n" appeases end-of-line-fixer
200
201 # Commit the changes
202 release.commit_file(session, ".", message=message)
203
204
205 # -----------------------------------------------------------------------------
206 # Release Commands
207 # -----------------------------------------------------------------------------
208 @nox.session(name="prepare-release")
209 def prepare_release(session):
210 version = release.get_version_from_arguments(session)
211 if not version:
212 session.error("Usage: nox -s prepare-release -- <version>")
213
214 session.log("# Ensure nothing is staged")
215 if release.modified_files_in_git("--staged"):
216 session.error("There are files staged in git")
217
218 session.log(f"# Updating {AUTHORS_FILE}")
219 release.generate_authors(AUTHORS_FILE)
220 if release.modified_files_in_git():
221 release.commit_file(
222 session, AUTHORS_FILE, message=f"Update {AUTHORS_FILE}",
223 )
224 else:
225 session.log(f"# No changes to {AUTHORS_FILE}")
226
227 session.log("# Generating NEWS")
228 release.generate_news(session, version)
229
230 session.log(f"# Bumping for release {version}")
231 release.update_version_file(version, VERSION_FILE)
232 release.commit_file(session, VERSION_FILE, message="Bump for release")
233
234 session.log("# Tagging release")
235 release.create_git_tag(session, version, message=f"Release {version}")
236
237 session.log("# Bumping for development")
238 next_dev_version = release.get_next_development_version(version)
239 release.update_version_file(next_dev_version, VERSION_FILE)
240 release.commit_file(session, VERSION_FILE, message="Bump for development")
241
242
243 @nox.session(name="build-release")
244 def build_release(session):
245 version = release.get_version_from_arguments(session)
246 if not version:
247 session.error("Usage: nox -s build-release -- YY.N[.P]")
248
249 session.log("# Ensure no files in dist/")
250 if release.have_files_in_folder("dist"):
251 session.error(
252 "There are files in dist/. Remove them and try again. "
253 "You can use `git clean -fxdi -- dist` command to do this"
254 )
255
256 session.log("# Install dependencies")
257 session.install("setuptools", "wheel", "twine")
258
259 with release.isolated_temporary_checkout(session, version) as build_dir:
260 session.log(
261 "# Start the build in an isolated, "
262 f"temporary Git checkout at {build_dir!s}",
263 )
264 with release.workdir(session, build_dir):
265 tmp_dists = build_dists(session)
266
267 tmp_dist_paths = (build_dir / p for p in tmp_dists)
268 session.log(f"# Copying dists from {build_dir}")
269 os.makedirs('dist', exist_ok=True)
270 for dist, final in zip(tmp_dist_paths, tmp_dists):
271 session.log(f"# Copying {dist} to {final}")
272 shutil.copy(dist, final)
273
274
275 def build_dists(session):
276 """Return dists with valid metadata."""
277 session.log(
278 "# Check if there's any Git-untracked files before building the wheel",
279 )
280
281 has_forbidden_git_untracked_files = any(
282 # Don't report the environment this session is running in
283 not untracked_file.startswith('.nox/build-release/')
284 for untracked_file in release.get_git_untracked_files()
285 )
286 if has_forbidden_git_untracked_files:
287 session.error(
288 "There are untracked files in the working directory. "
289 "Remove them and try again",
290 )
291
292 session.log("# Build distributions")
293 session.run("python", "setup.py", "sdist", "bdist_wheel", silent=True)
294 produced_dists = glob.glob("dist/*")
295
296 session.log(f"# Verify distributions: {', '.join(produced_dists)}")
297 session.run("twine", "check", *produced_dists, silent=True)
298
299 return produced_dists
300
301
302 @nox.session(name="upload-release")
303 def upload_release(session):
304 version = release.get_version_from_arguments(session)
305 if not version:
306 session.error("Usage: nox -s upload-release -- YY.N[.P]")
307
308 session.log("# Install dependencies")
309 session.install("twine")
310
311 distribution_files = glob.glob("dist/*")
312 session.log(f"# Distribution files: {distribution_files}")
313
314 # Sanity check: Make sure there's 2 distribution files.
315 count = len(distribution_files)
316 if count != 2:
317 session.error(
318 f"Expected 2 distribution files for upload, got {count}. "
319 f"Remove dist/ and run 'nox -s build-release -- {version}'"
320 )
321 # Sanity check: Make sure the files are correctly named.
322 distfile_names = map(os.path.basename, distribution_files)
323 expected_distribution_files = [
324 f"pip-{version}-py2.py3-none-any.whl",
325 f"pip-{version}.tar.gz",
326 ]
327 if sorted(distfile_names) != sorted(expected_distribution_files):
328 session.error(
329 f"Distribution files do not seem to be for {version} release."
330 )
331
332 session.log("# Upload distributions")
333 session.run("twine", "upload", *distribution_files)
334
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/noxfile.py b/noxfile.py
--- a/noxfile.py
+++ b/noxfile.py
@@ -149,6 +149,9 @@
args = ["--all-files", "--show-diff-on-failure"]
session.run("pre-commit", "run", *args)
+ session.run(
+ "pre-commit", "run", "-c", ".pre-commit-config-slow.yaml", *args
+ )
@nox.session
|
{"golden_diff": "diff --git a/noxfile.py b/noxfile.py\n--- a/noxfile.py\n+++ b/noxfile.py\n@@ -149,6 +149,9 @@\n args = [\"--all-files\", \"--show-diff-on-failure\"]\n \n session.run(\"pre-commit\", \"run\", *args)\n+ session.run(\n+ \"pre-commit\", \"run\", \"-c\", \".pre-commit-config-slow.yaml\", *args\n+ )\n \n \n @nox.session\n", "issue": "Move slow check_manifest out of .pre-commit-config.yaml\nThe check-manifest pre-commit hook is by far the slowest of the checks, in particular when committing a few files.\r\n\r\nWhen pre-commit is installed locally as a pre-commit hook, it tends to slow down the development flow significantly.\r\n\r\nCould we move it out of the default pre-commit config to a regular CI check ?\r\n\n", "before_files": [{"content": "\"\"\"Automation using nox.\n\"\"\"\n\n# The following comment should be removed at some point in the future.\n# mypy: disallow-untyped-defs=False\n\nimport glob\nimport os\nimport shutil\nimport sys\nfrom pathlib import Path\n\nimport nox\n\nsys.path.append(\".\")\nfrom tools.automation import release # isort:skip # noqa\nsys.path.pop()\n\nnox.options.reuse_existing_virtualenvs = True\nnox.options.sessions = [\"lint\"]\n\nLOCATIONS = {\n \"common-wheels\": \"tests/data/common_wheels\",\n \"protected-pip\": \"tools/tox_pip.py\",\n}\nREQUIREMENTS = {\n \"docs\": \"tools/requirements/docs.txt\",\n \"tests\": \"tools/requirements/tests.txt\",\n \"common-wheels\": \"tools/requirements/tests-common_wheels.txt\",\n}\n\nAUTHORS_FILE = \"AUTHORS.txt\"\nVERSION_FILE = \"src/pip/__init__.py\"\n\n\ndef run_with_protected_pip(session, *arguments):\n \"\"\"Do a session.run(\"pip\", *arguments), using a \"protected\" pip.\n\n This invokes a wrapper script, that forwards calls to original virtualenv\n (stable) version, and not the code being tested. This ensures pip being\n used is not the code being tested.\n \"\"\"\n env = {\"VIRTUAL_ENV\": session.virtualenv.location}\n\n command = (\"python\", LOCATIONS[\"protected-pip\"]) + arguments\n kwargs = {\"env\": env, \"silent\": True}\n session.run(*command, **kwargs)\n\n\ndef should_update_common_wheels():\n # If the cache hasn't been created, create it.\n if not os.path.exists(LOCATIONS[\"common-wheels\"]):\n return True\n\n # If the requirements was updated after cache, we'll repopulate it.\n cache_last_populated_at = os.path.getmtime(LOCATIONS[\"common-wheels\"])\n requirements_updated_at = os.path.getmtime(REQUIREMENTS[\"common-wheels\"])\n need_to_repopulate = requirements_updated_at > cache_last_populated_at\n\n # Clear the stale cache.\n if need_to_repopulate:\n shutil.rmtree(LOCATIONS[\"common-wheels\"], ignore_errors=True)\n\n return need_to_repopulate\n\n\n# -----------------------------------------------------------------------------\n# Development Commands\n# These are currently prototypes to evaluate whether we want to switch over\n# completely to nox for all our automation. Contributors should prefer using\n# `tox -e ...` until this note is removed.\n# -----------------------------------------------------------------------------\[email protected](python=[\"3.6\", \"3.7\", \"3.8\", \"3.9\", \"pypy3\"])\ndef test(session):\n # Get the common wheels.\n if should_update_common_wheels():\n run_with_protected_pip(\n session,\n \"wheel\",\n \"-w\", LOCATIONS[\"common-wheels\"],\n \"-r\", REQUIREMENTS[\"common-wheels\"],\n )\n else:\n msg = (\n \"Re-using existing common-wheels at {}.\"\n .format(LOCATIONS[\"common-wheels\"])\n )\n session.log(msg)\n\n # Build source distribution\n sdist_dir = os.path.join(session.virtualenv.location, \"sdist\")\n if os.path.exists(sdist_dir):\n shutil.rmtree(sdist_dir, ignore_errors=True)\n session.run(\n \"python\", \"setup.py\", \"sdist\",\n \"--formats=zip\", \"--dist-dir\", sdist_dir,\n silent=True,\n )\n generated_files = os.listdir(sdist_dir)\n assert len(generated_files) == 1\n generated_sdist = os.path.join(sdist_dir, generated_files[0])\n\n # Install source distribution\n run_with_protected_pip(session, \"install\", generated_sdist)\n\n # Install test dependencies\n run_with_protected_pip(session, \"install\", \"-r\", REQUIREMENTS[\"tests\"])\n\n # Parallelize tests as much as possible, by default.\n arguments = session.posargs or [\"-n\", \"auto\"]\n\n # Run the tests\n # LC_CTYPE is set to get UTF-8 output inside of the subprocesses that our\n # tests use.\n session.run(\"pytest\", *arguments, env={\"LC_CTYPE\": \"en_US.UTF-8\"})\n\n\[email protected]\ndef docs(session):\n session.install(\"-e\", \".\")\n session.install(\"-r\", REQUIREMENTS[\"docs\"])\n\n def get_sphinx_build_command(kind):\n # Having the conf.py in the docs/html is weird but needed because we\n # can not use a different configuration directory vs source directory\n # on RTD currently. So, we'll pass \"-c docs/html\" here.\n # See https://github.com/rtfd/readthedocs.org/issues/1543.\n return [\n \"sphinx-build\",\n \"-W\",\n \"-c\", \"docs/html\", # see note above\n \"-d\", \"docs/build/doctrees/\" + kind,\n \"-b\", kind,\n \"docs/\" + kind,\n \"docs/build/\" + kind,\n ]\n\n session.run(*get_sphinx_build_command(\"html\"))\n session.run(*get_sphinx_build_command(\"man\"))\n\n\[email protected]\ndef lint(session):\n session.install(\"pre-commit\")\n\n if session.posargs:\n args = session.posargs + [\"--all-files\"]\n else:\n args = [\"--all-files\", \"--show-diff-on-failure\"]\n\n session.run(\"pre-commit\", \"run\", *args)\n\n\[email protected]\ndef vendoring(session):\n session.install(\"vendoring>=0.3.0\")\n\n if \"--upgrade\" not in session.posargs:\n session.run(\"vendoring\", \"sync\", \".\", \"-v\")\n return\n\n def pinned_requirements(path):\n for line in path.read_text().splitlines():\n one, two = line.split(\"==\", 1)\n name = one.strip()\n version = two.split(\"#\")[0].strip()\n yield name, version\n\n vendor_txt = Path(\"src/pip/_vendor/vendor.txt\")\n for name, old_version in pinned_requirements(vendor_txt):\n if name == \"setuptools\":\n continue\n\n # update requirements.txt\n session.run(\"vendoring\", \"update\", \".\", name)\n\n # get the updated version\n new_version = old_version\n for inner_name, inner_version in pinned_requirements(vendor_txt):\n if inner_name == name:\n # this is a dedicated assignment, to make flake8 happy\n new_version = inner_version\n break\n else:\n session.error(f\"Could not find {name} in {vendor_txt}\")\n\n # check if the version changed.\n if new_version == old_version:\n continue # no change, nothing more to do here.\n\n # synchronize the contents\n session.run(\"vendoring\", \"sync\", \".\")\n\n # Determine the correct message\n message = f\"Upgrade {name} to {new_version}\"\n\n # Write our news fragment\n news_file = Path(\"news\") / (name + \".vendor.rst\")\n news_file.write_text(message + \"\\n\") # \"\\n\" appeases end-of-line-fixer\n\n # Commit the changes\n release.commit_file(session, \".\", message=message)\n\n\n# -----------------------------------------------------------------------------\n# Release Commands\n# -----------------------------------------------------------------------------\[email protected](name=\"prepare-release\")\ndef prepare_release(session):\n version = release.get_version_from_arguments(session)\n if not version:\n session.error(\"Usage: nox -s prepare-release -- <version>\")\n\n session.log(\"# Ensure nothing is staged\")\n if release.modified_files_in_git(\"--staged\"):\n session.error(\"There are files staged in git\")\n\n session.log(f\"# Updating {AUTHORS_FILE}\")\n release.generate_authors(AUTHORS_FILE)\n if release.modified_files_in_git():\n release.commit_file(\n session, AUTHORS_FILE, message=f\"Update {AUTHORS_FILE}\",\n )\n else:\n session.log(f\"# No changes to {AUTHORS_FILE}\")\n\n session.log(\"# Generating NEWS\")\n release.generate_news(session, version)\n\n session.log(f\"# Bumping for release {version}\")\n release.update_version_file(version, VERSION_FILE)\n release.commit_file(session, VERSION_FILE, message=\"Bump for release\")\n\n session.log(\"# Tagging release\")\n release.create_git_tag(session, version, message=f\"Release {version}\")\n\n session.log(\"# Bumping for development\")\n next_dev_version = release.get_next_development_version(version)\n release.update_version_file(next_dev_version, VERSION_FILE)\n release.commit_file(session, VERSION_FILE, message=\"Bump for development\")\n\n\[email protected](name=\"build-release\")\ndef build_release(session):\n version = release.get_version_from_arguments(session)\n if not version:\n session.error(\"Usage: nox -s build-release -- YY.N[.P]\")\n\n session.log(\"# Ensure no files in dist/\")\n if release.have_files_in_folder(\"dist\"):\n session.error(\n \"There are files in dist/. Remove them and try again. \"\n \"You can use `git clean -fxdi -- dist` command to do this\"\n )\n\n session.log(\"# Install dependencies\")\n session.install(\"setuptools\", \"wheel\", \"twine\")\n\n with release.isolated_temporary_checkout(session, version) as build_dir:\n session.log(\n \"# Start the build in an isolated, \"\n f\"temporary Git checkout at {build_dir!s}\",\n )\n with release.workdir(session, build_dir):\n tmp_dists = build_dists(session)\n\n tmp_dist_paths = (build_dir / p for p in tmp_dists)\n session.log(f\"# Copying dists from {build_dir}\")\n os.makedirs('dist', exist_ok=True)\n for dist, final in zip(tmp_dist_paths, tmp_dists):\n session.log(f\"# Copying {dist} to {final}\")\n shutil.copy(dist, final)\n\n\ndef build_dists(session):\n \"\"\"Return dists with valid metadata.\"\"\"\n session.log(\n \"# Check if there's any Git-untracked files before building the wheel\",\n )\n\n has_forbidden_git_untracked_files = any(\n # Don't report the environment this session is running in\n not untracked_file.startswith('.nox/build-release/')\n for untracked_file in release.get_git_untracked_files()\n )\n if has_forbidden_git_untracked_files:\n session.error(\n \"There are untracked files in the working directory. \"\n \"Remove them and try again\",\n )\n\n session.log(\"# Build distributions\")\n session.run(\"python\", \"setup.py\", \"sdist\", \"bdist_wheel\", silent=True)\n produced_dists = glob.glob(\"dist/*\")\n\n session.log(f\"# Verify distributions: {', '.join(produced_dists)}\")\n session.run(\"twine\", \"check\", *produced_dists, silent=True)\n\n return produced_dists\n\n\[email protected](name=\"upload-release\")\ndef upload_release(session):\n version = release.get_version_from_arguments(session)\n if not version:\n session.error(\"Usage: nox -s upload-release -- YY.N[.P]\")\n\n session.log(\"# Install dependencies\")\n session.install(\"twine\")\n\n distribution_files = glob.glob(\"dist/*\")\n session.log(f\"# Distribution files: {distribution_files}\")\n\n # Sanity check: Make sure there's 2 distribution files.\n count = len(distribution_files)\n if count != 2:\n session.error(\n f\"Expected 2 distribution files for upload, got {count}. \"\n f\"Remove dist/ and run 'nox -s build-release -- {version}'\"\n )\n # Sanity check: Make sure the files are correctly named.\n distfile_names = map(os.path.basename, distribution_files)\n expected_distribution_files = [\n f\"pip-{version}-py2.py3-none-any.whl\",\n f\"pip-{version}.tar.gz\",\n ]\n if sorted(distfile_names) != sorted(expected_distribution_files):\n session.error(\n f\"Distribution files do not seem to be for {version} release.\"\n )\n\n session.log(\"# Upload distributions\")\n session.run(\"twine\", \"upload\", *distribution_files)\n", "path": "noxfile.py"}], "after_files": [{"content": "\"\"\"Automation using nox.\n\"\"\"\n\n# The following comment should be removed at some point in the future.\n# mypy: disallow-untyped-defs=False\n\nimport glob\nimport os\nimport shutil\nimport sys\nfrom pathlib import Path\n\nimport nox\n\nsys.path.append(\".\")\nfrom tools.automation import release # isort:skip # noqa\nsys.path.pop()\n\nnox.options.reuse_existing_virtualenvs = True\nnox.options.sessions = [\"lint\"]\n\nLOCATIONS = {\n \"common-wheels\": \"tests/data/common_wheels\",\n \"protected-pip\": \"tools/tox_pip.py\",\n}\nREQUIREMENTS = {\n \"docs\": \"tools/requirements/docs.txt\",\n \"tests\": \"tools/requirements/tests.txt\",\n \"common-wheels\": \"tools/requirements/tests-common_wheels.txt\",\n}\n\nAUTHORS_FILE = \"AUTHORS.txt\"\nVERSION_FILE = \"src/pip/__init__.py\"\n\n\ndef run_with_protected_pip(session, *arguments):\n \"\"\"Do a session.run(\"pip\", *arguments), using a \"protected\" pip.\n\n This invokes a wrapper script, that forwards calls to original virtualenv\n (stable) version, and not the code being tested. This ensures pip being\n used is not the code being tested.\n \"\"\"\n env = {\"VIRTUAL_ENV\": session.virtualenv.location}\n\n command = (\"python\", LOCATIONS[\"protected-pip\"]) + arguments\n kwargs = {\"env\": env, \"silent\": True}\n session.run(*command, **kwargs)\n\n\ndef should_update_common_wheels():\n # If the cache hasn't been created, create it.\n if not os.path.exists(LOCATIONS[\"common-wheels\"]):\n return True\n\n # If the requirements was updated after cache, we'll repopulate it.\n cache_last_populated_at = os.path.getmtime(LOCATIONS[\"common-wheels\"])\n requirements_updated_at = os.path.getmtime(REQUIREMENTS[\"common-wheels\"])\n need_to_repopulate = requirements_updated_at > cache_last_populated_at\n\n # Clear the stale cache.\n if need_to_repopulate:\n shutil.rmtree(LOCATIONS[\"common-wheels\"], ignore_errors=True)\n\n return need_to_repopulate\n\n\n# -----------------------------------------------------------------------------\n# Development Commands\n# These are currently prototypes to evaluate whether we want to switch over\n# completely to nox for all our automation. Contributors should prefer using\n# `tox -e ...` until this note is removed.\n# -----------------------------------------------------------------------------\[email protected](python=[\"2.7\", \"3.5\", \"3.6\", \"3.7\", \"3.8\", \"3.9\", \"pypy\", \"pypy3\"])\ndef test(session):\n # Get the common wheels.\n if should_update_common_wheels():\n run_with_protected_pip(\n session,\n \"wheel\",\n \"-w\", LOCATIONS[\"common-wheels\"],\n \"-r\", REQUIREMENTS[\"common-wheels\"],\n )\n else:\n msg = (\n \"Re-using existing common-wheels at {}.\"\n .format(LOCATIONS[\"common-wheels\"])\n )\n session.log(msg)\n\n # Build source distribution\n sdist_dir = os.path.join(session.virtualenv.location, \"sdist\")\n if os.path.exists(sdist_dir):\n shutil.rmtree(sdist_dir, ignore_errors=True)\n session.run(\n \"python\", \"setup.py\", \"sdist\",\n \"--formats=zip\", \"--dist-dir\", sdist_dir,\n silent=True,\n )\n generated_files = os.listdir(sdist_dir)\n assert len(generated_files) == 1\n generated_sdist = os.path.join(sdist_dir, generated_files[0])\n\n # Install source distribution\n run_with_protected_pip(session, \"install\", generated_sdist)\n\n # Install test dependencies\n run_with_protected_pip(session, \"install\", \"-r\", REQUIREMENTS[\"tests\"])\n\n # Parallelize tests as much as possible, by default.\n arguments = session.posargs or [\"-n\", \"auto\"]\n\n # Run the tests\n # LC_CTYPE is set to get UTF-8 output inside of the subprocesses that our\n # tests use.\n session.run(\"pytest\", *arguments, env={\"LC_CTYPE\": \"en_US.UTF-8\"})\n\n\[email protected]\ndef docs(session):\n session.install(\"-e\", \".\")\n session.install(\"-r\", REQUIREMENTS[\"docs\"])\n\n def get_sphinx_build_command(kind):\n # Having the conf.py in the docs/html is weird but needed because we\n # can not use a different configuration directory vs source directory\n # on RTD currently. So, we'll pass \"-c docs/html\" here.\n # See https://github.com/rtfd/readthedocs.org/issues/1543.\n return [\n \"sphinx-build\",\n \"-W\",\n \"-c\", \"docs/html\", # see note above\n \"-d\", \"docs/build/doctrees/\" + kind,\n \"-b\", kind,\n \"docs/\" + kind,\n \"docs/build/\" + kind,\n ]\n\n session.run(*get_sphinx_build_command(\"html\"))\n session.run(*get_sphinx_build_command(\"man\"))\n\n\[email protected]\ndef lint(session):\n session.install(\"pre-commit\")\n\n if session.posargs:\n args = session.posargs + [\"--all-files\"]\n else:\n args = [\"--all-files\", \"--show-diff-on-failure\"]\n\n session.run(\"pre-commit\", \"run\", *args)\n session.run(\n \"pre-commit\", \"run\", \"-c\", \".pre-commit-config-slow.yaml\", *args\n )\n\n\[email protected]\ndef vendoring(session):\n session.install(\"vendoring>=0.3.0\")\n\n if \"--upgrade\" not in session.posargs:\n session.run(\"vendoring\", \"sync\", \".\", \"-v\")\n return\n\n def pinned_requirements(path):\n for line in path.read_text().splitlines():\n one, two = line.split(\"==\", 1)\n name = one.strip()\n version = two.split(\"#\")[0].strip()\n yield name, version\n\n vendor_txt = Path(\"src/pip/_vendor/vendor.txt\")\n for name, old_version in pinned_requirements(vendor_txt):\n if name == \"setuptools\":\n continue\n\n # update requirements.txt\n session.run(\"vendoring\", \"update\", \".\", name)\n\n # get the updated version\n new_version = old_version\n for inner_name, inner_version in pinned_requirements(vendor_txt):\n if inner_name == name:\n # this is a dedicated assignment, to make flake8 happy\n new_version = inner_version\n break\n else:\n session.error(f\"Could not find {name} in {vendor_txt}\")\n\n # check if the version changed.\n if new_version == old_version:\n continue # no change, nothing more to do here.\n\n # synchronize the contents\n session.run(\"vendoring\", \"sync\", \".\")\n\n # Determine the correct message\n message = f\"Upgrade {name} to {new_version}\"\n\n # Write our news fragment\n news_file = Path(\"news\") / (name + \".vendor.rst\")\n news_file.write_text(message + \"\\n\") # \"\\n\" appeases end-of-line-fixer\n\n # Commit the changes\n release.commit_file(session, \".\", message=message)\n\n\n# -----------------------------------------------------------------------------\n# Release Commands\n# -----------------------------------------------------------------------------\[email protected](name=\"prepare-release\")\ndef prepare_release(session):\n version = release.get_version_from_arguments(session)\n if not version:\n session.error(\"Usage: nox -s prepare-release -- <version>\")\n\n session.log(\"# Ensure nothing is staged\")\n if release.modified_files_in_git(\"--staged\"):\n session.error(\"There are files staged in git\")\n\n session.log(f\"# Updating {AUTHORS_FILE}\")\n release.generate_authors(AUTHORS_FILE)\n if release.modified_files_in_git():\n release.commit_file(\n session, AUTHORS_FILE, message=f\"Update {AUTHORS_FILE}\",\n )\n else:\n session.log(f\"# No changes to {AUTHORS_FILE}\")\n\n session.log(\"# Generating NEWS\")\n release.generate_news(session, version)\n\n session.log(f\"# Bumping for release {version}\")\n release.update_version_file(version, VERSION_FILE)\n release.commit_file(session, VERSION_FILE, message=\"Bump for release\")\n\n session.log(\"# Tagging release\")\n release.create_git_tag(session, version, message=f\"Release {version}\")\n\n session.log(\"# Bumping for development\")\n next_dev_version = release.get_next_development_version(version)\n release.update_version_file(next_dev_version, VERSION_FILE)\n release.commit_file(session, VERSION_FILE, message=\"Bump for development\")\n\n\[email protected](name=\"build-release\")\ndef build_release(session):\n version = release.get_version_from_arguments(session)\n if not version:\n session.error(\"Usage: nox -s build-release -- YY.N[.P]\")\n\n session.log(\"# Ensure no files in dist/\")\n if release.have_files_in_folder(\"dist\"):\n session.error(\n \"There are files in dist/. Remove them and try again. \"\n \"You can use `git clean -fxdi -- dist` command to do this\"\n )\n\n session.log(\"# Install dependencies\")\n session.install(\"setuptools\", \"wheel\", \"twine\")\n\n with release.isolated_temporary_checkout(session, version) as build_dir:\n session.log(\n \"# Start the build in an isolated, \"\n f\"temporary Git checkout at {build_dir!s}\",\n )\n with release.workdir(session, build_dir):\n tmp_dists = build_dists(session)\n\n tmp_dist_paths = (build_dir / p for p in tmp_dists)\n session.log(f\"# Copying dists from {build_dir}\")\n os.makedirs('dist', exist_ok=True)\n for dist, final in zip(tmp_dist_paths, tmp_dists):\n session.log(f\"# Copying {dist} to {final}\")\n shutil.copy(dist, final)\n\n\ndef build_dists(session):\n \"\"\"Return dists with valid metadata.\"\"\"\n session.log(\n \"# Check if there's any Git-untracked files before building the wheel\",\n )\n\n has_forbidden_git_untracked_files = any(\n # Don't report the environment this session is running in\n not untracked_file.startswith('.nox/build-release/')\n for untracked_file in release.get_git_untracked_files()\n )\n if has_forbidden_git_untracked_files:\n session.error(\n \"There are untracked files in the working directory. \"\n \"Remove them and try again\",\n )\n\n session.log(\"# Build distributions\")\n session.run(\"python\", \"setup.py\", \"sdist\", \"bdist_wheel\", silent=True)\n produced_dists = glob.glob(\"dist/*\")\n\n session.log(f\"# Verify distributions: {', '.join(produced_dists)}\")\n session.run(\"twine\", \"check\", *produced_dists, silent=True)\n\n return produced_dists\n\n\[email protected](name=\"upload-release\")\ndef upload_release(session):\n version = release.get_version_from_arguments(session)\n if not version:\n session.error(\"Usage: nox -s upload-release -- YY.N[.P]\")\n\n session.log(\"# Install dependencies\")\n session.install(\"twine\")\n\n distribution_files = glob.glob(\"dist/*\")\n session.log(f\"# Distribution files: {distribution_files}\")\n\n # Sanity check: Make sure there's 2 distribution files.\n count = len(distribution_files)\n if count != 2:\n session.error(\n f\"Expected 2 distribution files for upload, got {count}. \"\n f\"Remove dist/ and run 'nox -s build-release -- {version}'\"\n )\n # Sanity check: Make sure the files are correctly named.\n distfile_names = map(os.path.basename, distribution_files)\n expected_distribution_files = [\n f\"pip-{version}-py2.py3-none-any.whl\",\n f\"pip-{version}.tar.gz\",\n ]\n if sorted(distfile_names) != sorted(expected_distribution_files):\n session.error(\n f\"Distribution files do not seem to be for {version} release.\"\n )\n\n session.log(\"# Upload distributions\")\n session.run(\"twine\", \"upload\", *distribution_files)\n", "path": "noxfile.py"}]}
| 3,844 | 108 |
gh_patches_debug_5599
|
rasdani/github-patches
|
git_diff
|
sql-machine-learning__elasticdl-1830
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
worker pod crashes when get task
```
2020-03-12 22:03:32.300671: W tensorflow/core/kernels/data/generator_dataset_op.cc:103] Error occurred when finalizing GeneratorDataset iterator: Cancelled: Operation was cancelled
Traceback (most recent call last):
File "/usr/lib/python3.6/runpy.py", line 193, in _run_module_as_main
"__main__", mod_spec)
File "/usr/lib/python3.6/runpy.py", line 85, in _run_code
exec(code, run_globals)
File "/elasticdl/python/worker/main.py", line 44, in <module>
main()
File "/elasticdl/python/worker/main.py", line 40, in main
worker.run()
File "/elasticdl/python/worker/worker.py", line 1144, in run
self._train_and_evaluate()
File "/elasticdl/python/worker/worker.py", line 1074, in _train_and_evaluate
self._minibatch_size, err_msg
File "/elasticdl/python/worker/task_data_service.py", line 86, in report_record_done
task = self._pending_tasks[0]
IndexError: deque index out of range
```
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `elasticdl/python/worker/task_data_service.py`
Content:
```
1 import threading
2 import time
3 from collections import deque
4
5 import tensorflow as tf
6
7 from elasticdl.proto import elasticdl_pb2
8 from elasticdl.python.common.constants import TaskExecCounterKey
9 from elasticdl.python.common.log_utils import default_logger as logger
10 from elasticdl.python.data.reader.data_reader_factory import create_data_reader
11
12
13 class TaskDataService(object):
14 def __init__(
15 self, worker, training_with_evaluation, data_reader_params=None
16 ):
17 self._worker = worker
18 self._create_data_reader_fn = create_data_reader
19 if self._worker._custom_data_reader is not None:
20 self._create_data_reader_fn = self._worker._custom_data_reader
21 self._training_with_evaluation = training_with_evaluation
22 self._lock = threading.Lock()
23 self._pending_dataset = True
24 self._pending_train_end_callback_task = None
25 if data_reader_params:
26 self.data_reader = self._create_data_reader_fn(
27 data_origin=None, **data_reader_params
28 )
29 else:
30 self.data_reader = self._create_data_reader_fn(data_origin=None)
31 self._warm_up_task = None
32 self._has_warmed_up = False
33 self._failed_record_count = 0
34 self._reported_record_count = 0
35 self._current_task = None
36 self._pending_tasks = deque()
37
38 def _reset(self):
39 """
40 Reset pending tasks and record counts
41 """
42 self._reported_record_count = 0
43 self._failed_record_count = 0
44 self._pending_tasks = deque()
45 self._current_task = None
46
47 def get_current_task(self):
48 return self._current_task
49
50 def _do_report_task(self, task, err_msg=""):
51 if self._failed_record_count != 0:
52 exec_counters = {
53 TaskExecCounterKey.FAIL_COUNT: self._failed_record_count
54 }
55 else:
56 exec_counters = None
57 self._worker.report_task_result(
58 task.task_id, err_msg, exec_counters=exec_counters
59 )
60
61 def _log_fail_records(self, task, err_msg):
62 task_len = task.end - task.start
63 msg = (
64 "records ({f}/{t}) failure, possible "
65 "in task_id: {task_id} "
66 'reason "{err_msg}"'
67 ).format(
68 task_id=task.task_id,
69 err_msg=err_msg,
70 f=self._failed_record_count,
71 t=task_len,
72 )
73 logger.warning(msg)
74
75 def report_record_done(self, count, err_msg=""):
76 """
77 Report the number of records in the latest processed batch,
78 so TaskDataService knows if some pending tasks are finished
79 and report_task_result to the master.
80 Return True if there are some finished tasks, False otherwise.
81 """
82 self._reported_record_count += count
83 if err_msg:
84 self._failed_record_count += count
85
86 task = self._pending_tasks[0]
87 total_record_num = task.end - task.start
88 if self._reported_record_count >= total_record_num:
89 if err_msg:
90 self._log_fail_records(task, err_msg)
91
92 # Keep popping tasks until the reported record count is less
93 # than the size of the current data since `batch_size` may be
94 # larger than `task.end - task.start`
95 with self._lock:
96 while self._pending_tasks and self._reported_record_count >= (
97 self._pending_tasks[0].end - self._pending_tasks[0].start
98 ):
99 task = self._pending_tasks[0]
100 self._reported_record_count -= task.end - task.start
101 self._pending_tasks.popleft()
102 self._do_report_task(task, err_msg)
103 self._failed_record_count = 0
104 if self._pending_tasks:
105 self._current_task = self._pending_tasks[0]
106 return True
107 return False
108
109 def get_dataset_gen(self, task):
110 """
111 If a task exists, this creates a generator, which could be used to
112 creating a `tf.data.Dataset` object in further.
113 """
114 if not task:
115 return None
116 tasks = [task]
117
118 def gen():
119 for task in tasks:
120 for data in self.data_reader.read_records(task):
121 if data:
122 yield data
123
124 return gen
125
126 def get_dataset_by_task(self, task):
127 if task is None:
128 return None
129 gen = self.get_dataset_gen(task)
130 dataset = tf.data.Dataset.from_generator(
131 gen, self.data_reader.records_output_types
132 )
133 return dataset
134
135 def get_train_end_callback_task(self):
136 return self._pending_train_end_callback_task
137
138 def clear_train_end_callback_task(self):
139 self._pending_train_end_callback_task = None
140
141 def get_dataset(self):
142 """
143 If there's more data, this creates a `tf.data.Dataset` object.
144 Otherwise, this returns `None`.
145 """
146 if self._pending_dataset:
147 if self._pending_tasks:
148 logger.error(
149 "Cannot get new dataset when there are pending tasks"
150 )
151 return None
152 self._reset()
153 # We use a task to perform warm-up for data reader in order
154 # to collect useful metadata. Note that we only performs
155 # data fetching for this task and `break` instantly to make
156 # sure `read_records()` is executed without iterating all the
157 # records so this should not be time consuming.
158 if self._warm_up_task is None and not self._has_warmed_up:
159 while True:
160 task = self._worker.get_task()
161 if task.type != elasticdl_pb2.WAIT:
162 break
163 time.sleep(2)
164 if task.type == elasticdl_pb2.TRAIN_END_CALLBACK:
165 self._pending_train_end_callback_task = task
166 return None
167 elif not task.shard_name:
168 logger.info("No more task, stopping")
169 return None
170 else:
171 self._warm_up_task = task
172 for _ in self.data_reader.read_records(task):
173 break
174 self._has_warmed_up = True
175 ds = tf.data.Dataset.from_generator(
176 self._gen, self.data_reader.records_output_types
177 )
178 self._pending_dataset = False
179 return ds
180 else:
181 return None
182
183 def _gen(self):
184 """
185 A generator supports the iter() protocol (e.g. a generator function),
186 used to create a `tf.data.Dataset` object from a list of tasks.
187 """
188 while True:
189 # Make sure we also generate data from the warm-up task.
190 if self._warm_up_task is not None and self._has_warmed_up:
191 task = self._warm_up_task
192 self._warm_up_task = None
193 else:
194 task = self._worker.get_task()
195 if not task.shard_name:
196 if task.type == elasticdl_pb2.WAIT:
197 self._pending_dataset = True
198 logger.info("No tasks for now, maybe more later")
199 else:
200 logger.info("No more task, stopping")
201 break
202 with self._lock:
203 if task.type == elasticdl_pb2.TRAIN_END_CALLBACK:
204 self._pending_train_end_callback_task = task
205 continue
206
207 self._pending_tasks.append(task)
208 if len(self._pending_tasks) == 1:
209 self._current_task = task
210 for data in self.data_reader.read_records(task):
211 if data:
212 yield data
213
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/elasticdl/python/worker/task_data_service.py b/elasticdl/python/worker/task_data_service.py
--- a/elasticdl/python/worker/task_data_service.py
+++ b/elasticdl/python/worker/task_data_service.py
@@ -83,6 +83,9 @@
if err_msg:
self._failed_record_count += count
+ # TODO(qijun) This is a workaround for #1829
+ if not self._pending_tasks:
+ return False
task = self._pending_tasks[0]
total_record_num = task.end - task.start
if self._reported_record_count >= total_record_num:
|
{"golden_diff": "diff --git a/elasticdl/python/worker/task_data_service.py b/elasticdl/python/worker/task_data_service.py\n--- a/elasticdl/python/worker/task_data_service.py\n+++ b/elasticdl/python/worker/task_data_service.py\n@@ -83,6 +83,9 @@\n if err_msg:\n self._failed_record_count += count\n \n+ # TODO(qijun) This is a workaround for #1829\n+ if not self._pending_tasks:\n+ return False\n task = self._pending_tasks[0]\n total_record_num = task.end - task.start\n if self._reported_record_count >= total_record_num:\n", "issue": "worker pod crashes when get task\n```\r\n2020-03-12 22:03:32.300671: W tensorflow/core/kernels/data/generator_dataset_op.cc:103] Error occurred when finalizing GeneratorDataset iterator: Cancelled: Operation was cancelled\r\nTraceback (most recent call last):\r\n File \"/usr/lib/python3.6/runpy.py\", line 193, in _run_module_as_main\r\n \"__main__\", mod_spec)\r\n File \"/usr/lib/python3.6/runpy.py\", line 85, in _run_code\r\n exec(code, run_globals)\r\n File \"/elasticdl/python/worker/main.py\", line 44, in <module>\r\n main()\r\n File \"/elasticdl/python/worker/main.py\", line 40, in main\r\n worker.run()\r\n File \"/elasticdl/python/worker/worker.py\", line 1144, in run\r\n self._train_and_evaluate()\r\n File \"/elasticdl/python/worker/worker.py\", line 1074, in _train_and_evaluate\r\n self._minibatch_size, err_msg\r\n File \"/elasticdl/python/worker/task_data_service.py\", line 86, in report_record_done\r\n task = self._pending_tasks[0]\r\nIndexError: deque index out of range\r\n```\n", "before_files": [{"content": "import threading\nimport time\nfrom collections import deque\n\nimport tensorflow as tf\n\nfrom elasticdl.proto import elasticdl_pb2\nfrom elasticdl.python.common.constants import TaskExecCounterKey\nfrom elasticdl.python.common.log_utils import default_logger as logger\nfrom elasticdl.python.data.reader.data_reader_factory import create_data_reader\n\n\nclass TaskDataService(object):\n def __init__(\n self, worker, training_with_evaluation, data_reader_params=None\n ):\n self._worker = worker\n self._create_data_reader_fn = create_data_reader\n if self._worker._custom_data_reader is not None:\n self._create_data_reader_fn = self._worker._custom_data_reader\n self._training_with_evaluation = training_with_evaluation\n self._lock = threading.Lock()\n self._pending_dataset = True\n self._pending_train_end_callback_task = None\n if data_reader_params:\n self.data_reader = self._create_data_reader_fn(\n data_origin=None, **data_reader_params\n )\n else:\n self.data_reader = self._create_data_reader_fn(data_origin=None)\n self._warm_up_task = None\n self._has_warmed_up = False\n self._failed_record_count = 0\n self._reported_record_count = 0\n self._current_task = None\n self._pending_tasks = deque()\n\n def _reset(self):\n \"\"\"\n Reset pending tasks and record counts\n \"\"\"\n self._reported_record_count = 0\n self._failed_record_count = 0\n self._pending_tasks = deque()\n self._current_task = None\n\n def get_current_task(self):\n return self._current_task\n\n def _do_report_task(self, task, err_msg=\"\"):\n if self._failed_record_count != 0:\n exec_counters = {\n TaskExecCounterKey.FAIL_COUNT: self._failed_record_count\n }\n else:\n exec_counters = None\n self._worker.report_task_result(\n task.task_id, err_msg, exec_counters=exec_counters\n )\n\n def _log_fail_records(self, task, err_msg):\n task_len = task.end - task.start\n msg = (\n \"records ({f}/{t}) failure, possible \"\n \"in task_id: {task_id} \"\n 'reason \"{err_msg}\"'\n ).format(\n task_id=task.task_id,\n err_msg=err_msg,\n f=self._failed_record_count,\n t=task_len,\n )\n logger.warning(msg)\n\n def report_record_done(self, count, err_msg=\"\"):\n \"\"\"\n Report the number of records in the latest processed batch,\n so TaskDataService knows if some pending tasks are finished\n and report_task_result to the master.\n Return True if there are some finished tasks, False otherwise.\n \"\"\"\n self._reported_record_count += count\n if err_msg:\n self._failed_record_count += count\n\n task = self._pending_tasks[0]\n total_record_num = task.end - task.start\n if self._reported_record_count >= total_record_num:\n if err_msg:\n self._log_fail_records(task, err_msg)\n\n # Keep popping tasks until the reported record count is less\n # than the size of the current data since `batch_size` may be\n # larger than `task.end - task.start`\n with self._lock:\n while self._pending_tasks and self._reported_record_count >= (\n self._pending_tasks[0].end - self._pending_tasks[0].start\n ):\n task = self._pending_tasks[0]\n self._reported_record_count -= task.end - task.start\n self._pending_tasks.popleft()\n self._do_report_task(task, err_msg)\n self._failed_record_count = 0\n if self._pending_tasks:\n self._current_task = self._pending_tasks[0]\n return True\n return False\n\n def get_dataset_gen(self, task):\n \"\"\"\n If a task exists, this creates a generator, which could be used to\n creating a `tf.data.Dataset` object in further.\n \"\"\"\n if not task:\n return None\n tasks = [task]\n\n def gen():\n for task in tasks:\n for data in self.data_reader.read_records(task):\n if data:\n yield data\n\n return gen\n\n def get_dataset_by_task(self, task):\n if task is None:\n return None\n gen = self.get_dataset_gen(task)\n dataset = tf.data.Dataset.from_generator(\n gen, self.data_reader.records_output_types\n )\n return dataset\n\n def get_train_end_callback_task(self):\n return self._pending_train_end_callback_task\n\n def clear_train_end_callback_task(self):\n self._pending_train_end_callback_task = None\n\n def get_dataset(self):\n \"\"\"\n If there's more data, this creates a `tf.data.Dataset` object.\n Otherwise, this returns `None`.\n \"\"\"\n if self._pending_dataset:\n if self._pending_tasks:\n logger.error(\n \"Cannot get new dataset when there are pending tasks\"\n )\n return None\n self._reset()\n # We use a task to perform warm-up for data reader in order\n # to collect useful metadata. Note that we only performs\n # data fetching for this task and `break` instantly to make\n # sure `read_records()` is executed without iterating all the\n # records so this should not be time consuming.\n if self._warm_up_task is None and not self._has_warmed_up:\n while True:\n task = self._worker.get_task()\n if task.type != elasticdl_pb2.WAIT:\n break\n time.sleep(2)\n if task.type == elasticdl_pb2.TRAIN_END_CALLBACK:\n self._pending_train_end_callback_task = task\n return None\n elif not task.shard_name:\n logger.info(\"No more task, stopping\")\n return None\n else:\n self._warm_up_task = task\n for _ in self.data_reader.read_records(task):\n break\n self._has_warmed_up = True\n ds = tf.data.Dataset.from_generator(\n self._gen, self.data_reader.records_output_types\n )\n self._pending_dataset = False\n return ds\n else:\n return None\n\n def _gen(self):\n \"\"\"\n A generator supports the iter() protocol (e.g. a generator function),\n used to create a `tf.data.Dataset` object from a list of tasks.\n \"\"\"\n while True:\n # Make sure we also generate data from the warm-up task.\n if self._warm_up_task is not None and self._has_warmed_up:\n task = self._warm_up_task\n self._warm_up_task = None\n else:\n task = self._worker.get_task()\n if not task.shard_name:\n if task.type == elasticdl_pb2.WAIT:\n self._pending_dataset = True\n logger.info(\"No tasks for now, maybe more later\")\n else:\n logger.info(\"No more task, stopping\")\n break\n with self._lock:\n if task.type == elasticdl_pb2.TRAIN_END_CALLBACK:\n self._pending_train_end_callback_task = task\n continue\n\n self._pending_tasks.append(task)\n if len(self._pending_tasks) == 1:\n self._current_task = task\n for data in self.data_reader.read_records(task):\n if data:\n yield data\n", "path": "elasticdl/python/worker/task_data_service.py"}], "after_files": [{"content": "import threading\nimport time\nfrom collections import deque\n\nimport tensorflow as tf\n\nfrom elasticdl.proto import elasticdl_pb2\nfrom elasticdl.python.common.constants import TaskExecCounterKey\nfrom elasticdl.python.common.log_utils import default_logger as logger\nfrom elasticdl.python.data.reader.data_reader_factory import create_data_reader\n\n\nclass TaskDataService(object):\n def __init__(\n self, worker, training_with_evaluation, data_reader_params=None\n ):\n self._worker = worker\n self._create_data_reader_fn = create_data_reader\n if self._worker._custom_data_reader is not None:\n self._create_data_reader_fn = self._worker._custom_data_reader\n self._training_with_evaluation = training_with_evaluation\n self._lock = threading.Lock()\n self._pending_dataset = True\n self._pending_train_end_callback_task = None\n if data_reader_params:\n self.data_reader = self._create_data_reader_fn(\n data_origin=None, **data_reader_params\n )\n else:\n self.data_reader = self._create_data_reader_fn(data_origin=None)\n self._warm_up_task = None\n self._has_warmed_up = False\n self._failed_record_count = 0\n self._reported_record_count = 0\n self._current_task = None\n self._pending_tasks = deque()\n\n def _reset(self):\n \"\"\"\n Reset pending tasks and record counts\n \"\"\"\n self._reported_record_count = 0\n self._failed_record_count = 0\n self._pending_tasks = deque()\n self._current_task = None\n\n def get_current_task(self):\n return self._current_task\n\n def _do_report_task(self, task, err_msg=\"\"):\n if self._failed_record_count != 0:\n exec_counters = {\n TaskExecCounterKey.FAIL_COUNT: self._failed_record_count\n }\n else:\n exec_counters = None\n self._worker.report_task_result(\n task.task_id, err_msg, exec_counters=exec_counters\n )\n\n def _log_fail_records(self, task, err_msg):\n task_len = task.end - task.start\n msg = (\n \"records ({f}/{t}) failure, possible \"\n \"in task_id: {task_id} \"\n 'reason \"{err_msg}\"'\n ).format(\n task_id=task.task_id,\n err_msg=err_msg,\n f=self._failed_record_count,\n t=task_len,\n )\n logger.warning(msg)\n\n def report_record_done(self, count, err_msg=\"\"):\n \"\"\"\n Report the number of records in the latest processed batch,\n so TaskDataService knows if some pending tasks are finished\n and report_task_result to the master.\n Return True if there are some finished tasks, False otherwise.\n \"\"\"\n self._reported_record_count += count\n if err_msg:\n self._failed_record_count += count\n\n # TODO(qijun) This is a workaround for #1829\n if not self._pending_tasks:\n return False\n task = self._pending_tasks[0]\n total_record_num = task.end - task.start\n if self._reported_record_count >= total_record_num:\n if err_msg:\n self._log_fail_records(task, err_msg)\n\n # Keep popping tasks until the reported record count is less\n # than the size of the current data since `batch_size` may be\n # larger than `task.end - task.start`\n with self._lock:\n while self._pending_tasks and self._reported_record_count >= (\n self._pending_tasks[0].end - self._pending_tasks[0].start\n ):\n task = self._pending_tasks[0]\n self._reported_record_count -= task.end - task.start\n self._pending_tasks.popleft()\n self._do_report_task(task, err_msg)\n self._failed_record_count = 0\n if self._pending_tasks:\n self._current_task = self._pending_tasks[0]\n return True\n return False\n\n def get_dataset_gen(self, task):\n \"\"\"\n If a task exists, this creates a generator, which could be used to\n creating a `tf.data.Dataset` object in further.\n \"\"\"\n if not task:\n return None\n tasks = [task]\n\n def gen():\n for task in tasks:\n for data in self.data_reader.read_records(task):\n if data:\n yield data\n\n return gen\n\n def get_dataset_by_task(self, task):\n if task is None:\n return None\n gen = self.get_dataset_gen(task)\n dataset = tf.data.Dataset.from_generator(\n gen, self.data_reader.records_output_types\n )\n return dataset\n\n def get_train_end_callback_task(self):\n return self._pending_train_end_callback_task\n\n def clear_train_end_callback_task(self):\n self._pending_train_end_callback_task = None\n\n def get_dataset(self):\n \"\"\"\n If there's more data, this creates a `tf.data.Dataset` object.\n Otherwise, this returns `None`.\n \"\"\"\n if self._pending_dataset:\n if self._pending_tasks:\n logger.error(\n \"Cannot get new dataset when there are pending tasks\"\n )\n return None\n self._reset()\n # We use a task to perform warm-up for data reader in order\n # to collect useful metadata. Note that we only performs\n # data fetching for this task and `break` instantly to make\n # sure `read_records()` is executed without iterating all the\n # records so this should not be time consuming.\n if self._warm_up_task is None and not self._has_warmed_up:\n while True:\n task = self._worker.get_task()\n if task.type != elasticdl_pb2.WAIT:\n break\n time.sleep(2)\n if task.type == elasticdl_pb2.TRAIN_END_CALLBACK:\n self._pending_train_end_callback_task = task\n return None\n elif not task.shard_name:\n logger.info(\"No more task, stopping\")\n return None\n else:\n self._warm_up_task = task\n for _ in self.data_reader.read_records(task):\n break\n self._has_warmed_up = True\n ds = tf.data.Dataset.from_generator(\n self._gen, self.data_reader.records_output_types\n )\n self._pending_dataset = False\n return ds\n else:\n return None\n\n def _gen(self):\n \"\"\"\n A generator supports the iter() protocol (e.g. a generator function),\n used to create a `tf.data.Dataset` object from a list of tasks.\n \"\"\"\n while True:\n # Make sure we also generate data from the warm-up task.\n if self._warm_up_task is not None and self._has_warmed_up:\n task = self._warm_up_task\n self._warm_up_task = None\n else:\n task = self._worker.get_task()\n if not task.shard_name:\n if task.type == elasticdl_pb2.WAIT:\n self._pending_dataset = True\n logger.info(\"No tasks for now, maybe more later\")\n else:\n logger.info(\"No more task, stopping\")\n break\n with self._lock:\n if task.type == elasticdl_pb2.TRAIN_END_CALLBACK:\n self._pending_train_end_callback_task = task\n continue\n\n self._pending_tasks.append(task)\n if len(self._pending_tasks) == 1:\n self._current_task = task\n for data in self.data_reader.read_records(task):\n if data:\n yield data\n", "path": "elasticdl/python/worker/task_data_service.py"}]}
| 2,689 | 144 |
gh_patches_debug_24101
|
rasdani/github-patches
|
git_diff
|
azavea__raster-vision-844
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Get Sphinx to render Google-style API docs correctly
In the API docs on RTD https://docs.rastervision.io/en/latest/api.html, the line breaks in the docs aren't rendered correctly. In particular, the `lr` argument for the PyTorch backends is on the same line as the `batch_size` argument, which obscures the `lr` argument. I think this is because we are using Google style PyDocs which aren't natively supported by Sphinx. However, there is a plugin for doing this:
https://stackoverflow.com/questions/7033239/how-to-preserve-line-breaks-when-generating-python-docs-using-sphinx
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `docs/conf.py`
Content:
```
1 from pallets_sphinx_themes import ProjectLink, get_version
2
3 # -*- coding: utf-8 -*-
4 #
5 # Configuration file for the Sphinx documentation builder.
6 #
7 # This file does only contain a selection of the most common options. For a
8 # full list see the documentation:
9 # http://www.sphinx-doc.org/en/stable/config
10
11 # -- Path setup --------------------------------------------------------------
12
13 # If extensions (or modules to document with autodoc) are in another directory,
14 # add these directories to sys.path here. If the directory is relative to the
15 # documentation root, use os.path.abspath to make it absolute, like shown here.
16 #
17 # import os
18 # import sys
19 # sys.path.insert(0, os.path.abspath('.'))
20
21
22 # -- Project information -----------------------------------------------------
23
24 project = 'Raster Vision'
25 copyright = '2018, Azavea'
26 author = 'Azavea'
27
28 # The short X.Y version
29 version = '0.10'
30 # The full version, including alpha/beta/rc tags
31 release = '0.10.0'
32
33
34 # -- General configuration ---------------------------------------------------
35
36 # If your documentation needs a minimal Sphinx version, state it here.
37 #
38 # needs_sphinx = '1.0'
39
40 # Add any Sphinx extension module names here, as strings. They can be
41 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
42 # ones.
43 extensions = [
44 'sphinx.ext.autodoc',
45 'sphinx.ext.intersphinx',
46 'pallets_sphinx_themes',
47 'sphinxcontrib.programoutput'
48 ]
49
50 # https://read-the-docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
51 import sys
52 from unittest.mock import MagicMock
53
54 class Mock(MagicMock):
55 @classmethod
56 def __getattr__(cls, name):
57 return MagicMock()
58
59 MOCK_MODULES = ['pyproj', 'h5py']
60 sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
61
62 autodoc_mock_imports = ['torch', 'torchvision', 'pycocotools']
63
64 intersphinx_mapping = {'python': ('https://docs.python.org/3/', None)}
65
66 # Add any paths that contain templates here, relative to this directory.
67 templates_path = ['_templates']
68
69 # The suffix(es) of source filenames.
70 # You can specify multiple suffix as a list of string:
71 #
72 # source_suffix = ['.rst', '.md']
73 source_suffix = '.rst'
74
75 # The master toctree document.
76 master_doc = 'index'
77
78 # The language for content autogenerated by Sphinx. Refer to documentation
79 # for a list of supported languages.
80 #
81 # This is also used if you do content translation via gettext catalogs.
82 # Usually you set "language" from the command line for these cases.
83 language = None
84
85 # List of patterns, relative to source directory, that match files and
86 # directories to ignore when looking for source files.
87 # This pattern also affects html_static_path and html_extra_path .
88 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.md']
89
90 # The name of the Pygments (syntax highlighting) style to use.
91 # pygments_style = 'sphinx'
92
93 # HTML -----------------------------------------------------------------
94
95 html_theme = 'click'
96 html_theme_options = {'index_sidebar_logo': False}
97 html_context = {
98 'project_links': [
99 ProjectLink('Quickstart', 'quickstart.html'),
100 ProjectLink('Documentation TOC', 'index.html#documentation'),
101 ProjectLink('API Reference TOC', 'index.html#api-reference'),
102 ProjectLink('Project Website', 'https://rastervision.io/'),
103 ProjectLink('PyPI releases', 'https://pypi.org/project/rastervision/'),
104 ProjectLink('GitHub', 'https://github.com/azavea/raster-vision'),
105 ProjectLink('Gitter Channel', 'https://gitter.im/azavea/raster-vision'),
106 ProjectLink('Raster Vision Examples', 'https://github.com/azavea/raster-vision-examples'),
107 ProjectLink('AWS Batch Setup', 'https://github.com/azavea/raster-vision-aws'),
108 ProjectLink('Issue Tracker', 'https://github.com/azavea/raster-vision/issues/'),
109 ProjectLink('CHANGELOG', 'changelog.html'),
110 ProjectLink('Azavea', 'https://www.azavea.com/'),
111 ],
112 'css_files': [
113 '_static/rastervision.css',
114 'https://media.readthedocs.org/css/badge_only.css'
115 ]
116 }
117 html_sidebars = {
118 'index': ['project.html', 'versions.html', 'searchbox.html'],
119 '**': ['project.html', 'localtoc.html', 'relations.html', 'versions.html', 'searchbox.html'],
120 }
121 singlehtml_sidebars = {'index': ['project.html', 'versions.html', 'localtoc.html']}
122 html_static_path = ['_static']
123 html_favicon = '_static/raster-vision-icon.png'
124 html_logo = '_static/raster-vision-logo.png'
125 html_title = 'Raster Vision Documentation ({})'.format(version)
126 html_show_sourcelink = False
127 html_domain_indices = False
128 html_experimental_html5_writer = True
129
130 # -- Options for HTMLHelp output ---------------------------------------------
131
132 # Output file base name for HTML help builder.
133 htmlhelp_basename = 'RasterVisiondoc'
134
135
136 # -- Options for LaTeX output ------------------------------------------------
137
138 latex_elements = {
139 # The paper size ('letterpaper' or 'a4paper').
140 #
141 # 'papersize': 'letterpaper',
142
143 # The font size ('10pt', '11pt' or '12pt').
144 #
145 # 'pointsize': '10pt',
146
147 # Additional stuff for the LaTeX preamble.
148 #
149 # 'preamble': '',
150
151 # Latex figure (float) alignment
152 #
153 # 'figure_align': 'htbp',
154 }
155
156 # Grouping the document tree into LaTeX files. List of tuples
157 # (source start file, target name, title,
158 # author, documentclass [howto, manual, or own class]).
159 latex_documents = [
160 (master_doc, 'RasterVision.tex', 'Raster Vision Documentation',
161 'Azavea', 'manual'),
162 ]
163
164
165 # -- Options for manual page output ------------------------------------------
166
167 # One entry per manual page. List of tuples
168 # (source start file, name, description, authors, manual section).
169 man_pages = [
170 (master_doc, 'RasterVisoin-{}.tex', html_title,
171 [author], 'manual')
172 ]
173
174
175 # -- Options for Texinfo output ----------------------------------------------
176
177 # Grouping the document tree into Texinfo files. List of tuples
178 # (source start file, target name, title, author,
179 # dir menu entry, description, category)
180 texinfo_documents = [
181 (master_doc, 'RasterVision', 'Raster Vision Documentation',
182 author, 'RasterVision', 'One line description of project.',
183 'Miscellaneous'),
184 ]
185
186
187 # -- Extension configuration -------------------------------------------------
188
189 programoutput_prompt_template = '> {command}\n{output}'
190
191 # -- Options for todo extension ----------------------------------------------
192
193 # If true, `todo` and `todoList` produce output, else they produce nothing.
194 todo_include_todos = True
195
```
Path: `rastervision/backend/pytorch_chip_classification_config.py`
Content:
```
1 from copy import deepcopy
2
3 import rastervision as rv
4
5 from rastervision.backend.pytorch_chip_classification import (
6 PyTorchChipClassification)
7 from rastervision.backend.simple_backend_config import (
8 SimpleBackendConfig, SimpleBackendConfigBuilder)
9 from rastervision.backend.api import PYTORCH_CHIP_CLASSIFICATION
10
11
12 class TrainOptions():
13 def __init__(self,
14 batch_size=None,
15 lr=None,
16 one_cycle=None,
17 num_epochs=None,
18 model_arch=None,
19 sync_interval=None,
20 debug=None,
21 log_tensorboard=None,
22 run_tensorboard=None):
23 self.batch_size = batch_size
24 self.lr = lr
25 self.one_cycle = one_cycle
26 self.num_epochs = num_epochs
27 self.model_arch = model_arch
28 self.sync_interval = sync_interval
29 self.debug = debug
30 self.log_tensorboard = log_tensorboard
31 self.run_tensorboard = run_tensorboard
32
33 def __setattr__(self, name, value):
34 if name in ['batch_size', 'num_epochs', 'sync_interval']:
35 value = int(value) if isinstance(value, float) else value
36 super().__setattr__(name, value)
37
38
39 class PyTorchChipClassificationConfig(SimpleBackendConfig):
40 train_opts_class = TrainOptions
41 backend_type = PYTORCH_CHIP_CLASSIFICATION
42 backend_class = PyTorchChipClassification
43
44
45 class PyTorchChipClassificationConfigBuilder(SimpleBackendConfigBuilder):
46 config_class = PyTorchChipClassificationConfig
47
48 def _applicable_tasks(self):
49 return [rv.CHIP_CLASSIFICATION]
50
51 def with_train_options(self,
52 batch_size=8,
53 lr=1e-4,
54 one_cycle=True,
55 num_epochs=1,
56 model_arch='resnet18',
57 sync_interval=1,
58 debug=False,
59 log_tensorboard=True,
60 run_tensorboard=True):
61 """Set options for training models.
62
63 Args:
64 batch_size: (int) the batch size
65 weight_decay: (float) the weight decay
66 lr: (float) the learning rate if using a fixed LR
67 (ie. one_cycle is False),
68 or the maximum LR to use if one_cycle is True
69 one_cycle: (bool) True if cyclic learning rate scheduler should
70 be used. This
71 cycles the LR once during the course of training and seems to
72 result in a pretty consistent improvement. See lr for more
73 details.
74 num_epochs: (int) number of epochs (sweeps through training set) to
75 train model for
76 model_arch: (str) classification model backbone to use for UNet
77 architecture. Any option in torchvision.models is valid, for
78 example, resnet18.
79 sync_interval: (int) sync training directory to cloud every
80 sync_interval epochs.
81 debug: (bool) if True, save debug chips (ie. visualizations of
82 input to model during training) during training and use
83 single-core for creating minibatches.
84 log_tensorboard: (bool) if True, write events to Tensorboard log
85 file
86 run_tensorboard: (bool) if True, run a Tensorboard server at
87 port 6006 that uses the logs generated by the log_tensorboard
88 option
89 """
90 b = deepcopy(self)
91 b.train_opts = TrainOptions(
92 batch_size=batch_size,
93 lr=lr,
94 one_cycle=one_cycle,
95 num_epochs=num_epochs,
96 model_arch=model_arch,
97 sync_interval=sync_interval,
98 debug=debug,
99 log_tensorboard=log_tensorboard,
100 run_tensorboard=run_tensorboard)
101 return b
102
103 def with_pretrained_uri(self, pretrained_uri):
104 """pretrained_uri should be uri of exported model file."""
105 return super().with_pretrained_uri(pretrained_uri)
106
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/docs/conf.py b/docs/conf.py
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -44,7 +44,8 @@
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'pallets_sphinx_themes',
- 'sphinxcontrib.programoutput'
+ 'sphinxcontrib.programoutput',
+ 'sphinxcontrib.napoleon',
]
# https://read-the-docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
diff --git a/rastervision/backend/pytorch_chip_classification_config.py b/rastervision/backend/pytorch_chip_classification_config.py
--- a/rastervision/backend/pytorch_chip_classification_config.py
+++ b/rastervision/backend/pytorch_chip_classification_config.py
@@ -73,9 +73,8 @@
details.
num_epochs: (int) number of epochs (sweeps through training set) to
train model for
- model_arch: (str) classification model backbone to use for UNet
- architecture. Any option in torchvision.models is valid, for
- example, resnet18.
+ model_arch: (str) Any classification model option in
+ torchvision.models is valid, for example, resnet18.
sync_interval: (int) sync training directory to cloud every
sync_interval epochs.
debug: (bool) if True, save debug chips (ie. visualizations of
|
{"golden_diff": "diff --git a/docs/conf.py b/docs/conf.py\n--- a/docs/conf.py\n+++ b/docs/conf.py\n@@ -44,7 +44,8 @@\n 'sphinx.ext.autodoc',\n 'sphinx.ext.intersphinx',\n 'pallets_sphinx_themes',\n- 'sphinxcontrib.programoutput'\n+ 'sphinxcontrib.programoutput',\n+ 'sphinxcontrib.napoleon',\n ]\n \n # https://read-the-docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules\ndiff --git a/rastervision/backend/pytorch_chip_classification_config.py b/rastervision/backend/pytorch_chip_classification_config.py\n--- a/rastervision/backend/pytorch_chip_classification_config.py\n+++ b/rastervision/backend/pytorch_chip_classification_config.py\n@@ -73,9 +73,8 @@\n details.\n num_epochs: (int) number of epochs (sweeps through training set) to\n train model for\n- model_arch: (str) classification model backbone to use for UNet\n- architecture. Any option in torchvision.models is valid, for\n- example, resnet18.\n+ model_arch: (str) Any classification model option in\n+ torchvision.models is valid, for example, resnet18.\n sync_interval: (int) sync training directory to cloud every\n sync_interval epochs.\n debug: (bool) if True, save debug chips (ie. visualizations of\n", "issue": "Get Sphinx to render Google-style API docs correctly\nIn the API docs on RTD https://docs.rastervision.io/en/latest/api.html, the line breaks in the docs aren't rendered correctly. In particular, the `lr` argument for the PyTorch backends is on the same line as the `batch_size` argument, which obscures the `lr` argument. I think this is because we are using Google style PyDocs which aren't natively supported by Sphinx. However, there is a plugin for doing this:\r\n\r\nhttps://stackoverflow.com/questions/7033239/how-to-preserve-line-breaks-when-generating-python-docs-using-sphinx\n", "before_files": [{"content": "from pallets_sphinx_themes import ProjectLink, get_version\n\n# -*- coding: utf-8 -*-\n#\n# Configuration file for the Sphinx documentation builder.\n#\n# This file does only contain a selection of the most common options. For a\n# full list see the documentation:\n# http://www.sphinx-doc.org/en/stable/config\n\n# -- Path setup --------------------------------------------------------------\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\n#\n# import os\n# import sys\n# sys.path.insert(0, os.path.abspath('.'))\n\n\n# -- Project information -----------------------------------------------------\n\nproject = 'Raster Vision'\ncopyright = '2018, Azavea'\nauthor = 'Azavea'\n\n# The short X.Y version\nversion = '0.10'\n# The full version, including alpha/beta/rc tags\nrelease = '0.10.0'\n\n\n# -- General configuration ---------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#\n# needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n 'sphinx.ext.autodoc',\n 'sphinx.ext.intersphinx',\n 'pallets_sphinx_themes',\n 'sphinxcontrib.programoutput'\n]\n\n# https://read-the-docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules\nimport sys\nfrom unittest.mock import MagicMock\n\nclass Mock(MagicMock):\n @classmethod\n def __getattr__(cls, name):\n return MagicMock()\n\nMOCK_MODULES = ['pyproj', 'h5py']\nsys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)\n\nautodoc_mock_imports = ['torch', 'torchvision', 'pycocotools']\n\nintersphinx_mapping = {'python': ('https://docs.python.org/3/', None)}\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['_templates']\n\n# The suffix(es) of source filenames.\n# You can specify multiple suffix as a list of string:\n#\n# source_suffix = ['.rst', '.md']\nsource_suffix = '.rst'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#\n# This is also used if you do content translation via gettext catalogs.\n# Usually you set \"language\" from the command line for these cases.\nlanguage = None\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\n# This pattern also affects html_static_path and html_extra_path .\nexclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.md']\n\n# The name of the Pygments (syntax highlighting) style to use.\n# pygments_style = 'sphinx'\n\n# HTML -----------------------------------------------------------------\n\nhtml_theme = 'click'\nhtml_theme_options = {'index_sidebar_logo': False}\nhtml_context = {\n 'project_links': [\n ProjectLink('Quickstart', 'quickstart.html'),\n ProjectLink('Documentation TOC', 'index.html#documentation'),\n ProjectLink('API Reference TOC', 'index.html#api-reference'),\n ProjectLink('Project Website', 'https://rastervision.io/'),\n ProjectLink('PyPI releases', 'https://pypi.org/project/rastervision/'),\n ProjectLink('GitHub', 'https://github.com/azavea/raster-vision'),\n ProjectLink('Gitter Channel', 'https://gitter.im/azavea/raster-vision'),\n ProjectLink('Raster Vision Examples', 'https://github.com/azavea/raster-vision-examples'),\n ProjectLink('AWS Batch Setup', 'https://github.com/azavea/raster-vision-aws'),\n ProjectLink('Issue Tracker', 'https://github.com/azavea/raster-vision/issues/'),\n ProjectLink('CHANGELOG', 'changelog.html'),\n ProjectLink('Azavea', 'https://www.azavea.com/'),\n ],\n 'css_files': [\n '_static/rastervision.css',\n 'https://media.readthedocs.org/css/badge_only.css'\n ]\n}\nhtml_sidebars = {\n 'index': ['project.html', 'versions.html', 'searchbox.html'],\n '**': ['project.html', 'localtoc.html', 'relations.html', 'versions.html', 'searchbox.html'],\n}\nsinglehtml_sidebars = {'index': ['project.html', 'versions.html', 'localtoc.html']}\nhtml_static_path = ['_static']\nhtml_favicon = '_static/raster-vision-icon.png'\nhtml_logo = '_static/raster-vision-logo.png'\nhtml_title = 'Raster Vision Documentation ({})'.format(version)\nhtml_show_sourcelink = False\nhtml_domain_indices = False\nhtml_experimental_html5_writer = True\n\n# -- Options for HTMLHelp output ---------------------------------------------\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'RasterVisiondoc'\n\n\n# -- Options for LaTeX output ------------------------------------------------\n\nlatex_elements = {\n # The paper size ('letterpaper' or 'a4paper').\n #\n # 'papersize': 'letterpaper',\n\n # The font size ('10pt', '11pt' or '12pt').\n #\n # 'pointsize': '10pt',\n\n # Additional stuff for the LaTeX preamble.\n #\n # 'preamble': '',\n\n # Latex figure (float) alignment\n #\n # 'figure_align': 'htbp',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n# author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n (master_doc, 'RasterVision.tex', 'Raster Vision Documentation',\n 'Azavea', 'manual'),\n]\n\n\n# -- Options for manual page output ------------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [\n (master_doc, 'RasterVisoin-{}.tex', html_title,\n [author], 'manual')\n]\n\n\n# -- Options for Texinfo output ----------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n (master_doc, 'RasterVision', 'Raster Vision Documentation',\n author, 'RasterVision', 'One line description of project.',\n 'Miscellaneous'),\n]\n\n\n# -- Extension configuration -------------------------------------------------\n\nprogramoutput_prompt_template = '> {command}\\n{output}'\n\n# -- Options for todo extension ----------------------------------------------\n\n# If true, `todo` and `todoList` produce output, else they produce nothing.\ntodo_include_todos = True\n", "path": "docs/conf.py"}, {"content": "from copy import deepcopy\n\nimport rastervision as rv\n\nfrom rastervision.backend.pytorch_chip_classification import (\n PyTorchChipClassification)\nfrom rastervision.backend.simple_backend_config import (\n SimpleBackendConfig, SimpleBackendConfigBuilder)\nfrom rastervision.backend.api import PYTORCH_CHIP_CLASSIFICATION\n\n\nclass TrainOptions():\n def __init__(self,\n batch_size=None,\n lr=None,\n one_cycle=None,\n num_epochs=None,\n model_arch=None,\n sync_interval=None,\n debug=None,\n log_tensorboard=None,\n run_tensorboard=None):\n self.batch_size = batch_size\n self.lr = lr\n self.one_cycle = one_cycle\n self.num_epochs = num_epochs\n self.model_arch = model_arch\n self.sync_interval = sync_interval\n self.debug = debug\n self.log_tensorboard = log_tensorboard\n self.run_tensorboard = run_tensorboard\n\n def __setattr__(self, name, value):\n if name in ['batch_size', 'num_epochs', 'sync_interval']:\n value = int(value) if isinstance(value, float) else value\n super().__setattr__(name, value)\n\n\nclass PyTorchChipClassificationConfig(SimpleBackendConfig):\n train_opts_class = TrainOptions\n backend_type = PYTORCH_CHIP_CLASSIFICATION\n backend_class = PyTorchChipClassification\n\n\nclass PyTorchChipClassificationConfigBuilder(SimpleBackendConfigBuilder):\n config_class = PyTorchChipClassificationConfig\n\n def _applicable_tasks(self):\n return [rv.CHIP_CLASSIFICATION]\n\n def with_train_options(self,\n batch_size=8,\n lr=1e-4,\n one_cycle=True,\n num_epochs=1,\n model_arch='resnet18',\n sync_interval=1,\n debug=False,\n log_tensorboard=True,\n run_tensorboard=True):\n \"\"\"Set options for training models.\n\n Args:\n batch_size: (int) the batch size\n weight_decay: (float) the weight decay\n lr: (float) the learning rate if using a fixed LR\n (ie. one_cycle is False),\n or the maximum LR to use if one_cycle is True\n one_cycle: (bool) True if cyclic learning rate scheduler should\n be used. This\n cycles the LR once during the course of training and seems to\n result in a pretty consistent improvement. See lr for more\n details.\n num_epochs: (int) number of epochs (sweeps through training set) to\n train model for\n model_arch: (str) classification model backbone to use for UNet\n architecture. Any option in torchvision.models is valid, for\n example, resnet18.\n sync_interval: (int) sync training directory to cloud every\n sync_interval epochs.\n debug: (bool) if True, save debug chips (ie. visualizations of\n input to model during training) during training and use\n single-core for creating minibatches.\n log_tensorboard: (bool) if True, write events to Tensorboard log\n file\n run_tensorboard: (bool) if True, run a Tensorboard server at\n port 6006 that uses the logs generated by the log_tensorboard\n option\n \"\"\"\n b = deepcopy(self)\n b.train_opts = TrainOptions(\n batch_size=batch_size,\n lr=lr,\n one_cycle=one_cycle,\n num_epochs=num_epochs,\n model_arch=model_arch,\n sync_interval=sync_interval,\n debug=debug,\n log_tensorboard=log_tensorboard,\n run_tensorboard=run_tensorboard)\n return b\n\n def with_pretrained_uri(self, pretrained_uri):\n \"\"\"pretrained_uri should be uri of exported model file.\"\"\"\n return super().with_pretrained_uri(pretrained_uri)\n", "path": "rastervision/backend/pytorch_chip_classification_config.py"}], "after_files": [{"content": "from pallets_sphinx_themes import ProjectLink, get_version\n\n# -*- coding: utf-8 -*-\n#\n# Configuration file for the Sphinx documentation builder.\n#\n# This file does only contain a selection of the most common options. For a\n# full list see the documentation:\n# http://www.sphinx-doc.org/en/stable/config\n\n# -- Path setup --------------------------------------------------------------\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\n#\n# import os\n# import sys\n# sys.path.insert(0, os.path.abspath('.'))\n\n\n# -- Project information -----------------------------------------------------\n\nproject = 'Raster Vision'\ncopyright = '2018, Azavea'\nauthor = 'Azavea'\n\n# The short X.Y version\nversion = '0.10'\n# The full version, including alpha/beta/rc tags\nrelease = '0.10.0'\n\n\n# -- General configuration ---------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#\n# needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n 'sphinx.ext.autodoc',\n 'sphinx.ext.intersphinx',\n 'pallets_sphinx_themes',\n 'sphinxcontrib.programoutput',\n 'sphinxcontrib.napoleon',\n]\n\n# https://read-the-docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules\nimport sys\nfrom unittest.mock import MagicMock\n\nclass Mock(MagicMock):\n @classmethod\n def __getattr__(cls, name):\n return MagicMock()\n\nMOCK_MODULES = ['pyproj', 'h5py']\nsys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)\n\nautodoc_mock_imports = ['torch', 'torchvision', 'pycocotools']\n\nintersphinx_mapping = {'python': ('https://docs.python.org/3/', None)}\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['_templates']\n\n# The suffix(es) of source filenames.\n# You can specify multiple suffix as a list of string:\n#\n# source_suffix = ['.rst', '.md']\nsource_suffix = '.rst'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#\n# This is also used if you do content translation via gettext catalogs.\n# Usually you set \"language\" from the command line for these cases.\nlanguage = None\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\n# This pattern also affects html_static_path and html_extra_path .\nexclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.md']\n\n# The name of the Pygments (syntax highlighting) style to use.\n# pygments_style = 'sphinx'\n\n# HTML -----------------------------------------------------------------\n\nhtml_theme = 'click'\nhtml_theme_options = {'index_sidebar_logo': False}\nhtml_context = {\n 'project_links': [\n ProjectLink('Quickstart', 'quickstart.html'),\n ProjectLink('Documentation TOC', 'index.html#documentation'),\n ProjectLink('API Reference TOC', 'index.html#api-reference'),\n ProjectLink('Project Website', 'https://rastervision.io/'),\n ProjectLink('PyPI releases', 'https://pypi.org/project/rastervision/'),\n ProjectLink('GitHub', 'https://github.com/azavea/raster-vision'),\n ProjectLink('Gitter Channel', 'https://gitter.im/azavea/raster-vision'),\n ProjectLink('Raster Vision Examples', 'https://github.com/azavea/raster-vision-examples'),\n ProjectLink('AWS Batch Setup', 'https://github.com/azavea/raster-vision-aws'),\n ProjectLink('Issue Tracker', 'https://github.com/azavea/raster-vision/issues/'),\n ProjectLink('CHANGELOG', 'changelog.html'),\n ProjectLink('Azavea', 'https://www.azavea.com/'),\n ],\n 'css_files': [\n '_static/rastervision.css',\n 'https://media.readthedocs.org/css/badge_only.css'\n ]\n}\nhtml_sidebars = {\n 'index': ['project.html', 'versions.html', 'searchbox.html'],\n '**': ['project.html', 'localtoc.html', 'relations.html', 'versions.html', 'searchbox.html'],\n}\nsinglehtml_sidebars = {'index': ['project.html', 'versions.html', 'localtoc.html']}\nhtml_static_path = ['_static']\nhtml_favicon = '_static/raster-vision-icon.png'\nhtml_logo = '_static/raster-vision-logo.png'\nhtml_title = 'Raster Vision Documentation ({})'.format(version)\nhtml_show_sourcelink = False\nhtml_domain_indices = False\nhtml_experimental_html5_writer = True\n\n# -- Options for HTMLHelp output ---------------------------------------------\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'RasterVisiondoc'\n\n\n# -- Options for LaTeX output ------------------------------------------------\n\nlatex_elements = {\n # The paper size ('letterpaper' or 'a4paper').\n #\n # 'papersize': 'letterpaper',\n\n # The font size ('10pt', '11pt' or '12pt').\n #\n # 'pointsize': '10pt',\n\n # Additional stuff for the LaTeX preamble.\n #\n # 'preamble': '',\n\n # Latex figure (float) alignment\n #\n # 'figure_align': 'htbp',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n# author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n (master_doc, 'RasterVision.tex', 'Raster Vision Documentation',\n 'Azavea', 'manual'),\n]\n\n\n# -- Options for manual page output ------------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [\n (master_doc, 'RasterVisoin-{}.tex', html_title,\n [author], 'manual')\n]\n\n\n# -- Options for Texinfo output ----------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n (master_doc, 'RasterVision', 'Raster Vision Documentation',\n author, 'RasterVision', 'One line description of project.',\n 'Miscellaneous'),\n]\n\n\n# -- Extension configuration -------------------------------------------------\n\nprogramoutput_prompt_template = '> {command}\\n{output}'\n\n# -- Options for todo extension ----------------------------------------------\n\n# If true, `todo` and `todoList` produce output, else they produce nothing.\ntodo_include_todos = True\n", "path": "docs/conf.py"}, {"content": "from copy import deepcopy\n\nimport rastervision as rv\n\nfrom rastervision.backend.pytorch_chip_classification import (\n PyTorchChipClassification)\nfrom rastervision.backend.simple_backend_config import (\n SimpleBackendConfig, SimpleBackendConfigBuilder)\nfrom rastervision.backend.api import PYTORCH_CHIP_CLASSIFICATION\n\n\nclass TrainOptions():\n def __init__(self,\n batch_size=None,\n lr=None,\n one_cycle=None,\n num_epochs=None,\n model_arch=None,\n sync_interval=None,\n debug=None,\n log_tensorboard=None,\n run_tensorboard=None):\n self.batch_size = batch_size\n self.lr = lr\n self.one_cycle = one_cycle\n self.num_epochs = num_epochs\n self.model_arch = model_arch\n self.sync_interval = sync_interval\n self.debug = debug\n self.log_tensorboard = log_tensorboard\n self.run_tensorboard = run_tensorboard\n\n def __setattr__(self, name, value):\n if name in ['batch_size', 'num_epochs', 'sync_interval']:\n value = int(value) if isinstance(value, float) else value\n super().__setattr__(name, value)\n\n\nclass PyTorchChipClassificationConfig(SimpleBackendConfig):\n train_opts_class = TrainOptions\n backend_type = PYTORCH_CHIP_CLASSIFICATION\n backend_class = PyTorchChipClassification\n\n\nclass PyTorchChipClassificationConfigBuilder(SimpleBackendConfigBuilder):\n config_class = PyTorchChipClassificationConfig\n\n def _applicable_tasks(self):\n return [rv.CHIP_CLASSIFICATION]\n\n def with_train_options(self,\n batch_size=8,\n lr=1e-4,\n one_cycle=True,\n num_epochs=1,\n model_arch='resnet18',\n sync_interval=1,\n debug=False,\n log_tensorboard=True,\n run_tensorboard=True):\n \"\"\"Set options for training models.\n\n Args:\n batch_size: (int) the batch size\n weight_decay: (float) the weight decay\n lr: (float) the learning rate if using a fixed LR\n (ie. one_cycle is False),\n or the maximum LR to use if one_cycle is True\n one_cycle: (bool) True if cyclic learning rate scheduler should\n be used. This\n cycles the LR once during the course of training and seems to\n result in a pretty consistent improvement. See lr for more\n details.\n num_epochs: (int) number of epochs (sweeps through training set) to\n train model for\n model_arch: (str) Any classification model option in\n torchvision.models is valid, for example, resnet18.\n sync_interval: (int) sync training directory to cloud every\n sync_interval epochs.\n debug: (bool) if True, save debug chips (ie. visualizations of\n input to model during training) during training and use\n single-core for creating minibatches.\n log_tensorboard: (bool) if True, write events to Tensorboard log\n file\n run_tensorboard: (bool) if True, run a Tensorboard server at\n port 6006 that uses the logs generated by the log_tensorboard\n option\n \"\"\"\n b = deepcopy(self)\n b.train_opts = TrainOptions(\n batch_size=batch_size,\n lr=lr,\n one_cycle=one_cycle,\n num_epochs=num_epochs,\n model_arch=model_arch,\n sync_interval=sync_interval,\n debug=debug,\n log_tensorboard=log_tensorboard,\n run_tensorboard=run_tensorboard)\n return b\n\n def with_pretrained_uri(self, pretrained_uri):\n \"\"\"pretrained_uri should be uri of exported model file.\"\"\"\n return super().with_pretrained_uri(pretrained_uri)\n", "path": "rastervision/backend/pytorch_chip_classification_config.py"}]}
| 3,479 | 327 |
gh_patches_debug_40253
|
rasdani/github-patches
|
git_diff
|
openai__gym-1376
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Cannot use gym.utils.play.PlayPlot
```
from gym.utils.play import play, PlayPlot
def callback(obs_t, obs_tp1, action, rew, done, info):
return [rew,]
env_plotter = PlayPlot(callback, 30 * 5, ["reward"])
env = gym.make("IceHockey-v0")
```
I got : self.fig, self.ax = plt.subplots(num_plots) NameError: name 'plt' is not defined
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `gym/utils/play.py`
Content:
```
1 import gym
2 import pygame
3 import sys
4 import time
5 import matplotlib
6 import argparse
7 try:
8 matplotlib.use('GTK3Agg')
9 import matplotlib.pyplot as plt
10 except Exception:
11 pass
12
13
14 import pyglet.window as pw
15
16 from collections import deque
17 from pygame.locals import HWSURFACE, DOUBLEBUF, RESIZABLE, VIDEORESIZE
18 from threading import Thread
19
20 parser = argparse.ArgumentParser()
21 parser.add_argument('--env', type=str, default='MontezumaRevengeNoFrameskip-v4', help='Define Environment')
22 args = parser.parse_args()
23
24 def display_arr(screen, arr, video_size, transpose):
25 arr_min, arr_max = arr.min(), arr.max()
26 arr = 255.0 * (arr - arr_min) / (arr_max - arr_min)
27 pyg_img = pygame.surfarray.make_surface(arr.swapaxes(0, 1) if transpose else arr)
28 pyg_img = pygame.transform.scale(pyg_img, video_size)
29 screen.blit(pyg_img, (0,0))
30
31 def play(env, transpose=True, fps=30, zoom=None, callback=None, keys_to_action=None):
32 """Allows one to play the game using keyboard.
33
34 To simply play the game use:
35
36 play(gym.make("Pong-v3"))
37
38 Above code works also if env is wrapped, so it's particularly useful in
39 verifying that the frame-level preprocessing does not render the game
40 unplayable.
41
42 If you wish to plot real time statistics as you play, you can use
43 gym.utils.play.PlayPlot. Here's a sample code for plotting the reward
44 for last 5 second of gameplay.
45
46 def callback(obs_t, obs_tp1, rew, done, info):
47 return [rew,]
48 env_plotter = EnvPlotter(callback, 30 * 5, ["reward"])
49
50 env = gym.make("Pong-v3")
51 play(env, callback=env_plotter.callback)
52
53
54 Arguments
55 ---------
56 env: gym.Env
57 Environment to use for playing.
58 transpose: bool
59 If True the output of observation is transposed.
60 Defaults to true.
61 fps: int
62 Maximum number of steps of the environment to execute every second.
63 Defaults to 30.
64 zoom: float
65 Make screen edge this many times bigger
66 callback: lambda or None
67 Callback if a callback is provided it will be executed after
68 every step. It takes the following input:
69 obs_t: observation before performing action
70 obs_tp1: observation after performing action
71 action: action that was executed
72 rew: reward that was received
73 done: whether the environment is done or not
74 info: debug info
75 keys_to_action: dict: tuple(int) -> int or None
76 Mapping from keys pressed to action performed.
77 For example if pressed 'w' and space at the same time is supposed
78 to trigger action number 2 then key_to_action dict would look like this:
79
80 {
81 # ...
82 sorted(ord('w'), ord(' ')) -> 2
83 # ...
84 }
85 If None, default key_to_action mapping for that env is used, if provided.
86 """
87
88 obs_s = env.observation_space
89 assert type(obs_s) == gym.spaces.box.Box
90 assert len(obs_s.shape) == 2 or (len(obs_s.shape) == 3 and obs_s.shape[2] in [1,3])
91
92 if keys_to_action is None:
93 if hasattr(env, 'get_keys_to_action'):
94 keys_to_action = env.get_keys_to_action()
95 elif hasattr(env.unwrapped, 'get_keys_to_action'):
96 keys_to_action = env.unwrapped.get_keys_to_action()
97 else:
98 assert False, env.spec.id + " does not have explicit key to action mapping, " + \
99 "please specify one manually"
100 relevant_keys = set(sum(map(list, keys_to_action.keys()),[]))
101
102 if transpose:
103 video_size = env.observation_space.shape[1], env.observation_space.shape[0]
104 else:
105 video_size = env.observation_space.shape[0], env.observation_space.shape[1]
106
107 if zoom is not None:
108 video_size = int(video_size[0] * zoom), int(video_size[1] * zoom)
109
110 pressed_keys = []
111 running = True
112 env_done = True
113
114 screen = pygame.display.set_mode(video_size)
115 clock = pygame.time.Clock()
116
117
118 while running:
119 if env_done:
120 env_done = False
121 obs = env.reset()
122 else:
123 action = keys_to_action.get(tuple(sorted(pressed_keys)), 0)
124 prev_obs = obs
125 obs, rew, env_done, info = env.step(action)
126 if callback is not None:
127 callback(prev_obs, obs, action, rew, env_done, info)
128 if obs is not None:
129 if len(obs.shape) == 2:
130 obs = obs[:, :, None]
131 if obs.shape[2] == 1:
132 obs = obs.repeat(3, axis=2)
133 display_arr(screen, obs, transpose=transpose, video_size=video_size)
134
135 # process pygame events
136 for event in pygame.event.get():
137 # test events, set key states
138 if event.type == pygame.KEYDOWN:
139 if event.key in relevant_keys:
140 pressed_keys.append(event.key)
141 elif event.key == 27:
142 running = False
143 elif event.type == pygame.KEYUP:
144 if event.key in relevant_keys:
145 pressed_keys.remove(event.key)
146 elif event.type == pygame.QUIT:
147 running = False
148 elif event.type == VIDEORESIZE:
149 video_size = event.size
150 screen = pygame.display.set_mode(video_size)
151 print(video_size)
152
153 pygame.display.flip()
154 clock.tick(fps)
155 pygame.quit()
156
157 class PlayPlot(object):
158 def __init__(self, callback, horizon_timesteps, plot_names):
159 self.data_callback = callback
160 self.horizon_timesteps = horizon_timesteps
161 self.plot_names = plot_names
162
163 num_plots = len(self.plot_names)
164 self.fig, self.ax = plt.subplots(num_plots)
165 if num_plots == 1:
166 self.ax = [self.ax]
167 for axis, name in zip(self.ax, plot_names):
168 axis.set_title(name)
169 self.t = 0
170 self.cur_plot = [None for _ in range(num_plots)]
171 self.data = [deque(maxlen=horizon_timesteps) for _ in range(num_plots)]
172
173 def callback(self, obs_t, obs_tp1, action, rew, done, info):
174 points = self.data_callback(obs_t, obs_tp1, action, rew, done, info)
175 for point, data_series in zip(points, self.data):
176 data_series.append(point)
177 self.t += 1
178
179 xmin, xmax = max(0, self.t - self.horizon_timesteps), self.t
180
181 for i, plot in enumerate(self.cur_plot):
182 if plot is not None:
183 plot.remove()
184 self.cur_plot[i] = self.ax[i].scatter(range(xmin, xmax), list(self.data[i]))
185 self.ax[i].set_xlim(xmin, xmax)
186 plt.pause(0.000001)
187
188
189 if __name__ == '__main__':
190 env = gym.make(args.env)
191 play(env, zoom=4, fps=60)
192
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/gym/utils/play.py b/gym/utils/play.py
--- a/gym/utils/play.py
+++ b/gym/utils/play.py
@@ -1,25 +1,18 @@
import gym
import pygame
-import sys
-import time
import matplotlib
import argparse
+from gym import logger
try:
- matplotlib.use('GTK3Agg')
+ matplotlib.use('TkAgg')
import matplotlib.pyplot as plt
-except Exception:
- pass
-
-
-import pyglet.window as pw
+except ImportError as e:
+ logger.warn('failed to set matplotlib backend, plotting will not work: %s' % str(e))
+ plt = None
from collections import deque
-from pygame.locals import HWSURFACE, DOUBLEBUF, RESIZABLE, VIDEORESIZE
-from threading import Thread
+from pygame.locals import VIDEORESIZE
-parser = argparse.ArgumentParser()
-parser.add_argument('--env', type=str, default='MontezumaRevengeNoFrameskip-v4', help='Define Environment')
-args = parser.parse_args()
def display_arr(screen, arr, video_size, transpose):
arr_min, arr_max = arr.min(), arr.max()
@@ -33,7 +26,7 @@
To simply play the game use:
- play(gym.make("Pong-v3"))
+ play(gym.make("Pong-v4"))
Above code works also if env is wrapped, so it's particularly useful in
verifying that the frame-level preprocessing does not render the game
@@ -43,12 +36,12 @@
gym.utils.play.PlayPlot. Here's a sample code for plotting the reward
for last 5 second of gameplay.
- def callback(obs_t, obs_tp1, rew, done, info):
+ def callback(obs_t, obs_tp1, action, rew, done, info):
return [rew,]
- env_plotter = EnvPlotter(callback, 30 * 5, ["reward"])
+ plotter = PlayPlot(callback, 30 * 5, ["reward"])
- env = gym.make("Pong-v3")
- play(env, callback=env_plotter.callback)
+ env = gym.make("Pong-v4")
+ play(env, callback=plotter.callback)
Arguments
@@ -160,6 +153,8 @@
self.horizon_timesteps = horizon_timesteps
self.plot_names = plot_names
+ assert plt is not None, "matplotlib backend failed, plotting will not work"
+
num_plots = len(self.plot_names)
self.fig, self.ax = plt.subplots(num_plots)
if num_plots == 1:
@@ -181,11 +176,18 @@
for i, plot in enumerate(self.cur_plot):
if plot is not None:
plot.remove()
- self.cur_plot[i] = self.ax[i].scatter(range(xmin, xmax), list(self.data[i]))
+ self.cur_plot[i] = self.ax[i].scatter(range(xmin, xmax), list(self.data[i]), c='blue')
self.ax[i].set_xlim(xmin, xmax)
plt.pause(0.000001)
-if __name__ == '__main__':
+def main():
+ parser = argparse.ArgumentParser()
+ parser.add_argument('--env', type=str, default='MontezumaRevengeNoFrameskip-v4', help='Define Environment')
+ args = parser.parse_args()
env = gym.make(args.env)
play(env, zoom=4, fps=60)
+
+
+if __name__ == '__main__':
+ main()
|
{"golden_diff": "diff --git a/gym/utils/play.py b/gym/utils/play.py\n--- a/gym/utils/play.py\n+++ b/gym/utils/play.py\n@@ -1,25 +1,18 @@\n import gym\n import pygame\n-import sys\n-import time\n import matplotlib\n import argparse\n+from gym import logger\n try:\n- matplotlib.use('GTK3Agg')\n+ matplotlib.use('TkAgg')\n import matplotlib.pyplot as plt\n-except Exception:\n- pass\n-\n-\n-import pyglet.window as pw\n+except ImportError as e:\n+ logger.warn('failed to set matplotlib backend, plotting will not work: %s' % str(e))\n+ plt = None\n \n from collections import deque\n-from pygame.locals import HWSURFACE, DOUBLEBUF, RESIZABLE, VIDEORESIZE\n-from threading import Thread\n+from pygame.locals import VIDEORESIZE\n \n-parser = argparse.ArgumentParser()\n-parser.add_argument('--env', type=str, default='MontezumaRevengeNoFrameskip-v4', help='Define Environment')\n-args = parser.parse_args()\n \t\n def display_arr(screen, arr, video_size, transpose):\n arr_min, arr_max = arr.min(), arr.max()\n@@ -33,7 +26,7 @@\n \n To simply play the game use:\n \n- play(gym.make(\"Pong-v3\"))\n+ play(gym.make(\"Pong-v4\"))\n \n Above code works also if env is wrapped, so it's particularly useful in\n verifying that the frame-level preprocessing does not render the game\n@@ -43,12 +36,12 @@\n gym.utils.play.PlayPlot. Here's a sample code for plotting the reward\n for last 5 second of gameplay.\n \n- def callback(obs_t, obs_tp1, rew, done, info):\n+ def callback(obs_t, obs_tp1, action, rew, done, info):\n return [rew,]\n- env_plotter = EnvPlotter(callback, 30 * 5, [\"reward\"])\n+ plotter = PlayPlot(callback, 30 * 5, [\"reward\"])\n \n- env = gym.make(\"Pong-v3\")\n- play(env, callback=env_plotter.callback)\n+ env = gym.make(\"Pong-v4\")\n+ play(env, callback=plotter.callback)\n \n \n Arguments\n@@ -160,6 +153,8 @@\n self.horizon_timesteps = horizon_timesteps\n self.plot_names = plot_names\n \n+ assert plt is not None, \"matplotlib backend failed, plotting will not work\"\n+\n num_plots = len(self.plot_names)\n self.fig, self.ax = plt.subplots(num_plots)\n if num_plots == 1:\n@@ -181,11 +176,18 @@\n for i, plot in enumerate(self.cur_plot):\n if plot is not None:\n plot.remove()\n- self.cur_plot[i] = self.ax[i].scatter(range(xmin, xmax), list(self.data[i]))\n+ self.cur_plot[i] = self.ax[i].scatter(range(xmin, xmax), list(self.data[i]), c='blue')\n self.ax[i].set_xlim(xmin, xmax)\n plt.pause(0.000001)\n \n \n-if __name__ == '__main__':\n+def main():\n+ parser = argparse.ArgumentParser()\n+ parser.add_argument('--env', type=str, default='MontezumaRevengeNoFrameskip-v4', help='Define Environment')\n+ args = parser.parse_args()\n env = gym.make(args.env)\n play(env, zoom=4, fps=60)\n+\n+\n+if __name__ == '__main__':\n+ main()\n", "issue": "Cannot use gym.utils.play.PlayPlot\n```\r\nfrom gym.utils.play import play, PlayPlot\r\ndef callback(obs_t, obs_tp1, action, rew, done, info):\r\n return [rew,]\r\nenv_plotter = PlayPlot(callback, 30 * 5, [\"reward\"])\r\nenv = gym.make(\"IceHockey-v0\")\r\n```\r\nI got : self.fig, self.ax = plt.subplots(num_plots) NameError: name 'plt' is not defined\n", "before_files": [{"content": "import gym\nimport pygame\nimport sys\nimport time\nimport matplotlib\nimport argparse\ntry:\n matplotlib.use('GTK3Agg')\n import matplotlib.pyplot as plt\nexcept Exception:\n pass\n\n\nimport pyglet.window as pw\n\nfrom collections import deque\nfrom pygame.locals import HWSURFACE, DOUBLEBUF, RESIZABLE, VIDEORESIZE\nfrom threading import Thread\n\nparser = argparse.ArgumentParser()\nparser.add_argument('--env', type=str, default='MontezumaRevengeNoFrameskip-v4', help='Define Environment')\nargs = parser.parse_args()\n\t\ndef display_arr(screen, arr, video_size, transpose):\n arr_min, arr_max = arr.min(), arr.max()\n arr = 255.0 * (arr - arr_min) / (arr_max - arr_min)\n pyg_img = pygame.surfarray.make_surface(arr.swapaxes(0, 1) if transpose else arr)\n pyg_img = pygame.transform.scale(pyg_img, video_size)\n screen.blit(pyg_img, (0,0))\n\ndef play(env, transpose=True, fps=30, zoom=None, callback=None, keys_to_action=None):\n \"\"\"Allows one to play the game using keyboard.\n\n To simply play the game use:\n\n play(gym.make(\"Pong-v3\"))\n\n Above code works also if env is wrapped, so it's particularly useful in\n verifying that the frame-level preprocessing does not render the game\n unplayable.\n\n If you wish to plot real time statistics as you play, you can use\n gym.utils.play.PlayPlot. Here's a sample code for plotting the reward\n for last 5 second of gameplay.\n\n def callback(obs_t, obs_tp1, rew, done, info):\n return [rew,]\n env_plotter = EnvPlotter(callback, 30 * 5, [\"reward\"])\n\n env = gym.make(\"Pong-v3\")\n play(env, callback=env_plotter.callback)\n\n\n Arguments\n ---------\n env: gym.Env\n Environment to use for playing.\n transpose: bool\n If True the output of observation is transposed.\n Defaults to true.\n fps: int\n Maximum number of steps of the environment to execute every second.\n Defaults to 30.\n zoom: float\n Make screen edge this many times bigger\n callback: lambda or None\n Callback if a callback is provided it will be executed after\n every step. It takes the following input:\n obs_t: observation before performing action\n obs_tp1: observation after performing action\n action: action that was executed\n rew: reward that was received\n done: whether the environment is done or not\n info: debug info\n keys_to_action: dict: tuple(int) -> int or None\n Mapping from keys pressed to action performed.\n For example if pressed 'w' and space at the same time is supposed\n to trigger action number 2 then key_to_action dict would look like this:\n\n {\n # ...\n sorted(ord('w'), ord(' ')) -> 2\n # ...\n }\n If None, default key_to_action mapping for that env is used, if provided.\n \"\"\"\n\n obs_s = env.observation_space\n assert type(obs_s) == gym.spaces.box.Box\n assert len(obs_s.shape) == 2 or (len(obs_s.shape) == 3 and obs_s.shape[2] in [1,3])\n\n if keys_to_action is None:\n if hasattr(env, 'get_keys_to_action'):\n keys_to_action = env.get_keys_to_action()\n elif hasattr(env.unwrapped, 'get_keys_to_action'):\n keys_to_action = env.unwrapped.get_keys_to_action()\n else:\n assert False, env.spec.id + \" does not have explicit key to action mapping, \" + \\\n \"please specify one manually\"\n relevant_keys = set(sum(map(list, keys_to_action.keys()),[]))\n\n if transpose:\n video_size = env.observation_space.shape[1], env.observation_space.shape[0]\n else:\n video_size = env.observation_space.shape[0], env.observation_space.shape[1]\n\n if zoom is not None:\n video_size = int(video_size[0] * zoom), int(video_size[1] * zoom)\n\n pressed_keys = []\n running = True\n env_done = True\n\n screen = pygame.display.set_mode(video_size)\n clock = pygame.time.Clock()\n\n\n while running:\n if env_done:\n env_done = False\n obs = env.reset()\n else:\n action = keys_to_action.get(tuple(sorted(pressed_keys)), 0)\n prev_obs = obs\n obs, rew, env_done, info = env.step(action)\n if callback is not None:\n callback(prev_obs, obs, action, rew, env_done, info)\n if obs is not None:\n if len(obs.shape) == 2:\n obs = obs[:, :, None]\n if obs.shape[2] == 1:\n obs = obs.repeat(3, axis=2)\n display_arr(screen, obs, transpose=transpose, video_size=video_size)\n\n # process pygame events\n for event in pygame.event.get():\n # test events, set key states\n if event.type == pygame.KEYDOWN:\n if event.key in relevant_keys:\n pressed_keys.append(event.key)\n elif event.key == 27:\n running = False\n elif event.type == pygame.KEYUP:\n if event.key in relevant_keys:\n pressed_keys.remove(event.key)\n elif event.type == pygame.QUIT:\n running = False\n elif event.type == VIDEORESIZE:\n video_size = event.size\n screen = pygame.display.set_mode(video_size)\n print(video_size)\n\n pygame.display.flip()\n clock.tick(fps)\n pygame.quit()\n\nclass PlayPlot(object):\n def __init__(self, callback, horizon_timesteps, plot_names):\n self.data_callback = callback\n self.horizon_timesteps = horizon_timesteps\n self.plot_names = plot_names\n\n num_plots = len(self.plot_names)\n self.fig, self.ax = plt.subplots(num_plots)\n if num_plots == 1:\n self.ax = [self.ax]\n for axis, name in zip(self.ax, plot_names):\n axis.set_title(name)\n self.t = 0\n self.cur_plot = [None for _ in range(num_plots)]\n self.data = [deque(maxlen=horizon_timesteps) for _ in range(num_plots)]\n\n def callback(self, obs_t, obs_tp1, action, rew, done, info):\n points = self.data_callback(obs_t, obs_tp1, action, rew, done, info)\n for point, data_series in zip(points, self.data):\n data_series.append(point)\n self.t += 1\n\n xmin, xmax = max(0, self.t - self.horizon_timesteps), self.t\n\n for i, plot in enumerate(self.cur_plot):\n if plot is not None:\n plot.remove()\n self.cur_plot[i] = self.ax[i].scatter(range(xmin, xmax), list(self.data[i]))\n self.ax[i].set_xlim(xmin, xmax)\n plt.pause(0.000001)\n\n\nif __name__ == '__main__':\n env = gym.make(args.env)\n play(env, zoom=4, fps=60)\n", "path": "gym/utils/play.py"}], "after_files": [{"content": "import gym\nimport pygame\nimport matplotlib\nimport argparse\nfrom gym import logger\ntry:\n matplotlib.use('TkAgg')\n import matplotlib.pyplot as plt\nexcept ImportError as e:\n logger.warn('failed to set matplotlib backend, plotting will not work: %s' % str(e))\n plt = None\n\nfrom collections import deque\nfrom pygame.locals import VIDEORESIZE\n\n\t\ndef display_arr(screen, arr, video_size, transpose):\n arr_min, arr_max = arr.min(), arr.max()\n arr = 255.0 * (arr - arr_min) / (arr_max - arr_min)\n pyg_img = pygame.surfarray.make_surface(arr.swapaxes(0, 1) if transpose else arr)\n pyg_img = pygame.transform.scale(pyg_img, video_size)\n screen.blit(pyg_img, (0,0))\n\ndef play(env, transpose=True, fps=30, zoom=None, callback=None, keys_to_action=None):\n \"\"\"Allows one to play the game using keyboard.\n\n To simply play the game use:\n\n play(gym.make(\"Pong-v4\"))\n\n Above code works also if env is wrapped, so it's particularly useful in\n verifying that the frame-level preprocessing does not render the game\n unplayable.\n\n If you wish to plot real time statistics as you play, you can use\n gym.utils.play.PlayPlot. Here's a sample code for plotting the reward\n for last 5 second of gameplay.\n\n def callback(obs_t, obs_tp1, action, rew, done, info):\n return [rew,]\n plotter = PlayPlot(callback, 30 * 5, [\"reward\"])\n\n env = gym.make(\"Pong-v4\")\n play(env, callback=plotter.callback)\n\n\n Arguments\n ---------\n env: gym.Env\n Environment to use for playing.\n transpose: bool\n If True the output of observation is transposed.\n Defaults to true.\n fps: int\n Maximum number of steps of the environment to execute every second.\n Defaults to 30.\n zoom: float\n Make screen edge this many times bigger\n callback: lambda or None\n Callback if a callback is provided it will be executed after\n every step. It takes the following input:\n obs_t: observation before performing action\n obs_tp1: observation after performing action\n action: action that was executed\n rew: reward that was received\n done: whether the environment is done or not\n info: debug info\n keys_to_action: dict: tuple(int) -> int or None\n Mapping from keys pressed to action performed.\n For example if pressed 'w' and space at the same time is supposed\n to trigger action number 2 then key_to_action dict would look like this:\n\n {\n # ...\n sorted(ord('w'), ord(' ')) -> 2\n # ...\n }\n If None, default key_to_action mapping for that env is used, if provided.\n \"\"\"\n\n obs_s = env.observation_space\n assert type(obs_s) == gym.spaces.box.Box\n assert len(obs_s.shape) == 2 or (len(obs_s.shape) == 3 and obs_s.shape[2] in [1,3])\n\n if keys_to_action is None:\n if hasattr(env, 'get_keys_to_action'):\n keys_to_action = env.get_keys_to_action()\n elif hasattr(env.unwrapped, 'get_keys_to_action'):\n keys_to_action = env.unwrapped.get_keys_to_action()\n else:\n assert False, env.spec.id + \" does not have explicit key to action mapping, \" + \\\n \"please specify one manually\"\n relevant_keys = set(sum(map(list, keys_to_action.keys()),[]))\n\n if transpose:\n video_size = env.observation_space.shape[1], env.observation_space.shape[0]\n else:\n video_size = env.observation_space.shape[0], env.observation_space.shape[1]\n\n if zoom is not None:\n video_size = int(video_size[0] * zoom), int(video_size[1] * zoom)\n\n pressed_keys = []\n running = True\n env_done = True\n\n screen = pygame.display.set_mode(video_size)\n clock = pygame.time.Clock()\n\n\n while running:\n if env_done:\n env_done = False\n obs = env.reset()\n else:\n action = keys_to_action.get(tuple(sorted(pressed_keys)), 0)\n prev_obs = obs\n obs, rew, env_done, info = env.step(action)\n if callback is not None:\n callback(prev_obs, obs, action, rew, env_done, info)\n if obs is not None:\n if len(obs.shape) == 2:\n obs = obs[:, :, None]\n if obs.shape[2] == 1:\n obs = obs.repeat(3, axis=2)\n display_arr(screen, obs, transpose=transpose, video_size=video_size)\n\n # process pygame events\n for event in pygame.event.get():\n # test events, set key states\n if event.type == pygame.KEYDOWN:\n if event.key in relevant_keys:\n pressed_keys.append(event.key)\n elif event.key == 27:\n running = False\n elif event.type == pygame.KEYUP:\n if event.key in relevant_keys:\n pressed_keys.remove(event.key)\n elif event.type == pygame.QUIT:\n running = False\n elif event.type == VIDEORESIZE:\n video_size = event.size\n screen = pygame.display.set_mode(video_size)\n print(video_size)\n\n pygame.display.flip()\n clock.tick(fps)\n pygame.quit()\n\nclass PlayPlot(object):\n def __init__(self, callback, horizon_timesteps, plot_names):\n self.data_callback = callback\n self.horizon_timesteps = horizon_timesteps\n self.plot_names = plot_names\n\n assert plt is not None, \"matplotlib backend failed, plotting will not work\"\n\n num_plots = len(self.plot_names)\n self.fig, self.ax = plt.subplots(num_plots)\n if num_plots == 1:\n self.ax = [self.ax]\n for axis, name in zip(self.ax, plot_names):\n axis.set_title(name)\n self.t = 0\n self.cur_plot = [None for _ in range(num_plots)]\n self.data = [deque(maxlen=horizon_timesteps) for _ in range(num_plots)]\n\n def callback(self, obs_t, obs_tp1, action, rew, done, info):\n points = self.data_callback(obs_t, obs_tp1, action, rew, done, info)\n for point, data_series in zip(points, self.data):\n data_series.append(point)\n self.t += 1\n\n xmin, xmax = max(0, self.t - self.horizon_timesteps), self.t\n\n for i, plot in enumerate(self.cur_plot):\n if plot is not None:\n plot.remove()\n self.cur_plot[i] = self.ax[i].scatter(range(xmin, xmax), list(self.data[i]), c='blue')\n self.ax[i].set_xlim(xmin, xmax)\n plt.pause(0.000001)\n\n\ndef main():\n parser = argparse.ArgumentParser()\n parser.add_argument('--env', type=str, default='MontezumaRevengeNoFrameskip-v4', help='Define Environment')\n args = parser.parse_args()\n env = gym.make(args.env)\n play(env, zoom=4, fps=60)\n\n\nif __name__ == '__main__':\n main()\n", "path": "gym/utils/play.py"}]}
| 2,432 | 797 |
gh_patches_debug_13960
|
rasdani/github-patches
|
git_diff
|
uccser__cs-unplugged-1464
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
HTML can be inserted into a user's Plugging it in challenge templates
### The steps are:
- [Open any programming challenge on PII](https://www.csunplugged.org/en/plugging-it-in/binary-numbers/how-binary-digits-work/binary-numbers-no-calculations/)
- Submit this code in the answer box:
- `</script><script type="text/javascript">console.log("hi")</script>`
- It must be all on one line
- Adapt to your desired level of maliciousness
- Refresh the page
When the user re-requests the page, the submitted 'code' is loaded [in the HTML template](https://github.com/uccser/cs-unplugged/blob/develop/csunplugged/templates/plugging_it_in/programming-challenge.html#L191). The first `</script>` closes the script that assigns the variables, and what follows is loaded as a new HTML script tag. The resulting HTML is sent to the user and executes 'as normal'.
I haven't been able to submit code that executes while also not breaking every PII challenge page. When the page does break, deleting your cookies for CSU allows you to get it working again
### Three potential fixes
- [Escape the submitted code.](https://docs.djangoproject.com/en/3.1/ref/utils/#module-django.utils.html)
- It was already escaped, the problem is that [it gets un-escaped](https://docs.djangoproject.com/en/2.2/ref/templates/language/#automatic-html-escaping) in order to load as a variable.
- So we would need to un-escape it in JS rather than HTML, and doing so will be tricky
(`'}}<` etc is loaded into the answer box)
- Don't load the user submitted code into the HTML template, and instead request it in JS
- Will be slower, another request is needed
- Load the submitted code in the HTML, not as a variable, but straight into the <textarea> answer box.
- This is how it's done in CodeWOF
- Since it's in a <textarea> everything is rendered as plaintext
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `csunplugged/config/__init__.py`
Content:
```
1 """Module for Django system configuration."""
2
3 __version__ = "6.0.0"
4
```
Path: `csunplugged/plugging_it_in/views.py`
Content:
```
1 """Views for the plugging_it_in application."""
2
3 from django.http import HttpResponse
4 from django.http import Http404
5
6 import json
7 import requests
8
9 from django.shortcuts import get_object_or_404
10 from django.views import generic
11 from django.views import View
12 from django.urls import reverse
13 from django.conf import settings
14 from django.core.exceptions import ObjectDoesNotExist
15 from utils.translated_first import translated_first
16 from utils.group_lessons_by_age import group_lessons_by_age
17
18 from topics.models import (
19 Topic,
20 ProgrammingChallenge,
21 Lesson
22 )
23
24
25 class IndexView(generic.ListView):
26 """View for the topics application homepage."""
27
28 template_name = "plugging_it_in/index.html"
29 context_object_name = "programming_topics"
30
31 def get_queryset(self):
32 """Get queryset of all topics.
33
34 Returns:
35 Queryset of Topic objects ordered by name.
36 """
37 programming_topics = Topic.objects.order_by(
38 "name"
39 ).exclude(
40 programming_challenges__isnull=True
41 ).prefetch_related(
42 "programming_challenges",
43 "lessons",
44 )
45 return translated_first(programming_topics)
46
47 def get_context_data(self, **kwargs):
48 """Provide the context data for the index view.
49
50 Returns:
51 Dictionary of context data.
52 """
53 # Call the base implementation first to get a context
54 context = super(IndexView, self).get_context_data(**kwargs)
55 for topic in self.object_list:
56 topic.grouped_lessons = group_lessons_by_age(
57 topic.lessons.all(),
58 only_programming_exercises=True
59 )
60 return context
61
62
63 class AboutView(generic.TemplateView):
64 """View for the about page that renders from a template."""
65
66 template_name = "plugging_it_in/about.html"
67
68
69 class ProgrammingChallengeListView(generic.DetailView):
70 """View showing all the programming exercises for a specific lesson."""
71
72 model = Lesson
73 template_name = "plugging_it_in/lesson.html"
74
75 def get_object(self, **kwargs):
76 """Retrieve object for the lesson view.
77
78 Returns:
79 Lesson object, or raises 404 error if not found.
80 """
81 return get_object_or_404(
82 self.model.objects.select_related(),
83 topic__slug=self.kwargs.get("topic_slug", None),
84 slug=self.kwargs.get("lesson_slug", None),
85 )
86
87 def get_context_data(self, **kwargs):
88 """Provide the context data for the programming challenge list view.
89
90 Returns:
91 Dictionary of context data.
92 """
93 # Call the base implementation first to get a context
94 context = super(ProgrammingChallengeListView, self).get_context_data(**kwargs)
95
96 context["topic"] = self.object.topic
97
98 context["lesson"] = self.object
99
100 # Add in a QuerySet of all the connected programming exercises for this topic
101 context["programming_challenges"] = self.object.retrieve_related_programming_challenges(
102 ).prefetch_related('implementations')
103 return context
104
105
106 class ProgrammingChallengeView(generic.DetailView):
107 """View for a specific programming challenge."""
108
109 model = ProgrammingChallenge
110 template_name = "plugging_it_in/programming-challenge.html"
111 context_object_name = "programming_challenge"
112
113 def get_object(self, **kwargs):
114 """Retrieve object for the programming challenge view.
115
116 Returns:
117 ProgrammingChallenge object, or raises 404 error if not found.
118 """
119 return get_object_or_404(
120 self.model.objects.select_related(),
121 topic__slug=self.kwargs.get("topic_slug", None),
122 slug=self.kwargs.get("programming_challenge_slug", None)
123 )
124
125 def get_context_data(self, **kwargs):
126 """Provide the context data for the programming challenge view.
127
128 Returns:
129 Dictionary of context data.
130 """
131 # Call the base implementation first to get a context
132 context = super(ProgrammingChallengeView, self).get_context_data(**kwargs)
133
134 context["topic"] = self.object.topic
135
136 try:
137 lesson_slug = self.kwargs.get("lesson_slug", None)
138 lesson = Lesson.objects.get(slug=lesson_slug)
139 context["lesson"] = lesson
140 challlenges = lesson.retrieve_related_programming_challenges("Python")
141 context["programming_challenges"] = challlenges
142 context["programming_exercises_json"] = json.dumps(list(challlenges.values()))
143 except ObjectDoesNotExist:
144 raise Http404("Lesson does not exist")
145
146 context["implementations"] = self.object.ordered_implementations()
147
148 related_test_cases = self.object.related_test_cases()
149 context["test_cases_json"] = json.dumps(list(related_test_cases.values()))
150 context["test_cases"] = related_test_cases
151 context["jobe_proxy_url"] = reverse('plugging_it_in:jobe_proxy')
152 context["saved_attempts"] = self.request.session.get('saved_attempts', {})
153
154 return context
155
156
157 class JobeProxyView(View):
158 """Proxy for Jobe Server."""
159
160 def post(self, request, *args, **kwargs):
161 """Forward on request to Jobe from the frontend and adds API key if this is needed.
162
163 Returns:
164 The response from the Jobe server.
165 """
166 # Extracting data from the request body
167 body_unicode = request.body.decode('utf-8')
168 body = json.dumps(json.loads(body_unicode))
169
170 headers = {"Content-type": "application/json; charset=utf-8",
171 "Accept": "application/json"}
172
173 # Set API key for production
174 if hasattr(settings, 'JOBE_API_KEY'):
175 headers["X-API-KEY"] = settings.JOBE_API_KEY
176
177 response = requests.post(settings.JOBE_SERVER_URL + "/jobe/index.php/restapi/runs/",
178 data=body, headers=headers)
179 return HttpResponse(response.text)
180
181
182 class SaveAttemptView(View):
183 """View to save the users challenge attempt."""
184
185 def post(self, request):
186 """Save the users attempt to a Django session."""
187 body_unicode = request.body.decode('utf-8')
188 body = json.loads(body_unicode)
189
190 request.session['saved_attempts'] = request.session.get('saved_attempts', {})
191
192 # To stop a "passed" or "failed" status being overridden by "started"
193 if (not (body["status"] == "started"
194 and request.session.get('saved_attempts', {}).get(body["challenge"], {}).get("status", "")
195 in {'passed', 'failed'})
196 and body["attempt"] != ""):
197 request.session['saved_attempts'][body["challenge"]] = {
198 "status": body["status"],
199 "code": body["attempt"]
200 }
201 return HttpResponse("Saved the attempt.")
202 else:
203 return HttpResponse("Response does not need to be saved.")
204
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/csunplugged/config/__init__.py b/csunplugged/config/__init__.py
--- a/csunplugged/config/__init__.py
+++ b/csunplugged/config/__init__.py
@@ -1,3 +1,3 @@
"""Module for Django system configuration."""
-__version__ = "6.0.0"
+__version__ = "6.0.1"
diff --git a/csunplugged/plugging_it_in/views.py b/csunplugged/plugging_it_in/views.py
--- a/csunplugged/plugging_it_in/views.py
+++ b/csunplugged/plugging_it_in/views.py
@@ -150,6 +150,10 @@
context["test_cases"] = related_test_cases
context["jobe_proxy_url"] = reverse('plugging_it_in:jobe_proxy')
context["saved_attempts"] = self.request.session.get('saved_attempts', {})
+ try:
+ context["previous_submission"] = context["saved_attempts"][self.object.slug]['code']
+ except KeyError:
+ context["previous_submission"] = ''
return context
|
{"golden_diff": "diff --git a/csunplugged/config/__init__.py b/csunplugged/config/__init__.py\n--- a/csunplugged/config/__init__.py\n+++ b/csunplugged/config/__init__.py\n@@ -1,3 +1,3 @@\n \"\"\"Module for Django system configuration.\"\"\"\n \n-__version__ = \"6.0.0\"\n+__version__ = \"6.0.1\"\ndiff --git a/csunplugged/plugging_it_in/views.py b/csunplugged/plugging_it_in/views.py\n--- a/csunplugged/plugging_it_in/views.py\n+++ b/csunplugged/plugging_it_in/views.py\n@@ -150,6 +150,10 @@\n context[\"test_cases\"] = related_test_cases\n context[\"jobe_proxy_url\"] = reverse('plugging_it_in:jobe_proxy')\n context[\"saved_attempts\"] = self.request.session.get('saved_attempts', {})\n+ try:\n+ context[\"previous_submission\"] = context[\"saved_attempts\"][self.object.slug]['code']\n+ except KeyError:\n+ context[\"previous_submission\"] = ''\n \n return context\n", "issue": "HTML can be inserted into a user's Plugging it in challenge templates\n### The steps are:\r\n- [Open any programming challenge on PII](https://www.csunplugged.org/en/plugging-it-in/binary-numbers/how-binary-digits-work/binary-numbers-no-calculations/)\r\n- Submit this code in the answer box:\r\n - `</script><script type=\"text/javascript\">console.log(\"hi\")</script>`\r\n - It must be all on one line\r\n - Adapt to your desired level of maliciousness\r\n- Refresh the page\r\n\r\nWhen the user re-requests the page, the submitted 'code' is loaded [in the HTML template](https://github.com/uccser/cs-unplugged/blob/develop/csunplugged/templates/plugging_it_in/programming-challenge.html#L191). The first `</script>` closes the script that assigns the variables, and what follows is loaded as a new HTML script tag. The resulting HTML is sent to the user and executes 'as normal'.\r\n\r\nI haven't been able to submit code that executes while also not breaking every PII challenge page. When the page does break, deleting your cookies for CSU allows you to get it working again\r\n\r\n### Three potential fixes\r\n- [Escape the submitted code.](https://docs.djangoproject.com/en/3.1/ref/utils/#module-django.utils.html)\r\n - It was already escaped, the problem is that [it gets un-escaped](https://docs.djangoproject.com/en/2.2/ref/templates/language/#automatic-html-escaping) in order to load as a variable.\r\n - So we would need to un-escape it in JS rather than HTML, and doing so will be tricky\r\n(`'}}<` etc is loaded into the answer box)\r\n- Don't load the user submitted code into the HTML template, and instead request it in JS\r\n - Will be slower, another request is needed\r\n- Load the submitted code in the HTML, not as a variable, but straight into the <textarea> answer box.\r\n - This is how it's done in CodeWOF\r\n - Since it's in a <textarea> everything is rendered as plaintext\n", "before_files": [{"content": "\"\"\"Module for Django system configuration.\"\"\"\n\n__version__ = \"6.0.0\"\n", "path": "csunplugged/config/__init__.py"}, {"content": "\"\"\"Views for the plugging_it_in application.\"\"\"\n\nfrom django.http import HttpResponse\nfrom django.http import Http404\n\nimport json\nimport requests\n\nfrom django.shortcuts import get_object_or_404\nfrom django.views import generic\nfrom django.views import View\nfrom django.urls import reverse\nfrom django.conf import settings\nfrom django.core.exceptions import ObjectDoesNotExist\nfrom utils.translated_first import translated_first\nfrom utils.group_lessons_by_age import group_lessons_by_age\n\nfrom topics.models import (\n Topic,\n ProgrammingChallenge,\n Lesson\n)\n\n\nclass IndexView(generic.ListView):\n \"\"\"View for the topics application homepage.\"\"\"\n\n template_name = \"plugging_it_in/index.html\"\n context_object_name = \"programming_topics\"\n\n def get_queryset(self):\n \"\"\"Get queryset of all topics.\n\n Returns:\n Queryset of Topic objects ordered by name.\n \"\"\"\n programming_topics = Topic.objects.order_by(\n \"name\"\n ).exclude(\n programming_challenges__isnull=True\n ).prefetch_related(\n \"programming_challenges\",\n \"lessons\",\n )\n return translated_first(programming_topics)\n\n def get_context_data(self, **kwargs):\n \"\"\"Provide the context data for the index view.\n\n Returns:\n Dictionary of context data.\n \"\"\"\n # Call the base implementation first to get a context\n context = super(IndexView, self).get_context_data(**kwargs)\n for topic in self.object_list:\n topic.grouped_lessons = group_lessons_by_age(\n topic.lessons.all(),\n only_programming_exercises=True\n )\n return context\n\n\nclass AboutView(generic.TemplateView):\n \"\"\"View for the about page that renders from a template.\"\"\"\n\n template_name = \"plugging_it_in/about.html\"\n\n\nclass ProgrammingChallengeListView(generic.DetailView):\n \"\"\"View showing all the programming exercises for a specific lesson.\"\"\"\n\n model = Lesson\n template_name = \"plugging_it_in/lesson.html\"\n\n def get_object(self, **kwargs):\n \"\"\"Retrieve object for the lesson view.\n\n Returns:\n Lesson object, or raises 404 error if not found.\n \"\"\"\n return get_object_or_404(\n self.model.objects.select_related(),\n topic__slug=self.kwargs.get(\"topic_slug\", None),\n slug=self.kwargs.get(\"lesson_slug\", None),\n )\n\n def get_context_data(self, **kwargs):\n \"\"\"Provide the context data for the programming challenge list view.\n\n Returns:\n Dictionary of context data.\n \"\"\"\n # Call the base implementation first to get a context\n context = super(ProgrammingChallengeListView, self).get_context_data(**kwargs)\n\n context[\"topic\"] = self.object.topic\n\n context[\"lesson\"] = self.object\n\n # Add in a QuerySet of all the connected programming exercises for this topic\n context[\"programming_challenges\"] = self.object.retrieve_related_programming_challenges(\n ).prefetch_related('implementations')\n return context\n\n\nclass ProgrammingChallengeView(generic.DetailView):\n \"\"\"View for a specific programming challenge.\"\"\"\n\n model = ProgrammingChallenge\n template_name = \"plugging_it_in/programming-challenge.html\"\n context_object_name = \"programming_challenge\"\n\n def get_object(self, **kwargs):\n \"\"\"Retrieve object for the programming challenge view.\n\n Returns:\n ProgrammingChallenge object, or raises 404 error if not found.\n \"\"\"\n return get_object_or_404(\n self.model.objects.select_related(),\n topic__slug=self.kwargs.get(\"topic_slug\", None),\n slug=self.kwargs.get(\"programming_challenge_slug\", None)\n )\n\n def get_context_data(self, **kwargs):\n \"\"\"Provide the context data for the programming challenge view.\n\n Returns:\n Dictionary of context data.\n \"\"\"\n # Call the base implementation first to get a context\n context = super(ProgrammingChallengeView, self).get_context_data(**kwargs)\n\n context[\"topic\"] = self.object.topic\n\n try:\n lesson_slug = self.kwargs.get(\"lesson_slug\", None)\n lesson = Lesson.objects.get(slug=lesson_slug)\n context[\"lesson\"] = lesson\n challlenges = lesson.retrieve_related_programming_challenges(\"Python\")\n context[\"programming_challenges\"] = challlenges\n context[\"programming_exercises_json\"] = json.dumps(list(challlenges.values()))\n except ObjectDoesNotExist:\n raise Http404(\"Lesson does not exist\")\n\n context[\"implementations\"] = self.object.ordered_implementations()\n\n related_test_cases = self.object.related_test_cases()\n context[\"test_cases_json\"] = json.dumps(list(related_test_cases.values()))\n context[\"test_cases\"] = related_test_cases\n context[\"jobe_proxy_url\"] = reverse('plugging_it_in:jobe_proxy')\n context[\"saved_attempts\"] = self.request.session.get('saved_attempts', {})\n\n return context\n\n\nclass JobeProxyView(View):\n \"\"\"Proxy for Jobe Server.\"\"\"\n\n def post(self, request, *args, **kwargs):\n \"\"\"Forward on request to Jobe from the frontend and adds API key if this is needed.\n\n Returns:\n The response from the Jobe server.\n \"\"\"\n # Extracting data from the request body\n body_unicode = request.body.decode('utf-8')\n body = json.dumps(json.loads(body_unicode))\n\n headers = {\"Content-type\": \"application/json; charset=utf-8\",\n \"Accept\": \"application/json\"}\n\n # Set API key for production\n if hasattr(settings, 'JOBE_API_KEY'):\n headers[\"X-API-KEY\"] = settings.JOBE_API_KEY\n\n response = requests.post(settings.JOBE_SERVER_URL + \"/jobe/index.php/restapi/runs/\",\n data=body, headers=headers)\n return HttpResponse(response.text)\n\n\nclass SaveAttemptView(View):\n \"\"\"View to save the users challenge attempt.\"\"\"\n\n def post(self, request):\n \"\"\"Save the users attempt to a Django session.\"\"\"\n body_unicode = request.body.decode('utf-8')\n body = json.loads(body_unicode)\n\n request.session['saved_attempts'] = request.session.get('saved_attempts', {})\n\n # To stop a \"passed\" or \"failed\" status being overridden by \"started\"\n if (not (body[\"status\"] == \"started\"\n and request.session.get('saved_attempts', {}).get(body[\"challenge\"], {}).get(\"status\", \"\")\n in {'passed', 'failed'})\n and body[\"attempt\"] != \"\"):\n request.session['saved_attempts'][body[\"challenge\"]] = {\n \"status\": body[\"status\"],\n \"code\": body[\"attempt\"]\n }\n return HttpResponse(\"Saved the attempt.\")\n else:\n return HttpResponse(\"Response does not need to be saved.\")\n", "path": "csunplugged/plugging_it_in/views.py"}], "after_files": [{"content": "\"\"\"Module for Django system configuration.\"\"\"\n\n__version__ = \"6.0.1\"\n", "path": "csunplugged/config/__init__.py"}, {"content": "\"\"\"Views for the plugging_it_in application.\"\"\"\n\nfrom django.http import HttpResponse\nfrom django.http import Http404\n\nimport json\nimport requests\n\nfrom django.shortcuts import get_object_or_404\nfrom django.views import generic\nfrom django.views import View\nfrom django.urls import reverse\nfrom django.conf import settings\nfrom django.core.exceptions import ObjectDoesNotExist\nfrom utils.translated_first import translated_first\nfrom utils.group_lessons_by_age import group_lessons_by_age\n\nfrom topics.models import (\n Topic,\n ProgrammingChallenge,\n Lesson\n)\n\n\nclass IndexView(generic.ListView):\n \"\"\"View for the topics application homepage.\"\"\"\n\n template_name = \"plugging_it_in/index.html\"\n context_object_name = \"programming_topics\"\n\n def get_queryset(self):\n \"\"\"Get queryset of all topics.\n\n Returns:\n Queryset of Topic objects ordered by name.\n \"\"\"\n programming_topics = Topic.objects.order_by(\n \"name\"\n ).exclude(\n programming_challenges__isnull=True\n ).prefetch_related(\n \"programming_challenges\",\n \"lessons\",\n )\n return translated_first(programming_topics)\n\n def get_context_data(self, **kwargs):\n \"\"\"Provide the context data for the index view.\n\n Returns:\n Dictionary of context data.\n \"\"\"\n # Call the base implementation first to get a context\n context = super(IndexView, self).get_context_data(**kwargs)\n for topic in self.object_list:\n topic.grouped_lessons = group_lessons_by_age(\n topic.lessons.all(),\n only_programming_exercises=True\n )\n return context\n\n\nclass AboutView(generic.TemplateView):\n \"\"\"View for the about page that renders from a template.\"\"\"\n\n template_name = \"plugging_it_in/about.html\"\n\n\nclass ProgrammingChallengeListView(generic.DetailView):\n \"\"\"View showing all the programming exercises for a specific lesson.\"\"\"\n\n model = Lesson\n template_name = \"plugging_it_in/lesson.html\"\n\n def get_object(self, **kwargs):\n \"\"\"Retrieve object for the lesson view.\n\n Returns:\n Lesson object, or raises 404 error if not found.\n \"\"\"\n return get_object_or_404(\n self.model.objects.select_related(),\n topic__slug=self.kwargs.get(\"topic_slug\", None),\n slug=self.kwargs.get(\"lesson_slug\", None),\n )\n\n def get_context_data(self, **kwargs):\n \"\"\"Provide the context data for the programming challenge list view.\n\n Returns:\n Dictionary of context data.\n \"\"\"\n # Call the base implementation first to get a context\n context = super(ProgrammingChallengeListView, self).get_context_data(**kwargs)\n\n context[\"topic\"] = self.object.topic\n\n context[\"lesson\"] = self.object\n\n # Add in a QuerySet of all the connected programming exercises for this topic\n context[\"programming_challenges\"] = self.object.retrieve_related_programming_challenges(\n ).prefetch_related('implementations')\n return context\n\n\nclass ProgrammingChallengeView(generic.DetailView):\n \"\"\"View for a specific programming challenge.\"\"\"\n\n model = ProgrammingChallenge\n template_name = \"plugging_it_in/programming-challenge.html\"\n context_object_name = \"programming_challenge\"\n\n def get_object(self, **kwargs):\n \"\"\"Retrieve object for the programming challenge view.\n\n Returns:\n ProgrammingChallenge object, or raises 404 error if not found.\n \"\"\"\n return get_object_or_404(\n self.model.objects.select_related(),\n topic__slug=self.kwargs.get(\"topic_slug\", None),\n slug=self.kwargs.get(\"programming_challenge_slug\", None)\n )\n\n def get_context_data(self, **kwargs):\n \"\"\"Provide the context data for the programming challenge view.\n\n Returns:\n Dictionary of context data.\n \"\"\"\n # Call the base implementation first to get a context\n context = super(ProgrammingChallengeView, self).get_context_data(**kwargs)\n\n context[\"topic\"] = self.object.topic\n\n try:\n lesson_slug = self.kwargs.get(\"lesson_slug\", None)\n lesson = Lesson.objects.get(slug=lesson_slug)\n context[\"lesson\"] = lesson\n challlenges = lesson.retrieve_related_programming_challenges(\"Python\")\n context[\"programming_challenges\"] = challlenges\n context[\"programming_exercises_json\"] = json.dumps(list(challlenges.values()))\n except ObjectDoesNotExist:\n raise Http404(\"Lesson does not exist\")\n\n context[\"implementations\"] = self.object.ordered_implementations()\n\n related_test_cases = self.object.related_test_cases()\n context[\"test_cases_json\"] = json.dumps(list(related_test_cases.values()))\n context[\"test_cases\"] = related_test_cases\n context[\"jobe_proxy_url\"] = reverse('plugging_it_in:jobe_proxy')\n context[\"saved_attempts\"] = self.request.session.get('saved_attempts', {})\n try:\n context[\"previous_submission\"] = context[\"saved_attempts\"][self.object.slug]['code']\n except KeyError:\n context[\"previous_submission\"] = ''\n\n return context\n\n\nclass JobeProxyView(View):\n \"\"\"Proxy for Jobe Server.\"\"\"\n\n def post(self, request, *args, **kwargs):\n \"\"\"Forward on request to Jobe from the frontend and adds API key if this is needed.\n\n Returns:\n The response from the Jobe server.\n \"\"\"\n # Extracting data from the request body\n body_unicode = request.body.decode('utf-8')\n body = json.dumps(json.loads(body_unicode))\n\n headers = {\"Content-type\": \"application/json; charset=utf-8\",\n \"Accept\": \"application/json\"}\n\n # Set API key for production\n if hasattr(settings, 'JOBE_API_KEY'):\n headers[\"X-API-KEY\"] = settings.JOBE_API_KEY\n\n response = requests.post(settings.JOBE_SERVER_URL + \"/jobe/index.php/restapi/runs/\",\n data=body, headers=headers)\n return HttpResponse(response.text)\n\n\nclass SaveAttemptView(View):\n \"\"\"View to save the users challenge attempt.\"\"\"\n\n def post(self, request):\n \"\"\"Save the users attempt to a Django session.\"\"\"\n body_unicode = request.body.decode('utf-8')\n body = json.loads(body_unicode)\n\n request.session['saved_attempts'] = request.session.get('saved_attempts', {})\n\n # To stop a \"passed\" or \"failed\" status being overridden by \"started\"\n if (not (body[\"status\"] == \"started\"\n and request.session.get('saved_attempts', {}).get(body[\"challenge\"], {}).get(\"status\", \"\")\n in {'passed', 'failed'})\n and body[\"attempt\"] != \"\"):\n request.session['saved_attempts'][body[\"challenge\"]] = {\n \"status\": body[\"status\"],\n \"code\": body[\"attempt\"]\n }\n return HttpResponse(\"Saved the attempt.\")\n else:\n return HttpResponse(\"Response does not need to be saved.\")\n", "path": "csunplugged/plugging_it_in/views.py"}]}
| 2,715 | 246 |
gh_patches_debug_25141
|
rasdani/github-patches
|
git_diff
|
bridgecrewio__checkov-3080
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
CKV_AWS_233 Ensure Create before destroy for ACM certificates false positive reading plan
**Describe the issue**
This check raises a false positive for the following resource which does have that lifecycle hook enabled.
**Examples**
Checkov run with:
```
checkov --file plan.json --output junitxml --output cli --output-file-path checkov-out --repo-root-for-plan-enrichment . --download-external-modules True > out.log 2>&1
```
Section in the plan.json:
```
{
"address": "module.my_module.aws_acm_certificate.my_cert",
"mode": "managed",
"type": "aws_acm_certificate",
"name": "my_cert",
"provider_name": "registry.terraform.io/hashicorp/aws",
"schema_version": 0,
"values": {
"arn": "CENSORED",
"certificate_authority_arn": "",
"certificate_body": null,
"certificate_chain": null,
"domain_name": "CENSORED",
"domain_validation_options": [
{
"domain_name": "CENSORED",
"resource_record_name": "CENSORED",
"resource_record_type": "CNAME",
"resource_record_value": "CENSORED"
}
],
"id": "CENSORED",
"options": [
{
"certificate_transparency_logging_preference": "ENABLED"
}
],
"private_key": null,
"status": "ISSUED",
"subject_alternative_names": [
"CENSORED"
],
"tags": {},
"tags_all": {},
"validation_emails": [],
"validation_method": "DNS",
"validation_option": []
},
"sensitive_values": {
"domain_validation_options": [
{}
],
"options": [
{}
],
"subject_alternative_names": [
false
],
"tags": {},
"tags_all": {},
"validation_emails": [],
"validation_option": []
}
}
```
Terraform code:
```terraform
resource "aws_acm_certificate" "my_cert" {
domain_name = local.domain_name
validation_method = "DNS"
lifecycle {
create_before_destroy = true
}
}
```
Error:
```
Check: CKV_AWS_233: "Ensure Create before destroy for ACM certificates"
FAILED for resource: aws_acm_certificate.my_cert
File: ../my-file.tf:1-8
1 | resource "aws_acm_certificate" "my_cert" {
2 | domain_name = local.domain_name
3 | validation_method = "DNS"
4 |
5 | lifecycle {
6 | create_before_destroy = true
7 | }
8 | }
```
**Version:**
- Checkov Version: 2.0.1200
**Additional context**
Add any other context about the problem here.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `checkov/terraform/plan_runner.py`
Content:
```
1 import logging
2 import os
3 import platform
4
5 from typing import Optional, List, Type
6
7 from checkov.common.graph.checks_infra.registry import BaseRegistry
8 from checkov.common.graph.db_connectors.networkx.networkx_db_connector import NetworkxConnector
9 from checkov.terraform.graph_manager import TerraformGraphManager
10 from checkov.terraform.graph_builder.local_graph import TerraformLocalGraph
11 from checkov.common.graph.graph_builder.local_graph import LocalGraph
12 from checkov.common.checks_infra.registry import get_graph_checks_registry
13 from checkov.common.graph.graph_builder.graph_components.attribute_names import CustomAttributes
14 from checkov.common.output.record import Record
15 from checkov.common.output.report import Report, CheckType
16 from checkov.common.runners.base_runner import CHECKOV_CREATE_GRAPH
17 from checkov.runner_filter import RunnerFilter
18 from checkov.terraform.checks.resource.registry import resource_registry
19 from checkov.terraform.context_parsers.registry import parser_registry
20 from checkov.terraform.plan_utils import create_definitions, build_definitions_context
21 from checkov.terraform.runner import Runner as TerraformRunner, merge_reports
22
23
24 class Runner(TerraformRunner):
25 check_type = CheckType.TERRAFORM_PLAN
26
27 def __init__(self, graph_class: Type[LocalGraph] = TerraformLocalGraph,
28 graph_manager: Optional[TerraformGraphManager] = None,
29 db_connector: NetworkxConnector = NetworkxConnector(),
30 external_registries: Optional[List[BaseRegistry]] = None,
31 source: str = "Terraform"):
32 super().__init__(graph_class=graph_class, graph_manager=graph_manager, db_connector=db_connector,
33 external_registries=external_registries, source=source)
34 self.file_extensions = ['.json'] # override what gets set from the TF runner
35 self.definitions = None
36 self.context = None
37 self.graph_registry = get_graph_checks_registry(super().check_type)
38
39 block_type_registries = {
40 'resource': resource_registry,
41 }
42
43 def run(
44 self,
45 root_folder: Optional[str] = None,
46 external_checks_dir: Optional[List[str]] = None,
47 files: Optional[List[str]] = None,
48 runner_filter: RunnerFilter = RunnerFilter(),
49 collect_skip_comments: bool = True
50 ) -> Report:
51 report = Report(self.check_type)
52 parsing_errors = {}
53 if self.definitions is None or self.context is None:
54 self.definitions, definitions_raw = create_definitions(root_folder, files, runner_filter, parsing_errors)
55 self.context = build_definitions_context(self.definitions, definitions_raw)
56 if CHECKOV_CREATE_GRAPH:
57 graph = self.graph_manager.build_graph_from_definitions(self.definitions, render_variables=False)
58 self.graph_manager.save_graph(graph)
59
60 if external_checks_dir:
61 for directory in external_checks_dir:
62 resource_registry.load_external_checks(directory)
63 self.graph_registry.load_external_checks(directory)
64 self.check_tf_definition(report, root_folder, runner_filter)
65 report.add_parsing_errors(parsing_errors.keys())
66
67 if self.definitions:
68 graph_report = self.get_graph_checks_report(root_folder, runner_filter)
69 merge_reports(report, graph_report)
70 return report
71
72 def check_tf_definition(self, report, root_folder, runner_filter, collect_skip_comments=True):
73 for full_file_path, definition in self.definitions.items():
74 if platform.system() == "Windows":
75 temp = os.path.split(full_file_path)[0]
76 scanned_file = f"/{os.path.relpath(full_file_path,temp)}"
77 else:
78 scanned_file = f"/{os.path.relpath(full_file_path)}"
79 logging.debug(f"Scanning file: {scanned_file}")
80 for block_type in definition.keys():
81 if block_type in self.block_type_registries.keys():
82 self.run_block(definition[block_type], None, full_file_path, root_folder, report, scanned_file,
83 block_type, runner_filter)
84
85 def run_block(self, entities,
86 definition_context,
87 full_file_path, root_folder, report, scanned_file,
88 block_type, runner_filter=None, entity_context_path_header=None,
89 module_referrer: Optional[str] = None):
90 registry = self.block_type_registries[block_type]
91 if registry:
92 for entity in entities:
93 context_parser = parser_registry.context_parsers[block_type]
94 definition_path = context_parser.get_entity_context_path(entity)
95 entity_id = ".".join(definition_path)
96 # Entity can exist only once per dir, for file as well
97 entity_context = self.get_entity_context(definition_path, full_file_path)
98 entity_lines_range = [entity_context.get('start_line'), entity_context.get('end_line')]
99 entity_code_lines = entity_context.get('code_lines')
100 entity_address = entity_context.get('address')
101
102 results = registry.scan(scanned_file, entity, [], runner_filter)
103 for check, check_result in results.items():
104 record = Record(check_id=check.id, bc_check_id=check.bc_id, check_name=check.name,
105 check_result=check_result,
106 code_block=entity_code_lines, file_path=scanned_file,
107 file_line_range=entity_lines_range,
108 resource=entity_id, resource_address=entity_address, evaluations=None,
109 check_class=check.__class__.__module__, file_abs_path=full_file_path,
110 severity=check.severity)
111 record.set_guideline(check.guideline)
112 report.add_record(record=record)
113
114 def get_entity_context_and_evaluations(self, entity):
115 raw_context = self.get_entity_context(entity[CustomAttributes.BLOCK_NAME].split("."),
116 entity[CustomAttributes.FILE_PATH])
117 raw_context['definition_path'] = entity[CustomAttributes.BLOCK_NAME].split('.')
118 return raw_context, None
119
120 def get_entity_context(self, definition_path, full_file_path):
121 entity_id = ".".join(definition_path)
122 return self.context.get(full_file_path, {}).get(entity_id)
123
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/checkov/terraform/plan_runner.py b/checkov/terraform/plan_runner.py
--- a/checkov/terraform/plan_runner.py
+++ b/checkov/terraform/plan_runner.py
@@ -20,6 +20,14 @@
from checkov.terraform.plan_utils import create_definitions, build_definitions_context
from checkov.terraform.runner import Runner as TerraformRunner, merge_reports
+# set of check IDs with lifecycle condition
+TF_LIFECYCLE_CHECK_IDS = {
+ "CKV_AWS_217",
+ "CKV_AWS_233",
+ "CKV_AWS_237",
+ "CKV_GCP_82",
+}
+
class Runner(TerraformRunner):
check_type = CheckType.TERRAFORM_PLAN
@@ -101,6 +109,10 @@
results = registry.scan(scanned_file, entity, [], runner_filter)
for check, check_result in results.items():
+ if check.id in TF_LIFECYCLE_CHECK_IDS:
+ # can't be evaluated in TF plan
+ continue
+
record = Record(check_id=check.id, bc_check_id=check.bc_id, check_name=check.name,
check_result=check_result,
code_block=entity_code_lines, file_path=scanned_file,
|
{"golden_diff": "diff --git a/checkov/terraform/plan_runner.py b/checkov/terraform/plan_runner.py\n--- a/checkov/terraform/plan_runner.py\n+++ b/checkov/terraform/plan_runner.py\n@@ -20,6 +20,14 @@\n from checkov.terraform.plan_utils import create_definitions, build_definitions_context\n from checkov.terraform.runner import Runner as TerraformRunner, merge_reports\n \n+# set of check IDs with lifecycle condition\n+TF_LIFECYCLE_CHECK_IDS = {\n+ \"CKV_AWS_217\",\n+ \"CKV_AWS_233\",\n+ \"CKV_AWS_237\",\n+ \"CKV_GCP_82\",\n+}\n+\n \n class Runner(TerraformRunner):\n check_type = CheckType.TERRAFORM_PLAN\n@@ -101,6 +109,10 @@\n \n results = registry.scan(scanned_file, entity, [], runner_filter)\n for check, check_result in results.items():\n+ if check.id in TF_LIFECYCLE_CHECK_IDS:\n+ # can't be evaluated in TF plan\n+ continue\n+\n record = Record(check_id=check.id, bc_check_id=check.bc_id, check_name=check.name,\n check_result=check_result,\n code_block=entity_code_lines, file_path=scanned_file,\n", "issue": "CKV_AWS_233 Ensure Create before destroy for ACM certificates false positive reading plan\n**Describe the issue**\r\nThis check raises a false positive for the following resource which does have that lifecycle hook enabled.\r\n\r\n**Examples**\r\n\r\nCheckov run with:\r\n\r\n```\r\ncheckov --file plan.json --output junitxml --output cli --output-file-path checkov-out --repo-root-for-plan-enrichment . --download-external-modules True > out.log 2>&1\r\n```\r\n\r\nSection in the plan.json:\r\n\r\n```\r\n{\r\n \"address\": \"module.my_module.aws_acm_certificate.my_cert\",\r\n \"mode\": \"managed\",\r\n \"type\": \"aws_acm_certificate\",\r\n \"name\": \"my_cert\",\r\n \"provider_name\": \"registry.terraform.io/hashicorp/aws\",\r\n \"schema_version\": 0,\r\n \"values\": {\r\n \"arn\": \"CENSORED\",\r\n \"certificate_authority_arn\": \"\",\r\n \"certificate_body\": null,\r\n \"certificate_chain\": null,\r\n \"domain_name\": \"CENSORED\",\r\n \"domain_validation_options\": [\r\n {\r\n \"domain_name\": \"CENSORED\",\r\n \"resource_record_name\": \"CENSORED\",\r\n \"resource_record_type\": \"CNAME\",\r\n \"resource_record_value\": \"CENSORED\"\r\n }\r\n ],\r\n \"id\": \"CENSORED\",\r\n \"options\": [\r\n {\r\n \"certificate_transparency_logging_preference\": \"ENABLED\"\r\n }\r\n ],\r\n \"private_key\": null,\r\n \"status\": \"ISSUED\",\r\n \"subject_alternative_names\": [\r\n \"CENSORED\"\r\n ],\r\n \"tags\": {},\r\n \"tags_all\": {},\r\n \"validation_emails\": [],\r\n \"validation_method\": \"DNS\",\r\n \"validation_option\": []\r\n },\r\n \"sensitive_values\": {\r\n \"domain_validation_options\": [\r\n {}\r\n ],\r\n \"options\": [\r\n {}\r\n ],\r\n \"subject_alternative_names\": [\r\n false\r\n ],\r\n \"tags\": {},\r\n \"tags_all\": {},\r\n \"validation_emails\": [],\r\n \"validation_option\": []\r\n }\r\n}\r\n\r\n```\r\n\r\nTerraform code:\r\n\r\n```terraform\r\nresource \"aws_acm_certificate\" \"my_cert\" {\r\n domain_name = local.domain_name\r\n validation_method = \"DNS\"\r\n\r\n lifecycle {\r\n create_before_destroy = true\r\n }\r\n}\r\n```\r\n\r\nError:\r\n\r\n```\r\nCheck: CKV_AWS_233: \"Ensure Create before destroy for ACM certificates\"\r\n\tFAILED for resource: aws_acm_certificate.my_cert\r\n\tFile: ../my-file.tf:1-8\r\n\r\n\t\t1 | resource \"aws_acm_certificate\" \"my_cert\" {\r\n\t\t2 | domain_name = local.domain_name\r\n\t\t3 | validation_method = \"DNS\"\r\n\t\t4 | \r\n\t\t5 | lifecycle {\r\n\t\t6 | create_before_destroy = true\r\n\t\t7 | }\r\n\t\t8 | }\r\n```\r\n\r\n**Version:**\r\n - Checkov Version: 2.0.1200\r\n\r\n**Additional context**\r\nAdd any other context about the problem here.\r\n\n", "before_files": [{"content": "import logging\nimport os\nimport platform\n\nfrom typing import Optional, List, Type\n\nfrom checkov.common.graph.checks_infra.registry import BaseRegistry\nfrom checkov.common.graph.db_connectors.networkx.networkx_db_connector import NetworkxConnector\nfrom checkov.terraform.graph_manager import TerraformGraphManager\nfrom checkov.terraform.graph_builder.local_graph import TerraformLocalGraph\nfrom checkov.common.graph.graph_builder.local_graph import LocalGraph\nfrom checkov.common.checks_infra.registry import get_graph_checks_registry\nfrom checkov.common.graph.graph_builder.graph_components.attribute_names import CustomAttributes\nfrom checkov.common.output.record import Record\nfrom checkov.common.output.report import Report, CheckType\nfrom checkov.common.runners.base_runner import CHECKOV_CREATE_GRAPH\nfrom checkov.runner_filter import RunnerFilter\nfrom checkov.terraform.checks.resource.registry import resource_registry\nfrom checkov.terraform.context_parsers.registry import parser_registry\nfrom checkov.terraform.plan_utils import create_definitions, build_definitions_context\nfrom checkov.terraform.runner import Runner as TerraformRunner, merge_reports\n\n\nclass Runner(TerraformRunner):\n check_type = CheckType.TERRAFORM_PLAN\n\n def __init__(self, graph_class: Type[LocalGraph] = TerraformLocalGraph,\n graph_manager: Optional[TerraformGraphManager] = None,\n db_connector: NetworkxConnector = NetworkxConnector(),\n external_registries: Optional[List[BaseRegistry]] = None,\n source: str = \"Terraform\"):\n super().__init__(graph_class=graph_class, graph_manager=graph_manager, db_connector=db_connector,\n external_registries=external_registries, source=source)\n self.file_extensions = ['.json'] # override what gets set from the TF runner\n self.definitions = None\n self.context = None\n self.graph_registry = get_graph_checks_registry(super().check_type)\n\n block_type_registries = {\n 'resource': resource_registry,\n }\n\n def run(\n self,\n root_folder: Optional[str] = None,\n external_checks_dir: Optional[List[str]] = None,\n files: Optional[List[str]] = None,\n runner_filter: RunnerFilter = RunnerFilter(),\n collect_skip_comments: bool = True\n ) -> Report:\n report = Report(self.check_type)\n parsing_errors = {}\n if self.definitions is None or self.context is None:\n self.definitions, definitions_raw = create_definitions(root_folder, files, runner_filter, parsing_errors)\n self.context = build_definitions_context(self.definitions, definitions_raw)\n if CHECKOV_CREATE_GRAPH:\n graph = self.graph_manager.build_graph_from_definitions(self.definitions, render_variables=False)\n self.graph_manager.save_graph(graph)\n\n if external_checks_dir:\n for directory in external_checks_dir:\n resource_registry.load_external_checks(directory)\n self.graph_registry.load_external_checks(directory)\n self.check_tf_definition(report, root_folder, runner_filter)\n report.add_parsing_errors(parsing_errors.keys())\n\n if self.definitions:\n graph_report = self.get_graph_checks_report(root_folder, runner_filter)\n merge_reports(report, graph_report)\n return report\n\n def check_tf_definition(self, report, root_folder, runner_filter, collect_skip_comments=True):\n for full_file_path, definition in self.definitions.items():\n if platform.system() == \"Windows\":\n temp = os.path.split(full_file_path)[0]\n scanned_file = f\"/{os.path.relpath(full_file_path,temp)}\"\n else:\n scanned_file = f\"/{os.path.relpath(full_file_path)}\"\n logging.debug(f\"Scanning file: {scanned_file}\")\n for block_type in definition.keys():\n if block_type in self.block_type_registries.keys():\n self.run_block(definition[block_type], None, full_file_path, root_folder, report, scanned_file,\n block_type, runner_filter)\n\n def run_block(self, entities,\n definition_context,\n full_file_path, root_folder, report, scanned_file,\n block_type, runner_filter=None, entity_context_path_header=None,\n module_referrer: Optional[str] = None):\n registry = self.block_type_registries[block_type]\n if registry:\n for entity in entities:\n context_parser = parser_registry.context_parsers[block_type]\n definition_path = context_parser.get_entity_context_path(entity)\n entity_id = \".\".join(definition_path)\n # Entity can exist only once per dir, for file as well\n entity_context = self.get_entity_context(definition_path, full_file_path)\n entity_lines_range = [entity_context.get('start_line'), entity_context.get('end_line')]\n entity_code_lines = entity_context.get('code_lines')\n entity_address = entity_context.get('address')\n\n results = registry.scan(scanned_file, entity, [], runner_filter)\n for check, check_result in results.items():\n record = Record(check_id=check.id, bc_check_id=check.bc_id, check_name=check.name,\n check_result=check_result,\n code_block=entity_code_lines, file_path=scanned_file,\n file_line_range=entity_lines_range,\n resource=entity_id, resource_address=entity_address, evaluations=None,\n check_class=check.__class__.__module__, file_abs_path=full_file_path,\n severity=check.severity)\n record.set_guideline(check.guideline)\n report.add_record(record=record)\n\n def get_entity_context_and_evaluations(self, entity):\n raw_context = self.get_entity_context(entity[CustomAttributes.BLOCK_NAME].split(\".\"),\n entity[CustomAttributes.FILE_PATH])\n raw_context['definition_path'] = entity[CustomAttributes.BLOCK_NAME].split('.')\n return raw_context, None\n\n def get_entity_context(self, definition_path, full_file_path):\n entity_id = \".\".join(definition_path)\n return self.context.get(full_file_path, {}).get(entity_id)\n", "path": "checkov/terraform/plan_runner.py"}], "after_files": [{"content": "import logging\nimport os\nimport platform\n\nfrom typing import Optional, List, Type\n\nfrom checkov.common.graph.checks_infra.registry import BaseRegistry\nfrom checkov.common.graph.db_connectors.networkx.networkx_db_connector import NetworkxConnector\nfrom checkov.terraform.graph_manager import TerraformGraphManager\nfrom checkov.terraform.graph_builder.local_graph import TerraformLocalGraph\nfrom checkov.common.graph.graph_builder.local_graph import LocalGraph\nfrom checkov.common.checks_infra.registry import get_graph_checks_registry\nfrom checkov.common.graph.graph_builder.graph_components.attribute_names import CustomAttributes\nfrom checkov.common.output.record import Record\nfrom checkov.common.output.report import Report, CheckType\nfrom checkov.common.runners.base_runner import CHECKOV_CREATE_GRAPH\nfrom checkov.runner_filter import RunnerFilter\nfrom checkov.terraform.checks.resource.registry import resource_registry\nfrom checkov.terraform.context_parsers.registry import parser_registry\nfrom checkov.terraform.plan_utils import create_definitions, build_definitions_context\nfrom checkov.terraform.runner import Runner as TerraformRunner, merge_reports\n\n# set of check IDs with lifecycle condition\nTF_LIFECYCLE_CHECK_IDS = {\n \"CKV_AWS_217\",\n \"CKV_AWS_233\",\n \"CKV_AWS_237\",\n \"CKV_GCP_82\",\n}\n\n\nclass Runner(TerraformRunner):\n check_type = CheckType.TERRAFORM_PLAN\n\n def __init__(self, graph_class: Type[LocalGraph] = TerraformLocalGraph,\n graph_manager: Optional[TerraformGraphManager] = None,\n db_connector: NetworkxConnector = NetworkxConnector(),\n external_registries: Optional[List[BaseRegistry]] = None,\n source: str = \"Terraform\"):\n super().__init__(graph_class=graph_class, graph_manager=graph_manager, db_connector=db_connector,\n external_registries=external_registries, source=source)\n self.file_extensions = ['.json'] # override what gets set from the TF runner\n self.definitions = None\n self.context = None\n self.graph_registry = get_graph_checks_registry(super().check_type)\n\n block_type_registries = {\n 'resource': resource_registry,\n }\n\n def run(\n self,\n root_folder: Optional[str] = None,\n external_checks_dir: Optional[List[str]] = None,\n files: Optional[List[str]] = None,\n runner_filter: RunnerFilter = RunnerFilter(),\n collect_skip_comments: bool = True\n ) -> Report:\n report = Report(self.check_type)\n parsing_errors = {}\n if self.definitions is None or self.context is None:\n self.definitions, definitions_raw = create_definitions(root_folder, files, runner_filter, parsing_errors)\n self.context = build_definitions_context(self.definitions, definitions_raw)\n if CHECKOV_CREATE_GRAPH:\n graph = self.graph_manager.build_graph_from_definitions(self.definitions, render_variables=False)\n self.graph_manager.save_graph(graph)\n\n if external_checks_dir:\n for directory in external_checks_dir:\n resource_registry.load_external_checks(directory)\n self.graph_registry.load_external_checks(directory)\n self.check_tf_definition(report, root_folder, runner_filter)\n report.add_parsing_errors(parsing_errors.keys())\n\n if self.definitions:\n graph_report = self.get_graph_checks_report(root_folder, runner_filter)\n merge_reports(report, graph_report)\n return report\n\n def check_tf_definition(self, report, root_folder, runner_filter, collect_skip_comments=True):\n for full_file_path, definition in self.definitions.items():\n if platform.system() == \"Windows\":\n temp = os.path.split(full_file_path)[0]\n scanned_file = f\"/{os.path.relpath(full_file_path,temp)}\"\n else:\n scanned_file = f\"/{os.path.relpath(full_file_path)}\"\n logging.debug(f\"Scanning file: {scanned_file}\")\n for block_type in definition.keys():\n if block_type in self.block_type_registries.keys():\n self.run_block(definition[block_type], None, full_file_path, root_folder, report, scanned_file,\n block_type, runner_filter)\n\n def run_block(self, entities,\n definition_context,\n full_file_path, root_folder, report, scanned_file,\n block_type, runner_filter=None, entity_context_path_header=None,\n module_referrer: Optional[str] = None):\n registry = self.block_type_registries[block_type]\n if registry:\n for entity in entities:\n context_parser = parser_registry.context_parsers[block_type]\n definition_path = context_parser.get_entity_context_path(entity)\n entity_id = \".\".join(definition_path)\n # Entity can exist only once per dir, for file as well\n entity_context = self.get_entity_context(definition_path, full_file_path)\n entity_lines_range = [entity_context.get('start_line'), entity_context.get('end_line')]\n entity_code_lines = entity_context.get('code_lines')\n entity_address = entity_context.get('address')\n\n results = registry.scan(scanned_file, entity, [], runner_filter)\n for check, check_result in results.items():\n if check.id in TF_LIFECYCLE_CHECK_IDS:\n # can't be evaluated in TF plan\n continue\n\n record = Record(check_id=check.id, bc_check_id=check.bc_id, check_name=check.name,\n check_result=check_result,\n code_block=entity_code_lines, file_path=scanned_file,\n file_line_range=entity_lines_range,\n resource=entity_id, resource_address=entity_address, evaluations=None,\n check_class=check.__class__.__module__, file_abs_path=full_file_path,\n severity=check.severity)\n record.set_guideline(check.guideline)\n report.add_record(record=record)\n\n def get_entity_context_and_evaluations(self, entity):\n raw_context = self.get_entity_context(entity[CustomAttributes.BLOCK_NAME].split(\".\"),\n entity[CustomAttributes.FILE_PATH])\n raw_context['definition_path'] = entity[CustomAttributes.BLOCK_NAME].split('.')\n return raw_context, None\n\n def get_entity_context(self, definition_path, full_file_path):\n entity_id = \".\".join(definition_path)\n return self.context.get(full_file_path, {}).get(entity_id)\n", "path": "checkov/terraform/plan_runner.py"}]}
| 2,413 | 295 |
gh_patches_debug_12469
|
rasdani/github-patches
|
git_diff
|
pytorch__TensorRT-2490
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Expose ISelectLayer in dynamo.conversion.impl
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `py/torch_tensorrt/dynamo/conversion/impl/condition/ops.py`
Content:
```
1 from typing import Optional, Union
2
3 import numpy as np
4 import tensorrt as trt
5 import torch
6 from torch.fx.node import Target
7 from torch_tensorrt.dynamo._SourceIR import SourceIR
8 from torch_tensorrt.dynamo.conversion._ConversionContext import ConversionContext
9 from torch_tensorrt.dynamo.conversion.converter_utils import (
10 broadcastable,
11 get_trt_tensor,
12 )
13 from torch_tensorrt.dynamo.conversion.impl.slice import expand
14 from torch_tensorrt.fx.converters.converter_utils import set_layer_name
15 from torch_tensorrt.fx.types import TRTTensor
16
17
18 def where(
19 ctx: ConversionContext,
20 target: Target,
21 source_ir: Optional[SourceIR],
22 name: str,
23 input: Union[TRTTensor, np.ndarray, torch.Tensor],
24 other: Union[TRTTensor, np.ndarray, torch.Tensor],
25 condition: Union[TRTTensor, np.ndarray, torch.Tensor],
26 ) -> TRTTensor:
27 if not (broadcastable(input, other)):
28 assert "The two torch tensors should be broadcastable"
29
30 x_shape = list(input.shape)
31 y_shape = list(other.shape)
32 condition_shape = list(condition.shape)
33
34 output_shape = list(torch.broadcast_shapes(condition_shape, x_shape, y_shape))
35
36 # expand shape
37 if not isinstance(condition, TRTTensor):
38 assert condition.dtype in (torch.bool, np.bool_), "condition dtype is not bool"
39 if condition_shape != output_shape:
40 condition = (
41 condition.expand(output_shape)
42 if isinstance(condition, torch.Tensor)
43 else np.broadcast_to(condition, output_shape)
44 )
45 condition_val = get_trt_tensor(ctx, condition, f"{name}_condition")
46 else:
47 assert condition.dtype == trt.bool, "mask dtype is not bool!"
48 if condition_shape != output_shape:
49 condition_val = expand(
50 ctx, target, source_ir, f"{name}_expand", condition, output_shape
51 )
52 else:
53 condition_val = condition
54
55 if not isinstance(input, TRTTensor):
56 if x_shape != output_shape:
57 # special case where 1 element in input
58 if len(input.shape) == 0:
59 input = (
60 input.unsqueeze(0)
61 if isinstance(input, torch.Tensor)
62 else np.expand_dims(input, axis=0)
63 )
64 input = (
65 input.expand(output_shape)
66 if isinstance(input, torch.Tensor)
67 else np.broadcast_to(input, output_shape)
68 )
69 x_val = get_trt_tensor(ctx, input, f"{name}_x")
70 else:
71 x_val = input
72 if x_shape != output_shape:
73 x_val = expand(
74 ctx, target, source_ir, f"{name}_x_expand", input, output_shape
75 )
76
77 if not isinstance(other, TRTTensor):
78 if y_shape != output_shape:
79 # special case where 1 element in other
80 if len(other.shape) == 0:
81 other = (
82 other.unsqueeze(0)
83 if isinstance(other, torch.Tensor)
84 else np.expand_dims(other, axis=0)
85 )
86 other = (
87 other.expand(output_shape)
88 if isinstance(other, torch.Tensor)
89 else np.broadcast_to(other, output_shape)
90 )
91 y_val = get_trt_tensor(ctx, other, f"{name}_y")
92 else:
93 y_val = other
94 if y_shape != output_shape:
95 y_val = expand(
96 ctx, target, source_ir, f"{name}_y_expand", y_val, output_shape
97 )
98
99 select_layer = ctx.net.add_select(condition_val, x_val, y_val)
100
101 set_layer_name(select_layer, target, f"{name}_select")
102
103 return select_layer.get_output(0)
104
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/py/torch_tensorrt/dynamo/conversion/impl/condition/ops.py b/py/torch_tensorrt/dynamo/conversion/impl/condition/ops.py
--- a/py/torch_tensorrt/dynamo/conversion/impl/condition/ops.py
+++ b/py/torch_tensorrt/dynamo/conversion/impl/condition/ops.py
@@ -96,8 +96,18 @@
ctx, target, source_ir, f"{name}_y_expand", y_val, output_shape
)
- select_layer = ctx.net.add_select(condition_val, x_val, y_val)
+ return select(ctx, target, source_ir, name, x_val, y_val, condition_val)
- set_layer_name(select_layer, target, f"{name}_select")
+def select(
+ ctx: ConversionContext,
+ target: Target,
+ source_ir: Optional[SourceIR],
+ name: str,
+ input: TRTTensor,
+ other: TRTTensor,
+ condition: TRTTensor,
+) -> TRTTensor:
+ select_layer = ctx.net.add_select(condition, input, other)
+ set_layer_name(select_layer, target, name + "_select", source_ir)
return select_layer.get_output(0)
|
{"golden_diff": "diff --git a/py/torch_tensorrt/dynamo/conversion/impl/condition/ops.py b/py/torch_tensorrt/dynamo/conversion/impl/condition/ops.py\n--- a/py/torch_tensorrt/dynamo/conversion/impl/condition/ops.py\n+++ b/py/torch_tensorrt/dynamo/conversion/impl/condition/ops.py\n@@ -96,8 +96,18 @@\n ctx, target, source_ir, f\"{name}_y_expand\", y_val, output_shape\n )\n \n- select_layer = ctx.net.add_select(condition_val, x_val, y_val)\n+ return select(ctx, target, source_ir, name, x_val, y_val, condition_val)\n \n- set_layer_name(select_layer, target, f\"{name}_select\")\n \n+def select(\n+ ctx: ConversionContext,\n+ target: Target,\n+ source_ir: Optional[SourceIR],\n+ name: str,\n+ input: TRTTensor,\n+ other: TRTTensor,\n+ condition: TRTTensor,\n+) -> TRTTensor:\n+ select_layer = ctx.net.add_select(condition, input, other)\n+ set_layer_name(select_layer, target, name + \"_select\", source_ir)\n return select_layer.get_output(0)\n", "issue": "Expose ISelectLayer in dynamo.conversion.impl\n\n", "before_files": [{"content": "from typing import Optional, Union\n\nimport numpy as np\nimport tensorrt as trt\nimport torch\nfrom torch.fx.node import Target\nfrom torch_tensorrt.dynamo._SourceIR import SourceIR\nfrom torch_tensorrt.dynamo.conversion._ConversionContext import ConversionContext\nfrom torch_tensorrt.dynamo.conversion.converter_utils import (\n broadcastable,\n get_trt_tensor,\n)\nfrom torch_tensorrt.dynamo.conversion.impl.slice import expand\nfrom torch_tensorrt.fx.converters.converter_utils import set_layer_name\nfrom torch_tensorrt.fx.types import TRTTensor\n\n\ndef where(\n ctx: ConversionContext,\n target: Target,\n source_ir: Optional[SourceIR],\n name: str,\n input: Union[TRTTensor, np.ndarray, torch.Tensor],\n other: Union[TRTTensor, np.ndarray, torch.Tensor],\n condition: Union[TRTTensor, np.ndarray, torch.Tensor],\n) -> TRTTensor:\n if not (broadcastable(input, other)):\n assert \"The two torch tensors should be broadcastable\"\n\n x_shape = list(input.shape)\n y_shape = list(other.shape)\n condition_shape = list(condition.shape)\n\n output_shape = list(torch.broadcast_shapes(condition_shape, x_shape, y_shape))\n\n # expand shape\n if not isinstance(condition, TRTTensor):\n assert condition.dtype in (torch.bool, np.bool_), \"condition dtype is not bool\"\n if condition_shape != output_shape:\n condition = (\n condition.expand(output_shape)\n if isinstance(condition, torch.Tensor)\n else np.broadcast_to(condition, output_shape)\n )\n condition_val = get_trt_tensor(ctx, condition, f\"{name}_condition\")\n else:\n assert condition.dtype == trt.bool, \"mask dtype is not bool!\"\n if condition_shape != output_shape:\n condition_val = expand(\n ctx, target, source_ir, f\"{name}_expand\", condition, output_shape\n )\n else:\n condition_val = condition\n\n if not isinstance(input, TRTTensor):\n if x_shape != output_shape:\n # special case where 1 element in input\n if len(input.shape) == 0:\n input = (\n input.unsqueeze(0)\n if isinstance(input, torch.Tensor)\n else np.expand_dims(input, axis=0)\n )\n input = (\n input.expand(output_shape)\n if isinstance(input, torch.Tensor)\n else np.broadcast_to(input, output_shape)\n )\n x_val = get_trt_tensor(ctx, input, f\"{name}_x\")\n else:\n x_val = input\n if x_shape != output_shape:\n x_val = expand(\n ctx, target, source_ir, f\"{name}_x_expand\", input, output_shape\n )\n\n if not isinstance(other, TRTTensor):\n if y_shape != output_shape:\n # special case where 1 element in other\n if len(other.shape) == 0:\n other = (\n other.unsqueeze(0)\n if isinstance(other, torch.Tensor)\n else np.expand_dims(other, axis=0)\n )\n other = (\n other.expand(output_shape)\n if isinstance(other, torch.Tensor)\n else np.broadcast_to(other, output_shape)\n )\n y_val = get_trt_tensor(ctx, other, f\"{name}_y\")\n else:\n y_val = other\n if y_shape != output_shape:\n y_val = expand(\n ctx, target, source_ir, f\"{name}_y_expand\", y_val, output_shape\n )\n\n select_layer = ctx.net.add_select(condition_val, x_val, y_val)\n\n set_layer_name(select_layer, target, f\"{name}_select\")\n\n return select_layer.get_output(0)\n", "path": "py/torch_tensorrt/dynamo/conversion/impl/condition/ops.py"}], "after_files": [{"content": "from typing import Optional, Union\n\nimport numpy as np\nimport tensorrt as trt\nimport torch\nfrom torch.fx.node import Target\nfrom torch_tensorrt.dynamo._SourceIR import SourceIR\nfrom torch_tensorrt.dynamo.conversion._ConversionContext import ConversionContext\nfrom torch_tensorrt.dynamo.conversion.converter_utils import (\n broadcastable,\n get_trt_tensor,\n)\nfrom torch_tensorrt.dynamo.conversion.impl.slice import expand\nfrom torch_tensorrt.fx.converters.converter_utils import set_layer_name\nfrom torch_tensorrt.fx.types import TRTTensor\n\n\ndef where(\n ctx: ConversionContext,\n target: Target,\n source_ir: Optional[SourceIR],\n name: str,\n input: Union[TRTTensor, np.ndarray, torch.Tensor],\n other: Union[TRTTensor, np.ndarray, torch.Tensor],\n condition: Union[TRTTensor, np.ndarray, torch.Tensor],\n) -> TRTTensor:\n if not (broadcastable(input, other)):\n assert \"The two torch tensors should be broadcastable\"\n\n x_shape = list(input.shape)\n y_shape = list(other.shape)\n condition_shape = list(condition.shape)\n\n output_shape = list(torch.broadcast_shapes(condition_shape, x_shape, y_shape))\n\n # expand shape\n if not isinstance(condition, TRTTensor):\n assert condition.dtype in (torch.bool, np.bool_), \"condition dtype is not bool\"\n if condition_shape != output_shape:\n condition = (\n condition.expand(output_shape)\n if isinstance(condition, torch.Tensor)\n else np.broadcast_to(condition, output_shape)\n )\n condition_val = get_trt_tensor(ctx, condition, f\"{name}_condition\")\n else:\n assert condition.dtype == trt.bool, \"mask dtype is not bool!\"\n if condition_shape != output_shape:\n condition_val = expand(\n ctx, target, source_ir, f\"{name}_expand\", condition, output_shape\n )\n else:\n condition_val = condition\n\n if not isinstance(input, TRTTensor):\n if x_shape != output_shape:\n # special case where 1 element in input\n if len(input.shape) == 0:\n input = (\n input.unsqueeze(0)\n if isinstance(input, torch.Tensor)\n else np.expand_dims(input, axis=0)\n )\n input = (\n input.expand(output_shape)\n if isinstance(input, torch.Tensor)\n else np.broadcast_to(input, output_shape)\n )\n x_val = get_trt_tensor(ctx, input, f\"{name}_x\")\n else:\n x_val = input\n if x_shape != output_shape:\n x_val = expand(\n ctx, target, source_ir, f\"{name}_x_expand\", input, output_shape\n )\n\n if not isinstance(other, TRTTensor):\n if y_shape != output_shape:\n # special case where 1 element in other\n if len(other.shape) == 0:\n other = (\n other.unsqueeze(0)\n if isinstance(other, torch.Tensor)\n else np.expand_dims(other, axis=0)\n )\n other = (\n other.expand(output_shape)\n if isinstance(other, torch.Tensor)\n else np.broadcast_to(other, output_shape)\n )\n y_val = get_trt_tensor(ctx, other, f\"{name}_y\")\n else:\n y_val = other\n if y_shape != output_shape:\n y_val = expand(\n ctx, target, source_ir, f\"{name}_y_expand\", y_val, output_shape\n )\n\n return select(ctx, target, source_ir, name, x_val, y_val, condition_val)\n\n\ndef select(\n ctx: ConversionContext,\n target: Target,\n source_ir: Optional[SourceIR],\n name: str,\n input: TRTTensor,\n other: TRTTensor,\n condition: TRTTensor,\n) -> TRTTensor:\n select_layer = ctx.net.add_select(condition, input, other)\n set_layer_name(select_layer, target, name + \"_select\", source_ir)\n return select_layer.get_output(0)\n", "path": "py/torch_tensorrt/dynamo/conversion/impl/condition/ops.py"}]}
| 1,277 | 276 |
gh_patches_debug_4305
|
rasdani/github-patches
|
git_diff
|
pypa__pipenv-5148
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
CLI docs broken
### Issue description
[CLI docs](https://pipenv.pypa.io/en/latest/cli/)
[CLI docs source](https://pipenv.pypa.io/en/latest/_sources/cli.rst.txt)
### Expected result
CLI docs
### Actual result
Empty page
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `docs/conf.py`
Content:
```
1 #
2 # pipenv documentation build configuration file, created by
3 # sphinx-quickstart on Mon Jan 30 13:28:36 2017.
4 #
5 # This file is execfile()d with the current directory set to its
6 # containing dir.
7 #
8 # Note that not all possible configuration values are present in this
9 # autogenerated file.
10 #
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
13
14 # If extensions (or modules to document with autodoc) are in another directory,
15 # add these directories to sys.path here. If the directory is relative to the
16 # documentation root, use os.path.abspath to make it absolute, like shown here.
17 #
18 import os
19
20 # Path hackery to get current version number.
21 here = os.path.abspath(os.path.dirname(__file__))
22
23 about = {}
24 with open(os.path.join(here, "..", "pipenv", "__version__.py")) as f:
25 exec(f.read(), about)
26
27 # Hackery to get the CLI docs to generate
28 import click
29
30 import pipenv.vendor.click
31
32 click.Command = pipenv.vendor.click.Command
33 click.Group = pipenv.vendor.click.Group
34
35 # -- General configuration ------------------------------------------------
36
37 # If your documentation needs a minimal Sphinx version, state it here.
38 #
39 # needs_sphinx = '1.0'
40
41 # Add any Sphinx extension module names here, as strings. They can be
42 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
43 # ones.
44 extensions = [
45 "sphinx.ext.autodoc",
46 "sphinx.ext.todo",
47 "sphinx.ext.coverage",
48 "sphinx.ext.viewcode",
49 "sphinx_click",
50 ]
51
52 # Add any paths that contain templates here, relative to this directory.
53 templates_path = ["_templates"]
54
55 # The suffix(es) of source filenames.
56 # You can specify multiple suffix as a list of string:
57 #
58 # source_suffix = ['.rst', '.md']
59 source_suffix = ".rst"
60
61 # The master toctree document.
62 master_doc = "index"
63
64 # General information about the project.
65 project = "pipenv"
66 copyright = '2020. A project founded by Kenneth Reitz and maintained by <a href="https://www.pypa.io/en/latest/">Python Packaging Authority (PyPA).</a>'
67 author = "Python Packaging Authority"
68
69 # The version info for the project you're documenting, acts as replacement for
70 # |version| and |release|, also used in various other places throughout the
71 # built documents.
72 #
73 # The short X.Y version.
74 version = about["__version__"]
75 # The full version, including alpha/beta/rc tags.
76 release = about["__version__"]
77
78 # The language for content autogenerated by Sphinx. Refer to documentation
79 # for a list of supported languages.
80 #
81 # This is also used if you do content translation via gettext catalogs.
82 # Usually you set "language" from the command line for these cases.
83 language = None
84
85 # List of patterns, relative to source directory, that match files and
86 # directories to ignore when looking for source files.
87 # This patterns also effect to html_static_path and html_extra_path
88 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
89
90 # The name of the Pygments (syntax highlighting) style to use.
91 pygments_style = "sphinx"
92
93 # If true, `todo` and `todoList` produce output, else they produce nothing.
94 todo_include_todos = True
95
96 # -- Options for HTML output ----------------------------------------------
97
98 # The theme to use for HTML and HTML Help pages. See the documentation for
99 # a list of builtin themes.
100 #
101 html_theme = "alabaster"
102
103 # Theme options are theme-specific and customize the look and feel of a theme
104 # further. For a list of options available for each theme, see the
105 # documentation.
106 #
107 html_theme_options = {
108 "show_powered_by": False,
109 "github_user": "pypa",
110 "github_repo": "pipenv",
111 "github_banner": False,
112 "show_related": False,
113 }
114
115 html_sidebars = {
116 "index": ["sidebarlogo.html", "sourcelink.html", "searchbox.html", "hacks.html"],
117 "**": [
118 "sidebarlogo.html",
119 "localtoc.html",
120 "relations.html",
121 "sourcelink.html",
122 "searchbox.html",
123 "hacks.html",
124 ],
125 }
126
127
128 # Add any paths that contain custom static files (such as style sheets) here,
129 # relative to this directory. They are copied after the builtin static files,
130 # so a file named "default.css" will overwrite the builtin "default.css".
131 html_static_path = ["_static"]
132
133
134 def setup(app):
135 app.add_css_file("custom.css")
136
137
138 # -- Options for HTMLHelp output ------------------------------------------
139
140 # Output file base name for HTML help builder.
141 htmlhelp_basename = "pipenvdoc"
142
143
144 # -- Options for LaTeX output ---------------------------------------------
145
146 latex_elements = {
147 # The paper size ('letterpaper' or 'a4paper').
148 #
149 # 'papersize': 'letterpaper',
150 # The font size ('10pt', '11pt' or '12pt').
151 #
152 # 'pointsize': '10pt',
153 # Additional stuff for the LaTeX preamble.
154 #
155 # 'preamble': '',
156 # Latex figure (float) alignment
157 #
158 # 'figure_align': 'htbp',
159 }
160
161 # Grouping the document tree into LaTeX files. List of tuples
162 # (source start file, target name, title,
163 # author, documentclass [howto, manual, or own class]).
164 latex_documents = [
165 (master_doc, "pipenv.tex", "pipenv Documentation", "Kenneth Reitz", "manual"),
166 ]
167
168
169 # -- Options for manual page output ---------------------------------------
170
171 # One entry per manual page. List of tuples
172 # (source start file, name, description, authors, manual section).
173 man_pages = [(master_doc, "pipenv", "pipenv Documentation", [author], 1)]
174
175
176 # -- Options for Texinfo output -------------------------------------------
177
178 # Grouping the document tree into Texinfo files. List of tuples
179 # (source start file, target name, title, author,
180 # dir menu entry, description, category)
181 texinfo_documents = [
182 (
183 master_doc,
184 "pipenv",
185 "pipenv Documentation",
186 author,
187 "pipenv",
188 "One line description of project.",
189 "Miscellaneous",
190 ),
191 ]
192
193
194 # -- Options for Epub output ----------------------------------------------
195
196 # Bibliographic Dublin Core info.
197 epub_title = project
198 epub_author = author
199 epub_publisher = author
200 epub_copyright = copyright
201
202 # The unique identifier of the text. This can be a ISBN number
203 # or the project homepage.
204 #
205 # epub_identifier = ''
206
207 # A unique identification for the text.
208 #
209 # epub_uid = ''
210
211 # A list of files that should not be packed into the epub file.
212 epub_exclude_files = ["search.html"]
213
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/docs/conf.py b/docs/conf.py
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -31,7 +31,7 @@
click.Command = pipenv.vendor.click.Command
click.Group = pipenv.vendor.click.Group
-
+click.BaseCommand = pipenv.vendor.click.BaseCommand
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
|
{"golden_diff": "diff --git a/docs/conf.py b/docs/conf.py\n--- a/docs/conf.py\n+++ b/docs/conf.py\n@@ -31,7 +31,7 @@\n \n click.Command = pipenv.vendor.click.Command\n click.Group = pipenv.vendor.click.Group\n-\n+click.BaseCommand = pipenv.vendor.click.BaseCommand\n # -- General configuration ------------------------------------------------\n \n # If your documentation needs a minimal Sphinx version, state it here.\n", "issue": "CLI docs broken\n### Issue description\r\n[CLI docs](https://pipenv.pypa.io/en/latest/cli/)\r\n[CLI docs source](https://pipenv.pypa.io/en/latest/_sources/cli.rst.txt)\r\n\r\n### Expected result\r\nCLI docs\r\n\r\n### Actual result\r\nEmpty page\n", "before_files": [{"content": "#\n# pipenv documentation build configuration file, created by\n# sphinx-quickstart on Mon Jan 30 13:28:36 2017.\n#\n# This file is execfile()d with the current directory set to its\n# containing dir.\n#\n# Note that not all possible configuration values are present in this\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\n#\nimport os\n\n# Path hackery to get current version number.\nhere = os.path.abspath(os.path.dirname(__file__))\n\nabout = {}\nwith open(os.path.join(here, \"..\", \"pipenv\", \"__version__.py\")) as f:\n exec(f.read(), about)\n\n# Hackery to get the CLI docs to generate\nimport click\n\nimport pipenv.vendor.click\n\nclick.Command = pipenv.vendor.click.Command\nclick.Group = pipenv.vendor.click.Group\n\n# -- General configuration ------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#\n# needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n \"sphinx.ext.autodoc\",\n \"sphinx.ext.todo\",\n \"sphinx.ext.coverage\",\n \"sphinx.ext.viewcode\",\n \"sphinx_click\",\n]\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = [\"_templates\"]\n\n# The suffix(es) of source filenames.\n# You can specify multiple suffix as a list of string:\n#\n# source_suffix = ['.rst', '.md']\nsource_suffix = \".rst\"\n\n# The master toctree document.\nmaster_doc = \"index\"\n\n# General information about the project.\nproject = \"pipenv\"\ncopyright = '2020. A project founded by Kenneth Reitz and maintained by <a href=\"https://www.pypa.io/en/latest/\">Python Packaging Authority (PyPA).</a>'\nauthor = \"Python Packaging Authority\"\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = about[\"__version__\"]\n# The full version, including alpha/beta/rc tags.\nrelease = about[\"__version__\"]\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#\n# This is also used if you do content translation via gettext catalogs.\n# Usually you set \"language\" from the command line for these cases.\nlanguage = None\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\n# This patterns also effect to html_static_path and html_extra_path\nexclude_patterns = [\"_build\", \"Thumbs.db\", \".DS_Store\"]\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = \"sphinx\"\n\n# If true, `todo` and `todoList` produce output, else they produce nothing.\ntodo_include_todos = True\n\n# -- Options for HTML output ----------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\n#\nhtml_theme = \"alabaster\"\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#\nhtml_theme_options = {\n \"show_powered_by\": False,\n \"github_user\": \"pypa\",\n \"github_repo\": \"pipenv\",\n \"github_banner\": False,\n \"show_related\": False,\n}\n\nhtml_sidebars = {\n \"index\": [\"sidebarlogo.html\", \"sourcelink.html\", \"searchbox.html\", \"hacks.html\"],\n \"**\": [\n \"sidebarlogo.html\",\n \"localtoc.html\",\n \"relations.html\",\n \"sourcelink.html\",\n \"searchbox.html\",\n \"hacks.html\",\n ],\n}\n\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = [\"_static\"]\n\n\ndef setup(app):\n app.add_css_file(\"custom.css\")\n\n\n# -- Options for HTMLHelp output ------------------------------------------\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = \"pipenvdoc\"\n\n\n# -- Options for LaTeX output ---------------------------------------------\n\nlatex_elements = {\n # The paper size ('letterpaper' or 'a4paper').\n #\n # 'papersize': 'letterpaper',\n # The font size ('10pt', '11pt' or '12pt').\n #\n # 'pointsize': '10pt',\n # Additional stuff for the LaTeX preamble.\n #\n # 'preamble': '',\n # Latex figure (float) alignment\n #\n # 'figure_align': 'htbp',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n# author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n (master_doc, \"pipenv.tex\", \"pipenv Documentation\", \"Kenneth Reitz\", \"manual\"),\n]\n\n\n# -- Options for manual page output ---------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [(master_doc, \"pipenv\", \"pipenv Documentation\", [author], 1)]\n\n\n# -- Options for Texinfo output -------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n (\n master_doc,\n \"pipenv\",\n \"pipenv Documentation\",\n author,\n \"pipenv\",\n \"One line description of project.\",\n \"Miscellaneous\",\n ),\n]\n\n\n# -- Options for Epub output ----------------------------------------------\n\n# Bibliographic Dublin Core info.\nepub_title = project\nepub_author = author\nepub_publisher = author\nepub_copyright = copyright\n\n# The unique identifier of the text. This can be a ISBN number\n# or the project homepage.\n#\n# epub_identifier = ''\n\n# A unique identification for the text.\n#\n# epub_uid = ''\n\n# A list of files that should not be packed into the epub file.\nepub_exclude_files = [\"search.html\"]\n", "path": "docs/conf.py"}], "after_files": [{"content": "#\n# pipenv documentation build configuration file, created by\n# sphinx-quickstart on Mon Jan 30 13:28:36 2017.\n#\n# This file is execfile()d with the current directory set to its\n# containing dir.\n#\n# Note that not all possible configuration values are present in this\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\n#\nimport os\n\n# Path hackery to get current version number.\nhere = os.path.abspath(os.path.dirname(__file__))\n\nabout = {}\nwith open(os.path.join(here, \"..\", \"pipenv\", \"__version__.py\")) as f:\n exec(f.read(), about)\n\n# Hackery to get the CLI docs to generate\nimport click\n\nimport pipenv.vendor.click\n\nclick.Command = pipenv.vendor.click.Command\nclick.Group = pipenv.vendor.click.Group\nclick.BaseCommand = pipenv.vendor.click.BaseCommand\n# -- General configuration ------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#\n# needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n \"sphinx.ext.autodoc\",\n \"sphinx.ext.todo\",\n \"sphinx.ext.coverage\",\n \"sphinx.ext.viewcode\",\n \"sphinx_click\",\n]\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = [\"_templates\"]\n\n# The suffix(es) of source filenames.\n# You can specify multiple suffix as a list of string:\n#\n# source_suffix = ['.rst', '.md']\nsource_suffix = \".rst\"\n\n# The master toctree document.\nmaster_doc = \"index\"\n\n# General information about the project.\nproject = \"pipenv\"\ncopyright = '2020. A project founded by Kenneth Reitz and maintained by <a href=\"https://www.pypa.io/en/latest/\">Python Packaging Authority (PyPA).</a>'\nauthor = \"Python Packaging Authority\"\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = about[\"__version__\"]\n# The full version, including alpha/beta/rc tags.\nrelease = about[\"__version__\"]\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#\n# This is also used if you do content translation via gettext catalogs.\n# Usually you set \"language\" from the command line for these cases.\nlanguage = None\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\n# This patterns also effect to html_static_path and html_extra_path\nexclude_patterns = [\"_build\", \"Thumbs.db\", \".DS_Store\"]\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = \"sphinx\"\n\n# If true, `todo` and `todoList` produce output, else they produce nothing.\ntodo_include_todos = True\n\n# -- Options for HTML output ----------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\n#\nhtml_theme = \"alabaster\"\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further. For a list of options available for each theme, see the\n# documentation.\n#\nhtml_theme_options = {\n \"show_powered_by\": False,\n \"github_user\": \"pypa\",\n \"github_repo\": \"pipenv\",\n \"github_banner\": False,\n \"show_related\": False,\n}\n\nhtml_sidebars = {\n \"index\": [\"sidebarlogo.html\", \"sourcelink.html\", \"searchbox.html\", \"hacks.html\"],\n \"**\": [\n \"sidebarlogo.html\",\n \"localtoc.html\",\n \"relations.html\",\n \"sourcelink.html\",\n \"searchbox.html\",\n \"hacks.html\",\n ],\n}\n\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = [\"_static\"]\n\n\ndef setup(app):\n app.add_css_file(\"custom.css\")\n\n\n# -- Options for HTMLHelp output ------------------------------------------\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = \"pipenvdoc\"\n\n\n# -- Options for LaTeX output ---------------------------------------------\n\nlatex_elements = {\n # The paper size ('letterpaper' or 'a4paper').\n #\n # 'papersize': 'letterpaper',\n # The font size ('10pt', '11pt' or '12pt').\n #\n # 'pointsize': '10pt',\n # Additional stuff for the LaTeX preamble.\n #\n # 'preamble': '',\n # Latex figure (float) alignment\n #\n # 'figure_align': 'htbp',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title,\n# author, documentclass [howto, manual, or own class]).\nlatex_documents = [\n (master_doc, \"pipenv.tex\", \"pipenv Documentation\", \"Kenneth Reitz\", \"manual\"),\n]\n\n\n# -- Options for manual page output ---------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\nman_pages = [(master_doc, \"pipenv\", \"pipenv Documentation\", [author], 1)]\n\n\n# -- Options for Texinfo output -------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n# dir menu entry, description, category)\ntexinfo_documents = [\n (\n master_doc,\n \"pipenv\",\n \"pipenv Documentation\",\n author,\n \"pipenv\",\n \"One line description of project.\",\n \"Miscellaneous\",\n ),\n]\n\n\n# -- Options for Epub output ----------------------------------------------\n\n# Bibliographic Dublin Core info.\nepub_title = project\nepub_author = author\nepub_publisher = author\nepub_copyright = copyright\n\n# The unique identifier of the text. This can be a ISBN number\n# or the project homepage.\n#\n# epub_identifier = ''\n\n# A unique identification for the text.\n#\n# epub_uid = ''\n\n# A list of files that should not be packed into the epub file.\nepub_exclude_files = [\"search.html\"]\n", "path": "docs/conf.py"}]}
| 2,353 | 89 |
gh_patches_debug_32476
|
rasdani/github-patches
|
git_diff
|
freqtrade__freqtrade-3217
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
askVolume and bidVolume in VolumePairList
Hi,
I come back with the discussion with @hroff-1902 we have about askVolume and bidVolume.
If i have well understood it filtered based on the volume of the best bid/ask.
It means like if Bitcoin have a bid with 30 dollar and a shitcoin have a bid at 3000 dollar it will update the pairlist and put before in the list shitcoin vs BTC ?
Many tks.
askVolume and bidVolume in VolumePairList
Hi,
I come back with the discussion with @hroff-1902 we have about askVolume and bidVolume.
If i have well understood it filtered based on the volume of the best bid/ask.
It means like if Bitcoin have a bid with 30 dollar and a shitcoin have a bid at 3000 dollar it will update the pairlist and put before in the list shitcoin vs BTC ?
Many tks.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `freqtrade/configuration/deprecated_settings.py`
Content:
```
1 """
2 Functions to handle deprecated settings
3 """
4
5 import logging
6 from typing import Any, Dict
7
8 from freqtrade.exceptions import OperationalException
9
10
11 logger = logging.getLogger(__name__)
12
13
14 def check_conflicting_settings(config: Dict[str, Any],
15 section1: str, name1: str,
16 section2: str, name2: str) -> None:
17 section1_config = config.get(section1, {})
18 section2_config = config.get(section2, {})
19 if name1 in section1_config and name2 in section2_config:
20 raise OperationalException(
21 f"Conflicting settings `{section1}.{name1}` and `{section2}.{name2}` "
22 "(DEPRECATED) detected in the configuration file. "
23 "This deprecated setting will be removed in the next versions of Freqtrade. "
24 f"Please delete it from your configuration and use the `{section1}.{name1}` "
25 "setting instead."
26 )
27
28
29 def process_deprecated_setting(config: Dict[str, Any],
30 section1: str, name1: str,
31 section2: str, name2: str) -> None:
32 section2_config = config.get(section2, {})
33
34 if name2 in section2_config:
35 logger.warning(
36 "DEPRECATED: "
37 f"The `{section2}.{name2}` setting is deprecated and "
38 "will be removed in the next versions of Freqtrade. "
39 f"Please use the `{section1}.{name1}` setting in your configuration instead."
40 )
41 section1_config = config.get(section1, {})
42 section1_config[name1] = section2_config[name2]
43
44
45 def process_temporary_deprecated_settings(config: Dict[str, Any]) -> None:
46
47 check_conflicting_settings(config, 'ask_strategy', 'use_sell_signal',
48 'experimental', 'use_sell_signal')
49 check_conflicting_settings(config, 'ask_strategy', 'sell_profit_only',
50 'experimental', 'sell_profit_only')
51 check_conflicting_settings(config, 'ask_strategy', 'ignore_roi_if_buy_signal',
52 'experimental', 'ignore_roi_if_buy_signal')
53
54 process_deprecated_setting(config, 'ask_strategy', 'use_sell_signal',
55 'experimental', 'use_sell_signal')
56 process_deprecated_setting(config, 'ask_strategy', 'sell_profit_only',
57 'experimental', 'sell_profit_only')
58 process_deprecated_setting(config, 'ask_strategy', 'ignore_roi_if_buy_signal',
59 'experimental', 'ignore_roi_if_buy_signal')
60
61 if not config.get('pairlists') and not config.get('pairlists'):
62 config['pairlists'] = [{'method': 'StaticPairList'}]
63 logger.warning(
64 "DEPRECATED: "
65 "Pairlists must be defined explicitly in the future."
66 "Defaulting to StaticPairList for now.")
67
68 if config.get('pairlist', {}).get("method") == 'VolumePairList':
69 logger.warning(
70 "DEPRECATED: "
71 f"Using VolumePairList in pairlist is deprecated and must be moved to pairlists. "
72 "Please refer to the docs on configuration details")
73 pl = {'method': 'VolumePairList'}
74 pl.update(config.get('pairlist', {}).get('config'))
75 config['pairlists'].append(pl)
76
77 if config.get('pairlist', {}).get('config', {}).get('precision_filter'):
78 logger.warning(
79 "DEPRECATED: "
80 f"Using precision_filter setting is deprecated and has been replaced by"
81 "PrecisionFilter. Please refer to the docs on configuration details")
82 config['pairlists'].append({'method': 'PrecisionFilter'})
83
84 if (config.get('edge', {}).get('enabled', False)
85 and 'capital_available_percentage' in config.get('edge', {})):
86 logger.warning(
87 "DEPRECATED: "
88 "Using 'edge.capital_available_percentage' has been deprecated in favor of "
89 "'tradable_balance_ratio'. Please migrate your configuration to "
90 "'tradable_balance_ratio' and remove 'capital_available_percentage' "
91 "from the edge configuration."
92 )
93
```
Path: `freqtrade/pairlist/VolumePairList.py`
Content:
```
1 """
2 Volume PairList provider
3
4 Provides lists as configured in config.json
5
6 """
7 import logging
8 from datetime import datetime
9 from typing import Any, Dict, List
10
11 from freqtrade.exceptions import OperationalException
12 from freqtrade.pairlist.IPairList import IPairList
13
14 logger = logging.getLogger(__name__)
15
16 SORT_VALUES = ['askVolume', 'bidVolume', 'quoteVolume']
17
18
19 class VolumePairList(IPairList):
20
21 def __init__(self, exchange, pairlistmanager, config: Dict[str, Any], pairlistconfig: dict,
22 pairlist_pos: int) -> None:
23 super().__init__(exchange, pairlistmanager, config, pairlistconfig, pairlist_pos)
24
25 if 'number_assets' not in self._pairlistconfig:
26 raise OperationalException(
27 f'`number_assets` not specified. Please check your configuration '
28 'for "pairlist.config.number_assets"')
29 self._number_pairs = self._pairlistconfig['number_assets']
30 self._sort_key = self._pairlistconfig.get('sort_key', 'quoteVolume')
31 self._min_value = self._pairlistconfig.get('min_value', 0)
32 self.refresh_period = self._pairlistconfig.get('refresh_period', 1800)
33
34 if not self._exchange.exchange_has('fetchTickers'):
35 raise OperationalException(
36 'Exchange does not support dynamic whitelist.'
37 'Please edit your config and restart the bot'
38 )
39 if not self._validate_keys(self._sort_key):
40 raise OperationalException(
41 f'key {self._sort_key} not in {SORT_VALUES}')
42
43 @property
44 def needstickers(self) -> bool:
45 """
46 Boolean property defining if tickers are necessary.
47 If no Pairlist requries tickers, an empty List is passed
48 as tickers argument to filter_pairlist
49 """
50 return True
51
52 def _validate_keys(self, key):
53 return key in SORT_VALUES
54
55 def short_desc(self) -> str:
56 """
57 Short whitelist method description - used for startup-messages
58 """
59 return f"{self.name} - top {self._pairlistconfig['number_assets']} volume pairs."
60
61 def filter_pairlist(self, pairlist: List[str], tickers: Dict) -> List[str]:
62 """
63 Filters and sorts pairlist and returns the whitelist again.
64 Called on each bot iteration - please use internal caching if necessary
65 :param pairlist: pairlist to filter or sort
66 :param tickers: Tickers (from exchange.get_tickers()). May be cached.
67 :return: new whitelist
68 """
69 # Generate dynamic whitelist
70 # Must always run if this pairlist is not the first in the list.
71 if (self._pairlist_pos != 0 or
72 (self._last_refresh + self.refresh_period < datetime.now().timestamp())):
73
74 self._last_refresh = int(datetime.now().timestamp())
75 pairs = self._gen_pair_whitelist(pairlist, tickers,
76 self._config['stake_currency'],
77 self._sort_key, self._min_value)
78 else:
79 pairs = pairlist
80 self.log_on_refresh(logger.info, f"Searching {self._number_pairs} pairs: {pairs}")
81 return pairs
82
83 def _gen_pair_whitelist(self, pairlist: List[str], tickers: Dict,
84 base_currency: str, key: str, min_val: int) -> List[str]:
85 """
86 Updates the whitelist with with a dynamically generated list
87 :param base_currency: base currency as str
88 :param key: sort key (defaults to 'quoteVolume')
89 :param tickers: Tickers (from exchange.get_tickers()).
90 :return: List of pairs
91 """
92 if self._pairlist_pos == 0:
93 # If VolumePairList is the first in the list, use fresh pairlist
94 # Check if pair quote currency equals to the stake currency.
95 filtered_tickers = [v for k, v in tickers.items()
96 if (self._exchange.get_pair_quote_currency(k) == base_currency
97 and v[key] is not None)]
98 else:
99 # If other pairlist is in front, use the incomming pairlist.
100 filtered_tickers = [v for k, v in tickers.items() if k in pairlist]
101
102 if min_val > 0:
103 filtered_tickers = list(filter(lambda t: t[key] > min_val, filtered_tickers))
104
105 sorted_tickers = sorted(filtered_tickers, reverse=True, key=lambda t: t[key])
106
107 # Validate whitelist to only have active market pairs
108 pairs = self._whitelist_for_active_markets([s['symbol'] for s in sorted_tickers])
109 pairs = self._verify_blacklist(pairs, aswarning=False)
110 # Limit to X number of pairs
111 pairs = pairs[:self._number_pairs]
112
113 return pairs
114
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/freqtrade/configuration/deprecated_settings.py b/freqtrade/configuration/deprecated_settings.py
--- a/freqtrade/configuration/deprecated_settings.py
+++ b/freqtrade/configuration/deprecated_settings.py
@@ -58,29 +58,6 @@
process_deprecated_setting(config, 'ask_strategy', 'ignore_roi_if_buy_signal',
'experimental', 'ignore_roi_if_buy_signal')
- if not config.get('pairlists') and not config.get('pairlists'):
- config['pairlists'] = [{'method': 'StaticPairList'}]
- logger.warning(
- "DEPRECATED: "
- "Pairlists must be defined explicitly in the future."
- "Defaulting to StaticPairList for now.")
-
- if config.get('pairlist', {}).get("method") == 'VolumePairList':
- logger.warning(
- "DEPRECATED: "
- f"Using VolumePairList in pairlist is deprecated and must be moved to pairlists. "
- "Please refer to the docs on configuration details")
- pl = {'method': 'VolumePairList'}
- pl.update(config.get('pairlist', {}).get('config'))
- config['pairlists'].append(pl)
-
- if config.get('pairlist', {}).get('config', {}).get('precision_filter'):
- logger.warning(
- "DEPRECATED: "
- f"Using precision_filter setting is deprecated and has been replaced by"
- "PrecisionFilter. Please refer to the docs on configuration details")
- config['pairlists'].append({'method': 'PrecisionFilter'})
-
if (config.get('edge', {}).get('enabled', False)
and 'capital_available_percentage' in config.get('edge', {})):
logger.warning(
diff --git a/freqtrade/pairlist/VolumePairList.py b/freqtrade/pairlist/VolumePairList.py
--- a/freqtrade/pairlist/VolumePairList.py
+++ b/freqtrade/pairlist/VolumePairList.py
@@ -39,6 +39,10 @@
if not self._validate_keys(self._sort_key):
raise OperationalException(
f'key {self._sort_key} not in {SORT_VALUES}')
+ if self._sort_key != 'quoteVolume':
+ logger.warning(
+ "DEPRECATED: using any key other than quoteVolume for VolumePairList is deprecated."
+ )
@property
def needstickers(self) -> bool:
|
{"golden_diff": "diff --git a/freqtrade/configuration/deprecated_settings.py b/freqtrade/configuration/deprecated_settings.py\n--- a/freqtrade/configuration/deprecated_settings.py\n+++ b/freqtrade/configuration/deprecated_settings.py\n@@ -58,29 +58,6 @@\n process_deprecated_setting(config, 'ask_strategy', 'ignore_roi_if_buy_signal',\n 'experimental', 'ignore_roi_if_buy_signal')\n \n- if not config.get('pairlists') and not config.get('pairlists'):\n- config['pairlists'] = [{'method': 'StaticPairList'}]\n- logger.warning(\n- \"DEPRECATED: \"\n- \"Pairlists must be defined explicitly in the future.\"\n- \"Defaulting to StaticPairList for now.\")\n-\n- if config.get('pairlist', {}).get(\"method\") == 'VolumePairList':\n- logger.warning(\n- \"DEPRECATED: \"\n- f\"Using VolumePairList in pairlist is deprecated and must be moved to pairlists. \"\n- \"Please refer to the docs on configuration details\")\n- pl = {'method': 'VolumePairList'}\n- pl.update(config.get('pairlist', {}).get('config'))\n- config['pairlists'].append(pl)\n-\n- if config.get('pairlist', {}).get('config', {}).get('precision_filter'):\n- logger.warning(\n- \"DEPRECATED: \"\n- f\"Using precision_filter setting is deprecated and has been replaced by\"\n- \"PrecisionFilter. Please refer to the docs on configuration details\")\n- config['pairlists'].append({'method': 'PrecisionFilter'})\n-\n if (config.get('edge', {}).get('enabled', False)\n and 'capital_available_percentage' in config.get('edge', {})):\n logger.warning(\ndiff --git a/freqtrade/pairlist/VolumePairList.py b/freqtrade/pairlist/VolumePairList.py\n--- a/freqtrade/pairlist/VolumePairList.py\n+++ b/freqtrade/pairlist/VolumePairList.py\n@@ -39,6 +39,10 @@\n if not self._validate_keys(self._sort_key):\n raise OperationalException(\n f'key {self._sort_key} not in {SORT_VALUES}')\n+ if self._sort_key != 'quoteVolume':\n+ logger.warning(\n+ \"DEPRECATED: using any key other than quoteVolume for VolumePairList is deprecated.\"\n+ )\n \n @property\n def needstickers(self) -> bool:\n", "issue": "askVolume and bidVolume in VolumePairList\nHi,\r\n\r\nI come back with the discussion with @hroff-1902 we have about askVolume and bidVolume.\r\nIf i have well understood it filtered based on the volume of the best bid/ask.\r\n\r\nIt means like if Bitcoin have a bid with 30 dollar and a shitcoin have a bid at 3000 dollar it will update the pairlist and put before in the list shitcoin vs BTC ?\r\n\r\nMany tks.\naskVolume and bidVolume in VolumePairList\nHi,\r\n\r\nI come back with the discussion with @hroff-1902 we have about askVolume and bidVolume.\r\nIf i have well understood it filtered based on the volume of the best bid/ask.\r\n\r\nIt means like if Bitcoin have a bid with 30 dollar and a shitcoin have a bid at 3000 dollar it will update the pairlist and put before in the list shitcoin vs BTC ?\r\n\r\nMany tks.\n", "before_files": [{"content": "\"\"\"\nFunctions to handle deprecated settings\n\"\"\"\n\nimport logging\nfrom typing import Any, Dict\n\nfrom freqtrade.exceptions import OperationalException\n\n\nlogger = logging.getLogger(__name__)\n\n\ndef check_conflicting_settings(config: Dict[str, Any],\n section1: str, name1: str,\n section2: str, name2: str) -> None:\n section1_config = config.get(section1, {})\n section2_config = config.get(section2, {})\n if name1 in section1_config and name2 in section2_config:\n raise OperationalException(\n f\"Conflicting settings `{section1}.{name1}` and `{section2}.{name2}` \"\n \"(DEPRECATED) detected in the configuration file. \"\n \"This deprecated setting will be removed in the next versions of Freqtrade. \"\n f\"Please delete it from your configuration and use the `{section1}.{name1}` \"\n \"setting instead.\"\n )\n\n\ndef process_deprecated_setting(config: Dict[str, Any],\n section1: str, name1: str,\n section2: str, name2: str) -> None:\n section2_config = config.get(section2, {})\n\n if name2 in section2_config:\n logger.warning(\n \"DEPRECATED: \"\n f\"The `{section2}.{name2}` setting is deprecated and \"\n \"will be removed in the next versions of Freqtrade. \"\n f\"Please use the `{section1}.{name1}` setting in your configuration instead.\"\n )\n section1_config = config.get(section1, {})\n section1_config[name1] = section2_config[name2]\n\n\ndef process_temporary_deprecated_settings(config: Dict[str, Any]) -> None:\n\n check_conflicting_settings(config, 'ask_strategy', 'use_sell_signal',\n 'experimental', 'use_sell_signal')\n check_conflicting_settings(config, 'ask_strategy', 'sell_profit_only',\n 'experimental', 'sell_profit_only')\n check_conflicting_settings(config, 'ask_strategy', 'ignore_roi_if_buy_signal',\n 'experimental', 'ignore_roi_if_buy_signal')\n\n process_deprecated_setting(config, 'ask_strategy', 'use_sell_signal',\n 'experimental', 'use_sell_signal')\n process_deprecated_setting(config, 'ask_strategy', 'sell_profit_only',\n 'experimental', 'sell_profit_only')\n process_deprecated_setting(config, 'ask_strategy', 'ignore_roi_if_buy_signal',\n 'experimental', 'ignore_roi_if_buy_signal')\n\n if not config.get('pairlists') and not config.get('pairlists'):\n config['pairlists'] = [{'method': 'StaticPairList'}]\n logger.warning(\n \"DEPRECATED: \"\n \"Pairlists must be defined explicitly in the future.\"\n \"Defaulting to StaticPairList for now.\")\n\n if config.get('pairlist', {}).get(\"method\") == 'VolumePairList':\n logger.warning(\n \"DEPRECATED: \"\n f\"Using VolumePairList in pairlist is deprecated and must be moved to pairlists. \"\n \"Please refer to the docs on configuration details\")\n pl = {'method': 'VolumePairList'}\n pl.update(config.get('pairlist', {}).get('config'))\n config['pairlists'].append(pl)\n\n if config.get('pairlist', {}).get('config', {}).get('precision_filter'):\n logger.warning(\n \"DEPRECATED: \"\n f\"Using precision_filter setting is deprecated and has been replaced by\"\n \"PrecisionFilter. Please refer to the docs on configuration details\")\n config['pairlists'].append({'method': 'PrecisionFilter'})\n\n if (config.get('edge', {}).get('enabled', False)\n and 'capital_available_percentage' in config.get('edge', {})):\n logger.warning(\n \"DEPRECATED: \"\n \"Using 'edge.capital_available_percentage' has been deprecated in favor of \"\n \"'tradable_balance_ratio'. Please migrate your configuration to \"\n \"'tradable_balance_ratio' and remove 'capital_available_percentage' \"\n \"from the edge configuration.\"\n )\n", "path": "freqtrade/configuration/deprecated_settings.py"}, {"content": "\"\"\"\nVolume PairList provider\n\nProvides lists as configured in config.json\n\n \"\"\"\nimport logging\nfrom datetime import datetime\nfrom typing import Any, Dict, List\n\nfrom freqtrade.exceptions import OperationalException\nfrom freqtrade.pairlist.IPairList import IPairList\n\nlogger = logging.getLogger(__name__)\n\nSORT_VALUES = ['askVolume', 'bidVolume', 'quoteVolume']\n\n\nclass VolumePairList(IPairList):\n\n def __init__(self, exchange, pairlistmanager, config: Dict[str, Any], pairlistconfig: dict,\n pairlist_pos: int) -> None:\n super().__init__(exchange, pairlistmanager, config, pairlistconfig, pairlist_pos)\n\n if 'number_assets' not in self._pairlistconfig:\n raise OperationalException(\n f'`number_assets` not specified. Please check your configuration '\n 'for \"pairlist.config.number_assets\"')\n self._number_pairs = self._pairlistconfig['number_assets']\n self._sort_key = self._pairlistconfig.get('sort_key', 'quoteVolume')\n self._min_value = self._pairlistconfig.get('min_value', 0)\n self.refresh_period = self._pairlistconfig.get('refresh_period', 1800)\n\n if not self._exchange.exchange_has('fetchTickers'):\n raise OperationalException(\n 'Exchange does not support dynamic whitelist.'\n 'Please edit your config and restart the bot'\n )\n if not self._validate_keys(self._sort_key):\n raise OperationalException(\n f'key {self._sort_key} not in {SORT_VALUES}')\n\n @property\n def needstickers(self) -> bool:\n \"\"\"\n Boolean property defining if tickers are necessary.\n If no Pairlist requries tickers, an empty List is passed\n as tickers argument to filter_pairlist\n \"\"\"\n return True\n\n def _validate_keys(self, key):\n return key in SORT_VALUES\n\n def short_desc(self) -> str:\n \"\"\"\n Short whitelist method description - used for startup-messages\n \"\"\"\n return f\"{self.name} - top {self._pairlistconfig['number_assets']} volume pairs.\"\n\n def filter_pairlist(self, pairlist: List[str], tickers: Dict) -> List[str]:\n \"\"\"\n Filters and sorts pairlist and returns the whitelist again.\n Called on each bot iteration - please use internal caching if necessary\n :param pairlist: pairlist to filter or sort\n :param tickers: Tickers (from exchange.get_tickers()). May be cached.\n :return: new whitelist\n \"\"\"\n # Generate dynamic whitelist\n # Must always run if this pairlist is not the first in the list.\n if (self._pairlist_pos != 0 or\n (self._last_refresh + self.refresh_period < datetime.now().timestamp())):\n\n self._last_refresh = int(datetime.now().timestamp())\n pairs = self._gen_pair_whitelist(pairlist, tickers,\n self._config['stake_currency'],\n self._sort_key, self._min_value)\n else:\n pairs = pairlist\n self.log_on_refresh(logger.info, f\"Searching {self._number_pairs} pairs: {pairs}\")\n return pairs\n\n def _gen_pair_whitelist(self, pairlist: List[str], tickers: Dict,\n base_currency: str, key: str, min_val: int) -> List[str]:\n \"\"\"\n Updates the whitelist with with a dynamically generated list\n :param base_currency: base currency as str\n :param key: sort key (defaults to 'quoteVolume')\n :param tickers: Tickers (from exchange.get_tickers()).\n :return: List of pairs\n \"\"\"\n if self._pairlist_pos == 0:\n # If VolumePairList is the first in the list, use fresh pairlist\n # Check if pair quote currency equals to the stake currency.\n filtered_tickers = [v for k, v in tickers.items()\n if (self._exchange.get_pair_quote_currency(k) == base_currency\n and v[key] is not None)]\n else:\n # If other pairlist is in front, use the incomming pairlist.\n filtered_tickers = [v for k, v in tickers.items() if k in pairlist]\n\n if min_val > 0:\n filtered_tickers = list(filter(lambda t: t[key] > min_val, filtered_tickers))\n\n sorted_tickers = sorted(filtered_tickers, reverse=True, key=lambda t: t[key])\n\n # Validate whitelist to only have active market pairs\n pairs = self._whitelist_for_active_markets([s['symbol'] for s in sorted_tickers])\n pairs = self._verify_blacklist(pairs, aswarning=False)\n # Limit to X number of pairs\n pairs = pairs[:self._number_pairs]\n\n return pairs\n", "path": "freqtrade/pairlist/VolumePairList.py"}], "after_files": [{"content": "\"\"\"\nFunctions to handle deprecated settings\n\"\"\"\n\nimport logging\nfrom typing import Any, Dict\n\nfrom freqtrade.exceptions import OperationalException\n\n\nlogger = logging.getLogger(__name__)\n\n\ndef check_conflicting_settings(config: Dict[str, Any],\n section1: str, name1: str,\n section2: str, name2: str) -> None:\n section1_config = config.get(section1, {})\n section2_config = config.get(section2, {})\n if name1 in section1_config and name2 in section2_config:\n raise OperationalException(\n f\"Conflicting settings `{section1}.{name1}` and `{section2}.{name2}` \"\n \"(DEPRECATED) detected in the configuration file. \"\n \"This deprecated setting will be removed in the next versions of Freqtrade. \"\n f\"Please delete it from your configuration and use the `{section1}.{name1}` \"\n \"setting instead.\"\n )\n\n\ndef process_deprecated_setting(config: Dict[str, Any],\n section1: str, name1: str,\n section2: str, name2: str) -> None:\n section2_config = config.get(section2, {})\n\n if name2 in section2_config:\n logger.warning(\n \"DEPRECATED: \"\n f\"The `{section2}.{name2}` setting is deprecated and \"\n \"will be removed in the next versions of Freqtrade. \"\n f\"Please use the `{section1}.{name1}` setting in your configuration instead.\"\n )\n section1_config = config.get(section1, {})\n section1_config[name1] = section2_config[name2]\n\n\ndef process_temporary_deprecated_settings(config: Dict[str, Any]) -> None:\n\n check_conflicting_settings(config, 'ask_strategy', 'use_sell_signal',\n 'experimental', 'use_sell_signal')\n check_conflicting_settings(config, 'ask_strategy', 'sell_profit_only',\n 'experimental', 'sell_profit_only')\n check_conflicting_settings(config, 'ask_strategy', 'ignore_roi_if_buy_signal',\n 'experimental', 'ignore_roi_if_buy_signal')\n\n process_deprecated_setting(config, 'ask_strategy', 'use_sell_signal',\n 'experimental', 'use_sell_signal')\n process_deprecated_setting(config, 'ask_strategy', 'sell_profit_only',\n 'experimental', 'sell_profit_only')\n process_deprecated_setting(config, 'ask_strategy', 'ignore_roi_if_buy_signal',\n 'experimental', 'ignore_roi_if_buy_signal')\n\n if (config.get('edge', {}).get('enabled', False)\n and 'capital_available_percentage' in config.get('edge', {})):\n logger.warning(\n \"DEPRECATED: \"\n \"Using 'edge.capital_available_percentage' has been deprecated in favor of \"\n \"'tradable_balance_ratio'. Please migrate your configuration to \"\n \"'tradable_balance_ratio' and remove 'capital_available_percentage' \"\n \"from the edge configuration.\"\n )\n", "path": "freqtrade/configuration/deprecated_settings.py"}, {"content": "\"\"\"\nVolume PairList provider\n\nProvides lists as configured in config.json\n\n \"\"\"\nimport logging\nfrom datetime import datetime\nfrom typing import Any, Dict, List\n\nfrom freqtrade.exceptions import OperationalException\nfrom freqtrade.pairlist.IPairList import IPairList\n\nlogger = logging.getLogger(__name__)\n\nSORT_VALUES = ['askVolume', 'bidVolume', 'quoteVolume']\n\n\nclass VolumePairList(IPairList):\n\n def __init__(self, exchange, pairlistmanager, config: Dict[str, Any], pairlistconfig: dict,\n pairlist_pos: int) -> None:\n super().__init__(exchange, pairlistmanager, config, pairlistconfig, pairlist_pos)\n\n if 'number_assets' not in self._pairlistconfig:\n raise OperationalException(\n f'`number_assets` not specified. Please check your configuration '\n 'for \"pairlist.config.number_assets\"')\n self._number_pairs = self._pairlistconfig['number_assets']\n self._sort_key = self._pairlistconfig.get('sort_key', 'quoteVolume')\n self._min_value = self._pairlistconfig.get('min_value', 0)\n self.refresh_period = self._pairlistconfig.get('refresh_period', 1800)\n\n if not self._exchange.exchange_has('fetchTickers'):\n raise OperationalException(\n 'Exchange does not support dynamic whitelist.'\n 'Please edit your config and restart the bot'\n )\n if not self._validate_keys(self._sort_key):\n raise OperationalException(\n f'key {self._sort_key} not in {SORT_VALUES}')\n if self._sort_key != 'quoteVolume':\n logger.warning(\n \"DEPRECATED: using any key other than quoteVolume for VolumePairList is deprecated.\"\n )\n\n @property\n def needstickers(self) -> bool:\n \"\"\"\n Boolean property defining if tickers are necessary.\n If no Pairlist requries tickers, an empty List is passed\n as tickers argument to filter_pairlist\n \"\"\"\n return True\n\n def _validate_keys(self, key):\n return key in SORT_VALUES\n\n def short_desc(self) -> str:\n \"\"\"\n Short whitelist method description - used for startup-messages\n \"\"\"\n return f\"{self.name} - top {self._pairlistconfig['number_assets']} volume pairs.\"\n\n def filter_pairlist(self, pairlist: List[str], tickers: Dict) -> List[str]:\n \"\"\"\n Filters and sorts pairlist and returns the whitelist again.\n Called on each bot iteration - please use internal caching if necessary\n :param pairlist: pairlist to filter or sort\n :param tickers: Tickers (from exchange.get_tickers()). May be cached.\n :return: new whitelist\n \"\"\"\n # Generate dynamic whitelist\n # Must always run if this pairlist is not the first in the list.\n if (self._pairlist_pos != 0 or\n (self._last_refresh + self.refresh_period < datetime.now().timestamp())):\n\n self._last_refresh = int(datetime.now().timestamp())\n pairs = self._gen_pair_whitelist(pairlist, tickers,\n self._config['stake_currency'],\n self._sort_key, self._min_value)\n else:\n pairs = pairlist\n self.log_on_refresh(logger.info, f\"Searching {self._number_pairs} pairs: {pairs}\")\n return pairs\n\n def _gen_pair_whitelist(self, pairlist: List[str], tickers: Dict,\n base_currency: str, key: str, min_val: int) -> List[str]:\n \"\"\"\n Updates the whitelist with with a dynamically generated list\n :param base_currency: base currency as str\n :param key: sort key (defaults to 'quoteVolume')\n :param tickers: Tickers (from exchange.get_tickers()).\n :return: List of pairs\n \"\"\"\n if self._pairlist_pos == 0:\n # If VolumePairList is the first in the list, use fresh pairlist\n # Check if pair quote currency equals to the stake currency.\n filtered_tickers = [v for k, v in tickers.items()\n if (self._exchange.get_pair_quote_currency(k) == base_currency\n and v[key] is not None)]\n else:\n # If other pairlist is in front, use the incomming pairlist.\n filtered_tickers = [v for k, v in tickers.items() if k in pairlist]\n\n if min_val > 0:\n filtered_tickers = list(filter(lambda t: t[key] > min_val, filtered_tickers))\n\n sorted_tickers = sorted(filtered_tickers, reverse=True, key=lambda t: t[key])\n\n # Validate whitelist to only have active market pairs\n pairs = self._whitelist_for_active_markets([s['symbol'] for s in sorted_tickers])\n pairs = self._verify_blacklist(pairs, aswarning=False)\n # Limit to X number of pairs\n pairs = pairs[:self._number_pairs]\n\n return pairs\n", "path": "freqtrade/pairlist/VolumePairList.py"}]}
| 2,807 | 534 |
gh_patches_debug_34327
|
rasdani/github-patches
|
git_diff
|
translate__pootle-6695
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Use XHR for user select2 widgets
on a site with a lot of users the admin widgets are very slow and unnecessarily push a full list of users
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `pootle/apps/pootle_app/views/admin/permissions.py`
Content:
```
1 # -*- coding: utf-8 -*-
2 #
3 # Copyright (C) Pootle contributors.
4 #
5 # This file is a part of the Pootle project. It is distributed under the GPL3
6 # or later license. See the LICENSE file for a copy of the license and the
7 # AUTHORS file for copyright and authorship information.
8
9 from django import forms
10 from django.contrib.auth import get_user_model
11
12 from pootle.core.decorators import get_object_or_404
13 from pootle.core.exceptions import Http400
14 from pootle.core.views.admin import PootleAdminFormView
15 from pootle.core.views.mixins import PootleJSONMixin
16 from pootle.i18n.gettext import ugettext as _
17 from pootle_app.forms import PermissionsUsersSearchForm
18 from pootle_app.models import Directory
19 from pootle_app.models.permissions import (PermissionSet,
20 get_permission_contenttype)
21 from pootle_app.views.admin import util
22 from pootle_misc.forms import GroupedModelChoiceField
23
24
25 User = get_user_model()
26
27 PERMISSIONS = {
28 'positive': ['view', 'suggest', 'translate', 'review', 'administrate'],
29 'negative': ['hide'],
30 }
31
32
33 class PermissionFormField(forms.ModelMultipleChoiceField):
34
35 def label_from_instance(self, instance):
36 return _(instance.name)
37
38
39 def admin_permissions(request, current_directory, template, ctx):
40 language = ctx.get('language', None)
41
42 negative_permissions_excl = list(PERMISSIONS['negative'])
43 positive_permissions_excl = list(PERMISSIONS['positive'])
44
45 # Don't provide means to alter access permissions under /<lang_code>/*
46 # In other words: only allow setting access permissions for the root
47 # and the `/projects/<code>/` directories
48 if language is not None:
49 access_permissions = ['view', 'hide']
50 negative_permissions_excl.extend(access_permissions)
51 positive_permissions_excl.extend(access_permissions)
52
53 content_type = get_permission_contenttype()
54
55 positive_permissions_qs = content_type.permission_set.exclude(
56 codename__in=negative_permissions_excl,
57 )
58 negative_permissions_qs = content_type.permission_set.exclude(
59 codename__in=positive_permissions_excl,
60 )
61
62 base_queryset = User.objects.filter(is_active=1).exclude(
63 id__in=current_directory.permission_sets.values_list('user_id',
64 flat=True),)
65 choice_groups = [(None, base_queryset.filter(
66 username__in=('nobody', 'default')
67 ))]
68
69 choice_groups.append((
70 _('All Users'),
71 base_queryset.exclude(username__in=('nobody',
72 'default')).order_by('username'),
73 ))
74
75 class PermissionSetForm(forms.ModelForm):
76
77 class Meta(object):
78 model = PermissionSet
79 fields = ('user', 'directory', 'positive_permissions',
80 'negative_permissions')
81
82 directory = forms.ModelChoiceField(
83 queryset=Directory.objects.filter(pk=current_directory.pk),
84 initial=current_directory.pk,
85 widget=forms.HiddenInput,
86 )
87 user = GroupedModelChoiceField(
88 label=_('Username'),
89 choice_groups=choice_groups,
90 queryset=User.objects.all(),
91 required=True,
92 widget=forms.Select(attrs={
93 'class': 'js-select2 select2-username',
94 }),
95 )
96 positive_permissions = PermissionFormField(
97 label=_('Add Permissions'),
98 queryset=positive_permissions_qs,
99 required=False,
100 widget=forms.SelectMultiple(attrs={
101 'class': 'js-select2 select2-multiple',
102 'data-placeholder': _('Select one or more permissions'),
103 }),
104 )
105 negative_permissions = PermissionFormField(
106 label=_('Revoke Permissions'),
107 queryset=negative_permissions_qs,
108 required=False,
109 widget=forms.SelectMultiple(attrs={
110 'class': 'js-select2 select2-multiple',
111 'data-placeholder': _('Select one or more permissions'),
112 }),
113 )
114
115 def __init__(self, *args, **kwargs):
116 super(PermissionSetForm, self).__init__(*args, **kwargs)
117
118 # Don't display extra negative permissions field where they
119 # are not applicable
120 if language is not None:
121 del self.fields['negative_permissions']
122
123 link = lambda instance: unicode(instance.user)
124 directory_permissions = current_directory.permission_sets \
125 .order_by('user').all()
126
127 return util.edit(request, template, PermissionSet, ctx, link,
128 linkfield='user', queryset=directory_permissions,
129 can_delete=True, form=PermissionSetForm)
130
131
132 class PermissionsUsersJSON(PootleJSONMixin, PootleAdminFormView):
133 form_class = PermissionsUsersSearchForm
134
135 @property
136 def directory(self):
137 return get_object_or_404(
138 Directory.objects,
139 pk=self.kwargs["directory"])
140
141 def get_context_data(self, **kwargs):
142 context = super(
143 PermissionsUsersJSON, self).get_context_data(**kwargs)
144 form = context["form"]
145 return (
146 dict(items=form.search())
147 if form.is_valid()
148 else dict(items=[]))
149
150 def get_form_kwargs(self):
151 kwargs = super(PermissionsUsersJSON, self).get_form_kwargs()
152 kwargs["directory"] = self.directory
153 return kwargs
154
155 def form_valid(self, form):
156 return self.render_to_response(
157 self.get_context_data(form=form))
158
159 def form_invalid(self, form):
160 raise Http400(form.errors)
161
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/pootle/apps/pootle_app/views/admin/permissions.py b/pootle/apps/pootle_app/views/admin/permissions.py
--- a/pootle/apps/pootle_app/views/admin/permissions.py
+++ b/pootle/apps/pootle_app/views/admin/permissions.py
@@ -8,11 +8,13 @@
from django import forms
from django.contrib.auth import get_user_model
+from django.urls import reverse
from pootle.core.decorators import get_object_or_404
from pootle.core.exceptions import Http400
from pootle.core.views.admin import PootleAdminFormView
from pootle.core.views.mixins import PootleJSONMixin
+from pootle.core.views.widgets import RemoteSelectWidget
from pootle.i18n.gettext import ugettext as _
from pootle_app.forms import PermissionsUsersSearchForm
from pootle_app.models import Directory
@@ -89,10 +91,11 @@
choice_groups=choice_groups,
queryset=User.objects.all(),
required=True,
- widget=forms.Select(attrs={
- 'class': 'js-select2 select2-username',
- }),
- )
+ widget=RemoteSelectWidget(
+ attrs={
+ "data-s2-placeholder": _("Search for users to add"),
+ 'class': ('js-select2-remote select2-username '
+ 'js-s2-new-members')}))
positive_permissions = PermissionFormField(
label=_('Add Permissions'),
queryset=positive_permissions_qs,
@@ -115,6 +118,10 @@
def __init__(self, *args, **kwargs):
super(PermissionSetForm, self).__init__(*args, **kwargs)
+ self.fields["user"].widget.attrs["data-select2-url"] = reverse(
+ "pootle-permissions-users",
+ kwargs=dict(directory=current_directory.pk))
+
# Don't display extra negative permissions field where they
# are not applicable
if language is not None:
|
{"golden_diff": "diff --git a/pootle/apps/pootle_app/views/admin/permissions.py b/pootle/apps/pootle_app/views/admin/permissions.py\n--- a/pootle/apps/pootle_app/views/admin/permissions.py\n+++ b/pootle/apps/pootle_app/views/admin/permissions.py\n@@ -8,11 +8,13 @@\n \n from django import forms\n from django.contrib.auth import get_user_model\n+from django.urls import reverse\n \n from pootle.core.decorators import get_object_or_404\n from pootle.core.exceptions import Http400\n from pootle.core.views.admin import PootleAdminFormView\n from pootle.core.views.mixins import PootleJSONMixin\n+from pootle.core.views.widgets import RemoteSelectWidget\n from pootle.i18n.gettext import ugettext as _\n from pootle_app.forms import PermissionsUsersSearchForm\n from pootle_app.models import Directory\n@@ -89,10 +91,11 @@\n choice_groups=choice_groups,\n queryset=User.objects.all(),\n required=True,\n- widget=forms.Select(attrs={\n- 'class': 'js-select2 select2-username',\n- }),\n- )\n+ widget=RemoteSelectWidget(\n+ attrs={\n+ \"data-s2-placeholder\": _(\"Search for users to add\"),\n+ 'class': ('js-select2-remote select2-username '\n+ 'js-s2-new-members')}))\n positive_permissions = PermissionFormField(\n label=_('Add Permissions'),\n queryset=positive_permissions_qs,\n@@ -115,6 +118,10 @@\n def __init__(self, *args, **kwargs):\n super(PermissionSetForm, self).__init__(*args, **kwargs)\n \n+ self.fields[\"user\"].widget.attrs[\"data-select2-url\"] = reverse(\n+ \"pootle-permissions-users\",\n+ kwargs=dict(directory=current_directory.pk))\n+\n # Don't display extra negative permissions field where they\n # are not applicable\n if language is not None:\n", "issue": "Use XHR for user select2 widgets\non a site with a lot of users the admin widgets are very slow and unnecessarily push a full list of users\n\n", "before_files": [{"content": "# -*- coding: utf-8 -*-\n#\n# Copyright (C) Pootle contributors.\n#\n# This file is a part of the Pootle project. It is distributed under the GPL3\n# or later license. See the LICENSE file for a copy of the license and the\n# AUTHORS file for copyright and authorship information.\n\nfrom django import forms\nfrom django.contrib.auth import get_user_model\n\nfrom pootle.core.decorators import get_object_or_404\nfrom pootle.core.exceptions import Http400\nfrom pootle.core.views.admin import PootleAdminFormView\nfrom pootle.core.views.mixins import PootleJSONMixin\nfrom pootle.i18n.gettext import ugettext as _\nfrom pootle_app.forms import PermissionsUsersSearchForm\nfrom pootle_app.models import Directory\nfrom pootle_app.models.permissions import (PermissionSet,\n get_permission_contenttype)\nfrom pootle_app.views.admin import util\nfrom pootle_misc.forms import GroupedModelChoiceField\n\n\nUser = get_user_model()\n\nPERMISSIONS = {\n 'positive': ['view', 'suggest', 'translate', 'review', 'administrate'],\n 'negative': ['hide'],\n}\n\n\nclass PermissionFormField(forms.ModelMultipleChoiceField):\n\n def label_from_instance(self, instance):\n return _(instance.name)\n\n\ndef admin_permissions(request, current_directory, template, ctx):\n language = ctx.get('language', None)\n\n negative_permissions_excl = list(PERMISSIONS['negative'])\n positive_permissions_excl = list(PERMISSIONS['positive'])\n\n # Don't provide means to alter access permissions under /<lang_code>/*\n # In other words: only allow setting access permissions for the root\n # and the `/projects/<code>/` directories\n if language is not None:\n access_permissions = ['view', 'hide']\n negative_permissions_excl.extend(access_permissions)\n positive_permissions_excl.extend(access_permissions)\n\n content_type = get_permission_contenttype()\n\n positive_permissions_qs = content_type.permission_set.exclude(\n codename__in=negative_permissions_excl,\n )\n negative_permissions_qs = content_type.permission_set.exclude(\n codename__in=positive_permissions_excl,\n )\n\n base_queryset = User.objects.filter(is_active=1).exclude(\n id__in=current_directory.permission_sets.values_list('user_id',\n flat=True),)\n choice_groups = [(None, base_queryset.filter(\n username__in=('nobody', 'default')\n ))]\n\n choice_groups.append((\n _('All Users'),\n base_queryset.exclude(username__in=('nobody',\n 'default')).order_by('username'),\n ))\n\n class PermissionSetForm(forms.ModelForm):\n\n class Meta(object):\n model = PermissionSet\n fields = ('user', 'directory', 'positive_permissions',\n 'negative_permissions')\n\n directory = forms.ModelChoiceField(\n queryset=Directory.objects.filter(pk=current_directory.pk),\n initial=current_directory.pk,\n widget=forms.HiddenInput,\n )\n user = GroupedModelChoiceField(\n label=_('Username'),\n choice_groups=choice_groups,\n queryset=User.objects.all(),\n required=True,\n widget=forms.Select(attrs={\n 'class': 'js-select2 select2-username',\n }),\n )\n positive_permissions = PermissionFormField(\n label=_('Add Permissions'),\n queryset=positive_permissions_qs,\n required=False,\n widget=forms.SelectMultiple(attrs={\n 'class': 'js-select2 select2-multiple',\n 'data-placeholder': _('Select one or more permissions'),\n }),\n )\n negative_permissions = PermissionFormField(\n label=_('Revoke Permissions'),\n queryset=negative_permissions_qs,\n required=False,\n widget=forms.SelectMultiple(attrs={\n 'class': 'js-select2 select2-multiple',\n 'data-placeholder': _('Select one or more permissions'),\n }),\n )\n\n def __init__(self, *args, **kwargs):\n super(PermissionSetForm, self).__init__(*args, **kwargs)\n\n # Don't display extra negative permissions field where they\n # are not applicable\n if language is not None:\n del self.fields['negative_permissions']\n\n link = lambda instance: unicode(instance.user)\n directory_permissions = current_directory.permission_sets \\\n .order_by('user').all()\n\n return util.edit(request, template, PermissionSet, ctx, link,\n linkfield='user', queryset=directory_permissions,\n can_delete=True, form=PermissionSetForm)\n\n\nclass PermissionsUsersJSON(PootleJSONMixin, PootleAdminFormView):\n form_class = PermissionsUsersSearchForm\n\n @property\n def directory(self):\n return get_object_or_404(\n Directory.objects,\n pk=self.kwargs[\"directory\"])\n\n def get_context_data(self, **kwargs):\n context = super(\n PermissionsUsersJSON, self).get_context_data(**kwargs)\n form = context[\"form\"]\n return (\n dict(items=form.search())\n if form.is_valid()\n else dict(items=[]))\n\n def get_form_kwargs(self):\n kwargs = super(PermissionsUsersJSON, self).get_form_kwargs()\n kwargs[\"directory\"] = self.directory\n return kwargs\n\n def form_valid(self, form):\n return self.render_to_response(\n self.get_context_data(form=form))\n\n def form_invalid(self, form):\n raise Http400(form.errors)\n", "path": "pootle/apps/pootle_app/views/admin/permissions.py"}], "after_files": [{"content": "# -*- coding: utf-8 -*-\n#\n# Copyright (C) Pootle contributors.\n#\n# This file is a part of the Pootle project. It is distributed under the GPL3\n# or later license. See the LICENSE file for a copy of the license and the\n# AUTHORS file for copyright and authorship information.\n\nfrom django import forms\nfrom django.contrib.auth import get_user_model\nfrom django.urls import reverse\n\nfrom pootle.core.decorators import get_object_or_404\nfrom pootle.core.exceptions import Http400\nfrom pootle.core.views.admin import PootleAdminFormView\nfrom pootle.core.views.mixins import PootleJSONMixin\nfrom pootle.core.views.widgets import RemoteSelectWidget\nfrom pootle.i18n.gettext import ugettext as _\nfrom pootle_app.forms import PermissionsUsersSearchForm\nfrom pootle_app.models import Directory\nfrom pootle_app.models.permissions import (PermissionSet,\n get_permission_contenttype)\nfrom pootle_app.views.admin import util\nfrom pootle_misc.forms import GroupedModelChoiceField\n\n\nUser = get_user_model()\n\nPERMISSIONS = {\n 'positive': ['view', 'suggest', 'translate', 'review', 'administrate'],\n 'negative': ['hide'],\n}\n\n\nclass PermissionFormField(forms.ModelMultipleChoiceField):\n\n def label_from_instance(self, instance):\n return _(instance.name)\n\n\ndef admin_permissions(request, current_directory, template, ctx):\n language = ctx.get('language', None)\n\n negative_permissions_excl = list(PERMISSIONS['negative'])\n positive_permissions_excl = list(PERMISSIONS['positive'])\n\n # Don't provide means to alter access permissions under /<lang_code>/*\n # In other words: only allow setting access permissions for the root\n # and the `/projects/<code>/` directories\n if language is not None:\n access_permissions = ['view', 'hide']\n negative_permissions_excl.extend(access_permissions)\n positive_permissions_excl.extend(access_permissions)\n\n content_type = get_permission_contenttype()\n\n positive_permissions_qs = content_type.permission_set.exclude(\n codename__in=negative_permissions_excl,\n )\n negative_permissions_qs = content_type.permission_set.exclude(\n codename__in=positive_permissions_excl,\n )\n\n base_queryset = User.objects.filter(is_active=1).exclude(\n id__in=current_directory.permission_sets.values_list('user_id',\n flat=True),)\n choice_groups = [(None, base_queryset.filter(\n username__in=('nobody', 'default')\n ))]\n\n choice_groups.append((\n _('All Users'),\n base_queryset.exclude(username__in=('nobody',\n 'default')).order_by('username'),\n ))\n\n class PermissionSetForm(forms.ModelForm):\n\n class Meta(object):\n model = PermissionSet\n fields = ('user', 'directory', 'positive_permissions',\n 'negative_permissions')\n\n directory = forms.ModelChoiceField(\n queryset=Directory.objects.filter(pk=current_directory.pk),\n initial=current_directory.pk,\n widget=forms.HiddenInput,\n )\n user = GroupedModelChoiceField(\n label=_('Username'),\n choice_groups=choice_groups,\n queryset=User.objects.all(),\n required=True,\n widget=RemoteSelectWidget(\n attrs={\n \"data-s2-placeholder\": _(\"Search for users to add\"),\n 'class': ('js-select2-remote select2-username '\n 'js-s2-new-members')}))\n positive_permissions = PermissionFormField(\n label=_('Add Permissions'),\n queryset=positive_permissions_qs,\n required=False,\n widget=forms.SelectMultiple(attrs={\n 'class': 'js-select2 select2-multiple',\n 'data-placeholder': _('Select one or more permissions'),\n }),\n )\n negative_permissions = PermissionFormField(\n label=_('Revoke Permissions'),\n queryset=negative_permissions_qs,\n required=False,\n widget=forms.SelectMultiple(attrs={\n 'class': 'js-select2 select2-multiple',\n 'data-placeholder': _('Select one or more permissions'),\n }),\n )\n\n def __init__(self, *args, **kwargs):\n super(PermissionSetForm, self).__init__(*args, **kwargs)\n\n self.fields[\"user\"].widget.attrs[\"data-select2-url\"] = reverse(\n \"pootle-permissions-users\",\n kwargs=dict(directory=current_directory.pk))\n\n # Don't display extra negative permissions field where they\n # are not applicable\n if language is not None:\n del self.fields['negative_permissions']\n\n link = lambda instance: unicode(instance.user)\n directory_permissions = current_directory.permission_sets \\\n .order_by('user').all()\n\n return util.edit(request, template, PermissionSet, ctx, link,\n linkfield='user', queryset=directory_permissions,\n can_delete=True, form=PermissionSetForm)\n\n\nclass PermissionsUsersJSON(PootleJSONMixin, PootleAdminFormView):\n form_class = PermissionsUsersSearchForm\n\n @property\n def directory(self):\n return get_object_or_404(\n Directory.objects,\n pk=self.kwargs[\"directory\"])\n\n def get_context_data(self, **kwargs):\n context = super(\n PermissionsUsersJSON, self).get_context_data(**kwargs)\n form = context[\"form\"]\n return (\n dict(items=form.search())\n if form.is_valid()\n else dict(items=[]))\n\n def get_form_kwargs(self):\n kwargs = super(PermissionsUsersJSON, self).get_form_kwargs()\n kwargs[\"directory\"] = self.directory\n return kwargs\n\n def form_valid(self, form):\n return self.render_to_response(\n self.get_context_data(form=form))\n\n def form_invalid(self, form):\n raise Http400(form.errors)\n", "path": "pootle/apps/pootle_app/views/admin/permissions.py"}]}
| 1,818 | 443 |
gh_patches_debug_14892
|
rasdani/github-patches
|
git_diff
|
mitmproxy__mitmproxy-2659
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
command console.choose.cmd crashes when given no arguments
Enter mitmproxy console, issue a command like:
console.choose.cmd
... and press return.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `mitmproxy/command.py`
Content:
```
1 """
2 This module manges and invokes typed commands.
3 """
4 import inspect
5 import typing
6 import shlex
7 import textwrap
8 import functools
9 import sys
10
11 from mitmproxy.utils import typecheck
12 from mitmproxy import exceptions
13 from mitmproxy import flow
14
15
16 Cuts = typing.Sequence[
17 typing.Sequence[typing.Union[str, bytes]]
18 ]
19
20
21 def typename(t: type, ret: bool) -> str:
22 """
23 Translates a type to an explanatory string. If ret is True, we're
24 looking at a return type, else we're looking at a parameter type.
25 """
26 if issubclass(t, (str, int, bool)):
27 return t.__name__
28 elif t == typing.Sequence[flow.Flow]:
29 return "[flow]" if ret else "flowspec"
30 elif t == typing.Sequence[str]:
31 return "[str]"
32 elif t == Cuts:
33 return "[cuts]" if ret else "cutspec"
34 elif t == flow.Flow:
35 return "flow"
36 else: # pragma: no cover
37 raise NotImplementedError(t)
38
39
40 class Command:
41 def __init__(self, manager, path, func) -> None:
42 self.path = path
43 self.manager = manager
44 self.func = func
45 sig = inspect.signature(self.func)
46 self.help = None
47 if func.__doc__:
48 txt = func.__doc__.strip()
49 self.help = "\n".join(textwrap.wrap(txt))
50
51 self.has_positional = False
52 for i in sig.parameters.values():
53 # This is the kind for *args paramters
54 if i.kind == i.VAR_POSITIONAL:
55 self.has_positional = True
56 self.paramtypes = [v.annotation for v in sig.parameters.values()]
57 self.returntype = sig.return_annotation
58
59 def paramnames(self) -> typing.Sequence[str]:
60 v = [typename(i, False) for i in self.paramtypes]
61 if self.has_positional:
62 v[-1] = "*" + v[-1]
63 return v
64
65 def retname(self) -> str:
66 return typename(self.returntype, True) if self.returntype else ""
67
68 def signature_help(self) -> str:
69 params = " ".join(self.paramnames())
70 ret = self.retname()
71 if ret:
72 ret = " -> " + ret
73 return "%s %s%s" % (self.path, params, ret)
74
75 def call(self, args: typing.Sequence[str]):
76 """
77 Call the command with a list of arguments. At this point, all
78 arguments are strings.
79 """
80 if not self.has_positional and (len(self.paramtypes) != len(args)):
81 raise exceptions.CommandError("Usage: %s" % self.signature_help())
82
83 remainder = [] # type: typing.Sequence[str]
84 if self.has_positional:
85 remainder = args[len(self.paramtypes) - 1:]
86 args = args[:len(self.paramtypes) - 1]
87
88 pargs = []
89 for i in range(len(args)):
90 if typecheck.check_command_type(args[i], self.paramtypes[i]):
91 pargs.append(args[i])
92 else:
93 pargs.append(parsearg(self.manager, args[i], self.paramtypes[i]))
94
95 if remainder:
96 chk = typecheck.check_command_type(
97 remainder,
98 typing.Sequence[self.paramtypes[-1]] # type: ignore
99 )
100 if chk:
101 pargs.extend(remainder)
102 else:
103 raise exceptions.CommandError("Invalid value type.")
104
105 with self.manager.master.handlecontext():
106 ret = self.func(*pargs)
107
108 if not typecheck.check_command_type(ret, self.returntype):
109 raise exceptions.CommandError("Command returned unexpected data")
110
111 return ret
112
113
114 class CommandManager:
115 def __init__(self, master):
116 self.master = master
117 self.commands = {}
118
119 def collect_commands(self, addon):
120 for i in dir(addon):
121 if not i.startswith("__"):
122 o = getattr(addon, i)
123 if hasattr(o, "command_path"):
124 self.add(o.command_path, o)
125
126 def add(self, path: str, func: typing.Callable):
127 self.commands[path] = Command(self, path, func)
128
129 def call_args(self, path, args):
130 """
131 Call a command using a list of string arguments. May raise CommandError.
132 """
133 if path not in self.commands:
134 raise exceptions.CommandError("Unknown command: %s" % path)
135 return self.commands[path].call(args)
136
137 def call(self, cmdstr: str):
138 """
139 Call a command using a string. May raise CommandError.
140 """
141 parts = shlex.split(cmdstr)
142 if not len(parts) >= 1:
143 raise exceptions.CommandError("Invalid command: %s" % cmdstr)
144 return self.call_args(parts[0], parts[1:])
145
146 def dump(self, out=sys.stdout) -> None:
147 cmds = list(self.commands.values())
148 cmds.sort(key=lambda x: x.signature_help())
149 for c in cmds:
150 for hl in (c.help or "").splitlines():
151 print("# " + hl, file=out)
152 print(c.signature_help(), file=out)
153 print(file=out)
154
155
156 def parsearg(manager: CommandManager, spec: str, argtype: type) -> typing.Any:
157 """
158 Convert a string to a argument to the appropriate type.
159 """
160 if issubclass(argtype, str):
161 return spec
162 elif argtype == bool:
163 if spec == "true":
164 return True
165 elif spec == "false":
166 return False
167 else:
168 raise exceptions.CommandError(
169 "Booleans are 'true' or 'false', got %s" % spec
170 )
171 elif issubclass(argtype, int):
172 try:
173 return int(spec)
174 except ValueError as e:
175 raise exceptions.CommandError("Expected an integer, got %s." % spec)
176 elif argtype == typing.Sequence[flow.Flow]:
177 return manager.call_args("view.resolve", [spec])
178 elif argtype == Cuts:
179 return manager.call_args("cut", [spec])
180 elif argtype == flow.Flow:
181 flows = manager.call_args("view.resolve", [spec])
182 if len(flows) != 1:
183 raise exceptions.CommandError(
184 "Command requires one flow, specification matched %s." % len(flows)
185 )
186 return flows[0]
187 elif argtype == typing.Sequence[str]:
188 return [i.strip() for i in spec.split(",")]
189 else:
190 raise exceptions.CommandError("Unsupported argument type: %s" % argtype)
191
192
193 def command(path):
194 def decorator(function):
195 @functools.wraps(function)
196 def wrapper(*args, **kwargs):
197 return function(*args, **kwargs)
198 wrapper.__dict__["command_path"] = path
199 return wrapper
200 return decorator
201
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/mitmproxy/command.py b/mitmproxy/command.py
--- a/mitmproxy/command.py
+++ b/mitmproxy/command.py
@@ -190,10 +190,19 @@
raise exceptions.CommandError("Unsupported argument type: %s" % argtype)
+def verify_arg_signature(f: typing.Callable, args: list, kwargs: dict) -> None:
+ sig = inspect.signature(f)
+ try:
+ sig.bind(*args, **kwargs)
+ except TypeError as v:
+ raise exceptions.CommandError("Argument mismatch: %s" % v.args[0])
+
+
def command(path):
def decorator(function):
@functools.wraps(function)
def wrapper(*args, **kwargs):
+ verify_arg_signature(function, args, kwargs)
return function(*args, **kwargs)
wrapper.__dict__["command_path"] = path
return wrapper
|
{"golden_diff": "diff --git a/mitmproxy/command.py b/mitmproxy/command.py\n--- a/mitmproxy/command.py\n+++ b/mitmproxy/command.py\n@@ -190,10 +190,19 @@\n raise exceptions.CommandError(\"Unsupported argument type: %s\" % argtype)\n \n \n+def verify_arg_signature(f: typing.Callable, args: list, kwargs: dict) -> None:\n+ sig = inspect.signature(f)\n+ try:\n+ sig.bind(*args, **kwargs)\n+ except TypeError as v:\n+ raise exceptions.CommandError(\"Argument mismatch: %s\" % v.args[0])\n+\n+\n def command(path):\n def decorator(function):\n @functools.wraps(function)\n def wrapper(*args, **kwargs):\n+ verify_arg_signature(function, args, kwargs)\n return function(*args, **kwargs)\n wrapper.__dict__[\"command_path\"] = path\n return wrapper\n", "issue": "command console.choose.cmd crashes when given no arguments\nEnter mitmproxy console, issue a command like:\r\n\r\n console.choose.cmd\r\n\r\n... and press return. \n", "before_files": [{"content": "\"\"\"\n This module manges and invokes typed commands.\n\"\"\"\nimport inspect\nimport typing\nimport shlex\nimport textwrap\nimport functools\nimport sys\n\nfrom mitmproxy.utils import typecheck\nfrom mitmproxy import exceptions\nfrom mitmproxy import flow\n\n\nCuts = typing.Sequence[\n typing.Sequence[typing.Union[str, bytes]]\n]\n\n\ndef typename(t: type, ret: bool) -> str:\n \"\"\"\n Translates a type to an explanatory string. If ret is True, we're\n looking at a return type, else we're looking at a parameter type.\n \"\"\"\n if issubclass(t, (str, int, bool)):\n return t.__name__\n elif t == typing.Sequence[flow.Flow]:\n return \"[flow]\" if ret else \"flowspec\"\n elif t == typing.Sequence[str]:\n return \"[str]\"\n elif t == Cuts:\n return \"[cuts]\" if ret else \"cutspec\"\n elif t == flow.Flow:\n return \"flow\"\n else: # pragma: no cover\n raise NotImplementedError(t)\n\n\nclass Command:\n def __init__(self, manager, path, func) -> None:\n self.path = path\n self.manager = manager\n self.func = func\n sig = inspect.signature(self.func)\n self.help = None\n if func.__doc__:\n txt = func.__doc__.strip()\n self.help = \"\\n\".join(textwrap.wrap(txt))\n\n self.has_positional = False\n for i in sig.parameters.values():\n # This is the kind for *args paramters\n if i.kind == i.VAR_POSITIONAL:\n self.has_positional = True\n self.paramtypes = [v.annotation for v in sig.parameters.values()]\n self.returntype = sig.return_annotation\n\n def paramnames(self) -> typing.Sequence[str]:\n v = [typename(i, False) for i in self.paramtypes]\n if self.has_positional:\n v[-1] = \"*\" + v[-1]\n return v\n\n def retname(self) -> str:\n return typename(self.returntype, True) if self.returntype else \"\"\n\n def signature_help(self) -> str:\n params = \" \".join(self.paramnames())\n ret = self.retname()\n if ret:\n ret = \" -> \" + ret\n return \"%s %s%s\" % (self.path, params, ret)\n\n def call(self, args: typing.Sequence[str]):\n \"\"\"\n Call the command with a list of arguments. At this point, all\n arguments are strings.\n \"\"\"\n if not self.has_positional and (len(self.paramtypes) != len(args)):\n raise exceptions.CommandError(\"Usage: %s\" % self.signature_help())\n\n remainder = [] # type: typing.Sequence[str]\n if self.has_positional:\n remainder = args[len(self.paramtypes) - 1:]\n args = args[:len(self.paramtypes) - 1]\n\n pargs = []\n for i in range(len(args)):\n if typecheck.check_command_type(args[i], self.paramtypes[i]):\n pargs.append(args[i])\n else:\n pargs.append(parsearg(self.manager, args[i], self.paramtypes[i]))\n\n if remainder:\n chk = typecheck.check_command_type(\n remainder,\n typing.Sequence[self.paramtypes[-1]] # type: ignore\n )\n if chk:\n pargs.extend(remainder)\n else:\n raise exceptions.CommandError(\"Invalid value type.\")\n\n with self.manager.master.handlecontext():\n ret = self.func(*pargs)\n\n if not typecheck.check_command_type(ret, self.returntype):\n raise exceptions.CommandError(\"Command returned unexpected data\")\n\n return ret\n\n\nclass CommandManager:\n def __init__(self, master):\n self.master = master\n self.commands = {}\n\n def collect_commands(self, addon):\n for i in dir(addon):\n if not i.startswith(\"__\"):\n o = getattr(addon, i)\n if hasattr(o, \"command_path\"):\n self.add(o.command_path, o)\n\n def add(self, path: str, func: typing.Callable):\n self.commands[path] = Command(self, path, func)\n\n def call_args(self, path, args):\n \"\"\"\n Call a command using a list of string arguments. May raise CommandError.\n \"\"\"\n if path not in self.commands:\n raise exceptions.CommandError(\"Unknown command: %s\" % path)\n return self.commands[path].call(args)\n\n def call(self, cmdstr: str):\n \"\"\"\n Call a command using a string. May raise CommandError.\n \"\"\"\n parts = shlex.split(cmdstr)\n if not len(parts) >= 1:\n raise exceptions.CommandError(\"Invalid command: %s\" % cmdstr)\n return self.call_args(parts[0], parts[1:])\n\n def dump(self, out=sys.stdout) -> None:\n cmds = list(self.commands.values())\n cmds.sort(key=lambda x: x.signature_help())\n for c in cmds:\n for hl in (c.help or \"\").splitlines():\n print(\"# \" + hl, file=out)\n print(c.signature_help(), file=out)\n print(file=out)\n\n\ndef parsearg(manager: CommandManager, spec: str, argtype: type) -> typing.Any:\n \"\"\"\n Convert a string to a argument to the appropriate type.\n \"\"\"\n if issubclass(argtype, str):\n return spec\n elif argtype == bool:\n if spec == \"true\":\n return True\n elif spec == \"false\":\n return False\n else:\n raise exceptions.CommandError(\n \"Booleans are 'true' or 'false', got %s\" % spec\n )\n elif issubclass(argtype, int):\n try:\n return int(spec)\n except ValueError as e:\n raise exceptions.CommandError(\"Expected an integer, got %s.\" % spec)\n elif argtype == typing.Sequence[flow.Flow]:\n return manager.call_args(\"view.resolve\", [spec])\n elif argtype == Cuts:\n return manager.call_args(\"cut\", [spec])\n elif argtype == flow.Flow:\n flows = manager.call_args(\"view.resolve\", [spec])\n if len(flows) != 1:\n raise exceptions.CommandError(\n \"Command requires one flow, specification matched %s.\" % len(flows)\n )\n return flows[0]\n elif argtype == typing.Sequence[str]:\n return [i.strip() for i in spec.split(\",\")]\n else:\n raise exceptions.CommandError(\"Unsupported argument type: %s\" % argtype)\n\n\ndef command(path):\n def decorator(function):\n @functools.wraps(function)\n def wrapper(*args, **kwargs):\n return function(*args, **kwargs)\n wrapper.__dict__[\"command_path\"] = path\n return wrapper\n return decorator\n", "path": "mitmproxy/command.py"}], "after_files": [{"content": "\"\"\"\n This module manges and invokes typed commands.\n\"\"\"\nimport inspect\nimport typing\nimport shlex\nimport textwrap\nimport functools\nimport sys\n\nfrom mitmproxy.utils import typecheck\nfrom mitmproxy import exceptions\nfrom mitmproxy import flow\n\n\nCuts = typing.Sequence[\n typing.Sequence[typing.Union[str, bytes]]\n]\n\n\ndef typename(t: type, ret: bool) -> str:\n \"\"\"\n Translates a type to an explanatory string. If ret is True, we're\n looking at a return type, else we're looking at a parameter type.\n \"\"\"\n if issubclass(t, (str, int, bool)):\n return t.__name__\n elif t == typing.Sequence[flow.Flow]:\n return \"[flow]\" if ret else \"flowspec\"\n elif t == typing.Sequence[str]:\n return \"[str]\"\n elif t == Cuts:\n return \"[cuts]\" if ret else \"cutspec\"\n elif t == flow.Flow:\n return \"flow\"\n else: # pragma: no cover\n raise NotImplementedError(t)\n\n\nclass Command:\n def __init__(self, manager, path, func) -> None:\n self.path = path\n self.manager = manager\n self.func = func\n sig = inspect.signature(self.func)\n self.help = None\n if func.__doc__:\n txt = func.__doc__.strip()\n self.help = \"\\n\".join(textwrap.wrap(txt))\n\n self.has_positional = False\n for i in sig.parameters.values():\n # This is the kind for *args paramters\n if i.kind == i.VAR_POSITIONAL:\n self.has_positional = True\n self.paramtypes = [v.annotation for v in sig.parameters.values()]\n self.returntype = sig.return_annotation\n\n def paramnames(self) -> typing.Sequence[str]:\n v = [typename(i, False) for i in self.paramtypes]\n if self.has_positional:\n v[-1] = \"*\" + v[-1]\n return v\n\n def retname(self) -> str:\n return typename(self.returntype, True) if self.returntype else \"\"\n\n def signature_help(self) -> str:\n params = \" \".join(self.paramnames())\n ret = self.retname()\n if ret:\n ret = \" -> \" + ret\n return \"%s %s%s\" % (self.path, params, ret)\n\n def call(self, args: typing.Sequence[str]):\n \"\"\"\n Call the command with a list of arguments. At this point, all\n arguments are strings.\n \"\"\"\n if not self.has_positional and (len(self.paramtypes) != len(args)):\n raise exceptions.CommandError(\"Usage: %s\" % self.signature_help())\n\n remainder = [] # type: typing.Sequence[str]\n if self.has_positional:\n remainder = args[len(self.paramtypes) - 1:]\n args = args[:len(self.paramtypes) - 1]\n\n pargs = []\n for i in range(len(args)):\n if typecheck.check_command_type(args[i], self.paramtypes[i]):\n pargs.append(args[i])\n else:\n pargs.append(parsearg(self.manager, args[i], self.paramtypes[i]))\n\n if remainder:\n chk = typecheck.check_command_type(\n remainder,\n typing.Sequence[self.paramtypes[-1]] # type: ignore\n )\n if chk:\n pargs.extend(remainder)\n else:\n raise exceptions.CommandError(\"Invalid value type.\")\n\n with self.manager.master.handlecontext():\n ret = self.func(*pargs)\n\n if not typecheck.check_command_type(ret, self.returntype):\n raise exceptions.CommandError(\"Command returned unexpected data\")\n\n return ret\n\n\nclass CommandManager:\n def __init__(self, master):\n self.master = master\n self.commands = {}\n\n def collect_commands(self, addon):\n for i in dir(addon):\n if not i.startswith(\"__\"):\n o = getattr(addon, i)\n if hasattr(o, \"command_path\"):\n self.add(o.command_path, o)\n\n def add(self, path: str, func: typing.Callable):\n self.commands[path] = Command(self, path, func)\n\n def call_args(self, path, args):\n \"\"\"\n Call a command using a list of string arguments. May raise CommandError.\n \"\"\"\n if path not in self.commands:\n raise exceptions.CommandError(\"Unknown command: %s\" % path)\n return self.commands[path].call(args)\n\n def call(self, cmdstr: str):\n \"\"\"\n Call a command using a string. May raise CommandError.\n \"\"\"\n parts = shlex.split(cmdstr)\n if not len(parts) >= 1:\n raise exceptions.CommandError(\"Invalid command: %s\" % cmdstr)\n return self.call_args(parts[0], parts[1:])\n\n def dump(self, out=sys.stdout) -> None:\n cmds = list(self.commands.values())\n cmds.sort(key=lambda x: x.signature_help())\n for c in cmds:\n for hl in (c.help or \"\").splitlines():\n print(\"# \" + hl, file=out)\n print(c.signature_help(), file=out)\n print(file=out)\n\n\ndef parsearg(manager: CommandManager, spec: str, argtype: type) -> typing.Any:\n \"\"\"\n Convert a string to a argument to the appropriate type.\n \"\"\"\n if issubclass(argtype, str):\n return spec\n elif argtype == bool:\n if spec == \"true\":\n return True\n elif spec == \"false\":\n return False\n else:\n raise exceptions.CommandError(\n \"Booleans are 'true' or 'false', got %s\" % spec\n )\n elif issubclass(argtype, int):\n try:\n return int(spec)\n except ValueError as e:\n raise exceptions.CommandError(\"Expected an integer, got %s.\" % spec)\n elif argtype == typing.Sequence[flow.Flow]:\n return manager.call_args(\"view.resolve\", [spec])\n elif argtype == Cuts:\n return manager.call_args(\"cut\", [spec])\n elif argtype == flow.Flow:\n flows = manager.call_args(\"view.resolve\", [spec])\n if len(flows) != 1:\n raise exceptions.CommandError(\n \"Command requires one flow, specification matched %s.\" % len(flows)\n )\n return flows[0]\n elif argtype == typing.Sequence[str]:\n return [i.strip() for i in spec.split(\",\")]\n else:\n raise exceptions.CommandError(\"Unsupported argument type: %s\" % argtype)\n\n\ndef verify_arg_signature(f: typing.Callable, args: list, kwargs: dict) -> None:\n sig = inspect.signature(f)\n try:\n sig.bind(*args, **kwargs)\n except TypeError as v:\n raise exceptions.CommandError(\"Argument mismatch: %s\" % v.args[0])\n\n\ndef command(path):\n def decorator(function):\n @functools.wraps(function)\n def wrapper(*args, **kwargs):\n verify_arg_signature(function, args, kwargs)\n return function(*args, **kwargs)\n wrapper.__dict__[\"command_path\"] = path\n return wrapper\n return decorator\n", "path": "mitmproxy/command.py"}]}
| 2,256 | 200 |
gh_patches_debug_31695
|
rasdani/github-patches
|
git_diff
|
DistrictDataLabs__yellowbrick-652
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Fix second image in KElbowVisualizer documentation
The second image that was added to the `KElbowVisualizer` documentation in PR #635 is not rendering correctly because the `elbow_is_behind.png` file is not generated by the `elbow.py` file, but was added separately.
- [x] Expand `KElbowVisualizer` documentation in `elbow.rst`
- [x] Add example showing how to hide timing and use `calinski_harabaz` scoring metric
- [x] Update `elbow.py` to generate new image for the documentation.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `docs/api/cluster/elbow.py`
Content:
```
1 # Clustering Evaluation Imports
2 from functools import partial
3
4 from sklearn.cluster import MiniBatchKMeans
5 from sklearn.datasets import make_blobs as sk_make_blobs
6
7 from yellowbrick.cluster import KElbowVisualizer
8
9 # Helpers for easy dataset creation
10 N_SAMPLES = 1000
11 N_FEATURES = 12
12 SHUFFLE = True
13
14 # Make blobs partial
15 make_blobs = partial(sk_make_blobs, n_samples=N_SAMPLES, n_features=N_FEATURES, shuffle=SHUFFLE)
16
17
18 if __name__ == '__main__':
19 # Make 8 blobs dataset
20 X, y = make_blobs(centers=8)
21
22 # Instantiate the clustering model and visualizer
23 # Instantiate the clustering model and visualizer
24 visualizer = KElbowVisualizer(MiniBatchKMeans(), k=(4,12))
25
26 visualizer.fit(X) # Fit the training data to the visualizer
27 visualizer.poof(outpath="images/elbow.png") # Draw/show/poof the data
28
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/docs/api/cluster/elbow.py b/docs/api/cluster/elbow.py
--- a/docs/api/cluster/elbow.py
+++ b/docs/api/cluster/elbow.py
@@ -1,27 +1,55 @@
-# Clustering Evaluation Imports
-from functools import partial
+#!/usr/bin/env python
-from sklearn.cluster import MiniBatchKMeans
-from sklearn.datasets import make_blobs as sk_make_blobs
+"""
+Generate images for the elbow plot documentation.
+"""
-from yellowbrick.cluster import KElbowVisualizer
+# Import necessary modules
+import matplotlib.pyplot as plt
-# Helpers for easy dataset creation
-N_SAMPLES = 1000
-N_FEATURES = 12
-SHUFFLE = True
+from sklearn.cluster import KMeans
+from sklearn.datasets import make_blobs
+from yellowbrick.cluster import KElbowVisualizer
-# Make blobs partial
-make_blobs = partial(sk_make_blobs, n_samples=N_SAMPLES, n_features=N_FEATURES, shuffle=SHUFFLE)
+def draw_elbow(path="images/elbow.png"):
+ # Generate synthetic dataset with 8 blobs
+ X, y = make_blobs(
+ centers=8, n_features=12, n_samples=1000,
+ shuffle=True, random_state=42
+ )
-if __name__ == '__main__':
- # Make 8 blobs dataset
- X, y = make_blobs(centers=8)
+ # Create a new figure to draw the clustering visualizer on
+ _, ax = plt.subplots()
# Instantiate the clustering model and visualizer
+ model = KMeans()
+ visualizer = KElbowVisualizer(model, ax=ax, k=(4,12))
+
+ visualizer.fit(X) # Fit the data to the visualizer
+ visualizer.poof(outpath=path) # Draw/show/poof the data
+
+
+def draw_calinski_harabaz(path="images/calinski_harabaz.png"):
+ # Generate synthetic dataset with 8 blobs
+ X, y = make_blobs(
+ centers=8, n_features=12, n_samples=1000,
+ shuffle=True, random_state=42
+ )
+
+ # Create a new figure to draw the clustering visualizer on
+ _, ax = plt.subplots()
+
# Instantiate the clustering model and visualizer
- visualizer = KElbowVisualizer(MiniBatchKMeans(), k=(4,12))
+ model = KMeans()
+ visualizer = KElbowVisualizer(
+ model, ax=ax, k=(4,12),
+ metric='calinski_harabaz', timings=False
+ )
+ visualizer.fit(X) # Fit the data to the visualizer
+ visualizer.poof(outpath=path) # Draw/show/poof the data
- visualizer.fit(X) # Fit the training data to the visualizer
- visualizer.poof(outpath="images/elbow.png") # Draw/show/poof the data
+
+if __name__ == '__main__':
+ draw_elbow()
+ draw_calinski_harabaz()
|
{"golden_diff": "diff --git a/docs/api/cluster/elbow.py b/docs/api/cluster/elbow.py\n--- a/docs/api/cluster/elbow.py\n+++ b/docs/api/cluster/elbow.py\n@@ -1,27 +1,55 @@\n-# Clustering Evaluation Imports\n-from functools import partial\n+#!/usr/bin/env python\n \n-from sklearn.cluster import MiniBatchKMeans\n-from sklearn.datasets import make_blobs as sk_make_blobs\n+\"\"\"\n+Generate images for the elbow plot documentation.\n+\"\"\"\n \n-from yellowbrick.cluster import KElbowVisualizer\n+# Import necessary modules\n+import matplotlib.pyplot as plt\n \n-# Helpers for easy dataset creation\n-N_SAMPLES = 1000\n-N_FEATURES = 12\n-SHUFFLE = True\n+from sklearn.cluster import KMeans\n+from sklearn.datasets import make_blobs\n+from yellowbrick.cluster import KElbowVisualizer\n \n-# Make blobs partial\n-make_blobs = partial(sk_make_blobs, n_samples=N_SAMPLES, n_features=N_FEATURES, shuffle=SHUFFLE)\n \n+def draw_elbow(path=\"images/elbow.png\"):\n+ # Generate synthetic dataset with 8 blobs\n+ X, y = make_blobs(\n+ centers=8, n_features=12, n_samples=1000,\n+ shuffle=True, random_state=42\n+ )\n \n-if __name__ == '__main__':\n- # Make 8 blobs dataset\n- X, y = make_blobs(centers=8)\n+ # Create a new figure to draw the clustering visualizer on\n+ _, ax = plt.subplots()\n \n # Instantiate the clustering model and visualizer\n+ model = KMeans()\n+ visualizer = KElbowVisualizer(model, ax=ax, k=(4,12))\n+\n+ visualizer.fit(X) # Fit the data to the visualizer\n+ visualizer.poof(outpath=path) # Draw/show/poof the data\n+\n+\n+def draw_calinski_harabaz(path=\"images/calinski_harabaz.png\"):\n+ # Generate synthetic dataset with 8 blobs\n+ X, y = make_blobs(\n+ centers=8, n_features=12, n_samples=1000,\n+ shuffle=True, random_state=42\n+ )\n+\n+ # Create a new figure to draw the clustering visualizer on\n+ _, ax = plt.subplots()\n+\n # Instantiate the clustering model and visualizer\n- visualizer = KElbowVisualizer(MiniBatchKMeans(), k=(4,12))\n+ model = KMeans()\n+ visualizer = KElbowVisualizer(\n+ model, ax=ax, k=(4,12),\n+ metric='calinski_harabaz', timings=False\n+ )\n+ visualizer.fit(X) # Fit the data to the visualizer\n+ visualizer.poof(outpath=path) # Draw/show/poof the data\n \n- visualizer.fit(X) # Fit the training data to the visualizer\n- visualizer.poof(outpath=\"images/elbow.png\") # Draw/show/poof the data\n+\n+if __name__ == '__main__':\n+ draw_elbow()\n+ draw_calinski_harabaz()\n", "issue": "Fix second image in KElbowVisualizer documentation\nThe second image that was added to the `KElbowVisualizer` documentation in PR #635 is not rendering correctly because the `elbow_is_behind.png` file is not generated by the `elbow.py` file, but was added separately.\r\n\r\n- [x] Expand `KElbowVisualizer` documentation in `elbow.rst`\r\n- [x] Add example showing how to hide timing and use `calinski_harabaz` scoring metric\r\n- [x] Update `elbow.py` to generate new image for the documentation.\r\n\r\n\r\n\n", "before_files": [{"content": "# Clustering Evaluation Imports\nfrom functools import partial\n\nfrom sklearn.cluster import MiniBatchKMeans\nfrom sklearn.datasets import make_blobs as sk_make_blobs\n\nfrom yellowbrick.cluster import KElbowVisualizer\n\n# Helpers for easy dataset creation\nN_SAMPLES = 1000\nN_FEATURES = 12\nSHUFFLE = True\n\n# Make blobs partial\nmake_blobs = partial(sk_make_blobs, n_samples=N_SAMPLES, n_features=N_FEATURES, shuffle=SHUFFLE)\n\n\nif __name__ == '__main__':\n # Make 8 blobs dataset\n X, y = make_blobs(centers=8)\n\n # Instantiate the clustering model and visualizer\n # Instantiate the clustering model and visualizer\n visualizer = KElbowVisualizer(MiniBatchKMeans(), k=(4,12))\n\n visualizer.fit(X) # Fit the training data to the visualizer\n visualizer.poof(outpath=\"images/elbow.png\") # Draw/show/poof the data\n", "path": "docs/api/cluster/elbow.py"}], "after_files": [{"content": "#!/usr/bin/env python\n\n\"\"\"\nGenerate images for the elbow plot documentation.\n\"\"\"\n\n# Import necessary modules\nimport matplotlib.pyplot as plt\n\nfrom sklearn.cluster import KMeans\nfrom sklearn.datasets import make_blobs\nfrom yellowbrick.cluster import KElbowVisualizer\n\n\ndef draw_elbow(path=\"images/elbow.png\"):\n # Generate synthetic dataset with 8 blobs\n X, y = make_blobs(\n centers=8, n_features=12, n_samples=1000,\n shuffle=True, random_state=42\n )\n\n # Create a new figure to draw the clustering visualizer on\n _, ax = plt.subplots()\n\n # Instantiate the clustering model and visualizer\n model = KMeans()\n visualizer = KElbowVisualizer(model, ax=ax, k=(4,12))\n\n visualizer.fit(X) # Fit the data to the visualizer\n visualizer.poof(outpath=path) # Draw/show/poof the data\n\n\ndef draw_calinski_harabaz(path=\"images/calinski_harabaz.png\"):\n # Generate synthetic dataset with 8 blobs\n X, y = make_blobs(\n centers=8, n_features=12, n_samples=1000,\n shuffle=True, random_state=42\n )\n\n # Create a new figure to draw the clustering visualizer on\n _, ax = plt.subplots()\n\n # Instantiate the clustering model and visualizer\n model = KMeans()\n visualizer = KElbowVisualizer(\n model, ax=ax, k=(4,12),\n metric='calinski_harabaz', timings=False\n )\n visualizer.fit(X) # Fit the data to the visualizer\n visualizer.poof(outpath=path) # Draw/show/poof the data\n\n\nif __name__ == '__main__':\n draw_elbow()\n draw_calinski_harabaz()\n", "path": "docs/api/cluster/elbow.py"}]}
| 660 | 712 |
gh_patches_debug_10321
|
rasdani/github-patches
|
git_diff
|
numpy__numpy-9552
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
test_warning_calls "invalid escape sequence \s" on Python 3.6 daily wheel builds.
New errors today (13 August), for Linux and OSX:
```
======================================================================
ERROR: numpy.tests.test_warnings.test_warning_calls
----------------------------------------------------------------------
Traceback (most recent call last):
File "/venv/lib/python3.6/site-packages/nose/case.py", line 198, in runTest
self.test(*self.arg)
File "/venv/lib/python3.6/site-packages/numpy/tests/test_warnings.py", line 79, in test_warning_calls
tree = ast.parse(file.read())
File "/usr/lib/python3.6/ast.py", line 35, in parse
return compile(source, filename, mode, PyCF_ONLY_AST)
File "<unknown>", line 184
SyntaxError: invalid escape sequence \s
```
https://travis-ci.org/MacPython/numpy-wheels/jobs/264023630
https://travis-ci.org/MacPython/numpy-wheels/jobs/264023631
https://travis-ci.org/MacPython/numpy-wheels/jobs/264023635
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `numpy/doc/basics.py`
Content:
```
1 """
2 ============
3 Array basics
4 ============
5
6 Array types and conversions between types
7 =========================================
8
9 NumPy supports a much greater variety of numerical types than Python does.
10 This section shows which are available, and how to modify an array's data-type.
11
12 ============ ==========================================================
13 Data type Description
14 ============ ==========================================================
15 ``bool_`` Boolean (True or False) stored as a byte
16 ``int_`` Default integer type (same as C ``long``; normally either
17 ``int64`` or ``int32``)
18 intc Identical to C ``int`` (normally ``int32`` or ``int64``)
19 intp Integer used for indexing (same as C ``ssize_t``; normally
20 either ``int32`` or ``int64``)
21 int8 Byte (-128 to 127)
22 int16 Integer (-32768 to 32767)
23 int32 Integer (-2147483648 to 2147483647)
24 int64 Integer (-9223372036854775808 to 9223372036854775807)
25 uint8 Unsigned integer (0 to 255)
26 uint16 Unsigned integer (0 to 65535)
27 uint32 Unsigned integer (0 to 4294967295)
28 uint64 Unsigned integer (0 to 18446744073709551615)
29 ``float_`` Shorthand for ``float64``.
30 float16 Half precision float: sign bit, 5 bits exponent,
31 10 bits mantissa
32 float32 Single precision float: sign bit, 8 bits exponent,
33 23 bits mantissa
34 float64 Double precision float: sign bit, 11 bits exponent,
35 52 bits mantissa
36 ``complex_`` Shorthand for ``complex128``.
37 complex64 Complex number, represented by two 32-bit floats (real
38 and imaginary components)
39 complex128 Complex number, represented by two 64-bit floats (real
40 and imaginary components)
41 ============ ==========================================================
42
43 Additionally to ``intc`` the platform dependent C integer types ``short``,
44 ``long``, ``longlong`` and their unsigned versions are defined.
45
46 NumPy numerical types are instances of ``dtype`` (data-type) objects, each
47 having unique characteristics. Once you have imported NumPy using
48
49 ::
50
51 >>> import numpy as np
52
53 the dtypes are available as ``np.bool_``, ``np.float32``, etc.
54
55 Advanced types, not listed in the table above, are explored in
56 section :ref:`structured_arrays`.
57
58 There are 5 basic numerical types representing booleans (bool), integers (int),
59 unsigned integers (uint) floating point (float) and complex. Those with numbers
60 in their name indicate the bitsize of the type (i.e. how many bits are needed
61 to represent a single value in memory). Some types, such as ``int`` and
62 ``intp``, have differing bitsizes, dependent on the platforms (e.g. 32-bit
63 vs. 64-bit machines). This should be taken into account when interfacing
64 with low-level code (such as C or Fortran) where the raw memory is addressed.
65
66 Data-types can be used as functions to convert python numbers to array scalars
67 (see the array scalar section for an explanation), python sequences of numbers
68 to arrays of that type, or as arguments to the dtype keyword that many numpy
69 functions or methods accept. Some examples::
70
71 >>> import numpy as np
72 >>> x = np.float32(1.0)
73 >>> x
74 1.0
75 >>> y = np.int_([1,2,4])
76 >>> y
77 array([1, 2, 4])
78 >>> z = np.arange(3, dtype=np.uint8)
79 >>> z
80 array([0, 1, 2], dtype=uint8)
81
82 Array types can also be referred to by character codes, mostly to retain
83 backward compatibility with older packages such as Numeric. Some
84 documentation may still refer to these, for example::
85
86 >>> np.array([1, 2, 3], dtype='f')
87 array([ 1., 2., 3.], dtype=float32)
88
89 We recommend using dtype objects instead.
90
91 To convert the type of an array, use the .astype() method (preferred) or
92 the type itself as a function. For example: ::
93
94 >>> z.astype(float) #doctest: +NORMALIZE_WHITESPACE
95 array([ 0., 1., 2.])
96 >>> np.int8(z)
97 array([0, 1, 2], dtype=int8)
98
99 Note that, above, we use the *Python* float object as a dtype. NumPy knows
100 that ``int`` refers to ``np.int_``, ``bool`` means ``np.bool_``,
101 that ``float`` is ``np.float_`` and ``complex`` is ``np.complex_``.
102 The other data-types do not have Python equivalents.
103
104 To determine the type of an array, look at the dtype attribute::
105
106 >>> z.dtype
107 dtype('uint8')
108
109 dtype objects also contain information about the type, such as its bit-width
110 and its byte-order. The data type can also be used indirectly to query
111 properties of the type, such as whether it is an integer::
112
113 >>> d = np.dtype(int)
114 >>> d
115 dtype('int32')
116
117 >>> np.issubdtype(d, np.integer)
118 True
119
120 >>> np.issubdtype(d, np.floating)
121 False
122
123
124 Array Scalars
125 =============
126
127 NumPy generally returns elements of arrays as array scalars (a scalar
128 with an associated dtype). Array scalars differ from Python scalars, but
129 for the most part they can be used interchangeably (the primary
130 exception is for versions of Python older than v2.x, where integer array
131 scalars cannot act as indices for lists and tuples). There are some
132 exceptions, such as when code requires very specific attributes of a scalar
133 or when it checks specifically whether a value is a Python scalar. Generally,
134 problems are easily fixed by explicitly converting array scalars
135 to Python scalars, using the corresponding Python type function
136 (e.g., ``int``, ``float``, ``complex``, ``str``, ``unicode``).
137
138 The primary advantage of using array scalars is that
139 they preserve the array type (Python may not have a matching scalar type
140 available, e.g. ``int16``). Therefore, the use of array scalars ensures
141 identical behaviour between arrays and scalars, irrespective of whether the
142 value is inside an array or not. NumPy scalars also have many of the same
143 methods arrays do.
144
145 Extended Precision
146 ==================
147
148 Python's floating-point numbers are usually 64-bit floating-point numbers,
149 nearly equivalent to ``np.float64``. In some unusual situations it may be
150 useful to use floating-point numbers with more precision. Whether this
151 is possible in numpy depends on the hardware and on the development
152 environment: specifically, x86 machines provide hardware floating-point
153 with 80-bit precision, and while most C compilers provide this as their
154 ``long double`` type, MSVC (standard for Windows builds) makes
155 ``long double`` identical to ``double`` (64 bits). NumPy makes the
156 compiler's ``long double`` available as ``np.longdouble`` (and
157 ``np.clongdouble`` for the complex numbers). You can find out what your
158 numpy provides with ``np.finfo(np.longdouble)``.
159
160 NumPy does not provide a dtype with more precision than C
161 ``long double``\s; in particular, the 128-bit IEEE quad precision
162 data type (FORTRAN's ``REAL*16``\) is not available.
163
164 For efficient memory alignment, ``np.longdouble`` is usually stored
165 padded with zero bits, either to 96 or 128 bits. Which is more efficient
166 depends on hardware and development environment; typically on 32-bit
167 systems they are padded to 96 bits, while on 64-bit systems they are
168 typically padded to 128 bits. ``np.longdouble`` is padded to the system
169 default; ``np.float96`` and ``np.float128`` are provided for users who
170 want specific padding. In spite of the names, ``np.float96`` and
171 ``np.float128`` provide only as much precision as ``np.longdouble``,
172 that is, 80 bits on most x86 machines and 64 bits in standard
173 Windows builds.
174
175 Be warned that even if ``np.longdouble`` offers more precision than
176 python ``float``, it is easy to lose that extra precision, since
177 python often forces values to pass through ``float``. For example,
178 the ``%`` formatting operator requires its arguments to be converted
179 to standard python types, and it is therefore impossible to preserve
180 extended precision even if many decimal places are requested. It can
181 be useful to test your code with the value
182 ``1 + np.finfo(np.longdouble).eps``.
183
184 """
185 from __future__ import division, absolute_import, print_function
186
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/numpy/doc/basics.py b/numpy/doc/basics.py
--- a/numpy/doc/basics.py
+++ b/numpy/doc/basics.py
@@ -158,8 +158,8 @@
numpy provides with ``np.finfo(np.longdouble)``.
NumPy does not provide a dtype with more precision than C
-``long double``\s; in particular, the 128-bit IEEE quad precision
-data type (FORTRAN's ``REAL*16``\) is not available.
+``long double``\\s; in particular, the 128-bit IEEE quad precision
+data type (FORTRAN's ``REAL*16``\\) is not available.
For efficient memory alignment, ``np.longdouble`` is usually stored
padded with zero bits, either to 96 or 128 bits. Which is more efficient
|
{"golden_diff": "diff --git a/numpy/doc/basics.py b/numpy/doc/basics.py\n--- a/numpy/doc/basics.py\n+++ b/numpy/doc/basics.py\n@@ -158,8 +158,8 @@\n numpy provides with ``np.finfo(np.longdouble)``.\n \n NumPy does not provide a dtype with more precision than C\n-``long double``\\s; in particular, the 128-bit IEEE quad precision\n-data type (FORTRAN's ``REAL*16``\\) is not available.\n+``long double``\\\\s; in particular, the 128-bit IEEE quad precision\n+data type (FORTRAN's ``REAL*16``\\\\) is not available.\n \n For efficient memory alignment, ``np.longdouble`` is usually stored\n padded with zero bits, either to 96 or 128 bits. Which is more efficient\n", "issue": "test_warning_calls \"invalid escape sequence \\s\" on Python 3.6 daily wheel builds.\nNew errors today (13 August), for Linux and OSX:\r\n\r\n```\r\n======================================================================\r\nERROR: numpy.tests.test_warnings.test_warning_calls\r\n----------------------------------------------------------------------\r\nTraceback (most recent call last):\r\n File \"/venv/lib/python3.6/site-packages/nose/case.py\", line 198, in runTest\r\n self.test(*self.arg)\r\n File \"/venv/lib/python3.6/site-packages/numpy/tests/test_warnings.py\", line 79, in test_warning_calls\r\n tree = ast.parse(file.read())\r\n File \"/usr/lib/python3.6/ast.py\", line 35, in parse\r\n return compile(source, filename, mode, PyCF_ONLY_AST)\r\n File \"<unknown>\", line 184\r\nSyntaxError: invalid escape sequence \\s\r\n```\r\n\r\nhttps://travis-ci.org/MacPython/numpy-wheels/jobs/264023630\r\nhttps://travis-ci.org/MacPython/numpy-wheels/jobs/264023631\r\nhttps://travis-ci.org/MacPython/numpy-wheels/jobs/264023635\n", "before_files": [{"content": "\"\"\"\n============\nArray basics\n============\n\nArray types and conversions between types\n=========================================\n\nNumPy supports a much greater variety of numerical types than Python does.\nThis section shows which are available, and how to modify an array's data-type.\n\n============ ==========================================================\nData type Description\n============ ==========================================================\n``bool_`` Boolean (True or False) stored as a byte\n``int_`` Default integer type (same as C ``long``; normally either\n ``int64`` or ``int32``)\nintc Identical to C ``int`` (normally ``int32`` or ``int64``)\nintp Integer used for indexing (same as C ``ssize_t``; normally\n either ``int32`` or ``int64``)\nint8 Byte (-128 to 127)\nint16 Integer (-32768 to 32767)\nint32 Integer (-2147483648 to 2147483647)\nint64 Integer (-9223372036854775808 to 9223372036854775807)\nuint8 Unsigned integer (0 to 255)\nuint16 Unsigned integer (0 to 65535)\nuint32 Unsigned integer (0 to 4294967295)\nuint64 Unsigned integer (0 to 18446744073709551615)\n``float_`` Shorthand for ``float64``.\nfloat16 Half precision float: sign bit, 5 bits exponent,\n 10 bits mantissa\nfloat32 Single precision float: sign bit, 8 bits exponent,\n 23 bits mantissa\nfloat64 Double precision float: sign bit, 11 bits exponent,\n 52 bits mantissa\n``complex_`` Shorthand for ``complex128``.\ncomplex64 Complex number, represented by two 32-bit floats (real\n and imaginary components)\ncomplex128 Complex number, represented by two 64-bit floats (real\n and imaginary components)\n============ ==========================================================\n\nAdditionally to ``intc`` the platform dependent C integer types ``short``,\n``long``, ``longlong`` and their unsigned versions are defined.\n\nNumPy numerical types are instances of ``dtype`` (data-type) objects, each\nhaving unique characteristics. Once you have imported NumPy using\n\n ::\n\n >>> import numpy as np\n\nthe dtypes are available as ``np.bool_``, ``np.float32``, etc.\n\nAdvanced types, not listed in the table above, are explored in\nsection :ref:`structured_arrays`.\n\nThere are 5 basic numerical types representing booleans (bool), integers (int),\nunsigned integers (uint) floating point (float) and complex. Those with numbers\nin their name indicate the bitsize of the type (i.e. how many bits are needed\nto represent a single value in memory). Some types, such as ``int`` and\n``intp``, have differing bitsizes, dependent on the platforms (e.g. 32-bit\nvs. 64-bit machines). This should be taken into account when interfacing\nwith low-level code (such as C or Fortran) where the raw memory is addressed.\n\nData-types can be used as functions to convert python numbers to array scalars\n(see the array scalar section for an explanation), python sequences of numbers\nto arrays of that type, or as arguments to the dtype keyword that many numpy\nfunctions or methods accept. Some examples::\n\n >>> import numpy as np\n >>> x = np.float32(1.0)\n >>> x\n 1.0\n >>> y = np.int_([1,2,4])\n >>> y\n array([1, 2, 4])\n >>> z = np.arange(3, dtype=np.uint8)\n >>> z\n array([0, 1, 2], dtype=uint8)\n\nArray types can also be referred to by character codes, mostly to retain\nbackward compatibility with older packages such as Numeric. Some\ndocumentation may still refer to these, for example::\n\n >>> np.array([1, 2, 3], dtype='f')\n array([ 1., 2., 3.], dtype=float32)\n\nWe recommend using dtype objects instead.\n\nTo convert the type of an array, use the .astype() method (preferred) or\nthe type itself as a function. For example: ::\n\n >>> z.astype(float) #doctest: +NORMALIZE_WHITESPACE\n array([ 0., 1., 2.])\n >>> np.int8(z)\n array([0, 1, 2], dtype=int8)\n\nNote that, above, we use the *Python* float object as a dtype. NumPy knows\nthat ``int`` refers to ``np.int_``, ``bool`` means ``np.bool_``,\nthat ``float`` is ``np.float_`` and ``complex`` is ``np.complex_``.\nThe other data-types do not have Python equivalents.\n\nTo determine the type of an array, look at the dtype attribute::\n\n >>> z.dtype\n dtype('uint8')\n\ndtype objects also contain information about the type, such as its bit-width\nand its byte-order. The data type can also be used indirectly to query\nproperties of the type, such as whether it is an integer::\n\n >>> d = np.dtype(int)\n >>> d\n dtype('int32')\n\n >>> np.issubdtype(d, np.integer)\n True\n\n >>> np.issubdtype(d, np.floating)\n False\n\n\nArray Scalars\n=============\n\nNumPy generally returns elements of arrays as array scalars (a scalar\nwith an associated dtype). Array scalars differ from Python scalars, but\nfor the most part they can be used interchangeably (the primary\nexception is for versions of Python older than v2.x, where integer array\nscalars cannot act as indices for lists and tuples). There are some\nexceptions, such as when code requires very specific attributes of a scalar\nor when it checks specifically whether a value is a Python scalar. Generally,\nproblems are easily fixed by explicitly converting array scalars\nto Python scalars, using the corresponding Python type function\n(e.g., ``int``, ``float``, ``complex``, ``str``, ``unicode``).\n\nThe primary advantage of using array scalars is that\nthey preserve the array type (Python may not have a matching scalar type\navailable, e.g. ``int16``). Therefore, the use of array scalars ensures\nidentical behaviour between arrays and scalars, irrespective of whether the\nvalue is inside an array or not. NumPy scalars also have many of the same\nmethods arrays do.\n\nExtended Precision\n==================\n\nPython's floating-point numbers are usually 64-bit floating-point numbers,\nnearly equivalent to ``np.float64``. In some unusual situations it may be\nuseful to use floating-point numbers with more precision. Whether this\nis possible in numpy depends on the hardware and on the development\nenvironment: specifically, x86 machines provide hardware floating-point\nwith 80-bit precision, and while most C compilers provide this as their\n``long double`` type, MSVC (standard for Windows builds) makes\n``long double`` identical to ``double`` (64 bits). NumPy makes the\ncompiler's ``long double`` available as ``np.longdouble`` (and\n``np.clongdouble`` for the complex numbers). You can find out what your\nnumpy provides with ``np.finfo(np.longdouble)``.\n\nNumPy does not provide a dtype with more precision than C\n``long double``\\s; in particular, the 128-bit IEEE quad precision\ndata type (FORTRAN's ``REAL*16``\\) is not available.\n\nFor efficient memory alignment, ``np.longdouble`` is usually stored\npadded with zero bits, either to 96 or 128 bits. Which is more efficient\ndepends on hardware and development environment; typically on 32-bit\nsystems they are padded to 96 bits, while on 64-bit systems they are\ntypically padded to 128 bits. ``np.longdouble`` is padded to the system\ndefault; ``np.float96`` and ``np.float128`` are provided for users who\nwant specific padding. In spite of the names, ``np.float96`` and\n``np.float128`` provide only as much precision as ``np.longdouble``,\nthat is, 80 bits on most x86 machines and 64 bits in standard\nWindows builds.\n\nBe warned that even if ``np.longdouble`` offers more precision than\npython ``float``, it is easy to lose that extra precision, since\npython often forces values to pass through ``float``. For example,\nthe ``%`` formatting operator requires its arguments to be converted\nto standard python types, and it is therefore impossible to preserve\nextended precision even if many decimal places are requested. It can\nbe useful to test your code with the value\n``1 + np.finfo(np.longdouble).eps``.\n\n\"\"\"\nfrom __future__ import division, absolute_import, print_function\n", "path": "numpy/doc/basics.py"}], "after_files": [{"content": "\"\"\"\n============\nArray basics\n============\n\nArray types and conversions between types\n=========================================\n\nNumPy supports a much greater variety of numerical types than Python does.\nThis section shows which are available, and how to modify an array's data-type.\n\n============ ==========================================================\nData type Description\n============ ==========================================================\n``bool_`` Boolean (True or False) stored as a byte\n``int_`` Default integer type (same as C ``long``; normally either\n ``int64`` or ``int32``)\nintc Identical to C ``int`` (normally ``int32`` or ``int64``)\nintp Integer used for indexing (same as C ``ssize_t``; normally\n either ``int32`` or ``int64``)\nint8 Byte (-128 to 127)\nint16 Integer (-32768 to 32767)\nint32 Integer (-2147483648 to 2147483647)\nint64 Integer (-9223372036854775808 to 9223372036854775807)\nuint8 Unsigned integer (0 to 255)\nuint16 Unsigned integer (0 to 65535)\nuint32 Unsigned integer (0 to 4294967295)\nuint64 Unsigned integer (0 to 18446744073709551615)\n``float_`` Shorthand for ``float64``.\nfloat16 Half precision float: sign bit, 5 bits exponent,\n 10 bits mantissa\nfloat32 Single precision float: sign bit, 8 bits exponent,\n 23 bits mantissa\nfloat64 Double precision float: sign bit, 11 bits exponent,\n 52 bits mantissa\n``complex_`` Shorthand for ``complex128``.\ncomplex64 Complex number, represented by two 32-bit floats (real\n and imaginary components)\ncomplex128 Complex number, represented by two 64-bit floats (real\n and imaginary components)\n============ ==========================================================\n\nAdditionally to ``intc`` the platform dependent C integer types ``short``,\n``long``, ``longlong`` and their unsigned versions are defined.\n\nNumPy numerical types are instances of ``dtype`` (data-type) objects, each\nhaving unique characteristics. Once you have imported NumPy using\n\n ::\n\n >>> import numpy as np\n\nthe dtypes are available as ``np.bool_``, ``np.float32``, etc.\n\nAdvanced types, not listed in the table above, are explored in\nsection :ref:`structured_arrays`.\n\nThere are 5 basic numerical types representing booleans (bool), integers (int),\nunsigned integers (uint) floating point (float) and complex. Those with numbers\nin their name indicate the bitsize of the type (i.e. how many bits are needed\nto represent a single value in memory). Some types, such as ``int`` and\n``intp``, have differing bitsizes, dependent on the platforms (e.g. 32-bit\nvs. 64-bit machines). This should be taken into account when interfacing\nwith low-level code (such as C or Fortran) where the raw memory is addressed.\n\nData-types can be used as functions to convert python numbers to array scalars\n(see the array scalar section for an explanation), python sequences of numbers\nto arrays of that type, or as arguments to the dtype keyword that many numpy\nfunctions or methods accept. Some examples::\n\n >>> import numpy as np\n >>> x = np.float32(1.0)\n >>> x\n 1.0\n >>> y = np.int_([1,2,4])\n >>> y\n array([1, 2, 4])\n >>> z = np.arange(3, dtype=np.uint8)\n >>> z\n array([0, 1, 2], dtype=uint8)\n\nArray types can also be referred to by character codes, mostly to retain\nbackward compatibility with older packages such as Numeric. Some\ndocumentation may still refer to these, for example::\n\n >>> np.array([1, 2, 3], dtype='f')\n array([ 1., 2., 3.], dtype=float32)\n\nWe recommend using dtype objects instead.\n\nTo convert the type of an array, use the .astype() method (preferred) or\nthe type itself as a function. For example: ::\n\n >>> z.astype(float) #doctest: +NORMALIZE_WHITESPACE\n array([ 0., 1., 2.])\n >>> np.int8(z)\n array([0, 1, 2], dtype=int8)\n\nNote that, above, we use the *Python* float object as a dtype. NumPy knows\nthat ``int`` refers to ``np.int_``, ``bool`` means ``np.bool_``,\nthat ``float`` is ``np.float_`` and ``complex`` is ``np.complex_``.\nThe other data-types do not have Python equivalents.\n\nTo determine the type of an array, look at the dtype attribute::\n\n >>> z.dtype\n dtype('uint8')\n\ndtype objects also contain information about the type, such as its bit-width\nand its byte-order. The data type can also be used indirectly to query\nproperties of the type, such as whether it is an integer::\n\n >>> d = np.dtype(int)\n >>> d\n dtype('int32')\n\n >>> np.issubdtype(d, np.integer)\n True\n\n >>> np.issubdtype(d, np.floating)\n False\n\n\nArray Scalars\n=============\n\nNumPy generally returns elements of arrays as array scalars (a scalar\nwith an associated dtype). Array scalars differ from Python scalars, but\nfor the most part they can be used interchangeably (the primary\nexception is for versions of Python older than v2.x, where integer array\nscalars cannot act as indices for lists and tuples). There are some\nexceptions, such as when code requires very specific attributes of a scalar\nor when it checks specifically whether a value is a Python scalar. Generally,\nproblems are easily fixed by explicitly converting array scalars\nto Python scalars, using the corresponding Python type function\n(e.g., ``int``, ``float``, ``complex``, ``str``, ``unicode``).\n\nThe primary advantage of using array scalars is that\nthey preserve the array type (Python may not have a matching scalar type\navailable, e.g. ``int16``). Therefore, the use of array scalars ensures\nidentical behaviour between arrays and scalars, irrespective of whether the\nvalue is inside an array or not. NumPy scalars also have many of the same\nmethods arrays do.\n\nExtended Precision\n==================\n\nPython's floating-point numbers are usually 64-bit floating-point numbers,\nnearly equivalent to ``np.float64``. In some unusual situations it may be\nuseful to use floating-point numbers with more precision. Whether this\nis possible in numpy depends on the hardware and on the development\nenvironment: specifically, x86 machines provide hardware floating-point\nwith 80-bit precision, and while most C compilers provide this as their\n``long double`` type, MSVC (standard for Windows builds) makes\n``long double`` identical to ``double`` (64 bits). NumPy makes the\ncompiler's ``long double`` available as ``np.longdouble`` (and\n``np.clongdouble`` for the complex numbers). You can find out what your\nnumpy provides with ``np.finfo(np.longdouble)``.\n\nNumPy does not provide a dtype with more precision than C\n``long double``\\\\s; in particular, the 128-bit IEEE quad precision\ndata type (FORTRAN's ``REAL*16``\\\\) is not available.\n\nFor efficient memory alignment, ``np.longdouble`` is usually stored\npadded with zero bits, either to 96 or 128 bits. Which is more efficient\ndepends on hardware and development environment; typically on 32-bit\nsystems they are padded to 96 bits, while on 64-bit systems they are\ntypically padded to 128 bits. ``np.longdouble`` is padded to the system\ndefault; ``np.float96`` and ``np.float128`` are provided for users who\nwant specific padding. In spite of the names, ``np.float96`` and\n``np.float128`` provide only as much precision as ``np.longdouble``,\nthat is, 80 bits on most x86 machines and 64 bits in standard\nWindows builds.\n\nBe warned that even if ``np.longdouble`` offers more precision than\npython ``float``, it is easy to lose that extra precision, since\npython often forces values to pass through ``float``. For example,\nthe ``%`` formatting operator requires its arguments to be converted\nto standard python types, and it is therefore impossible to preserve\nextended precision even if many decimal places are requested. It can\nbe useful to test your code with the value\n``1 + np.finfo(np.longdouble).eps``.\n\n\"\"\"\nfrom __future__ import division, absolute_import, print_function\n", "path": "numpy/doc/basics.py"}]}
| 3,028 | 192 |
gh_patches_debug_43081
|
rasdani/github-patches
|
git_diff
|
open-telemetry__opentelemetry-python-contrib-236
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Make sure rpc instrumentations follow semantic conventions
Specs: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/rpc.md
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `instrumentation/opentelemetry-instrumentation-grpc/src/opentelemetry/instrumentation/grpc/_server.py`
Content:
```
1 # Copyright The OpenTelemetry Authors
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 # pylint:disable=relative-beyond-top-level
16 # pylint:disable=arguments-differ
17 # pylint:disable=no-member
18 # pylint:disable=signature-differs
19
20 """
21 Implementation of the service-side open-telemetry interceptor.
22 """
23
24 import logging
25 from contextlib import contextmanager
26
27 import grpc
28
29 from opentelemetry import propagators, trace
30 from opentelemetry.context import attach, detach
31 from opentelemetry.trace.propagation.textmap import DictGetter
32 from opentelemetry.trace.status import Status, StatusCode
33
34 logger = logging.getLogger(__name__)
35
36
37 # wrap an RPC call
38 # see https://github.com/grpc/grpc/issues/18191
39 def _wrap_rpc_behavior(handler, continuation):
40 if handler is None:
41 return None
42
43 if handler.request_streaming and handler.response_streaming:
44 behavior_fn = handler.stream_stream
45 handler_factory = grpc.stream_stream_rpc_method_handler
46 elif handler.request_streaming and not handler.response_streaming:
47 behavior_fn = handler.stream_unary
48 handler_factory = grpc.stream_unary_rpc_method_handler
49 elif not handler.request_streaming and handler.response_streaming:
50 behavior_fn = handler.unary_stream
51 handler_factory = grpc.unary_stream_rpc_method_handler
52 else:
53 behavior_fn = handler.unary_unary
54 handler_factory = grpc.unary_unary_rpc_method_handler
55
56 return handler_factory(
57 continuation(
58 behavior_fn, handler.request_streaming, handler.response_streaming
59 ),
60 request_deserializer=handler.request_deserializer,
61 response_serializer=handler.response_serializer,
62 )
63
64
65 # pylint:disable=abstract-method
66 class _OpenTelemetryServicerContext(grpc.ServicerContext):
67 def __init__(self, servicer_context, active_span):
68 self._servicer_context = servicer_context
69 self._active_span = active_span
70 self.code = grpc.StatusCode.OK
71 self.details = None
72 super().__init__()
73
74 def is_active(self, *args, **kwargs):
75 return self._servicer_context.is_active(*args, **kwargs)
76
77 def time_remaining(self, *args, **kwargs):
78 return self._servicer_context.time_remaining(*args, **kwargs)
79
80 def cancel(self, *args, **kwargs):
81 return self._servicer_context.cancel(*args, **kwargs)
82
83 def add_callback(self, *args, **kwargs):
84 return self._servicer_context.add_callback(*args, **kwargs)
85
86 def disable_next_message_compression(self):
87 return self._service_context.disable_next_message_compression()
88
89 def invocation_metadata(self, *args, **kwargs):
90 return self._servicer_context.invocation_metadata(*args, **kwargs)
91
92 def peer(self):
93 return self._servicer_context.peer()
94
95 def peer_identities(self):
96 return self._servicer_context.peer_identities()
97
98 def peer_identity_key(self):
99 return self._servicer_context.peer_identity_key()
100
101 def auth_context(self):
102 return self._servicer_context.auth_context()
103
104 def set_compression(self, compression):
105 return self._servicer_context.set_compression(compression)
106
107 def send_initial_metadata(self, *args, **kwargs):
108 return self._servicer_context.send_initial_metadata(*args, **kwargs)
109
110 def set_trailing_metadata(self, *args, **kwargs):
111 return self._servicer_context.set_trailing_metadata(*args, **kwargs)
112
113 def abort(self, code, details):
114 self.code = code
115 self.details = details
116 self._active_span.set_attribute("rpc.grpc.status_code", code.name)
117 self._active_span.set_status(
118 Status(status_code=StatusCode.ERROR, description=details)
119 )
120 return self._servicer_context.abort(code, details)
121
122 def abort_with_status(self, status):
123 return self._servicer_context.abort_with_status(status)
124
125 def set_code(self, code):
126 self.code = code
127 # use details if we already have it, otherwise the status description
128 details = self.details or code.value[1]
129 self._active_span.set_attribute("rpc.grpc.status_code", code.name)
130 self._active_span.set_status(
131 Status(status_code=StatusCode.ERROR, description=details)
132 )
133 return self._servicer_context.set_code(code)
134
135 def set_details(self, details):
136 self.details = details
137 self._active_span.set_status(
138 Status(status_code=StatusCode.ERROR, description=details)
139 )
140 return self._servicer_context.set_details(details)
141
142
143 # pylint:disable=abstract-method
144 # pylint:disable=no-self-use
145 # pylint:disable=unused-argument
146 class OpenTelemetryServerInterceptor(grpc.ServerInterceptor):
147 """
148 A gRPC server interceptor, to add OpenTelemetry.
149
150 Usage::
151
152 tracer = some OpenTelemetry tracer
153
154 interceptors = [
155 OpenTelemetryServerInterceptor(tracer),
156 ]
157
158 server = grpc.server(
159 futures.ThreadPoolExecutor(max_workers=concurrency),
160 interceptors = interceptors)
161
162 """
163
164 def __init__(self, tracer):
165 self._tracer = tracer
166 self._carrier_getter = DictGetter()
167
168 @contextmanager
169 def _set_remote_context(self, servicer_context):
170 metadata = servicer_context.invocation_metadata()
171 if metadata:
172 md_dict = {md.key: md.value for md in metadata}
173 ctx = propagators.extract(self._carrier_getter, md_dict)
174 token = attach(ctx)
175 try:
176 yield
177 finally:
178 detach(token)
179 else:
180 yield
181
182 def _start_span(self, handler_call_details, context):
183
184 attributes = {
185 "rpc.method": handler_call_details.method,
186 "rpc.system": "grpc",
187 "rpc.grpc.status_code": grpc.StatusCode.OK,
188 }
189
190 metadata = dict(context.invocation_metadata())
191 if "user-agent" in metadata:
192 attributes["rpc.user_agent"] = metadata["user-agent"]
193
194 # Split up the peer to keep with how other telemetry sources
195 # do it. This looks like:
196 # * ipv6:[::1]:57284
197 # * ipv4:127.0.0.1:57284
198 # * ipv4:10.2.1.1:57284,127.0.0.1:57284
199 #
200 try:
201 host, port = (
202 context.peer().split(",")[0].split(":", 1)[1].rsplit(":", 1)
203 )
204
205 # other telemetry sources convert this, so we will too
206 if host in ("[::1]", "127.0.0.1"):
207 host = "localhost"
208
209 attributes.update({"net.peer.name": host, "net.peer.port": port})
210 except IndexError:
211 logger.warning("Failed to parse peer address '%s'", context.peer())
212
213 return self._tracer.start_as_current_span(
214 name=handler_call_details.method,
215 kind=trace.SpanKind.SERVER,
216 attributes=attributes,
217 )
218
219 def intercept_service(self, continuation, handler_call_details):
220 def telemetry_wrapper(behavior, request_streaming, response_streaming):
221 def telemetry_interceptor(request_or_iterator, context):
222
223 with self._set_remote_context(context):
224 with self._start_span(
225 handler_call_details, context
226 ) as span:
227 # wrap the context
228 context = _OpenTelemetryServicerContext(context, span)
229
230 # And now we run the actual RPC.
231 try:
232 return behavior(request_or_iterator, context)
233 except Exception as error:
234 # Bare exceptions are likely to be gRPC aborts, which
235 # we handle in our context wrapper.
236 # Here, we're interested in uncaught exceptions.
237 # pylint:disable=unidiomatic-typecheck
238 if type(error) != Exception:
239 span.record_exception(error)
240 raise error
241
242 return telemetry_interceptor
243
244 return _wrap_rpc_behavior(
245 continuation(handler_call_details), telemetry_wrapper
246 )
247
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/instrumentation/opentelemetry-instrumentation-grpc/src/opentelemetry/instrumentation/grpc/_server.py b/instrumentation/opentelemetry-instrumentation-grpc/src/opentelemetry/instrumentation/grpc/_server.py
--- a/instrumentation/opentelemetry-instrumentation-grpc/src/opentelemetry/instrumentation/grpc/_server.py
+++ b/instrumentation/opentelemetry-instrumentation-grpc/src/opentelemetry/instrumentation/grpc/_server.py
@@ -113,9 +113,12 @@
def abort(self, code, details):
self.code = code
self.details = details
- self._active_span.set_attribute("rpc.grpc.status_code", code.name)
+ self._active_span.set_attribute("rpc.grpc.status_code", code.value[0])
self._active_span.set_status(
- Status(status_code=StatusCode.ERROR, description=details)
+ Status(
+ status_code=StatusCode.ERROR,
+ description="{}:{}".format(code, details),
+ )
)
return self._servicer_context.abort(code, details)
@@ -126,17 +129,25 @@
self.code = code
# use details if we already have it, otherwise the status description
details = self.details or code.value[1]
- self._active_span.set_attribute("rpc.grpc.status_code", code.name)
- self._active_span.set_status(
- Status(status_code=StatusCode.ERROR, description=details)
- )
+ self._active_span.set_attribute("rpc.grpc.status_code", code.value[0])
+ if code != grpc.StatusCode.OK:
+ self._active_span.set_status(
+ Status(
+ status_code=StatusCode.ERROR,
+ description="{}:{}".format(code, details),
+ )
+ )
return self._servicer_context.set_code(code)
def set_details(self, details):
self.details = details
- self._active_span.set_status(
- Status(status_code=StatusCode.ERROR, description=details)
- )
+ if self.code != grpc.StatusCode.OK:
+ self._active_span.set_status(
+ Status(
+ status_code=StatusCode.ERROR,
+ description="{}:{}".format(self.code, details),
+ )
+ )
return self._servicer_context.set_details(details)
@@ -181,12 +192,20 @@
def _start_span(self, handler_call_details, context):
+ # standard attributes
attributes = {
- "rpc.method": handler_call_details.method,
"rpc.system": "grpc",
- "rpc.grpc.status_code": grpc.StatusCode.OK,
+ "rpc.grpc.status_code": grpc.StatusCode.OK.value[0],
}
+ # if we have details about the call, split into service and method
+ if handler_call_details.method:
+ service, method = handler_call_details.method.lstrip("/").split(
+ "/", 1
+ )
+ attributes.update({"rpc.method": method, "rpc.service": service})
+
+ # add some attributes from the metadata
metadata = dict(context.invocation_metadata())
if "user-agent" in metadata:
attributes["rpc.user_agent"] = metadata["user-agent"]
@@ -198,15 +217,15 @@
# * ipv4:10.2.1.1:57284,127.0.0.1:57284
#
try:
- host, port = (
+ ip, port = (
context.peer().split(",")[0].split(":", 1)[1].rsplit(":", 1)
)
+ attributes.update({"net.peer.ip": ip, "net.peer.port": port})
- # other telemetry sources convert this, so we will too
- if host in ("[::1]", "127.0.0.1"):
- host = "localhost"
+ # other telemetry sources add this, so we will too
+ if ip in ("[::1]", "127.0.0.1"):
+ attributes["net.peer.name"] = "localhost"
- attributes.update({"net.peer.name": host, "net.peer.port": port})
except IndexError:
logger.warning("Failed to parse peer address '%s'", context.peer())
|
{"golden_diff": "diff --git a/instrumentation/opentelemetry-instrumentation-grpc/src/opentelemetry/instrumentation/grpc/_server.py b/instrumentation/opentelemetry-instrumentation-grpc/src/opentelemetry/instrumentation/grpc/_server.py\n--- a/instrumentation/opentelemetry-instrumentation-grpc/src/opentelemetry/instrumentation/grpc/_server.py\n+++ b/instrumentation/opentelemetry-instrumentation-grpc/src/opentelemetry/instrumentation/grpc/_server.py\n@@ -113,9 +113,12 @@\n def abort(self, code, details):\n self.code = code\n self.details = details\n- self._active_span.set_attribute(\"rpc.grpc.status_code\", code.name)\n+ self._active_span.set_attribute(\"rpc.grpc.status_code\", code.value[0])\n self._active_span.set_status(\n- Status(status_code=StatusCode.ERROR, description=details)\n+ Status(\n+ status_code=StatusCode.ERROR,\n+ description=\"{}:{}\".format(code, details),\n+ )\n )\n return self._servicer_context.abort(code, details)\n \n@@ -126,17 +129,25 @@\n self.code = code\n # use details if we already have it, otherwise the status description\n details = self.details or code.value[1]\n- self._active_span.set_attribute(\"rpc.grpc.status_code\", code.name)\n- self._active_span.set_status(\n- Status(status_code=StatusCode.ERROR, description=details)\n- )\n+ self._active_span.set_attribute(\"rpc.grpc.status_code\", code.value[0])\n+ if code != grpc.StatusCode.OK:\n+ self._active_span.set_status(\n+ Status(\n+ status_code=StatusCode.ERROR,\n+ description=\"{}:{}\".format(code, details),\n+ )\n+ )\n return self._servicer_context.set_code(code)\n \n def set_details(self, details):\n self.details = details\n- self._active_span.set_status(\n- Status(status_code=StatusCode.ERROR, description=details)\n- )\n+ if self.code != grpc.StatusCode.OK:\n+ self._active_span.set_status(\n+ Status(\n+ status_code=StatusCode.ERROR,\n+ description=\"{}:{}\".format(self.code, details),\n+ )\n+ )\n return self._servicer_context.set_details(details)\n \n \n@@ -181,12 +192,20 @@\n \n def _start_span(self, handler_call_details, context):\n \n+ # standard attributes\n attributes = {\n- \"rpc.method\": handler_call_details.method,\n \"rpc.system\": \"grpc\",\n- \"rpc.grpc.status_code\": grpc.StatusCode.OK,\n+ \"rpc.grpc.status_code\": grpc.StatusCode.OK.value[0],\n }\n \n+ # if we have details about the call, split into service and method\n+ if handler_call_details.method:\n+ service, method = handler_call_details.method.lstrip(\"/\").split(\n+ \"/\", 1\n+ )\n+ attributes.update({\"rpc.method\": method, \"rpc.service\": service})\n+\n+ # add some attributes from the metadata\n metadata = dict(context.invocation_metadata())\n if \"user-agent\" in metadata:\n attributes[\"rpc.user_agent\"] = metadata[\"user-agent\"]\n@@ -198,15 +217,15 @@\n # * ipv4:10.2.1.1:57284,127.0.0.1:57284\n #\n try:\n- host, port = (\n+ ip, port = (\n context.peer().split(\",\")[0].split(\":\", 1)[1].rsplit(\":\", 1)\n )\n+ attributes.update({\"net.peer.ip\": ip, \"net.peer.port\": port})\n \n- # other telemetry sources convert this, so we will too\n- if host in (\"[::1]\", \"127.0.0.1\"):\n- host = \"localhost\"\n+ # other telemetry sources add this, so we will too\n+ if ip in (\"[::1]\", \"127.0.0.1\"):\n+ attributes[\"net.peer.name\"] = \"localhost\"\n \n- attributes.update({\"net.peer.name\": host, \"net.peer.port\": port})\n except IndexError:\n logger.warning(\"Failed to parse peer address '%s'\", context.peer())\n", "issue": "Make sure rpc instrumentations follow semantic conventions\nSpecs: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/rpc.md\n", "before_files": [{"content": "# Copyright The OpenTelemetry 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 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\n# pylint:disable=relative-beyond-top-level\n# pylint:disable=arguments-differ\n# pylint:disable=no-member\n# pylint:disable=signature-differs\n\n\"\"\"\nImplementation of the service-side open-telemetry interceptor.\n\"\"\"\n\nimport logging\nfrom contextlib import contextmanager\n\nimport grpc\n\nfrom opentelemetry import propagators, trace\nfrom opentelemetry.context import attach, detach\nfrom opentelemetry.trace.propagation.textmap import DictGetter\nfrom opentelemetry.trace.status import Status, StatusCode\n\nlogger = logging.getLogger(__name__)\n\n\n# wrap an RPC call\n# see https://github.com/grpc/grpc/issues/18191\ndef _wrap_rpc_behavior(handler, continuation):\n if handler is None:\n return None\n\n if handler.request_streaming and handler.response_streaming:\n behavior_fn = handler.stream_stream\n handler_factory = grpc.stream_stream_rpc_method_handler\n elif handler.request_streaming and not handler.response_streaming:\n behavior_fn = handler.stream_unary\n handler_factory = grpc.stream_unary_rpc_method_handler\n elif not handler.request_streaming and handler.response_streaming:\n behavior_fn = handler.unary_stream\n handler_factory = grpc.unary_stream_rpc_method_handler\n else:\n behavior_fn = handler.unary_unary\n handler_factory = grpc.unary_unary_rpc_method_handler\n\n return handler_factory(\n continuation(\n behavior_fn, handler.request_streaming, handler.response_streaming\n ),\n request_deserializer=handler.request_deserializer,\n response_serializer=handler.response_serializer,\n )\n\n\n# pylint:disable=abstract-method\nclass _OpenTelemetryServicerContext(grpc.ServicerContext):\n def __init__(self, servicer_context, active_span):\n self._servicer_context = servicer_context\n self._active_span = active_span\n self.code = grpc.StatusCode.OK\n self.details = None\n super().__init__()\n\n def is_active(self, *args, **kwargs):\n return self._servicer_context.is_active(*args, **kwargs)\n\n def time_remaining(self, *args, **kwargs):\n return self._servicer_context.time_remaining(*args, **kwargs)\n\n def cancel(self, *args, **kwargs):\n return self._servicer_context.cancel(*args, **kwargs)\n\n def add_callback(self, *args, **kwargs):\n return self._servicer_context.add_callback(*args, **kwargs)\n\n def disable_next_message_compression(self):\n return self._service_context.disable_next_message_compression()\n\n def invocation_metadata(self, *args, **kwargs):\n return self._servicer_context.invocation_metadata(*args, **kwargs)\n\n def peer(self):\n return self._servicer_context.peer()\n\n def peer_identities(self):\n return self._servicer_context.peer_identities()\n\n def peer_identity_key(self):\n return self._servicer_context.peer_identity_key()\n\n def auth_context(self):\n return self._servicer_context.auth_context()\n\n def set_compression(self, compression):\n return self._servicer_context.set_compression(compression)\n\n def send_initial_metadata(self, *args, **kwargs):\n return self._servicer_context.send_initial_metadata(*args, **kwargs)\n\n def set_trailing_metadata(self, *args, **kwargs):\n return self._servicer_context.set_trailing_metadata(*args, **kwargs)\n\n def abort(self, code, details):\n self.code = code\n self.details = details\n self._active_span.set_attribute(\"rpc.grpc.status_code\", code.name)\n self._active_span.set_status(\n Status(status_code=StatusCode.ERROR, description=details)\n )\n return self._servicer_context.abort(code, details)\n\n def abort_with_status(self, status):\n return self._servicer_context.abort_with_status(status)\n\n def set_code(self, code):\n self.code = code\n # use details if we already have it, otherwise the status description\n details = self.details or code.value[1]\n self._active_span.set_attribute(\"rpc.grpc.status_code\", code.name)\n self._active_span.set_status(\n Status(status_code=StatusCode.ERROR, description=details)\n )\n return self._servicer_context.set_code(code)\n\n def set_details(self, details):\n self.details = details\n self._active_span.set_status(\n Status(status_code=StatusCode.ERROR, description=details)\n )\n return self._servicer_context.set_details(details)\n\n\n# pylint:disable=abstract-method\n# pylint:disable=no-self-use\n# pylint:disable=unused-argument\nclass OpenTelemetryServerInterceptor(grpc.ServerInterceptor):\n \"\"\"\n A gRPC server interceptor, to add OpenTelemetry.\n\n Usage::\n\n tracer = some OpenTelemetry tracer\n\n interceptors = [\n OpenTelemetryServerInterceptor(tracer),\n ]\n\n server = grpc.server(\n futures.ThreadPoolExecutor(max_workers=concurrency),\n interceptors = interceptors)\n\n \"\"\"\n\n def __init__(self, tracer):\n self._tracer = tracer\n self._carrier_getter = DictGetter()\n\n @contextmanager\n def _set_remote_context(self, servicer_context):\n metadata = servicer_context.invocation_metadata()\n if metadata:\n md_dict = {md.key: md.value for md in metadata}\n ctx = propagators.extract(self._carrier_getter, md_dict)\n token = attach(ctx)\n try:\n yield\n finally:\n detach(token)\n else:\n yield\n\n def _start_span(self, handler_call_details, context):\n\n attributes = {\n \"rpc.method\": handler_call_details.method,\n \"rpc.system\": \"grpc\",\n \"rpc.grpc.status_code\": grpc.StatusCode.OK,\n }\n\n metadata = dict(context.invocation_metadata())\n if \"user-agent\" in metadata:\n attributes[\"rpc.user_agent\"] = metadata[\"user-agent\"]\n\n # Split up the peer to keep with how other telemetry sources\n # do it. This looks like:\n # * ipv6:[::1]:57284\n # * ipv4:127.0.0.1:57284\n # * ipv4:10.2.1.1:57284,127.0.0.1:57284\n #\n try:\n host, port = (\n context.peer().split(\",\")[0].split(\":\", 1)[1].rsplit(\":\", 1)\n )\n\n # other telemetry sources convert this, so we will too\n if host in (\"[::1]\", \"127.0.0.1\"):\n host = \"localhost\"\n\n attributes.update({\"net.peer.name\": host, \"net.peer.port\": port})\n except IndexError:\n logger.warning(\"Failed to parse peer address '%s'\", context.peer())\n\n return self._tracer.start_as_current_span(\n name=handler_call_details.method,\n kind=trace.SpanKind.SERVER,\n attributes=attributes,\n )\n\n def intercept_service(self, continuation, handler_call_details):\n def telemetry_wrapper(behavior, request_streaming, response_streaming):\n def telemetry_interceptor(request_or_iterator, context):\n\n with self._set_remote_context(context):\n with self._start_span(\n handler_call_details, context\n ) as span:\n # wrap the context\n context = _OpenTelemetryServicerContext(context, span)\n\n # And now we run the actual RPC.\n try:\n return behavior(request_or_iterator, context)\n except Exception as error:\n # Bare exceptions are likely to be gRPC aborts, which\n # we handle in our context wrapper.\n # Here, we're interested in uncaught exceptions.\n # pylint:disable=unidiomatic-typecheck\n if type(error) != Exception:\n span.record_exception(error)\n raise error\n\n return telemetry_interceptor\n\n return _wrap_rpc_behavior(\n continuation(handler_call_details), telemetry_wrapper\n )\n", "path": "instrumentation/opentelemetry-instrumentation-grpc/src/opentelemetry/instrumentation/grpc/_server.py"}], "after_files": [{"content": "# Copyright The OpenTelemetry 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 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\n# pylint:disable=relative-beyond-top-level\n# pylint:disable=arguments-differ\n# pylint:disable=no-member\n# pylint:disable=signature-differs\n\n\"\"\"\nImplementation of the service-side open-telemetry interceptor.\n\"\"\"\n\nimport logging\nfrom contextlib import contextmanager\n\nimport grpc\n\nfrom opentelemetry import propagators, trace\nfrom opentelemetry.context import attach, detach\nfrom opentelemetry.trace.propagation.textmap import DictGetter\nfrom opentelemetry.trace.status import Status, StatusCode\n\nlogger = logging.getLogger(__name__)\n\n\n# wrap an RPC call\n# see https://github.com/grpc/grpc/issues/18191\ndef _wrap_rpc_behavior(handler, continuation):\n if handler is None:\n return None\n\n if handler.request_streaming and handler.response_streaming:\n behavior_fn = handler.stream_stream\n handler_factory = grpc.stream_stream_rpc_method_handler\n elif handler.request_streaming and not handler.response_streaming:\n behavior_fn = handler.stream_unary\n handler_factory = grpc.stream_unary_rpc_method_handler\n elif not handler.request_streaming and handler.response_streaming:\n behavior_fn = handler.unary_stream\n handler_factory = grpc.unary_stream_rpc_method_handler\n else:\n behavior_fn = handler.unary_unary\n handler_factory = grpc.unary_unary_rpc_method_handler\n\n return handler_factory(\n continuation(\n behavior_fn, handler.request_streaming, handler.response_streaming\n ),\n request_deserializer=handler.request_deserializer,\n response_serializer=handler.response_serializer,\n )\n\n\n# pylint:disable=abstract-method\nclass _OpenTelemetryServicerContext(grpc.ServicerContext):\n def __init__(self, servicer_context, active_span):\n self._servicer_context = servicer_context\n self._active_span = active_span\n self.code = grpc.StatusCode.OK\n self.details = None\n super().__init__()\n\n def is_active(self, *args, **kwargs):\n return self._servicer_context.is_active(*args, **kwargs)\n\n def time_remaining(self, *args, **kwargs):\n return self._servicer_context.time_remaining(*args, **kwargs)\n\n def cancel(self, *args, **kwargs):\n return self._servicer_context.cancel(*args, **kwargs)\n\n def add_callback(self, *args, **kwargs):\n return self._servicer_context.add_callback(*args, **kwargs)\n\n def disable_next_message_compression(self):\n return self._service_context.disable_next_message_compression()\n\n def invocation_metadata(self, *args, **kwargs):\n return self._servicer_context.invocation_metadata(*args, **kwargs)\n\n def peer(self):\n return self._servicer_context.peer()\n\n def peer_identities(self):\n return self._servicer_context.peer_identities()\n\n def peer_identity_key(self):\n return self._servicer_context.peer_identity_key()\n\n def auth_context(self):\n return self._servicer_context.auth_context()\n\n def set_compression(self, compression):\n return self._servicer_context.set_compression(compression)\n\n def send_initial_metadata(self, *args, **kwargs):\n return self._servicer_context.send_initial_metadata(*args, **kwargs)\n\n def set_trailing_metadata(self, *args, **kwargs):\n return self._servicer_context.set_trailing_metadata(*args, **kwargs)\n\n def abort(self, code, details):\n self.code = code\n self.details = details\n self._active_span.set_attribute(\"rpc.grpc.status_code\", code.value[0])\n self._active_span.set_status(\n Status(\n status_code=StatusCode.ERROR,\n description=\"{}:{}\".format(code, details),\n )\n )\n return self._servicer_context.abort(code, details)\n\n def abort_with_status(self, status):\n return self._servicer_context.abort_with_status(status)\n\n def set_code(self, code):\n self.code = code\n # use details if we already have it, otherwise the status description\n details = self.details or code.value[1]\n self._active_span.set_attribute(\"rpc.grpc.status_code\", code.value[0])\n if code != grpc.StatusCode.OK:\n self._active_span.set_status(\n Status(\n status_code=StatusCode.ERROR,\n description=\"{}:{}\".format(code, details),\n )\n )\n return self._servicer_context.set_code(code)\n\n def set_details(self, details):\n self.details = details\n if self.code != grpc.StatusCode.OK:\n self._active_span.set_status(\n Status(\n status_code=StatusCode.ERROR,\n description=\"{}:{}\".format(self.code, details),\n )\n )\n return self._servicer_context.set_details(details)\n\n\n# pylint:disable=abstract-method\n# pylint:disable=no-self-use\n# pylint:disable=unused-argument\nclass OpenTelemetryServerInterceptor(grpc.ServerInterceptor):\n \"\"\"\n A gRPC server interceptor, to add OpenTelemetry.\n\n Usage::\n\n tracer = some OpenTelemetry tracer\n\n interceptors = [\n OpenTelemetryServerInterceptor(tracer),\n ]\n\n server = grpc.server(\n futures.ThreadPoolExecutor(max_workers=concurrency),\n interceptors = interceptors)\n\n \"\"\"\n\n def __init__(self, tracer):\n self._tracer = tracer\n self._carrier_getter = DictGetter()\n\n @contextmanager\n def _set_remote_context(self, servicer_context):\n metadata = servicer_context.invocation_metadata()\n if metadata:\n md_dict = {md.key: md.value for md in metadata}\n ctx = propagators.extract(self._carrier_getter, md_dict)\n token = attach(ctx)\n try:\n yield\n finally:\n detach(token)\n else:\n yield\n\n def _start_span(self, handler_call_details, context):\n\n # standard attributes\n attributes = {\n \"rpc.system\": \"grpc\",\n \"rpc.grpc.status_code\": grpc.StatusCode.OK.value[0],\n }\n\n # if we have details about the call, split into service and method\n if handler_call_details.method:\n service, method = handler_call_details.method.lstrip(\"/\").split(\n \"/\", 1\n )\n attributes.update({\"rpc.method\": method, \"rpc.service\": service})\n\n # add some attributes from the metadata\n metadata = dict(context.invocation_metadata())\n if \"user-agent\" in metadata:\n attributes[\"rpc.user_agent\"] = metadata[\"user-agent\"]\n\n # Split up the peer to keep with how other telemetry sources\n # do it. This looks like:\n # * ipv6:[::1]:57284\n # * ipv4:127.0.0.1:57284\n # * ipv4:10.2.1.1:57284,127.0.0.1:57284\n #\n try:\n ip, port = (\n context.peer().split(\",\")[0].split(\":\", 1)[1].rsplit(\":\", 1)\n )\n attributes.update({\"net.peer.ip\": ip, \"net.peer.port\": port})\n\n # other telemetry sources add this, so we will too\n if ip in (\"[::1]\", \"127.0.0.1\"):\n attributes[\"net.peer.name\"] = \"localhost\"\n\n except IndexError:\n logger.warning(\"Failed to parse peer address '%s'\", context.peer())\n\n return self._tracer.start_as_current_span(\n name=handler_call_details.method,\n kind=trace.SpanKind.SERVER,\n attributes=attributes,\n )\n\n def intercept_service(self, continuation, handler_call_details):\n def telemetry_wrapper(behavior, request_streaming, response_streaming):\n def telemetry_interceptor(request_or_iterator, context):\n\n with self._set_remote_context(context):\n with self._start_span(\n handler_call_details, context\n ) as span:\n # wrap the context\n context = _OpenTelemetryServicerContext(context, span)\n\n # And now we run the actual RPC.\n try:\n return behavior(request_or_iterator, context)\n except Exception as error:\n # Bare exceptions are likely to be gRPC aborts, which\n # we handle in our context wrapper.\n # Here, we're interested in uncaught exceptions.\n # pylint:disable=unidiomatic-typecheck\n if type(error) != Exception:\n span.record_exception(error)\n raise error\n\n return telemetry_interceptor\n\n return _wrap_rpc_behavior(\n continuation(handler_call_details), telemetry_wrapper\n )\n", "path": "instrumentation/opentelemetry-instrumentation-grpc/src/opentelemetry/instrumentation/grpc/_server.py"}]}
| 2,788 | 947 |
gh_patches_debug_21348
|
rasdani/github-patches
|
git_diff
|
readthedocs__readthedocs.org-7839
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Improve performance for concurrency builds DB query
We start getting timeout when calling `/api/v2/builds/concurrent/` from builders to know `(limit_reached, concurrent, max_concurrent)` for a particular project.
We need to improve the queryset that works over the `Build` model because sometimes it takes ~4s or more. It usually takes ~200ms, so I guess this is because the project is/has subprojects/translations since in that case the query gets more complex.
This is the query we need to optimize,
https://github.com/readthedocs/readthedocs.org/blob/2e9cb8dd85c5f8a55ab085abe58082fe3f2c6799/readthedocs/builds/querysets.py#L129-L177
Sentry issues: https://sentry.io/organizations/read-the-docs/issues/1719520575/?project=148442&query=is%3Aunresolved&statsPeriod=14d
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `readthedocs/builds/querysets.py`
Content:
```
1 """Build and Version QuerySet classes."""
2 import logging
3
4 from django.db import models
5 from django.db.models import Q
6
7 from readthedocs.core.utils.extend import SettingsOverrideObject
8 from readthedocs.projects import constants
9 from readthedocs.projects.models import Project
10
11 from .constants import BUILD_STATE_TRIGGERED, BUILD_STATE_FINISHED
12
13
14 log = logging.getLogger(__name__)
15
16
17 __all__ = ['VersionQuerySet', 'BuildQuerySet', 'RelatedBuildQuerySet']
18
19
20 class VersionQuerySetBase(models.QuerySet):
21
22 """Versions take into account their own privacy_level setting."""
23
24 use_for_related_fields = True
25
26 def _add_user_repos(self, queryset, user):
27 if user.has_perm('builds.view_version'):
28 return self.all()
29 if user.is_authenticated:
30 projects_pk = user.projects.all().values_list('pk', flat=True)
31 user_queryset = self.filter(project__in=projects_pk)
32 queryset = user_queryset | queryset
33 return queryset
34
35 def public(self, user=None, project=None, only_active=True,
36 include_hidden=True, only_built=False):
37 queryset = self.filter(privacy_level=constants.PUBLIC)
38 if user:
39 queryset = self._add_user_repos(queryset, user)
40 if project:
41 queryset = queryset.filter(project=project)
42 if only_active:
43 queryset = queryset.filter(active=True)
44 if only_built:
45 queryset = queryset.filter(built=True)
46 if not include_hidden:
47 queryset = queryset.filter(hidden=False)
48 return queryset.distinct()
49
50 def protected(self, user=None, project=None, only_active=True):
51 queryset = self.filter(
52 privacy_level__in=[constants.PUBLIC, constants.PROTECTED],
53 )
54 if user:
55 queryset = self._add_user_repos(queryset, user)
56 if project:
57 queryset = queryset.filter(project=project)
58 if only_active:
59 queryset = queryset.filter(active=True)
60 return queryset.distinct()
61
62 def private(self, user=None, project=None, only_active=True):
63 queryset = self.filter(privacy_level__in=[constants.PRIVATE])
64 if user:
65 queryset = self._add_user_repos(queryset, user)
66 if project:
67 queryset = queryset.filter(project=project)
68 if only_active:
69 queryset = queryset.filter(active=True)
70 return queryset.distinct()
71
72 def api(self, user=None, detail=True):
73 if detail:
74 return self.public(user, only_active=False)
75
76 queryset = self.none()
77 if user:
78 queryset = self._add_user_repos(queryset, user)
79 return queryset.distinct()
80
81 def for_project(self, project):
82 """Return all versions for a project, including translations."""
83 return self.filter(
84 models.Q(project=project) |
85 models.Q(project__main_language_project=project),
86 )
87
88
89 class VersionQuerySet(SettingsOverrideObject):
90 _default_class = VersionQuerySetBase
91
92
93 class BuildQuerySetBase(models.QuerySet):
94
95 """
96 Build objects that are privacy aware.
97
98 i.e. they take into account the privacy of the Version that they relate to.
99 """
100
101 use_for_related_fields = True
102
103 def _add_user_repos(self, queryset, user=None):
104 if user.has_perm('builds.view_version'):
105 return self.all()
106 if user.is_authenticated:
107 projects_pk = user.projects.all().values_list('pk', flat=True)
108 user_queryset = self.filter(project__in=projects_pk)
109 queryset = user_queryset | queryset
110 return queryset
111
112 def public(self, user=None, project=None):
113 queryset = self.filter(version__privacy_level=constants.PUBLIC)
114 if user:
115 queryset = self._add_user_repos(queryset, user)
116 if project:
117 queryset = queryset.filter(project=project)
118 return queryset.distinct()
119
120 def api(self, user=None, detail=True):
121 if detail:
122 return self.public(user)
123
124 queryset = self.none()
125 if user:
126 queryset = self._add_user_repos(queryset, user)
127 return queryset.distinct()
128
129 def concurrent(self, project):
130 """
131 Check if the max build concurrency for this project was reached.
132
133 - regular project: counts concurrent builds
134
135 - translation: concurrent builds of all the translations + builds of main project
136
137 .. note::
138
139 If the project/translation belongs to an organization, we count all concurrent
140 builds for all the projects from the organization.
141
142 :rtype: tuple
143 :returns: limit_reached, number of concurrent builds, number of max concurrent
144 """
145 limit_reached = False
146 query = Q(project__slug=project.slug)
147
148 if project.main_language_project:
149 # Project is a translation, counts all builds of all the translations
150 query |= Q(project__main_language_project=project.main_language_project)
151 query |= Q(project__slug=project.main_language_project.slug)
152
153 elif project.translations.exists():
154 # The project has translations, counts their builds as well
155 query |= Q(project__in=project.translations.all())
156
157 # If the project belongs to an organization, count all the projects
158 # from this organization as well
159 organization = project.organizations.first()
160 if organization:
161 query |= Q(project__in=organization.projects.all())
162
163 concurrent = (
164 self.filter(query)
165 .exclude(state__in=[BUILD_STATE_TRIGGERED, BUILD_STATE_FINISHED])
166 ).distinct().count()
167
168 max_concurrent = Project.objects.max_concurrent_builds(project)
169 log.info(
170 'Concurrent builds. project=%s running=%s max=%s',
171 project.slug,
172 concurrent,
173 max_concurrent,
174 )
175 if concurrent >= max_concurrent:
176 limit_reached = True
177 return (limit_reached, concurrent, max_concurrent)
178
179
180 class BuildQuerySet(SettingsOverrideObject):
181 _default_class = BuildQuerySetBase
182
183
184 class RelatedBuildQuerySetBase(models.QuerySet):
185
186 """For models with association to a project through :py:class:`Build`."""
187
188 use_for_related_fields = True
189
190 def _add_user_repos(self, queryset, user=None):
191 if user.has_perm('builds.view_version'):
192 return self.all()
193 if user.is_authenticated:
194 projects_pk = user.projects.all().values_list('pk', flat=True)
195 user_queryset = self.filter(build__project__in=projects_pk)
196 queryset = user_queryset | queryset
197 return queryset
198
199 def public(self, user=None, project=None):
200 queryset = self.filter(build__version__privacy_level=constants.PUBLIC)
201 if user:
202 queryset = self._add_user_repos(queryset, user)
203 if project:
204 queryset = queryset.filter(build__project=project)
205 return queryset.distinct()
206
207 def api(self, user=None):
208 return self.public(user)
209
210
211 class RelatedBuildQuerySet(SettingsOverrideObject):
212 _default_class = RelatedBuildQuerySetBase
213 _override_setting = 'RELATED_BUILD_MANAGER'
214
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/readthedocs/builds/querysets.py b/readthedocs/builds/querysets.py
--- a/readthedocs/builds/querysets.py
+++ b/readthedocs/builds/querysets.py
@@ -1,8 +1,10 @@
"""Build and Version QuerySet classes."""
+import datetime
import logging
from django.db import models
from django.db.models import Q
+from django.utils import timezone
from readthedocs.core.utils.extend import SettingsOverrideObject
from readthedocs.projects import constants
@@ -143,7 +145,11 @@
:returns: limit_reached, number of concurrent builds, number of max concurrent
"""
limit_reached = False
- query = Q(project__slug=project.slug)
+ query = Q(
+ project__slug=project.slug,
+ # Limit builds to 5 hours ago to speed up the query
+ date__gte=timezone.now() - datetime.timedelta(hours=5),
+ )
if project.main_language_project:
# Project is a translation, counts all builds of all the translations
|
{"golden_diff": "diff --git a/readthedocs/builds/querysets.py b/readthedocs/builds/querysets.py\n--- a/readthedocs/builds/querysets.py\n+++ b/readthedocs/builds/querysets.py\n@@ -1,8 +1,10 @@\n \"\"\"Build and Version QuerySet classes.\"\"\"\n+import datetime\n import logging\n \n from django.db import models\n from django.db.models import Q\n+from django.utils import timezone\n \n from readthedocs.core.utils.extend import SettingsOverrideObject\n from readthedocs.projects import constants\n@@ -143,7 +145,11 @@\n :returns: limit_reached, number of concurrent builds, number of max concurrent\n \"\"\"\n limit_reached = False\n- query = Q(project__slug=project.slug)\n+ query = Q(\n+ project__slug=project.slug,\n+ # Limit builds to 5 hours ago to speed up the query\n+ date__gte=timezone.now() - datetime.timedelta(hours=5),\n+ )\n \n if project.main_language_project:\n # Project is a translation, counts all builds of all the translations\n", "issue": "Improve performance for concurrency builds DB query\nWe start getting timeout when calling `/api/v2/builds/concurrent/` from builders to know `(limit_reached, concurrent, max_concurrent)` for a particular project.\r\n\r\nWe need to improve the queryset that works over the `Build` model because sometimes it takes ~4s or more. It usually takes ~200ms, so I guess this is because the project is/has subprojects/translations since in that case the query gets more complex.\r\n\r\nThis is the query we need to optimize,\r\n\r\nhttps://github.com/readthedocs/readthedocs.org/blob/2e9cb8dd85c5f8a55ab085abe58082fe3f2c6799/readthedocs/builds/querysets.py#L129-L177\r\n\r\nSentry issues: https://sentry.io/organizations/read-the-docs/issues/1719520575/?project=148442&query=is%3Aunresolved&statsPeriod=14d\n", "before_files": [{"content": "\"\"\"Build and Version QuerySet classes.\"\"\"\nimport logging\n\nfrom django.db import models\nfrom django.db.models import Q\n\nfrom readthedocs.core.utils.extend import SettingsOverrideObject\nfrom readthedocs.projects import constants\nfrom readthedocs.projects.models import Project\n\nfrom .constants import BUILD_STATE_TRIGGERED, BUILD_STATE_FINISHED\n\n\nlog = logging.getLogger(__name__)\n\n\n__all__ = ['VersionQuerySet', 'BuildQuerySet', 'RelatedBuildQuerySet']\n\n\nclass VersionQuerySetBase(models.QuerySet):\n\n \"\"\"Versions take into account their own privacy_level setting.\"\"\"\n\n use_for_related_fields = True\n\n def _add_user_repos(self, queryset, user):\n if user.has_perm('builds.view_version'):\n return self.all()\n if user.is_authenticated:\n projects_pk = user.projects.all().values_list('pk', flat=True)\n user_queryset = self.filter(project__in=projects_pk)\n queryset = user_queryset | queryset\n return queryset\n\n def public(self, user=None, project=None, only_active=True,\n include_hidden=True, only_built=False):\n queryset = self.filter(privacy_level=constants.PUBLIC)\n if user:\n queryset = self._add_user_repos(queryset, user)\n if project:\n queryset = queryset.filter(project=project)\n if only_active:\n queryset = queryset.filter(active=True)\n if only_built:\n queryset = queryset.filter(built=True)\n if not include_hidden:\n queryset = queryset.filter(hidden=False)\n return queryset.distinct()\n\n def protected(self, user=None, project=None, only_active=True):\n queryset = self.filter(\n privacy_level__in=[constants.PUBLIC, constants.PROTECTED],\n )\n if user:\n queryset = self._add_user_repos(queryset, user)\n if project:\n queryset = queryset.filter(project=project)\n if only_active:\n queryset = queryset.filter(active=True)\n return queryset.distinct()\n\n def private(self, user=None, project=None, only_active=True):\n queryset = self.filter(privacy_level__in=[constants.PRIVATE])\n if user:\n queryset = self._add_user_repos(queryset, user)\n if project:\n queryset = queryset.filter(project=project)\n if only_active:\n queryset = queryset.filter(active=True)\n return queryset.distinct()\n\n def api(self, user=None, detail=True):\n if detail:\n return self.public(user, only_active=False)\n\n queryset = self.none()\n if user:\n queryset = self._add_user_repos(queryset, user)\n return queryset.distinct()\n\n def for_project(self, project):\n \"\"\"Return all versions for a project, including translations.\"\"\"\n return self.filter(\n models.Q(project=project) |\n models.Q(project__main_language_project=project),\n )\n\n\nclass VersionQuerySet(SettingsOverrideObject):\n _default_class = VersionQuerySetBase\n\n\nclass BuildQuerySetBase(models.QuerySet):\n\n \"\"\"\n Build objects that are privacy aware.\n\n i.e. they take into account the privacy of the Version that they relate to.\n \"\"\"\n\n use_for_related_fields = True\n\n def _add_user_repos(self, queryset, user=None):\n if user.has_perm('builds.view_version'):\n return self.all()\n if user.is_authenticated:\n projects_pk = user.projects.all().values_list('pk', flat=True)\n user_queryset = self.filter(project__in=projects_pk)\n queryset = user_queryset | queryset\n return queryset\n\n def public(self, user=None, project=None):\n queryset = self.filter(version__privacy_level=constants.PUBLIC)\n if user:\n queryset = self._add_user_repos(queryset, user)\n if project:\n queryset = queryset.filter(project=project)\n return queryset.distinct()\n\n def api(self, user=None, detail=True):\n if detail:\n return self.public(user)\n\n queryset = self.none()\n if user:\n queryset = self._add_user_repos(queryset, user)\n return queryset.distinct()\n\n def concurrent(self, project):\n \"\"\"\n Check if the max build concurrency for this project was reached.\n\n - regular project: counts concurrent builds\n\n - translation: concurrent builds of all the translations + builds of main project\n\n .. note::\n\n If the project/translation belongs to an organization, we count all concurrent\n builds for all the projects from the organization.\n\n :rtype: tuple\n :returns: limit_reached, number of concurrent builds, number of max concurrent\n \"\"\"\n limit_reached = False\n query = Q(project__slug=project.slug)\n\n if project.main_language_project:\n # Project is a translation, counts all builds of all the translations\n query |= Q(project__main_language_project=project.main_language_project)\n query |= Q(project__slug=project.main_language_project.slug)\n\n elif project.translations.exists():\n # The project has translations, counts their builds as well\n query |= Q(project__in=project.translations.all())\n\n # If the project belongs to an organization, count all the projects\n # from this organization as well\n organization = project.organizations.first()\n if organization:\n query |= Q(project__in=organization.projects.all())\n\n concurrent = (\n self.filter(query)\n .exclude(state__in=[BUILD_STATE_TRIGGERED, BUILD_STATE_FINISHED])\n ).distinct().count()\n\n max_concurrent = Project.objects.max_concurrent_builds(project)\n log.info(\n 'Concurrent builds. project=%s running=%s max=%s',\n project.slug,\n concurrent,\n max_concurrent,\n )\n if concurrent >= max_concurrent:\n limit_reached = True\n return (limit_reached, concurrent, max_concurrent)\n\n\nclass BuildQuerySet(SettingsOverrideObject):\n _default_class = BuildQuerySetBase\n\n\nclass RelatedBuildQuerySetBase(models.QuerySet):\n\n \"\"\"For models with association to a project through :py:class:`Build`.\"\"\"\n\n use_for_related_fields = True\n\n def _add_user_repos(self, queryset, user=None):\n if user.has_perm('builds.view_version'):\n return self.all()\n if user.is_authenticated:\n projects_pk = user.projects.all().values_list('pk', flat=True)\n user_queryset = self.filter(build__project__in=projects_pk)\n queryset = user_queryset | queryset\n return queryset\n\n def public(self, user=None, project=None):\n queryset = self.filter(build__version__privacy_level=constants.PUBLIC)\n if user:\n queryset = self._add_user_repos(queryset, user)\n if project:\n queryset = queryset.filter(build__project=project)\n return queryset.distinct()\n\n def api(self, user=None):\n return self.public(user)\n\n\nclass RelatedBuildQuerySet(SettingsOverrideObject):\n _default_class = RelatedBuildQuerySetBase\n _override_setting = 'RELATED_BUILD_MANAGER'\n", "path": "readthedocs/builds/querysets.py"}], "after_files": [{"content": "\"\"\"Build and Version QuerySet classes.\"\"\"\nimport datetime\nimport logging\n\nfrom django.db import models\nfrom django.db.models import Q\nfrom django.utils import timezone\n\nfrom readthedocs.core.utils.extend import SettingsOverrideObject\nfrom readthedocs.projects import constants\nfrom readthedocs.projects.models import Project\n\nfrom .constants import BUILD_STATE_TRIGGERED, BUILD_STATE_FINISHED\n\n\nlog = logging.getLogger(__name__)\n\n\n__all__ = ['VersionQuerySet', 'BuildQuerySet', 'RelatedBuildQuerySet']\n\n\nclass VersionQuerySetBase(models.QuerySet):\n\n \"\"\"Versions take into account their own privacy_level setting.\"\"\"\n\n use_for_related_fields = True\n\n def _add_user_repos(self, queryset, user):\n if user.has_perm('builds.view_version'):\n return self.all()\n if user.is_authenticated:\n projects_pk = user.projects.all().values_list('pk', flat=True)\n user_queryset = self.filter(project__in=projects_pk)\n queryset = user_queryset | queryset\n return queryset\n\n def public(self, user=None, project=None, only_active=True,\n include_hidden=True, only_built=False):\n queryset = self.filter(privacy_level=constants.PUBLIC)\n if user:\n queryset = self._add_user_repos(queryset, user)\n if project:\n queryset = queryset.filter(project=project)\n if only_active:\n queryset = queryset.filter(active=True)\n if only_built:\n queryset = queryset.filter(built=True)\n if not include_hidden:\n queryset = queryset.filter(hidden=False)\n return queryset.distinct()\n\n def protected(self, user=None, project=None, only_active=True):\n queryset = self.filter(\n privacy_level__in=[constants.PUBLIC, constants.PROTECTED],\n )\n if user:\n queryset = self._add_user_repos(queryset, user)\n if project:\n queryset = queryset.filter(project=project)\n if only_active:\n queryset = queryset.filter(active=True)\n return queryset.distinct()\n\n def private(self, user=None, project=None, only_active=True):\n queryset = self.filter(privacy_level__in=[constants.PRIVATE])\n if user:\n queryset = self._add_user_repos(queryset, user)\n if project:\n queryset = queryset.filter(project=project)\n if only_active:\n queryset = queryset.filter(active=True)\n return queryset.distinct()\n\n def api(self, user=None, detail=True):\n if detail:\n return self.public(user, only_active=False)\n\n queryset = self.none()\n if user:\n queryset = self._add_user_repos(queryset, user)\n return queryset.distinct()\n\n def for_project(self, project):\n \"\"\"Return all versions for a project, including translations.\"\"\"\n return self.filter(\n models.Q(project=project) |\n models.Q(project__main_language_project=project),\n )\n\n\nclass VersionQuerySet(SettingsOverrideObject):\n _default_class = VersionQuerySetBase\n\n\nclass BuildQuerySetBase(models.QuerySet):\n\n \"\"\"\n Build objects that are privacy aware.\n\n i.e. they take into account the privacy of the Version that they relate to.\n \"\"\"\n\n use_for_related_fields = True\n\n def _add_user_repos(self, queryset, user=None):\n if user.has_perm('builds.view_version'):\n return self.all()\n if user.is_authenticated:\n projects_pk = user.projects.all().values_list('pk', flat=True)\n user_queryset = self.filter(project__in=projects_pk)\n queryset = user_queryset | queryset\n return queryset\n\n def public(self, user=None, project=None):\n queryset = self.filter(version__privacy_level=constants.PUBLIC)\n if user:\n queryset = self._add_user_repos(queryset, user)\n if project:\n queryset = queryset.filter(project=project)\n return queryset.distinct()\n\n def api(self, user=None, detail=True):\n if detail:\n return self.public(user)\n\n queryset = self.none()\n if user:\n queryset = self._add_user_repos(queryset, user)\n return queryset.distinct()\n\n def concurrent(self, project):\n \"\"\"\n Check if the max build concurrency for this project was reached.\n\n - regular project: counts concurrent builds\n\n - translation: concurrent builds of all the translations + builds of main project\n\n .. note::\n\n If the project/translation belongs to an organization, we count all concurrent\n builds for all the projects from the organization.\n\n :rtype: tuple\n :returns: limit_reached, number of concurrent builds, number of max concurrent\n \"\"\"\n limit_reached = False\n query = Q(\n project__slug=project.slug,\n # Limit builds to 5 hours ago to speed up the query\n date__gte=timezone.now() - datetime.timedelta(hours=5),\n )\n\n if project.main_language_project:\n # Project is a translation, counts all builds of all the translations\n query |= Q(project__main_language_project=project.main_language_project)\n query |= Q(project__slug=project.main_language_project.slug)\n\n elif project.translations.exists():\n # The project has translations, counts their builds as well\n query |= Q(project__in=project.translations.all())\n\n # If the project belongs to an organization, count all the projects\n # from this organization as well\n organization = project.organizations.first()\n if organization:\n query |= Q(project__in=organization.projects.all())\n\n concurrent = (\n self.filter(query)\n .exclude(state__in=[BUILD_STATE_TRIGGERED, BUILD_STATE_FINISHED])\n ).distinct().count()\n\n max_concurrent = Project.objects.max_concurrent_builds(project)\n log.info(\n 'Concurrent builds. project=%s running=%s max=%s',\n project.slug,\n concurrent,\n max_concurrent,\n )\n if concurrent >= max_concurrent:\n limit_reached = True\n return (limit_reached, concurrent, max_concurrent)\n\n\nclass BuildQuerySet(SettingsOverrideObject):\n _default_class = BuildQuerySetBase\n\n\nclass RelatedBuildQuerySetBase(models.QuerySet):\n\n \"\"\"For models with association to a project through :py:class:`Build`.\"\"\"\n\n use_for_related_fields = True\n\n def _add_user_repos(self, queryset, user=None):\n if user.has_perm('builds.view_version'):\n return self.all()\n if user.is_authenticated:\n projects_pk = user.projects.all().values_list('pk', flat=True)\n user_queryset = self.filter(build__project__in=projects_pk)\n queryset = user_queryset | queryset\n return queryset\n\n def public(self, user=None, project=None):\n queryset = self.filter(build__version__privacy_level=constants.PUBLIC)\n if user:\n queryset = self._add_user_repos(queryset, user)\n if project:\n queryset = queryset.filter(build__project=project)\n return queryset.distinct()\n\n def api(self, user=None):\n return self.public(user)\n\n\nclass RelatedBuildQuerySet(SettingsOverrideObject):\n _default_class = RelatedBuildQuerySetBase\n _override_setting = 'RELATED_BUILD_MANAGER'\n", "path": "readthedocs/builds/querysets.py"}]}
| 2,517 | 237 |
gh_patches_debug_6683
|
rasdani/github-patches
|
git_diff
|
TabbycatDebate__tabbycat-1178
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Email draw/custom email/motions page formatting error
Running the latest develop branch v2.3.0A.
The message box on the email draw/custom email motions page is obscured/broken as per the picture running Windows 10/Google Chrome.
Error reproduced on a Mac/Google Chrome.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `tabbycat/notifications/forms.py`
Content:
```
1 from django import forms
2 from django.conf import settings
3 from django.core.mail import send_mail
4 from django.utils.translation import gettext as _, gettext_lazy
5 from django_summernote.widgets import SummernoteWidget
6
7
8 class TestEmailForm(forms.Form):
9 """Simple form that just sends a test email."""
10
11 recipient = forms.EmailField(label=gettext_lazy("Recipient email address"), required=True)
12
13 def send_email(self, host):
14 send_mail(
15 _("Test email from %(host)s") % {'host': host},
16 _("Congratulations! If you're reading this message, your email "
17 "backend on %(host)s looks all good to go!") % {'host': host},
18 settings.DEFAULT_FROM_EMAIL,
19 [self.cleaned_data['recipient']],
20 )
21 return self.cleaned_data['recipient']
22
23
24 class BasicEmailForm(forms.Form):
25 """A base class for an email form with fields for subject/message
26
27 Note that the list of recipients is handled by Vue, bypassing this Form."""
28
29 subject_line = forms.CharField(label=_("Subject"), required=True, max_length=78)
30 message_body = forms.CharField(label=_("Message"), required=True, widget=SummernoteWidget(attrs={'height': 150}))
31
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/tabbycat/notifications/forms.py b/tabbycat/notifications/forms.py
--- a/tabbycat/notifications/forms.py
+++ b/tabbycat/notifications/forms.py
@@ -27,4 +27,5 @@
Note that the list of recipients is handled by Vue, bypassing this Form."""
subject_line = forms.CharField(label=_("Subject"), required=True, max_length=78)
- message_body = forms.CharField(label=_("Message"), required=True, widget=SummernoteWidget(attrs={'height': 150}))
+ message_body = forms.CharField(label=_("Message"), required=True, widget=SummernoteWidget(
+ attrs={'height': 150, 'class': 'form-summernote'}))
|
{"golden_diff": "diff --git a/tabbycat/notifications/forms.py b/tabbycat/notifications/forms.py\n--- a/tabbycat/notifications/forms.py\n+++ b/tabbycat/notifications/forms.py\n@@ -27,4 +27,5 @@\n Note that the list of recipients is handled by Vue, bypassing this Form.\"\"\"\n \n subject_line = forms.CharField(label=_(\"Subject\"), required=True, max_length=78)\n- message_body = forms.CharField(label=_(\"Message\"), required=True, widget=SummernoteWidget(attrs={'height': 150}))\n+ message_body = forms.CharField(label=_(\"Message\"), required=True, widget=SummernoteWidget(\n+ attrs={'height': 150, 'class': 'form-summernote'}))\n", "issue": "Email draw/custom email/motions page formatting error\nRunning the latest develop branch v2.3.0A.\r\n\r\nThe message box on the email draw/custom email motions page is obscured/broken as per the picture running Windows 10/Google Chrome. \r\n\r\nError reproduced on a Mac/Google Chrome. \r\n\r\n\r\n\n", "before_files": [{"content": "from django import forms\nfrom django.conf import settings\nfrom django.core.mail import send_mail\nfrom django.utils.translation import gettext as _, gettext_lazy\nfrom django_summernote.widgets import SummernoteWidget\n\n\nclass TestEmailForm(forms.Form):\n \"\"\"Simple form that just sends a test email.\"\"\"\n\n recipient = forms.EmailField(label=gettext_lazy(\"Recipient email address\"), required=True)\n\n def send_email(self, host):\n send_mail(\n _(\"Test email from %(host)s\") % {'host': host},\n _(\"Congratulations! If you're reading this message, your email \"\n \"backend on %(host)s looks all good to go!\") % {'host': host},\n settings.DEFAULT_FROM_EMAIL,\n [self.cleaned_data['recipient']],\n )\n return self.cleaned_data['recipient']\n\n\nclass BasicEmailForm(forms.Form):\n \"\"\"A base class for an email form with fields for subject/message\n\n Note that the list of recipients is handled by Vue, bypassing this Form.\"\"\"\n\n subject_line = forms.CharField(label=_(\"Subject\"), required=True, max_length=78)\n message_body = forms.CharField(label=_(\"Message\"), required=True, widget=SummernoteWidget(attrs={'height': 150}))\n", "path": "tabbycat/notifications/forms.py"}], "after_files": [{"content": "from django import forms\nfrom django.conf import settings\nfrom django.core.mail import send_mail\nfrom django.utils.translation import gettext as _, gettext_lazy\nfrom django_summernote.widgets import SummernoteWidget\n\n\nclass TestEmailForm(forms.Form):\n \"\"\"Simple form that just sends a test email.\"\"\"\n\n recipient = forms.EmailField(label=gettext_lazy(\"Recipient email address\"), required=True)\n\n def send_email(self, host):\n send_mail(\n _(\"Test email from %(host)s\") % {'host': host},\n _(\"Congratulations! If you're reading this message, your email \"\n \"backend on %(host)s looks all good to go!\") % {'host': host},\n settings.DEFAULT_FROM_EMAIL,\n [self.cleaned_data['recipient']],\n )\n return self.cleaned_data['recipient']\n\n\nclass BasicEmailForm(forms.Form):\n \"\"\"A base class for an email form with fields for subject/message\n\n Note that the list of recipients is handled by Vue, bypassing this Form.\"\"\"\n\n subject_line = forms.CharField(label=_(\"Subject\"), required=True, max_length=78)\n message_body = forms.CharField(label=_(\"Message\"), required=True, widget=SummernoteWidget(\n attrs={'height': 150, 'class': 'form-summernote'}))\n", "path": "tabbycat/notifications/forms.py"}]}
| 694 | 160 |
gh_patches_debug_10669
|
rasdani/github-patches
|
git_diff
|
strawberry-graphql__strawberry-1451
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
from_pydantic error if pydantic models contains contains fields that are resolver field in strawberry type
Hi :),
i have a pydantic model that i want to convert to strawberry type using from_pydantic() method. The pydantic model contains fields that are resolver field in the strawberry type model.
```python
from .pydantic_models import Post as PostModel
# Strawberry type
@strawberry.experimental.pydantic.type(name="Post", model=PostModel)
class PostType:
user: Optional[LazyType["UserType", "api_gateway.user"]] = strawberry.field(name="user", resolver=resolve_user)
create_date: auto
text: auto
```
```python
# pydantic_models.py
from pydantic import BaseModel
# pydantic model
class Post(BaseModel):
user: Optional["User"]
create_date: datetime = Field(default_factory=datetime.utcnow)
text: str
```
**Actual Behavior**
----------------------------------
__init__() got an unexpected keyword argument user
**Steps to Reproduce the Problem**
----------------------------------
pydantic_post = Post(user=None, text="Hello World!") #create pydantic instance
posttype = PostType.from_pydantic(pydantic_post) # not work - error
This also not work:
pydantic_post = Post(text="Hello World!")
posttype = PostType.from_pydantic(pydantic_post) # also not work
Thx
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `strawberry/experimental/pydantic/conversion.py`
Content:
```
1 from typing import Union, cast
2
3 from strawberry.enum import EnumDefinition
4 from strawberry.field import StrawberryField
5 from strawberry.type import StrawberryList, StrawberryOptional, StrawberryType
6 from strawberry.union import StrawberryUnion
7
8
9 def _convert_from_pydantic_to_strawberry_type(
10 type_: Union[StrawberryType, type], data_from_model=None, extra=None
11 ):
12 data = data_from_model if data_from_model is not None else extra
13
14 if isinstance(type_, StrawberryOptional):
15 if data is None:
16 return data
17 return _convert_from_pydantic_to_strawberry_type(
18 type_.of_type, data_from_model=data, extra=extra
19 )
20 if isinstance(type_, StrawberryUnion):
21 for option_type in type_.types:
22 if hasattr(option_type, "_pydantic_type"):
23 source_type = option_type._pydantic_type # type: ignore
24 else:
25 source_type = cast(type, option_type)
26 if isinstance(data, source_type):
27 return _convert_from_pydantic_to_strawberry_type(
28 option_type, data_from_model=data, extra=extra
29 )
30 if isinstance(type_, EnumDefinition):
31 return data
32 if isinstance(type_, StrawberryList):
33 items = []
34 for index, item in enumerate(data):
35 items.append(
36 _convert_from_pydantic_to_strawberry_type(
37 type_.of_type,
38 data_from_model=item,
39 extra=extra[index] if extra else None,
40 )
41 )
42
43 return items
44
45 if hasattr(type_, "_type_definition"):
46 # in the case of an interface, the concrete type may be more specific
47 # than the type in the field definition
48 if hasattr(type(data), "_strawberry_type"):
49 type_ = type(data)._strawberry_type
50 return convert_pydantic_model_to_strawberry_class(
51 type_, model_instance=data_from_model, extra=extra
52 )
53
54 return data
55
56
57 def convert_pydantic_model_to_strawberry_class(cls, *, model_instance=None, extra=None):
58 extra = extra or {}
59 kwargs = {}
60
61 for field in cls._type_definition.fields:
62 field = cast(StrawberryField, field)
63 python_name = field.python_name
64
65 data_from_extra = extra.get(python_name, None)
66 data_from_model = (
67 getattr(model_instance, python_name, None) if model_instance else None
68 )
69 kwargs[python_name] = _convert_from_pydantic_to_strawberry_type(
70 field.type, data_from_model, extra=data_from_extra
71 )
72
73 return cls(**kwargs)
74
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/strawberry/experimental/pydantic/conversion.py b/strawberry/experimental/pydantic/conversion.py
--- a/strawberry/experimental/pydantic/conversion.py
+++ b/strawberry/experimental/pydantic/conversion.py
@@ -66,8 +66,12 @@
data_from_model = (
getattr(model_instance, python_name, None) if model_instance else None
)
- kwargs[python_name] = _convert_from_pydantic_to_strawberry_type(
- field.type, data_from_model, extra=data_from_extra
- )
+
+ # only convert and add fields to kwargs if they are present in the `__init__`
+ # method of the class
+ if field.init:
+ kwargs[python_name] = _convert_from_pydantic_to_strawberry_type(
+ field.type, data_from_model, extra=data_from_extra
+ )
return cls(**kwargs)
|
{"golden_diff": "diff --git a/strawberry/experimental/pydantic/conversion.py b/strawberry/experimental/pydantic/conversion.py\n--- a/strawberry/experimental/pydantic/conversion.py\n+++ b/strawberry/experimental/pydantic/conversion.py\n@@ -66,8 +66,12 @@\n data_from_model = (\n getattr(model_instance, python_name, None) if model_instance else None\n )\n- kwargs[python_name] = _convert_from_pydantic_to_strawberry_type(\n- field.type, data_from_model, extra=data_from_extra\n- )\n+\n+ # only convert and add fields to kwargs if they are present in the `__init__`\n+ # method of the class\n+ if field.init:\n+ kwargs[python_name] = _convert_from_pydantic_to_strawberry_type(\n+ field.type, data_from_model, extra=data_from_extra\n+ )\n \n return cls(**kwargs)\n", "issue": "from_pydantic error if pydantic models contains contains fields that are resolver field in strawberry type\nHi :),\r\ni have a pydantic model that i want to convert to strawberry type using from_pydantic() method. The pydantic model contains fields that are resolver field in the strawberry type model.\r\n\r\n```python\r\n\r\nfrom .pydantic_models import Post as PostModel\r\n\r\n# Strawberry type \r\[email protected](name=\"Post\", model=PostModel)\r\nclass PostType:\r\n user: Optional[LazyType[\"UserType\", \"api_gateway.user\"]] = strawberry.field(name=\"user\", resolver=resolve_user)\r\n create_date: auto\r\n text: auto\r\n```\r\n\r\n```python\r\n\r\n# pydantic_models.py\r\n\r\nfrom pydantic import BaseModel\r\n\r\n# pydantic model\r\nclass Post(BaseModel):\r\n user: Optional[\"User\"]\r\n create_date: datetime = Field(default_factory=datetime.utcnow)\r\n text: str\r\n```\r\n\r\n**Actual Behavior**\r\n----------------------------------\r\n__init__() got an unexpected keyword argument user\r\n\r\n**Steps to Reproduce the Problem**\r\n----------------------------------\r\npydantic_post = Post(user=None, text=\"Hello World!\") #create pydantic instance\r\nposttype = PostType.from_pydantic(pydantic_post) # not work - error\r\n\r\nThis also not work:\r\npydantic_post = Post(text=\"Hello World!\")\r\nposttype = PostType.from_pydantic(pydantic_post) # also not work\r\n\r\nThx\r\n\r\n\r\n\n", "before_files": [{"content": "from typing import Union, cast\n\nfrom strawberry.enum import EnumDefinition\nfrom strawberry.field import StrawberryField\nfrom strawberry.type import StrawberryList, StrawberryOptional, StrawberryType\nfrom strawberry.union import StrawberryUnion\n\n\ndef _convert_from_pydantic_to_strawberry_type(\n type_: Union[StrawberryType, type], data_from_model=None, extra=None\n):\n data = data_from_model if data_from_model is not None else extra\n\n if isinstance(type_, StrawberryOptional):\n if data is None:\n return data\n return _convert_from_pydantic_to_strawberry_type(\n type_.of_type, data_from_model=data, extra=extra\n )\n if isinstance(type_, StrawberryUnion):\n for option_type in type_.types:\n if hasattr(option_type, \"_pydantic_type\"):\n source_type = option_type._pydantic_type # type: ignore\n else:\n source_type = cast(type, option_type)\n if isinstance(data, source_type):\n return _convert_from_pydantic_to_strawberry_type(\n option_type, data_from_model=data, extra=extra\n )\n if isinstance(type_, EnumDefinition):\n return data\n if isinstance(type_, StrawberryList):\n items = []\n for index, item in enumerate(data):\n items.append(\n _convert_from_pydantic_to_strawberry_type(\n type_.of_type,\n data_from_model=item,\n extra=extra[index] if extra else None,\n )\n )\n\n return items\n\n if hasattr(type_, \"_type_definition\"):\n # in the case of an interface, the concrete type may be more specific\n # than the type in the field definition\n if hasattr(type(data), \"_strawberry_type\"):\n type_ = type(data)._strawberry_type\n return convert_pydantic_model_to_strawberry_class(\n type_, model_instance=data_from_model, extra=extra\n )\n\n return data\n\n\ndef convert_pydantic_model_to_strawberry_class(cls, *, model_instance=None, extra=None):\n extra = extra or {}\n kwargs = {}\n\n for field in cls._type_definition.fields:\n field = cast(StrawberryField, field)\n python_name = field.python_name\n\n data_from_extra = extra.get(python_name, None)\n data_from_model = (\n getattr(model_instance, python_name, None) if model_instance else None\n )\n kwargs[python_name] = _convert_from_pydantic_to_strawberry_type(\n field.type, data_from_model, extra=data_from_extra\n )\n\n return cls(**kwargs)\n", "path": "strawberry/experimental/pydantic/conversion.py"}], "after_files": [{"content": "from typing import Union, cast\n\nfrom strawberry.enum import EnumDefinition\nfrom strawberry.field import StrawberryField\nfrom strawberry.type import StrawberryList, StrawberryOptional, StrawberryType\nfrom strawberry.union import StrawberryUnion\n\n\ndef _convert_from_pydantic_to_strawberry_type(\n type_: Union[StrawberryType, type], data_from_model=None, extra=None\n):\n data = data_from_model if data_from_model is not None else extra\n\n if isinstance(type_, StrawberryOptional):\n if data is None:\n return data\n return _convert_from_pydantic_to_strawberry_type(\n type_.of_type, data_from_model=data, extra=extra\n )\n if isinstance(type_, StrawberryUnion):\n for option_type in type_.types:\n if hasattr(option_type, \"_pydantic_type\"):\n source_type = option_type._pydantic_type # type: ignore\n else:\n source_type = cast(type, option_type)\n if isinstance(data, source_type):\n return _convert_from_pydantic_to_strawberry_type(\n option_type, data_from_model=data, extra=extra\n )\n if isinstance(type_, EnumDefinition):\n return data\n if isinstance(type_, StrawberryList):\n items = []\n for index, item in enumerate(data):\n items.append(\n _convert_from_pydantic_to_strawberry_type(\n type_.of_type,\n data_from_model=item,\n extra=extra[index] if extra else None,\n )\n )\n\n return items\n\n if hasattr(type_, \"_type_definition\"):\n # in the case of an interface, the concrete type may be more specific\n # than the type in the field definition\n if hasattr(type(data), \"_strawberry_type\"):\n type_ = type(data)._strawberry_type\n return convert_pydantic_model_to_strawberry_class(\n type_, model_instance=data_from_model, extra=extra\n )\n\n return data\n\n\ndef convert_pydantic_model_to_strawberry_class(cls, *, model_instance=None, extra=None):\n extra = extra or {}\n kwargs = {}\n\n for field in cls._type_definition.fields:\n field = cast(StrawberryField, field)\n python_name = field.python_name\n\n data_from_extra = extra.get(python_name, None)\n data_from_model = (\n getattr(model_instance, python_name, None) if model_instance else None\n )\n\n # only convert and add fields to kwargs if they are present in the `__init__`\n # method of the class\n if field.init:\n kwargs[python_name] = _convert_from_pydantic_to_strawberry_type(\n field.type, data_from_model, extra=data_from_extra\n )\n\n return cls(**kwargs)\n", "path": "strawberry/experimental/pydantic/conversion.py"}]}
| 1,269 | 214 |
gh_patches_debug_23824
|
rasdani/github-patches
|
git_diff
|
internetarchive__openlibrary-4260
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
(PYL-W0102) Dangerous default argument
## Description
Mutable Default Arguments: https://docs.python-guide.org/writing/gotchas/
Do not use a mutable like `list` or `dictionary` as a default value to an argument. Python’s default arguments are evaluated once when the function is defined. Using a mutable default argument and mutating it will mutate that object for all future calls to the function as well.
## Occurrences
There are 23 occurrences of this issue in the repository.
See all occurrences on DeepSource → [deepsource.io/gh/HarshCasper/openlibrary-1/issue/PYL-W0102/occurrences/](https://deepsource.io/gh/HarshCasper/openlibrary-1/issue/PYL-W0102/occurrences/)
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `openlibrary/plugins/upstream/adapter.py`
Content:
```
1 """Adapter to provide upstream URL structure over existing Open Library Infobase interface.
2
3 Upstream requires:
4
5 /user/.* -> /people/.*
6 /b/.* -> /books/.*
7 /a/.* -> /authors/.*
8
9 This adapter module is a filter that sits above an Infobase server and fakes the new URL structure.
10 """
11 import simplejson
12 import web
13
14 import six
15 from six.moves import urllib
16
17
18 urls = (
19 '/([^/]*)/get', 'get',
20 '/([^/]*)/get_many', 'get_many',
21 '/([^/]*)/things', 'things',
22 '/([^/]*)/versions', 'versions',
23 '/([^/]*)/new_key', 'new_key',
24 '/([^/]*)/save(/.*)', 'save',
25 '/([^/]*)/save_many', 'save_many',
26 '/([^/]*)/reindex', 'reindex',
27 '/([^/]*)/account/(.*)', 'account',
28 '/([^/]*)/count_edits_by_user', 'count_edits_by_user',
29 '/.*', 'proxy'
30 )
31 app = web.application(urls, globals())
32
33 convertions = {
34 # '/people/': '/user/',
35 # '/books/': '/b/',
36 # '/authors/': '/a/',
37 # '/languages/': '/l/',
38 '/templates/': '/upstream/templates/',
39 '/macros/': '/upstream/macros/',
40 '/js/': '/upstream/js/',
41 '/css/': '/upstream/css/',
42 '/old/templates/': '/templates/',
43 '/old/macros/': '/macros/',
44 '/old/js/': '/js/',
45 '/old/css/': '/css/',
46 }
47
48 # inverse of convertions
49 iconversions = dict((v, k) for k, v in convertions.items())
50
51 class proxy:
52 def delegate(self, *args):
53 self.args = args
54 self.input = web.input(_method='GET', _unicode=False)
55 self.path = web.ctx.path
56
57 if web.ctx.method in ['POST', 'PUT']:
58 self.data = web.data()
59 else:
60 self.data = None
61
62 headers = dict((k[len('HTTP_'):].replace('-', '_').lower(), v) for k, v in web.ctx.environ.items())
63
64 self.before_request()
65 try:
66 server = web.config.infobase_server
67 req = urllib.request.Request(server + self.path + '?' + urllib.parse.urlencode(self.input), self.data, headers=headers)
68 req.get_method = lambda: web.ctx.method
69 response = urllib.request.urlopen(req)
70 except urllib.error.HTTPError as e:
71 response = e
72 self.status_code = response.code
73 self.status_msg = response.msg
74 self.output = response.read()
75
76 self.headers = dict(response.headers.items())
77 for k in ['transfer-encoding', 'server', 'connection', 'date']:
78 self.headers.pop(k, None)
79
80 if self.status_code == 200:
81 self.after_request()
82 else:
83 self.process_error()
84
85 web.ctx.status = "%s %s" % (self.status_code, self.status_msg)
86 web.ctx.headers = self.headers.items()
87 return self.output
88
89 GET = POST = PUT = DELETE = delegate
90
91 def before_request(self):
92 if 'key' in self.input:
93 self.input.key = convert_key(self.input.key)
94
95 def after_request(self):
96 if self.output:
97 d = simplejson.loads(self.output)
98 d = unconvert_dict(d)
99 self.output = simplejson.dumps(d)
100
101 def process_error(self):
102 if self.output:
103 d = simplejson.loads(self.output)
104 if 'key' in d:
105 d['key'] = unconvert_key(d['key'])
106 self.output = simplejson.dumps(d)
107
108 def convert_key(key, mapping=convertions):
109 """
110 >>> convert_key("/authors/OL1A", {'/authors/': '/a/'})
111 '/a/OL1A'
112 """
113 if key is None:
114 return None
115 elif key == '/':
116 return '/upstream'
117
118 for new, old in mapping.items():
119 if key.startswith(new):
120 key2 = old + key[len(new):]
121 return key2
122 return key
123
124 def convert_dict(d, mapping=convertions):
125 """
126 >>> convert_dict({'author': {'key': '/authors/OL1A'}}, {'/authors/': '/a/'})
127 {'author': {'key': '/a/OL1A'}}
128 """
129 if isinstance(d, dict):
130 if 'key' in d:
131 d['key'] = convert_key(d['key'], mapping)
132 for k, v in d.items():
133 d[k] = convert_dict(v, mapping)
134 return d
135 elif isinstance(d, list):
136 return [convert_dict(x, mapping) for x in d]
137 else:
138 return d
139
140 def unconvert_key(key):
141 if key == '/upstream':
142 return '/'
143 return convert_key(key, iconversions)
144
145 def unconvert_dict(d):
146 return convert_dict(d, iconversions)
147
148 class get(proxy):
149 def before_request(self):
150 i = self.input
151 if 'key' in i:
152 i.key = convert_key(i.key)
153
154 class get_many(proxy):
155 def before_request(self):
156 if 'keys' in self.input:
157 keys = self.input['keys']
158 keys = simplejson.loads(keys)
159 keys = [convert_key(k) for k in keys]
160 self.input['keys'] = simplejson.dumps(keys)
161
162 def after_request(self):
163 d = simplejson.loads(self.output)
164 d = dict((unconvert_key(k), unconvert_dict(v)) for k, v in d.items())
165 self.output = simplejson.dumps(d)
166
167 class things(proxy):
168 def before_request(self):
169 if 'query' in self.input:
170 q = self.input.query
171 q = simplejson.loads(q)
172
173 def convert_keys(q):
174 if isinstance(q, dict):
175 return dict((k, convert_keys(v)) for k, v in q.items())
176 elif isinstance(q, list):
177 return [convert_keys(x) for x in q]
178 elif isinstance(q, six.string_types):
179 return convert_key(q)
180 else:
181 return q
182 self.input.query = simplejson.dumps(convert_keys(q))
183
184 def after_request(self):
185 if self.output:
186 d = simplejson.loads(self.output)
187
188 if self.input.get('details', '').lower() == 'true':
189 d = unconvert_dict(d)
190 else:
191 d = [unconvert_key(key) for key in d]
192
193 self.output = simplejson.dumps(d)
194
195 class versions(proxy):
196 def before_request(self):
197 if 'query' in self.input:
198 q = self.input.query
199 q = simplejson.loads(q)
200 if 'key' in q:
201 q['key'] = convert_key(q['key'])
202 if 'author' in q:
203 q['author'] = convert_key(q['author'])
204 self.input.query = simplejson.dumps(q)
205
206 def after_request(self):
207 if self.output:
208 d = simplejson.loads(self.output)
209 for v in d:
210 v['author'] = v['author'] and unconvert_key(v['author'])
211 v['key'] = unconvert_key(v['key'])
212 self.output = simplejson.dumps(d)
213
214 class new_key(proxy):
215 def after_request(self):
216 if self.output:
217 d = simplejson.loads(self.output)
218 d = unconvert_key(d)
219 self.output = simplejson.dumps(d)
220
221 class save(proxy):
222 def before_request(self):
223 self.path = '/%s/save%s' % (self.args[0], convert_key(self.args[1]))
224 d = simplejson.loads(self.data)
225 d = convert_dict(d)
226 self.data = simplejson.dumps(d)
227
228 class save_many(proxy):
229 def before_request(self):
230 i = web.input(_method="POST")
231 if 'query' in i:
232 q = simplejson.loads(i['query'])
233 q = convert_dict(q)
234 i['query'] = simplejson.dumps(q)
235 self.data = urllib.parse.urlencode(i)
236
237 class reindex(proxy):
238 def before_request(self):
239 i = web.input(_method="POST")
240 if 'keys' in i:
241 keys = [convert_key(k) for k in simplejson.loads(i['keys'])]
242 i['keys'] = simplejson.dumps(keys)
243 self.data = urllib.parse.urlencode(i)
244
245 class account(proxy):
246 def before_request(self):
247 i = self.input
248 if 'username' in i and i.username.startswith('/'):
249 i.username = convert_key(i.username)
250
251 def main():
252 import sys
253 import os
254 web.config.infobase_server = sys.argv[1].rstrip('/')
255 os.environ['REAL_SCRIPT_NAME'] = ''
256
257 sys.argv[1:] = sys.argv[2:]
258 app.run()
259
260 if __name__ == '__main__':
261 main()
262
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/openlibrary/plugins/upstream/adapter.py b/openlibrary/plugins/upstream/adapter.py
--- a/openlibrary/plugins/upstream/adapter.py
+++ b/openlibrary/plugins/upstream/adapter.py
@@ -105,11 +105,13 @@
d['key'] = unconvert_key(d['key'])
self.output = simplejson.dumps(d)
-def convert_key(key, mapping=convertions):
+
+def convert_key(key, mapping=None):
"""
>>> convert_key("/authors/OL1A", {'/authors/': '/a/'})
'/a/OL1A'
"""
+ mapping = mapping or convertions
if key is None:
return None
elif key == '/':
@@ -121,11 +123,13 @@
return key2
return key
-def convert_dict(d, mapping=convertions):
+
+def convert_dict(d, mapping=None):
"""
>>> convert_dict({'author': {'key': '/authors/OL1A'}}, {'/authors/': '/a/'})
{'author': {'key': '/a/OL1A'}}
"""
+ mapping = mapping or convertions
if isinstance(d, dict):
if 'key' in d:
d['key'] = convert_key(d['key'], mapping)
|
{"golden_diff": "diff --git a/openlibrary/plugins/upstream/adapter.py b/openlibrary/plugins/upstream/adapter.py\n--- a/openlibrary/plugins/upstream/adapter.py\n+++ b/openlibrary/plugins/upstream/adapter.py\n@@ -105,11 +105,13 @@\n d['key'] = unconvert_key(d['key'])\n self.output = simplejson.dumps(d)\n \n-def convert_key(key, mapping=convertions):\n+\n+def convert_key(key, mapping=None):\n \"\"\"\n >>> convert_key(\"/authors/OL1A\", {'/authors/': '/a/'})\n '/a/OL1A'\n \"\"\"\n+ mapping = mapping or convertions\n if key is None:\n return None\n elif key == '/':\n@@ -121,11 +123,13 @@\n return key2\n return key\n \n-def convert_dict(d, mapping=convertions):\n+\n+def convert_dict(d, mapping=None):\n \"\"\"\n >>> convert_dict({'author': {'key': '/authors/OL1A'}}, {'/authors/': '/a/'})\n {'author': {'key': '/a/OL1A'}}\n \"\"\"\n+ mapping = mapping or convertions\n if isinstance(d, dict):\n if 'key' in d:\n d['key'] = convert_key(d['key'], mapping)\n", "issue": "(PYL-W0102) Dangerous default argument\n## Description\r\nMutable Default Arguments: https://docs.python-guide.org/writing/gotchas/\r\n\r\nDo not use a mutable like `list` or `dictionary` as a default value to an argument. Python\u2019s default arguments are evaluated once when the function is defined. Using a mutable default argument and mutating it will mutate that object for all future calls to the function as well.\r\n\r\n## Occurrences\r\nThere are 23 occurrences of this issue in the repository.\r\n\r\nSee all occurrences on DeepSource → [deepsource.io/gh/HarshCasper/openlibrary-1/issue/PYL-W0102/occurrences/](https://deepsource.io/gh/HarshCasper/openlibrary-1/issue/PYL-W0102/occurrences/)\r\n\n", "before_files": [{"content": "\"\"\"Adapter to provide upstream URL structure over existing Open Library Infobase interface.\n\nUpstream requires:\n\n /user/.* -> /people/.*\n /b/.* -> /books/.*\n /a/.* -> /authors/.*\n\nThis adapter module is a filter that sits above an Infobase server and fakes the new URL structure.\n\"\"\"\nimport simplejson\nimport web\n\nimport six\nfrom six.moves import urllib\n\n\nurls = (\n '/([^/]*)/get', 'get',\n '/([^/]*)/get_many', 'get_many',\n '/([^/]*)/things', 'things',\n '/([^/]*)/versions', 'versions',\n '/([^/]*)/new_key', 'new_key',\n '/([^/]*)/save(/.*)', 'save',\n '/([^/]*)/save_many', 'save_many',\n '/([^/]*)/reindex', 'reindex',\n '/([^/]*)/account/(.*)', 'account',\n '/([^/]*)/count_edits_by_user', 'count_edits_by_user',\n '/.*', 'proxy'\n)\napp = web.application(urls, globals())\n\nconvertions = {\n# '/people/': '/user/',\n# '/books/': '/b/',\n# '/authors/': '/a/',\n# '/languages/': '/l/',\n '/templates/': '/upstream/templates/',\n '/macros/': '/upstream/macros/',\n '/js/': '/upstream/js/',\n '/css/': '/upstream/css/',\n '/old/templates/': '/templates/',\n '/old/macros/': '/macros/',\n '/old/js/': '/js/',\n '/old/css/': '/css/',\n}\n\n# inverse of convertions\niconversions = dict((v, k) for k, v in convertions.items())\n\nclass proxy:\n def delegate(self, *args):\n self.args = args\n self.input = web.input(_method='GET', _unicode=False)\n self.path = web.ctx.path\n\n if web.ctx.method in ['POST', 'PUT']:\n self.data = web.data()\n else:\n self.data = None\n\n headers = dict((k[len('HTTP_'):].replace('-', '_').lower(), v) for k, v in web.ctx.environ.items())\n\n self.before_request()\n try:\n server = web.config.infobase_server\n req = urllib.request.Request(server + self.path + '?' + urllib.parse.urlencode(self.input), self.data, headers=headers)\n req.get_method = lambda: web.ctx.method\n response = urllib.request.urlopen(req)\n except urllib.error.HTTPError as e:\n response = e\n self.status_code = response.code\n self.status_msg = response.msg\n self.output = response.read()\n\n self.headers = dict(response.headers.items())\n for k in ['transfer-encoding', 'server', 'connection', 'date']:\n self.headers.pop(k, None)\n\n if self.status_code == 200:\n self.after_request()\n else:\n self.process_error()\n\n web.ctx.status = \"%s %s\" % (self.status_code, self.status_msg)\n web.ctx.headers = self.headers.items()\n return self.output\n\n GET = POST = PUT = DELETE = delegate\n\n def before_request(self):\n if 'key' in self.input:\n self.input.key = convert_key(self.input.key)\n\n def after_request(self):\n if self.output:\n d = simplejson.loads(self.output)\n d = unconvert_dict(d)\n self.output = simplejson.dumps(d)\n\n def process_error(self):\n if self.output:\n d = simplejson.loads(self.output)\n if 'key' in d:\n d['key'] = unconvert_key(d['key'])\n self.output = simplejson.dumps(d)\n\ndef convert_key(key, mapping=convertions):\n \"\"\"\n >>> convert_key(\"/authors/OL1A\", {'/authors/': '/a/'})\n '/a/OL1A'\n \"\"\"\n if key is None:\n return None\n elif key == '/':\n return '/upstream'\n\n for new, old in mapping.items():\n if key.startswith(new):\n key2 = old + key[len(new):]\n return key2\n return key\n\ndef convert_dict(d, mapping=convertions):\n \"\"\"\n >>> convert_dict({'author': {'key': '/authors/OL1A'}}, {'/authors/': '/a/'})\n {'author': {'key': '/a/OL1A'}}\n \"\"\"\n if isinstance(d, dict):\n if 'key' in d:\n d['key'] = convert_key(d['key'], mapping)\n for k, v in d.items():\n d[k] = convert_dict(v, mapping)\n return d\n elif isinstance(d, list):\n return [convert_dict(x, mapping) for x in d]\n else:\n return d\n\ndef unconvert_key(key):\n if key == '/upstream':\n return '/'\n return convert_key(key, iconversions)\n\ndef unconvert_dict(d):\n return convert_dict(d, iconversions)\n\nclass get(proxy):\n def before_request(self):\n i = self.input\n if 'key' in i:\n i.key = convert_key(i.key)\n\nclass get_many(proxy):\n def before_request(self):\n if 'keys' in self.input:\n keys = self.input['keys']\n keys = simplejson.loads(keys)\n keys = [convert_key(k) for k in keys]\n self.input['keys'] = simplejson.dumps(keys)\n\n def after_request(self):\n d = simplejson.loads(self.output)\n d = dict((unconvert_key(k), unconvert_dict(v)) for k, v in d.items())\n self.output = simplejson.dumps(d)\n\nclass things(proxy):\n def before_request(self):\n if 'query' in self.input:\n q = self.input.query\n q = simplejson.loads(q)\n\n def convert_keys(q):\n if isinstance(q, dict):\n return dict((k, convert_keys(v)) for k, v in q.items())\n elif isinstance(q, list):\n return [convert_keys(x) for x in q]\n elif isinstance(q, six.string_types):\n return convert_key(q)\n else:\n return q\n self.input.query = simplejson.dumps(convert_keys(q))\n\n def after_request(self):\n if self.output:\n d = simplejson.loads(self.output)\n\n if self.input.get('details', '').lower() == 'true':\n d = unconvert_dict(d)\n else:\n d = [unconvert_key(key) for key in d]\n\n self.output = simplejson.dumps(d)\n\nclass versions(proxy):\n def before_request(self):\n if 'query' in self.input:\n q = self.input.query\n q = simplejson.loads(q)\n if 'key' in q:\n q['key'] = convert_key(q['key'])\n if 'author' in q:\n q['author'] = convert_key(q['author'])\n self.input.query = simplejson.dumps(q)\n\n def after_request(self):\n if self.output:\n d = simplejson.loads(self.output)\n for v in d:\n v['author'] = v['author'] and unconvert_key(v['author'])\n v['key'] = unconvert_key(v['key'])\n self.output = simplejson.dumps(d)\n\nclass new_key(proxy):\n def after_request(self):\n if self.output:\n d = simplejson.loads(self.output)\n d = unconvert_key(d)\n self.output = simplejson.dumps(d)\n\nclass save(proxy):\n def before_request(self):\n self.path = '/%s/save%s' % (self.args[0], convert_key(self.args[1]))\n d = simplejson.loads(self.data)\n d = convert_dict(d)\n self.data = simplejson.dumps(d)\n\nclass save_many(proxy):\n def before_request(self):\n i = web.input(_method=\"POST\")\n if 'query' in i:\n q = simplejson.loads(i['query'])\n q = convert_dict(q)\n i['query'] = simplejson.dumps(q)\n self.data = urllib.parse.urlencode(i)\n\nclass reindex(proxy):\n def before_request(self):\n i = web.input(_method=\"POST\")\n if 'keys' in i:\n keys = [convert_key(k) for k in simplejson.loads(i['keys'])]\n i['keys'] = simplejson.dumps(keys)\n self.data = urllib.parse.urlencode(i)\n\nclass account(proxy):\n def before_request(self):\n i = self.input\n if 'username' in i and i.username.startswith('/'):\n i.username = convert_key(i.username)\n\ndef main():\n import sys\n import os\n web.config.infobase_server = sys.argv[1].rstrip('/')\n os.environ['REAL_SCRIPT_NAME'] = ''\n\n sys.argv[1:] = sys.argv[2:]\n app.run()\n\nif __name__ == '__main__':\n main()\n", "path": "openlibrary/plugins/upstream/adapter.py"}], "after_files": [{"content": "\"\"\"Adapter to provide upstream URL structure over existing Open Library Infobase interface.\n\nUpstream requires:\n\n /user/.* -> /people/.*\n /b/.* -> /books/.*\n /a/.* -> /authors/.*\n\nThis adapter module is a filter that sits above an Infobase server and fakes the new URL structure.\n\"\"\"\nimport simplejson\nimport web\n\nimport six\nfrom six.moves import urllib\n\n\nurls = (\n '/([^/]*)/get', 'get',\n '/([^/]*)/get_many', 'get_many',\n '/([^/]*)/things', 'things',\n '/([^/]*)/versions', 'versions',\n '/([^/]*)/new_key', 'new_key',\n '/([^/]*)/save(/.*)', 'save',\n '/([^/]*)/save_many', 'save_many',\n '/([^/]*)/reindex', 'reindex',\n '/([^/]*)/account/(.*)', 'account',\n '/([^/]*)/count_edits_by_user', 'count_edits_by_user',\n '/.*', 'proxy'\n)\napp = web.application(urls, globals())\n\nconvertions = {\n# '/people/': '/user/',\n# '/books/': '/b/',\n# '/authors/': '/a/',\n# '/languages/': '/l/',\n '/templates/': '/upstream/templates/',\n '/macros/': '/upstream/macros/',\n '/js/': '/upstream/js/',\n '/css/': '/upstream/css/',\n '/old/templates/': '/templates/',\n '/old/macros/': '/macros/',\n '/old/js/': '/js/',\n '/old/css/': '/css/',\n}\n\n# inverse of convertions\niconversions = dict((v, k) for k, v in convertions.items())\n\nclass proxy:\n def delegate(self, *args):\n self.args = args\n self.input = web.input(_method='GET', _unicode=False)\n self.path = web.ctx.path\n\n if web.ctx.method in ['POST', 'PUT']:\n self.data = web.data()\n else:\n self.data = None\n\n headers = dict((k[len('HTTP_'):].replace('-', '_').lower(), v) for k, v in web.ctx.environ.items())\n\n self.before_request()\n try:\n server = web.config.infobase_server\n req = urllib.request.Request(server + self.path + '?' + urllib.parse.urlencode(self.input), self.data, headers=headers)\n req.get_method = lambda: web.ctx.method\n response = urllib.request.urlopen(req)\n except urllib.error.HTTPError as e:\n response = e\n self.status_code = response.code\n self.status_msg = response.msg\n self.output = response.read()\n\n self.headers = dict(response.headers.items())\n for k in ['transfer-encoding', 'server', 'connection', 'date']:\n self.headers.pop(k, None)\n\n if self.status_code == 200:\n self.after_request()\n else:\n self.process_error()\n\n web.ctx.status = \"%s %s\" % (self.status_code, self.status_msg)\n web.ctx.headers = self.headers.items()\n return self.output\n\n GET = POST = PUT = DELETE = delegate\n\n def before_request(self):\n if 'key' in self.input:\n self.input.key = convert_key(self.input.key)\n\n def after_request(self):\n if self.output:\n d = simplejson.loads(self.output)\n d = unconvert_dict(d)\n self.output = simplejson.dumps(d)\n\n def process_error(self):\n if self.output:\n d = simplejson.loads(self.output)\n if 'key' in d:\n d['key'] = unconvert_key(d['key'])\n self.output = simplejson.dumps(d)\n\n\ndef convert_key(key, mapping=None):\n \"\"\"\n >>> convert_key(\"/authors/OL1A\", {'/authors/': '/a/'})\n '/a/OL1A'\n \"\"\"\n mapping = mapping or convertions\n if key is None:\n return None\n elif key == '/':\n return '/upstream'\n\n for new, old in mapping.items():\n if key.startswith(new):\n key2 = old + key[len(new):]\n return key2\n return key\n\n\ndef convert_dict(d, mapping=None):\n \"\"\"\n >>> convert_dict({'author': {'key': '/authors/OL1A'}}, {'/authors/': '/a/'})\n {'author': {'key': '/a/OL1A'}}\n \"\"\"\n mapping = mapping or convertions\n if isinstance(d, dict):\n if 'key' in d:\n d['key'] = convert_key(d['key'], mapping)\n for k, v in d.items():\n d[k] = convert_dict(v, mapping)\n return d\n elif isinstance(d, list):\n return [convert_dict(x, mapping) for x in d]\n else:\n return d\n\ndef unconvert_key(key):\n if key == '/upstream':\n return '/'\n return convert_key(key, iconversions)\n\ndef unconvert_dict(d):\n return convert_dict(d, iconversions)\n\nclass get(proxy):\n def before_request(self):\n i = self.input\n if 'key' in i:\n i.key = convert_key(i.key)\n\nclass get_many(proxy):\n def before_request(self):\n if 'keys' in self.input:\n keys = self.input['keys']\n keys = simplejson.loads(keys)\n keys = [convert_key(k) for k in keys]\n self.input['keys'] = simplejson.dumps(keys)\n\n def after_request(self):\n d = simplejson.loads(self.output)\n d = dict((unconvert_key(k), unconvert_dict(v)) for k, v in d.items())\n self.output = simplejson.dumps(d)\n\nclass things(proxy):\n def before_request(self):\n if 'query' in self.input:\n q = self.input.query\n q = simplejson.loads(q)\n\n def convert_keys(q):\n if isinstance(q, dict):\n return dict((k, convert_keys(v)) for k, v in q.items())\n elif isinstance(q, list):\n return [convert_keys(x) for x in q]\n elif isinstance(q, six.string_types):\n return convert_key(q)\n else:\n return q\n self.input.query = simplejson.dumps(convert_keys(q))\n\n def after_request(self):\n if self.output:\n d = simplejson.loads(self.output)\n\n if self.input.get('details', '').lower() == 'true':\n d = unconvert_dict(d)\n else:\n d = [unconvert_key(key) for key in d]\n\n self.output = simplejson.dumps(d)\n\nclass versions(proxy):\n def before_request(self):\n if 'query' in self.input:\n q = self.input.query\n q = simplejson.loads(q)\n if 'key' in q:\n q['key'] = convert_key(q['key'])\n if 'author' in q:\n q['author'] = convert_key(q['author'])\n self.input.query = simplejson.dumps(q)\n\n def after_request(self):\n if self.output:\n d = simplejson.loads(self.output)\n for v in d:\n v['author'] = v['author'] and unconvert_key(v['author'])\n v['key'] = unconvert_key(v['key'])\n self.output = simplejson.dumps(d)\n\nclass new_key(proxy):\n def after_request(self):\n if self.output:\n d = simplejson.loads(self.output)\n d = unconvert_key(d)\n self.output = simplejson.dumps(d)\n\nclass save(proxy):\n def before_request(self):\n self.path = '/%s/save%s' % (self.args[0], convert_key(self.args[1]))\n d = simplejson.loads(self.data)\n d = convert_dict(d)\n self.data = simplejson.dumps(d)\n\nclass save_many(proxy):\n def before_request(self):\n i = web.input(_method=\"POST\")\n if 'query' in i:\n q = simplejson.loads(i['query'])\n q = convert_dict(q)\n i['query'] = simplejson.dumps(q)\n self.data = urllib.parse.urlencode(i)\n\nclass reindex(proxy):\n def before_request(self):\n i = web.input(_method=\"POST\")\n if 'keys' in i:\n keys = [convert_key(k) for k in simplejson.loads(i['keys'])]\n i['keys'] = simplejson.dumps(keys)\n self.data = urllib.parse.urlencode(i)\n\nclass account(proxy):\n def before_request(self):\n i = self.input\n if 'username' in i and i.username.startswith('/'):\n i.username = convert_key(i.username)\n\ndef main():\n import sys\n import os\n web.config.infobase_server = sys.argv[1].rstrip('/')\n os.environ['REAL_SCRIPT_NAME'] = ''\n\n sys.argv[1:] = sys.argv[2:]\n app.run()\n\nif __name__ == '__main__':\n main()\n", "path": "openlibrary/plugins/upstream/adapter.py"}]}
| 3,044 | 288 |
gh_patches_debug_6173
|
rasdani/github-patches
|
git_diff
|
ipython__ipython-7883
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Making stdin optional when creating new kernels
It would be useful for the `ExecutePreprocessor` (and other things that want to automatically run notebooks on the fly) to be able to easily disable `stdin` -- otherwise, if there is something like a call to `input`, it causes the preprocessor to just hang and eventually time out. I think this would just involve adding a new kwarg to this function: https://github.com/ipython/ipython/blob/master/IPython/kernel/manager.py#L417 and then calling `kc.start_channels(stdin=stdin)`, where `stdin` is whatever value that was passed in (True by default).
Questions:
1. Is there some other way to do this that I missed?
2. If not, does this change sound ok? If so, I'll go ahead and make a PR for it and add an option to disable stdin to the `ExecutePreprocessor` as well.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `IPython/nbconvert/preprocessors/execute.py`
Content:
```
1 """Module containing a preprocessor that removes the outputs from code cells"""
2
3 # Copyright (c) IPython Development Team.
4 # Distributed under the terms of the Modified BSD License.
5
6 import os
7
8 try:
9 from queue import Empty # Py 3
10 except ImportError:
11 from Queue import Empty # Py 2
12
13 from IPython.utils.traitlets import List, Unicode
14
15 from IPython.nbformat.v4 import output_from_msg
16 from .base import Preprocessor
17 from IPython.utils.traitlets import Integer
18
19
20 class ExecutePreprocessor(Preprocessor):
21 """
22 Executes all the cells in a notebook
23 """
24
25 timeout = Integer(30, config=True,
26 help="The time to wait (in seconds) for output from executions."
27 )
28
29 extra_arguments = List(Unicode)
30
31 def preprocess(self, nb, resources):
32 from IPython.kernel import run_kernel
33 kernel_name = nb.metadata.get('kernelspec', {}).get('name', 'python')
34 self.log.info("Executing notebook with kernel: %s" % kernel_name)
35 with run_kernel(kernel_name=kernel_name,
36 extra_arguments=self.extra_arguments,
37 stderr=open(os.devnull, 'w')) as kc:
38 self.kc = kc
39 nb, resources = super(ExecutePreprocessor, self).preprocess(nb, resources)
40 return nb, resources
41
42 def preprocess_cell(self, cell, resources, cell_index):
43 """
44 Apply a transformation on each code cell. See base.py for details.
45 """
46 if cell.cell_type != 'code':
47 return cell, resources
48 try:
49 outputs = self.run_cell(cell)
50 except Exception as e:
51 self.log.error("failed to run cell: " + repr(e))
52 self.log.error(str(cell.source))
53 raise
54 cell.outputs = outputs
55 return cell, resources
56
57 def run_cell(self, cell):
58 msg_id = self.kc.execute(cell.source)
59 self.log.debug("Executing cell:\n%s", cell.source)
60 # wait for finish, with timeout
61 while True:
62 try:
63 msg = self.kc.shell_channel.get_msg(timeout=self.timeout)
64 except Empty:
65 self.log.error("Timeout waiting for execute reply")
66 raise
67 if msg['parent_header'].get('msg_id') == msg_id:
68 break
69 else:
70 # not our reply
71 continue
72
73 outs = []
74
75 while True:
76 try:
77 msg = self.kc.iopub_channel.get_msg(timeout=self.timeout)
78 except Empty:
79 self.log.warn("Timeout waiting for IOPub output")
80 break
81 if msg['parent_header'].get('msg_id') != msg_id:
82 # not an output from our execution
83 continue
84
85 msg_type = msg['msg_type']
86 self.log.debug("output: %s", msg_type)
87 content = msg['content']
88
89 # set the prompt number for the input and the output
90 if 'execution_count' in content:
91 cell['execution_count'] = content['execution_count']
92
93 if msg_type == 'status':
94 if content['execution_state'] == 'idle':
95 break
96 else:
97 continue
98 elif msg_type == 'execute_input':
99 continue
100 elif msg_type == 'clear_output':
101 outs = []
102 continue
103
104 try:
105 out = output_from_msg(msg)
106 except ValueError:
107 self.log.error("unhandled iopub msg: " + msg_type)
108 else:
109 outs.append(out)
110
111 return outs
112
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/IPython/nbconvert/preprocessors/execute.py b/IPython/nbconvert/preprocessors/execute.py
--- a/IPython/nbconvert/preprocessors/execute.py
+++ b/IPython/nbconvert/preprocessors/execute.py
@@ -36,6 +36,7 @@
extra_arguments=self.extra_arguments,
stderr=open(os.devnull, 'w')) as kc:
self.kc = kc
+ self.kc.allow_stdin = False
nb, resources = super(ExecutePreprocessor, self).preprocess(nb, resources)
return nb, resources
|
{"golden_diff": "diff --git a/IPython/nbconvert/preprocessors/execute.py b/IPython/nbconvert/preprocessors/execute.py\n--- a/IPython/nbconvert/preprocessors/execute.py\n+++ b/IPython/nbconvert/preprocessors/execute.py\n@@ -36,6 +36,7 @@\n extra_arguments=self.extra_arguments,\n stderr=open(os.devnull, 'w')) as kc:\n self.kc = kc\n+ self.kc.allow_stdin = False\n nb, resources = super(ExecutePreprocessor, self).preprocess(nb, resources)\n return nb, resources\n", "issue": "Making stdin optional when creating new kernels\nIt would be useful for the `ExecutePreprocessor` (and other things that want to automatically run notebooks on the fly) to be able to easily disable `stdin` -- otherwise, if there is something like a call to `input`, it causes the preprocessor to just hang and eventually time out. I think this would just involve adding a new kwarg to this function: https://github.com/ipython/ipython/blob/master/IPython/kernel/manager.py#L417 and then calling `kc.start_channels(stdin=stdin)`, where `stdin` is whatever value that was passed in (True by default).\n\nQuestions:\n1. Is there some other way to do this that I missed?\n2. If not, does this change sound ok? If so, I'll go ahead and make a PR for it and add an option to disable stdin to the `ExecutePreprocessor` as well.\n\n", "before_files": [{"content": "\"\"\"Module containing a preprocessor that removes the outputs from code cells\"\"\"\n\n# Copyright (c) IPython Development Team.\n# Distributed under the terms of the Modified BSD License.\n\nimport os\n\ntry:\n from queue import Empty # Py 3\nexcept ImportError:\n from Queue import Empty # Py 2\n\nfrom IPython.utils.traitlets import List, Unicode\n\nfrom IPython.nbformat.v4 import output_from_msg\nfrom .base import Preprocessor\nfrom IPython.utils.traitlets import Integer\n\n\nclass ExecutePreprocessor(Preprocessor):\n \"\"\"\n Executes all the cells in a notebook\n \"\"\"\n \n timeout = Integer(30, config=True,\n help=\"The time to wait (in seconds) for output from executions.\"\n )\n \n extra_arguments = List(Unicode)\n\n def preprocess(self, nb, resources):\n from IPython.kernel import run_kernel\n kernel_name = nb.metadata.get('kernelspec', {}).get('name', 'python')\n self.log.info(\"Executing notebook with kernel: %s\" % kernel_name)\n with run_kernel(kernel_name=kernel_name,\n extra_arguments=self.extra_arguments,\n stderr=open(os.devnull, 'w')) as kc:\n self.kc = kc\n nb, resources = super(ExecutePreprocessor, self).preprocess(nb, resources)\n return nb, resources\n\n def preprocess_cell(self, cell, resources, cell_index):\n \"\"\"\n Apply a transformation on each code cell. See base.py for details.\n \"\"\"\n if cell.cell_type != 'code':\n return cell, resources\n try:\n outputs = self.run_cell(cell)\n except Exception as e:\n self.log.error(\"failed to run cell: \" + repr(e))\n self.log.error(str(cell.source))\n raise\n cell.outputs = outputs\n return cell, resources\n\n def run_cell(self, cell):\n msg_id = self.kc.execute(cell.source)\n self.log.debug(\"Executing cell:\\n%s\", cell.source)\n # wait for finish, with timeout\n while True:\n try:\n msg = self.kc.shell_channel.get_msg(timeout=self.timeout)\n except Empty:\n self.log.error(\"Timeout waiting for execute reply\")\n raise\n if msg['parent_header'].get('msg_id') == msg_id:\n break\n else:\n # not our reply\n continue\n \n outs = []\n\n while True:\n try:\n msg = self.kc.iopub_channel.get_msg(timeout=self.timeout)\n except Empty:\n self.log.warn(\"Timeout waiting for IOPub output\")\n break\n if msg['parent_header'].get('msg_id') != msg_id:\n # not an output from our execution\n continue\n\n msg_type = msg['msg_type']\n self.log.debug(\"output: %s\", msg_type)\n content = msg['content']\n\n # set the prompt number for the input and the output\n if 'execution_count' in content:\n cell['execution_count'] = content['execution_count']\n\n if msg_type == 'status':\n if content['execution_state'] == 'idle':\n break\n else:\n continue\n elif msg_type == 'execute_input':\n continue\n elif msg_type == 'clear_output':\n outs = []\n continue\n\n try:\n out = output_from_msg(msg)\n except ValueError:\n self.log.error(\"unhandled iopub msg: \" + msg_type)\n else:\n outs.append(out)\n\n return outs\n", "path": "IPython/nbconvert/preprocessors/execute.py"}], "after_files": [{"content": "\"\"\"Module containing a preprocessor that removes the outputs from code cells\"\"\"\n\n# Copyright (c) IPython Development Team.\n# Distributed under the terms of the Modified BSD License.\n\nimport os\n\ntry:\n from queue import Empty # Py 3\nexcept ImportError:\n from Queue import Empty # Py 2\n\nfrom IPython.utils.traitlets import List, Unicode\n\nfrom IPython.nbformat.v4 import output_from_msg\nfrom .base import Preprocessor\nfrom IPython.utils.traitlets import Integer\n\n\nclass ExecutePreprocessor(Preprocessor):\n \"\"\"\n Executes all the cells in a notebook\n \"\"\"\n \n timeout = Integer(30, config=True,\n help=\"The time to wait (in seconds) for output from executions.\"\n )\n \n extra_arguments = List(Unicode)\n\n def preprocess(self, nb, resources):\n from IPython.kernel import run_kernel\n kernel_name = nb.metadata.get('kernelspec', {}).get('name', 'python')\n self.log.info(\"Executing notebook with kernel: %s\" % kernel_name)\n with run_kernel(kernel_name=kernel_name,\n extra_arguments=self.extra_arguments,\n stderr=open(os.devnull, 'w')) as kc:\n self.kc = kc\n self.kc.allow_stdin = False\n nb, resources = super(ExecutePreprocessor, self).preprocess(nb, resources)\n return nb, resources\n\n def preprocess_cell(self, cell, resources, cell_index):\n \"\"\"\n Apply a transformation on each code cell. See base.py for details.\n \"\"\"\n if cell.cell_type != 'code':\n return cell, resources\n try:\n outputs = self.run_cell(cell)\n except Exception as e:\n self.log.error(\"failed to run cell: \" + repr(e))\n self.log.error(str(cell.source))\n raise\n cell.outputs = outputs\n return cell, resources\n\n def run_cell(self, cell):\n msg_id = self.kc.execute(cell.source)\n self.log.debug(\"Executing cell:\\n%s\", cell.source)\n # wait for finish, with timeout\n while True:\n try:\n msg = self.kc.shell_channel.get_msg(timeout=self.timeout)\n except Empty:\n self.log.error(\"Timeout waiting for execute reply\")\n raise\n if msg['parent_header'].get('msg_id') == msg_id:\n break\n else:\n # not our reply\n continue\n \n outs = []\n\n while True:\n try:\n msg = self.kc.iopub_channel.get_msg(timeout=self.timeout)\n except Empty:\n self.log.warn(\"Timeout waiting for IOPub output\")\n break\n if msg['parent_header'].get('msg_id') != msg_id:\n # not an output from our execution\n continue\n\n msg_type = msg['msg_type']\n self.log.debug(\"output: %s\", msg_type)\n content = msg['content']\n\n # set the prompt number for the input and the output\n if 'execution_count' in content:\n cell['execution_count'] = content['execution_count']\n\n if msg_type == 'status':\n if content['execution_state'] == 'idle':\n break\n else:\n continue\n elif msg_type == 'execute_input':\n continue\n elif msg_type == 'clear_output':\n outs = []\n continue\n\n try:\n out = output_from_msg(msg)\n except ValueError:\n self.log.error(\"unhandled iopub msg: \" + msg_type)\n else:\n outs.append(out)\n\n return outs\n", "path": "IPython/nbconvert/preprocessors/execute.py"}]}
| 1,438 | 127 |
gh_patches_debug_2176
|
rasdani/github-patches
|
git_diff
|
PrefectHQ__prefect-2467
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Feature/#2439 prefect server telemetry
**Thanks for contributing to Prefect!**
Please describe your work and make sure your PR:
- [x] adds new tests (if appropriate)
- [x] updates `CHANGELOG.md` (if appropriate)
- [x] updates docstrings for any new functions or function arguments, including `docs/outline.toml` for API reference docs (if appropriate)
Note that your PR will not be reviewed unless all three boxes are checked.
## What does this PR change?
This PR closes #2467 and adds some minimal telemetry to Prefect Server.
## Why is this PR important?
This is the first step into collecting usage information that can help the Prefect team understand how Prefect Server is being used and how we can make it better.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `src/prefect/cli/server.py`
Content:
```
1 import os
2 import shutil
3 import subprocess
4 import tempfile
5 import time
6 from pathlib import Path
7
8 import click
9 import yaml
10
11 import prefect
12 from prefect import config
13 from prefect.utilities.configuration import set_temporary_config
14 from prefect.utilities.docker_util import platform_is_linux, get_docker_ip
15
16
17 def make_env(fname=None):
18 # replace localhost with postgres to use docker-compose dns
19 PREFECT_ENV = dict(
20 DB_CONNECTION_URL=config.server.database.connection_url.replace(
21 "localhost", "postgres"
22 ),
23 GRAPHQL_HOST_PORT=config.server.graphql.host_port,
24 UI_HOST_PORT=config.server.ui.host_port,
25 )
26
27 APOLLO_ENV = dict(
28 HASURA_API_URL="http://hasura:{}/v1alpha1/graphql".format(
29 config.server.hasura.port
30 ),
31 HASURA_WS_URL="ws://hasura:{}/v1alpha1/graphql".format(
32 config.server.hasura.port
33 ),
34 PREFECT_API_URL="http://graphql:{port}{path}".format(
35 port=config.server.graphql.port, path=config.server.graphql.path
36 ),
37 PREFECT_API_HEALTH_URL="http://graphql:{port}/health".format(
38 port=config.server.graphql.port
39 ),
40 APOLLO_HOST_PORT=config.server.host_port,
41 )
42
43 POSTGRES_ENV = dict(
44 POSTGRES_HOST_PORT=config.server.database.host_port,
45 POSTGRES_USER=config.server.database.username,
46 POSTGRES_PASSWORD=config.server.database.password,
47 POSTGRES_DB=config.server.database.name,
48 )
49
50 UI_ENV = dict(GRAPHQL_URL=config.server.ui.graphql_url)
51
52 HASURA_ENV = dict(HASURA_HOST_PORT=config.server.hasura.host_port)
53
54 ENV = os.environ.copy()
55 ENV.update(**PREFECT_ENV, **APOLLO_ENV, **POSTGRES_ENV, **UI_ENV, **HASURA_ENV)
56
57 if fname is not None:
58 list_of_pairs = [
59 "{k}={repr(v)}".format(k=k, v=v)
60 if "\n" in v
61 else "{k}={v}".format(k=k, v=v)
62 for k, v in ENV.items()
63 ]
64 with open(fname, "w") as f:
65 f.write("\n".join(list_of_pairs))
66 return ENV.copy()
67
68
69 @click.group(hidden=True)
70 def server():
71 """
72 Commands for interacting with the Prefect Core server
73
74 \b
75 Usage:
76 $ prefect server ...
77
78 \b
79 Arguments:
80 start ...
81
82 \b
83 Examples:
84 $ prefect server start
85 ...
86 """
87
88
89 @server.command(hidden=True)
90 @click.option(
91 "--version",
92 "-v",
93 help="The server image versions to use (for example, '0.10.0' or 'master')",
94 hidden=True,
95 )
96 @click.option(
97 "--skip-pull",
98 help="Pass this flag to skip pulling new images (if available)",
99 is_flag=True,
100 hidden=True,
101 )
102 @click.option(
103 "--no-upgrade",
104 "-n",
105 help="Pass this flag to avoid running a database upgrade when the database spins up",
106 is_flag=True,
107 hidden=True,
108 )
109 @click.option(
110 "--no-ui",
111 "-u",
112 help="Pass this flag to avoid starting the UI",
113 is_flag=True,
114 hidden=True,
115 )
116 @click.option(
117 "--postgres-port",
118 help="The port used to serve Postgres",
119 default=config.server.database.host_port,
120 type=str,
121 hidden=True,
122 )
123 @click.option(
124 "--hasura-port",
125 help="The port used to serve Hasura",
126 default=config.server.hasura.host_port,
127 type=str,
128 hidden=True,
129 )
130 @click.option(
131 "--graphql-port",
132 help="The port used to serve the GraphQL API",
133 default=config.server.graphql.host_port,
134 type=str,
135 hidden=True,
136 )
137 @click.option(
138 "--ui-port",
139 help="The port used to serve the UI",
140 default=config.server.ui.host_port,
141 type=str,
142 hidden=True,
143 )
144 @click.option(
145 "--server-port",
146 help="The port used to serve the Core server",
147 default=config.server.host_port,
148 type=str,
149 hidden=True,
150 )
151 @click.option(
152 "--no-postgres-port",
153 help="Disable port map of Postgres to host",
154 is_flag=True,
155 hidden=True,
156 )
157 @click.option(
158 "--no-hasura-port",
159 help="Disable port map of Hasura to host",
160 is_flag=True,
161 hidden=True,
162 )
163 @click.option(
164 "--no-graphql-port",
165 help="Disable port map of the GraphqlAPI to host",
166 is_flag=True,
167 hidden=True,
168 )
169 @click.option(
170 "--no-ui-port", help="Disable port map of the UI to host", is_flag=True, hidden=True
171 )
172 @click.option(
173 "--no-server-port",
174 help="Disable port map of the Core server to host",
175 is_flag=True,
176 hidden=True,
177 )
178 def start(
179 version,
180 skip_pull,
181 no_upgrade,
182 no_ui,
183 postgres_port,
184 hasura_port,
185 graphql_port,
186 ui_port,
187 server_port,
188 no_postgres_port,
189 no_hasura_port,
190 no_graphql_port,
191 no_ui_port,
192 no_server_port,
193 ):
194 """
195 This command spins up all infrastructure and services for the Prefect Core server
196
197 \b
198 Options:
199 --version, -v TEXT The server image versions to use (for example, '0.10.0' or 'master')
200 Defaults to the current installed Prefect version.
201 --skip-pull Flag to skip pulling new images (if available)
202 --no-upgrade, -n Flag to avoid running a database upgrade when the database spins up
203 --no-ui, -u Flag to avoid starting the UI
204
205 \b
206 --postgres-port TEXT Port used to serve Postgres, defaults to '5432'
207 --hasura-port TEXT Port used to serve Hasura, defaults to '3001'
208 --graphql-port TEXT Port used to serve the GraphQL API, defaults to '4001'
209 --ui-port TEXT Port used to serve the UI, defaults to '8080'
210 --server-port TEXT Port used to serve the Core server, defaults to '4200'
211
212 \b
213 --no-postgres-port Disable port map of Postgres to host
214 --no-hasura-port Disable port map of Hasura to host
215 --no-graphql-port Disable port map of the GraphQL API to host
216 --no-ui-port Disable port map of the UI to host
217 --no-server-port Disable port map of the Core server to host
218 """
219
220 docker_dir = Path(__file__).parents[0]
221 compose_dir_path = docker_dir
222
223 # Remove port mappings if specified
224 if (
225 no_postgres_port
226 or no_hasura_port
227 or no_graphql_port
228 or no_ui_port
229 or no_server_port
230 or platform_is_linux()
231 ):
232 temp_dir = tempfile.gettempdir()
233 temp_path = os.path.join(temp_dir, "docker-compose.yml")
234 shutil.copy2(os.path.join(docker_dir, "docker-compose.yml"), temp_path)
235
236 with open(temp_path, "r") as file:
237 y = yaml.safe_load(file)
238
239 if no_postgres_port:
240 del y["services"]["postgres"]["ports"]
241
242 if no_hasura_port:
243 del y["services"]["hasura"]["ports"]
244
245 if no_graphql_port:
246 del y["services"]["graphql"]["ports"]
247
248 if no_ui_port:
249 del y["services"]["ui"]["ports"]
250
251 if no_server_port:
252 del y["services"]["apollo"]["ports"]
253
254 if platform_is_linux():
255 docker_internal_ip = get_docker_ip()
256 for service in list(y["services"]):
257 y["services"][service]["extra_hosts"] = [
258 "host.docker.internal:{}".format(docker_internal_ip)
259 ]
260
261 with open(temp_path, "w") as f:
262 y = yaml.safe_dump(y, f)
263
264 compose_dir_path = temp_dir
265
266 # Temporary config set for port allocation
267 with set_temporary_config(
268 {
269 "server.database.host_port": postgres_port,
270 "server.hasura.host_port": hasura_port,
271 "server.graphql.host_port": graphql_port,
272 "server.ui.host_port": ui_port,
273 "server.host_port": server_port,
274 }
275 ):
276 env = make_env()
277
278 if "PREFECT_SERVER_TAG" not in env:
279 env.update(
280 PREFECT_SERVER_TAG=version
281 or (
282 "master"
283 if len(prefect.__version__.split("+")) > 1
284 else prefect.__version__
285 )
286 )
287 if "PREFECT_SERVER_DB_CMD" not in env:
288 cmd = (
289 "prefect-server database upgrade -y"
290 if not no_upgrade
291 else "echo 'DATABASE MIGRATIONS SKIPPED'"
292 )
293 env.update(PREFECT_SERVER_DB_CMD=cmd)
294
295 proc = None
296 try:
297 if not skip_pull:
298 subprocess.check_call(
299 ["docker-compose", "pull"], cwd=compose_dir_path, env=env
300 )
301
302 cmd = ["docker-compose", "up"]
303 if no_ui:
304 cmd += ["--scale", "ui=0"]
305 proc = subprocess.Popen(cmd, cwd=compose_dir_path, env=env)
306 while True:
307 time.sleep(0.5)
308 except:
309 click.secho(
310 "Exception caught; killing services (press ctrl-C to force)",
311 fg="white",
312 bg="red",
313 )
314 subprocess.check_output(
315 ["docker-compose", "down"], cwd=compose_dir_path, env=env
316 )
317 if proc:
318 proc.kill()
319 raise
320
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/src/prefect/cli/server.py b/src/prefect/cli/server.py
--- a/src/prefect/cli/server.py
+++ b/src/prefect/cli/server.py
@@ -38,6 +38,9 @@
port=config.server.graphql.port
),
APOLLO_HOST_PORT=config.server.host_port,
+ PREFECT_SERVER__TELEMETRY__ENABLED=(
+ "true" if config.server.telemetry.enabled is True else "false"
+ ),
)
POSTGRES_ENV = dict(
|
{"golden_diff": "diff --git a/src/prefect/cli/server.py b/src/prefect/cli/server.py\n--- a/src/prefect/cli/server.py\n+++ b/src/prefect/cli/server.py\n@@ -38,6 +38,9 @@\n port=config.server.graphql.port\n ),\n APOLLO_HOST_PORT=config.server.host_port,\n+ PREFECT_SERVER__TELEMETRY__ENABLED=(\n+ \"true\" if config.server.telemetry.enabled is True else \"false\"\n+ ),\n )\n \n POSTGRES_ENV = dict(\n", "issue": "Feature/#2439 prefect server telemetry\n**Thanks for contributing to Prefect!**\r\n\r\nPlease describe your work and make sure your PR:\r\n\r\n- [x] adds new tests (if appropriate)\r\n- [x] updates `CHANGELOG.md` (if appropriate)\r\n- [x] updates docstrings for any new functions or function arguments, including `docs/outline.toml` for API reference docs (if appropriate)\r\n\r\nNote that your PR will not be reviewed unless all three boxes are checked.\r\n\r\n## What does this PR change?\r\n\r\nThis PR closes #2467 and adds some minimal telemetry to Prefect Server.\r\n\r\n## Why is this PR important?\r\n\r\nThis is the first step into collecting usage information that can help the Prefect team understand how Prefect Server is being used and how we can make it better.\r\n\n", "before_files": [{"content": "import os\nimport shutil\nimport subprocess\nimport tempfile\nimport time\nfrom pathlib import Path\n\nimport click\nimport yaml\n\nimport prefect\nfrom prefect import config\nfrom prefect.utilities.configuration import set_temporary_config\nfrom prefect.utilities.docker_util import platform_is_linux, get_docker_ip\n\n\ndef make_env(fname=None):\n # replace localhost with postgres to use docker-compose dns\n PREFECT_ENV = dict(\n DB_CONNECTION_URL=config.server.database.connection_url.replace(\n \"localhost\", \"postgres\"\n ),\n GRAPHQL_HOST_PORT=config.server.graphql.host_port,\n UI_HOST_PORT=config.server.ui.host_port,\n )\n\n APOLLO_ENV = dict(\n HASURA_API_URL=\"http://hasura:{}/v1alpha1/graphql\".format(\n config.server.hasura.port\n ),\n HASURA_WS_URL=\"ws://hasura:{}/v1alpha1/graphql\".format(\n config.server.hasura.port\n ),\n PREFECT_API_URL=\"http://graphql:{port}{path}\".format(\n port=config.server.graphql.port, path=config.server.graphql.path\n ),\n PREFECT_API_HEALTH_URL=\"http://graphql:{port}/health\".format(\n port=config.server.graphql.port\n ),\n APOLLO_HOST_PORT=config.server.host_port,\n )\n\n POSTGRES_ENV = dict(\n POSTGRES_HOST_PORT=config.server.database.host_port,\n POSTGRES_USER=config.server.database.username,\n POSTGRES_PASSWORD=config.server.database.password,\n POSTGRES_DB=config.server.database.name,\n )\n\n UI_ENV = dict(GRAPHQL_URL=config.server.ui.graphql_url)\n\n HASURA_ENV = dict(HASURA_HOST_PORT=config.server.hasura.host_port)\n\n ENV = os.environ.copy()\n ENV.update(**PREFECT_ENV, **APOLLO_ENV, **POSTGRES_ENV, **UI_ENV, **HASURA_ENV)\n\n if fname is not None:\n list_of_pairs = [\n \"{k}={repr(v)}\".format(k=k, v=v)\n if \"\\n\" in v\n else \"{k}={v}\".format(k=k, v=v)\n for k, v in ENV.items()\n ]\n with open(fname, \"w\") as f:\n f.write(\"\\n\".join(list_of_pairs))\n return ENV.copy()\n\n\[email protected](hidden=True)\ndef server():\n \"\"\"\n Commands for interacting with the Prefect Core server\n\n \\b\n Usage:\n $ prefect server ...\n\n \\b\n Arguments:\n start ...\n\n \\b\n Examples:\n $ prefect server start\n ...\n \"\"\"\n\n\[email protected](hidden=True)\[email protected](\n \"--version\",\n \"-v\",\n help=\"The server image versions to use (for example, '0.10.0' or 'master')\",\n hidden=True,\n)\[email protected](\n \"--skip-pull\",\n help=\"Pass this flag to skip pulling new images (if available)\",\n is_flag=True,\n hidden=True,\n)\[email protected](\n \"--no-upgrade\",\n \"-n\",\n help=\"Pass this flag to avoid running a database upgrade when the database spins up\",\n is_flag=True,\n hidden=True,\n)\[email protected](\n \"--no-ui\",\n \"-u\",\n help=\"Pass this flag to avoid starting the UI\",\n is_flag=True,\n hidden=True,\n)\[email protected](\n \"--postgres-port\",\n help=\"The port used to serve Postgres\",\n default=config.server.database.host_port,\n type=str,\n hidden=True,\n)\[email protected](\n \"--hasura-port\",\n help=\"The port used to serve Hasura\",\n default=config.server.hasura.host_port,\n type=str,\n hidden=True,\n)\[email protected](\n \"--graphql-port\",\n help=\"The port used to serve the GraphQL API\",\n default=config.server.graphql.host_port,\n type=str,\n hidden=True,\n)\[email protected](\n \"--ui-port\",\n help=\"The port used to serve the UI\",\n default=config.server.ui.host_port,\n type=str,\n hidden=True,\n)\[email protected](\n \"--server-port\",\n help=\"The port used to serve the Core server\",\n default=config.server.host_port,\n type=str,\n hidden=True,\n)\[email protected](\n \"--no-postgres-port\",\n help=\"Disable port map of Postgres to host\",\n is_flag=True,\n hidden=True,\n)\[email protected](\n \"--no-hasura-port\",\n help=\"Disable port map of Hasura to host\",\n is_flag=True,\n hidden=True,\n)\[email protected](\n \"--no-graphql-port\",\n help=\"Disable port map of the GraphqlAPI to host\",\n is_flag=True,\n hidden=True,\n)\[email protected](\n \"--no-ui-port\", help=\"Disable port map of the UI to host\", is_flag=True, hidden=True\n)\[email protected](\n \"--no-server-port\",\n help=\"Disable port map of the Core server to host\",\n is_flag=True,\n hidden=True,\n)\ndef start(\n version,\n skip_pull,\n no_upgrade,\n no_ui,\n postgres_port,\n hasura_port,\n graphql_port,\n ui_port,\n server_port,\n no_postgres_port,\n no_hasura_port,\n no_graphql_port,\n no_ui_port,\n no_server_port,\n):\n \"\"\"\n This command spins up all infrastructure and services for the Prefect Core server\n\n \\b\n Options:\n --version, -v TEXT The server image versions to use (for example, '0.10.0' or 'master')\n Defaults to the current installed Prefect version.\n --skip-pull Flag to skip pulling new images (if available)\n --no-upgrade, -n Flag to avoid running a database upgrade when the database spins up\n --no-ui, -u Flag to avoid starting the UI\n\n \\b\n --postgres-port TEXT Port used to serve Postgres, defaults to '5432'\n --hasura-port TEXT Port used to serve Hasura, defaults to '3001'\n --graphql-port TEXT Port used to serve the GraphQL API, defaults to '4001'\n --ui-port TEXT Port used to serve the UI, defaults to '8080'\n --server-port TEXT Port used to serve the Core server, defaults to '4200'\n\n \\b\n --no-postgres-port Disable port map of Postgres to host\n --no-hasura-port Disable port map of Hasura to host\n --no-graphql-port Disable port map of the GraphQL API to host\n --no-ui-port Disable port map of the UI to host\n --no-server-port Disable port map of the Core server to host\n \"\"\"\n\n docker_dir = Path(__file__).parents[0]\n compose_dir_path = docker_dir\n\n # Remove port mappings if specified\n if (\n no_postgres_port\n or no_hasura_port\n or no_graphql_port\n or no_ui_port\n or no_server_port\n or platform_is_linux()\n ):\n temp_dir = tempfile.gettempdir()\n temp_path = os.path.join(temp_dir, \"docker-compose.yml\")\n shutil.copy2(os.path.join(docker_dir, \"docker-compose.yml\"), temp_path)\n\n with open(temp_path, \"r\") as file:\n y = yaml.safe_load(file)\n\n if no_postgres_port:\n del y[\"services\"][\"postgres\"][\"ports\"]\n\n if no_hasura_port:\n del y[\"services\"][\"hasura\"][\"ports\"]\n\n if no_graphql_port:\n del y[\"services\"][\"graphql\"][\"ports\"]\n\n if no_ui_port:\n del y[\"services\"][\"ui\"][\"ports\"]\n\n if no_server_port:\n del y[\"services\"][\"apollo\"][\"ports\"]\n\n if platform_is_linux():\n docker_internal_ip = get_docker_ip()\n for service in list(y[\"services\"]):\n y[\"services\"][service][\"extra_hosts\"] = [\n \"host.docker.internal:{}\".format(docker_internal_ip)\n ]\n\n with open(temp_path, \"w\") as f:\n y = yaml.safe_dump(y, f)\n\n compose_dir_path = temp_dir\n\n # Temporary config set for port allocation\n with set_temporary_config(\n {\n \"server.database.host_port\": postgres_port,\n \"server.hasura.host_port\": hasura_port,\n \"server.graphql.host_port\": graphql_port,\n \"server.ui.host_port\": ui_port,\n \"server.host_port\": server_port,\n }\n ):\n env = make_env()\n\n if \"PREFECT_SERVER_TAG\" not in env:\n env.update(\n PREFECT_SERVER_TAG=version\n or (\n \"master\"\n if len(prefect.__version__.split(\"+\")) > 1\n else prefect.__version__\n )\n )\n if \"PREFECT_SERVER_DB_CMD\" not in env:\n cmd = (\n \"prefect-server database upgrade -y\"\n if not no_upgrade\n else \"echo 'DATABASE MIGRATIONS SKIPPED'\"\n )\n env.update(PREFECT_SERVER_DB_CMD=cmd)\n\n proc = None\n try:\n if not skip_pull:\n subprocess.check_call(\n [\"docker-compose\", \"pull\"], cwd=compose_dir_path, env=env\n )\n\n cmd = [\"docker-compose\", \"up\"]\n if no_ui:\n cmd += [\"--scale\", \"ui=0\"]\n proc = subprocess.Popen(cmd, cwd=compose_dir_path, env=env)\n while True:\n time.sleep(0.5)\n except:\n click.secho(\n \"Exception caught; killing services (press ctrl-C to force)\",\n fg=\"white\",\n bg=\"red\",\n )\n subprocess.check_output(\n [\"docker-compose\", \"down\"], cwd=compose_dir_path, env=env\n )\n if proc:\n proc.kill()\n raise\n", "path": "src/prefect/cli/server.py"}], "after_files": [{"content": "import os\nimport shutil\nimport subprocess\nimport tempfile\nimport time\nfrom pathlib import Path\n\nimport click\nimport yaml\n\nimport prefect\nfrom prefect import config\nfrom prefect.utilities.configuration import set_temporary_config\nfrom prefect.utilities.docker_util import platform_is_linux, get_docker_ip\n\n\ndef make_env(fname=None):\n # replace localhost with postgres to use docker-compose dns\n PREFECT_ENV = dict(\n DB_CONNECTION_URL=config.server.database.connection_url.replace(\n \"localhost\", \"postgres\"\n ),\n GRAPHQL_HOST_PORT=config.server.graphql.host_port,\n UI_HOST_PORT=config.server.ui.host_port,\n )\n\n APOLLO_ENV = dict(\n HASURA_API_URL=\"http://hasura:{}/v1alpha1/graphql\".format(\n config.server.hasura.port\n ),\n HASURA_WS_URL=\"ws://hasura:{}/v1alpha1/graphql\".format(\n config.server.hasura.port\n ),\n PREFECT_API_URL=\"http://graphql:{port}{path}\".format(\n port=config.server.graphql.port, path=config.server.graphql.path\n ),\n PREFECT_API_HEALTH_URL=\"http://graphql:{port}/health\".format(\n port=config.server.graphql.port\n ),\n APOLLO_HOST_PORT=config.server.host_port,\n PREFECT_SERVER__TELEMETRY__ENABLED=(\n \"true\" if config.server.telemetry.enabled is True else \"false\"\n ),\n )\n\n POSTGRES_ENV = dict(\n POSTGRES_HOST_PORT=config.server.database.host_port,\n POSTGRES_USER=config.server.database.username,\n POSTGRES_PASSWORD=config.server.database.password,\n POSTGRES_DB=config.server.database.name,\n )\n\n UI_ENV = dict(GRAPHQL_URL=config.server.ui.graphql_url)\n\n HASURA_ENV = dict(HASURA_HOST_PORT=config.server.hasura.host_port)\n\n ENV = os.environ.copy()\n ENV.update(**PREFECT_ENV, **APOLLO_ENV, **POSTGRES_ENV, **UI_ENV, **HASURA_ENV)\n\n if fname is not None:\n list_of_pairs = [\n \"{k}={repr(v)}\".format(k=k, v=v)\n if \"\\n\" in v\n else \"{k}={v}\".format(k=k, v=v)\n for k, v in ENV.items()\n ]\n with open(fname, \"w\") as f:\n f.write(\"\\n\".join(list_of_pairs))\n return ENV.copy()\n\n\[email protected](hidden=True)\ndef server():\n \"\"\"\n Commands for interacting with the Prefect Core server\n\n \\b\n Usage:\n $ prefect server ...\n\n \\b\n Arguments:\n start ...\n\n \\b\n Examples:\n $ prefect server start\n ...\n \"\"\"\n\n\[email protected](hidden=True)\[email protected](\n \"--version\",\n \"-v\",\n help=\"The server image versions to use (for example, '0.10.0' or 'master')\",\n hidden=True,\n)\[email protected](\n \"--skip-pull\",\n help=\"Pass this flag to skip pulling new images (if available)\",\n is_flag=True,\n hidden=True,\n)\[email protected](\n \"--no-upgrade\",\n \"-n\",\n help=\"Pass this flag to avoid running a database upgrade when the database spins up\",\n is_flag=True,\n hidden=True,\n)\[email protected](\n \"--no-ui\",\n \"-u\",\n help=\"Pass this flag to avoid starting the UI\",\n is_flag=True,\n hidden=True,\n)\[email protected](\n \"--postgres-port\",\n help=\"The port used to serve Postgres\",\n default=config.server.database.host_port,\n type=str,\n hidden=True,\n)\[email protected](\n \"--hasura-port\",\n help=\"The port used to serve Hasura\",\n default=config.server.hasura.host_port,\n type=str,\n hidden=True,\n)\[email protected](\n \"--graphql-port\",\n help=\"The port used to serve the GraphQL API\",\n default=config.server.graphql.host_port,\n type=str,\n hidden=True,\n)\[email protected](\n \"--ui-port\",\n help=\"The port used to serve the UI\",\n default=config.server.ui.host_port,\n type=str,\n hidden=True,\n)\[email protected](\n \"--server-port\",\n help=\"The port used to serve the Core server\",\n default=config.server.host_port,\n type=str,\n hidden=True,\n)\[email protected](\n \"--no-postgres-port\",\n help=\"Disable port map of Postgres to host\",\n is_flag=True,\n hidden=True,\n)\[email protected](\n \"--no-hasura-port\",\n help=\"Disable port map of Hasura to host\",\n is_flag=True,\n hidden=True,\n)\[email protected](\n \"--no-graphql-port\",\n help=\"Disable port map of the GraphqlAPI to host\",\n is_flag=True,\n hidden=True,\n)\[email protected](\n \"--no-ui-port\", help=\"Disable port map of the UI to host\", is_flag=True, hidden=True\n)\[email protected](\n \"--no-server-port\",\n help=\"Disable port map of the Core server to host\",\n is_flag=True,\n hidden=True,\n)\ndef start(\n version,\n skip_pull,\n no_upgrade,\n no_ui,\n postgres_port,\n hasura_port,\n graphql_port,\n ui_port,\n server_port,\n no_postgres_port,\n no_hasura_port,\n no_graphql_port,\n no_ui_port,\n no_server_port,\n):\n \"\"\"\n This command spins up all infrastructure and services for the Prefect Core server\n\n \\b\n Options:\n --version, -v TEXT The server image versions to use (for example, '0.10.0' or 'master')\n Defaults to the current installed Prefect version.\n --skip-pull Flag to skip pulling new images (if available)\n --no-upgrade, -n Flag to avoid running a database upgrade when the database spins up\n --no-ui, -u Flag to avoid starting the UI\n\n \\b\n --postgres-port TEXT Port used to serve Postgres, defaults to '5432'\n --hasura-port TEXT Port used to serve Hasura, defaults to '3001'\n --graphql-port TEXT Port used to serve the GraphQL API, defaults to '4001'\n --ui-port TEXT Port used to serve the UI, defaults to '8080'\n --server-port TEXT Port used to serve the Core server, defaults to '4200'\n\n \\b\n --no-postgres-port Disable port map of Postgres to host\n --no-hasura-port Disable port map of Hasura to host\n --no-graphql-port Disable port map of the GraphQL API to host\n --no-ui-port Disable port map of the UI to host\n --no-server-port Disable port map of the Core server to host\n \"\"\"\n\n docker_dir = Path(__file__).parents[0]\n compose_dir_path = docker_dir\n\n # Remove port mappings if specified\n if (\n no_postgres_port\n or no_hasura_port\n or no_graphql_port\n or no_ui_port\n or no_server_port\n or platform_is_linux()\n ):\n temp_dir = tempfile.gettempdir()\n temp_path = os.path.join(temp_dir, \"docker-compose.yml\")\n shutil.copy2(os.path.join(docker_dir, \"docker-compose.yml\"), temp_path)\n\n with open(temp_path, \"r\") as file:\n y = yaml.safe_load(file)\n\n if no_postgres_port:\n del y[\"services\"][\"postgres\"][\"ports\"]\n\n if no_hasura_port:\n del y[\"services\"][\"hasura\"][\"ports\"]\n\n if no_graphql_port:\n del y[\"services\"][\"graphql\"][\"ports\"]\n\n if no_ui_port:\n del y[\"services\"][\"ui\"][\"ports\"]\n\n if no_server_port:\n del y[\"services\"][\"apollo\"][\"ports\"]\n\n if platform_is_linux():\n docker_internal_ip = get_docker_ip()\n for service in list(y[\"services\"]):\n y[\"services\"][service][\"extra_hosts\"] = [\n \"host.docker.internal:{}\".format(docker_internal_ip)\n ]\n\n with open(temp_path, \"w\") as f:\n y = yaml.safe_dump(y, f)\n\n compose_dir_path = temp_dir\n\n # Temporary config set for port allocation\n with set_temporary_config(\n {\n \"server.database.host_port\": postgres_port,\n \"server.hasura.host_port\": hasura_port,\n \"server.graphql.host_port\": graphql_port,\n \"server.ui.host_port\": ui_port,\n \"server.host_port\": server_port,\n }\n ):\n env = make_env()\n\n if \"PREFECT_SERVER_TAG\" not in env:\n env.update(\n PREFECT_SERVER_TAG=version\n or (\n \"master\"\n if len(prefect.__version__.split(\"+\")) > 1\n else prefect.__version__\n )\n )\n if \"PREFECT_SERVER_DB_CMD\" not in env:\n cmd = (\n \"prefect-server database upgrade -y\"\n if not no_upgrade\n else \"echo 'DATABASE MIGRATIONS SKIPPED'\"\n )\n env.update(PREFECT_SERVER_DB_CMD=cmd)\n\n proc = None\n try:\n if not skip_pull:\n subprocess.check_call(\n [\"docker-compose\", \"pull\"], cwd=compose_dir_path, env=env\n )\n\n cmd = [\"docker-compose\", \"up\"]\n if no_ui:\n cmd += [\"--scale\", \"ui=0\"]\n proc = subprocess.Popen(cmd, cwd=compose_dir_path, env=env)\n while True:\n time.sleep(0.5)\n except:\n click.secho(\n \"Exception caught; killing services (press ctrl-C to force)\",\n fg=\"white\",\n bg=\"red\",\n )\n subprocess.check_output(\n [\"docker-compose\", \"down\"], cwd=compose_dir_path, env=env\n )\n if proc:\n proc.kill()\n raise\n", "path": "src/prefect/cli/server.py"}]}
| 3,421 | 117 |
gh_patches_debug_35313
|
rasdani/github-patches
|
git_diff
|
ocadotechnology__aimmo-143
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Improve error handling when getting worker actions.
Have `AvatarWrapper.decide_action` default to setting a `WaitAction` if anything goes wrong.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `aimmo-game/simulation/avatar/avatar_wrapper.py`
Content:
```
1 import logging
2 import requests
3
4 from simulation.action import ACTIONS, MoveAction
5
6 LOGGER = logging.getLogger(__name__)
7
8
9 class AvatarWrapper(object):
10 """
11 The application's view of a character, not to be confused with "Avatar",
12 the player-supplied code.
13 """
14
15 def __init__(self, player_id, initial_location, worker_url, avatar_appearance):
16 self.player_id = player_id
17 self.location = initial_location
18 self.health = 5
19 self.score = 0
20 self.events = []
21 self.avatar_appearance = avatar_appearance
22 self.worker_url = worker_url
23 self.fog_of_war_modifier = 0
24 self._action = None
25
26 @property
27 def action(self):
28 return self._action
29
30 @property
31 def is_moving(self):
32 return isinstance(self.action, MoveAction)
33
34 def decide_action(self, state_view):
35 try:
36 data = requests.post(self.worker_url, json=state_view).json()
37 except ValueError as err:
38 LOGGER.info('Failed to get turn result: %s', err)
39 return False
40 else:
41 try:
42 action_data = data['action']
43 action_type = action_data['action_type']
44 action_args = action_data.get('options', {})
45 action_args['avatar'] = self
46 action = ACTIONS[action_type](**action_args)
47 except (KeyError, ValueError) as err:
48 LOGGER.info('Bad action data supplied: %s', err)
49 return False
50 else:
51 self._action = action
52 return True
53
54 def clear_action(self):
55 self._action = None
56
57 def die(self, respawn_location):
58 # TODO: extract settings for health and score loss on death
59 self.health = 5
60 self.score = max(0, self.score - 2)
61 self.location = respawn_location
62
63 def add_event(self, event):
64 self.events.append(event)
65
66 def serialise(self):
67 return {
68 'events': [
69 # {
70 # 'event_name': event.__class__.__name__.lower(),
71 # 'event_options': event.__dict__,
72 # } for event in self.events
73 ],
74 'health': self.health,
75 'location': self.location.serialise(),
76 'score': self.score,
77 }
78
79 def __repr__(self):
80 return 'Avatar(id={}, location={}, health={}, score={})'.format(self.player_id, self.location, self.health, self.score)
81
```
Path: `aimmo-game/service.py`
Content:
```
1 #!/usr/bin/env python
2 import logging
3 import os
4 import sys
5
6 # If we monkey patch during testing then Django fails to create a DB enironment
7 if __name__ == '__main__':
8 import eventlet
9 eventlet.monkey_patch()
10
11 import flask
12 from flask_socketio import SocketIO, emit
13
14 from six.moves import range
15
16 from simulation.turn_manager import state_provider
17 from simulation import map_generator
18 from simulation.avatar.avatar_manager import AvatarManager
19 from simulation.location import Location
20 from simulation.game_state import GameState
21 from simulation.turn_manager import ConcurrentTurnManager
22 from simulation.turn_manager import SequentialTurnManager
23 from simulation.worker_manager import WORKER_MANAGERS
24
25 app = flask.Flask(__name__)
26 socketio = SocketIO()
27
28 worker_manager = None
29
30
31 def to_cell_type(cell):
32 if not cell.habitable:
33 return 1
34 if cell.generates_score:
35 return 2
36 return 0
37
38
39 def player_dict(avatar):
40 # TODO: implement better colour functionality: will eventually fall off end of numbers
41 colour = "#%06x" % (avatar.player_id * 4999)
42 return {
43 'id': avatar.player_id,
44 'x': avatar.location.x,
45 'y': avatar.location.y,
46 'health': avatar.health,
47 'score': avatar.score,
48 'rotation': 0,
49 "colours": {
50 "bodyStroke": "#0ff",
51 "bodyFill": colour,
52 "eyeStroke": "#aff",
53 "eyeFill": "#eff",
54 }
55 }
56
57
58 def get_world_state():
59 with state_provider as game_state:
60 world = game_state.world_map
61 num_cols = world.num_cols
62 num_rows = world.num_rows
63 grid = [[to_cell_type(world.get_cell(Location(x, y)))
64 for y in range(num_rows)]
65 for x in range(num_cols)]
66 player_data = {p.player_id: player_dict(p) for p in game_state.avatar_manager.avatars}
67 return {
68 'players': player_data,
69 'score_locations': [(cell.location.x, cell.location.y) for cell in world.score_cells()],
70 'pickup_locations': [(cell.location.x, cell.location.y) for cell in world.pickup_cells()],
71 'map_changed': True, # TODO: experiment with only sending deltas (not if not required)
72 'width': num_cols,
73 'height': num_rows,
74 'layout': grid,
75 }
76
77
78 @socketio.on('connect')
79 def world_update_on_connect():
80 emit(
81 'world-update',
82 get_world_state(),
83 )
84
85
86 def send_world_update():
87 socketio.emit(
88 'world-update',
89 get_world_state(),
90 broadcast=True,
91 )
92
93
94 @app.route('/')
95 def healthcheck():
96 return 'HEALTHY'
97
98
99 @app.route('/player/<player_id>')
100 def player_data(player_id):
101 player_id = int(player_id)
102 return flask.jsonify({
103 'code': worker_manager.get_code(player_id),
104 'options': {}, # Game options
105 'state': None,
106 })
107
108
109 def run_game():
110 global worker_manager
111
112 print("Running game...")
113 my_map = map_generator.generate_map(10, 10, 0.1)
114 player_manager = AvatarManager()
115 game_state = GameState(my_map, player_manager)
116 turn_manager = ConcurrentTurnManager(game_state=game_state, end_turn_callback=send_world_update)
117 WorkerManagerClass = WORKER_MANAGERS[os.environ.get('WORKER_MANAGER', 'local')]
118 worker_manager = WorkerManagerClass(
119 game_state=game_state,
120 users_url=os.environ.get('GAME_API_URL', 'http://localhost:8000/players/api/games/')
121 )
122 worker_manager.start()
123 turn_manager.start()
124
125
126 if __name__ == '__main__':
127 logging.basicConfig(level=logging.DEBUG)
128
129 socketio.init_app(app, resource=os.environ.get('SOCKETIO_RESOURCE', 'socket.io'))
130 run_game()
131 socketio.run(
132 app,
133 debug=False,
134 host=sys.argv[1],
135 port=int(sys.argv[2]),
136 use_reloader=False,
137 )
138
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/aimmo-game/service.py b/aimmo-game/service.py
--- a/aimmo-game/service.py
+++ b/aimmo-game/service.py
@@ -124,7 +124,7 @@
if __name__ == '__main__':
- logging.basicConfig(level=logging.DEBUG)
+ logging.basicConfig(level=logging.INFO)
socketio.init_app(app, resource=os.environ.get('SOCKETIO_RESOURCE', 'socket.io'))
run_game()
diff --git a/aimmo-game/simulation/avatar/avatar_wrapper.py b/aimmo-game/simulation/avatar/avatar_wrapper.py
--- a/aimmo-game/simulation/avatar/avatar_wrapper.py
+++ b/aimmo-game/simulation/avatar/avatar_wrapper.py
@@ -1,7 +1,7 @@
import logging
import requests
-from simulation.action import ACTIONS, MoveAction
+from simulation.action import ACTIONS, MoveAction, WaitAction
LOGGER = logging.getLogger(__name__)
@@ -31,25 +31,34 @@
def is_moving(self):
return isinstance(self.action, MoveAction)
+ def _fetch_action(self, state_view):
+ return requests.post(self.worker_url, json=state_view).json()
+
+ def _construct_action(self, data):
+ action_data = data['action']
+ action_type = action_data['action_type']
+ action_args = action_data.get('options', {})
+ action_args['avatar'] = self
+ return ACTIONS[action_type](**action_args)
+
def decide_action(self, state_view):
try:
- data = requests.post(self.worker_url, json=state_view).json()
- except ValueError as err:
- LOGGER.info('Failed to get turn result: %s', err)
- return False
+ data = self._fetch_action(state_view)
+ action = self._construct_action(data)
+
+ except (KeyError, ValueError) as err:
+ LOGGER.info('Bad action data supplied: %s', err)
+ except requests.exceptions.ConnectionError:
+ LOGGER.info('Could not connect to worker, probably not ready yet')
+ except Exception:
+ LOGGER.exception("Unknown error while fetching turn data")
+
else:
- try:
- action_data = data['action']
- action_type = action_data['action_type']
- action_args = action_data.get('options', {})
- action_args['avatar'] = self
- action = ACTIONS[action_type](**action_args)
- except (KeyError, ValueError) as err:
- LOGGER.info('Bad action data supplied: %s', err)
- return False
- else:
- self._action = action
- return True
+ self._action = action
+ return True
+
+ self._action = WaitAction(self)
+ return False
def clear_action(self):
self._action = None
|
{"golden_diff": "diff --git a/aimmo-game/service.py b/aimmo-game/service.py\n--- a/aimmo-game/service.py\n+++ b/aimmo-game/service.py\n@@ -124,7 +124,7 @@\n \n \n if __name__ == '__main__':\n- logging.basicConfig(level=logging.DEBUG)\n+ logging.basicConfig(level=logging.INFO)\n \n socketio.init_app(app, resource=os.environ.get('SOCKETIO_RESOURCE', 'socket.io'))\n run_game()\ndiff --git a/aimmo-game/simulation/avatar/avatar_wrapper.py b/aimmo-game/simulation/avatar/avatar_wrapper.py\n--- a/aimmo-game/simulation/avatar/avatar_wrapper.py\n+++ b/aimmo-game/simulation/avatar/avatar_wrapper.py\n@@ -1,7 +1,7 @@\n import logging\n import requests\n \n-from simulation.action import ACTIONS, MoveAction\n+from simulation.action import ACTIONS, MoveAction, WaitAction\n \n LOGGER = logging.getLogger(__name__)\n \n@@ -31,25 +31,34 @@\n def is_moving(self):\n return isinstance(self.action, MoveAction)\n \n+ def _fetch_action(self, state_view):\n+ return requests.post(self.worker_url, json=state_view).json()\n+\n+ def _construct_action(self, data):\n+ action_data = data['action']\n+ action_type = action_data['action_type']\n+ action_args = action_data.get('options', {})\n+ action_args['avatar'] = self\n+ return ACTIONS[action_type](**action_args)\n+\n def decide_action(self, state_view):\n try:\n- data = requests.post(self.worker_url, json=state_view).json()\n- except ValueError as err:\n- LOGGER.info('Failed to get turn result: %s', err)\n- return False\n+ data = self._fetch_action(state_view)\n+ action = self._construct_action(data)\n+\n+ except (KeyError, ValueError) as err:\n+ LOGGER.info('Bad action data supplied: %s', err)\n+ except requests.exceptions.ConnectionError:\n+ LOGGER.info('Could not connect to worker, probably not ready yet')\n+ except Exception:\n+ LOGGER.exception(\"Unknown error while fetching turn data\")\n+\n else:\n- try:\n- action_data = data['action']\n- action_type = action_data['action_type']\n- action_args = action_data.get('options', {})\n- action_args['avatar'] = self\n- action = ACTIONS[action_type](**action_args)\n- except (KeyError, ValueError) as err:\n- LOGGER.info('Bad action data supplied: %s', err)\n- return False\n- else:\n- self._action = action\n- return True\n+ self._action = action\n+ return True\n+\n+ self._action = WaitAction(self)\n+ return False\n \n def clear_action(self):\n self._action = None\n", "issue": "Improve error handling when getting worker actions.\nHave `AvatarWrapper.decide_action` default to setting a `WaitAction` if anything goes wrong.\n\n", "before_files": [{"content": "import logging\nimport requests\n\nfrom simulation.action import ACTIONS, MoveAction\n\nLOGGER = logging.getLogger(__name__)\n\n\nclass AvatarWrapper(object):\n \"\"\"\n The application's view of a character, not to be confused with \"Avatar\",\n the player-supplied code.\n \"\"\"\n\n def __init__(self, player_id, initial_location, worker_url, avatar_appearance):\n self.player_id = player_id\n self.location = initial_location\n self.health = 5\n self.score = 0\n self.events = []\n self.avatar_appearance = avatar_appearance\n self.worker_url = worker_url\n self.fog_of_war_modifier = 0\n self._action = None\n\n @property\n def action(self):\n return self._action\n\n @property\n def is_moving(self):\n return isinstance(self.action, MoveAction)\n\n def decide_action(self, state_view):\n try:\n data = requests.post(self.worker_url, json=state_view).json()\n except ValueError as err:\n LOGGER.info('Failed to get turn result: %s', err)\n return False\n else:\n try:\n action_data = data['action']\n action_type = action_data['action_type']\n action_args = action_data.get('options', {})\n action_args['avatar'] = self\n action = ACTIONS[action_type](**action_args)\n except (KeyError, ValueError) as err:\n LOGGER.info('Bad action data supplied: %s', err)\n return False\n else:\n self._action = action\n return True\n\n def clear_action(self):\n self._action = None\n\n def die(self, respawn_location):\n # TODO: extract settings for health and score loss on death\n self.health = 5\n self.score = max(0, self.score - 2)\n self.location = respawn_location\n\n def add_event(self, event):\n self.events.append(event)\n\n def serialise(self):\n return {\n 'events': [\n # {\n # 'event_name': event.__class__.__name__.lower(),\n # 'event_options': event.__dict__,\n # } for event in self.events\n ],\n 'health': self.health,\n 'location': self.location.serialise(),\n 'score': self.score,\n }\n\n def __repr__(self):\n return 'Avatar(id={}, location={}, health={}, score={})'.format(self.player_id, self.location, self.health, self.score)\n", "path": "aimmo-game/simulation/avatar/avatar_wrapper.py"}, {"content": "#!/usr/bin/env python\nimport logging\nimport os\nimport sys\n\n# If we monkey patch during testing then Django fails to create a DB enironment\nif __name__ == '__main__':\n import eventlet\n eventlet.monkey_patch()\n\nimport flask\nfrom flask_socketio import SocketIO, emit\n\nfrom six.moves import range\n\nfrom simulation.turn_manager import state_provider\nfrom simulation import map_generator\nfrom simulation.avatar.avatar_manager import AvatarManager\nfrom simulation.location import Location\nfrom simulation.game_state import GameState\nfrom simulation.turn_manager import ConcurrentTurnManager\nfrom simulation.turn_manager import SequentialTurnManager\nfrom simulation.worker_manager import WORKER_MANAGERS\n\napp = flask.Flask(__name__)\nsocketio = SocketIO()\n\nworker_manager = None\n\n\ndef to_cell_type(cell):\n if not cell.habitable:\n return 1\n if cell.generates_score:\n return 2\n return 0\n\n\ndef player_dict(avatar):\n # TODO: implement better colour functionality: will eventually fall off end of numbers\n colour = \"#%06x\" % (avatar.player_id * 4999)\n return {\n 'id': avatar.player_id,\n 'x': avatar.location.x,\n 'y': avatar.location.y,\n 'health': avatar.health,\n 'score': avatar.score,\n 'rotation': 0,\n \"colours\": {\n \"bodyStroke\": \"#0ff\",\n \"bodyFill\": colour,\n \"eyeStroke\": \"#aff\",\n \"eyeFill\": \"#eff\",\n }\n }\n\n\ndef get_world_state():\n with state_provider as game_state:\n world = game_state.world_map\n num_cols = world.num_cols\n num_rows = world.num_rows\n grid = [[to_cell_type(world.get_cell(Location(x, y)))\n for y in range(num_rows)]\n for x in range(num_cols)]\n player_data = {p.player_id: player_dict(p) for p in game_state.avatar_manager.avatars}\n return {\n 'players': player_data,\n 'score_locations': [(cell.location.x, cell.location.y) for cell in world.score_cells()],\n 'pickup_locations': [(cell.location.x, cell.location.y) for cell in world.pickup_cells()],\n 'map_changed': True, # TODO: experiment with only sending deltas (not if not required)\n 'width': num_cols,\n 'height': num_rows,\n 'layout': grid,\n }\n\n\[email protected]('connect')\ndef world_update_on_connect():\n emit(\n 'world-update',\n get_world_state(),\n )\n\n\ndef send_world_update():\n socketio.emit(\n 'world-update',\n get_world_state(),\n broadcast=True,\n )\n\n\[email protected]('/')\ndef healthcheck():\n return 'HEALTHY'\n\n\[email protected]('/player/<player_id>')\ndef player_data(player_id):\n player_id = int(player_id)\n return flask.jsonify({\n 'code': worker_manager.get_code(player_id),\n 'options': {}, # Game options\n 'state': None,\n })\n\n\ndef run_game():\n global worker_manager\n\n print(\"Running game...\")\n my_map = map_generator.generate_map(10, 10, 0.1)\n player_manager = AvatarManager()\n game_state = GameState(my_map, player_manager)\n turn_manager = ConcurrentTurnManager(game_state=game_state, end_turn_callback=send_world_update)\n WorkerManagerClass = WORKER_MANAGERS[os.environ.get('WORKER_MANAGER', 'local')]\n worker_manager = WorkerManagerClass(\n game_state=game_state,\n users_url=os.environ.get('GAME_API_URL', 'http://localhost:8000/players/api/games/')\n )\n worker_manager.start()\n turn_manager.start()\n\n\nif __name__ == '__main__':\n logging.basicConfig(level=logging.DEBUG)\n\n socketio.init_app(app, resource=os.environ.get('SOCKETIO_RESOURCE', 'socket.io'))\n run_game()\n socketio.run(\n app,\n debug=False,\n host=sys.argv[1],\n port=int(sys.argv[2]),\n use_reloader=False,\n )\n", "path": "aimmo-game/service.py"}], "after_files": [{"content": "import logging\nimport requests\n\nfrom simulation.action import ACTIONS, MoveAction, WaitAction\n\nLOGGER = logging.getLogger(__name__)\n\n\nclass AvatarWrapper(object):\n \"\"\"\n The application's view of a character, not to be confused with \"Avatar\",\n the player-supplied code.\n \"\"\"\n\n def __init__(self, player_id, initial_location, worker_url, avatar_appearance):\n self.player_id = player_id\n self.location = initial_location\n self.health = 5\n self.score = 0\n self.events = []\n self.avatar_appearance = avatar_appearance\n self.worker_url = worker_url\n self.fog_of_war_modifier = 0\n self._action = None\n\n @property\n def action(self):\n return self._action\n\n @property\n def is_moving(self):\n return isinstance(self.action, MoveAction)\n\n def _fetch_action(self, state_view):\n return requests.post(self.worker_url, json=state_view).json()\n\n def _construct_action(self, data):\n action_data = data['action']\n action_type = action_data['action_type']\n action_args = action_data.get('options', {})\n action_args['avatar'] = self\n return ACTIONS[action_type](**action_args)\n\n def decide_action(self, state_view):\n try:\n data = self._fetch_action(state_view)\n action = self._construct_action(data)\n\n except (KeyError, ValueError) as err:\n LOGGER.info('Bad action data supplied: %s', err)\n except requests.exceptions.ConnectionError:\n LOGGER.info('Could not connect to worker, probably not ready yet')\n except Exception:\n LOGGER.exception(\"Unknown error while fetching turn data\")\n\n else:\n self._action = action\n return True\n\n self._action = WaitAction(self)\n return False\n\n def clear_action(self):\n self._action = None\n\n def die(self, respawn_location):\n # TODO: extract settings for health and score loss on death\n self.health = 5\n self.score = max(0, self.score - 2)\n self.location = respawn_location\n\n def add_event(self, event):\n self.events.append(event)\n\n def serialise(self):\n return {\n 'events': [\n # {\n # 'event_name': event.__class__.__name__.lower(),\n # 'event_options': event.__dict__,\n # } for event in self.events\n ],\n 'health': self.health,\n 'location': self.location.serialise(),\n 'score': self.score,\n }\n\n def __repr__(self):\n return 'Avatar(id={}, location={}, health={}, score={})'.format(self.player_id, self.location, self.health, self.score)\n", "path": "aimmo-game/simulation/avatar/avatar_wrapper.py"}, {"content": "#!/usr/bin/env python\nimport logging\nimport os\nimport sys\n\n# If we monkey patch during testing then Django fails to create a DB enironment\nif __name__ == '__main__':\n import eventlet\n eventlet.monkey_patch()\n\nimport flask\nfrom flask_socketio import SocketIO, emit\n\nfrom six.moves import range\n\nfrom simulation.turn_manager import state_provider\nfrom simulation import map_generator\nfrom simulation.avatar.avatar_manager import AvatarManager\nfrom simulation.location import Location\nfrom simulation.game_state import GameState\nfrom simulation.turn_manager import ConcurrentTurnManager\nfrom simulation.turn_manager import SequentialTurnManager\nfrom simulation.worker_manager import WORKER_MANAGERS\n\napp = flask.Flask(__name__)\nsocketio = SocketIO()\n\nworker_manager = None\n\n\ndef to_cell_type(cell):\n if not cell.habitable:\n return 1\n if cell.generates_score:\n return 2\n return 0\n\n\ndef player_dict(avatar):\n # TODO: implement better colour functionality: will eventually fall off end of numbers\n colour = \"#%06x\" % (avatar.player_id * 4999)\n return {\n 'id': avatar.player_id,\n 'x': avatar.location.x,\n 'y': avatar.location.y,\n 'health': avatar.health,\n 'score': avatar.score,\n 'rotation': 0,\n \"colours\": {\n \"bodyStroke\": \"#0ff\",\n \"bodyFill\": colour,\n \"eyeStroke\": \"#aff\",\n \"eyeFill\": \"#eff\",\n }\n }\n\n\ndef get_world_state():\n with state_provider as game_state:\n world = game_state.world_map\n num_cols = world.num_cols\n num_rows = world.num_rows\n grid = [[to_cell_type(world.get_cell(Location(x, y)))\n for y in range(num_rows)]\n for x in range(num_cols)]\n player_data = {p.player_id: player_dict(p) for p in game_state.avatar_manager.avatars}\n return {\n 'players': player_data,\n 'score_locations': [(cell.location.x, cell.location.y) for cell in world.score_cells()],\n 'pickup_locations': [(cell.location.x, cell.location.y) for cell in world.pickup_cells()],\n 'map_changed': True, # TODO: experiment with only sending deltas (not if not required)\n 'width': num_cols,\n 'height': num_rows,\n 'layout': grid,\n }\n\n\[email protected]('connect')\ndef world_update_on_connect():\n emit(\n 'world-update',\n get_world_state(),\n )\n\n\ndef send_world_update():\n socketio.emit(\n 'world-update',\n get_world_state(),\n broadcast=True,\n )\n\n\[email protected]('/')\ndef healthcheck():\n return 'HEALTHY'\n\n\[email protected]('/player/<player_id>')\ndef player_data(player_id):\n player_id = int(player_id)\n return flask.jsonify({\n 'code': worker_manager.get_code(player_id),\n 'options': {}, # Game options\n 'state': None,\n })\n\n\ndef run_game():\n global worker_manager\n\n print(\"Running game...\")\n my_map = map_generator.generate_map(10, 10, 0.1)\n player_manager = AvatarManager()\n game_state = GameState(my_map, player_manager)\n turn_manager = ConcurrentTurnManager(game_state=game_state, end_turn_callback=send_world_update)\n WorkerManagerClass = WORKER_MANAGERS[os.environ.get('WORKER_MANAGER', 'local')]\n worker_manager = WorkerManagerClass(\n game_state=game_state,\n users_url=os.environ.get('GAME_API_URL', 'http://localhost:8000/players/api/games/')\n )\n worker_manager.start()\n turn_manager.start()\n\n\nif __name__ == '__main__':\n logging.basicConfig(level=logging.INFO)\n\n socketio.init_app(app, resource=os.environ.get('SOCKETIO_RESOURCE', 'socket.io'))\n run_game()\n socketio.run(\n app,\n debug=False,\n host=sys.argv[1],\n port=int(sys.argv[2]),\n use_reloader=False,\n )\n", "path": "aimmo-game/service.py"}]}
| 2,197 | 622 |
gh_patches_debug_29293
|
rasdani/github-patches
|
git_diff
|
pytorch__ignite-1132
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Misleading ValueError - Accuracy Metric Multilabel
## 🐛 Bug description
When using Accuracy.update() with both inputs having the second dimension 1, e.g. in my case `torch.Size([256,1])` the raised error message is misleading.
To reproduce
```
from ignite.metrics import Accuracy
import torch
acc = Accuracy(is_multilabel=True)
acc.update((torch.zeros((256,1)), torch.zeros((256,1))))
```
`ValueError: y and y_pred must have same shape of (batch_size, num_categories, ...).`
In this case the y and y_pred do have the same shape but the issue is that it's not an accepted multilabel input (the `and y.shape[1] != 1` in the following code block from `_check_shape` in `_BaseClassification`). This should be indicated in the error message (or the if statement changed).
What is the argument to not allow a `y.shape[1]` of 1?
```
if self._is_multilabel and not (y.shape == y_pred.shape and y.ndimension() > 1 and y.shape[1] != 1):
raise ValueError("y and y_pred must have same shape of (batch_size, num_categories, ...).")
```
## Environment
- PyTorch Version (e.g., 1.4):
- Ignite Version (e.g., 0.3.0): 0.3.0
- OS (e.g., Linux): Linux
- How you installed Ignite (`conda`, `pip`, source): conda
- Python version:
- Any other relevant information:
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `ignite/metrics/accuracy.py`
Content:
```
1 from typing import Callable, Optional, Sequence, Union
2
3 import torch
4
5 from ignite.exceptions import NotComputableError
6 from ignite.metrics.metric import Metric, reinit__is_reduced, sync_all_reduce
7
8 __all__ = ["Accuracy"]
9
10
11 class _BaseClassification(Metric):
12 def __init__(
13 self,
14 output_transform: Callable = lambda x: x,
15 is_multilabel: bool = False,
16 device: Optional[Union[str, torch.device]] = None,
17 ):
18 self._is_multilabel = is_multilabel
19 self._type = None
20 self._num_classes = None
21 super(_BaseClassification, self).__init__(output_transform=output_transform, device=device)
22
23 def reset(self) -> None:
24 self._type = None
25 self._num_classes = None
26
27 def _check_shape(self, output: Sequence[torch.Tensor]) -> None:
28 y_pred, y = output
29
30 if not (y.ndimension() == y_pred.ndimension() or y.ndimension() + 1 == y_pred.ndimension()):
31 raise ValueError(
32 "y must have shape of (batch_size, ...) and y_pred must have "
33 "shape of (batch_size, num_categories, ...) or (batch_size, ...), "
34 "but given {} vs {}.".format(y.shape, y_pred.shape)
35 )
36
37 y_shape = y.shape
38 y_pred_shape = y_pred.shape
39
40 if y.ndimension() + 1 == y_pred.ndimension():
41 y_pred_shape = (y_pred_shape[0],) + y_pred_shape[2:]
42
43 if not (y_shape == y_pred_shape):
44 raise ValueError("y and y_pred must have compatible shapes.")
45
46 if self._is_multilabel and not (y.shape == y_pred.shape and y.ndimension() > 1 and y.shape[1] != 1):
47 raise ValueError("y and y_pred must have same shape of (batch_size, num_categories, ...).")
48
49 def _check_binary_multilabel_cases(self, output: Sequence[torch.Tensor]) -> None:
50 y_pred, y = output
51
52 if not torch.equal(y, y ** 2):
53 raise ValueError("For binary cases, y must be comprised of 0's and 1's.")
54
55 if not torch.equal(y_pred, y_pred ** 2):
56 raise ValueError("For binary cases, y_pred must be comprised of 0's and 1's.")
57
58 def _check_type(self, output: Sequence[torch.Tensor]) -> None:
59 y_pred, y = output
60
61 if y.ndimension() + 1 == y_pred.ndimension():
62 num_classes = y_pred.shape[1]
63 if num_classes == 1:
64 update_type = "binary"
65 self._check_binary_multilabel_cases((y_pred, y))
66 else:
67 update_type = "multiclass"
68 elif y.ndimension() == y_pred.ndimension():
69 self._check_binary_multilabel_cases((y_pred, y))
70
71 if self._is_multilabel:
72 update_type = "multilabel"
73 num_classes = y_pred.shape[1]
74 else:
75 update_type = "binary"
76 num_classes = 1
77 else:
78 raise RuntimeError(
79 "Invalid shapes of y (shape={}) and y_pred (shape={}), check documentation."
80 " for expected shapes of y and y_pred.".format(y.shape, y_pred.shape)
81 )
82 if self._type is None:
83 self._type = update_type
84 self._num_classes = num_classes
85 else:
86 if self._type != update_type:
87 raise RuntimeError("Input data type has changed from {} to {}.".format(self._type, update_type))
88 if self._num_classes != num_classes:
89 raise ValueError(
90 "Input data number of classes has changed from {} to {}".format(self._num_classes, num_classes)
91 )
92
93
94 class Accuracy(_BaseClassification):
95 """
96 Calculates the accuracy for binary, multiclass and multilabel data.
97
98 - `update` must receive output of the form `(y_pred, y)` or `{'y_pred': y_pred, 'y': y}`.
99 - `y_pred` must be in the following shape (batch_size, num_categories, ...) or (batch_size, ...).
100 - `y` must be in the following shape (batch_size, ...).
101 - `y` and `y_pred` must be in the following shape of (batch_size, num_categories, ...) for multilabel cases.
102
103 In binary and multilabel cases, the elements of `y` and `y_pred` should have 0 or 1 values. Thresholding of
104 predictions can be done as below:
105
106 .. code-block:: python
107
108 def thresholded_output_transform(output):
109 y_pred, y = output
110 y_pred = torch.round(y_pred)
111 return y_pred, y
112
113 binary_accuracy = Accuracy(thresholded_output_transform)
114
115
116 Args:
117 output_transform (callable, optional): a callable that is used to transform the
118 :class:`~ignite.engine.Engine`'s `process_function`'s output into the
119 form expected by the metric. This can be useful if, for example, you have a multi-output model and
120 you want to compute the metric with respect to one of the outputs.
121 is_multilabel (bool, optional): flag to use in multilabel case. By default, False.
122 device (str of torch.device, optional): unused argument.
123
124 """
125
126 def __init__(
127 self,
128 output_transform: Callable = lambda x: x,
129 is_multilabel: bool = False,
130 device: Optional[Union[str, torch.device]] = None,
131 ):
132 self._num_correct = None
133 self._num_examples = None
134 super(Accuracy, self).__init__(output_transform=output_transform, is_multilabel=is_multilabel, device=device)
135
136 @reinit__is_reduced
137 def reset(self) -> None:
138 self._num_correct = 0
139 self._num_examples = 0
140 super(Accuracy, self).reset()
141
142 @reinit__is_reduced
143 def update(self, output: Sequence[torch.Tensor]) -> None:
144 y_pred, y = output
145 self._check_shape((y_pred, y))
146 self._check_type((y_pred, y))
147
148 if self._type == "binary":
149 correct = torch.eq(y_pred.view(-1).to(y), y.view(-1))
150 elif self._type == "multiclass":
151 indices = torch.argmax(y_pred, dim=1)
152 correct = torch.eq(indices, y).view(-1)
153 elif self._type == "multilabel":
154 # if y, y_pred shape is (N, C, ...) -> (N x ..., C)
155 num_classes = y_pred.size(1)
156 last_dim = y_pred.ndimension()
157 y_pred = torch.transpose(y_pred, 1, last_dim - 1).reshape(-1, num_classes)
158 y = torch.transpose(y, 1, last_dim - 1).reshape(-1, num_classes)
159 correct = torch.all(y == y_pred.type_as(y), dim=-1)
160
161 self._num_correct += torch.sum(correct).item()
162 self._num_examples += correct.shape[0]
163
164 @sync_all_reduce("_num_examples", "_num_correct")
165 def compute(self) -> torch.Tensor:
166 if self._num_examples == 0:
167 raise NotComputableError("Accuracy must have at least one example before it can be computed.")
168 return self._num_correct / self._num_examples
169
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/ignite/metrics/accuracy.py b/ignite/metrics/accuracy.py
--- a/ignite/metrics/accuracy.py
+++ b/ignite/metrics/accuracy.py
@@ -43,8 +43,10 @@
if not (y_shape == y_pred_shape):
raise ValueError("y and y_pred must have compatible shapes.")
- if self._is_multilabel and not (y.shape == y_pred.shape and y.ndimension() > 1 and y.shape[1] != 1):
- raise ValueError("y and y_pred must have same shape of (batch_size, num_categories, ...).")
+ if self._is_multilabel and not (y.shape == y_pred.shape and y.ndimension() > 1 and y.shape[1] > 1):
+ raise ValueError(
+ "y and y_pred must have same shape of (batch_size, num_categories, ...) and num_categories > 1."
+ )
def _check_binary_multilabel_cases(self, output: Sequence[torch.Tensor]) -> None:
y_pred, y = output
@@ -98,7 +100,8 @@
- `update` must receive output of the form `(y_pred, y)` or `{'y_pred': y_pred, 'y': y}`.
- `y_pred` must be in the following shape (batch_size, num_categories, ...) or (batch_size, ...).
- `y` must be in the following shape (batch_size, ...).
- - `y` and `y_pred` must be in the following shape of (batch_size, num_categories, ...) for multilabel cases.
+ - `y` and `y_pred` must be in the following shape of (batch_size, num_categories, ...) and
+ num_categories must be greater than 1 for multilabel cases.
In binary and multilabel cases, the elements of `y` and `y_pred` should have 0 or 1 values. Thresholding of
predictions can be done as below:
|
{"golden_diff": "diff --git a/ignite/metrics/accuracy.py b/ignite/metrics/accuracy.py\n--- a/ignite/metrics/accuracy.py\n+++ b/ignite/metrics/accuracy.py\n@@ -43,8 +43,10 @@\n if not (y_shape == y_pred_shape):\n raise ValueError(\"y and y_pred must have compatible shapes.\")\n \n- if self._is_multilabel and not (y.shape == y_pred.shape and y.ndimension() > 1 and y.shape[1] != 1):\n- raise ValueError(\"y and y_pred must have same shape of (batch_size, num_categories, ...).\")\n+ if self._is_multilabel and not (y.shape == y_pred.shape and y.ndimension() > 1 and y.shape[1] > 1):\n+ raise ValueError(\n+ \"y and y_pred must have same shape of (batch_size, num_categories, ...) and num_categories > 1.\"\n+ )\n \n def _check_binary_multilabel_cases(self, output: Sequence[torch.Tensor]) -> None:\n y_pred, y = output\n@@ -98,7 +100,8 @@\n - `update` must receive output of the form `(y_pred, y)` or `{'y_pred': y_pred, 'y': y}`.\n - `y_pred` must be in the following shape (batch_size, num_categories, ...) or (batch_size, ...).\n - `y` must be in the following shape (batch_size, ...).\n- - `y` and `y_pred` must be in the following shape of (batch_size, num_categories, ...) for multilabel cases.\n+ - `y` and `y_pred` must be in the following shape of (batch_size, num_categories, ...) and\n+ num_categories must be greater than 1 for multilabel cases.\n \n In binary and multilabel cases, the elements of `y` and `y_pred` should have 0 or 1 values. Thresholding of\n predictions can be done as below:\n", "issue": "Misleading ValueError - Accuracy Metric Multilabel\n## \ud83d\udc1b Bug description\r\n\r\n\r\nWhen using Accuracy.update() with both inputs having the second dimension 1, e.g. in my case `torch.Size([256,1])` the raised error message is misleading.\r\n\r\nTo reproduce \r\n```\r\nfrom ignite.metrics import Accuracy\r\nimport torch\r\nacc = Accuracy(is_multilabel=True)\r\nacc.update((torch.zeros((256,1)), torch.zeros((256,1))))\r\n```\r\n`ValueError: y and y_pred must have same shape of (batch_size, num_categories, ...).`\r\n\r\nIn this case the y and y_pred do have the same shape but the issue is that it's not an accepted multilabel input (the `and y.shape[1] != 1` in the following code block from `_check_shape` in `_BaseClassification`). This should be indicated in the error message (or the if statement changed).\r\n\r\nWhat is the argument to not allow a `y.shape[1]` of 1?\r\n\r\n```\r\nif self._is_multilabel and not (y.shape == y_pred.shape and y.ndimension() > 1 and y.shape[1] != 1):\r\n raise ValueError(\"y and y_pred must have same shape of (batch_size, num_categories, ...).\")\r\n```\r\n\r\n\r\n## Environment\r\n\r\n - PyTorch Version (e.g., 1.4): \r\n - Ignite Version (e.g., 0.3.0): 0.3.0\r\n - OS (e.g., Linux): Linux\r\n - How you installed Ignite (`conda`, `pip`, source): conda\r\n - Python version:\r\n - Any other relevant information:\r\n\n", "before_files": [{"content": "from typing import Callable, Optional, Sequence, 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__ = [\"Accuracy\"]\n\n\nclass _BaseClassification(Metric):\n def __init__(\n self,\n output_transform: Callable = lambda x: x,\n is_multilabel: bool = False,\n device: Optional[Union[str, torch.device]] = None,\n ):\n self._is_multilabel = is_multilabel\n self._type = None\n self._num_classes = None\n super(_BaseClassification, self).__init__(output_transform=output_transform, device=device)\n\n def reset(self) -> None:\n self._type = None\n self._num_classes = None\n\n def _check_shape(self, output: Sequence[torch.Tensor]) -> None:\n y_pred, y = output\n\n if not (y.ndimension() == y_pred.ndimension() or y.ndimension() + 1 == y_pred.ndimension()):\n raise ValueError(\n \"y must have shape of (batch_size, ...) and y_pred must have \"\n \"shape of (batch_size, num_categories, ...) or (batch_size, ...), \"\n \"but given {} vs {}.\".format(y.shape, y_pred.shape)\n )\n\n y_shape = y.shape\n y_pred_shape = y_pred.shape\n\n if y.ndimension() + 1 == y_pred.ndimension():\n y_pred_shape = (y_pred_shape[0],) + y_pred_shape[2:]\n\n if not (y_shape == y_pred_shape):\n raise ValueError(\"y and y_pred must have compatible shapes.\")\n\n if self._is_multilabel and not (y.shape == y_pred.shape and y.ndimension() > 1 and y.shape[1] != 1):\n raise ValueError(\"y and y_pred must have same shape of (batch_size, num_categories, ...).\")\n\n def _check_binary_multilabel_cases(self, output: Sequence[torch.Tensor]) -> None:\n y_pred, y = output\n\n if not torch.equal(y, y ** 2):\n raise ValueError(\"For binary cases, y must be comprised of 0's and 1's.\")\n\n if not torch.equal(y_pred, y_pred ** 2):\n raise ValueError(\"For binary cases, y_pred must be comprised of 0's and 1's.\")\n\n def _check_type(self, output: Sequence[torch.Tensor]) -> None:\n y_pred, y = output\n\n if y.ndimension() + 1 == y_pred.ndimension():\n num_classes = y_pred.shape[1]\n if num_classes == 1:\n update_type = \"binary\"\n self._check_binary_multilabel_cases((y_pred, y))\n else:\n update_type = \"multiclass\"\n elif y.ndimension() == y_pred.ndimension():\n self._check_binary_multilabel_cases((y_pred, y))\n\n if self._is_multilabel:\n update_type = \"multilabel\"\n num_classes = y_pred.shape[1]\n else:\n update_type = \"binary\"\n num_classes = 1\n else:\n raise RuntimeError(\n \"Invalid shapes of y (shape={}) and y_pred (shape={}), check documentation.\"\n \" for expected shapes of y and y_pred.\".format(y.shape, y_pred.shape)\n )\n if self._type is None:\n self._type = update_type\n self._num_classes = num_classes\n else:\n if self._type != update_type:\n raise RuntimeError(\"Input data type has changed from {} to {}.\".format(self._type, update_type))\n if self._num_classes != num_classes:\n raise ValueError(\n \"Input data number of classes has changed from {} to {}\".format(self._num_classes, num_classes)\n )\n\n\nclass Accuracy(_BaseClassification):\n \"\"\"\n Calculates the accuracy for binary, multiclass and multilabel data.\n\n - `update` must receive output of the form `(y_pred, y)` or `{'y_pred': y_pred, 'y': y}`.\n - `y_pred` must be in the following shape (batch_size, num_categories, ...) or (batch_size, ...).\n - `y` must be in the following shape (batch_size, ...).\n - `y` and `y_pred` must be in the following shape of (batch_size, num_categories, ...) for multilabel cases.\n\n In binary and multilabel cases, the elements of `y` and `y_pred` should have 0 or 1 values. Thresholding of\n predictions can be done as below:\n\n .. code-block:: python\n\n def thresholded_output_transform(output):\n y_pred, y = output\n y_pred = torch.round(y_pred)\n return y_pred, y\n\n binary_accuracy = Accuracy(thresholded_output_transform)\n\n\n Args:\n output_transform (callable, optional): a callable that is used to transform the\n :class:`~ignite.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 is_multilabel (bool, optional): flag to use in multilabel case. By default, False.\n device (str of torch.device, optional): unused argument.\n\n \"\"\"\n\n def __init__(\n self,\n output_transform: Callable = lambda x: x,\n is_multilabel: bool = False,\n device: Optional[Union[str, torch.device]] = None,\n ):\n self._num_correct = None\n self._num_examples = None\n super(Accuracy, self).__init__(output_transform=output_transform, is_multilabel=is_multilabel, device=device)\n\n @reinit__is_reduced\n def reset(self) -> None:\n self._num_correct = 0\n self._num_examples = 0\n super(Accuracy, self).reset()\n\n @reinit__is_reduced\n def update(self, output: Sequence[torch.Tensor]) -> None:\n y_pred, y = output\n self._check_shape((y_pred, y))\n self._check_type((y_pred, y))\n\n if self._type == \"binary\":\n correct = torch.eq(y_pred.view(-1).to(y), y.view(-1))\n elif self._type == \"multiclass\":\n indices = torch.argmax(y_pred, dim=1)\n correct = torch.eq(indices, y).view(-1)\n elif self._type == \"multilabel\":\n # if y, y_pred shape is (N, C, ...) -> (N x ..., C)\n num_classes = y_pred.size(1)\n last_dim = y_pred.ndimension()\n y_pred = torch.transpose(y_pred, 1, last_dim - 1).reshape(-1, num_classes)\n y = torch.transpose(y, 1, last_dim - 1).reshape(-1, num_classes)\n correct = torch.all(y == y_pred.type_as(y), dim=-1)\n\n self._num_correct += torch.sum(correct).item()\n self._num_examples += correct.shape[0]\n\n @sync_all_reduce(\"_num_examples\", \"_num_correct\")\n def compute(self) -> torch.Tensor:\n if self._num_examples == 0:\n raise NotComputableError(\"Accuracy must have at least one example before it can be computed.\")\n return self._num_correct / self._num_examples\n", "path": "ignite/metrics/accuracy.py"}], "after_files": [{"content": "from typing import Callable, Optional, Sequence, 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__ = [\"Accuracy\"]\n\n\nclass _BaseClassification(Metric):\n def __init__(\n self,\n output_transform: Callable = lambda x: x,\n is_multilabel: bool = False,\n device: Optional[Union[str, torch.device]] = None,\n ):\n self._is_multilabel = is_multilabel\n self._type = None\n self._num_classes = None\n super(_BaseClassification, self).__init__(output_transform=output_transform, device=device)\n\n def reset(self) -> None:\n self._type = None\n self._num_classes = None\n\n def _check_shape(self, output: Sequence[torch.Tensor]) -> None:\n y_pred, y = output\n\n if not (y.ndimension() == y_pred.ndimension() or y.ndimension() + 1 == y_pred.ndimension()):\n raise ValueError(\n \"y must have shape of (batch_size, ...) and y_pred must have \"\n \"shape of (batch_size, num_categories, ...) or (batch_size, ...), \"\n \"but given {} vs {}.\".format(y.shape, y_pred.shape)\n )\n\n y_shape = y.shape\n y_pred_shape = y_pred.shape\n\n if y.ndimension() + 1 == y_pred.ndimension():\n y_pred_shape = (y_pred_shape[0],) + y_pred_shape[2:]\n\n if not (y_shape == y_pred_shape):\n raise ValueError(\"y and y_pred must have compatible shapes.\")\n\n if self._is_multilabel and not (y.shape == y_pred.shape and y.ndimension() > 1 and y.shape[1] > 1):\n raise ValueError(\n \"y and y_pred must have same shape of (batch_size, num_categories, ...) and num_categories > 1.\"\n )\n\n def _check_binary_multilabel_cases(self, output: Sequence[torch.Tensor]) -> None:\n y_pred, y = output\n\n if not torch.equal(y, y ** 2):\n raise ValueError(\"For binary cases, y must be comprised of 0's and 1's.\")\n\n if not torch.equal(y_pred, y_pred ** 2):\n raise ValueError(\"For binary cases, y_pred must be comprised of 0's and 1's.\")\n\n def _check_type(self, output: Sequence[torch.Tensor]) -> None:\n y_pred, y = output\n\n if y.ndimension() + 1 == y_pred.ndimension():\n num_classes = y_pred.shape[1]\n if num_classes == 1:\n update_type = \"binary\"\n self._check_binary_multilabel_cases((y_pred, y))\n else:\n update_type = \"multiclass\"\n elif y.ndimension() == y_pred.ndimension():\n self._check_binary_multilabel_cases((y_pred, y))\n\n if self._is_multilabel:\n update_type = \"multilabel\"\n num_classes = y_pred.shape[1]\n else:\n update_type = \"binary\"\n num_classes = 1\n else:\n raise RuntimeError(\n \"Invalid shapes of y (shape={}) and y_pred (shape={}), check documentation.\"\n \" for expected shapes of y and y_pred.\".format(y.shape, y_pred.shape)\n )\n if self._type is None:\n self._type = update_type\n self._num_classes = num_classes\n else:\n if self._type != update_type:\n raise RuntimeError(\"Input data type has changed from {} to {}.\".format(self._type, update_type))\n if self._num_classes != num_classes:\n raise ValueError(\n \"Input data number of classes has changed from {} to {}\".format(self._num_classes, num_classes)\n )\n\n\nclass Accuracy(_BaseClassification):\n \"\"\"\n Calculates the accuracy for binary, multiclass and multilabel data.\n\n - `update` must receive output of the form `(y_pred, y)` or `{'y_pred': y_pred, 'y': y}`.\n - `y_pred` must be in the following shape (batch_size, num_categories, ...) or (batch_size, ...).\n - `y` must be in the following shape (batch_size, ...).\n - `y` and `y_pred` must be in the following shape of (batch_size, num_categories, ...) and\n num_categories must be greater than 1 for multilabel cases.\n\n In binary and multilabel cases, the elements of `y` and `y_pred` should have 0 or 1 values. Thresholding of\n predictions can be done as below:\n\n .. code-block:: python\n\n def thresholded_output_transform(output):\n y_pred, y = output\n y_pred = torch.round(y_pred)\n return y_pred, y\n\n binary_accuracy = Accuracy(thresholded_output_transform)\n\n\n Args:\n output_transform (callable, optional): a callable that is used to transform the\n :class:`~ignite.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 is_multilabel (bool, optional): flag to use in multilabel case. By default, False.\n device (str of torch.device, optional): unused argument.\n\n \"\"\"\n\n def __init__(\n self,\n output_transform: Callable = lambda x: x,\n is_multilabel: bool = False,\n device: Optional[Union[str, torch.device]] = None,\n ):\n self._num_correct = None\n self._num_examples = None\n super(Accuracy, self).__init__(output_transform=output_transform, is_multilabel=is_multilabel, device=device)\n\n @reinit__is_reduced\n def reset(self) -> None:\n self._num_correct = 0\n self._num_examples = 0\n super(Accuracy, self).reset()\n\n @reinit__is_reduced\n def update(self, output: Sequence[torch.Tensor]) -> None:\n y_pred, y = output\n self._check_shape((y_pred, y))\n self._check_type((y_pred, y))\n\n if self._type == \"binary\":\n correct = torch.eq(y_pred.view(-1).to(y), y.view(-1))\n elif self._type == \"multiclass\":\n indices = torch.argmax(y_pred, dim=1)\n correct = torch.eq(indices, y).view(-1)\n elif self._type == \"multilabel\":\n # if y, y_pred shape is (N, C, ...) -> (N x ..., C)\n num_classes = y_pred.size(1)\n last_dim = y_pred.ndimension()\n y_pred = torch.transpose(y_pred, 1, last_dim - 1).reshape(-1, num_classes)\n y = torch.transpose(y, 1, last_dim - 1).reshape(-1, num_classes)\n correct = torch.all(y == y_pred.type_as(y), dim=-1)\n\n self._num_correct += torch.sum(correct).item()\n self._num_examples += correct.shape[0]\n\n @sync_all_reduce(\"_num_examples\", \"_num_correct\")\n def compute(self) -> torch.Tensor:\n if self._num_examples == 0:\n raise NotComputableError(\"Accuracy must have at least one example before it can be computed.\")\n return self._num_correct / self._num_examples\n", "path": "ignite/metrics/accuracy.py"}]}
| 2,665 | 446 |
gh_patches_debug_40601
|
rasdani/github-patches
|
git_diff
|
pytorch__TensorRT-1738
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
✨[Feature] Create Decorator for Python functions Incompatible with Legacy Torch Versions
## Context
Some functions in the code base are incompatible with certain versions of Torch such as 1.13.1. Adding a general-purpose utility decorator which detects whether the Torch version is incompatible with certain key functions could be helpful in notifying the user when such mismatches occur.
## Desired Solution
A decorator of the form:
```python
@req_torch_version(2)
def f(...):
```
This decorator would throw a clear error when the detected Torch version differs from that required to use the decorated function.
## Temporary Alternative
A temporary alternative, which is already in use in PR #1731, is to add logic to each function with compatibility issues, raising an error if any versioning issues are detected. While this is a functional solution, it is difficult to scale and can lead to repetitive code.
## Additional Context
Certain imports are also not compatible across Torch versions (as in `import torchdynamo` in Torch 1.13 versus `import torch._dynamo` in 2.0). To resolve this issue, the imports can be moved inside the functions using them so as to encapsulate all version-specific code within one area.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `py/torch_tensorrt/fx/tracer/dispatch_tracer/aten_tracer.py`
Content:
```
1 import copy
2 import sys
3 from contextlib import contextmanager
4 from typing import Any, Callable, Dict, Generator, List, Optional, Set, Tuple, Union
5
6 import torch
7
8 if not torch.__version__.startswith("1"):
9 import torch._dynamo as torchdynamo
10
11 from torch.fx.passes.infra.pass_base import PassResult
12
13 from torch_tensorrt.fx.passes.lower_basic_pass_aten import (
14 compose_bmm,
15 compose_chunk,
16 compose_getitem_slice,
17 remove_ops,
18 replace_aten_op_with_indices,
19 replace_aten_reshape_alias_with_replace,
20 replace_builtin_ops,
21 replace_inplace_ops,
22 replace_native_layernorm_with_layernorm,
23 replace_transpose_mm_op_with_linear,
24 run_const_fold,
25 )
26 from typing_extensions import TypeAlias
27
28 Value: TypeAlias = Union[
29 Tuple["Value", ...],
30 List["Value"],
31 Dict[str, "Value"],
32 ]
33
34
35 class DynamoConfig:
36 """
37 Manage Exir-specific configurations of Dynamo.
38 """
39
40 def __init__(
41 self,
42 capture_scalar_outputs: bool = True,
43 guard_nn_modules: bool = True,
44 dynamic_shapes: bool = True,
45 specialize_int_float: bool = True,
46 verbose: bool = True,
47 ) -> None:
48
49 self.capture_scalar_outputs = capture_scalar_outputs
50 self.guard_nn_modules = guard_nn_modules
51 self.dynamic_shapes = dynamic_shapes
52 self.specialize_int_float = specialize_int_float
53 self.verbose = verbose
54
55 def activate(self) -> None:
56 torchdynamo.config.capture_scalar_outputs = self.capture_scalar_outputs
57 torchdynamo.config.guard_nn_modules = self.guard_nn_modules
58 torchdynamo.config.dynamic_shapes = self.dynamic_shapes
59 torchdynamo.config.specialize_int_float = self.specialize_int_float
60 torchdynamo.config.verbose = self.verbose
61
62 def deactivate(self) -> None:
63 torchdynamo.config.capture_scalar_outputs = True
64 torchdynamo.config.guard_nn_modules = True
65 torchdynamo.config.dynamic_shapes = True
66 torchdynamo.config.specialize_int_float = True
67 torchdynamo.config.verbose = True
68
69
70 @contextmanager
71 def using_config(config: DynamoConfig) -> Generator[DynamoConfig, None, None]:
72 config.activate()
73 try:
74 yield config
75 finally:
76 config.deactivate()
77
78
79 @contextmanager
80 def setting_python_recursive_limit(limit: int = 10000) -> Generator[None, None, None]:
81 """
82 Temporarily increase the python interpreter stack recursion limit.
83 This is mostly used for pickling large scale modules.
84 """
85 default = sys.getrecursionlimit()
86 if limit > default:
87 sys.setrecursionlimit(limit)
88 try:
89 yield
90 finally:
91 sys.setrecursionlimit(default)
92
93
94 def dynamo_trace(
95 f: Callable[..., Value],
96 # pyre-ignore
97 args: Tuple[Any, ...],
98 aten_graph: bool,
99 tracing_mode: str = "real",
100 dynamo_config: Optional[DynamoConfig] = None,
101 ) -> Tuple[torch.fx.GraphModule, Set]:
102 """
103 TODO: Once we fully migrate to torchdynamo frontend, we will remove
104 this config option alltogether. For now, it helps with quick
105 experiments with playing around with TorchDynamo
106 """
107 if torch.__version__.startswith("1"):
108 raise ValueError(
109 f"The aten tracer requires Torch version >= 2.0. Detected version {torch.__version__}"
110 )
111
112 if dynamo_config is None:
113 dynamo_config = DynamoConfig()
114 with using_config(dynamo_config), setting_python_recursive_limit(2000):
115 torchdynamo.reset()
116 try:
117 return torchdynamo.export(
118 f,
119 *copy.deepcopy(args),
120 aten_graph=aten_graph,
121 tracing_mode=tracing_mode,
122 )
123 except torchdynamo.exc.Unsupported as exc:
124 raise RuntimeError(
125 "The user code is using a feature we don't support. "
126 "Please try torchdynamo.explain() to get possible the reasons",
127 ) from exc
128 except Exception as exc:
129 raise RuntimeError(
130 "torchdynamo internal error occured. Please see above stacktrace"
131 ) from exc
132
133
134 def trace(f, args, *rest):
135 graph_module, guards = dynamo_trace(f, args, True, "symbolic")
136 return graph_module, guards
137
138
139 def opt_trace(f, args, *rest):
140 """
141 Optimized trace with necessary passes which re-compose some ops or replace some ops
142 These passes should be general and functional purpose
143 """
144 passes_list = [
145 compose_bmm,
146 compose_chunk,
147 compose_getitem_slice,
148 replace_aten_reshape_alias_with_replace,
149 replace_aten_op_with_indices,
150 replace_transpose_mm_op_with_linear, # after compose_bmm
151 replace_native_layernorm_with_layernorm,
152 remove_ops,
153 replace_builtin_ops, # after replace_native_layernorm_with_layernorm
154 replace_inplace_ops, # remove it once functionalization is enabled
155 ]
156
157 fx_module, _ = trace(f, args)
158 print(fx_module.graph)
159 for passes in passes_list:
160 pr: PassResult = passes(fx_module)
161 fx_module = pr.graph_module
162
163 fx_module(*args)
164
165 fx_module = run_const_fold(fx_module)
166 print(fx_module.graph)
167 return fx_module
168
```
Path: `py/torch_tensorrt/fx/utils.py`
Content:
```
1 from enum import Enum
2 from typing import List
3
4 # @manual=//deeplearning/trt/python:py_tensorrt
5 import tensorrt as trt
6 import torch
7 from functorch import make_fx
8 from functorch.experimental import functionalize
9 from torch_tensorrt.fx.passes.lower_basic_pass import (
10 replace_op_with_indices,
11 run_const_fold,
12 )
13
14 from .types import Shape, TRTDataType
15
16
17 class LowerPrecision(Enum):
18 FP32 = "fp32"
19 FP16 = "fp16"
20 INT8 = "int8"
21
22
23 def torch_dtype_to_trt(dtype: torch.dtype) -> TRTDataType:
24 """
25 Convert PyTorch data types to TensorRT data types.
26
27 Args:
28 dtype (torch.dtype): A PyTorch data type.
29
30 Returns:
31 The equivalent TensorRT data type.
32 """
33 if trt.__version__ >= "7.0" and dtype == torch.bool:
34 return trt.bool
35 elif dtype == torch.int8:
36 return trt.int8
37 elif dtype == torch.int32:
38 return trt.int32
39 elif dtype == torch.float16:
40 return trt.float16
41 elif dtype == torch.float32:
42 return trt.float32
43 else:
44 raise TypeError("%s is not supported by tensorrt" % dtype)
45
46
47 def torch_dtype_from_trt(dtype: TRTDataType) -> torch.dtype:
48 """
49 Convert TensorRT data types to PyTorch data types.
50
51 Args:
52 dtype (TRTDataType): A TensorRT data type.
53
54 Returns:
55 The equivalent PyTorch data type.
56 """
57 if dtype == trt.int8:
58 return torch.int8
59 elif trt.__version__ >= "7.0" and dtype == trt.bool:
60 return torch.bool
61 elif dtype == trt.int32:
62 return torch.int32
63 elif dtype == trt.float16:
64 return torch.float16
65 elif dtype == trt.float32:
66 return torch.float32
67 else:
68 raise TypeError("%s is not supported by torch" % dtype)
69
70
71 def get_dynamic_dims(shape: Shape) -> List[int]:
72 """
73 This function finds the dynamic dimensions in the given
74 shape. A dimension is dynamic if it's -1.
75
76 Args:
77 shape (Shape): A sequence of integer that represents
78 the shape of a tensor.
79
80 Returns:
81 A list of integers contains all the dynamic dimensions
82 in the given shape
83 """
84 dynamic_dims = []
85
86 for i, s in enumerate(shape):
87 if s == -1:
88 dynamic_dims.append(i)
89
90 return dynamic_dims
91
92
93 def proxytensor_trace(mod, inputs):
94
95 mod.eval()
96
97 def f(*inp):
98 return mod(*inp)
99
100 mod = make_fx(functionalize(f))(*inputs)
101
102 # Remove const operation. For ex, nn.Linear has transpose operation on weight
103 mod.graph.eliminate_dead_code()
104 mod = run_const_fold(mod)
105 mod = replace_op_with_indices(mod)
106 return mod
107
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/py/torch_tensorrt/fx/tracer/dispatch_tracer/aten_tracer.py b/py/torch_tensorrt/fx/tracer/dispatch_tracer/aten_tracer.py
--- a/py/torch_tensorrt/fx/tracer/dispatch_tracer/aten_tracer.py
+++ b/py/torch_tensorrt/fx/tracer/dispatch_tracer/aten_tracer.py
@@ -9,7 +9,7 @@
import torch._dynamo as torchdynamo
from torch.fx.passes.infra.pass_base import PassResult
-
+from torch_tensorrt.fx.utils import req_torch_version
from torch_tensorrt.fx.passes.lower_basic_pass_aten import (
compose_bmm,
compose_chunk,
@@ -91,6 +91,7 @@
sys.setrecursionlimit(default)
+@req_torch_version("2.0")
def dynamo_trace(
f: Callable[..., Value],
# pyre-ignore
@@ -104,11 +105,6 @@
this config option alltogether. For now, it helps with quick
experiments with playing around with TorchDynamo
"""
- if torch.__version__.startswith("1"):
- raise ValueError(
- f"The aten tracer requires Torch version >= 2.0. Detected version {torch.__version__}"
- )
-
if dynamo_config is None:
dynamo_config = DynamoConfig()
with using_config(dynamo_config), setting_python_recursive_limit(2000):
@@ -131,11 +127,13 @@
) from exc
+@req_torch_version("2.0")
def trace(f, args, *rest):
graph_module, guards = dynamo_trace(f, args, True, "symbolic")
return graph_module, guards
+@req_torch_version("2.0")
def opt_trace(f, args, *rest):
"""
Optimized trace with necessary passes which re-compose some ops or replace some ops
diff --git a/py/torch_tensorrt/fx/utils.py b/py/torch_tensorrt/fx/utils.py
--- a/py/torch_tensorrt/fx/utils.py
+++ b/py/torch_tensorrt/fx/utils.py
@@ -1,5 +1,6 @@
from enum import Enum
-from typing import List
+from typing import List, Callable
+from packaging import version
# @manual=//deeplearning/trt/python:py_tensorrt
import tensorrt as trt
@@ -104,3 +105,36 @@
mod = run_const_fold(mod)
mod = replace_op_with_indices(mod)
return mod
+
+
+def req_torch_version(min_torch_version: str = "2.dev"):
+ """
+ Create a decorator which verifies the Torch version installed
+ against a specified version range
+
+ Args:
+ min_torch_version (str): The minimum required Torch version
+ for the decorated function to work properly
+
+ Returns:
+ A decorator which raises a descriptive error message if
+ an unsupported Torch version is used
+ """
+
+ def nested_decorator(f: Callable):
+ def function_wrapper(*args, **kwargs):
+ # Parse minimum and current Torch versions
+ min_version = version.parse(min_torch_version)
+ current_version = version.parse(torch.__version__)
+
+ if current_version < min_version:
+ raise AssertionError(
+ f"Expected Torch version {min_torch_version} or greater, "
+ + f"when calling {f}. Detected version {torch.__version__}"
+ )
+ else:
+ return f(*args, **kwargs)
+
+ return function_wrapper
+
+ return nested_decorator
|
{"golden_diff": "diff --git a/py/torch_tensorrt/fx/tracer/dispatch_tracer/aten_tracer.py b/py/torch_tensorrt/fx/tracer/dispatch_tracer/aten_tracer.py\n--- a/py/torch_tensorrt/fx/tracer/dispatch_tracer/aten_tracer.py\n+++ b/py/torch_tensorrt/fx/tracer/dispatch_tracer/aten_tracer.py\n@@ -9,7 +9,7 @@\n import torch._dynamo as torchdynamo\n \n from torch.fx.passes.infra.pass_base import PassResult\n-\n+from torch_tensorrt.fx.utils import req_torch_version\n from torch_tensorrt.fx.passes.lower_basic_pass_aten import (\n compose_bmm,\n compose_chunk,\n@@ -91,6 +91,7 @@\n sys.setrecursionlimit(default)\n \n \n+@req_torch_version(\"2.0\")\n def dynamo_trace(\n f: Callable[..., Value],\n # pyre-ignore\n@@ -104,11 +105,6 @@\n this config option alltogether. For now, it helps with quick\n experiments with playing around with TorchDynamo\n \"\"\"\n- if torch.__version__.startswith(\"1\"):\n- raise ValueError(\n- f\"The aten tracer requires Torch version >= 2.0. Detected version {torch.__version__}\"\n- )\n-\n if dynamo_config is None:\n dynamo_config = DynamoConfig()\n with using_config(dynamo_config), setting_python_recursive_limit(2000):\n@@ -131,11 +127,13 @@\n ) from exc\n \n \n+@req_torch_version(\"2.0\")\n def trace(f, args, *rest):\n graph_module, guards = dynamo_trace(f, args, True, \"symbolic\")\n return graph_module, guards\n \n \n+@req_torch_version(\"2.0\")\n def opt_trace(f, args, *rest):\n \"\"\"\n Optimized trace with necessary passes which re-compose some ops or replace some ops\ndiff --git a/py/torch_tensorrt/fx/utils.py b/py/torch_tensorrt/fx/utils.py\n--- a/py/torch_tensorrt/fx/utils.py\n+++ b/py/torch_tensorrt/fx/utils.py\n@@ -1,5 +1,6 @@\n from enum import Enum\n-from typing import List\n+from typing import List, Callable\n+from packaging import version\n \n # @manual=//deeplearning/trt/python:py_tensorrt\n import tensorrt as trt\n@@ -104,3 +105,36 @@\n mod = run_const_fold(mod)\n mod = replace_op_with_indices(mod)\n return mod\n+\n+\n+def req_torch_version(min_torch_version: str = \"2.dev\"):\n+ \"\"\"\n+ Create a decorator which verifies the Torch version installed\n+ against a specified version range\n+\n+ Args:\n+ min_torch_version (str): The minimum required Torch version\n+ for the decorated function to work properly\n+\n+ Returns:\n+ A decorator which raises a descriptive error message if\n+ an unsupported Torch version is used\n+ \"\"\"\n+\n+ def nested_decorator(f: Callable):\n+ def function_wrapper(*args, **kwargs):\n+ # Parse minimum and current Torch versions\n+ min_version = version.parse(min_torch_version)\n+ current_version = version.parse(torch.__version__)\n+\n+ if current_version < min_version:\n+ raise AssertionError(\n+ f\"Expected Torch version {min_torch_version} or greater, \"\n+ + f\"when calling {f}. Detected version {torch.__version__}\"\n+ )\n+ else:\n+ return f(*args, **kwargs)\n+\n+ return function_wrapper\n+\n+ return nested_decorator\n", "issue": "\u2728[Feature] Create Decorator for Python functions Incompatible with Legacy Torch Versions\n## Context\r\nSome functions in the code base are incompatible with certain versions of Torch such as 1.13.1. Adding a general-purpose utility decorator which detects whether the Torch version is incompatible with certain key functions could be helpful in notifying the user when such mismatches occur.\r\n\r\n## Desired Solution\r\nA decorator of the form:\r\n```python\r\n@req_torch_version(2)\r\ndef f(...):\r\n```\r\nThis decorator would throw a clear error when the detected Torch version differs from that required to use the decorated function.\r\n\r\n## Temporary Alternative\r\nA temporary alternative, which is already in use in PR #1731, is to add logic to each function with compatibility issues, raising an error if any versioning issues are detected. While this is a functional solution, it is difficult to scale and can lead to repetitive code.\r\n\r\n## Additional Context\r\nCertain imports are also not compatible across Torch versions (as in `import torchdynamo` in Torch 1.13 versus `import torch._dynamo` in 2.0). To resolve this issue, the imports can be moved inside the functions using them so as to encapsulate all version-specific code within one area.\n", "before_files": [{"content": "import copy\nimport sys\nfrom contextlib import contextmanager\nfrom typing import Any, Callable, Dict, Generator, List, Optional, Set, Tuple, Union\n\nimport torch\n\nif not torch.__version__.startswith(\"1\"):\n import torch._dynamo as torchdynamo\n\nfrom torch.fx.passes.infra.pass_base import PassResult\n\nfrom torch_tensorrt.fx.passes.lower_basic_pass_aten import (\n compose_bmm,\n compose_chunk,\n compose_getitem_slice,\n remove_ops,\n replace_aten_op_with_indices,\n replace_aten_reshape_alias_with_replace,\n replace_builtin_ops,\n replace_inplace_ops,\n replace_native_layernorm_with_layernorm,\n replace_transpose_mm_op_with_linear,\n run_const_fold,\n)\nfrom typing_extensions import TypeAlias\n\nValue: TypeAlias = Union[\n Tuple[\"Value\", ...],\n List[\"Value\"],\n Dict[str, \"Value\"],\n]\n\n\nclass DynamoConfig:\n \"\"\"\n Manage Exir-specific configurations of Dynamo.\n \"\"\"\n\n def __init__(\n self,\n capture_scalar_outputs: bool = True,\n guard_nn_modules: bool = True,\n dynamic_shapes: bool = True,\n specialize_int_float: bool = True,\n verbose: bool = True,\n ) -> None:\n\n self.capture_scalar_outputs = capture_scalar_outputs\n self.guard_nn_modules = guard_nn_modules\n self.dynamic_shapes = dynamic_shapes\n self.specialize_int_float = specialize_int_float\n self.verbose = verbose\n\n def activate(self) -> None:\n torchdynamo.config.capture_scalar_outputs = self.capture_scalar_outputs\n torchdynamo.config.guard_nn_modules = self.guard_nn_modules\n torchdynamo.config.dynamic_shapes = self.dynamic_shapes\n torchdynamo.config.specialize_int_float = self.specialize_int_float\n torchdynamo.config.verbose = self.verbose\n\n def deactivate(self) -> None:\n torchdynamo.config.capture_scalar_outputs = True\n torchdynamo.config.guard_nn_modules = True\n torchdynamo.config.dynamic_shapes = True\n torchdynamo.config.specialize_int_float = True\n torchdynamo.config.verbose = True\n\n\n@contextmanager\ndef using_config(config: DynamoConfig) -> Generator[DynamoConfig, None, None]:\n config.activate()\n try:\n yield config\n finally:\n config.deactivate()\n\n\n@contextmanager\ndef setting_python_recursive_limit(limit: int = 10000) -> Generator[None, None, None]:\n \"\"\"\n Temporarily increase the python interpreter stack recursion limit.\n This is mostly used for pickling large scale modules.\n \"\"\"\n default = sys.getrecursionlimit()\n if limit > default:\n sys.setrecursionlimit(limit)\n try:\n yield\n finally:\n sys.setrecursionlimit(default)\n\n\ndef dynamo_trace(\n f: Callable[..., Value],\n # pyre-ignore\n args: Tuple[Any, ...],\n aten_graph: bool,\n tracing_mode: str = \"real\",\n dynamo_config: Optional[DynamoConfig] = None,\n) -> Tuple[torch.fx.GraphModule, Set]:\n \"\"\"\n TODO: Once we fully migrate to torchdynamo frontend, we will remove\n this config option alltogether. For now, it helps with quick\n experiments with playing around with TorchDynamo\n \"\"\"\n if torch.__version__.startswith(\"1\"):\n raise ValueError(\n f\"The aten tracer requires Torch version >= 2.0. Detected version {torch.__version__}\"\n )\n\n if dynamo_config is None:\n dynamo_config = DynamoConfig()\n with using_config(dynamo_config), setting_python_recursive_limit(2000):\n torchdynamo.reset()\n try:\n return torchdynamo.export(\n f,\n *copy.deepcopy(args),\n aten_graph=aten_graph,\n tracing_mode=tracing_mode,\n )\n except torchdynamo.exc.Unsupported as exc:\n raise RuntimeError(\n \"The user code is using a feature we don't support. \"\n \"Please try torchdynamo.explain() to get possible the reasons\",\n ) from exc\n except Exception as exc:\n raise RuntimeError(\n \"torchdynamo internal error occured. Please see above stacktrace\"\n ) from exc\n\n\ndef trace(f, args, *rest):\n graph_module, guards = dynamo_trace(f, args, True, \"symbolic\")\n return graph_module, guards\n\n\ndef opt_trace(f, args, *rest):\n \"\"\"\n Optimized trace with necessary passes which re-compose some ops or replace some ops\n These passes should be general and functional purpose\n \"\"\"\n passes_list = [\n compose_bmm,\n compose_chunk,\n compose_getitem_slice,\n replace_aten_reshape_alias_with_replace,\n replace_aten_op_with_indices,\n replace_transpose_mm_op_with_linear, # after compose_bmm\n replace_native_layernorm_with_layernorm,\n remove_ops,\n replace_builtin_ops, # after replace_native_layernorm_with_layernorm\n replace_inplace_ops, # remove it once functionalization is enabled\n ]\n\n fx_module, _ = trace(f, args)\n print(fx_module.graph)\n for passes in passes_list:\n pr: PassResult = passes(fx_module)\n fx_module = pr.graph_module\n\n fx_module(*args)\n\n fx_module = run_const_fold(fx_module)\n print(fx_module.graph)\n return fx_module\n", "path": "py/torch_tensorrt/fx/tracer/dispatch_tracer/aten_tracer.py"}, {"content": "from enum import Enum\nfrom typing import List\n\n# @manual=//deeplearning/trt/python:py_tensorrt\nimport tensorrt as trt\nimport torch\nfrom functorch import make_fx\nfrom functorch.experimental import functionalize\nfrom torch_tensorrt.fx.passes.lower_basic_pass import (\n replace_op_with_indices,\n run_const_fold,\n)\n\nfrom .types import Shape, TRTDataType\n\n\nclass LowerPrecision(Enum):\n FP32 = \"fp32\"\n FP16 = \"fp16\"\n INT8 = \"int8\"\n\n\ndef torch_dtype_to_trt(dtype: torch.dtype) -> TRTDataType:\n \"\"\"\n Convert PyTorch data types to TensorRT data types.\n\n Args:\n dtype (torch.dtype): A PyTorch data type.\n\n Returns:\n The equivalent TensorRT data type.\n \"\"\"\n if trt.__version__ >= \"7.0\" and dtype == torch.bool:\n return trt.bool\n elif dtype == torch.int8:\n return trt.int8\n elif dtype == torch.int32:\n return trt.int32\n elif dtype == torch.float16:\n return trt.float16\n elif dtype == torch.float32:\n return trt.float32\n else:\n raise TypeError(\"%s is not supported by tensorrt\" % dtype)\n\n\ndef torch_dtype_from_trt(dtype: TRTDataType) -> torch.dtype:\n \"\"\"\n Convert TensorRT data types to PyTorch data types.\n\n Args:\n dtype (TRTDataType): A TensorRT data type.\n\n Returns:\n The equivalent PyTorch data type.\n \"\"\"\n if dtype == trt.int8:\n return torch.int8\n elif trt.__version__ >= \"7.0\" and dtype == trt.bool:\n return torch.bool\n elif dtype == trt.int32:\n return torch.int32\n elif dtype == trt.float16:\n return torch.float16\n elif dtype == trt.float32:\n return torch.float32\n else:\n raise TypeError(\"%s is not supported by torch\" % dtype)\n\n\ndef get_dynamic_dims(shape: Shape) -> List[int]:\n \"\"\"\n This function finds the dynamic dimensions in the given\n shape. A dimension is dynamic if it's -1.\n\n Args:\n shape (Shape): A sequence of integer that represents\n the shape of a tensor.\n\n Returns:\n A list of integers contains all the dynamic dimensions\n in the given shape\n \"\"\"\n dynamic_dims = []\n\n for i, s in enumerate(shape):\n if s == -1:\n dynamic_dims.append(i)\n\n return dynamic_dims\n\n\ndef proxytensor_trace(mod, inputs):\n\n mod.eval()\n\n def f(*inp):\n return mod(*inp)\n\n mod = make_fx(functionalize(f))(*inputs)\n\n # Remove const operation. For ex, nn.Linear has transpose operation on weight\n mod.graph.eliminate_dead_code()\n mod = run_const_fold(mod)\n mod = replace_op_with_indices(mod)\n return mod\n", "path": "py/torch_tensorrt/fx/utils.py"}], "after_files": [{"content": "import copy\nimport sys\nfrom contextlib import contextmanager\nfrom typing import Any, Callable, Dict, Generator, List, Optional, Set, Tuple, Union\n\nimport torch\n\nif not torch.__version__.startswith(\"1\"):\n import torch._dynamo as torchdynamo\n\nfrom torch.fx.passes.infra.pass_base import PassResult\nfrom torch_tensorrt.fx.utils import req_torch_version\nfrom torch_tensorrt.fx.passes.lower_basic_pass_aten import (\n compose_bmm,\n compose_chunk,\n compose_getitem_slice,\n remove_ops,\n replace_aten_op_with_indices,\n replace_aten_reshape_alias_with_replace,\n replace_builtin_ops,\n replace_inplace_ops,\n replace_native_layernorm_with_layernorm,\n replace_transpose_mm_op_with_linear,\n run_const_fold,\n)\nfrom typing_extensions import TypeAlias\n\nValue: TypeAlias = Union[\n Tuple[\"Value\", ...],\n List[\"Value\"],\n Dict[str, \"Value\"],\n]\n\n\nclass DynamoConfig:\n \"\"\"\n Manage Exir-specific configurations of Dynamo.\n \"\"\"\n\n def __init__(\n self,\n capture_scalar_outputs: bool = True,\n guard_nn_modules: bool = True,\n dynamic_shapes: bool = True,\n specialize_int_float: bool = True,\n verbose: bool = True,\n ) -> None:\n\n self.capture_scalar_outputs = capture_scalar_outputs\n self.guard_nn_modules = guard_nn_modules\n self.dynamic_shapes = dynamic_shapes\n self.specialize_int_float = specialize_int_float\n self.verbose = verbose\n\n def activate(self) -> None:\n torchdynamo.config.capture_scalar_outputs = self.capture_scalar_outputs\n torchdynamo.config.guard_nn_modules = self.guard_nn_modules\n torchdynamo.config.dynamic_shapes = self.dynamic_shapes\n torchdynamo.config.specialize_int_float = self.specialize_int_float\n torchdynamo.config.verbose = self.verbose\n\n def deactivate(self) -> None:\n torchdynamo.config.capture_scalar_outputs = True\n torchdynamo.config.guard_nn_modules = True\n torchdynamo.config.dynamic_shapes = True\n torchdynamo.config.specialize_int_float = True\n torchdynamo.config.verbose = True\n\n\n@contextmanager\ndef using_config(config: DynamoConfig) -> Generator[DynamoConfig, None, None]:\n config.activate()\n try:\n yield config\n finally:\n config.deactivate()\n\n\n@contextmanager\ndef setting_python_recursive_limit(limit: int = 10000) -> Generator[None, None, None]:\n \"\"\"\n Temporarily increase the python interpreter stack recursion limit.\n This is mostly used for pickling large scale modules.\n \"\"\"\n default = sys.getrecursionlimit()\n if limit > default:\n sys.setrecursionlimit(limit)\n try:\n yield\n finally:\n sys.setrecursionlimit(default)\n\n\n@req_torch_version(\"2.0\")\ndef dynamo_trace(\n f: Callable[..., Value],\n # pyre-ignore\n args: Tuple[Any, ...],\n aten_graph: bool,\n tracing_mode: str = \"real\",\n dynamo_config: Optional[DynamoConfig] = None,\n) -> Tuple[torch.fx.GraphModule, Set]:\n \"\"\"\n TODO: Once we fully migrate to torchdynamo frontend, we will remove\n this config option alltogether. For now, it helps with quick\n experiments with playing around with TorchDynamo\n \"\"\"\n if dynamo_config is None:\n dynamo_config = DynamoConfig()\n with using_config(dynamo_config), setting_python_recursive_limit(2000):\n torchdynamo.reset()\n try:\n return torchdynamo.export(\n f,\n *copy.deepcopy(args),\n aten_graph=aten_graph,\n tracing_mode=tracing_mode,\n )\n except torchdynamo.exc.Unsupported as exc:\n raise RuntimeError(\n \"The user code is using a feature we don't support. \"\n \"Please try torchdynamo.explain() to get possible the reasons\",\n ) from exc\n except Exception as exc:\n raise RuntimeError(\n \"torchdynamo internal error occured. Please see above stacktrace\"\n ) from exc\n\n\n@req_torch_version(\"2.0\")\ndef trace(f, args, *rest):\n graph_module, guards = dynamo_trace(f, args, True, \"symbolic\")\n return graph_module, guards\n\n\n@req_torch_version(\"2.0\")\ndef opt_trace(f, args, *rest):\n \"\"\"\n Optimized trace with necessary passes which re-compose some ops or replace some ops\n These passes should be general and functional purpose\n \"\"\"\n passes_list = [\n compose_bmm,\n compose_chunk,\n compose_getitem_slice,\n replace_aten_reshape_alias_with_replace,\n replace_aten_op_with_indices,\n replace_transpose_mm_op_with_linear, # after compose_bmm\n replace_native_layernorm_with_layernorm,\n remove_ops,\n replace_builtin_ops, # after replace_native_layernorm_with_layernorm\n replace_inplace_ops, # remove it once functionalization is enabled\n ]\n\n fx_module, _ = trace(f, args)\n print(fx_module.graph)\n for passes in passes_list:\n pr: PassResult = passes(fx_module)\n fx_module = pr.graph_module\n\n fx_module(*args)\n\n fx_module = run_const_fold(fx_module)\n print(fx_module.graph)\n return fx_module\n", "path": "py/torch_tensorrt/fx/tracer/dispatch_tracer/aten_tracer.py"}, {"content": "from enum import Enum\nfrom typing import List, Callable\nfrom packaging import version\n\n# @manual=//deeplearning/trt/python:py_tensorrt\nimport tensorrt as trt\nimport torch\nfrom functorch import make_fx\nfrom functorch.experimental import functionalize\nfrom torch_tensorrt.fx.passes.lower_basic_pass import (\n replace_op_with_indices,\n run_const_fold,\n)\n\nfrom .types import Shape, TRTDataType\n\n\nclass LowerPrecision(Enum):\n FP32 = \"fp32\"\n FP16 = \"fp16\"\n INT8 = \"int8\"\n\n\ndef torch_dtype_to_trt(dtype: torch.dtype) -> TRTDataType:\n \"\"\"\n Convert PyTorch data types to TensorRT data types.\n\n Args:\n dtype (torch.dtype): A PyTorch data type.\n\n Returns:\n The equivalent TensorRT data type.\n \"\"\"\n if trt.__version__ >= \"7.0\" and dtype == torch.bool:\n return trt.bool\n elif dtype == torch.int8:\n return trt.int8\n elif dtype == torch.int32:\n return trt.int32\n elif dtype == torch.float16:\n return trt.float16\n elif dtype == torch.float32:\n return trt.float32\n else:\n raise TypeError(\"%s is not supported by tensorrt\" % dtype)\n\n\ndef torch_dtype_from_trt(dtype: TRTDataType) -> torch.dtype:\n \"\"\"\n Convert TensorRT data types to PyTorch data types.\n\n Args:\n dtype (TRTDataType): A TensorRT data type.\n\n Returns:\n The equivalent PyTorch data type.\n \"\"\"\n if dtype == trt.int8:\n return torch.int8\n elif trt.__version__ >= \"7.0\" and dtype == trt.bool:\n return torch.bool\n elif dtype == trt.int32:\n return torch.int32\n elif dtype == trt.float16:\n return torch.float16\n elif dtype == trt.float32:\n return torch.float32\n else:\n raise TypeError(\"%s is not supported by torch\" % dtype)\n\n\ndef get_dynamic_dims(shape: Shape) -> List[int]:\n \"\"\"\n This function finds the dynamic dimensions in the given\n shape. A dimension is dynamic if it's -1.\n\n Args:\n shape (Shape): A sequence of integer that represents\n the shape of a tensor.\n\n Returns:\n A list of integers contains all the dynamic dimensions\n in the given shape\n \"\"\"\n dynamic_dims = []\n\n for i, s in enumerate(shape):\n if s == -1:\n dynamic_dims.append(i)\n\n return dynamic_dims\n\n\ndef proxytensor_trace(mod, inputs):\n\n mod.eval()\n\n def f(*inp):\n return mod(*inp)\n\n mod = make_fx(functionalize(f))(*inputs)\n\n # Remove const operation. For ex, nn.Linear has transpose operation on weight\n mod.graph.eliminate_dead_code()\n mod = run_const_fold(mod)\n mod = replace_op_with_indices(mod)\n return mod\n\n\ndef req_torch_version(min_torch_version: str = \"2.dev\"):\n \"\"\"\n Create a decorator which verifies the Torch version installed\n against a specified version range\n\n Args:\n min_torch_version (str): The minimum required Torch version\n for the decorated function to work properly\n\n Returns:\n A decorator which raises a descriptive error message if\n an unsupported Torch version is used\n \"\"\"\n\n def nested_decorator(f: Callable):\n def function_wrapper(*args, **kwargs):\n # Parse minimum and current Torch versions\n min_version = version.parse(min_torch_version)\n current_version = version.parse(torch.__version__)\n\n if current_version < min_version:\n raise AssertionError(\n f\"Expected Torch version {min_torch_version} or greater, \"\n + f\"when calling {f}. Detected version {torch.__version__}\"\n )\n else:\n return f(*args, **kwargs)\n\n return function_wrapper\n\n return nested_decorator\n", "path": "py/torch_tensorrt/fx/utils.py"}]}
| 3,012 | 813 |
gh_patches_debug_1266
|
rasdani/github-patches
|
git_diff
|
aio-libs-abandoned__aioredis-py-1048
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[2.0] Type annotations break mypy
I tried porting an existing project to aioredis 2.0. I've got it almost working, but the type annotations that have been added are too strict (and in some cases just wrong) and break mypy. The main problem is that all the functions that take keys annotate them as `str`, when `bytes` (and I think several other types) are perfectly acceptable and are used in my code. The same applies to `register_script`.
The `min` and `max` arguments of `zrangebylex` and `zrevrangebylex` are annotated as int, but they're used for lexicographical sorting so are string-like.
Getting the type annotations right is a fair large undertaking. If there is a desire to release 2.0 soon I'd suggest deleting `py.typed` so that mypy doesn't see this package as annotated. There are annotations for redis-py in typeshed; perhaps that would be a good place to start, although I've occasionally also had issues there.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `setup.py`
Content:
```
1 import os.path
2 import re
3
4 from setuptools import find_packages, setup
5
6
7 def read(*parts):
8 with open(os.path.join(*parts)) as f:
9 return f.read().strip()
10
11
12 def read_version():
13 regexp = re.compile(r"^__version__\W*=\W*\"([\d.abrc]+)\"")
14 init_py = os.path.join(os.path.dirname(__file__), "aioredis", "__init__.py")
15 with open(init_py) as f:
16 for line in f:
17 match = regexp.match(line)
18 if match is not None:
19 return match.group(1)
20 raise RuntimeError(f"Cannot find version in {init_py}")
21
22
23 classifiers = [
24 "License :: OSI Approved :: MIT License",
25 "Development Status :: 4 - Beta",
26 "Programming Language :: Python",
27 "Programming Language :: Python :: 3",
28 "Programming Language :: Python :: 3.6",
29 "Programming Language :: Python :: 3.7",
30 "Programming Language :: Python :: 3 :: Only",
31 "Operating System :: POSIX",
32 "Environment :: Web Environment",
33 "Intended Audience :: Developers",
34 "Topic :: Software Development",
35 "Topic :: Software Development :: Libraries",
36 "Framework :: AsyncIO",
37 ]
38
39 setup(
40 name="aioredis",
41 version=read_version(),
42 description="asyncio (PEP 3156) Redis support",
43 long_description="\n\n".join((read("README.md"), read("CHANGELOG.md"))),
44 long_description_content_type="text/markdown",
45 classifiers=classifiers,
46 platforms=["POSIX"],
47 url="https://github.com/aio-libs/aioredis",
48 license="MIT",
49 packages=find_packages(exclude=["tests"]),
50 install_requires=[
51 "async-timeout",
52 "typing-extensions",
53 ],
54 extras_require={
55 "hiredis": 'hiredis>=1.0; implementation_name=="cpython"',
56 },
57 python_requires=">=3.6",
58 include_package_data=True,
59 )
60
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/setup.py b/setup.py
--- a/setup.py
+++ b/setup.py
@@ -54,6 +54,7 @@
extras_require={
"hiredis": 'hiredis>=1.0; implementation_name=="cpython"',
},
+ package_data={"aioredis": ["py.typed"]},
python_requires=">=3.6",
include_package_data=True,
)
|
{"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -54,6 +54,7 @@\n extras_require={\n \"hiredis\": 'hiredis>=1.0; implementation_name==\"cpython\"',\n },\n+ package_data={\"aioredis\": [\"py.typed\"]},\n python_requires=\">=3.6\",\n include_package_data=True,\n )\n", "issue": "[2.0] Type annotations break mypy\nI tried porting an existing project to aioredis 2.0. I've got it almost working, but the type annotations that have been added are too strict (and in some cases just wrong) and break mypy. The main problem is that all the functions that take keys annotate them as `str`, when `bytes` (and I think several other types) are perfectly acceptable and are used in my code. The same applies to `register_script`.\r\n\r\nThe `min` and `max` arguments of `zrangebylex` and `zrevrangebylex` are annotated as int, but they're used for lexicographical sorting so are string-like.\r\n\r\nGetting the type annotations right is a fair large undertaking. If there is a desire to release 2.0 soon I'd suggest deleting `py.typed` so that mypy doesn't see this package as annotated. There are annotations for redis-py in typeshed; perhaps that would be a good place to start, although I've occasionally also had issues there.\n", "before_files": [{"content": "import os.path\nimport re\n\nfrom setuptools import find_packages, setup\n\n\ndef read(*parts):\n with open(os.path.join(*parts)) as f:\n return f.read().strip()\n\n\ndef read_version():\n regexp = re.compile(r\"^__version__\\W*=\\W*\\\"([\\d.abrc]+)\\\"\")\n init_py = os.path.join(os.path.dirname(__file__), \"aioredis\", \"__init__.py\")\n with open(init_py) as f:\n for line in f:\n match = regexp.match(line)\n if match is not None:\n return match.group(1)\n raise RuntimeError(f\"Cannot find version in {init_py}\")\n\n\nclassifiers = [\n \"License :: OSI Approved :: MIT License\",\n \"Development Status :: 4 - Beta\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3 :: Only\",\n \"Operating System :: POSIX\",\n \"Environment :: Web Environment\",\n \"Intended Audience :: Developers\",\n \"Topic :: Software Development\",\n \"Topic :: Software Development :: Libraries\",\n \"Framework :: AsyncIO\",\n]\n\nsetup(\n name=\"aioredis\",\n version=read_version(),\n description=\"asyncio (PEP 3156) Redis support\",\n long_description=\"\\n\\n\".join((read(\"README.md\"), read(\"CHANGELOG.md\"))),\n long_description_content_type=\"text/markdown\",\n classifiers=classifiers,\n platforms=[\"POSIX\"],\n url=\"https://github.com/aio-libs/aioredis\",\n license=\"MIT\",\n packages=find_packages(exclude=[\"tests\"]),\n install_requires=[\n \"async-timeout\",\n \"typing-extensions\",\n ],\n extras_require={\n \"hiredis\": 'hiredis>=1.0; implementation_name==\"cpython\"',\n },\n python_requires=\">=3.6\",\n include_package_data=True,\n)\n", "path": "setup.py"}], "after_files": [{"content": "import os.path\nimport re\n\nfrom setuptools import find_packages, setup\n\n\ndef read(*parts):\n with open(os.path.join(*parts)) as f:\n return f.read().strip()\n\n\ndef read_version():\n regexp = re.compile(r\"^__version__\\W*=\\W*\\\"([\\d.abrc]+)\\\"\")\n init_py = os.path.join(os.path.dirname(__file__), \"aioredis\", \"__init__.py\")\n with open(init_py) as f:\n for line in f:\n match = regexp.match(line)\n if match is not None:\n return match.group(1)\n raise RuntimeError(f\"Cannot find version in {init_py}\")\n\n\nclassifiers = [\n \"License :: OSI Approved :: MIT License\",\n \"Development Status :: 4 - Beta\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3 :: Only\",\n \"Operating System :: POSIX\",\n \"Environment :: Web Environment\",\n \"Intended Audience :: Developers\",\n \"Topic :: Software Development\",\n \"Topic :: Software Development :: Libraries\",\n \"Framework :: AsyncIO\",\n]\n\nsetup(\n name=\"aioredis\",\n version=read_version(),\n description=\"asyncio (PEP 3156) Redis support\",\n long_description=\"\\n\\n\".join((read(\"README.md\"), read(\"CHANGELOG.md\"))),\n long_description_content_type=\"text/markdown\",\n classifiers=classifiers,\n platforms=[\"POSIX\"],\n url=\"https://github.com/aio-libs/aioredis\",\n license=\"MIT\",\n packages=find_packages(exclude=[\"tests\"]),\n install_requires=[\n \"async-timeout\",\n \"typing-extensions\",\n ],\n extras_require={\n \"hiredis\": 'hiredis>=1.0; implementation_name==\"cpython\"',\n },\n package_data={\"aioredis\": [\"py.typed\"]},\n python_requires=\">=3.6\",\n include_package_data=True,\n)\n", "path": "setup.py"}]}
| 1,027 | 90 |
gh_patches_debug_9756
|
rasdani/github-patches
|
git_diff
|
facebookresearch__fairscale-210
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
an error importing AMP in fairscale when using a Pytorch version less than 1.6
## 🐛 Bug
<!-- A clear and concise description of what the bug is. -->
## Command
## To Reproduce
<img width="737" alt="Screenshot 2020-11-23 at 08 21 28" src="https://user-images.githubusercontent.com/12861981/99949945-c2f11300-2d73-11eb-87f2-17a02e64da75.png">
Steps to reproduce the behavior:
<!-- If you were running a command, post the exact command that you were running -->
1.
2.
3.
<!-- If you have a code sample, error messages, stack traces, please provide it here as well -->
## Expected behavior
<!-- A clear and concise description of what you expected to happen. -->
## Environment
Please copy and paste the output from the
environment collection script from PyTorch
(or fill out the checklist below manually).
You can run the script with:
```
# For security purposes, please check the contents of collect_env.py before running it.
python -m torch.utils.collect_env
```
- PyTorch Version (e.g., 1.0):
- OS (e.g., Linux):
- How you installed PyTorch (`conda`, `pip`, source):
- Build command you used (if compiling from source):
- Python version:
- CUDA/cuDNN version:
- GPU models and configuration:
- Any other relevant information:
## Additional context
<!-- Add any other context about the problem here. -->
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `fairscale/optim/__init__.py`
Content:
```
1 # Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.
2 #
3 # This source code is licensed under the BSD license found in the
4 # LICENSE file in the root directory of this source tree.
5
6 """
7 :mod:`fairscale.optim` is a package implementing various torch optimization algorithms.
8 """
9
10 try:
11 from .adam import Adam, Precision
12 except ImportError: # pragma: no cover
13 pass # pragma: no cover
14 from .adascale import AdaScale
15 from .grad_scaler import GradScaler
16 from .oss import OSS
17
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/fairscale/optim/__init__.py b/fairscale/optim/__init__.py
--- a/fairscale/optim/__init__.py
+++ b/fairscale/optim/__init__.py
@@ -6,11 +6,16 @@
"""
:mod:`fairscale.optim` is a package implementing various torch optimization algorithms.
"""
+import logging
+
+from .adascale import AdaScale
+from .oss import OSS
try:
from .adam import Adam, Precision
except ImportError: # pragma: no cover
pass # pragma: no cover
-from .adascale import AdaScale
-from .grad_scaler import GradScaler
-from .oss import OSS
+try:
+ from .grad_scaler import GradScaler
+except ImportError:
+ logging.warning("Torch AMP is not available on this platform")
|
{"golden_diff": "diff --git a/fairscale/optim/__init__.py b/fairscale/optim/__init__.py\n--- a/fairscale/optim/__init__.py\n+++ b/fairscale/optim/__init__.py\n@@ -6,11 +6,16 @@\n \"\"\"\n :mod:`fairscale.optim` is a package implementing various torch optimization algorithms.\n \"\"\"\n+import logging\n+\n+from .adascale import AdaScale\n+from .oss import OSS\n \n try:\n from .adam import Adam, Precision\n except ImportError: # pragma: no cover\n pass # pragma: no cover\n-from .adascale import AdaScale\n-from .grad_scaler import GradScaler\n-from .oss import OSS\n+try:\n+ from .grad_scaler import GradScaler\n+except ImportError:\n+ logging.warning(\"Torch AMP is not available on this platform\")\n", "issue": "an error importing AMP in fairscale when using a Pytorch version less than 1.6\n## \ud83d\udc1b Bug\r\n\r\n<!-- A clear and concise description of what the bug is. -->\r\n\r\n## Command\r\n\r\n## To Reproduce\r\n\r\n<img width=\"737\" alt=\"Screenshot 2020-11-23 at 08 21 28\" src=\"https://user-images.githubusercontent.com/12861981/99949945-c2f11300-2d73-11eb-87f2-17a02e64da75.png\">\r\n\r\n\r\nSteps to reproduce the behavior:\r\n\r\n<!-- If you were running a command, post the exact command that you were running -->\r\n\r\n1.\r\n2.\r\n3.\r\n\r\n<!-- If you have a code sample, error messages, stack traces, please provide it here as well -->\r\n\r\n## Expected behavior\r\n\r\n<!-- A clear and concise description of what you expected to happen. -->\r\n\r\n## Environment\r\n\r\nPlease copy and paste the output from the\r\nenvironment collection script from PyTorch\r\n(or fill out the checklist below manually).\r\n\r\nYou can run the script with:\r\n```\r\n# For security purposes, please check the contents of collect_env.py before running it.\r\npython -m torch.utils.collect_env\r\n```\r\n\r\n - PyTorch Version (e.g., 1.0):\r\n - OS (e.g., Linux):\r\n - How you installed PyTorch (`conda`, `pip`, source):\r\n - Build command you used (if compiling from source):\r\n - Python version:\r\n - CUDA/cuDNN version:\r\n - GPU models and configuration:\r\n - Any other relevant information:\r\n\r\n## Additional context\r\n\r\n<!-- Add any other context about the problem here. -->\r\n\n", "before_files": [{"content": "# Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.\n#\n# This source code is licensed under the BSD license found in the\n# LICENSE file in the root directory of this source tree.\n\n\"\"\"\n:mod:`fairscale.optim` is a package implementing various torch optimization algorithms.\n\"\"\"\n\ntry:\n from .adam import Adam, Precision\nexcept ImportError: # pragma: no cover\n pass # pragma: no cover\nfrom .adascale import AdaScale\nfrom .grad_scaler import GradScaler\nfrom .oss import OSS\n", "path": "fairscale/optim/__init__.py"}], "after_files": [{"content": "# Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.\n#\n# This source code is licensed under the BSD license found in the\n# LICENSE file in the root directory of this source tree.\n\n\"\"\"\n:mod:`fairscale.optim` is a package implementing various torch optimization algorithms.\n\"\"\"\nimport logging\n\nfrom .adascale import AdaScale\nfrom .oss import OSS\n\ntry:\n from .adam import Adam, Precision\nexcept ImportError: # pragma: no cover\n pass # pragma: no cover\ntry:\n from .grad_scaler import GradScaler\nexcept ImportError:\n logging.warning(\"Torch AMP is not available on this platform\")\n", "path": "fairscale/optim/__init__.py"}]}
| 770 | 186 |
gh_patches_debug_25635
|
rasdani/github-patches
|
git_diff
|
DDMAL__CantusDB-706
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
`/articles` has different url and does not show article previews
On OldCantus, `/news` is a valid url and returns a page showing a list of articles with titles and article details/previews.
On NewCantus, `/news` (http://206.12.88.113/news) returns a 404Error and the resulting list of articles at `/articles` does not contain previews of article contents.
Additionally, the page on OldCantus paginates the list of articles, while on NewCantus it does not (very possible it has this behaviour programmed but just doesn't have enough articles...)
OldCantus:
<img width="960" alt="image" src="https://github.com/DDMAL/CantusDB/assets/11023634/153c9a31-5ea1-4e8a-a646-cde3bd7982f7">
NewCantus:
<img width="923" alt="image" src="https://github.com/DDMAL/CantusDB/assets/11023634/0b59df5a-b195-49d1-9c77-6cb920f23958">
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `django/cantusdb_project/articles/urls.py`
Content:
```
1 from django.urls import path
2 from articles.views import ArticleDetailView
3 from articles.views import ArticleListView
4
5 urlpatterns = [
6 path("articles/", ArticleListView.as_view(), name="article-list"),
7 path("article/<int:pk>", ArticleDetailView.as_view(), name="article-detail"),
8 ]
9
```
Path: `django/cantusdb_project/articles/views.py`
Content:
```
1 from django.shortcuts import render
2 from django.views.generic import DetailView, ListView
3 from articles.models import Article
4
5
6 class ArticleDetailView(DetailView):
7 model = Article
8 context_object_name = "article"
9 template_name = "article_detail.html"
10
11
12 class ArticleListView(ListView):
13 model = Article
14 queryset = Article.objects.order_by("-date_created")
15 paginate_by = 100
16 context_object_name = "articles"
17 template_name = "article_list.html"
18
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/django/cantusdb_project/articles/urls.py b/django/cantusdb_project/articles/urls.py
--- a/django/cantusdb_project/articles/urls.py
+++ b/django/cantusdb_project/articles/urls.py
@@ -1,8 +1,12 @@
from django.urls import path
-from articles.views import ArticleDetailView
-from articles.views import ArticleListView
+from articles.views import (
+ ArticleDetailView,
+ ArticleListView,
+ article_list_redirect_from_old_path,
+)
urlpatterns = [
path("articles/", ArticleListView.as_view(), name="article-list"),
path("article/<int:pk>", ArticleDetailView.as_view(), name="article-detail"),
+ path("news/", article_list_redirect_from_old_path),
]
diff --git a/django/cantusdb_project/articles/views.py b/django/cantusdb_project/articles/views.py
--- a/django/cantusdb_project/articles/views.py
+++ b/django/cantusdb_project/articles/views.py
@@ -1,4 +1,5 @@
-from django.shortcuts import render
+from django.shortcuts import render, redirect
+from django.urls.base import reverse
from django.views.generic import DetailView, ListView
from articles.models import Article
@@ -12,6 +13,10 @@
class ArticleListView(ListView):
model = Article
queryset = Article.objects.order_by("-date_created")
- paginate_by = 100
+ paginate_by = 10
context_object_name = "articles"
template_name = "article_list.html"
+
+
+def article_list_redirect_from_old_path(request):
+ return redirect(reverse("article-list"))
|
{"golden_diff": "diff --git a/django/cantusdb_project/articles/urls.py b/django/cantusdb_project/articles/urls.py\n--- a/django/cantusdb_project/articles/urls.py\n+++ b/django/cantusdb_project/articles/urls.py\n@@ -1,8 +1,12 @@\n from django.urls import path\n-from articles.views import ArticleDetailView\n-from articles.views import ArticleListView\n+from articles.views import (\n+ ArticleDetailView,\n+ ArticleListView,\n+ article_list_redirect_from_old_path,\n+)\n \n urlpatterns = [\n path(\"articles/\", ArticleListView.as_view(), name=\"article-list\"),\n path(\"article/<int:pk>\", ArticleDetailView.as_view(), name=\"article-detail\"),\n+ path(\"news/\", article_list_redirect_from_old_path),\n ]\ndiff --git a/django/cantusdb_project/articles/views.py b/django/cantusdb_project/articles/views.py\n--- a/django/cantusdb_project/articles/views.py\n+++ b/django/cantusdb_project/articles/views.py\n@@ -1,4 +1,5 @@\n-from django.shortcuts import render\n+from django.shortcuts import render, redirect\n+from django.urls.base import reverse\n from django.views.generic import DetailView, ListView\n from articles.models import Article\n \n@@ -12,6 +13,10 @@\n class ArticleListView(ListView):\n model = Article\n queryset = Article.objects.order_by(\"-date_created\")\n- paginate_by = 100\n+ paginate_by = 10\n context_object_name = \"articles\"\n template_name = \"article_list.html\"\n+\n+\n+def article_list_redirect_from_old_path(request):\n+ return redirect(reverse(\"article-list\"))\n", "issue": "`/articles` has different url and does not show article previews\nOn OldCantus, `/news` is a valid url and returns a page showing a list of articles with titles and article details/previews.\r\n\r\nOn NewCantus, `/news` (http://206.12.88.113/news) returns a 404Error and the resulting list of articles at `/articles` does not contain previews of article contents. \r\n\r\nAdditionally, the page on OldCantus paginates the list of articles, while on NewCantus it does not (very possible it has this behaviour programmed but just doesn't have enough articles...)\r\n\r\nOldCantus:\r\n<img width=\"960\" alt=\"image\" src=\"https://github.com/DDMAL/CantusDB/assets/11023634/153c9a31-5ea1-4e8a-a646-cde3bd7982f7\">\r\n\r\n\r\nNewCantus:\r\n\r\n<img width=\"923\" alt=\"image\" src=\"https://github.com/DDMAL/CantusDB/assets/11023634/0b59df5a-b195-49d1-9c77-6cb920f23958\">\r\n\r\n\n", "before_files": [{"content": "from django.urls import path\nfrom articles.views import ArticleDetailView\nfrom articles.views import ArticleListView\n\nurlpatterns = [\n path(\"articles/\", ArticleListView.as_view(), name=\"article-list\"),\n path(\"article/<int:pk>\", ArticleDetailView.as_view(), name=\"article-detail\"),\n]\n", "path": "django/cantusdb_project/articles/urls.py"}, {"content": "from django.shortcuts import render\nfrom django.views.generic import DetailView, ListView\nfrom articles.models import Article\n\n\nclass ArticleDetailView(DetailView):\n model = Article\n context_object_name = \"article\"\n template_name = \"article_detail.html\"\n\n\nclass ArticleListView(ListView):\n model = Article\n queryset = Article.objects.order_by(\"-date_created\")\n paginate_by = 100\n context_object_name = \"articles\"\n template_name = \"article_list.html\"\n", "path": "django/cantusdb_project/articles/views.py"}], "after_files": [{"content": "from django.urls import path\nfrom articles.views import (\n ArticleDetailView,\n ArticleListView,\n article_list_redirect_from_old_path,\n)\n\nurlpatterns = [\n path(\"articles/\", ArticleListView.as_view(), name=\"article-list\"),\n path(\"article/<int:pk>\", ArticleDetailView.as_view(), name=\"article-detail\"),\n path(\"news/\", article_list_redirect_from_old_path),\n]\n", "path": "django/cantusdb_project/articles/urls.py"}, {"content": "from django.shortcuts import render, redirect\nfrom django.urls.base import reverse\nfrom django.views.generic import DetailView, ListView\nfrom articles.models import Article\n\n\nclass ArticleDetailView(DetailView):\n model = Article\n context_object_name = \"article\"\n template_name = \"article_detail.html\"\n\n\nclass ArticleListView(ListView):\n model = Article\n queryset = Article.objects.order_by(\"-date_created\")\n paginate_by = 10\n context_object_name = \"articles\"\n template_name = \"article_list.html\"\n\n\ndef article_list_redirect_from_old_path(request):\n return redirect(reverse(\"article-list\"))\n", "path": "django/cantusdb_project/articles/views.py"}]}
| 768 | 358 |
gh_patches_debug_27435
|
rasdani/github-patches
|
git_diff
|
fossasia__open-event-server-5892
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Tickets endpoint results in too many redirects in production.
```python
try:
response = make_response(send_file(file_path))
response.headers['Content-Disposition'] = 'attachment; filename=ticket-%s.pdf' % order_identifier
return response
except FileNotFoundError:
create_pdf_tickets_for_holder(order)
return redirect(url_for('ticket_blueprint.ticket_attendee_authorized', order_identifier=order_identifier))
```
The redirect call seems to be the problem, removing it and manually sending the response seems to fix it.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `app/api/auth.py`
Content:
```
1 import os
2 import base64
3 import random
4 import string
5
6 import requests
7 from flask import request, jsonify, make_response, Blueprint, send_file, url_for, redirect
8 from flask_jwt import current_identity as current_user, jwt_required
9 from sqlalchemy.orm.exc import NoResultFound
10 from app.api.helpers.order import create_pdf_tickets_for_holder
11 from app.api.helpers.storage import generate_hash
12
13 from app import get_settings
14 from app.api.helpers.db import save_to_db, get_count
15 from app.api.helpers.errors import ForbiddenError, UnprocessableEntityError, NotFoundError, BadRequestError
16 from app.api.helpers.files import make_frontend_url
17 from app.api.helpers.mail import send_email_with_action, \
18 send_email_confirmation
19 from app.api.helpers.notification import send_notification_with_action
20 from app.api.helpers.third_party_auth import GoogleOAuth, FbOAuth, TwitterOAuth, InstagramOAuth
21 from app.api.helpers.utilities import get_serializer, str_generator
22 from app.models import db
23 from app.models.order import Order
24 from app.models.mail import PASSWORD_RESET, PASSWORD_CHANGE, \
25 USER_REGISTER_WITH_PASSWORD, PASSWORD_RESET_AND_VERIFY
26 from app.models.notification import PASSWORD_CHANGE as PASSWORD_CHANGE_NOTIF
27 from app.models.user import User
28 from app.api.helpers.storage import UPLOAD_PATHS
29
30
31 ticket_blueprint = Blueprint('ticket_blueprint', __name__, url_prefix='/v1')
32 auth_routes = Blueprint('auth', __name__, url_prefix='/v1/auth')
33
34
35 @auth_routes.route('/oauth/<provider>', methods=['GET'])
36 def redirect_uri(provider):
37 if provider == 'facebook':
38 provider_class = FbOAuth()
39 elif provider == 'google':
40 provider_class = GoogleOAuth()
41 elif provider == 'twitter':
42 provider_class = TwitterOAuth()
43 elif provider == 'instagram':
44 provider_class = InstagramOAuth()
45 else:
46 return make_response(jsonify(
47 message="No support for {}".format(provider)), 404)
48
49 client_id = provider_class.get_client_id()
50 if not client_id:
51 return make_response(jsonify(
52 message="{} client id is not configured on the server".format(provider)), 404)
53
54 url = provider_class.get_auth_uri() + '?client_id=' + \
55 client_id + '&redirect_uri=' + \
56 provider_class.get_redirect_uri()
57 return make_response(jsonify(url=url), 200)
58
59
60 @auth_routes.route('/oauth/token/<provider>', methods=['GET'])
61 def get_token(provider):
62 if provider == 'facebook':
63 provider_class = FbOAuth()
64 payload = {
65 'grant_type': 'client_credentials',
66 'client_id': provider_class.get_client_id(),
67 'client_secret': provider_class.get_client_secret()
68 }
69 elif provider == 'google':
70 provider_class = GoogleOAuth()
71 payload = {
72 'client_id': provider_class.get_client_id(),
73 'client_secret': provider_class.get_client_secret()
74 }
75 elif provider == 'twitter':
76 provider_class = TwitterOAuth()
77 payload = {
78 'client_id': provider_class.get_client_id(),
79 'client_secret': provider_class.get_client_secret()
80 }
81 elif provider == 'instagram':
82 provider_class = InstagramOAuth()
83 payload = {
84 'client_id': provider_class.get_client_id(),
85 'client_secret': provider_class.get_client_secret()
86 }
87 else:
88 return make_response(jsonify(
89 message="No support for {}".format(provider)), 200)
90 response = requests.post(provider_class.get_token_uri(), params=payload)
91 return make_response(jsonify(token=response.json()), 200)
92
93
94 @auth_routes.route('/oauth/login/<provider>', methods=['POST'])
95 def login_user(provider):
96 if provider == 'facebook':
97 provider_class = FbOAuth()
98 payload = {
99 'client_id': provider_class.get_client_id(),
100 'redirect_uri': provider_class.get_redirect_uri(),
101 'client_secret': provider_class.get_client_secret(),
102 'code': request.args.get('code')
103 }
104 if not payload['client_id'] or not payload['client_secret']:
105 raise NotImplementedError({'source': ''}, 'Facebook Login Not Configured')
106 access_token = requests.get('https://graph.facebook.com/v3.0/oauth/access_token', params=payload).json()
107 payload_details = {
108 'input_token': access_token['access_token'],
109 'access_token': provider_class.get_client_id() + '|' + provider_class.get_client_secret()
110 }
111 details = requests.get('https://graph.facebook.com/debug_token', params=payload_details).json()
112 user_details = requests.get('https://graph.facebook.com/v3.0/' + details['data']['user_id'],
113 params={'access_token': access_token['access_token'],
114 'fields': 'first_name, last_name, email'}).json()
115
116 if get_count(db.session.query(User).filter_by(email=user_details['email'])) > 0:
117 user = db.session.query(User).filter_by(email=user_details['email']).one()
118 if not user.facebook_id:
119 user.facebook_id = user_details['id']
120 user.facebook_login_hash = random.getrandbits(128)
121 save_to_db(user)
122 return make_response(
123 jsonify(user_id=user.id, email=user.email, oauth_hash=user.facebook_login_hash), 200)
124
125 user = User()
126 user.first_name = user_details['first_name']
127 user.last_name = user_details['last_name']
128 user.facebook_id = user_details['id']
129 user.facebook_login_hash = random.getrandbits(128)
130 user.password = ''.join(random.SystemRandom().choice(string.ascii_uppercase + string.digits) for _ in range(8))
131 if user_details['email']:
132 user.email = user_details['email']
133
134 save_to_db(user)
135 return make_response(jsonify(user_id=user.id, email=user.email, oauth_hash=user.facebook_login_hash),
136 200)
137
138 elif provider == 'google':
139 provider_class = GoogleOAuth()
140 payload = {
141 'client_id': provider_class.get_client_id(),
142 'client_secret': provider_class.get_client_secret()
143 }
144 elif provider == 'twitter':
145 provider_class = TwitterOAuth()
146 payload = {
147 'client_id': provider_class.get_client_id(),
148 'client_secret': provider_class.get_client_secret()
149 }
150 elif provider == 'instagram':
151 provider_class = InstagramOAuth()
152 payload = {
153 'client_id': provider_class.get_client_id(),
154 'client_secret': provider_class.get_client_secret()
155 }
156 else:
157 return make_response(jsonify(
158 message="No support for {}".format(provider)), 200)
159 response = requests.post(provider_class.get_token_uri(), params=payload)
160 return make_response(jsonify(token=response.json()), 200)
161
162
163 @auth_routes.route('/verify-email', methods=['POST'])
164 def verify_email():
165 token = base64.b64decode(request.json['data']['token'])
166 s = get_serializer()
167
168 try:
169 data = s.loads(token)
170 except Exception:
171 return BadRequestError({'source': ''}, 'Invalid Token').respond()
172
173 try:
174 user = User.query.filter_by(email=data[0]).one()
175 except Exception:
176 return BadRequestError({'source': ''}, 'Invalid Token').respond()
177 else:
178 user.is_verified = True
179 save_to_db(user)
180 return make_response(jsonify(message="Email Verified"), 200)
181
182
183 @auth_routes.route('/resend-verification-email', methods=['POST'])
184 def resend_verification_email():
185 try:
186 email = request.json['data']['email']
187 except TypeError:
188 return BadRequestError({'source': ''}, 'Bad Request Error').respond()
189
190 try:
191 user = User.query.filter_by(email=email).one()
192 except NoResultFound:
193 return UnprocessableEntityError(
194 {'source': ''}, 'User with email: ' + email + ' not found.').respond()
195 else:
196 serializer = get_serializer()
197 hash_ = str(base64.b64encode(str(serializer.dumps(
198 [user.email, str_generator()])).encode()), 'utf-8')
199 link = make_frontend_url(
200 '/verify'.format(id=user.id), {'token': hash_})
201 send_email_confirmation(user.email, link)
202
203 return make_response(jsonify(message="Verification email resent"), 200)
204
205
206 @auth_routes.route('/reset-password', methods=['POST'])
207 def reset_password_post():
208 try:
209 email = request.json['data']['email']
210 except TypeError:
211 return BadRequestError({'source': ''}, 'Bad Request Error').respond()
212
213 try:
214 user = User.query.filter_by(email=email).one()
215 except NoResultFound:
216 return NotFoundError({'source': ''}, 'User not found').respond()
217 else:
218 link = make_frontend_url('/reset-password', {'token': user.reset_password})
219 if user.was_registered_with_order:
220 send_email_with_action(user, PASSWORD_RESET_AND_VERIFY, app_name=get_settings()['app_name'], link=link)
221 else:
222 send_email_with_action(user, PASSWORD_RESET, app_name=get_settings()['app_name'], link=link)
223
224 return make_response(jsonify(message="Email Sent"), 200)
225
226
227 @auth_routes.route('/reset-password', methods=['PATCH'])
228 def reset_password_patch():
229 token = request.json['data']['token']
230 password = request.json['data']['password']
231
232 try:
233 user = User.query.filter_by(reset_password=token).one()
234 except NoResultFound:
235 return NotFoundError({'source': ''}, 'User Not Found').respond()
236 else:
237 user.password = password
238 if user.was_registered_with_order:
239 user.is_verified = True
240 save_to_db(user)
241
242 return jsonify({
243 "id": user.id,
244 "email": user.email,
245 "name": user.fullname if user.fullname else None
246 })
247
248
249 @auth_routes.route('/change-password', methods=['POST'])
250 @jwt_required()
251 def change_password():
252 old_password = request.json['data']['old-password']
253 new_password = request.json['data']['new-password']
254
255 try:
256 user = User.query.filter_by(id=current_user.id).one()
257 except NoResultFound:
258 return NotFoundError({'source': ''}, 'User Not Found').respond()
259 else:
260 if user.is_correct_password(old_password):
261 if user.is_correct_password(new_password):
262 return BadRequestError({'source': ''},
263 'Old and New passwords must be different').respond()
264 if len(new_password) < 8:
265 return BadRequestError({'source': ''},
266 'Password should have minimum 8 characters').respond()
267 user.password = new_password
268 save_to_db(user)
269 send_email_with_action(user, PASSWORD_CHANGE,
270 app_name=get_settings()['app_name'])
271 send_notification_with_action(user, PASSWORD_CHANGE_NOTIF,
272 app_name=get_settings()['app_name'])
273 else:
274 return BadRequestError({'source': ''}, 'Wrong Password. Please enter correct current password.').respond()
275
276 return jsonify({
277 "id": user.id,
278 "email": user.email,
279 "name": user.fullname if user.fullname else None,
280 "password-changed": True
281 })
282
283
284 @ticket_blueprint.route('/tickets/<string:order_identifier>')
285 @jwt_required()
286 def ticket_attendee_authorized(order_identifier):
287 if current_user:
288 try:
289 order = Order.query.filter_by(identifier=order_identifier).first()
290 user_id = order.user.id
291 except NoResultFound:
292 return NotFoundError({'source': ''}, 'This ticket is not associated with any order').respond()
293 if current_user.id == user_id:
294 key = UPLOAD_PATHS['pdf']['ticket_attendee'].format(identifier=order_identifier)
295 file_path = '../generated/tickets/{}/{}/'.format(key, generate_hash(key)) + order_identifier + '.pdf'
296 try:
297 response = make_response(send_file(file_path))
298 response.headers['Content-Disposition'] = 'attachment; filename=ticket-%s.zip' % order_identifier
299 return response
300 except FileNotFoundError:
301 create_pdf_tickets_for_holder(order)
302 return redirect(url_for('ticket_blueprint.ticket_attendee_authorized', order_identifier=order_identifier))
303 else:
304 return ForbiddenError({'source': ''}, 'Unauthorized Access').respond()
305 else:
306 return ForbiddenError({'source': ''}, 'Authentication Required to access ticket').respond()
307
308
309 @ticket_blueprint.route('/orders/invoices/<string:order_identifier>')
310 @jwt_required()
311 def order_invoices(order_identifier):
312 if current_user:
313 try:
314 order = Order.query.filter_by(identifier=order_identifier).first()
315 user_id = order.user.id
316 except NoResultFound:
317 return NotFoundError({'source': ''}, 'Order Invoice not found').respond()
318 if current_user.id == user_id:
319 key = UPLOAD_PATHS['pdf']['order'].format(identifier=order_identifier)
320 file_path = '../generated/invoices/{}/{}/'.format(key, generate_hash(key)) + order_identifier + '.pdf'
321 response = make_response(send_file(file_path))
322 response.headers['Content-Disposition'] = 'attachment; filename=invoice-%s.zip' % order_identifier
323 return response
324 else:
325 return ForbiddenError({'source': ''}, 'Unauthorized Access').respond()
326 else:
327 return ForbiddenError({'source': ''}, 'Authentication Required to access Invoice').respond()
328
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/app/api/auth.py b/app/api/auth.py
--- a/app/api/auth.py
+++ b/app/api/auth.py
@@ -281,6 +281,11 @@
})
+def return_tickets(file_path, order_identifier):
+ response = make_response(send_file(file_path))
+ response.headers['Content-Disposition'] = 'attachment; filename=ticket-%s.pdf' % order_identifier
+ return response
+
@ticket_blueprint.route('/tickets/<string:order_identifier>')
@jwt_required()
def ticket_attendee_authorized(order_identifier):
@@ -294,12 +299,10 @@
key = UPLOAD_PATHS['pdf']['ticket_attendee'].format(identifier=order_identifier)
file_path = '../generated/tickets/{}/{}/'.format(key, generate_hash(key)) + order_identifier + '.pdf'
try:
- response = make_response(send_file(file_path))
- response.headers['Content-Disposition'] = 'attachment; filename=ticket-%s.zip' % order_identifier
- return response
+ return return_tickets(file_path, order_identifier)
except FileNotFoundError:
create_pdf_tickets_for_holder(order)
- return redirect(url_for('ticket_blueprint.ticket_attendee_authorized', order_identifier=order_identifier))
+ return return_tickets(file_path, order_identifier)
else:
return ForbiddenError({'source': ''}, 'Unauthorized Access').respond()
else:
|
{"golden_diff": "diff --git a/app/api/auth.py b/app/api/auth.py\n--- a/app/api/auth.py\n+++ b/app/api/auth.py\n@@ -281,6 +281,11 @@\n })\n \n \n+def return_tickets(file_path, order_identifier):\n+ response = make_response(send_file(file_path))\n+ response.headers['Content-Disposition'] = 'attachment; filename=ticket-%s.pdf' % order_identifier\n+ return response\n+\n @ticket_blueprint.route('/tickets/<string:order_identifier>')\n @jwt_required()\n def ticket_attendee_authorized(order_identifier):\n@@ -294,12 +299,10 @@\n key = UPLOAD_PATHS['pdf']['ticket_attendee'].format(identifier=order_identifier)\n file_path = '../generated/tickets/{}/{}/'.format(key, generate_hash(key)) + order_identifier + '.pdf'\n try:\n- response = make_response(send_file(file_path))\n- response.headers['Content-Disposition'] = 'attachment; filename=ticket-%s.zip' % order_identifier\n- return response\n+ return return_tickets(file_path, order_identifier)\n except FileNotFoundError:\n create_pdf_tickets_for_holder(order)\n- return redirect(url_for('ticket_blueprint.ticket_attendee_authorized', order_identifier=order_identifier))\n+ return return_tickets(file_path, order_identifier)\n else:\n return ForbiddenError({'source': ''}, 'Unauthorized Access').respond()\n else:\n", "issue": "Tickets endpoint results in too many redirects in production.\n```python\r\n try:\r\n response = make_response(send_file(file_path))\r\n response.headers['Content-Disposition'] = 'attachment; filename=ticket-%s.pdf' % order_identifier\r\n return response\r\n except FileNotFoundError:\r\n create_pdf_tickets_for_holder(order)\r\n return redirect(url_for('ticket_blueprint.ticket_attendee_authorized', order_identifier=order_identifier))\r\n```\r\n\r\nThe redirect call seems to be the problem, removing it and manually sending the response seems to fix it.\r\n\n", "before_files": [{"content": "import os\nimport base64\nimport random\nimport string\n\nimport requests\nfrom flask import request, jsonify, make_response, Blueprint, send_file, url_for, redirect\nfrom flask_jwt import current_identity as current_user, jwt_required\nfrom sqlalchemy.orm.exc import NoResultFound\nfrom app.api.helpers.order import create_pdf_tickets_for_holder\nfrom app.api.helpers.storage import generate_hash\n\nfrom app import get_settings\nfrom app.api.helpers.db import save_to_db, get_count\nfrom app.api.helpers.errors import ForbiddenError, UnprocessableEntityError, NotFoundError, BadRequestError\nfrom app.api.helpers.files import make_frontend_url\nfrom app.api.helpers.mail import send_email_with_action, \\\n send_email_confirmation\nfrom app.api.helpers.notification import send_notification_with_action\nfrom app.api.helpers.third_party_auth import GoogleOAuth, FbOAuth, TwitterOAuth, InstagramOAuth\nfrom app.api.helpers.utilities import get_serializer, str_generator\nfrom app.models import db\nfrom app.models.order import Order\nfrom app.models.mail import PASSWORD_RESET, PASSWORD_CHANGE, \\\n USER_REGISTER_WITH_PASSWORD, PASSWORD_RESET_AND_VERIFY\nfrom app.models.notification import PASSWORD_CHANGE as PASSWORD_CHANGE_NOTIF\nfrom app.models.user import User\nfrom app.api.helpers.storage import UPLOAD_PATHS\n\n\nticket_blueprint = Blueprint('ticket_blueprint', __name__, url_prefix='/v1')\nauth_routes = Blueprint('auth', __name__, url_prefix='/v1/auth')\n\n\n@auth_routes.route('/oauth/<provider>', methods=['GET'])\ndef redirect_uri(provider):\n if provider == 'facebook':\n provider_class = FbOAuth()\n elif provider == 'google':\n provider_class = GoogleOAuth()\n elif provider == 'twitter':\n provider_class = TwitterOAuth()\n elif provider == 'instagram':\n provider_class = InstagramOAuth()\n else:\n return make_response(jsonify(\n message=\"No support for {}\".format(provider)), 404)\n\n client_id = provider_class.get_client_id()\n if not client_id:\n return make_response(jsonify(\n message=\"{} client id is not configured on the server\".format(provider)), 404)\n\n url = provider_class.get_auth_uri() + '?client_id=' + \\\n client_id + '&redirect_uri=' + \\\n provider_class.get_redirect_uri()\n return make_response(jsonify(url=url), 200)\n\n\n@auth_routes.route('/oauth/token/<provider>', methods=['GET'])\ndef get_token(provider):\n if provider == 'facebook':\n provider_class = FbOAuth()\n payload = {\n 'grant_type': 'client_credentials',\n 'client_id': provider_class.get_client_id(),\n 'client_secret': provider_class.get_client_secret()\n }\n elif provider == 'google':\n provider_class = GoogleOAuth()\n payload = {\n 'client_id': provider_class.get_client_id(),\n 'client_secret': provider_class.get_client_secret()\n }\n elif provider == 'twitter':\n provider_class = TwitterOAuth()\n payload = {\n 'client_id': provider_class.get_client_id(),\n 'client_secret': provider_class.get_client_secret()\n }\n elif provider == 'instagram':\n provider_class = InstagramOAuth()\n payload = {\n 'client_id': provider_class.get_client_id(),\n 'client_secret': provider_class.get_client_secret()\n }\n else:\n return make_response(jsonify(\n message=\"No support for {}\".format(provider)), 200)\n response = requests.post(provider_class.get_token_uri(), params=payload)\n return make_response(jsonify(token=response.json()), 200)\n\n\n@auth_routes.route('/oauth/login/<provider>', methods=['POST'])\ndef login_user(provider):\n if provider == 'facebook':\n provider_class = FbOAuth()\n payload = {\n 'client_id': provider_class.get_client_id(),\n 'redirect_uri': provider_class.get_redirect_uri(),\n 'client_secret': provider_class.get_client_secret(),\n 'code': request.args.get('code')\n }\n if not payload['client_id'] or not payload['client_secret']:\n raise NotImplementedError({'source': ''}, 'Facebook Login Not Configured')\n access_token = requests.get('https://graph.facebook.com/v3.0/oauth/access_token', params=payload).json()\n payload_details = {\n 'input_token': access_token['access_token'],\n 'access_token': provider_class.get_client_id() + '|' + provider_class.get_client_secret()\n }\n details = requests.get('https://graph.facebook.com/debug_token', params=payload_details).json()\n user_details = requests.get('https://graph.facebook.com/v3.0/' + details['data']['user_id'],\n params={'access_token': access_token['access_token'],\n 'fields': 'first_name, last_name, email'}).json()\n\n if get_count(db.session.query(User).filter_by(email=user_details['email'])) > 0:\n user = db.session.query(User).filter_by(email=user_details['email']).one()\n if not user.facebook_id:\n user.facebook_id = user_details['id']\n user.facebook_login_hash = random.getrandbits(128)\n save_to_db(user)\n return make_response(\n jsonify(user_id=user.id, email=user.email, oauth_hash=user.facebook_login_hash), 200)\n\n user = User()\n user.first_name = user_details['first_name']\n user.last_name = user_details['last_name']\n user.facebook_id = user_details['id']\n user.facebook_login_hash = random.getrandbits(128)\n user.password = ''.join(random.SystemRandom().choice(string.ascii_uppercase + string.digits) for _ in range(8))\n if user_details['email']:\n user.email = user_details['email']\n\n save_to_db(user)\n return make_response(jsonify(user_id=user.id, email=user.email, oauth_hash=user.facebook_login_hash),\n 200)\n\n elif provider == 'google':\n provider_class = GoogleOAuth()\n payload = {\n 'client_id': provider_class.get_client_id(),\n 'client_secret': provider_class.get_client_secret()\n }\n elif provider == 'twitter':\n provider_class = TwitterOAuth()\n payload = {\n 'client_id': provider_class.get_client_id(),\n 'client_secret': provider_class.get_client_secret()\n }\n elif provider == 'instagram':\n provider_class = InstagramOAuth()\n payload = {\n 'client_id': provider_class.get_client_id(),\n 'client_secret': provider_class.get_client_secret()\n }\n else:\n return make_response(jsonify(\n message=\"No support for {}\".format(provider)), 200)\n response = requests.post(provider_class.get_token_uri(), params=payload)\n return make_response(jsonify(token=response.json()), 200)\n\n\n@auth_routes.route('/verify-email', methods=['POST'])\ndef verify_email():\n token = base64.b64decode(request.json['data']['token'])\n s = get_serializer()\n\n try:\n data = s.loads(token)\n except Exception:\n return BadRequestError({'source': ''}, 'Invalid Token').respond()\n\n try:\n user = User.query.filter_by(email=data[0]).one()\n except Exception:\n return BadRequestError({'source': ''}, 'Invalid Token').respond()\n else:\n user.is_verified = True\n save_to_db(user)\n return make_response(jsonify(message=\"Email Verified\"), 200)\n\n\n@auth_routes.route('/resend-verification-email', methods=['POST'])\ndef resend_verification_email():\n try:\n email = request.json['data']['email']\n except TypeError:\n return BadRequestError({'source': ''}, 'Bad Request Error').respond()\n\n try:\n user = User.query.filter_by(email=email).one()\n except NoResultFound:\n return UnprocessableEntityError(\n {'source': ''}, 'User with email: ' + email + ' not found.').respond()\n else:\n serializer = get_serializer()\n hash_ = str(base64.b64encode(str(serializer.dumps(\n [user.email, str_generator()])).encode()), 'utf-8')\n link = make_frontend_url(\n '/verify'.format(id=user.id), {'token': hash_})\n send_email_confirmation(user.email, link)\n\n return make_response(jsonify(message=\"Verification email resent\"), 200)\n\n\n@auth_routes.route('/reset-password', methods=['POST'])\ndef reset_password_post():\n try:\n email = request.json['data']['email']\n except TypeError:\n return BadRequestError({'source': ''}, 'Bad Request Error').respond()\n\n try:\n user = User.query.filter_by(email=email).one()\n except NoResultFound:\n return NotFoundError({'source': ''}, 'User not found').respond()\n else:\n link = make_frontend_url('/reset-password', {'token': user.reset_password})\n if user.was_registered_with_order:\n send_email_with_action(user, PASSWORD_RESET_AND_VERIFY, app_name=get_settings()['app_name'], link=link)\n else:\n send_email_with_action(user, PASSWORD_RESET, app_name=get_settings()['app_name'], link=link)\n\n return make_response(jsonify(message=\"Email Sent\"), 200)\n\n\n@auth_routes.route('/reset-password', methods=['PATCH'])\ndef reset_password_patch():\n token = request.json['data']['token']\n password = request.json['data']['password']\n\n try:\n user = User.query.filter_by(reset_password=token).one()\n except NoResultFound:\n return NotFoundError({'source': ''}, 'User Not Found').respond()\n else:\n user.password = password\n if user.was_registered_with_order:\n user.is_verified = True\n save_to_db(user)\n\n return jsonify({\n \"id\": user.id,\n \"email\": user.email,\n \"name\": user.fullname if user.fullname else None\n })\n\n\n@auth_routes.route('/change-password', methods=['POST'])\n@jwt_required()\ndef change_password():\n old_password = request.json['data']['old-password']\n new_password = request.json['data']['new-password']\n\n try:\n user = User.query.filter_by(id=current_user.id).one()\n except NoResultFound:\n return NotFoundError({'source': ''}, 'User Not Found').respond()\n else:\n if user.is_correct_password(old_password):\n if user.is_correct_password(new_password):\n return BadRequestError({'source': ''},\n 'Old and New passwords must be different').respond()\n if len(new_password) < 8:\n return BadRequestError({'source': ''},\n 'Password should have minimum 8 characters').respond()\n user.password = new_password\n save_to_db(user)\n send_email_with_action(user, PASSWORD_CHANGE,\n app_name=get_settings()['app_name'])\n send_notification_with_action(user, PASSWORD_CHANGE_NOTIF,\n app_name=get_settings()['app_name'])\n else:\n return BadRequestError({'source': ''}, 'Wrong Password. Please enter correct current password.').respond()\n\n return jsonify({\n \"id\": user.id,\n \"email\": user.email,\n \"name\": user.fullname if user.fullname else None,\n \"password-changed\": True\n })\n\n\n@ticket_blueprint.route('/tickets/<string:order_identifier>')\n@jwt_required()\ndef ticket_attendee_authorized(order_identifier):\n if current_user:\n try:\n order = Order.query.filter_by(identifier=order_identifier).first()\n user_id = order.user.id\n except NoResultFound:\n return NotFoundError({'source': ''}, 'This ticket is not associated with any order').respond()\n if current_user.id == user_id:\n key = UPLOAD_PATHS['pdf']['ticket_attendee'].format(identifier=order_identifier)\n file_path = '../generated/tickets/{}/{}/'.format(key, generate_hash(key)) + order_identifier + '.pdf'\n try:\n response = make_response(send_file(file_path))\n response.headers['Content-Disposition'] = 'attachment; filename=ticket-%s.zip' % order_identifier\n return response\n except FileNotFoundError:\n create_pdf_tickets_for_holder(order)\n return redirect(url_for('ticket_blueprint.ticket_attendee_authorized', order_identifier=order_identifier))\n else:\n return ForbiddenError({'source': ''}, 'Unauthorized Access').respond()\n else:\n return ForbiddenError({'source': ''}, 'Authentication Required to access ticket').respond()\n\n\n@ticket_blueprint.route('/orders/invoices/<string:order_identifier>')\n@jwt_required()\ndef order_invoices(order_identifier):\n if current_user:\n try:\n order = Order.query.filter_by(identifier=order_identifier).first()\n user_id = order.user.id\n except NoResultFound:\n return NotFoundError({'source': ''}, 'Order Invoice not found').respond()\n if current_user.id == user_id:\n key = UPLOAD_PATHS['pdf']['order'].format(identifier=order_identifier)\n file_path = '../generated/invoices/{}/{}/'.format(key, generate_hash(key)) + order_identifier + '.pdf'\n response = make_response(send_file(file_path))\n response.headers['Content-Disposition'] = 'attachment; filename=invoice-%s.zip' % order_identifier\n return response\n else:\n return ForbiddenError({'source': ''}, 'Unauthorized Access').respond()\n else:\n return ForbiddenError({'source': ''}, 'Authentication Required to access Invoice').respond()\n", "path": "app/api/auth.py"}], "after_files": [{"content": "import os\nimport base64\nimport random\nimport string\n\nimport requests\nfrom flask import request, jsonify, make_response, Blueprint, send_file, url_for, redirect\nfrom flask_jwt import current_identity as current_user, jwt_required\nfrom sqlalchemy.orm.exc import NoResultFound\nfrom app.api.helpers.order import create_pdf_tickets_for_holder\nfrom app.api.helpers.storage import generate_hash\n\nfrom app import get_settings\nfrom app.api.helpers.db import save_to_db, get_count\nfrom app.api.helpers.errors import ForbiddenError, UnprocessableEntityError, NotFoundError, BadRequestError\nfrom app.api.helpers.files import make_frontend_url\nfrom app.api.helpers.mail import send_email_with_action, \\\n send_email_confirmation\nfrom app.api.helpers.notification import send_notification_with_action\nfrom app.api.helpers.third_party_auth import GoogleOAuth, FbOAuth, TwitterOAuth, InstagramOAuth\nfrom app.api.helpers.utilities import get_serializer, str_generator\nfrom app.models import db\nfrom app.models.order import Order\nfrom app.models.mail import PASSWORD_RESET, PASSWORD_CHANGE, \\\n USER_REGISTER_WITH_PASSWORD, PASSWORD_RESET_AND_VERIFY\nfrom app.models.notification import PASSWORD_CHANGE as PASSWORD_CHANGE_NOTIF\nfrom app.models.user import User\nfrom app.api.helpers.storage import UPLOAD_PATHS\n\n\nticket_blueprint = Blueprint('ticket_blueprint', __name__, url_prefix='/v1')\nauth_routes = Blueprint('auth', __name__, url_prefix='/v1/auth')\n\n\n@auth_routes.route('/oauth/<provider>', methods=['GET'])\ndef redirect_uri(provider):\n if provider == 'facebook':\n provider_class = FbOAuth()\n elif provider == 'google':\n provider_class = GoogleOAuth()\n elif provider == 'twitter':\n provider_class = TwitterOAuth()\n elif provider == 'instagram':\n provider_class = InstagramOAuth()\n else:\n return make_response(jsonify(\n message=\"No support for {}\".format(provider)), 404)\n\n client_id = provider_class.get_client_id()\n if not client_id:\n return make_response(jsonify(\n message=\"{} client id is not configured on the server\".format(provider)), 404)\n\n url = provider_class.get_auth_uri() + '?client_id=' + \\\n client_id + '&redirect_uri=' + \\\n provider_class.get_redirect_uri()\n return make_response(jsonify(url=url), 200)\n\n\n@auth_routes.route('/oauth/token/<provider>', methods=['GET'])\ndef get_token(provider):\n if provider == 'facebook':\n provider_class = FbOAuth()\n payload = {\n 'grant_type': 'client_credentials',\n 'client_id': provider_class.get_client_id(),\n 'client_secret': provider_class.get_client_secret()\n }\n elif provider == 'google':\n provider_class = GoogleOAuth()\n payload = {\n 'client_id': provider_class.get_client_id(),\n 'client_secret': provider_class.get_client_secret()\n }\n elif provider == 'twitter':\n provider_class = TwitterOAuth()\n payload = {\n 'client_id': provider_class.get_client_id(),\n 'client_secret': provider_class.get_client_secret()\n }\n elif provider == 'instagram':\n provider_class = InstagramOAuth()\n payload = {\n 'client_id': provider_class.get_client_id(),\n 'client_secret': provider_class.get_client_secret()\n }\n else:\n return make_response(jsonify(\n message=\"No support for {}\".format(provider)), 200)\n response = requests.post(provider_class.get_token_uri(), params=payload)\n return make_response(jsonify(token=response.json()), 200)\n\n\n@auth_routes.route('/oauth/login/<provider>', methods=['POST'])\ndef login_user(provider):\n if provider == 'facebook':\n provider_class = FbOAuth()\n payload = {\n 'client_id': provider_class.get_client_id(),\n 'redirect_uri': provider_class.get_redirect_uri(),\n 'client_secret': provider_class.get_client_secret(),\n 'code': request.args.get('code')\n }\n if not payload['client_id'] or not payload['client_secret']:\n raise NotImplementedError({'source': ''}, 'Facebook Login Not Configured')\n access_token = requests.get('https://graph.facebook.com/v3.0/oauth/access_token', params=payload).json()\n payload_details = {\n 'input_token': access_token['access_token'],\n 'access_token': provider_class.get_client_id() + '|' + provider_class.get_client_secret()\n }\n details = requests.get('https://graph.facebook.com/debug_token', params=payload_details).json()\n user_details = requests.get('https://graph.facebook.com/v3.0/' + details['data']['user_id'],\n params={'access_token': access_token['access_token'],\n 'fields': 'first_name, last_name, email'}).json()\n\n if get_count(db.session.query(User).filter_by(email=user_details['email'])) > 0:\n user = db.session.query(User).filter_by(email=user_details['email']).one()\n if not user.facebook_id:\n user.facebook_id = user_details['id']\n user.facebook_login_hash = random.getrandbits(128)\n save_to_db(user)\n return make_response(\n jsonify(user_id=user.id, email=user.email, oauth_hash=user.facebook_login_hash), 200)\n\n user = User()\n user.first_name = user_details['first_name']\n user.last_name = user_details['last_name']\n user.facebook_id = user_details['id']\n user.facebook_login_hash = random.getrandbits(128)\n user.password = ''.join(random.SystemRandom().choice(string.ascii_uppercase + string.digits) for _ in range(8))\n if user_details['email']:\n user.email = user_details['email']\n\n save_to_db(user)\n return make_response(jsonify(user_id=user.id, email=user.email, oauth_hash=user.facebook_login_hash),\n 200)\n\n elif provider == 'google':\n provider_class = GoogleOAuth()\n payload = {\n 'client_id': provider_class.get_client_id(),\n 'client_secret': provider_class.get_client_secret()\n }\n elif provider == 'twitter':\n provider_class = TwitterOAuth()\n payload = {\n 'client_id': provider_class.get_client_id(),\n 'client_secret': provider_class.get_client_secret()\n }\n elif provider == 'instagram':\n provider_class = InstagramOAuth()\n payload = {\n 'client_id': provider_class.get_client_id(),\n 'client_secret': provider_class.get_client_secret()\n }\n else:\n return make_response(jsonify(\n message=\"No support for {}\".format(provider)), 200)\n response = requests.post(provider_class.get_token_uri(), params=payload)\n return make_response(jsonify(token=response.json()), 200)\n\n\n@auth_routes.route('/verify-email', methods=['POST'])\ndef verify_email():\n token = base64.b64decode(request.json['data']['token'])\n s = get_serializer()\n\n try:\n data = s.loads(token)\n except Exception:\n return BadRequestError({'source': ''}, 'Invalid Token').respond()\n\n try:\n user = User.query.filter_by(email=data[0]).one()\n except Exception:\n return BadRequestError({'source': ''}, 'Invalid Token').respond()\n else:\n user.is_verified = True\n save_to_db(user)\n return make_response(jsonify(message=\"Email Verified\"), 200)\n\n\n@auth_routes.route('/resend-verification-email', methods=['POST'])\ndef resend_verification_email():\n try:\n email = request.json['data']['email']\n except TypeError:\n return BadRequestError({'source': ''}, 'Bad Request Error').respond()\n\n try:\n user = User.query.filter_by(email=email).one()\n except NoResultFound:\n return UnprocessableEntityError(\n {'source': ''}, 'User with email: ' + email + ' not found.').respond()\n else:\n serializer = get_serializer()\n hash_ = str(base64.b64encode(str(serializer.dumps(\n [user.email, str_generator()])).encode()), 'utf-8')\n link = make_frontend_url(\n '/verify'.format(id=user.id), {'token': hash_})\n send_email_confirmation(user.email, link)\n\n return make_response(jsonify(message=\"Verification email resent\"), 200)\n\n\n@auth_routes.route('/reset-password', methods=['POST'])\ndef reset_password_post():\n try:\n email = request.json['data']['email']\n except TypeError:\n return BadRequestError({'source': ''}, 'Bad Request Error').respond()\n\n try:\n user = User.query.filter_by(email=email).one()\n except NoResultFound:\n return NotFoundError({'source': ''}, 'User not found').respond()\n else:\n link = make_frontend_url('/reset-password', {'token': user.reset_password})\n if user.was_registered_with_order:\n send_email_with_action(user, PASSWORD_RESET_AND_VERIFY, app_name=get_settings()['app_name'], link=link)\n else:\n send_email_with_action(user, PASSWORD_RESET, app_name=get_settings()['app_name'], link=link)\n\n return make_response(jsonify(message=\"Email Sent\"), 200)\n\n\n@auth_routes.route('/reset-password', methods=['PATCH'])\ndef reset_password_patch():\n token = request.json['data']['token']\n password = request.json['data']['password']\n\n try:\n user = User.query.filter_by(reset_password=token).one()\n except NoResultFound:\n return NotFoundError({'source': ''}, 'User Not Found').respond()\n else:\n user.password = password\n if user.was_registered_with_order:\n user.is_verified = True\n save_to_db(user)\n\n return jsonify({\n \"id\": user.id,\n \"email\": user.email,\n \"name\": user.fullname if user.fullname else None\n })\n\n\n@auth_routes.route('/change-password', methods=['POST'])\n@jwt_required()\ndef change_password():\n old_password = request.json['data']['old-password']\n new_password = request.json['data']['new-password']\n\n try:\n user = User.query.filter_by(id=current_user.id).one()\n except NoResultFound:\n return NotFoundError({'source': ''}, 'User Not Found').respond()\n else:\n if user.is_correct_password(old_password):\n if user.is_correct_password(new_password):\n return BadRequestError({'source': ''},\n 'Old and New passwords must be different').respond()\n if len(new_password) < 8:\n return BadRequestError({'source': ''},\n 'Password should have minimum 8 characters').respond()\n user.password = new_password\n save_to_db(user)\n send_email_with_action(user, PASSWORD_CHANGE,\n app_name=get_settings()['app_name'])\n send_notification_with_action(user, PASSWORD_CHANGE_NOTIF,\n app_name=get_settings()['app_name'])\n else:\n return BadRequestError({'source': ''}, 'Wrong Password. Please enter correct current password.').respond()\n\n return jsonify({\n \"id\": user.id,\n \"email\": user.email,\n \"name\": user.fullname if user.fullname else None,\n \"password-changed\": True\n })\n\n\ndef return_tickets(file_path, order_identifier):\n response = make_response(send_file(file_path))\n response.headers['Content-Disposition'] = 'attachment; filename=ticket-%s.pdf' % order_identifier\n return response\n\n@ticket_blueprint.route('/tickets/<string:order_identifier>')\n@jwt_required()\ndef ticket_attendee_authorized(order_identifier):\n if current_user:\n try:\n order = Order.query.filter_by(identifier=order_identifier).first()\n user_id = order.user.id\n except NoResultFound:\n return NotFoundError({'source': ''}, 'This ticket is not associated with any order').respond()\n if current_user.id == user_id:\n key = UPLOAD_PATHS['pdf']['ticket_attendee'].format(identifier=order_identifier)\n file_path = '../generated/tickets/{}/{}/'.format(key, generate_hash(key)) + order_identifier + '.pdf'\n try:\n return return_tickets(file_path, order_identifier)\n except FileNotFoundError:\n create_pdf_tickets_for_holder(order)\n return return_tickets(file_path, order_identifier)\n else:\n return ForbiddenError({'source': ''}, 'Unauthorized Access').respond()\n else:\n return ForbiddenError({'source': ''}, 'Authentication Required to access ticket').respond()\n\n\n@ticket_blueprint.route('/orders/invoices/<string:order_identifier>')\n@jwt_required()\ndef order_invoices(order_identifier):\n if current_user:\n try:\n order = Order.query.filter_by(identifier=order_identifier).first()\n user_id = order.user.id\n except NoResultFound:\n return NotFoundError({'source': ''}, 'Order Invoice not found').respond()\n if current_user.id == user_id:\n key = UPLOAD_PATHS['pdf']['order'].format(identifier=order_identifier)\n file_path = '../generated/invoices/{}/{}/'.format(key, generate_hash(key)) + order_identifier + '.pdf'\n response = make_response(send_file(file_path))\n response.headers['Content-Disposition'] = 'attachment; filename=invoice-%s.zip' % order_identifier\n return response\n else:\n return ForbiddenError({'source': ''}, 'Unauthorized Access').respond()\n else:\n return ForbiddenError({'source': ''}, 'Authentication Required to access Invoice').respond()\n", "path": "app/api/auth.py"}]}
| 4,064 | 303 |
gh_patches_debug_12375
|
rasdani/github-patches
|
git_diff
|
pytorch__vision-6095
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
`Tensor.to` does not work with feature as reference
`torch.Tensor.to` accepts a tensor reference object as input in which case it converts to the reference dtype and device:
```py
>>> a = torch.zeros((), dtype=torch.float)
>>> b = torch.ones((), dtype=torch.int)
>>> b
tensor(1, dtype=torch.int32)
>>> b.to(a)
tensor(1.)
```
This also works for our custom features:
```py
>>> data = torch.rand(3, 2, 2)
>>> image = features.Image(data.to(torch.float64))
>>> image
Image([[[0.9595, 0.0947],
[0.9553, 0.5563]],
[[0.5435, 0.2975],
[0.3037, 0.0863]],
[[0.6253, 0.3481],
[0.3518, 0.4499]]], dtype=torch.float64)
>>> image.to(torch.float32)
Image([[[0.9595, 0.0947],
[0.9553, 0.5563]],
[[0.5435, 0.2975],
[0.3037, 0.0863]],
[[0.6253, 0.3481],
[0.3518, 0.4499]]])
>>> image.to(data)
Image([[[0.9595, 0.0947],
[0.9553, 0.5563]],
[[0.5435, 0.2975],
[0.3037, 0.0863]],
[[0.6253, 0.3481],
[0.3518, 0.4499]]])
```
However, it doesn't work if we want to convert a plain tensor and use a custom feature as reference:
```py
>>> data.to(image)
AttributeError: 'Tensor' object has no attribute 'color_space'
```
cc @bjuncek @pmeier
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `torchvision/prototype/features/_feature.py`
Content:
```
1 from __future__ import annotations
2
3 from types import ModuleType
4 from typing import Any, Callable, cast, List, Mapping, Optional, Sequence, Tuple, Type, TypeVar, Union
5
6 import PIL.Image
7 import torch
8 from torch._C import _TensorBase, DisableTorchFunction
9 from torchvision.transforms import InterpolationMode
10
11 F = TypeVar("F", bound="_Feature")
12 FillType = Union[int, float, Sequence[int], Sequence[float], None]
13 FillTypeJIT = Union[int, float, List[float], None]
14
15
16 def is_simple_tensor(inpt: Any) -> bool:
17 return isinstance(inpt, torch.Tensor) and not isinstance(inpt, _Feature)
18
19
20 class _Feature(torch.Tensor):
21 __F: Optional[ModuleType] = None
22
23 def __new__(
24 cls: Type[F],
25 data: Any,
26 *,
27 dtype: Optional[torch.dtype] = None,
28 device: Optional[Union[torch.device, str, int]] = None,
29 requires_grad: bool = False,
30 ) -> F:
31 return cast(
32 F,
33 torch.Tensor._make_subclass(
34 cast(_TensorBase, cls),
35 torch.as_tensor(data, dtype=dtype, device=device), # type: ignore[arg-type]
36 requires_grad,
37 ),
38 )
39
40 @classmethod
41 def new_like(
42 cls: Type[F],
43 other: F,
44 data: Any,
45 *,
46 dtype: Optional[torch.dtype] = None,
47 device: Optional[Union[torch.device, str, int]] = None,
48 requires_grad: Optional[bool] = None,
49 **kwargs: Any,
50 ) -> F:
51 return cls(
52 data,
53 dtype=dtype if dtype is not None else other.dtype,
54 device=device if device is not None else other.device,
55 requires_grad=requires_grad if requires_grad is not None else other.requires_grad,
56 **kwargs,
57 )
58
59 @classmethod
60 def __torch_function__(
61 cls,
62 func: Callable[..., torch.Tensor],
63 types: Tuple[Type[torch.Tensor], ...],
64 args: Sequence[Any] = (),
65 kwargs: Optional[Mapping[str, Any]] = None,
66 ) -> torch.Tensor:
67 """For general information about how the __torch_function__ protocol works,
68 see https://pytorch.org/docs/stable/notes/extending.html#extending-torch
69
70 TL;DR: Every time a PyTorch operator is called, it goes through the inputs and looks for the
71 ``__torch_function__`` method. If one is found, it is invoked with the operator as ``func`` as well as the
72 ``args`` and ``kwargs`` of the original call.
73
74 The default behavior of :class:`~torch.Tensor`'s is to retain a custom tensor type. For the :class:`Feature`
75 use case, this has two downsides:
76
77 1. Since some :class:`Feature`'s require metadata to be constructed, the default wrapping, i.e.
78 ``return cls(func(*args, **kwargs))``, will fail for them.
79 2. For most operations, there is no way of knowing if the input type is still valid for the output.
80
81 For these reasons, the automatic output wrapping is turned off for most operators.
82
83 Exceptions to this are:
84
85 - :func:`torch.clone`
86 - :meth:`torch.Tensor.to`
87 """
88 kwargs = kwargs or dict()
89 with DisableTorchFunction():
90 output = func(*args, **kwargs)
91
92 if func is torch.Tensor.clone:
93 return cls.new_like(args[0], output)
94 elif func is torch.Tensor.to:
95 return cls.new_like(args[0], output, dtype=output.dtype, device=output.device)
96 else:
97 return output
98
99 def _make_repr(self, **kwargs: Any) -> str:
100 # This is a poor man's implementation of the proposal in https://github.com/pytorch/pytorch/issues/76532.
101 # If that ever gets implemented, remove this in favor of the solution on the `torch.Tensor` class.
102 extra_repr = ", ".join(f"{key}={value}" for key, value in kwargs.items())
103 return f"{super().__repr__()[:-1]}, {extra_repr})"
104
105 @property
106 def _F(self) -> ModuleType:
107 # This implements a lazy import of the functional to get around the cyclic import. This import is deferred
108 # until the first time we need reference to the functional module and it's shared across all instances of
109 # the class. This approach avoids the DataLoader issue described at
110 # https://github.com/pytorch/vision/pull/6476#discussion_r953588621
111 if _Feature.__F is None:
112 from ..transforms import functional
113
114 _Feature.__F = functional
115 return _Feature.__F
116
117 def horizontal_flip(self) -> _Feature:
118 return self
119
120 def vertical_flip(self) -> _Feature:
121 return self
122
123 # TODO: We have to ignore override mypy error as there is torch.Tensor built-in deprecated op: Tensor.resize
124 # https://github.com/pytorch/pytorch/blob/e8727994eb7cdb2ab642749d6549bc497563aa06/torch/_tensor.py#L588-L593
125 def resize( # type: ignore[override]
126 self,
127 size: List[int],
128 interpolation: InterpolationMode = InterpolationMode.BILINEAR,
129 max_size: Optional[int] = None,
130 antialias: bool = False,
131 ) -> _Feature:
132 return self
133
134 def crop(self, top: int, left: int, height: int, width: int) -> _Feature:
135 return self
136
137 def center_crop(self, output_size: List[int]) -> _Feature:
138 return self
139
140 def resized_crop(
141 self,
142 top: int,
143 left: int,
144 height: int,
145 width: int,
146 size: List[int],
147 interpolation: InterpolationMode = InterpolationMode.BILINEAR,
148 antialias: bool = False,
149 ) -> _Feature:
150 return self
151
152 def pad(
153 self,
154 padding: Union[int, List[int]],
155 fill: FillTypeJIT = None,
156 padding_mode: str = "constant",
157 ) -> _Feature:
158 return self
159
160 def rotate(
161 self,
162 angle: float,
163 interpolation: InterpolationMode = InterpolationMode.NEAREST,
164 expand: bool = False,
165 fill: FillTypeJIT = None,
166 center: Optional[List[float]] = None,
167 ) -> _Feature:
168 return self
169
170 def affine(
171 self,
172 angle: Union[int, float],
173 translate: List[float],
174 scale: float,
175 shear: List[float],
176 interpolation: InterpolationMode = InterpolationMode.NEAREST,
177 fill: FillTypeJIT = None,
178 center: Optional[List[float]] = None,
179 ) -> _Feature:
180 return self
181
182 def perspective(
183 self,
184 perspective_coeffs: List[float],
185 interpolation: InterpolationMode = InterpolationMode.BILINEAR,
186 fill: FillTypeJIT = None,
187 ) -> _Feature:
188 return self
189
190 def elastic(
191 self,
192 displacement: torch.Tensor,
193 interpolation: InterpolationMode = InterpolationMode.BILINEAR,
194 fill: FillTypeJIT = None,
195 ) -> _Feature:
196 return self
197
198 def adjust_brightness(self, brightness_factor: float) -> _Feature:
199 return self
200
201 def adjust_saturation(self, saturation_factor: float) -> _Feature:
202 return self
203
204 def adjust_contrast(self, contrast_factor: float) -> _Feature:
205 return self
206
207 def adjust_sharpness(self, sharpness_factor: float) -> _Feature:
208 return self
209
210 def adjust_hue(self, hue_factor: float) -> _Feature:
211 return self
212
213 def adjust_gamma(self, gamma: float, gain: float = 1) -> _Feature:
214 return self
215
216 def posterize(self, bits: int) -> _Feature:
217 return self
218
219 def solarize(self, threshold: float) -> _Feature:
220 return self
221
222 def autocontrast(self) -> _Feature:
223 return self
224
225 def equalize(self) -> _Feature:
226 return self
227
228 def invert(self) -> _Feature:
229 return self
230
231 def gaussian_blur(self, kernel_size: List[int], sigma: Optional[List[float]] = None) -> _Feature:
232 return self
233
234
235 InputType = Union[torch.Tensor, PIL.Image.Image, _Feature]
236 InputTypeJIT = torch.Tensor
237
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/torchvision/prototype/features/_feature.py b/torchvision/prototype/features/_feature.py
--- a/torchvision/prototype/features/_feature.py
+++ b/torchvision/prototype/features/_feature.py
@@ -89,6 +89,13 @@
with DisableTorchFunction():
output = func(*args, **kwargs)
+ # The __torch_function__ protocol will invoke this method on all types involved in the computation by walking
+ # the MRO upwards. For example, `torch.Tensor(...).to(features.Image(...))` will invoke
+ # `features.Image.__torch_function__` first. The check below makes sure that we do not try to wrap in such a
+ # case.
+ if not isinstance(args[0], cls):
+ return output
+
if func is torch.Tensor.clone:
return cls.new_like(args[0], output)
elif func is torch.Tensor.to:
|
{"golden_diff": "diff --git a/torchvision/prototype/features/_feature.py b/torchvision/prototype/features/_feature.py\n--- a/torchvision/prototype/features/_feature.py\n+++ b/torchvision/prototype/features/_feature.py\n@@ -89,6 +89,13 @@\n with DisableTorchFunction():\n output = func(*args, **kwargs)\n \n+ # The __torch_function__ protocol will invoke this method on all types involved in the computation by walking\n+ # the MRO upwards. For example, `torch.Tensor(...).to(features.Image(...))` will invoke\n+ # `features.Image.__torch_function__` first. The check below makes sure that we do not try to wrap in such a\n+ # case.\n+ if not isinstance(args[0], cls):\n+ return output\n+\n if func is torch.Tensor.clone:\n return cls.new_like(args[0], output)\n elif func is torch.Tensor.to:\n", "issue": "`Tensor.to` does not work with feature as reference\n`torch.Tensor.to` accepts a tensor reference object as input in which case it converts to the reference dtype and device:\r\n\r\n```py\r\n>>> a = torch.zeros((), dtype=torch.float)\r\n>>> b = torch.ones((), dtype=torch.int)\r\n>>> b\r\ntensor(1, dtype=torch.int32)\r\n>>> b.to(a)\r\ntensor(1.)\r\n```\r\n\r\nThis also works for our custom features:\r\n\r\n```py\r\n>>> data = torch.rand(3, 2, 2)\r\n>>> image = features.Image(data.to(torch.float64))\r\n>>> image\r\nImage([[[0.9595, 0.0947],\r\n [0.9553, 0.5563]],\r\n [[0.5435, 0.2975],\r\n [0.3037, 0.0863]],\r\n [[0.6253, 0.3481],\r\n [0.3518, 0.4499]]], dtype=torch.float64)\r\n>>> image.to(torch.float32)\r\nImage([[[0.9595, 0.0947],\r\n [0.9553, 0.5563]],\r\n [[0.5435, 0.2975],\r\n [0.3037, 0.0863]],\r\n [[0.6253, 0.3481],\r\n [0.3518, 0.4499]]])\r\n>>> image.to(data)\r\nImage([[[0.9595, 0.0947],\r\n [0.9553, 0.5563]],\r\n [[0.5435, 0.2975],\r\n [0.3037, 0.0863]],\r\n [[0.6253, 0.3481],\r\n [0.3518, 0.4499]]])\r\n\r\n```\r\n\r\nHowever, it doesn't work if we want to convert a plain tensor and use a custom feature as reference:\r\n\r\n```py\r\n>>> data.to(image)\r\nAttributeError: 'Tensor' object has no attribute 'color_space'\r\n```\n\ncc @bjuncek @pmeier\n", "before_files": [{"content": "from __future__ import annotations\n\nfrom types import ModuleType\nfrom typing import Any, Callable, cast, List, Mapping, Optional, Sequence, Tuple, Type, TypeVar, Union\n\nimport PIL.Image\nimport torch\nfrom torch._C import _TensorBase, DisableTorchFunction\nfrom torchvision.transforms import InterpolationMode\n\nF = TypeVar(\"F\", bound=\"_Feature\")\nFillType = Union[int, float, Sequence[int], Sequence[float], None]\nFillTypeJIT = Union[int, float, List[float], None]\n\n\ndef is_simple_tensor(inpt: Any) -> bool:\n return isinstance(inpt, torch.Tensor) and not isinstance(inpt, _Feature)\n\n\nclass _Feature(torch.Tensor):\n __F: Optional[ModuleType] = None\n\n def __new__(\n cls: Type[F],\n data: Any,\n *,\n dtype: Optional[torch.dtype] = None,\n device: Optional[Union[torch.device, str, int]] = None,\n requires_grad: bool = False,\n ) -> F:\n return cast(\n F,\n torch.Tensor._make_subclass(\n cast(_TensorBase, cls),\n torch.as_tensor(data, dtype=dtype, device=device), # type: ignore[arg-type]\n requires_grad,\n ),\n )\n\n @classmethod\n def new_like(\n cls: Type[F],\n other: F,\n data: Any,\n *,\n dtype: Optional[torch.dtype] = None,\n device: Optional[Union[torch.device, str, int]] = None,\n requires_grad: Optional[bool] = None,\n **kwargs: Any,\n ) -> F:\n return cls(\n data,\n dtype=dtype if dtype is not None else other.dtype,\n device=device if device is not None else other.device,\n requires_grad=requires_grad if requires_grad is not None else other.requires_grad,\n **kwargs,\n )\n\n @classmethod\n def __torch_function__(\n cls,\n func: Callable[..., torch.Tensor],\n types: Tuple[Type[torch.Tensor], ...],\n args: Sequence[Any] = (),\n kwargs: Optional[Mapping[str, Any]] = None,\n ) -> torch.Tensor:\n \"\"\"For general information about how the __torch_function__ protocol works,\n see https://pytorch.org/docs/stable/notes/extending.html#extending-torch\n\n TL;DR: Every time a PyTorch operator is called, it goes through the inputs and looks for the\n ``__torch_function__`` method. If one is found, it is invoked with the operator as ``func`` as well as the\n ``args`` and ``kwargs`` of the original call.\n\n The default behavior of :class:`~torch.Tensor`'s is to retain a custom tensor type. For the :class:`Feature`\n use case, this has two downsides:\n\n 1. Since some :class:`Feature`'s require metadata to be constructed, the default wrapping, i.e.\n ``return cls(func(*args, **kwargs))``, will fail for them.\n 2. For most operations, there is no way of knowing if the input type is still valid for the output.\n\n For these reasons, the automatic output wrapping is turned off for most operators.\n\n Exceptions to this are:\n\n - :func:`torch.clone`\n - :meth:`torch.Tensor.to`\n \"\"\"\n kwargs = kwargs or dict()\n with DisableTorchFunction():\n output = func(*args, **kwargs)\n\n if func is torch.Tensor.clone:\n return cls.new_like(args[0], output)\n elif func is torch.Tensor.to:\n return cls.new_like(args[0], output, dtype=output.dtype, device=output.device)\n else:\n return output\n\n def _make_repr(self, **kwargs: Any) -> str:\n # This is a poor man's implementation of the proposal in https://github.com/pytorch/pytorch/issues/76532.\n # If that ever gets implemented, remove this in favor of the solution on the `torch.Tensor` class.\n extra_repr = \", \".join(f\"{key}={value}\" for key, value in kwargs.items())\n return f\"{super().__repr__()[:-1]}, {extra_repr})\"\n\n @property\n def _F(self) -> ModuleType:\n # This implements a lazy import of the functional to get around the cyclic import. This import is deferred\n # until the first time we need reference to the functional module and it's shared across all instances of\n # the class. This approach avoids the DataLoader issue described at\n # https://github.com/pytorch/vision/pull/6476#discussion_r953588621\n if _Feature.__F is None:\n from ..transforms import functional\n\n _Feature.__F = functional\n return _Feature.__F\n\n def horizontal_flip(self) -> _Feature:\n return self\n\n def vertical_flip(self) -> _Feature:\n return self\n\n # TODO: We have to ignore override mypy error as there is torch.Tensor built-in deprecated op: Tensor.resize\n # https://github.com/pytorch/pytorch/blob/e8727994eb7cdb2ab642749d6549bc497563aa06/torch/_tensor.py#L588-L593\n def resize( # type: ignore[override]\n self,\n size: List[int],\n interpolation: InterpolationMode = InterpolationMode.BILINEAR,\n max_size: Optional[int] = None,\n antialias: bool = False,\n ) -> _Feature:\n return self\n\n def crop(self, top: int, left: int, height: int, width: int) -> _Feature:\n return self\n\n def center_crop(self, output_size: List[int]) -> _Feature:\n return self\n\n def resized_crop(\n self,\n top: int,\n left: int,\n height: int,\n width: int,\n size: List[int],\n interpolation: InterpolationMode = InterpolationMode.BILINEAR,\n antialias: bool = False,\n ) -> _Feature:\n return self\n\n def pad(\n self,\n padding: Union[int, List[int]],\n fill: FillTypeJIT = None,\n padding_mode: str = \"constant\",\n ) -> _Feature:\n return self\n\n def rotate(\n self,\n angle: float,\n interpolation: InterpolationMode = InterpolationMode.NEAREST,\n expand: bool = False,\n fill: FillTypeJIT = None,\n center: Optional[List[float]] = None,\n ) -> _Feature:\n return self\n\n def affine(\n self,\n angle: Union[int, float],\n translate: List[float],\n scale: float,\n shear: List[float],\n interpolation: InterpolationMode = InterpolationMode.NEAREST,\n fill: FillTypeJIT = None,\n center: Optional[List[float]] = None,\n ) -> _Feature:\n return self\n\n def perspective(\n self,\n perspective_coeffs: List[float],\n interpolation: InterpolationMode = InterpolationMode.BILINEAR,\n fill: FillTypeJIT = None,\n ) -> _Feature:\n return self\n\n def elastic(\n self,\n displacement: torch.Tensor,\n interpolation: InterpolationMode = InterpolationMode.BILINEAR,\n fill: FillTypeJIT = None,\n ) -> _Feature:\n return self\n\n def adjust_brightness(self, brightness_factor: float) -> _Feature:\n return self\n\n def adjust_saturation(self, saturation_factor: float) -> _Feature:\n return self\n\n def adjust_contrast(self, contrast_factor: float) -> _Feature:\n return self\n\n def adjust_sharpness(self, sharpness_factor: float) -> _Feature:\n return self\n\n def adjust_hue(self, hue_factor: float) -> _Feature:\n return self\n\n def adjust_gamma(self, gamma: float, gain: float = 1) -> _Feature:\n return self\n\n def posterize(self, bits: int) -> _Feature:\n return self\n\n def solarize(self, threshold: float) -> _Feature:\n return self\n\n def autocontrast(self) -> _Feature:\n return self\n\n def equalize(self) -> _Feature:\n return self\n\n def invert(self) -> _Feature:\n return self\n\n def gaussian_blur(self, kernel_size: List[int], sigma: Optional[List[float]] = None) -> _Feature:\n return self\n\n\nInputType = Union[torch.Tensor, PIL.Image.Image, _Feature]\nInputTypeJIT = torch.Tensor\n", "path": "torchvision/prototype/features/_feature.py"}], "after_files": [{"content": "from __future__ import annotations\n\nfrom types import ModuleType\nfrom typing import Any, Callable, cast, List, Mapping, Optional, Sequence, Tuple, Type, TypeVar, Union\n\nimport PIL.Image\nimport torch\nfrom torch._C import _TensorBase, DisableTorchFunction\nfrom torchvision.transforms import InterpolationMode\n\nF = TypeVar(\"F\", bound=\"_Feature\")\nFillType = Union[int, float, Sequence[int], Sequence[float], None]\nFillTypeJIT = Union[int, float, List[float], None]\n\n\ndef is_simple_tensor(inpt: Any) -> bool:\n return isinstance(inpt, torch.Tensor) and not isinstance(inpt, _Feature)\n\n\nclass _Feature(torch.Tensor):\n __F: Optional[ModuleType] = None\n\n def __new__(\n cls: Type[F],\n data: Any,\n *,\n dtype: Optional[torch.dtype] = None,\n device: Optional[Union[torch.device, str, int]] = None,\n requires_grad: bool = False,\n ) -> F:\n return cast(\n F,\n torch.Tensor._make_subclass(\n cast(_TensorBase, cls),\n torch.as_tensor(data, dtype=dtype, device=device), # type: ignore[arg-type]\n requires_grad,\n ),\n )\n\n @classmethod\n def new_like(\n cls: Type[F],\n other: F,\n data: Any,\n *,\n dtype: Optional[torch.dtype] = None,\n device: Optional[Union[torch.device, str, int]] = None,\n requires_grad: Optional[bool] = None,\n **kwargs: Any,\n ) -> F:\n return cls(\n data,\n dtype=dtype if dtype is not None else other.dtype,\n device=device if device is not None else other.device,\n requires_grad=requires_grad if requires_grad is not None else other.requires_grad,\n **kwargs,\n )\n\n @classmethod\n def __torch_function__(\n cls,\n func: Callable[..., torch.Tensor],\n types: Tuple[Type[torch.Tensor], ...],\n args: Sequence[Any] = (),\n kwargs: Optional[Mapping[str, Any]] = None,\n ) -> torch.Tensor:\n \"\"\"For general information about how the __torch_function__ protocol works,\n see https://pytorch.org/docs/stable/notes/extending.html#extending-torch\n\n TL;DR: Every time a PyTorch operator is called, it goes through the inputs and looks for the\n ``__torch_function__`` method. If one is found, it is invoked with the operator as ``func`` as well as the\n ``args`` and ``kwargs`` of the original call.\n\n The default behavior of :class:`~torch.Tensor`'s is to retain a custom tensor type. For the :class:`Feature`\n use case, this has two downsides:\n\n 1. Since some :class:`Feature`'s require metadata to be constructed, the default wrapping, i.e.\n ``return cls(func(*args, **kwargs))``, will fail for them.\n 2. For most operations, there is no way of knowing if the input type is still valid for the output.\n\n For these reasons, the automatic output wrapping is turned off for most operators.\n\n Exceptions to this are:\n\n - :func:`torch.clone`\n - :meth:`torch.Tensor.to`\n \"\"\"\n kwargs = kwargs or dict()\n with DisableTorchFunction():\n output = func(*args, **kwargs)\n\n # The __torch_function__ protocol will invoke this method on all types involved in the computation by walking\n # the MRO upwards. For example, `torch.Tensor(...).to(features.Image(...))` will invoke\n # `features.Image.__torch_function__` first. The check below makes sure that we do not try to wrap in such a\n # case.\n if not isinstance(args[0], cls):\n return output\n\n if func is torch.Tensor.clone:\n return cls.new_like(args[0], output)\n elif func is torch.Tensor.to:\n return cls.new_like(args[0], output, dtype=output.dtype, device=output.device)\n else:\n return output\n\n def _make_repr(self, **kwargs: Any) -> str:\n # This is a poor man's implementation of the proposal in https://github.com/pytorch/pytorch/issues/76532.\n # If that ever gets implemented, remove this in favor of the solution on the `torch.Tensor` class.\n extra_repr = \", \".join(f\"{key}={value}\" for key, value in kwargs.items())\n return f\"{super().__repr__()[:-1]}, {extra_repr})\"\n\n @property\n def _F(self) -> ModuleType:\n # This implements a lazy import of the functional to get around the cyclic import. This import is deferred\n # until the first time we need reference to the functional module and it's shared across all instances of\n # the class. This approach avoids the DataLoader issue described at\n # https://github.com/pytorch/vision/pull/6476#discussion_r953588621\n if _Feature.__F is None:\n from ..transforms import functional\n\n _Feature.__F = functional\n return _Feature.__F\n\n def horizontal_flip(self) -> _Feature:\n return self\n\n def vertical_flip(self) -> _Feature:\n return self\n\n # TODO: We have to ignore override mypy error as there is torch.Tensor built-in deprecated op: Tensor.resize\n # https://github.com/pytorch/pytorch/blob/e8727994eb7cdb2ab642749d6549bc497563aa06/torch/_tensor.py#L588-L593\n def resize( # type: ignore[override]\n self,\n size: List[int],\n interpolation: InterpolationMode = InterpolationMode.BILINEAR,\n max_size: Optional[int] = None,\n antialias: bool = False,\n ) -> _Feature:\n return self\n\n def crop(self, top: int, left: int, height: int, width: int) -> _Feature:\n return self\n\n def center_crop(self, output_size: List[int]) -> _Feature:\n return self\n\n def resized_crop(\n self,\n top: int,\n left: int,\n height: int,\n width: int,\n size: List[int],\n interpolation: InterpolationMode = InterpolationMode.BILINEAR,\n antialias: bool = False,\n ) -> _Feature:\n return self\n\n def pad(\n self,\n padding: Union[int, List[int]],\n fill: FillTypeJIT = None,\n padding_mode: str = \"constant\",\n ) -> _Feature:\n return self\n\n def rotate(\n self,\n angle: float,\n interpolation: InterpolationMode = InterpolationMode.NEAREST,\n expand: bool = False,\n fill: FillTypeJIT = None,\n center: Optional[List[float]] = None,\n ) -> _Feature:\n return self\n\n def affine(\n self,\n angle: Union[int, float],\n translate: List[float],\n scale: float,\n shear: List[float],\n interpolation: InterpolationMode = InterpolationMode.NEAREST,\n fill: FillTypeJIT = None,\n center: Optional[List[float]] = None,\n ) -> _Feature:\n return self\n\n def perspective(\n self,\n perspective_coeffs: List[float],\n interpolation: InterpolationMode = InterpolationMode.BILINEAR,\n fill: FillTypeJIT = None,\n ) -> _Feature:\n return self\n\n def elastic(\n self,\n displacement: torch.Tensor,\n interpolation: InterpolationMode = InterpolationMode.BILINEAR,\n fill: FillTypeJIT = None,\n ) -> _Feature:\n return self\n\n def adjust_brightness(self, brightness_factor: float) -> _Feature:\n return self\n\n def adjust_saturation(self, saturation_factor: float) -> _Feature:\n return self\n\n def adjust_contrast(self, contrast_factor: float) -> _Feature:\n return self\n\n def adjust_sharpness(self, sharpness_factor: float) -> _Feature:\n return self\n\n def adjust_hue(self, hue_factor: float) -> _Feature:\n return self\n\n def adjust_gamma(self, gamma: float, gain: float = 1) -> _Feature:\n return self\n\n def posterize(self, bits: int) -> _Feature:\n return self\n\n def solarize(self, threshold: float) -> _Feature:\n return self\n\n def autocontrast(self) -> _Feature:\n return self\n\n def equalize(self) -> _Feature:\n return self\n\n def invert(self) -> _Feature:\n return self\n\n def gaussian_blur(self, kernel_size: List[int], sigma: Optional[List[float]] = None) -> _Feature:\n return self\n\n\nInputType = Union[torch.Tensor, PIL.Image.Image, _Feature]\nInputTypeJIT = torch.Tensor\n", "path": "torchvision/prototype/features/_feature.py"}]}
| 3,282 | 205 |
gh_patches_debug_17146
|
rasdani/github-patches
|
git_diff
|
facebookresearch__nevergrad-270
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Setup adds files directly to the root of sys.prefix
The arguments to `setup.py` add files directly to the root of `sys.prefix`, instead of in a nevergrad-specific subsubdirectory.
## Steps to reproduce
```console
jwnimmer@call-cc:~/issue$ python3 -m virtualenv --python python3 scratch
Already using interpreter /usr/bin/python3
Using base prefix '/usr'
New python executable in /home/jwnimmer/issue/scratch/bin/python3
Also creating executable in /home/jwnimmer/issue/scratch/bin/python
Installing setuptools, pkg_resources, pip, wheel...done.
jwnimmer@call-cc:~/issue$ scratch/bin/pip install 'nevergrad == 0.2.2'
Collecting nevergrad==0.2.2
Downloading https://files.pythonhosted.org/packages/46/04/b2f4673771fbd2fd07143f44a4f2880f8cbaa08a0cc32bdf287eef99c1d7/nevergrad-0.2.2-py3-none-any.whl (170kB)
... etc ...
... etc ...
Installing collected packages: typing-extensions, numpy, scipy, joblib, scikit-learn, bayesian-optimization, cma, six, python-dateutil, pytz, pandas, nevergrad
Successfully installed bayesian-optimization-1.0.1 cma-2.7.0 joblib-0.13.2 nevergrad-0.2.2 numpy-1.16.4 pandas-0.24.2 python-dateutil-2.8.0 pytz-2019.1 scikit-learn-0.21.2 scipy-1.3.0 six-1.12.0 typing-extensions-3.7.4
jwnimmer@call-cc:~/issue$ ls -l scratch
total 80
-rw-rw-r-- 1 jwnimmer jwnimmer 84 Jul 23 14:08 bench.txt
drwxrwxr-x 2 jwnimmer jwnimmer 4096 Jul 23 14:08 bin
-rw-rw-r-- 1 jwnimmer jwnimmer 102 Jul 23 14:08 dev.txt
drwxrwxr-x 2 jwnimmer jwnimmer 4096 Jul 23 14:07 include
drwxrwxr-x 3 jwnimmer jwnimmer 4096 Jul 23 14:07 lib
-rw-rw-r-- 1 jwnimmer jwnimmer 1086 Jul 23 14:08 LICENSE
-rw-rw-r-- 1 jwnimmer jwnimmer 94 Jul 23 14:08 main.txt
drwxrwxr-x 3 jwnimmer jwnimmer 4096 Jul 23 14:08 nevergrad
-rw-rw-r-- 1 jwnimmer jwnimmer 59 Jul 23 14:07 pip-selfcheck.json
drwxrwxr-x 3 jwnimmer jwnimmer 4096 Jul 23 14:07 share
```
## Observed Results
The `sys.prefix` contains spurious files:
```
LICENSE
bench.txt
dev.txt
main.txt
nevergrad/*
```
## Expected Results
Only standardized files and folders (bin, lib, share, ...) exist in the root of `sys.prefix`.
## Relevant Code
https://github.com/facebookresearch/nevergrad/blob/aabb4475b04fc10e668cd1ed6783d24107c72390/setup.py#L68-L70
## Additional thoughts
I am sure why the `LICENSE` or `*.txt` files are being explicitly installed in the first place. I believe that information is already available in the metadata. If they are to be installed, they should be in a nevergrad-specific subfolder.
I suspect the nevergrad examples are probably better installed using `packages=` or `package_data=` argument, not `data_files=`.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `setup.py`
Content:
```
1 #!/usr/bin/env python
2 # Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
3 #
4 # This source code is licensed under the MIT license found in the
5 # LICENSE file in the root directory of this source tree.
6
7 import re
8 from pathlib import Path
9 from typing import Dict, List, Match
10 from setuptools import setup
11 from setuptools import find_packages
12
13
14 # read requirements
15
16 requirements: Dict[str, List[str]] = {}
17 for extra in ["dev", "bench", "main"]:
18 requirements[extra] = Path(f"requirements/{extra}.txt").read_text().splitlines()
19
20
21 # build long description
22
23 with open("README.md", "r", encoding="utf-8") as fh:
24 long_description = fh.read()
25
26
27 def _replace_relative_links(regex: Match[str]) -> str:
28 """Converts relative links into links to master
29 """
30 string = regex.group()
31 link = regex.group("link")
32 name = regex.group("name")
33 if not link.startswith("http") and Path(link).exists():
34 githuburl = ("github.com/facebookresearch/nevergrad/blob/master" if not link.endswith(".gif") else
35 "raw.githubusercontent.com/facebookresearch/nevergrad/master")
36 string = f"[{name}](https://{githuburl}/{link})"
37 return string
38
39
40 pattern = re.compile(r"\[(?P<name>.+?)\]\((?P<link>\S+?)\)")
41 long_description = re.sub(pattern, _replace_relative_links, long_description)
42
43
44 # find version
45
46 init_str = Path("nevergrad/__init__.py").read_text()
47 match = re.search(r"^__version__ = \"(?P<version>[\w\.]+?)\"$", init_str, re.MULTILINE)
48 assert match is not None, "Could not find version in nevergrad/__init__.py"
49 version = match.group("version")
50
51
52 # setup
53
54 setup(
55 name="nevergrad",
56 version=version,
57 license="MIT",
58 description="A Python toolbox for performing gradient-free optimization",
59 long_description=long_description,
60 long_description_content_type="text/markdown",
61 author="Facebook AI Research",
62 url="https://github.com/facebookresearch/nevergrad",
63 packages=find_packages(),
64 classifiers=["License :: OSI Approved :: MIT License",
65 "Intended Audience :: Science/Research",
66 "Topic :: Scientific/Engineering",
67 "Programming Language :: Python"],
68 data_files=[("", ["LICENSE", "requirements/main.txt", "requirements/dev.txt", "requirements/bench.txt"]),
69 ("nevergrad", ["nevergrad/benchmark/additional/example.py",
70 "nevergrad/instrumentation/examples/script.py"])],
71 install_requires=requirements["main"],
72 extras_require={"all": requirements["dev"] + requirements["bench"],
73 "dev": requirements["dev"],
74 "benchmark": requirements["bench"]}
75 )
76
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/setup.py b/setup.py
--- a/setup.py
+++ b/setup.py
@@ -65,11 +65,9 @@
"Intended Audience :: Science/Research",
"Topic :: Scientific/Engineering",
"Programming Language :: Python"],
- data_files=[("", ["LICENSE", "requirements/main.txt", "requirements/dev.txt", "requirements/bench.txt"]),
- ("nevergrad", ["nevergrad/benchmark/additional/example.py",
- "nevergrad/instrumentation/examples/script.py"])],
install_requires=requirements["main"],
extras_require={"all": requirements["dev"] + requirements["bench"],
"dev": requirements["dev"],
- "benchmark": requirements["bench"]}
+ "benchmark": requirements["bench"]},
+ package_data={"nevergrad": ["py.typed", "*.csv", "*.py", "functions/photonics/src/*"]},
)
|
{"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -65,11 +65,9 @@\n \"Intended Audience :: Science/Research\",\n \"Topic :: Scientific/Engineering\",\n \"Programming Language :: Python\"],\n- data_files=[(\"\", [\"LICENSE\", \"requirements/main.txt\", \"requirements/dev.txt\", \"requirements/bench.txt\"]),\n- (\"nevergrad\", [\"nevergrad/benchmark/additional/example.py\",\n- \"nevergrad/instrumentation/examples/script.py\"])],\n install_requires=requirements[\"main\"],\n extras_require={\"all\": requirements[\"dev\"] + requirements[\"bench\"],\n \"dev\": requirements[\"dev\"],\n- \"benchmark\": requirements[\"bench\"]}\n+ \"benchmark\": requirements[\"bench\"]},\n+ package_data={\"nevergrad\": [\"py.typed\", \"*.csv\", \"*.py\", \"functions/photonics/src/*\"]},\n )\n", "issue": "Setup adds files directly to the root of sys.prefix\nThe arguments to `setup.py` add files directly to the root of `sys.prefix`, instead of in a nevergrad-specific subsubdirectory.\r\n\r\n## Steps to reproduce\r\n\r\n```console\r\njwnimmer@call-cc:~/issue$ python3 -m virtualenv --python python3 scratch\r\nAlready using interpreter /usr/bin/python3\r\nUsing base prefix '/usr'\r\nNew python executable in /home/jwnimmer/issue/scratch/bin/python3\r\nAlso creating executable in /home/jwnimmer/issue/scratch/bin/python\r\nInstalling setuptools, pkg_resources, pip, wheel...done.\r\n\r\njwnimmer@call-cc:~/issue$ scratch/bin/pip install 'nevergrad == 0.2.2'\r\nCollecting nevergrad==0.2.2\r\n Downloading https://files.pythonhosted.org/packages/46/04/b2f4673771fbd2fd07143f44a4f2880f8cbaa08a0cc32bdf287eef99c1d7/nevergrad-0.2.2-py3-none-any.whl (170kB)\r\n... etc ...\r\n... etc ...\r\nInstalling collected packages: typing-extensions, numpy, scipy, joblib, scikit-learn, bayesian-optimization, cma, six, python-dateutil, pytz, pandas, nevergrad\r\nSuccessfully installed bayesian-optimization-1.0.1 cma-2.7.0 joblib-0.13.2 nevergrad-0.2.2 numpy-1.16.4 pandas-0.24.2 python-dateutil-2.8.0 pytz-2019.1 scikit-learn-0.21.2 scipy-1.3.0 six-1.12.0 typing-extensions-3.7.4\r\n\r\njwnimmer@call-cc:~/issue$ ls -l scratch\r\ntotal 80\r\n-rw-rw-r-- 1 jwnimmer jwnimmer 84 Jul 23 14:08 bench.txt\r\ndrwxrwxr-x 2 jwnimmer jwnimmer 4096 Jul 23 14:08 bin\r\n-rw-rw-r-- 1 jwnimmer jwnimmer 102 Jul 23 14:08 dev.txt\r\ndrwxrwxr-x 2 jwnimmer jwnimmer 4096 Jul 23 14:07 include\r\ndrwxrwxr-x 3 jwnimmer jwnimmer 4096 Jul 23 14:07 lib\r\n-rw-rw-r-- 1 jwnimmer jwnimmer 1086 Jul 23 14:08 LICENSE\r\n-rw-rw-r-- 1 jwnimmer jwnimmer 94 Jul 23 14:08 main.txt\r\ndrwxrwxr-x 3 jwnimmer jwnimmer 4096 Jul 23 14:08 nevergrad\r\n-rw-rw-r-- 1 jwnimmer jwnimmer 59 Jul 23 14:07 pip-selfcheck.json\r\ndrwxrwxr-x 3 jwnimmer jwnimmer 4096 Jul 23 14:07 share\r\n```\r\n\r\n## Observed Results\r\n\r\nThe `sys.prefix` contains spurious files:\r\n```\r\nLICENSE\r\nbench.txt\r\ndev.txt\r\nmain.txt\r\nnevergrad/*\r\n```\r\n\r\n## Expected Results\r\n\r\nOnly standardized files and folders (bin, lib, share, ...) exist in the root of `sys.prefix`.\r\n\r\n## Relevant Code\r\n\r\nhttps://github.com/facebookresearch/nevergrad/blob/aabb4475b04fc10e668cd1ed6783d24107c72390/setup.py#L68-L70\r\n\r\n## Additional thoughts\r\n\r\nI am sure why the `LICENSE` or `*.txt` files are being explicitly installed in the first place. I believe that information is already available in the metadata. If they are to be installed, they should be in a nevergrad-specific subfolder.\r\n\r\nI suspect the nevergrad examples are probably better installed using `packages=` or `package_data=` argument, not `data_files=`.\n", "before_files": [{"content": "#!/usr/bin/env python\n# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.\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.\n\nimport re\nfrom pathlib import Path\nfrom typing import Dict, List, Match\nfrom setuptools import setup\nfrom setuptools import find_packages\n\n\n# read requirements\n\nrequirements: Dict[str, List[str]] = {}\nfor extra in [\"dev\", \"bench\", \"main\"]:\n requirements[extra] = Path(f\"requirements/{extra}.txt\").read_text().splitlines()\n\n\n# build long description\n\nwith open(\"README.md\", \"r\", encoding=\"utf-8\") as fh:\n long_description = fh.read()\n\n\ndef _replace_relative_links(regex: Match[str]) -> str:\n \"\"\"Converts relative links into links to master\n \"\"\"\n string = regex.group()\n link = regex.group(\"link\")\n name = regex.group(\"name\")\n if not link.startswith(\"http\") and Path(link).exists():\n githuburl = (\"github.com/facebookresearch/nevergrad/blob/master\" if not link.endswith(\".gif\") else\n \"raw.githubusercontent.com/facebookresearch/nevergrad/master\")\n string = f\"[{name}](https://{githuburl}/{link})\"\n return string\n\n\npattern = re.compile(r\"\\[(?P<name>.+?)\\]\\((?P<link>\\S+?)\\)\")\nlong_description = re.sub(pattern, _replace_relative_links, long_description)\n\n\n# find version\n\ninit_str = Path(\"nevergrad/__init__.py\").read_text()\nmatch = re.search(r\"^__version__ = \\\"(?P<version>[\\w\\.]+?)\\\"$\", init_str, re.MULTILINE)\nassert match is not None, \"Could not find version in nevergrad/__init__.py\"\nversion = match.group(\"version\")\n\n\n# setup\n\nsetup(\n name=\"nevergrad\",\n version=version,\n license=\"MIT\",\n description=\"A Python toolbox for performing gradient-free optimization\",\n long_description=long_description,\n long_description_content_type=\"text/markdown\",\n author=\"Facebook AI Research\",\n url=\"https://github.com/facebookresearch/nevergrad\",\n packages=find_packages(),\n classifiers=[\"License :: OSI Approved :: MIT License\",\n \"Intended Audience :: Science/Research\",\n \"Topic :: Scientific/Engineering\",\n \"Programming Language :: Python\"],\n data_files=[(\"\", [\"LICENSE\", \"requirements/main.txt\", \"requirements/dev.txt\", \"requirements/bench.txt\"]),\n (\"nevergrad\", [\"nevergrad/benchmark/additional/example.py\",\n \"nevergrad/instrumentation/examples/script.py\"])],\n install_requires=requirements[\"main\"],\n extras_require={\"all\": requirements[\"dev\"] + requirements[\"bench\"],\n \"dev\": requirements[\"dev\"],\n \"benchmark\": requirements[\"bench\"]}\n)\n", "path": "setup.py"}], "after_files": [{"content": "#!/usr/bin/env python\n# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.\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.\n\nimport re\nfrom pathlib import Path\nfrom typing import Dict, List, Match\nfrom setuptools import setup\nfrom setuptools import find_packages\n\n\n# read requirements\n\nrequirements: Dict[str, List[str]] = {}\nfor extra in [\"dev\", \"bench\", \"main\"]:\n requirements[extra] = Path(f\"requirements/{extra}.txt\").read_text().splitlines()\n\n\n# build long description\n\nwith open(\"README.md\", \"r\", encoding=\"utf-8\") as fh:\n long_description = fh.read()\n\n\ndef _replace_relative_links(regex: Match[str]) -> str:\n \"\"\"Converts relative links into links to master\n \"\"\"\n string = regex.group()\n link = regex.group(\"link\")\n name = regex.group(\"name\")\n if not link.startswith(\"http\") and Path(link).exists():\n githuburl = (\"github.com/facebookresearch/nevergrad/blob/master\" if not link.endswith(\".gif\") else\n \"raw.githubusercontent.com/facebookresearch/nevergrad/master\")\n string = f\"[{name}](https://{githuburl}/{link})\"\n return string\n\n\npattern = re.compile(r\"\\[(?P<name>.+?)\\]\\((?P<link>\\S+?)\\)\")\nlong_description = re.sub(pattern, _replace_relative_links, long_description)\n\n\n# find version\n\ninit_str = Path(\"nevergrad/__init__.py\").read_text()\nmatch = re.search(r\"^__version__ = \\\"(?P<version>[\\w\\.]+?)\\\"$\", init_str, re.MULTILINE)\nassert match is not None, \"Could not find version in nevergrad/__init__.py\"\nversion = match.group(\"version\")\n\n\n# setup\n\nsetup(\n name=\"nevergrad\",\n version=version,\n license=\"MIT\",\n description=\"A Python toolbox for performing gradient-free optimization\",\n long_description=long_description,\n long_description_content_type=\"text/markdown\",\n author=\"Facebook AI Research\",\n url=\"https://github.com/facebookresearch/nevergrad\",\n packages=find_packages(),\n classifiers=[\"License :: OSI Approved :: MIT License\",\n \"Intended Audience :: Science/Research\",\n \"Topic :: Scientific/Engineering\",\n \"Programming Language :: Python\"],\n install_requires=requirements[\"main\"],\n extras_require={\"all\": requirements[\"dev\"] + requirements[\"bench\"],\n \"dev\": requirements[\"dev\"],\n \"benchmark\": requirements[\"bench\"]},\n package_data={\"nevergrad\": [\"py.typed\", \"*.csv\", \"*.py\", \"functions/photonics/src/*\"]},\n)\n", "path": "setup.py"}]}
| 1,967 | 191 |
gh_patches_debug_41311
|
rasdani/github-patches
|
git_diff
|
deepchecks__deepchecks-1522
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[FEAT] Enable ignoring Null values in the Is Single Value check
**Is your feature request related to a problem? Please describe.**
Currently, if the data has both a single value and NaNs in the same column, this column will be considered to have 2 unique values.
**Describe the solution you'd like**
Add a Boolean parameter telling the check to disregard NaN's
**Additional context**
Issue raised by @galsr in the [Deepchecks Community](https://join.slack.com/t/deepcheckscommunity/shared_invite/zt-1973c7twx-Ytb7_yJefTT4PmnMZj2p7A) support channel.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `docs/source/checks/tabular/data_integrity/plot_is_single_value.py`
Content:
```
1 # -*- coding: utf-8 -*-
2 """
3 Is Single Value
4 ***************
5 """
6
7 #%%
8 # Imports
9 # =======
10
11 import pandas as pd
12 from sklearn.datasets import load_iris
13
14 from deepchecks.tabular.checks import IsSingleValue
15
16 #%%
17 # Load Data
18 # =========
19
20 iris = load_iris()
21 X = iris.data
22 df = pd.DataFrame({'a':[3,4,1], 'b':[2,2,2], 'c':[None, None, None], 'd':['a', 4, 6]})
23 df
24
25 #%%
26 # See functionality
27 # =================
28
29 IsSingleValue().run(pd.DataFrame(X))
30
31 #%%
32
33 IsSingleValue().run(pd.DataFrame({'a':[3,4], 'b':[2,2], 'c':[None, None], 'd':['a', 4]}))
34
35 #%%
36
37 sv = IsSingleValue()
38 sv.run(df)
39
40 #%%
41
42 sv_ignore = IsSingleValue(ignore_columns=['b','c'])
43 sv_ignore.run(df)
44
```
Path: `deepchecks/tabular/checks/data_integrity/is_single_value.py`
Content:
```
1 # ----------------------------------------------------------------------------
2 # Copyright (C) 2021-2022 Deepchecks (https://www.deepchecks.com)
3 #
4 # This file is part of Deepchecks.
5 # Deepchecks is distributed under the terms of the GNU Affero General
6 # Public License (version 3 or later).
7 # You should have received a copy of the GNU Affero General Public License
8 # along with Deepchecks. If not, see <http://www.gnu.org/licenses/>.
9 # ----------------------------------------------------------------------------
10 #
11 """Module contains is_single_value check."""
12 from typing import List, Union
13
14 from deepchecks.core import CheckResult, ConditionCategory, ConditionResult
15 from deepchecks.tabular import Context, SingleDatasetCheck
16 from deepchecks.tabular.utils.messages import get_condition_passed_message
17 from deepchecks.utils.dataframes import select_from_dataframe
18 from deepchecks.utils.typing import Hashable
19
20 __all__ = ['IsSingleValue']
21
22
23 class IsSingleValue(SingleDatasetCheck):
24 """Check if there are columns which have only a single unique value in all rows.
25
26 Parameters
27 ----------
28 columns : Union[Hashable, List[Hashable]] , default: None
29 Columns to check, if none are given checks all
30 columns except ignored ones.
31 ignore_columns : Union[Hashable, List[Hashable]] , default: None
32 Columns to ignore, if none given checks based
33 on columns variable.
34 """
35
36 def __init__(
37 self,
38 columns: Union[Hashable, List[Hashable], None] = None,
39 ignore_columns: Union[Hashable, List[Hashable], None] = None,
40 **kwargs
41 ):
42 super().__init__(**kwargs)
43 self.columns = columns
44 self.ignore_columns = ignore_columns
45
46 def run_logic(self, context: Context, dataset_type: str = 'train') -> CheckResult:
47 """Run check.
48
49 Returns
50 -------
51 CheckResult
52 value of result is a dict of all columns with number of unique values in format {column: number_of_uniques}
53 display is a series with columns that have only one unique
54 """
55 # Validate parameters
56 if dataset_type == 'train':
57 df = context.train.data
58 else:
59 df = context.test.data
60
61 df = select_from_dataframe(df, self.columns, self.ignore_columns)
62
63 num_unique_per_col = df.nunique(dropna=False)
64 is_single_unique_value = (num_unique_per_col == 1)
65
66 if is_single_unique_value.any():
67 # get names of columns with one unique value
68 # pylint: disable=unsubscriptable-object
69 cols_with_single = is_single_unique_value[is_single_unique_value].index.to_list()
70 uniques = df.loc[:, cols_with_single].head(1)
71 uniques.index = ['Single unique value']
72 display = ['The following columns have only one unique value', uniques]
73 else:
74 display = None
75
76 return CheckResult(num_unique_per_col.to_dict(), header='Single Value in Column', display=display)
77
78 def add_condition_not_single_value(self):
79 """Add condition - not single value."""
80 name = 'Does not contain only a single value'
81
82 def condition(result):
83 single_value_cols = [k for k, v in result.items() if v == 1]
84 if single_value_cols:
85 details = f'Found {len(single_value_cols)} out of {len(result)} columns with a single value: ' \
86 f'{single_value_cols}'
87 return ConditionResult(ConditionCategory.FAIL, details)
88 else:
89 return ConditionResult(ConditionCategory.PASS, get_condition_passed_message(result))
90
91 return self.add_condition(name, condition)
92
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/deepchecks/tabular/checks/data_integrity/is_single_value.py b/deepchecks/tabular/checks/data_integrity/is_single_value.py
--- a/deepchecks/tabular/checks/data_integrity/is_single_value.py
+++ b/deepchecks/tabular/checks/data_integrity/is_single_value.py
@@ -11,6 +11,8 @@
"""Module contains is_single_value check."""
from typing import List, Union
+import pandas as pd
+
from deepchecks.core import CheckResult, ConditionCategory, ConditionResult
from deepchecks.tabular import Context, SingleDatasetCheck
from deepchecks.tabular.utils.messages import get_condition_passed_message
@@ -31,17 +33,21 @@
ignore_columns : Union[Hashable, List[Hashable]] , default: None
Columns to ignore, if none given checks based
on columns variable.
+ ignore_nan : bool, default True
+ Whether to ignore NaN values in a column when counting the number of unique values.
"""
def __init__(
self,
columns: Union[Hashable, List[Hashable], None] = None,
ignore_columns: Union[Hashable, List[Hashable], None] = None,
+ ignore_nan: bool = True,
**kwargs
):
super().__init__(**kwargs)
self.columns = columns
self.ignore_columns = ignore_columns
+ self.ignore_nan = ignore_nan
def run_logic(self, context: Context, dataset_type: str = 'train') -> CheckResult:
"""Run check.
@@ -60,14 +66,17 @@
df = select_from_dataframe(df, self.columns, self.ignore_columns)
- num_unique_per_col = df.nunique(dropna=False)
+ num_unique_per_col = df.nunique(dropna=self.ignore_nan)
is_single_unique_value = (num_unique_per_col == 1)
if is_single_unique_value.any():
# get names of columns with one unique value
# pylint: disable=unsubscriptable-object
cols_with_single = is_single_unique_value[is_single_unique_value].index.to_list()
- uniques = df.loc[:, cols_with_single].head(1)
+ uniques = pd.DataFrame({
+ column_name: [column.sort_values(kind='mergesort').values[0]]
+ for column_name, column in df.loc[:, cols_with_single].items()
+ })
uniques.index = ['Single unique value']
display = ['The following columns have only one unique value', uniques]
else:
diff --git a/docs/source/checks/tabular/data_integrity/plot_is_single_value.py b/docs/source/checks/tabular/data_integrity/plot_is_single_value.py
--- a/docs/source/checks/tabular/data_integrity/plot_is_single_value.py
+++ b/docs/source/checks/tabular/data_integrity/plot_is_single_value.py
@@ -8,6 +8,7 @@
# Imports
# =======
+import numpy as np
import pandas as pd
from sklearn.datasets import load_iris
@@ -41,3 +42,14 @@
sv_ignore = IsSingleValue(ignore_columns=['b','c'])
sv_ignore.run(df)
+
+#%%
+
+# Ignoring NaN values
+
+IsSingleValue(ignore_nan=True).run(pd.DataFrame({
+ 'a': [3, np.nan],
+ 'b': [2, 2],
+ 'c': [None, np.nan],
+ 'd': ['a', 4]
+}))
|
{"golden_diff": "diff --git a/deepchecks/tabular/checks/data_integrity/is_single_value.py b/deepchecks/tabular/checks/data_integrity/is_single_value.py\n--- a/deepchecks/tabular/checks/data_integrity/is_single_value.py\n+++ b/deepchecks/tabular/checks/data_integrity/is_single_value.py\n@@ -11,6 +11,8 @@\n \"\"\"Module contains is_single_value check.\"\"\"\n from typing import List, Union\n \n+import pandas as pd\n+\n from deepchecks.core import CheckResult, ConditionCategory, ConditionResult\n from deepchecks.tabular import Context, SingleDatasetCheck\n from deepchecks.tabular.utils.messages import get_condition_passed_message\n@@ -31,17 +33,21 @@\n ignore_columns : Union[Hashable, List[Hashable]] , default: None\n Columns to ignore, if none given checks based\n on columns variable.\n+ ignore_nan : bool, default True\n+ Whether to ignore NaN values in a column when counting the number of unique values.\n \"\"\"\n \n def __init__(\n self,\n columns: Union[Hashable, List[Hashable], None] = None,\n ignore_columns: Union[Hashable, List[Hashable], None] = None,\n+ ignore_nan: bool = True,\n **kwargs\n ):\n super().__init__(**kwargs)\n self.columns = columns\n self.ignore_columns = ignore_columns\n+ self.ignore_nan = ignore_nan\n \n def run_logic(self, context: Context, dataset_type: str = 'train') -> CheckResult:\n \"\"\"Run check.\n@@ -60,14 +66,17 @@\n \n df = select_from_dataframe(df, self.columns, self.ignore_columns)\n \n- num_unique_per_col = df.nunique(dropna=False)\n+ num_unique_per_col = df.nunique(dropna=self.ignore_nan)\n is_single_unique_value = (num_unique_per_col == 1)\n \n if is_single_unique_value.any():\n # get names of columns with one unique value\n # pylint: disable=unsubscriptable-object\n cols_with_single = is_single_unique_value[is_single_unique_value].index.to_list()\n- uniques = df.loc[:, cols_with_single].head(1)\n+ uniques = pd.DataFrame({\n+ column_name: [column.sort_values(kind='mergesort').values[0]]\n+ for column_name, column in df.loc[:, cols_with_single].items()\n+ })\n uniques.index = ['Single unique value']\n display = ['The following columns have only one unique value', uniques]\n else:\ndiff --git a/docs/source/checks/tabular/data_integrity/plot_is_single_value.py b/docs/source/checks/tabular/data_integrity/plot_is_single_value.py\n--- a/docs/source/checks/tabular/data_integrity/plot_is_single_value.py\n+++ b/docs/source/checks/tabular/data_integrity/plot_is_single_value.py\n@@ -8,6 +8,7 @@\n # Imports\n # =======\n \n+import numpy as np\n import pandas as pd\n from sklearn.datasets import load_iris\n \n@@ -41,3 +42,14 @@\n \n sv_ignore = IsSingleValue(ignore_columns=['b','c'])\n sv_ignore.run(df)\n+\n+#%%\n+\n+# Ignoring NaN values\n+\n+IsSingleValue(ignore_nan=True).run(pd.DataFrame({\n+ 'a': [3, np.nan], \n+ 'b': [2, 2],\n+ 'c': [None, np.nan], \n+ 'd': ['a', 4]\n+}))\n", "issue": "[FEAT] Enable ignoring Null values in the Is Single Value check\n**Is your feature request related to a problem? Please describe.**\r\nCurrently, if the data has both a single value and NaNs in the same column, this column will be considered to have 2 unique values.\r\n\r\n**Describe the solution you'd like**\r\nAdd a Boolean parameter telling the check to disregard NaN's\r\n\r\n**Additional context**\r\nIssue raised by @galsr in the [Deepchecks Community](https://join.slack.com/t/deepcheckscommunity/shared_invite/zt-1973c7twx-Ytb7_yJefTT4PmnMZj2p7A) support channel. \n", "before_files": [{"content": "# -*- coding: utf-8 -*-\n\"\"\"\nIs Single Value\n***************\n\"\"\"\n\n#%%\n# Imports\n# =======\n\nimport pandas as pd\nfrom sklearn.datasets import load_iris\n\nfrom deepchecks.tabular.checks import IsSingleValue\n\n#%%\n# Load Data\n# =========\n\niris = load_iris()\nX = iris.data\ndf = pd.DataFrame({'a':[3,4,1], 'b':[2,2,2], 'c':[None, None, None], 'd':['a', 4, 6]})\ndf\n\n#%%\n# See functionality\n# =================\n\nIsSingleValue().run(pd.DataFrame(X))\n\n#%%\n\nIsSingleValue().run(pd.DataFrame({'a':[3,4], 'b':[2,2], 'c':[None, None], 'd':['a', 4]}))\n\n#%%\n\nsv = IsSingleValue()\nsv.run(df)\n\n#%%\n\nsv_ignore = IsSingleValue(ignore_columns=['b','c'])\nsv_ignore.run(df)\n", "path": "docs/source/checks/tabular/data_integrity/plot_is_single_value.py"}, {"content": "# ----------------------------------------------------------------------------\n# Copyright (C) 2021-2022 Deepchecks (https://www.deepchecks.com)\n#\n# This file is part of Deepchecks.\n# Deepchecks is distributed under the terms of the GNU Affero General\n# Public License (version 3 or later).\n# You should have received a copy of the GNU Affero General Public License\n# along with Deepchecks. If not, see <http://www.gnu.org/licenses/>.\n# ----------------------------------------------------------------------------\n#\n\"\"\"Module contains is_single_value check.\"\"\"\nfrom typing import List, Union\n\nfrom deepchecks.core import CheckResult, ConditionCategory, ConditionResult\nfrom deepchecks.tabular import Context, SingleDatasetCheck\nfrom deepchecks.tabular.utils.messages import get_condition_passed_message\nfrom deepchecks.utils.dataframes import select_from_dataframe\nfrom deepchecks.utils.typing import Hashable\n\n__all__ = ['IsSingleValue']\n\n\nclass IsSingleValue(SingleDatasetCheck):\n \"\"\"Check if there are columns which have only a single unique value in all rows.\n\n Parameters\n ----------\n columns : Union[Hashable, List[Hashable]] , default: None\n Columns to check, if none are given checks all\n columns except ignored ones.\n ignore_columns : Union[Hashable, List[Hashable]] , default: None\n Columns to ignore, if none given checks based\n on columns variable.\n \"\"\"\n\n def __init__(\n self,\n columns: Union[Hashable, List[Hashable], None] = None,\n ignore_columns: Union[Hashable, List[Hashable], None] = None,\n **kwargs\n ):\n super().__init__(**kwargs)\n self.columns = columns\n self.ignore_columns = ignore_columns\n\n def run_logic(self, context: Context, dataset_type: str = 'train') -> CheckResult:\n \"\"\"Run check.\n\n Returns\n -------\n CheckResult\n value of result is a dict of all columns with number of unique values in format {column: number_of_uniques}\n display is a series with columns that have only one unique\n \"\"\"\n # Validate parameters\n if dataset_type == 'train':\n df = context.train.data\n else:\n df = context.test.data\n\n df = select_from_dataframe(df, self.columns, self.ignore_columns)\n\n num_unique_per_col = df.nunique(dropna=False)\n is_single_unique_value = (num_unique_per_col == 1)\n\n if is_single_unique_value.any():\n # get names of columns with one unique value\n # pylint: disable=unsubscriptable-object\n cols_with_single = is_single_unique_value[is_single_unique_value].index.to_list()\n uniques = df.loc[:, cols_with_single].head(1)\n uniques.index = ['Single unique value']\n display = ['The following columns have only one unique value', uniques]\n else:\n display = None\n\n return CheckResult(num_unique_per_col.to_dict(), header='Single Value in Column', display=display)\n\n def add_condition_not_single_value(self):\n \"\"\"Add condition - not single value.\"\"\"\n name = 'Does not contain only a single value'\n\n def condition(result):\n single_value_cols = [k for k, v in result.items() if v == 1]\n if single_value_cols:\n details = f'Found {len(single_value_cols)} out of {len(result)} columns with a single value: ' \\\n f'{single_value_cols}'\n return ConditionResult(ConditionCategory.FAIL, details)\n else:\n return ConditionResult(ConditionCategory.PASS, get_condition_passed_message(result))\n\n return self.add_condition(name, condition)\n", "path": "deepchecks/tabular/checks/data_integrity/is_single_value.py"}], "after_files": [{"content": "# -*- coding: utf-8 -*-\n\"\"\"\nIs Single Value\n***************\n\"\"\"\n\n#%%\n# Imports\n# =======\n\nimport numpy as np\nimport pandas as pd\nfrom sklearn.datasets import load_iris\n\nfrom deepchecks.tabular.checks import IsSingleValue\n\n#%%\n# Load Data\n# =========\n\niris = load_iris()\nX = iris.data\ndf = pd.DataFrame({'a':[3,4,1], 'b':[2,2,2], 'c':[None, None, None], 'd':['a', 4, 6]})\ndf\n\n#%%\n# See functionality\n# =================\n\nIsSingleValue().run(pd.DataFrame(X))\n\n#%%\n\nIsSingleValue().run(pd.DataFrame({'a':[3,4], 'b':[2,2], 'c':[None, None], 'd':['a', 4]}))\n\n#%%\n\nsv = IsSingleValue()\nsv.run(df)\n\n#%%\n\nsv_ignore = IsSingleValue(ignore_columns=['b','c'])\nsv_ignore.run(df)\n\n#%%\n\n# Ignoring NaN values\n\nIsSingleValue(ignore_nan=True).run(pd.DataFrame({\n 'a': [3, np.nan], \n 'b': [2, 2],\n 'c': [None, np.nan], \n 'd': ['a', 4]\n}))\n", "path": "docs/source/checks/tabular/data_integrity/plot_is_single_value.py"}, {"content": "# ----------------------------------------------------------------------------\n# Copyright (C) 2021-2022 Deepchecks (https://www.deepchecks.com)\n#\n# This file is part of Deepchecks.\n# Deepchecks is distributed under the terms of the GNU Affero General\n# Public License (version 3 or later).\n# You should have received a copy of the GNU Affero General Public License\n# along with Deepchecks. If not, see <http://www.gnu.org/licenses/>.\n# ----------------------------------------------------------------------------\n#\n\"\"\"Module contains is_single_value check.\"\"\"\nfrom typing import List, Union\n\nimport pandas as pd\n\nfrom deepchecks.core import CheckResult, ConditionCategory, ConditionResult\nfrom deepchecks.tabular import Context, SingleDatasetCheck\nfrom deepchecks.tabular.utils.messages import get_condition_passed_message\nfrom deepchecks.utils.dataframes import select_from_dataframe\nfrom deepchecks.utils.typing import Hashable\n\n__all__ = ['IsSingleValue']\n\n\nclass IsSingleValue(SingleDatasetCheck):\n \"\"\"Check if there are columns which have only a single unique value in all rows.\n\n Parameters\n ----------\n columns : Union[Hashable, List[Hashable]] , default: None\n Columns to check, if none are given checks all\n columns except ignored ones.\n ignore_columns : Union[Hashable, List[Hashable]] , default: None\n Columns to ignore, if none given checks based\n on columns variable.\n ignore_nan : bool, default True\n Whether to ignore NaN values in a column when counting the number of unique values.\n \"\"\"\n\n def __init__(\n self,\n columns: Union[Hashable, List[Hashable], None] = None,\n ignore_columns: Union[Hashable, List[Hashable], None] = None,\n ignore_nan: bool = True,\n **kwargs\n ):\n super().__init__(**kwargs)\n self.columns = columns\n self.ignore_columns = ignore_columns\n self.ignore_nan = ignore_nan\n\n def run_logic(self, context: Context, dataset_type: str = 'train') -> CheckResult:\n \"\"\"Run check.\n\n Returns\n -------\n CheckResult\n value of result is a dict of all columns with number of unique values in format {column: number_of_uniques}\n display is a series with columns that have only one unique\n \"\"\"\n # Validate parameters\n if dataset_type == 'train':\n df = context.train.data\n else:\n df = context.test.data\n\n df = select_from_dataframe(df, self.columns, self.ignore_columns)\n\n num_unique_per_col = df.nunique(dropna=self.ignore_nan)\n is_single_unique_value = (num_unique_per_col == 1)\n\n if is_single_unique_value.any():\n # get names of columns with one unique value\n # pylint: disable=unsubscriptable-object\n cols_with_single = is_single_unique_value[is_single_unique_value].index.to_list()\n uniques = pd.DataFrame({\n column_name: [column.sort_values(kind='mergesort').values[0]]\n for column_name, column in df.loc[:, cols_with_single].items()\n })\n uniques.index = ['Single unique value']\n display = ['The following columns have only one unique value', uniques]\n else:\n display = None\n\n return CheckResult(num_unique_per_col.to_dict(), header='Single Value in Column', display=display)\n\n def add_condition_not_single_value(self):\n \"\"\"Add condition - not single value.\"\"\"\n name = 'Does not contain only a single value'\n\n def condition(result):\n single_value_cols = [k for k, v in result.items() if v == 1]\n if single_value_cols:\n details = f'Found {len(single_value_cols)} out of {len(result)} columns with a single value: ' \\\n f'{single_value_cols}'\n return ConditionResult(ConditionCategory.FAIL, details)\n else:\n return ConditionResult(ConditionCategory.PASS, get_condition_passed_message(result))\n\n return self.add_condition(name, condition)\n", "path": "deepchecks/tabular/checks/data_integrity/is_single_value.py"}]}
| 1,683 | 769 |
gh_patches_debug_13084
|
rasdani/github-patches
|
git_diff
|
NVIDIA__NeMo-5261
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Fix links to speaker identification notebook
# What does this PR do ?
Fixes #5258
**Collection**: [Note which collection this PR will affect]
# Changelog
- Add specific line by line info of high level changes in this PR.
# Usage
* You can potentially add a usage example below
```python
# Add a code snippet demonstrating how to use this
```
# Before your PR is "Ready for review"
**Pre checks**:
- [ ] Make sure you read and followed [Contributor guidelines](https://github.com/NVIDIA/NeMo/blob/main/CONTRIBUTING.md)
- [ ] Did you write any new necessary tests?
- [ ] Did you add or update any necessary documentation?
- [ ] Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
- [ ] Reviewer: Does the PR have correct import guards for all optional libraries?
**PR Type**:
- [ ] New Feature
- [ ] Bugfix
- [ ] Documentation
If you haven't finished some of the above items you can still open "Draft" PR.
## Who can review?
Anyone in the community is free to review the PR once the checks have passed.
[Contributor guidelines](https://github.com/NVIDIA/NeMo/blob/main/CONTRIBUTING.md) contains specific people who can review PRs to various areas.
# Additional Information
* Related to # (issue)
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `examples/speaker_tasks/recognition/speaker_reco.py`
Content:
```
1 # Copyright (c) 2020, NVIDIA CORPORATION. All rights reserved.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 import os
16
17 import pytorch_lightning as pl
18 import torch
19 from omegaconf import OmegaConf
20 from pytorch_lightning import seed_everything
21
22 from nemo.collections.asr.models import EncDecSpeakerLabelModel
23 from nemo.core.config import hydra_runner
24 from nemo.utils import logging
25 from nemo.utils.exp_manager import exp_manager
26
27 """
28 Basic run (on GPU for 10 epochs for 2 class training):
29 EXP_NAME=sample_run
30 python ./speaker_reco.py --config-path='conf' --config-name='SpeakerNet_recognition_3x2x512.yaml' \
31 trainer.max_epochs=10 \
32 model.train_ds.batch_size=64 model.validation_ds.batch_size=64 \
33 model.train_ds.manifest_filepath="<train_manifest>" model.validation_ds.manifest_filepath="<dev_manifest>" \
34 model.test_ds.manifest_filepath="<test_manifest>" \
35 trainer.devices=1 \
36 model.decoder.params.num_classes=2 \
37 exp_manager.name=$EXP_NAME +exp_manager.use_datetime_version=False \
38 exp_manager.exp_dir='./speaker_exps'
39
40 See https://github.com/NVIDIA/NeMo/blob/main/tutorials/speaker_tasks/Speaker_Recognition_Verification.ipynb for notebook tutorial
41
42 Optional: Use tarred dataset to speech up data loading.
43 Prepare ONE manifest that contains all training data you would like to include. Validation should use non-tarred dataset.
44 Note that it's possible that tarred datasets impacts validation scores because it drop values in order to have same amount of files per tarfile;
45 Scores might be off since some data is missing.
46
47 Use the `convert_to_tarred_audio_dataset.py` script under <NEMO_ROOT>/speech_recognition/scripts in order to prepare tarred audio dataset.
48 For details, please see TarredAudioToClassificationLabelDataset in <NEMO_ROOT>/nemo/collections/asr/data/audio_to_label.py
49 """
50
51 seed_everything(42)
52
53
54 @hydra_runner(config_path="conf", config_name="SpeakerNet_verification_3x2x256.yaml")
55 def main(cfg):
56
57 logging.info(f'Hydra config: {OmegaConf.to_yaml(cfg)}')
58 trainer = pl.Trainer(**cfg.trainer)
59 log_dir = exp_manager(trainer, cfg.get("exp_manager", None))
60 speaker_model = EncDecSpeakerLabelModel(cfg=cfg.model, trainer=trainer)
61 trainer.fit(speaker_model)
62 if not trainer.fast_dev_run:
63 model_path = os.path.join(log_dir, '..', 'spkr.nemo')
64 speaker_model.save_to(model_path)
65
66 torch.distributed.destroy_process_group()
67 if hasattr(cfg.model, 'test_ds') and cfg.model.test_ds.manifest_filepath is not None:
68 if trainer.is_global_zero:
69 trainer = pl.Trainer(devices=1, accelerator=cfg.trainer.accelerator, strategy=cfg.trainer.strategy)
70 if speaker_model.prepare_test(trainer):
71 trainer.test(speaker_model)
72
73
74 if __name__ == '__main__':
75 main()
76
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/examples/speaker_tasks/recognition/speaker_reco.py b/examples/speaker_tasks/recognition/speaker_reco.py
--- a/examples/speaker_tasks/recognition/speaker_reco.py
+++ b/examples/speaker_tasks/recognition/speaker_reco.py
@@ -37,7 +37,7 @@
exp_manager.name=$EXP_NAME +exp_manager.use_datetime_version=False \
exp_manager.exp_dir='./speaker_exps'
-See https://github.com/NVIDIA/NeMo/blob/main/tutorials/speaker_tasks/Speaker_Recognition_Verification.ipynb for notebook tutorial
+See https://github.com/NVIDIA/NeMo/blob/main/tutorials/speaker_tasks/Speaker_Identification_Verification.ipynb for notebook tutorial
Optional: Use tarred dataset to speech up data loading.
Prepare ONE manifest that contains all training data you would like to include. Validation should use non-tarred dataset.
|
{"golden_diff": "diff --git a/examples/speaker_tasks/recognition/speaker_reco.py b/examples/speaker_tasks/recognition/speaker_reco.py\n--- a/examples/speaker_tasks/recognition/speaker_reco.py\n+++ b/examples/speaker_tasks/recognition/speaker_reco.py\n@@ -37,7 +37,7 @@\n exp_manager.name=$EXP_NAME +exp_manager.use_datetime_version=False \\\n exp_manager.exp_dir='./speaker_exps'\n \n-See https://github.com/NVIDIA/NeMo/blob/main/tutorials/speaker_tasks/Speaker_Recognition_Verification.ipynb for notebook tutorial\n+See https://github.com/NVIDIA/NeMo/blob/main/tutorials/speaker_tasks/Speaker_Identification_Verification.ipynb for notebook tutorial\n \n Optional: Use tarred dataset to speech up data loading.\n Prepare ONE manifest that contains all training data you would like to include. Validation should use non-tarred dataset.\n", "issue": "Fix links to speaker identification notebook\n# What does this PR do ?\r\n\r\nFixes #5258\r\n\r\n**Collection**: [Note which collection this PR will affect]\r\n\r\n# Changelog \r\n- Add specific line by line info of high level changes in this PR.\r\n\r\n# Usage\r\n* You can potentially add a usage example below\r\n\r\n```python\r\n# Add a code snippet demonstrating how to use this \r\n```\r\n\r\n# Before your PR is \"Ready for review\"\r\n**Pre checks**:\r\n- [ ] Make sure you read and followed [Contributor guidelines](https://github.com/NVIDIA/NeMo/blob/main/CONTRIBUTING.md)\r\n- [ ] Did you write any new necessary tests?\r\n- [ ] Did you add or update any necessary documentation?\r\n- [ ] Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)\r\n - [ ] Reviewer: Does the PR have correct import guards for all optional libraries?\r\n \r\n**PR Type**:\r\n- [ ] New Feature\r\n- [ ] Bugfix\r\n- [ ] Documentation\r\n\r\nIf you haven't finished some of the above items you can still open \"Draft\" PR.\r\n\r\n\r\n## Who can review?\r\n\r\nAnyone in the community is free to review the PR once the checks have passed. \r\n[Contributor guidelines](https://github.com/NVIDIA/NeMo/blob/main/CONTRIBUTING.md) contains specific people who can review PRs to various areas.\r\n\r\n# Additional Information\r\n* Related to # (issue)\r\n\n", "before_files": [{"content": "# Copyright (c) 2020, 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 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 os\n\nimport pytorch_lightning as pl\nimport torch\nfrom omegaconf import OmegaConf\nfrom pytorch_lightning import seed_everything\n\nfrom nemo.collections.asr.models import EncDecSpeakerLabelModel\nfrom nemo.core.config import hydra_runner\nfrom nemo.utils import logging\nfrom nemo.utils.exp_manager import exp_manager\n\n\"\"\"\nBasic run (on GPU for 10 epochs for 2 class training):\nEXP_NAME=sample_run\npython ./speaker_reco.py --config-path='conf' --config-name='SpeakerNet_recognition_3x2x512.yaml' \\\n trainer.max_epochs=10 \\\n model.train_ds.batch_size=64 model.validation_ds.batch_size=64 \\\n model.train_ds.manifest_filepath=\"<train_manifest>\" model.validation_ds.manifest_filepath=\"<dev_manifest>\" \\\n model.test_ds.manifest_filepath=\"<test_manifest>\" \\\n trainer.devices=1 \\\n model.decoder.params.num_classes=2 \\\n exp_manager.name=$EXP_NAME +exp_manager.use_datetime_version=False \\\n exp_manager.exp_dir='./speaker_exps'\n\nSee https://github.com/NVIDIA/NeMo/blob/main/tutorials/speaker_tasks/Speaker_Recognition_Verification.ipynb for notebook tutorial\n\nOptional: Use tarred dataset to speech up data loading.\n Prepare ONE manifest that contains all training data you would like to include. Validation should use non-tarred dataset.\n Note that it's possible that tarred datasets impacts validation scores because it drop values in order to have same amount of files per tarfile; \n Scores might be off since some data is missing. \n \n Use the `convert_to_tarred_audio_dataset.py` script under <NEMO_ROOT>/speech_recognition/scripts in order to prepare tarred audio dataset.\n For details, please see TarredAudioToClassificationLabelDataset in <NEMO_ROOT>/nemo/collections/asr/data/audio_to_label.py\n\"\"\"\n\nseed_everything(42)\n\n\n@hydra_runner(config_path=\"conf\", config_name=\"SpeakerNet_verification_3x2x256.yaml\")\ndef main(cfg):\n\n logging.info(f'Hydra config: {OmegaConf.to_yaml(cfg)}')\n trainer = pl.Trainer(**cfg.trainer)\n log_dir = exp_manager(trainer, cfg.get(\"exp_manager\", None))\n speaker_model = EncDecSpeakerLabelModel(cfg=cfg.model, trainer=trainer)\n trainer.fit(speaker_model)\n if not trainer.fast_dev_run:\n model_path = os.path.join(log_dir, '..', 'spkr.nemo')\n speaker_model.save_to(model_path)\n\n torch.distributed.destroy_process_group()\n if hasattr(cfg.model, 'test_ds') and cfg.model.test_ds.manifest_filepath is not None:\n if trainer.is_global_zero:\n trainer = pl.Trainer(devices=1, accelerator=cfg.trainer.accelerator, strategy=cfg.trainer.strategy)\n if speaker_model.prepare_test(trainer):\n trainer.test(speaker_model)\n\n\nif __name__ == '__main__':\n main()\n", "path": "examples/speaker_tasks/recognition/speaker_reco.py"}], "after_files": [{"content": "# Copyright (c) 2020, 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 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 os\n\nimport pytorch_lightning as pl\nimport torch\nfrom omegaconf import OmegaConf\nfrom pytorch_lightning import seed_everything\n\nfrom nemo.collections.asr.models import EncDecSpeakerLabelModel\nfrom nemo.core.config import hydra_runner\nfrom nemo.utils import logging\nfrom nemo.utils.exp_manager import exp_manager\n\n\"\"\"\nBasic run (on GPU for 10 epochs for 2 class training):\nEXP_NAME=sample_run\npython ./speaker_reco.py --config-path='conf' --config-name='SpeakerNet_recognition_3x2x512.yaml' \\\n trainer.max_epochs=10 \\\n model.train_ds.batch_size=64 model.validation_ds.batch_size=64 \\\n model.train_ds.manifest_filepath=\"<train_manifest>\" model.validation_ds.manifest_filepath=\"<dev_manifest>\" \\\n model.test_ds.manifest_filepath=\"<test_manifest>\" \\\n trainer.devices=1 \\\n model.decoder.params.num_classes=2 \\\n exp_manager.name=$EXP_NAME +exp_manager.use_datetime_version=False \\\n exp_manager.exp_dir='./speaker_exps'\n\nSee https://github.com/NVIDIA/NeMo/blob/main/tutorials/speaker_tasks/Speaker_Identification_Verification.ipynb for notebook tutorial\n\nOptional: Use tarred dataset to speech up data loading.\n Prepare ONE manifest that contains all training data you would like to include. Validation should use non-tarred dataset.\n Note that it's possible that tarred datasets impacts validation scores because it drop values in order to have same amount of files per tarfile; \n Scores might be off since some data is missing. \n \n Use the `convert_to_tarred_audio_dataset.py` script under <NEMO_ROOT>/speech_recognition/scripts in order to prepare tarred audio dataset.\n For details, please see TarredAudioToClassificationLabelDataset in <NEMO_ROOT>/nemo/collections/asr/data/audio_to_label.py\n\"\"\"\n\nseed_everything(42)\n\n\n@hydra_runner(config_path=\"conf\", config_name=\"SpeakerNet_verification_3x2x256.yaml\")\ndef main(cfg):\n\n logging.info(f'Hydra config: {OmegaConf.to_yaml(cfg)}')\n trainer = pl.Trainer(**cfg.trainer)\n log_dir = exp_manager(trainer, cfg.get(\"exp_manager\", None))\n speaker_model = EncDecSpeakerLabelModel(cfg=cfg.model, trainer=trainer)\n trainer.fit(speaker_model)\n if not trainer.fast_dev_run:\n model_path = os.path.join(log_dir, '..', 'spkr.nemo')\n speaker_model.save_to(model_path)\n\n torch.distributed.destroy_process_group()\n if hasattr(cfg.model, 'test_ds') and cfg.model.test_ds.manifest_filepath is not None:\n if trainer.is_global_zero:\n trainer = pl.Trainer(devices=1, accelerator=cfg.trainer.accelerator, strategy=cfg.trainer.strategy)\n if speaker_model.prepare_test(trainer):\n trainer.test(speaker_model)\n\n\nif __name__ == '__main__':\n main()\n", "path": "examples/speaker_tasks/recognition/speaker_reco.py"}]}
| 1,505 | 195 |
gh_patches_debug_11070
|
rasdani/github-patches
|
git_diff
|
pymedusa__Medusa-2780
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[APP SUBMITTED]: TypeError: level must be an integer
### INFO
**Python Version**: `2.7.9 (default, Sep 17 2016, 20:26:04) [GCC 4.9.2]`
**Operating System**: `Linux-4.4.38-v7+-armv7l-with-debian-8.0`
**Locale**: `UTF-8`
**Branch**: [develop](../tree/develop)
**Database**: `44.8`
**Commit**: pymedusa/Medusa@289e34a0ff1556d94f314ee1d268036bccbc19ba
**Link to Log**: https://gist.github.com/fab36c448ceab560ac5437227d5f393a
### ERROR
<pre>
2017-05-10 00:06:46 ERROR SEARCHQUEUE-MANUAL-274431 :: [Danishbits] :: [289e34a] Failed parsing provider. Traceback: 'Traceback (most recent call last):\n File "/home/pi/Medusa/medusa/providers/torrent/html/danishbits.py", line 174, in parse\n title, seeders, leechers)\n File "/home/pi/Medusa/medusa/logger/adapters/style.py", line 79, in log\n self.logger.log(level, brace_msg, **kwargs)\n File "/usr/lib/python2.7/logging/__init__.py", line 1482, in log\n self.logger.log(level, msg, *args, **kwargs)\n File "/usr/lib/python2.7/logging/__init__.py", line 1220, in log\n raise TypeError("level must be an integer")\nTypeError: level must be an integer\n'
Traceback (most recent call last):
File "/home/pi/Medusa/<a href="../blob/289e34a0ff1556d94f314ee1d268036bccbc19ba/medusa/providers/torrent/html/danishbits.py#L174">medusa/providers/torrent/html/danishbits.py</a>", line 174, in parse
title, seeders, leechers)
File "/home/pi/Medusa/<a href="../blob/289e34a0ff1556d94f314ee1d268036bccbc19ba/medusa/logger/adapters/style.py#L79">medusa/logger/adapters/style.py</a>", line 79, in log
self.logger.log(level, brace_msg, **kwargs)
File "/usr/lib/python2.7/logging/__init__.py", line 1482, in log
self.logger.log(level, msg, *args, **kwargs)
File "/usr/lib/python2.7/logging/__init__.py", line 1220, in log
raise TypeError("level must be an integer")
TypeError: level must be an integer
</pre>
---
_STAFF NOTIFIED_: @pymedusa/support @pymedusa/moderators
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `medusa/providers/torrent/html/danishbits.py`
Content:
```
1 # coding=utf-8
2
3 """Provider code for Danishbits."""
4
5 from __future__ import unicode_literals
6
7 import logging
8 import traceback
9
10 from dateutil import parser
11
12 from medusa import tv
13 from medusa.bs4_parser import BS4Parser
14 from medusa.helper.common import (
15 convert_size,
16 try_int,
17 )
18 from medusa.logger.adapters.style import BraceAdapter
19 from medusa.providers.torrent.torrent_provider import TorrentProvider
20
21 from requests.compat import urljoin
22 from requests.utils import dict_from_cookiejar
23
24 log = BraceAdapter(logging.getLogger(__name__))
25 log.logger.addHandler(logging.NullHandler())
26
27
28 class DanishbitsProvider(TorrentProvider):
29 """Danishbits Torrent provider."""
30
31 def __init__(self):
32 """Initialize the class."""
33 super(self.__class__, self).__init__('Danishbits')
34
35 # Credentials
36 self.username = None
37 self.password = None
38
39 # URLs
40 self.url = 'https://danishbits.org'
41 self.urls = {
42 'login': urljoin(self.url, 'login.php'),
43 'search': urljoin(self.url, 'torrents.php'),
44 }
45
46 # Proper Strings
47
48 # Miscellaneous Options
49 self.freeleech = True
50
51 # Torrent Stats
52 self.minseed = 0
53 self.minleech = 0
54
55 # Cache
56 self.cache = tv.Cache(self, min_time=10) # Only poll Danishbits every 10 minutes max
57
58 def search(self, search_strings, age=0, ep_obj=None):
59 """
60 Search a provider and parse the results.
61
62 :param search_strings: A dict with mode (key) and the search value (value)
63 :param age: Not used
64 :param ep_obj: Not used
65 :returns: A list of search results (structure)
66 """
67 results = []
68 if not self.login():
69 return results
70
71 # Search Params
72 search_params = {
73 'action': 'newbrowse',
74 'group': 3,
75 'search': '',
76 }
77
78 for mode in search_strings:
79 log.debug('Search mode: {0}', mode)
80
81 for search_string in search_strings[mode]:
82
83 if mode != 'RSS':
84 log.debug('Search string: {search}',
85 {'search': search_string})
86
87 search_params['search'] = search_string
88 response = self.get_url(self.urls['search'], params=search_params, returns='response')
89 if not response or not response.text:
90 log.debug('No data returned from provider')
91 continue
92
93 results += self.parse(response.text, mode)
94
95 return results
96
97 def parse(self, data, mode):
98 """
99 Parse search results for items.
100
101 :param data: The raw response from a search
102 :param mode: The current mode used to search, e.g. RSS
103
104 :return: A list of items found
105 """
106 # Units
107 units = ['B', 'KB', 'MB', 'GB', 'TB', 'PB']
108
109 def process_column_header(td):
110 result = ''
111 if td.img:
112 result = td.img.get('title')
113 if not result:
114 result = td.get_text(strip=True)
115 return result
116
117 items = []
118
119 with BS4Parser(data, 'html5lib') as html:
120 torrent_table = html.find('table', id='torrent_table')
121 torrent_rows = torrent_table('tr') if torrent_table else []
122
123 # Continue only if at least one release is found
124 if len(torrent_rows) < 2:
125 log.debug('Data returned from provider does not contain any torrents')
126 return items
127
128 # Literal: Navn, Størrelse, Kommentarer, Tilføjet, Snatches, Seeders, Leechers
129 # Translation: Name, Size, Comments, Added, Snatches, Seeders, Leechers
130 labels = [process_column_header(label) for label in torrent_rows[0]('td')]
131
132 # Skip column headers
133 for row in torrent_rows[1:]:
134 cells = row('td')
135 if len(cells) < len(labels):
136 continue
137
138 try:
139 title = row.find(class_='croptorrenttext').get_text(strip=True)
140 download_url = urljoin(self.url, row.find(title='Direkte download link')['href'])
141 if not all([title, download_url]):
142 continue
143
144 seeders = try_int(cells[labels.index('Seeders')].get_text(strip=True))
145 leechers = try_int(cells[labels.index('Leechers')].get_text(strip=True))
146
147 # Filter unseeded torrent
148 if seeders < min(self.minseed, 1):
149 if mode != 'RSS':
150 log.debug("Discarding torrent because it doesn't meet the"
151 " minimum seeders: {0}. Seeders: {1}",
152 title, seeders)
153 continue
154
155 freeleech = row.find(class_='freeleech')
156 if self.freeleech and not freeleech:
157 continue
158
159 torrent_size = cells[labels.index('Størrelse')].contents[0]
160 size = convert_size(torrent_size, units=units) or -1
161 pubdate_raw = cells[labels.index('Tilføjet')].find('span')['title']
162 pubdate = parser.parse(pubdate_raw, fuzzy=True) if pubdate_raw else None
163
164 item = {
165 'title': title,
166 'link': download_url,
167 'size': size,
168 'seeders': seeders,
169 'leechers': leechers,
170 'pubdate': pubdate,
171 }
172 if mode != 'RSS':
173 log.log('Found result: {0} with {1} seeders and {2} leechers',
174 title, seeders, leechers)
175
176 items.append(item)
177 except (AttributeError, TypeError, KeyError, ValueError, IndexError):
178 log.error('Failed parsing provider. Traceback: {0!r}',
179 traceback.format_exc())
180
181 return items
182
183 def login(self):
184 """Login method used for logging in before doing search and torrent downloads."""
185 if any(dict_from_cookiejar(self.session.cookies).values()):
186 return True
187
188 login_params = {
189 'username': self.username,
190 'password': self.password,
191 'keeplogged': 1,
192 'langlang': '',
193 'login': 'Login',
194 }
195
196 response = self.get_url(self.urls['login'], post_data=login_params, returns='response')
197 if not response or not response.text:
198 log.warning('Unable to connect to provider')
199 self.session.cookies.clear()
200 return False
201
202 if '<title>Login :: Danishbits.org</title>' in response.text:
203 log.warning('Invalid username or password. Check your settings')
204 self.session.cookies.clear()
205 return False
206
207 return True
208
209
210 provider = DanishbitsProvider()
211
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/medusa/providers/torrent/html/danishbits.py b/medusa/providers/torrent/html/danishbits.py
--- a/medusa/providers/torrent/html/danishbits.py
+++ b/medusa/providers/torrent/html/danishbits.py
@@ -170,8 +170,8 @@
'pubdate': pubdate,
}
if mode != 'RSS':
- log.log('Found result: {0} with {1} seeders and {2} leechers',
- title, seeders, leechers)
+ log.debug('Found result: {0} with {1} seeders and {2} leechers',
+ title, seeders, leechers)
items.append(item)
except (AttributeError, TypeError, KeyError, ValueError, IndexError):
|
{"golden_diff": "diff --git a/medusa/providers/torrent/html/danishbits.py b/medusa/providers/torrent/html/danishbits.py\n--- a/medusa/providers/torrent/html/danishbits.py\n+++ b/medusa/providers/torrent/html/danishbits.py\n@@ -170,8 +170,8 @@\n 'pubdate': pubdate,\n }\n if mode != 'RSS':\n- log.log('Found result: {0} with {1} seeders and {2} leechers',\n- title, seeders, leechers)\n+ log.debug('Found result: {0} with {1} seeders and {2} leechers',\n+ title, seeders, leechers)\n \n items.append(item)\n except (AttributeError, TypeError, KeyError, ValueError, IndexError):\n", "issue": "[APP SUBMITTED]: TypeError: level must be an integer\n### INFO\n**Python Version**: `2.7.9 (default, Sep 17 2016, 20:26:04) [GCC 4.9.2]`\n**Operating System**: `Linux-4.4.38-v7+-armv7l-with-debian-8.0`\n**Locale**: `UTF-8`\n**Branch**: [develop](../tree/develop)\n**Database**: `44.8`\n**Commit**: pymedusa/Medusa@289e34a0ff1556d94f314ee1d268036bccbc19ba\n**Link to Log**: https://gist.github.com/fab36c448ceab560ac5437227d5f393a\n### ERROR\n<pre>\n2017-05-10 00:06:46 ERROR SEARCHQUEUE-MANUAL-274431 :: [Danishbits] :: [289e34a] Failed parsing provider. Traceback: 'Traceback (most recent call last):\\n File \"/home/pi/Medusa/medusa/providers/torrent/html/danishbits.py\", line 174, in parse\\n title, seeders, leechers)\\n File \"/home/pi/Medusa/medusa/logger/adapters/style.py\", line 79, in log\\n self.logger.log(level, brace_msg, **kwargs)\\n File \"/usr/lib/python2.7/logging/__init__.py\", line 1482, in log\\n self.logger.log(level, msg, *args, **kwargs)\\n File \"/usr/lib/python2.7/logging/__init__.py\", line 1220, in log\\n raise TypeError(\"level must be an integer\")\\nTypeError: level must be an integer\\n'\nTraceback (most recent call last):\n File \"/home/pi/Medusa/<a href=\"../blob/289e34a0ff1556d94f314ee1d268036bccbc19ba/medusa/providers/torrent/html/danishbits.py#L174\">medusa/providers/torrent/html/danishbits.py</a>\", line 174, in parse\n title, seeders, leechers)\n File \"/home/pi/Medusa/<a href=\"../blob/289e34a0ff1556d94f314ee1d268036bccbc19ba/medusa/logger/adapters/style.py#L79\">medusa/logger/adapters/style.py</a>\", line 79, in log\n self.logger.log(level, brace_msg, **kwargs)\n File \"/usr/lib/python2.7/logging/__init__.py\", line 1482, in log\n self.logger.log(level, msg, *args, **kwargs)\n File \"/usr/lib/python2.7/logging/__init__.py\", line 1220, in log\n raise TypeError(\"level must be an integer\")\nTypeError: level must be an integer\n</pre>\n---\n_STAFF NOTIFIED_: @pymedusa/support @pymedusa/moderators\n", "before_files": [{"content": "# coding=utf-8\n\n\"\"\"Provider code for Danishbits.\"\"\"\n\nfrom __future__ import unicode_literals\n\nimport logging\nimport traceback\n\nfrom dateutil import parser\n\nfrom medusa import tv\nfrom medusa.bs4_parser import BS4Parser\nfrom medusa.helper.common import (\n convert_size,\n try_int,\n)\nfrom medusa.logger.adapters.style import BraceAdapter\nfrom medusa.providers.torrent.torrent_provider import TorrentProvider\n\nfrom requests.compat import urljoin\nfrom requests.utils import dict_from_cookiejar\n\nlog = BraceAdapter(logging.getLogger(__name__))\nlog.logger.addHandler(logging.NullHandler())\n\n\nclass DanishbitsProvider(TorrentProvider):\n \"\"\"Danishbits Torrent provider.\"\"\"\n\n def __init__(self):\n \"\"\"Initialize the class.\"\"\"\n super(self.__class__, self).__init__('Danishbits')\n\n # Credentials\n self.username = None\n self.password = None\n\n # URLs\n self.url = 'https://danishbits.org'\n self.urls = {\n 'login': urljoin(self.url, 'login.php'),\n 'search': urljoin(self.url, 'torrents.php'),\n }\n\n # Proper Strings\n\n # Miscellaneous Options\n self.freeleech = True\n\n # Torrent Stats\n self.minseed = 0\n self.minleech = 0\n\n # Cache\n self.cache = tv.Cache(self, min_time=10) # Only poll Danishbits every 10 minutes max\n\n def search(self, search_strings, age=0, ep_obj=None):\n \"\"\"\n Search a provider and parse the results.\n\n :param search_strings: A dict with mode (key) and the search value (value)\n :param age: Not used\n :param ep_obj: Not used\n :returns: A list of search results (structure)\n \"\"\"\n results = []\n if not self.login():\n return results\n\n # Search Params\n search_params = {\n 'action': 'newbrowse',\n 'group': 3,\n 'search': '',\n }\n\n for mode in search_strings:\n log.debug('Search mode: {0}', mode)\n\n for search_string in search_strings[mode]:\n\n if mode != 'RSS':\n log.debug('Search string: {search}',\n {'search': search_string})\n\n search_params['search'] = search_string\n response = self.get_url(self.urls['search'], params=search_params, returns='response')\n if not response or not response.text:\n log.debug('No data returned from provider')\n continue\n\n results += self.parse(response.text, mode)\n\n return results\n\n def parse(self, data, mode):\n \"\"\"\n Parse search results for items.\n\n :param data: The raw response from a search\n :param mode: The current mode used to search, e.g. RSS\n\n :return: A list of items found\n \"\"\"\n # Units\n units = ['B', 'KB', 'MB', 'GB', 'TB', 'PB']\n\n def process_column_header(td):\n result = ''\n if td.img:\n result = td.img.get('title')\n if not result:\n result = td.get_text(strip=True)\n return result\n\n items = []\n\n with BS4Parser(data, 'html5lib') as html:\n torrent_table = html.find('table', id='torrent_table')\n torrent_rows = torrent_table('tr') if torrent_table else []\n\n # Continue only if at least one release is found\n if len(torrent_rows) < 2:\n log.debug('Data returned from provider does not contain any torrents')\n return items\n\n # Literal: Navn, St\u00f8rrelse, Kommentarer, Tilf\u00f8jet, Snatches, Seeders, Leechers\n # Translation: Name, Size, Comments, Added, Snatches, Seeders, Leechers\n labels = [process_column_header(label) for label in torrent_rows[0]('td')]\n\n # Skip column headers\n for row in torrent_rows[1:]:\n cells = row('td')\n if len(cells) < len(labels):\n continue\n\n try:\n title = row.find(class_='croptorrenttext').get_text(strip=True)\n download_url = urljoin(self.url, row.find(title='Direkte download link')['href'])\n if not all([title, download_url]):\n continue\n\n seeders = try_int(cells[labels.index('Seeders')].get_text(strip=True))\n leechers = try_int(cells[labels.index('Leechers')].get_text(strip=True))\n\n # Filter unseeded torrent\n if seeders < min(self.minseed, 1):\n if mode != 'RSS':\n log.debug(\"Discarding torrent because it doesn't meet the\"\n \" minimum seeders: {0}. Seeders: {1}\",\n title, seeders)\n continue\n\n freeleech = row.find(class_='freeleech')\n if self.freeleech and not freeleech:\n continue\n\n torrent_size = cells[labels.index('St\u00f8rrelse')].contents[0]\n size = convert_size(torrent_size, units=units) or -1\n pubdate_raw = cells[labels.index('Tilf\u00f8jet')].find('span')['title']\n pubdate = parser.parse(pubdate_raw, fuzzy=True) if pubdate_raw else None\n\n item = {\n 'title': title,\n 'link': download_url,\n 'size': size,\n 'seeders': seeders,\n 'leechers': leechers,\n 'pubdate': pubdate,\n }\n if mode != 'RSS':\n log.log('Found result: {0} with {1} seeders and {2} leechers',\n title, seeders, leechers)\n\n items.append(item)\n except (AttributeError, TypeError, KeyError, ValueError, IndexError):\n log.error('Failed parsing provider. Traceback: {0!r}',\n traceback.format_exc())\n\n return items\n\n def login(self):\n \"\"\"Login method used for logging in before doing search and torrent downloads.\"\"\"\n if any(dict_from_cookiejar(self.session.cookies).values()):\n return True\n\n login_params = {\n 'username': self.username,\n 'password': self.password,\n 'keeplogged': 1,\n 'langlang': '',\n 'login': 'Login',\n }\n\n response = self.get_url(self.urls['login'], post_data=login_params, returns='response')\n if not response or not response.text:\n log.warning('Unable to connect to provider')\n self.session.cookies.clear()\n return False\n\n if '<title>Login :: Danishbits.org</title>' in response.text:\n log.warning('Invalid username or password. Check your settings')\n self.session.cookies.clear()\n return False\n\n return True\n\n\nprovider = DanishbitsProvider()\n", "path": "medusa/providers/torrent/html/danishbits.py"}], "after_files": [{"content": "# coding=utf-8\n\n\"\"\"Provider code for Danishbits.\"\"\"\n\nfrom __future__ import unicode_literals\n\nimport logging\nimport traceback\n\nfrom dateutil import parser\n\nfrom medusa import tv\nfrom medusa.bs4_parser import BS4Parser\nfrom medusa.helper.common import (\n convert_size,\n try_int,\n)\nfrom medusa.logger.adapters.style import BraceAdapter\nfrom medusa.providers.torrent.torrent_provider import TorrentProvider\n\nfrom requests.compat import urljoin\nfrom requests.utils import dict_from_cookiejar\n\nlog = BraceAdapter(logging.getLogger(__name__))\nlog.logger.addHandler(logging.NullHandler())\n\n\nclass DanishbitsProvider(TorrentProvider):\n \"\"\"Danishbits Torrent provider.\"\"\"\n\n def __init__(self):\n \"\"\"Initialize the class.\"\"\"\n super(self.__class__, self).__init__('Danishbits')\n\n # Credentials\n self.username = None\n self.password = None\n\n # URLs\n self.url = 'https://danishbits.org'\n self.urls = {\n 'login': urljoin(self.url, 'login.php'),\n 'search': urljoin(self.url, 'torrents.php'),\n }\n\n # Proper Strings\n\n # Miscellaneous Options\n self.freeleech = True\n\n # Torrent Stats\n self.minseed = 0\n self.minleech = 0\n\n # Cache\n self.cache = tv.Cache(self, min_time=10) # Only poll Danishbits every 10 minutes max\n\n def search(self, search_strings, age=0, ep_obj=None):\n \"\"\"\n Search a provider and parse the results.\n\n :param search_strings: A dict with mode (key) and the search value (value)\n :param age: Not used\n :param ep_obj: Not used\n :returns: A list of search results (structure)\n \"\"\"\n results = []\n if not self.login():\n return results\n\n # Search Params\n search_params = {\n 'action': 'newbrowse',\n 'group': 3,\n 'search': '',\n }\n\n for mode in search_strings:\n log.debug('Search mode: {0}', mode)\n\n for search_string in search_strings[mode]:\n\n if mode != 'RSS':\n log.debug('Search string: {search}',\n {'search': search_string})\n\n search_params['search'] = search_string\n response = self.get_url(self.urls['search'], params=search_params, returns='response')\n if not response or not response.text:\n log.debug('No data returned from provider')\n continue\n\n results += self.parse(response.text, mode)\n\n return results\n\n def parse(self, data, mode):\n \"\"\"\n Parse search results for items.\n\n :param data: The raw response from a search\n :param mode: The current mode used to search, e.g. RSS\n\n :return: A list of items found\n \"\"\"\n # Units\n units = ['B', 'KB', 'MB', 'GB', 'TB', 'PB']\n\n def process_column_header(td):\n result = ''\n if td.img:\n result = td.img.get('title')\n if not result:\n result = td.get_text(strip=True)\n return result\n\n items = []\n\n with BS4Parser(data, 'html5lib') as html:\n torrent_table = html.find('table', id='torrent_table')\n torrent_rows = torrent_table('tr') if torrent_table else []\n\n # Continue only if at least one release is found\n if len(torrent_rows) < 2:\n log.debug('Data returned from provider does not contain any torrents')\n return items\n\n # Literal: Navn, St\u00f8rrelse, Kommentarer, Tilf\u00f8jet, Snatches, Seeders, Leechers\n # Translation: Name, Size, Comments, Added, Snatches, Seeders, Leechers\n labels = [process_column_header(label) for label in torrent_rows[0]('td')]\n\n # Skip column headers\n for row in torrent_rows[1:]:\n cells = row('td')\n if len(cells) < len(labels):\n continue\n\n try:\n title = row.find(class_='croptorrenttext').get_text(strip=True)\n download_url = urljoin(self.url, row.find(title='Direkte download link')['href'])\n if not all([title, download_url]):\n continue\n\n seeders = try_int(cells[labels.index('Seeders')].get_text(strip=True))\n leechers = try_int(cells[labels.index('Leechers')].get_text(strip=True))\n\n # Filter unseeded torrent\n if seeders < min(self.minseed, 1):\n if mode != 'RSS':\n log.debug(\"Discarding torrent because it doesn't meet the\"\n \" minimum seeders: {0}. Seeders: {1}\",\n title, seeders)\n continue\n\n freeleech = row.find(class_='freeleech')\n if self.freeleech and not freeleech:\n continue\n\n torrent_size = cells[labels.index('St\u00f8rrelse')].contents[0]\n size = convert_size(torrent_size, units=units) or -1\n pubdate_raw = cells[labels.index('Tilf\u00f8jet')].find('span')['title']\n pubdate = parser.parse(pubdate_raw, fuzzy=True) if pubdate_raw else None\n\n item = {\n 'title': title,\n 'link': download_url,\n 'size': size,\n 'seeders': seeders,\n 'leechers': leechers,\n 'pubdate': pubdate,\n }\n if mode != 'RSS':\n log.debug('Found result: {0} with {1} seeders and {2} leechers',\n title, seeders, leechers)\n\n items.append(item)\n except (AttributeError, TypeError, KeyError, ValueError, IndexError):\n log.error('Failed parsing provider. Traceback: {0!r}',\n traceback.format_exc())\n\n return items\n\n def login(self):\n \"\"\"Login method used for logging in before doing search and torrent downloads.\"\"\"\n if any(dict_from_cookiejar(self.session.cookies).values()):\n return True\n\n login_params = {\n 'username': self.username,\n 'password': self.password,\n 'keeplogged': 1,\n 'langlang': '',\n 'login': 'Login',\n }\n\n response = self.get_url(self.urls['login'], post_data=login_params, returns='response')\n if not response or not response.text:\n log.warning('Unable to connect to provider')\n self.session.cookies.clear()\n return False\n\n if '<title>Login :: Danishbits.org</title>' in response.text:\n log.warning('Invalid username or password. Check your settings')\n self.session.cookies.clear()\n return False\n\n return True\n\n\nprovider = DanishbitsProvider()\n", "path": "medusa/providers/torrent/html/danishbits.py"}]}
| 3,027 | 183 |
gh_patches_debug_41916
|
rasdani/github-patches
|
git_diff
|
freedomofpress__securedrop-2649
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Missing translation for 'This field is required' across all languages
# Bug
## Description
When navigating to `/login` and pressing submit on an empty, the default (English) error message string is displayed.
## Steps to Reproduce
1. Click on the localized equivalent of 'Check for a response`
2. Click submit (while leaving an empty string)
3. Observe the error message.
## Expected Behavior
The error message should be displayed in the localized language.
## Actual Behavior
The message is displayed in English.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `securedrop/source_app/forms.py`
Content:
```
1 from flask_babel import gettext
2 from flask_wtf import FlaskForm
3 from wtforms import PasswordField
4 from wtforms.validators import InputRequired, Regexp, Length
5
6 from db import Source
7
8
9 class LoginForm(FlaskForm):
10 codename = PasswordField('codename', validators=[
11 InputRequired(message=gettext('This field is required.')),
12 Length(1, Source.MAX_CODENAME_LEN,
13 message=gettext('Field must be between 1 and '
14 '{max_codename_len} characters long.'.format(
15 max_codename_len=Source.MAX_CODENAME_LEN))),
16 # Make sure to allow dashes since some words in the wordlist have them
17 Regexp(r'[\sA-Za-z0-9-]+$', message=gettext('Invalid input.'))
18 ])
19
```
Path: `securedrop/journalist_app/forms.py`
Content:
```
1 # -*- coding: utf-8 -*-
2
3 from flask_babel import gettext
4 from flask_wtf import FlaskForm
5 from wtforms import (TextAreaField, TextField, BooleanField, HiddenField,
6 ValidationError)
7 from wtforms.validators import InputRequired, Optional
8
9 from db import Journalist
10
11
12 def otp_secret_validation(form, field):
13 strip_whitespace = field.data.replace(' ', '')
14 if len(strip_whitespace) != 40:
15 raise ValidationError(gettext('Field must be 40 characters long but '
16 'got {num_chars}.'.format(
17 num_chars=len(strip_whitespace)
18 )))
19
20
21 def minimum_length_validation(form, field):
22 if len(field.data) < Journalist.MIN_USERNAME_LEN:
23 raise ValidationError(
24 gettext('Field must be at least {min_chars} '
25 'characters long but only got '
26 '{num_chars}.'.format(
27 min_chars=Journalist.MIN_USERNAME_LEN,
28 num_chars=len(field.data))))
29
30
31 class NewUserForm(FlaskForm):
32 username = TextField('username', validators=[
33 InputRequired(message=gettext('This field is required.')),
34 minimum_length_validation
35 ])
36 password = HiddenField('password')
37 is_admin = BooleanField('is_admin')
38 is_hotp = BooleanField('is_hotp')
39 otp_secret = TextField('otp_secret', validators=[
40 otp_secret_validation,
41 Optional()
42 ])
43
44
45 class ReplyForm(FlaskForm):
46 message = TextAreaField(
47 u'Message',
48 id="content-area",
49 validators=[
50 InputRequired(message=gettext('You cannot send an empty reply.')),
51 ],
52 )
53
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/securedrop/journalist_app/forms.py b/securedrop/journalist_app/forms.py
--- a/securedrop/journalist_app/forms.py
+++ b/securedrop/journalist_app/forms.py
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
-from flask_babel import gettext
+from flask_babel import lazy_gettext
from flask_wtf import FlaskForm
from wtforms import (TextAreaField, TextField, BooleanField, HiddenField,
ValidationError)
@@ -12,25 +12,26 @@
def otp_secret_validation(form, field):
strip_whitespace = field.data.replace(' ', '')
if len(strip_whitespace) != 40:
- raise ValidationError(gettext('Field must be 40 characters long but '
- 'got {num_chars}.'.format(
- num_chars=len(strip_whitespace)
- )))
+ raise ValidationError(lazy_gettext(
+ 'Field must be 40 characters long but '
+ 'got {num_chars}.'.format(
+ num_chars=len(strip_whitespace)
+ )))
def minimum_length_validation(form, field):
if len(field.data) < Journalist.MIN_USERNAME_LEN:
raise ValidationError(
- gettext('Field must be at least {min_chars} '
- 'characters long but only got '
- '{num_chars}.'.format(
- min_chars=Journalist.MIN_USERNAME_LEN,
- num_chars=len(field.data))))
+ lazy_gettext('Field must be at least {min_chars} '
+ 'characters long but only got '
+ '{num_chars}.'.format(
+ min_chars=Journalist.MIN_USERNAME_LEN,
+ num_chars=len(field.data))))
class NewUserForm(FlaskForm):
username = TextField('username', validators=[
- InputRequired(message=gettext('This field is required.')),
+ InputRequired(message=lazy_gettext('This field is required.')),
minimum_length_validation
])
password = HiddenField('password')
@@ -47,6 +48,7 @@
u'Message',
id="content-area",
validators=[
- InputRequired(message=gettext('You cannot send an empty reply.')),
+ InputRequired(message=lazy_gettext(
+ 'You cannot send an empty reply.')),
],
)
diff --git a/securedrop/source_app/forms.py b/securedrop/source_app/forms.py
--- a/securedrop/source_app/forms.py
+++ b/securedrop/source_app/forms.py
@@ -1,4 +1,4 @@
-from flask_babel import gettext
+from flask_babel import lazy_gettext
from flask_wtf import FlaskForm
from wtforms import PasswordField
from wtforms.validators import InputRequired, Regexp, Length
@@ -8,11 +8,12 @@
class LoginForm(FlaskForm):
codename = PasswordField('codename', validators=[
- InputRequired(message=gettext('This field is required.')),
+ InputRequired(message=lazy_gettext('This field is required.')),
Length(1, Source.MAX_CODENAME_LEN,
- message=gettext('Field must be between 1 and '
- '{max_codename_len} characters long.'.format(
- max_codename_len=Source.MAX_CODENAME_LEN))),
+ message=lazy_gettext(
+ 'Field must be between 1 and '
+ '{max_codename_len} characters long.'.format(
+ max_codename_len=Source.MAX_CODENAME_LEN))),
# Make sure to allow dashes since some words in the wordlist have them
- Regexp(r'[\sA-Za-z0-9-]+$', message=gettext('Invalid input.'))
+ Regexp(r'[\sA-Za-z0-9-]+$', message=lazy_gettext('Invalid input.'))
])
|
{"golden_diff": "diff --git a/securedrop/journalist_app/forms.py b/securedrop/journalist_app/forms.py\n--- a/securedrop/journalist_app/forms.py\n+++ b/securedrop/journalist_app/forms.py\n@@ -1,6 +1,6 @@\n # -*- coding: utf-8 -*-\n \n-from flask_babel import gettext\n+from flask_babel import lazy_gettext\n from flask_wtf import FlaskForm\n from wtforms import (TextAreaField, TextField, BooleanField, HiddenField,\n ValidationError)\n@@ -12,25 +12,26 @@\n def otp_secret_validation(form, field):\n strip_whitespace = field.data.replace(' ', '')\n if len(strip_whitespace) != 40:\n- raise ValidationError(gettext('Field must be 40 characters long but '\n- 'got {num_chars}.'.format(\n- num_chars=len(strip_whitespace)\n- )))\n+ raise ValidationError(lazy_gettext(\n+ 'Field must be 40 characters long but '\n+ 'got {num_chars}.'.format(\n+ num_chars=len(strip_whitespace)\n+ )))\n \n \n def minimum_length_validation(form, field):\n if len(field.data) < Journalist.MIN_USERNAME_LEN:\n raise ValidationError(\n- gettext('Field must be at least {min_chars} '\n- 'characters long but only got '\n- '{num_chars}.'.format(\n- min_chars=Journalist.MIN_USERNAME_LEN,\n- num_chars=len(field.data))))\n+ lazy_gettext('Field must be at least {min_chars} '\n+ 'characters long but only got '\n+ '{num_chars}.'.format(\n+ min_chars=Journalist.MIN_USERNAME_LEN,\n+ num_chars=len(field.data))))\n \n \n class NewUserForm(FlaskForm):\n username = TextField('username', validators=[\n- InputRequired(message=gettext('This field is required.')),\n+ InputRequired(message=lazy_gettext('This field is required.')),\n minimum_length_validation\n ])\n password = HiddenField('password')\n@@ -47,6 +48,7 @@\n u'Message',\n id=\"content-area\",\n validators=[\n- InputRequired(message=gettext('You cannot send an empty reply.')),\n+ InputRequired(message=lazy_gettext(\n+ 'You cannot send an empty reply.')),\n ],\n )\ndiff --git a/securedrop/source_app/forms.py b/securedrop/source_app/forms.py\n--- a/securedrop/source_app/forms.py\n+++ b/securedrop/source_app/forms.py\n@@ -1,4 +1,4 @@\n-from flask_babel import gettext\n+from flask_babel import lazy_gettext\n from flask_wtf import FlaskForm\n from wtforms import PasswordField\n from wtforms.validators import InputRequired, Regexp, Length\n@@ -8,11 +8,12 @@\n \n class LoginForm(FlaskForm):\n codename = PasswordField('codename', validators=[\n- InputRequired(message=gettext('This field is required.')),\n+ InputRequired(message=lazy_gettext('This field is required.')),\n Length(1, Source.MAX_CODENAME_LEN,\n- message=gettext('Field must be between 1 and '\n- '{max_codename_len} characters long.'.format(\n- max_codename_len=Source.MAX_CODENAME_LEN))),\n+ message=lazy_gettext(\n+ 'Field must be between 1 and '\n+ '{max_codename_len} characters long.'.format(\n+ max_codename_len=Source.MAX_CODENAME_LEN))),\n # Make sure to allow dashes since some words in the wordlist have them\n- Regexp(r'[\\sA-Za-z0-9-]+$', message=gettext('Invalid input.'))\n+ Regexp(r'[\\sA-Za-z0-9-]+$', message=lazy_gettext('Invalid input.'))\n ])\n", "issue": "Missing translation for 'This field is required' across all languages\n# Bug\r\n\r\n## Description\r\n\r\nWhen navigating to `/login` and pressing submit on an empty, the default (English) error message string is displayed.\r\n\r\n## Steps to Reproduce\r\n\r\n1. Click on the localized equivalent of 'Check for a response`\r\n2. Click submit (while leaving an empty string)\r\n3. Observe the error message.\r\n\r\n## Expected Behavior\r\nThe error message should be displayed in the localized language.\r\n\r\n## Actual Behavior\r\n\r\nThe message is displayed in English.\n", "before_files": [{"content": "from flask_babel import gettext\nfrom flask_wtf import FlaskForm\nfrom wtforms import PasswordField\nfrom wtforms.validators import InputRequired, Regexp, Length\n\nfrom db import Source\n\n\nclass LoginForm(FlaskForm):\n codename = PasswordField('codename', validators=[\n InputRequired(message=gettext('This field is required.')),\n Length(1, Source.MAX_CODENAME_LEN,\n message=gettext('Field must be between 1 and '\n '{max_codename_len} characters long.'.format(\n max_codename_len=Source.MAX_CODENAME_LEN))),\n # Make sure to allow dashes since some words in the wordlist have them\n Regexp(r'[\\sA-Za-z0-9-]+$', message=gettext('Invalid input.'))\n ])\n", "path": "securedrop/source_app/forms.py"}, {"content": "# -*- coding: utf-8 -*-\n\nfrom flask_babel import gettext\nfrom flask_wtf import FlaskForm\nfrom wtforms import (TextAreaField, TextField, BooleanField, HiddenField,\n ValidationError)\nfrom wtforms.validators import InputRequired, Optional\n\nfrom db import Journalist\n\n\ndef otp_secret_validation(form, field):\n strip_whitespace = field.data.replace(' ', '')\n if len(strip_whitespace) != 40:\n raise ValidationError(gettext('Field must be 40 characters long but '\n 'got {num_chars}.'.format(\n num_chars=len(strip_whitespace)\n )))\n\n\ndef minimum_length_validation(form, field):\n if len(field.data) < Journalist.MIN_USERNAME_LEN:\n raise ValidationError(\n gettext('Field must be at least {min_chars} '\n 'characters long but only got '\n '{num_chars}.'.format(\n min_chars=Journalist.MIN_USERNAME_LEN,\n num_chars=len(field.data))))\n\n\nclass NewUserForm(FlaskForm):\n username = TextField('username', validators=[\n InputRequired(message=gettext('This field is required.')),\n minimum_length_validation\n ])\n password = HiddenField('password')\n is_admin = BooleanField('is_admin')\n is_hotp = BooleanField('is_hotp')\n otp_secret = TextField('otp_secret', validators=[\n otp_secret_validation,\n Optional()\n ])\n\n\nclass ReplyForm(FlaskForm):\n message = TextAreaField(\n u'Message',\n id=\"content-area\",\n validators=[\n InputRequired(message=gettext('You cannot send an empty reply.')),\n ],\n )\n", "path": "securedrop/journalist_app/forms.py"}], "after_files": [{"content": "from flask_babel import lazy_gettext\nfrom flask_wtf import FlaskForm\nfrom wtforms import PasswordField\nfrom wtforms.validators import InputRequired, Regexp, Length\n\nfrom db import Source\n\n\nclass LoginForm(FlaskForm):\n codename = PasswordField('codename', validators=[\n InputRequired(message=lazy_gettext('This field is required.')),\n Length(1, Source.MAX_CODENAME_LEN,\n message=lazy_gettext(\n 'Field must be between 1 and '\n '{max_codename_len} characters long.'.format(\n max_codename_len=Source.MAX_CODENAME_LEN))),\n # Make sure to allow dashes since some words in the wordlist have them\n Regexp(r'[\\sA-Za-z0-9-]+$', message=lazy_gettext('Invalid input.'))\n ])\n", "path": "securedrop/source_app/forms.py"}, {"content": "# -*- coding: utf-8 -*-\n\nfrom flask_babel import lazy_gettext\nfrom flask_wtf import FlaskForm\nfrom wtforms import (TextAreaField, TextField, BooleanField, HiddenField,\n ValidationError)\nfrom wtforms.validators import InputRequired, Optional\n\nfrom db import Journalist\n\n\ndef otp_secret_validation(form, field):\n strip_whitespace = field.data.replace(' ', '')\n if len(strip_whitespace) != 40:\n raise ValidationError(lazy_gettext(\n 'Field must be 40 characters long but '\n 'got {num_chars}.'.format(\n num_chars=len(strip_whitespace)\n )))\n\n\ndef minimum_length_validation(form, field):\n if len(field.data) < Journalist.MIN_USERNAME_LEN:\n raise ValidationError(\n lazy_gettext('Field must be at least {min_chars} '\n 'characters long but only got '\n '{num_chars}.'.format(\n min_chars=Journalist.MIN_USERNAME_LEN,\n num_chars=len(field.data))))\n\n\nclass NewUserForm(FlaskForm):\n username = TextField('username', validators=[\n InputRequired(message=lazy_gettext('This field is required.')),\n minimum_length_validation\n ])\n password = HiddenField('password')\n is_admin = BooleanField('is_admin')\n is_hotp = BooleanField('is_hotp')\n otp_secret = TextField('otp_secret', validators=[\n otp_secret_validation,\n Optional()\n ])\n\n\nclass ReplyForm(FlaskForm):\n message = TextAreaField(\n u'Message',\n id=\"content-area\",\n validators=[\n InputRequired(message=lazy_gettext(\n 'You cannot send an empty reply.')),\n ],\n )\n", "path": "securedrop/journalist_app/forms.py"}]}
| 1,016 | 822 |
gh_patches_debug_19209
|
rasdani/github-patches
|
git_diff
|
freedomofpress__securedrop-4309
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
On the Admin Workstation, N SecureDrop updater processes are started if N network interfaces are enabled in Tails
## Description
If a Tails Admin Workstation has more than one network interface, the SecureDrop network manager hook that checks for updates will run for each active NIC. (For example, if a workstation has both Ethernet and Wifi enabled.)
This is confusing to end users and may result in multiple update processes clobbering each other's changes.
## Steps to Reproduce
On an Admin Workstation:
- revert to an earlier SecureDrop version:
```
cd ~/Persistent/securedrop
git checkout 0.10.0
```
- enable multiple network connections (eg Ethernet and Wifi) and wait for their Tor connections to come up
## Expected Behavior
A single instance of the Securedrop Updater is started.
## Actual Behavior
Multiple instances of the SecureDrop Updater are started.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `journalist_gui/journalist_gui/SecureDropUpdater.py`
Content:
```
1 #!/usr/bin/python
2 from PyQt5 import QtGui, QtWidgets
3 from PyQt5.QtCore import QThread, pyqtSignal
4 import subprocess
5 import os
6 import re
7 import pexpect
8
9 from journalist_gui import updaterUI, strings, resources_rc # noqa
10
11
12 FLAG_LOCATION = "/home/amnesia/Persistent/.securedrop/securedrop_update.flag" # noqa
13 ESCAPE_POD = re.compile(r'\x1B\[[0-?]*[ -/]*[@-~]')
14
15
16 class SetupThread(QThread):
17 signal = pyqtSignal('PyQt_PyObject')
18
19 def __init__(self):
20 QThread.__init__(self)
21 self.output = ""
22 self.update_success = False
23 self.failure_reason = ""
24
25 def run(self):
26 sdadmin_path = '/home/amnesia/Persistent/securedrop/securedrop-admin'
27 update_command = [sdadmin_path, 'setup']
28
29 # Create flag file to indicate we should resume failed updates on
30 # reboot. Don't create the flag if it already exists.
31 if not os.path.exists(FLAG_LOCATION):
32 open(FLAG_LOCATION, 'a').close()
33
34 try:
35 self.output = subprocess.check_output(
36 update_command,
37 stderr=subprocess.STDOUT).decode('utf-8')
38 if 'Failed to install' in self.output:
39 self.update_success = False
40 self.failure_reason = strings.update_failed_generic_reason
41 else:
42 self.update_success = True
43 except subprocess.CalledProcessError as e:
44 self.output += e.output.decode('utf-8')
45 self.update_success = False
46 self.failure_reason = strings.update_failed_generic_reason
47 result = {'status': self.update_success,
48 'output': self.output,
49 'failure_reason': self.failure_reason}
50 self.signal.emit(result)
51
52
53 # This thread will handle the ./securedrop-admin update command
54 class UpdateThread(QThread):
55 signal = pyqtSignal('PyQt_PyObject')
56
57 def __init__(self):
58 QThread.__init__(self)
59 self.output = ""
60 self.update_success = False
61 self.failure_reason = ""
62
63 def run(self):
64 sdadmin_path = '/home/amnesia/Persistent/securedrop/securedrop-admin'
65 update_command = [sdadmin_path, 'update']
66 try:
67 self.output = subprocess.check_output(
68 update_command,
69 stderr=subprocess.STDOUT).decode('utf-8')
70 if "Signature verification successful" in self.output:
71 self.update_success = True
72 else:
73 self.failure_reason = strings.update_failed_generic_reason
74 except subprocess.CalledProcessError as e:
75 self.update_success = False
76 self.output += e.output.decode('utf-8')
77 if 'Signature verification failed' in self.output:
78 self.failure_reason = strings.update_failed_sig_failure
79 else:
80 self.failure_reason = strings.update_failed_generic_reason
81 result = {'status': self.update_success,
82 'output': self.output,
83 'failure_reason': self.failure_reason}
84 self.signal.emit(result)
85
86
87 # This thread will handle the ./securedrop-admin tailsconfig command
88 class TailsconfigThread(QThread):
89 signal = pyqtSignal('PyQt_PyObject')
90
91 def __init__(self):
92 QThread.__init__(self)
93 self.output = ""
94 self.update_success = False
95 self.failure_reason = ""
96 self.sudo_password = ""
97
98 def run(self):
99 tailsconfig_command = ("/home/amnesia/Persistent/"
100 "securedrop/securedrop-admin "
101 "tailsconfig")
102 try:
103 child = pexpect.spawn(tailsconfig_command)
104 child.expect('SUDO password:')
105 self.output += child.before.decode('utf-8')
106 child.sendline(self.sudo_password)
107 child.expect(pexpect.EOF)
108 self.output += child.before.decode('utf-8')
109 child.close()
110
111 # For Tailsconfig to be considered a success, we expect no
112 # failures in the Ansible output.
113 if child.exitstatus:
114 self.update_success = False
115 self.failure_reason = strings.tailsconfig_failed_generic_reason # noqa
116 else:
117 self.update_success = True
118 except pexpect.exceptions.TIMEOUT:
119 self.update_success = False
120 self.failure_reason = strings.tailsconfig_failed_sudo_password
121
122 except subprocess.CalledProcessError:
123 self.update_success = False
124 self.failure_reason = strings.tailsconfig_failed_generic_reason
125 result = {'status': self.update_success,
126 'output': ESCAPE_POD.sub('', self.output),
127 'failure_reason': self.failure_reason}
128 self.signal.emit(result)
129
130
131 class UpdaterApp(QtWidgets.QMainWindow, updaterUI.Ui_MainWindow):
132
133 def __init__(self, parent=None):
134 super(UpdaterApp, self).__init__(parent)
135 self.setupUi(self)
136 self.statusbar.setSizeGripEnabled(False)
137 self.output = strings.initial_text_box
138 self.plainTextEdit.setPlainText(self.output)
139 self.update_success = False
140
141 pixmap = QtGui.QPixmap(":/images/static/banner.png")
142 self.label_2.setPixmap(pixmap)
143 self.label_2.setScaledContents(True)
144
145 self.progressBar.setProperty("value", 0)
146 self.setWindowTitle(strings.window_title)
147 self.setWindowIcon(QtGui.QIcon(':/images/static/securedrop_icon.png'))
148 self.label.setText(strings.update_in_progress)
149
150 self.tabWidget.setTabText(self.tabWidget.indexOf(self.tab),
151 strings.main_tab)
152 self.tabWidget.setTabText(self.tabWidget.indexOf(self.tab_2),
153 strings.output_tab)
154
155 # Connect buttons to their functions.
156 self.pushButton.setText(strings.install_later_button)
157 self.pushButton.setStyleSheet("""background-color: lightgrey;
158 min-height: 2em;
159 border-radius: 10px""")
160 self.pushButton.clicked.connect(self.close)
161 self.pushButton_2.setText(strings.install_update_button)
162 self.pushButton_2.setStyleSheet("""background-color: #E6FFEB;
163 min-height: 2em;
164 border-radius: 10px;""")
165 self.pushButton_2.clicked.connect(self.update_securedrop)
166 self.update_thread = UpdateThread()
167 self.update_thread.signal.connect(self.update_status)
168 self.tails_thread = TailsconfigThread()
169 self.tails_thread.signal.connect(self.tails_status)
170 self.setup_thread = SetupThread()
171 self.setup_thread.signal.connect(self.setup_status)
172
173 # At the end of this function, we will try to do tailsconfig.
174 # A new slot will handle tailsconfig output
175 def setup_status(self, result):
176 "This is the slot for setup thread"
177 self.output += result['output']
178 self.update_success = result['status']
179 self.failure_reason = result['failure_reason']
180 self.progressBar.setProperty("value", 60)
181 self.plainTextEdit.setPlainText(self.output)
182 self.plainTextEdit.setReadOnly = True
183 if not self.update_success: # Failed to do setup
184 self.pushButton.setEnabled(True)
185 self.pushButton_2.setEnabled(True)
186 self.update_status_bar_and_output(self.failure_reason)
187 self.progressBar.setProperty("value", 0)
188 self.alert_failure(self.failure_reason)
189 return
190 self.progressBar.setProperty("value", 70)
191 self.call_tailsconfig()
192
193 # This will update the output text after the git commands.
194 def update_status(self, result):
195 "This is the slot for update thread"
196 self.output += result['output']
197 self.update_success = result['status']
198 self.failure_reason = result['failure_reason']
199 self.progressBar.setProperty("value", 40)
200 self.plainTextEdit.setPlainText(self.output)
201 self.plainTextEdit.setReadOnly = True
202 if not self.update_success: # Failed to do update
203 self.pushButton.setEnabled(True)
204 self.pushButton_2.setEnabled(True)
205 self.update_status_bar_and_output(self.failure_reason)
206 self.progressBar.setProperty("value", 0)
207 self.alert_failure(self.failure_reason)
208 return
209 self.progressBar.setProperty("value", 50)
210 self.update_status_bar_and_output(strings.doing_setup)
211 self.setup_thread.start()
212
213 def update_status_bar_and_output(self, status_message):
214 """This method updates the status bar and the output window with the
215 status_message."""
216 self.statusbar.showMessage(status_message)
217 self.output += status_message + '\n'
218 self.plainTextEdit.setPlainText(self.output)
219
220 def call_tailsconfig(self):
221 # Now let us work on tailsconfig part
222 if self.update_success:
223 # Get sudo password and add an enter key as tailsconfig command
224 # expects
225 sudo_password = self.get_sudo_password()
226 if not sudo_password:
227 self.update_success = False
228 self.failure_reason = strings.missing_sudo_password
229 self.on_failure()
230 return
231 self.tails_thread.sudo_password = sudo_password + '\n'
232 self.update_status_bar_and_output(strings.updating_tails_env)
233 self.tails_thread.start()
234 else:
235 self.on_failure()
236
237 def tails_status(self, result):
238 "This is the slot for Tailsconfig thread"
239 self.output += result['output']
240 self.update_success = result['status']
241 self.failure_reason = result['failure_reason']
242 self.plainTextEdit.setPlainText(self.output)
243 self.progressBar.setProperty("value", 80)
244 if self.update_success:
245 # Remove flag file indicating an update is in progress
246 os.remove(FLAG_LOCATION)
247 self.update_status_bar_and_output(strings.finished)
248 self.progressBar.setProperty("value", 100)
249 self.alert_success()
250 else:
251 self.on_failure()
252
253 def on_failure(self):
254 self.update_status_bar_and_output(self.failure_reason)
255 self.alert_failure(self.failure_reason)
256 # Now everything is done, enable the button.
257 self.pushButton.setEnabled(True)
258 self.pushButton_2.setEnabled(True)
259 self.progressBar.setProperty("value", 0)
260
261 def update_securedrop(self):
262 self.pushButton_2.setEnabled(False)
263 self.pushButton.setEnabled(False)
264 self.progressBar.setProperty("value", 10)
265 self.update_status_bar_and_output(strings.fetching_update)
266 self.update_thread.start()
267
268 def alert_success(self):
269 self.success_dialog = QtWidgets.QMessageBox()
270 self.success_dialog.setIcon(QtWidgets.QMessageBox.Information)
271 self.success_dialog.setText(strings.finished_dialog_message)
272 self.success_dialog.setWindowTitle(strings.finished_dialog_title)
273 self.success_dialog.show()
274
275 def alert_failure(self, failure_reason):
276 self.error_dialog = QtWidgets.QMessageBox()
277 self.error_dialog.setIcon(QtWidgets.QMessageBox.Critical)
278 self.error_dialog.setText(self.failure_reason)
279 self.error_dialog.setWindowTitle(strings.update_failed_dialog_title)
280 self.error_dialog.show()
281
282 def get_sudo_password(self):
283 sudo_password, ok_is_pressed = QtWidgets.QInputDialog.getText(
284 self, "Tails Administrator password", strings.sudo_password_text,
285 QtWidgets.QLineEdit.Password, "")
286 if ok_is_pressed and sudo_password:
287 return sudo_password
288 else:
289 return None
290
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/journalist_gui/journalist_gui/SecureDropUpdater.py b/journalist_gui/journalist_gui/SecureDropUpdater.py
--- a/journalist_gui/journalist_gui/SecureDropUpdater.py
+++ b/journalist_gui/journalist_gui/SecureDropUpdater.py
@@ -5,6 +5,8 @@
import os
import re
import pexpect
+import socket
+import sys
from journalist_gui import updaterUI, strings, resources_rc # noqa
@@ -13,6 +15,25 @@
ESCAPE_POD = re.compile(r'\x1B\[[0-?]*[ -/]*[@-~]')
+def prevent_second_instance(app: QtWidgets.QApplication, name: str) -> None: # noqa
+
+ # Null byte triggers abstract namespace
+ IDENTIFIER = '\0' + name
+ ALREADY_BOUND_ERRNO = 98
+
+ app.instance_binding = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
+ try:
+ app.instance_binding.bind(IDENTIFIER)
+ except OSError as e:
+ if e.errno == ALREADY_BOUND_ERRNO:
+ err_dialog = QtWidgets.QMessageBox()
+ err_dialog.setText(name + ' is already running.')
+ err_dialog.exec()
+ sys.exit()
+ else:
+ raise
+
+
class SetupThread(QThread):
signal = pyqtSignal('PyQt_PyObject')
|
{"golden_diff": "diff --git a/journalist_gui/journalist_gui/SecureDropUpdater.py b/journalist_gui/journalist_gui/SecureDropUpdater.py\n--- a/journalist_gui/journalist_gui/SecureDropUpdater.py\n+++ b/journalist_gui/journalist_gui/SecureDropUpdater.py\n@@ -5,6 +5,8 @@\n import os\n import re\n import pexpect\n+import socket\n+import sys\n \n from journalist_gui import updaterUI, strings, resources_rc # noqa\n \n@@ -13,6 +15,25 @@\n ESCAPE_POD = re.compile(r'\\x1B\\[[0-?]*[ -/]*[@-~]')\n \n \n+def prevent_second_instance(app: QtWidgets.QApplication, name: str) -> None: # noqa\n+\n+ # Null byte triggers abstract namespace\n+ IDENTIFIER = '\\0' + name\n+ ALREADY_BOUND_ERRNO = 98\n+\n+ app.instance_binding = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)\n+ try:\n+ app.instance_binding.bind(IDENTIFIER)\n+ except OSError as e:\n+ if e.errno == ALREADY_BOUND_ERRNO:\n+ err_dialog = QtWidgets.QMessageBox()\n+ err_dialog.setText(name + ' is already running.')\n+ err_dialog.exec()\n+ sys.exit()\n+ else:\n+ raise\n+\n+\n class SetupThread(QThread):\n signal = pyqtSignal('PyQt_PyObject')\n", "issue": "On the Admin Workstation, N SecureDrop updater processes are started if N network interfaces are enabled in Tails\n## Description\r\n\r\nIf a Tails Admin Workstation has more than one network interface, the SecureDrop network manager hook that checks for updates will run for each active NIC. (For example, if a workstation has both Ethernet and Wifi enabled.)\r\n\r\nThis is confusing to end users and may result in multiple update processes clobbering each other's changes.\r\n\r\n## Steps to Reproduce\r\n\r\nOn an Admin Workstation:\r\n- revert to an earlier SecureDrop version:\r\n```\r\ncd ~/Persistent/securedrop\r\ngit checkout 0.10.0\r\n```\r\n- enable multiple network connections (eg Ethernet and Wifi) and wait for their Tor connections to come up\r\n\r\n## Expected Behavior\r\nA single instance of the Securedrop Updater is started.\r\n\r\n## Actual Behavior\r\nMultiple instances of the SecureDrop Updater are started.\r\n\n", "before_files": [{"content": "#!/usr/bin/python\nfrom PyQt5 import QtGui, QtWidgets\nfrom PyQt5.QtCore import QThread, pyqtSignal\nimport subprocess\nimport os\nimport re\nimport pexpect\n\nfrom journalist_gui import updaterUI, strings, resources_rc # noqa\n\n\nFLAG_LOCATION = \"/home/amnesia/Persistent/.securedrop/securedrop_update.flag\" # noqa\nESCAPE_POD = re.compile(r'\\x1B\\[[0-?]*[ -/]*[@-~]')\n\n\nclass SetupThread(QThread):\n signal = pyqtSignal('PyQt_PyObject')\n\n def __init__(self):\n QThread.__init__(self)\n self.output = \"\"\n self.update_success = False\n self.failure_reason = \"\"\n\n def run(self):\n sdadmin_path = '/home/amnesia/Persistent/securedrop/securedrop-admin'\n update_command = [sdadmin_path, 'setup']\n\n # Create flag file to indicate we should resume failed updates on\n # reboot. Don't create the flag if it already exists.\n if not os.path.exists(FLAG_LOCATION):\n open(FLAG_LOCATION, 'a').close()\n\n try:\n self.output = subprocess.check_output(\n update_command,\n stderr=subprocess.STDOUT).decode('utf-8')\n if 'Failed to install' in self.output:\n self.update_success = False\n self.failure_reason = strings.update_failed_generic_reason\n else:\n self.update_success = True\n except subprocess.CalledProcessError as e:\n self.output += e.output.decode('utf-8')\n self.update_success = False\n self.failure_reason = strings.update_failed_generic_reason\n result = {'status': self.update_success,\n 'output': self.output,\n 'failure_reason': self.failure_reason}\n self.signal.emit(result)\n\n\n# This thread will handle the ./securedrop-admin update command\nclass UpdateThread(QThread):\n signal = pyqtSignal('PyQt_PyObject')\n\n def __init__(self):\n QThread.__init__(self)\n self.output = \"\"\n self.update_success = False\n self.failure_reason = \"\"\n\n def run(self):\n sdadmin_path = '/home/amnesia/Persistent/securedrop/securedrop-admin'\n update_command = [sdadmin_path, 'update']\n try:\n self.output = subprocess.check_output(\n update_command,\n stderr=subprocess.STDOUT).decode('utf-8')\n if \"Signature verification successful\" in self.output:\n self.update_success = True\n else:\n self.failure_reason = strings.update_failed_generic_reason\n except subprocess.CalledProcessError as e:\n self.update_success = False\n self.output += e.output.decode('utf-8')\n if 'Signature verification failed' in self.output:\n self.failure_reason = strings.update_failed_sig_failure\n else:\n self.failure_reason = strings.update_failed_generic_reason\n result = {'status': self.update_success,\n 'output': self.output,\n 'failure_reason': self.failure_reason}\n self.signal.emit(result)\n\n\n# This thread will handle the ./securedrop-admin tailsconfig command\nclass TailsconfigThread(QThread):\n signal = pyqtSignal('PyQt_PyObject')\n\n def __init__(self):\n QThread.__init__(self)\n self.output = \"\"\n self.update_success = False\n self.failure_reason = \"\"\n self.sudo_password = \"\"\n\n def run(self):\n tailsconfig_command = (\"/home/amnesia/Persistent/\"\n \"securedrop/securedrop-admin \"\n \"tailsconfig\")\n try:\n child = pexpect.spawn(tailsconfig_command)\n child.expect('SUDO password:')\n self.output += child.before.decode('utf-8')\n child.sendline(self.sudo_password)\n child.expect(pexpect.EOF)\n self.output += child.before.decode('utf-8')\n child.close()\n\n # For Tailsconfig to be considered a success, we expect no\n # failures in the Ansible output.\n if child.exitstatus:\n self.update_success = False\n self.failure_reason = strings.tailsconfig_failed_generic_reason # noqa\n else:\n self.update_success = True\n except pexpect.exceptions.TIMEOUT:\n self.update_success = False\n self.failure_reason = strings.tailsconfig_failed_sudo_password\n\n except subprocess.CalledProcessError:\n self.update_success = False\n self.failure_reason = strings.tailsconfig_failed_generic_reason\n result = {'status': self.update_success,\n 'output': ESCAPE_POD.sub('', self.output),\n 'failure_reason': self.failure_reason}\n self.signal.emit(result)\n\n\nclass UpdaterApp(QtWidgets.QMainWindow, updaterUI.Ui_MainWindow):\n\n def __init__(self, parent=None):\n super(UpdaterApp, self).__init__(parent)\n self.setupUi(self)\n self.statusbar.setSizeGripEnabled(False)\n self.output = strings.initial_text_box\n self.plainTextEdit.setPlainText(self.output)\n self.update_success = False\n\n pixmap = QtGui.QPixmap(\":/images/static/banner.png\")\n self.label_2.setPixmap(pixmap)\n self.label_2.setScaledContents(True)\n\n self.progressBar.setProperty(\"value\", 0)\n self.setWindowTitle(strings.window_title)\n self.setWindowIcon(QtGui.QIcon(':/images/static/securedrop_icon.png'))\n self.label.setText(strings.update_in_progress)\n\n self.tabWidget.setTabText(self.tabWidget.indexOf(self.tab),\n strings.main_tab)\n self.tabWidget.setTabText(self.tabWidget.indexOf(self.tab_2),\n strings.output_tab)\n\n # Connect buttons to their functions.\n self.pushButton.setText(strings.install_later_button)\n self.pushButton.setStyleSheet(\"\"\"background-color: lightgrey;\n min-height: 2em;\n border-radius: 10px\"\"\")\n self.pushButton.clicked.connect(self.close)\n self.pushButton_2.setText(strings.install_update_button)\n self.pushButton_2.setStyleSheet(\"\"\"background-color: #E6FFEB;\n min-height: 2em;\n border-radius: 10px;\"\"\")\n self.pushButton_2.clicked.connect(self.update_securedrop)\n self.update_thread = UpdateThread()\n self.update_thread.signal.connect(self.update_status)\n self.tails_thread = TailsconfigThread()\n self.tails_thread.signal.connect(self.tails_status)\n self.setup_thread = SetupThread()\n self.setup_thread.signal.connect(self.setup_status)\n\n # At the end of this function, we will try to do tailsconfig.\n # A new slot will handle tailsconfig output\n def setup_status(self, result):\n \"This is the slot for setup thread\"\n self.output += result['output']\n self.update_success = result['status']\n self.failure_reason = result['failure_reason']\n self.progressBar.setProperty(\"value\", 60)\n self.plainTextEdit.setPlainText(self.output)\n self.plainTextEdit.setReadOnly = True\n if not self.update_success: # Failed to do setup\n self.pushButton.setEnabled(True)\n self.pushButton_2.setEnabled(True)\n self.update_status_bar_and_output(self.failure_reason)\n self.progressBar.setProperty(\"value\", 0)\n self.alert_failure(self.failure_reason)\n return\n self.progressBar.setProperty(\"value\", 70)\n self.call_tailsconfig()\n\n # This will update the output text after the git commands.\n def update_status(self, result):\n \"This is the slot for update thread\"\n self.output += result['output']\n self.update_success = result['status']\n self.failure_reason = result['failure_reason']\n self.progressBar.setProperty(\"value\", 40)\n self.plainTextEdit.setPlainText(self.output)\n self.plainTextEdit.setReadOnly = True\n if not self.update_success: # Failed to do update\n self.pushButton.setEnabled(True)\n self.pushButton_2.setEnabled(True)\n self.update_status_bar_and_output(self.failure_reason)\n self.progressBar.setProperty(\"value\", 0)\n self.alert_failure(self.failure_reason)\n return\n self.progressBar.setProperty(\"value\", 50)\n self.update_status_bar_and_output(strings.doing_setup)\n self.setup_thread.start()\n\n def update_status_bar_and_output(self, status_message):\n \"\"\"This method updates the status bar and the output window with the\n status_message.\"\"\"\n self.statusbar.showMessage(status_message)\n self.output += status_message + '\\n'\n self.plainTextEdit.setPlainText(self.output)\n\n def call_tailsconfig(self):\n # Now let us work on tailsconfig part\n if self.update_success:\n # Get sudo password and add an enter key as tailsconfig command\n # expects\n sudo_password = self.get_sudo_password()\n if not sudo_password:\n self.update_success = False\n self.failure_reason = strings.missing_sudo_password\n self.on_failure()\n return\n self.tails_thread.sudo_password = sudo_password + '\\n'\n self.update_status_bar_and_output(strings.updating_tails_env)\n self.tails_thread.start()\n else:\n self.on_failure()\n\n def tails_status(self, result):\n \"This is the slot for Tailsconfig thread\"\n self.output += result['output']\n self.update_success = result['status']\n self.failure_reason = result['failure_reason']\n self.plainTextEdit.setPlainText(self.output)\n self.progressBar.setProperty(\"value\", 80)\n if self.update_success:\n # Remove flag file indicating an update is in progress\n os.remove(FLAG_LOCATION)\n self.update_status_bar_and_output(strings.finished)\n self.progressBar.setProperty(\"value\", 100)\n self.alert_success()\n else:\n self.on_failure()\n\n def on_failure(self):\n self.update_status_bar_and_output(self.failure_reason)\n self.alert_failure(self.failure_reason)\n # Now everything is done, enable the button.\n self.pushButton.setEnabled(True)\n self.pushButton_2.setEnabled(True)\n self.progressBar.setProperty(\"value\", 0)\n\n def update_securedrop(self):\n self.pushButton_2.setEnabled(False)\n self.pushButton.setEnabled(False)\n self.progressBar.setProperty(\"value\", 10)\n self.update_status_bar_and_output(strings.fetching_update)\n self.update_thread.start()\n\n def alert_success(self):\n self.success_dialog = QtWidgets.QMessageBox()\n self.success_dialog.setIcon(QtWidgets.QMessageBox.Information)\n self.success_dialog.setText(strings.finished_dialog_message)\n self.success_dialog.setWindowTitle(strings.finished_dialog_title)\n self.success_dialog.show()\n\n def alert_failure(self, failure_reason):\n self.error_dialog = QtWidgets.QMessageBox()\n self.error_dialog.setIcon(QtWidgets.QMessageBox.Critical)\n self.error_dialog.setText(self.failure_reason)\n self.error_dialog.setWindowTitle(strings.update_failed_dialog_title)\n self.error_dialog.show()\n\n def get_sudo_password(self):\n sudo_password, ok_is_pressed = QtWidgets.QInputDialog.getText(\n self, \"Tails Administrator password\", strings.sudo_password_text,\n QtWidgets.QLineEdit.Password, \"\")\n if ok_is_pressed and sudo_password:\n return sudo_password\n else:\n return None\n", "path": "journalist_gui/journalist_gui/SecureDropUpdater.py"}], "after_files": [{"content": "#!/usr/bin/python\nfrom PyQt5 import QtGui, QtWidgets\nfrom PyQt5.QtCore import QThread, pyqtSignal\nimport subprocess\nimport os\nimport re\nimport pexpect\nimport socket\nimport sys\n\nfrom journalist_gui import updaterUI, strings, resources_rc # noqa\n\n\nFLAG_LOCATION = \"/home/amnesia/Persistent/.securedrop/securedrop_update.flag\" # noqa\nESCAPE_POD = re.compile(r'\\x1B\\[[0-?]*[ -/]*[@-~]')\n\n\ndef prevent_second_instance(app: QtWidgets.QApplication, name: str) -> None: # noqa\n\n # Null byte triggers abstract namespace\n IDENTIFIER = '\\0' + name\n ALREADY_BOUND_ERRNO = 98\n\n app.instance_binding = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)\n try:\n app.instance_binding.bind(IDENTIFIER)\n except OSError as e:\n if e.errno == ALREADY_BOUND_ERRNO:\n err_dialog = QtWidgets.QMessageBox()\n err_dialog.setText(name + ' is already running.')\n err_dialog.exec()\n sys.exit()\n else:\n raise\n\n\nclass SetupThread(QThread):\n signal = pyqtSignal('PyQt_PyObject')\n\n def __init__(self):\n QThread.__init__(self)\n self.output = \"\"\n self.update_success = False\n self.failure_reason = \"\"\n\n def run(self):\n sdadmin_path = '/home/amnesia/Persistent/securedrop/securedrop-admin'\n update_command = [sdadmin_path, 'setup']\n\n # Create flag file to indicate we should resume failed updates on\n # reboot. Don't create the flag if it already exists.\n if not os.path.exists(FLAG_LOCATION):\n open(FLAG_LOCATION, 'a').close()\n\n try:\n self.output = subprocess.check_output(\n update_command,\n stderr=subprocess.STDOUT).decode('utf-8')\n if 'Failed to install' in self.output:\n self.update_success = False\n self.failure_reason = strings.update_failed_generic_reason\n else:\n self.update_success = True\n except subprocess.CalledProcessError as e:\n self.output += e.output.decode('utf-8')\n self.update_success = False\n self.failure_reason = strings.update_failed_generic_reason\n result = {'status': self.update_success,\n 'output': self.output,\n 'failure_reason': self.failure_reason}\n self.signal.emit(result)\n\n\n# This thread will handle the ./securedrop-admin update command\nclass UpdateThread(QThread):\n signal = pyqtSignal('PyQt_PyObject')\n\n def __init__(self):\n QThread.__init__(self)\n self.output = \"\"\n self.update_success = False\n self.failure_reason = \"\"\n\n def run(self):\n sdadmin_path = '/home/amnesia/Persistent/securedrop/securedrop-admin'\n update_command = [sdadmin_path, 'update']\n try:\n self.output = subprocess.check_output(\n update_command,\n stderr=subprocess.STDOUT).decode('utf-8')\n if \"Signature verification successful\" in self.output:\n self.update_success = True\n else:\n self.failure_reason = strings.update_failed_generic_reason\n except subprocess.CalledProcessError as e:\n self.update_success = False\n self.output += e.output.decode('utf-8')\n if 'Signature verification failed' in self.output:\n self.failure_reason = strings.update_failed_sig_failure\n else:\n self.failure_reason = strings.update_failed_generic_reason\n result = {'status': self.update_success,\n 'output': self.output,\n 'failure_reason': self.failure_reason}\n self.signal.emit(result)\n\n\n# This thread will handle the ./securedrop-admin tailsconfig command\nclass TailsconfigThread(QThread):\n signal = pyqtSignal('PyQt_PyObject')\n\n def __init__(self):\n QThread.__init__(self)\n self.output = \"\"\n self.update_success = False\n self.failure_reason = \"\"\n self.sudo_password = \"\"\n\n def run(self):\n tailsconfig_command = (\"/home/amnesia/Persistent/\"\n \"securedrop/securedrop-admin \"\n \"tailsconfig\")\n try:\n child = pexpect.spawn(tailsconfig_command)\n child.expect('SUDO password:')\n self.output += child.before.decode('utf-8')\n child.sendline(self.sudo_password)\n child.expect(pexpect.EOF)\n self.output += child.before.decode('utf-8')\n child.close()\n\n # For Tailsconfig to be considered a success, we expect no\n # failures in the Ansible output.\n if child.exitstatus:\n self.update_success = False\n self.failure_reason = strings.tailsconfig_failed_generic_reason # noqa\n else:\n self.update_success = True\n except pexpect.exceptions.TIMEOUT:\n self.update_success = False\n self.failure_reason = strings.tailsconfig_failed_sudo_password\n\n except subprocess.CalledProcessError:\n self.update_success = False\n self.failure_reason = strings.tailsconfig_failed_generic_reason\n result = {'status': self.update_success,\n 'output': ESCAPE_POD.sub('', self.output),\n 'failure_reason': self.failure_reason}\n self.signal.emit(result)\n\n\nclass UpdaterApp(QtWidgets.QMainWindow, updaterUI.Ui_MainWindow):\n\n def __init__(self, parent=None):\n super(UpdaterApp, self).__init__(parent)\n self.setupUi(self)\n self.statusbar.setSizeGripEnabled(False)\n self.output = strings.initial_text_box\n self.plainTextEdit.setPlainText(self.output)\n self.update_success = False\n\n pixmap = QtGui.QPixmap(\":/images/static/banner.png\")\n self.label_2.setPixmap(pixmap)\n self.label_2.setScaledContents(True)\n\n self.progressBar.setProperty(\"value\", 0)\n self.setWindowTitle(strings.window_title)\n self.setWindowIcon(QtGui.QIcon(':/images/static/securedrop_icon.png'))\n self.label.setText(strings.update_in_progress)\n\n self.tabWidget.setTabText(self.tabWidget.indexOf(self.tab),\n strings.main_tab)\n self.tabWidget.setTabText(self.tabWidget.indexOf(self.tab_2),\n strings.output_tab)\n\n # Connect buttons to their functions.\n self.pushButton.setText(strings.install_later_button)\n self.pushButton.setStyleSheet(\"\"\"background-color: lightgrey;\n min-height: 2em;\n border-radius: 10px\"\"\")\n self.pushButton.clicked.connect(self.close)\n self.pushButton_2.setText(strings.install_update_button)\n self.pushButton_2.setStyleSheet(\"\"\"background-color: #E6FFEB;\n min-height: 2em;\n border-radius: 10px;\"\"\")\n self.pushButton_2.clicked.connect(self.update_securedrop)\n self.update_thread = UpdateThread()\n self.update_thread.signal.connect(self.update_status)\n self.tails_thread = TailsconfigThread()\n self.tails_thread.signal.connect(self.tails_status)\n self.setup_thread = SetupThread()\n self.setup_thread.signal.connect(self.setup_status)\n\n # At the end of this function, we will try to do tailsconfig.\n # A new slot will handle tailsconfig output\n def setup_status(self, result):\n \"This is the slot for setup thread\"\n self.output += result['output']\n self.update_success = result['status']\n self.failure_reason = result['failure_reason']\n self.progressBar.setProperty(\"value\", 60)\n self.plainTextEdit.setPlainText(self.output)\n self.plainTextEdit.setReadOnly = True\n if not self.update_success: # Failed to do setup\n self.pushButton.setEnabled(True)\n self.pushButton_2.setEnabled(True)\n self.update_status_bar_and_output(self.failure_reason)\n self.progressBar.setProperty(\"value\", 0)\n self.alert_failure(self.failure_reason)\n return\n self.progressBar.setProperty(\"value\", 70)\n self.call_tailsconfig()\n\n # This will update the output text after the git commands.\n def update_status(self, result):\n \"This is the slot for update thread\"\n self.output += result['output']\n self.update_success = result['status']\n self.failure_reason = result['failure_reason']\n self.progressBar.setProperty(\"value\", 40)\n self.plainTextEdit.setPlainText(self.output)\n self.plainTextEdit.setReadOnly = True\n if not self.update_success: # Failed to do update\n self.pushButton.setEnabled(True)\n self.pushButton_2.setEnabled(True)\n self.update_status_bar_and_output(self.failure_reason)\n self.progressBar.setProperty(\"value\", 0)\n self.alert_failure(self.failure_reason)\n return\n self.progressBar.setProperty(\"value\", 50)\n self.update_status_bar_and_output(strings.doing_setup)\n self.setup_thread.start()\n\n def update_status_bar_and_output(self, status_message):\n \"\"\"This method updates the status bar and the output window with the\n status_message.\"\"\"\n self.statusbar.showMessage(status_message)\n self.output += status_message + '\\n'\n self.plainTextEdit.setPlainText(self.output)\n\n def call_tailsconfig(self):\n # Now let us work on tailsconfig part\n if self.update_success:\n # Get sudo password and add an enter key as tailsconfig command\n # expects\n sudo_password = self.get_sudo_password()\n if not sudo_password:\n self.update_success = False\n self.failure_reason = strings.missing_sudo_password\n self.on_failure()\n return\n self.tails_thread.sudo_password = sudo_password + '\\n'\n self.update_status_bar_and_output(strings.updating_tails_env)\n self.tails_thread.start()\n else:\n self.on_failure()\n\n def tails_status(self, result):\n \"This is the slot for Tailsconfig thread\"\n self.output += result['output']\n self.update_success = result['status']\n self.failure_reason = result['failure_reason']\n self.plainTextEdit.setPlainText(self.output)\n self.progressBar.setProperty(\"value\", 80)\n if self.update_success:\n # Remove flag file indicating an update is in progress\n os.remove(FLAG_LOCATION)\n self.update_status_bar_and_output(strings.finished)\n self.progressBar.setProperty(\"value\", 100)\n self.alert_success()\n else:\n self.on_failure()\n\n def on_failure(self):\n self.update_status_bar_and_output(self.failure_reason)\n self.alert_failure(self.failure_reason)\n # Now everything is done, enable the button.\n self.pushButton.setEnabled(True)\n self.pushButton_2.setEnabled(True)\n self.progressBar.setProperty(\"value\", 0)\n\n def update_securedrop(self):\n self.pushButton_2.setEnabled(False)\n self.pushButton.setEnabled(False)\n self.progressBar.setProperty(\"value\", 10)\n self.update_status_bar_and_output(strings.fetching_update)\n self.update_thread.start()\n\n def alert_success(self):\n self.success_dialog = QtWidgets.QMessageBox()\n self.success_dialog.setIcon(QtWidgets.QMessageBox.Information)\n self.success_dialog.setText(strings.finished_dialog_message)\n self.success_dialog.setWindowTitle(strings.finished_dialog_title)\n self.success_dialog.show()\n\n def alert_failure(self, failure_reason):\n self.error_dialog = QtWidgets.QMessageBox()\n self.error_dialog.setIcon(QtWidgets.QMessageBox.Critical)\n self.error_dialog.setText(self.failure_reason)\n self.error_dialog.setWindowTitle(strings.update_failed_dialog_title)\n self.error_dialog.show()\n\n def get_sudo_password(self):\n sudo_password, ok_is_pressed = QtWidgets.QInputDialog.getText(\n self, \"Tails Administrator password\", strings.sudo_password_text,\n QtWidgets.QLineEdit.Password, \"\")\n if ok_is_pressed and sudo_password:\n return sudo_password\n else:\n return None\n", "path": "journalist_gui/journalist_gui/SecureDropUpdater.py"}]}
| 3,550 | 314 |
gh_patches_debug_16621
|
rasdani/github-patches
|
git_diff
|
pre-commit__pre-commit-1997
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Docker inspect fails when running with Docker in Docker
When trying to run pre commits with `docker_image` language via GitLabs Docker in Docker approach the docker inspect fails, and so pre-commit throws an error when trying to get the mount path.
The [code](https://github.com/pre-commit/pre-commit/blob/fe436f1eb09dfdd67032b4f9f8dfa543fb99cf06/pre_commit/languages/docker.py#L39) for this already has a fall back of "return path" but doesn't handle the docker command failing.
Could the code for this be modified to handle the docker inspect failing?
More details of docker in docker are [here](https://docs.gitlab.com/ee/ci/docker/using_docker_build.html#use-the-docker-executor-with-the-docker-image-docker-in-docker)
Full logs of the failure:
### version information
```
pre-commit version: 2.13.0
sys.version:
3.6.9 (default, Jan 26 2021, 15:33:00)
[GCC 8.4.0]
sys.executable: /usr/bin/python3
os.name: posix
sys.platform: linux
```
### error information
```
An unexpected error has occurred: CalledProcessError: command: ('/usr/bin/docker', 'inspect', 'runner-dmrvfsu-project-35395-concurrent-0')
return code: 1
expected return code: 0
stdout:
[]
stderr:
Error: No such object: runner-dmrvfsu-project-35395-concurrent-0
```
```
Traceback (most recent call last):
File "/usr/local/lib/python3.6/dist-packages/pre_commit/error_handler.py", line 65, in error_handler
yield
File "/usr/local/lib/python3.6/dist-packages/pre_commit/main.py", line 385, in main
return run(args.config, store, args)
File "/usr/local/lib/python3.6/dist-packages/pre_commit/commands/run.py", line 410, in run
return _run_hooks(config, hooks, skips, args, environ)
File "/usr/local/lib/python3.6/dist-packages/pre_commit/commands/run.py", line 288, in _run_hooks
verbose=args.verbose, use_color=args.color,
File "/usr/local/lib/python3.6/dist-packages/pre_commit/commands/run.py", line 194, in _run_single_hook
retcode, out = language.run_hook(hook, filenames, use_color)
File "/usr/local/lib/python3.6/dist-packages/pre_commit/languages/docker_image.py", line 19, in run_hook
cmd = docker_cmd() + hook.cmd
File "/usr/local/lib/python3.6/dist-packages/pre_commit/languages/docker.py", line 107, in docker_cmd
'-v', f'{_get_docker_path(os.getcwd())}:/src:rw,Z',
File "/usr/local/lib/python3.6/dist-packages/pre_commit/languages/docker.py", line 34, in _get_docker_path
_, out, _ = cmd_output_b('docker', 'inspect', hostname)
File "/usr/local/lib/python3.6/dist-packages/pre_commit/util.py", line 154, in cmd_output_b
raise CalledProcessError(returncode, cmd, retcode, stdout_b, stderr_b)
pre_commit.util.CalledProcessError: command: ('/usr/bin/docker', 'inspect', 'runner-dmrvfsu-project-35395-concurrent-0')
return code: 1
expected return code: 0
stdout:
[]
stderr:
Error: No such object: runner-dmrvfsu-project-35395-concurrent-0
```
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `pre_commit/languages/docker.py`
Content:
```
1 import hashlib
2 import json
3 import os
4 from typing import Sequence
5 from typing import Tuple
6
7 import pre_commit.constants as C
8 from pre_commit.hook import Hook
9 from pre_commit.languages import helpers
10 from pre_commit.prefix import Prefix
11 from pre_commit.util import clean_path_on_failure
12 from pre_commit.util import cmd_output_b
13
14 ENVIRONMENT_DIR = 'docker'
15 PRE_COMMIT_LABEL = 'PRE_COMMIT'
16 get_default_version = helpers.basic_get_default_version
17 healthy = helpers.basic_healthy
18
19
20 def _is_in_docker() -> bool:
21 try:
22 with open('/proc/1/cgroup', 'rb') as f:
23 return b'docker' in f.read()
24 except FileNotFoundError:
25 return False
26
27
28 def _get_container_id() -> str:
29 # It's assumed that we already check /proc/1/cgroup in _is_in_docker. The
30 # cpuset cgroup controller existed since cgroups were introduced so this
31 # way of getting the container ID is pretty reliable.
32 with open('/proc/1/cgroup', 'rb') as f:
33 for line in f.readlines():
34 if line.split(b':')[1] == b'cpuset':
35 return os.path.basename(line.split(b':')[2]).strip().decode()
36 raise RuntimeError('Failed to find the container ID in /proc/1/cgroup.')
37
38
39 def _get_docker_path(path: str) -> str:
40 if not _is_in_docker():
41 return path
42
43 container_id = _get_container_id()
44
45 _, out, _ = cmd_output_b('docker', 'inspect', container_id)
46
47 container, = json.loads(out)
48 for mount in container['Mounts']:
49 src_path = mount['Source']
50 to_path = mount['Destination']
51 if os.path.commonpath((path, to_path)) == to_path:
52 # So there is something in common,
53 # and we can proceed remapping it
54 return path.replace(to_path, src_path)
55 # we're in Docker, but the path is not mounted, cannot really do anything,
56 # so fall back to original path
57 return path
58
59
60 def md5(s: str) -> str: # pragma: win32 no cover
61 return hashlib.md5(s.encode()).hexdigest()
62
63
64 def docker_tag(prefix: Prefix) -> str: # pragma: win32 no cover
65 md5sum = md5(os.path.basename(prefix.prefix_dir)).lower()
66 return f'pre-commit-{md5sum}'
67
68
69 def build_docker_image(
70 prefix: Prefix,
71 *,
72 pull: bool,
73 ) -> None: # pragma: win32 no cover
74 cmd: Tuple[str, ...] = (
75 'docker', 'build',
76 '--tag', docker_tag(prefix),
77 '--label', PRE_COMMIT_LABEL,
78 )
79 if pull:
80 cmd += ('--pull',)
81 # This must come last for old versions of docker. See #477
82 cmd += ('.',)
83 helpers.run_setup_cmd(prefix, cmd)
84
85
86 def install_environment(
87 prefix: Prefix, version: str, additional_dependencies: Sequence[str],
88 ) -> None: # pragma: win32 no cover
89 helpers.assert_version_default('docker', version)
90 helpers.assert_no_additional_deps('docker', additional_dependencies)
91
92 directory = prefix.path(
93 helpers.environment_dir(ENVIRONMENT_DIR, C.DEFAULT),
94 )
95
96 # Docker doesn't really have relevant disk environment, but pre-commit
97 # still needs to cleanup its state files on failure
98 with clean_path_on_failure(directory):
99 build_docker_image(prefix, pull=True)
100 os.mkdir(directory)
101
102
103 def get_docker_user() -> Tuple[str, ...]: # pragma: win32 no cover
104 try:
105 return ('-u', f'{os.getuid()}:{os.getgid()}')
106 except AttributeError:
107 return ()
108
109
110 def docker_cmd() -> Tuple[str, ...]: # pragma: win32 no cover
111 return (
112 'docker', 'run',
113 '--rm',
114 *get_docker_user(),
115 # https://docs.docker.com/engine/reference/commandline/run/#mount-volumes-from-container-volumes-from
116 # The `Z` option tells Docker to label the content with a private
117 # unshared label. Only the current container can use a private volume.
118 '-v', f'{_get_docker_path(os.getcwd())}:/src:rw,Z',
119 '--workdir', '/src',
120 )
121
122
123 def run_hook(
124 hook: Hook,
125 file_args: Sequence[str],
126 color: bool,
127 ) -> Tuple[int, bytes]: # pragma: win32 no cover
128 # Rebuild the docker image in case it has gone missing, as many people do
129 # automated cleanup of docker images.
130 build_docker_image(hook.prefix, pull=False)
131
132 entry_exe, *cmd_rest = hook.cmd
133
134 entry_tag = ('--entrypoint', entry_exe, docker_tag(hook.prefix))
135 cmd = (*docker_cmd(), *entry_tag, *cmd_rest)
136 return helpers.run_xargs(hook, cmd, file_args, color=color)
137
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/pre_commit/languages/docker.py b/pre_commit/languages/docker.py
--- a/pre_commit/languages/docker.py
+++ b/pre_commit/languages/docker.py
@@ -8,6 +8,7 @@
from pre_commit.hook import Hook
from pre_commit.languages import helpers
from pre_commit.prefix import Prefix
+from pre_commit.util import CalledProcessError
from pre_commit.util import clean_path_on_failure
from pre_commit.util import cmd_output_b
@@ -42,7 +43,11 @@
container_id = _get_container_id()
- _, out, _ = cmd_output_b('docker', 'inspect', container_id)
+ try:
+ _, out, _ = cmd_output_b('docker', 'inspect', container_id)
+ except CalledProcessError:
+ # self-container was not visible from here (perhaps docker-in-docker)
+ return path
container, = json.loads(out)
for mount in container['Mounts']:
|
{"golden_diff": "diff --git a/pre_commit/languages/docker.py b/pre_commit/languages/docker.py\n--- a/pre_commit/languages/docker.py\n+++ b/pre_commit/languages/docker.py\n@@ -8,6 +8,7 @@\n from pre_commit.hook import Hook\n from pre_commit.languages import helpers\n from pre_commit.prefix import Prefix\n+from pre_commit.util import CalledProcessError\n from pre_commit.util import clean_path_on_failure\n from pre_commit.util import cmd_output_b\n \n@@ -42,7 +43,11 @@\n \n container_id = _get_container_id()\n \n- _, out, _ = cmd_output_b('docker', 'inspect', container_id)\n+ try:\n+ _, out, _ = cmd_output_b('docker', 'inspect', container_id)\n+ except CalledProcessError:\n+ # self-container was not visible from here (perhaps docker-in-docker)\n+ return path\n \n container, = json.loads(out)\n for mount in container['Mounts']:\n", "issue": "Docker inspect fails when running with Docker in Docker\nWhen trying to run pre commits with `docker_image` language via GitLabs Docker in Docker approach the docker inspect fails, and so pre-commit throws an error when trying to get the mount path.\r\n\r\nThe [code](https://github.com/pre-commit/pre-commit/blob/fe436f1eb09dfdd67032b4f9f8dfa543fb99cf06/pre_commit/languages/docker.py#L39) for this already has a fall back of \"return path\" but doesn't handle the docker command failing.\r\n\r\nCould the code for this be modified to handle the docker inspect failing?\r\n\r\nMore details of docker in docker are [here](https://docs.gitlab.com/ee/ci/docker/using_docker_build.html#use-the-docker-executor-with-the-docker-image-docker-in-docker)\r\n\r\n\r\nFull logs of the failure:\r\n\r\n\r\n### version information\r\n\r\n```\r\npre-commit version: 2.13.0\r\nsys.version:\r\n 3.6.9 (default, Jan 26 2021, 15:33:00) \r\n [GCC 8.4.0]\r\nsys.executable: /usr/bin/python3\r\nos.name: posix\r\nsys.platform: linux\r\n```\r\n\r\n### error information\r\n\r\n```\r\nAn unexpected error has occurred: CalledProcessError: command: ('/usr/bin/docker', 'inspect', 'runner-dmrvfsu-project-35395-concurrent-0')\r\nreturn code: 1\r\nexpected return code: 0\r\nstdout:\r\n []\r\n \r\nstderr:\r\n Error: No such object: runner-dmrvfsu-project-35395-concurrent-0\r\n \r\n```\r\n\r\n```\r\nTraceback (most recent call last):\r\n File \"/usr/local/lib/python3.6/dist-packages/pre_commit/error_handler.py\", line 65, in error_handler\r\n yield\r\n File \"/usr/local/lib/python3.6/dist-packages/pre_commit/main.py\", line 385, in main\r\n return run(args.config, store, args)\r\n File \"/usr/local/lib/python3.6/dist-packages/pre_commit/commands/run.py\", line 410, in run\r\n return _run_hooks(config, hooks, skips, args, environ)\r\n File \"/usr/local/lib/python3.6/dist-packages/pre_commit/commands/run.py\", line 288, in _run_hooks\r\n verbose=args.verbose, use_color=args.color,\r\n File \"/usr/local/lib/python3.6/dist-packages/pre_commit/commands/run.py\", line 194, in _run_single_hook\r\n retcode, out = language.run_hook(hook, filenames, use_color)\r\n File \"/usr/local/lib/python3.6/dist-packages/pre_commit/languages/docker_image.py\", line 19, in run_hook\r\n cmd = docker_cmd() + hook.cmd\r\n File \"/usr/local/lib/python3.6/dist-packages/pre_commit/languages/docker.py\", line 107, in docker_cmd\r\n '-v', f'{_get_docker_path(os.getcwd())}:/src:rw,Z',\r\n File \"/usr/local/lib/python3.6/dist-packages/pre_commit/languages/docker.py\", line 34, in _get_docker_path\r\n _, out, _ = cmd_output_b('docker', 'inspect', hostname)\r\n File \"/usr/local/lib/python3.6/dist-packages/pre_commit/util.py\", line 154, in cmd_output_b\r\n raise CalledProcessError(returncode, cmd, retcode, stdout_b, stderr_b)\r\npre_commit.util.CalledProcessError: command: ('/usr/bin/docker', 'inspect', 'runner-dmrvfsu-project-35395-concurrent-0')\r\nreturn code: 1\r\nexpected return code: 0\r\nstdout:\r\n []\r\n \r\nstderr:\r\n Error: No such object: runner-dmrvfsu-project-35395-concurrent-0\r\n```\n", "before_files": [{"content": "import hashlib\nimport json\nimport os\nfrom typing import Sequence\nfrom typing import Tuple\n\nimport pre_commit.constants as C\nfrom pre_commit.hook import Hook\nfrom pre_commit.languages import helpers\nfrom pre_commit.prefix import Prefix\nfrom pre_commit.util import clean_path_on_failure\nfrom pre_commit.util import cmd_output_b\n\nENVIRONMENT_DIR = 'docker'\nPRE_COMMIT_LABEL = 'PRE_COMMIT'\nget_default_version = helpers.basic_get_default_version\nhealthy = helpers.basic_healthy\n\n\ndef _is_in_docker() -> bool:\n try:\n with open('/proc/1/cgroup', 'rb') as f:\n return b'docker' in f.read()\n except FileNotFoundError:\n return False\n\n\ndef _get_container_id() -> str:\n # It's assumed that we already check /proc/1/cgroup in _is_in_docker. The\n # cpuset cgroup controller existed since cgroups were introduced so this\n # way of getting the container ID is pretty reliable.\n with open('/proc/1/cgroup', 'rb') as f:\n for line in f.readlines():\n if line.split(b':')[1] == b'cpuset':\n return os.path.basename(line.split(b':')[2]).strip().decode()\n raise RuntimeError('Failed to find the container ID in /proc/1/cgroup.')\n\n\ndef _get_docker_path(path: str) -> str:\n if not _is_in_docker():\n return path\n\n container_id = _get_container_id()\n\n _, out, _ = cmd_output_b('docker', 'inspect', container_id)\n\n container, = json.loads(out)\n for mount in container['Mounts']:\n src_path = mount['Source']\n to_path = mount['Destination']\n if os.path.commonpath((path, to_path)) == to_path:\n # So there is something in common,\n # and we can proceed remapping it\n return path.replace(to_path, src_path)\n # we're in Docker, but the path is not mounted, cannot really do anything,\n # so fall back to original path\n return path\n\n\ndef md5(s: str) -> str: # pragma: win32 no cover\n return hashlib.md5(s.encode()).hexdigest()\n\n\ndef docker_tag(prefix: Prefix) -> str: # pragma: win32 no cover\n md5sum = md5(os.path.basename(prefix.prefix_dir)).lower()\n return f'pre-commit-{md5sum}'\n\n\ndef build_docker_image(\n prefix: Prefix,\n *,\n pull: bool,\n) -> None: # pragma: win32 no cover\n cmd: Tuple[str, ...] = (\n 'docker', 'build',\n '--tag', docker_tag(prefix),\n '--label', PRE_COMMIT_LABEL,\n )\n if pull:\n cmd += ('--pull',)\n # This must come last for old versions of docker. See #477\n cmd += ('.',)\n helpers.run_setup_cmd(prefix, cmd)\n\n\ndef install_environment(\n prefix: Prefix, version: str, additional_dependencies: Sequence[str],\n) -> None: # pragma: win32 no cover\n helpers.assert_version_default('docker', version)\n helpers.assert_no_additional_deps('docker', additional_dependencies)\n\n directory = prefix.path(\n helpers.environment_dir(ENVIRONMENT_DIR, C.DEFAULT),\n )\n\n # Docker doesn't really have relevant disk environment, but pre-commit\n # still needs to cleanup its state files on failure\n with clean_path_on_failure(directory):\n build_docker_image(prefix, pull=True)\n os.mkdir(directory)\n\n\ndef get_docker_user() -> Tuple[str, ...]: # pragma: win32 no cover\n try:\n return ('-u', f'{os.getuid()}:{os.getgid()}')\n except AttributeError:\n return ()\n\n\ndef docker_cmd() -> Tuple[str, ...]: # pragma: win32 no cover\n return (\n 'docker', 'run',\n '--rm',\n *get_docker_user(),\n # https://docs.docker.com/engine/reference/commandline/run/#mount-volumes-from-container-volumes-from\n # The `Z` option tells Docker to label the content with a private\n # unshared label. Only the current container can use a private volume.\n '-v', f'{_get_docker_path(os.getcwd())}:/src:rw,Z',\n '--workdir', '/src',\n )\n\n\ndef run_hook(\n hook: Hook,\n file_args: Sequence[str],\n color: bool,\n) -> Tuple[int, bytes]: # pragma: win32 no cover\n # Rebuild the docker image in case it has gone missing, as many people do\n # automated cleanup of docker images.\n build_docker_image(hook.prefix, pull=False)\n\n entry_exe, *cmd_rest = hook.cmd\n\n entry_tag = ('--entrypoint', entry_exe, docker_tag(hook.prefix))\n cmd = (*docker_cmd(), *entry_tag, *cmd_rest)\n return helpers.run_xargs(hook, cmd, file_args, color=color)\n", "path": "pre_commit/languages/docker.py"}], "after_files": [{"content": "import hashlib\nimport json\nimport os\nfrom typing import Sequence\nfrom typing import Tuple\n\nimport pre_commit.constants as C\nfrom pre_commit.hook import Hook\nfrom pre_commit.languages import helpers\nfrom pre_commit.prefix import Prefix\nfrom pre_commit.util import CalledProcessError\nfrom pre_commit.util import clean_path_on_failure\nfrom pre_commit.util import cmd_output_b\n\nENVIRONMENT_DIR = 'docker'\nPRE_COMMIT_LABEL = 'PRE_COMMIT'\nget_default_version = helpers.basic_get_default_version\nhealthy = helpers.basic_healthy\n\n\ndef _is_in_docker() -> bool:\n try:\n with open('/proc/1/cgroup', 'rb') as f:\n return b'docker' in f.read()\n except FileNotFoundError:\n return False\n\n\ndef _get_container_id() -> str:\n # It's assumed that we already check /proc/1/cgroup in _is_in_docker. The\n # cpuset cgroup controller existed since cgroups were introduced so this\n # way of getting the container ID is pretty reliable.\n with open('/proc/1/cgroup', 'rb') as f:\n for line in f.readlines():\n if line.split(b':')[1] == b'cpuset':\n return os.path.basename(line.split(b':')[2]).strip().decode()\n raise RuntimeError('Failed to find the container ID in /proc/1/cgroup.')\n\n\ndef _get_docker_path(path: str) -> str:\n if not _is_in_docker():\n return path\n\n container_id = _get_container_id()\n\n try:\n _, out, _ = cmd_output_b('docker', 'inspect', container_id)\n except CalledProcessError:\n # self-container was not visible from here (perhaps docker-in-docker)\n return path\n\n container, = json.loads(out)\n for mount in container['Mounts']:\n src_path = mount['Source']\n to_path = mount['Destination']\n if os.path.commonpath((path, to_path)) == to_path:\n # So there is something in common,\n # and we can proceed remapping it\n return path.replace(to_path, src_path)\n # we're in Docker, but the path is not mounted, cannot really do anything,\n # so fall back to original path\n return path\n\n\ndef md5(s: str) -> str: # pragma: win32 no cover\n return hashlib.md5(s.encode()).hexdigest()\n\n\ndef docker_tag(prefix: Prefix) -> str: # pragma: win32 no cover\n md5sum = md5(os.path.basename(prefix.prefix_dir)).lower()\n return f'pre-commit-{md5sum}'\n\n\ndef build_docker_image(\n prefix: Prefix,\n *,\n pull: bool,\n) -> None: # pragma: win32 no cover\n cmd: Tuple[str, ...] = (\n 'docker', 'build',\n '--tag', docker_tag(prefix),\n '--label', PRE_COMMIT_LABEL,\n )\n if pull:\n cmd += ('--pull',)\n # This must come last for old versions of docker. See #477\n cmd += ('.',)\n helpers.run_setup_cmd(prefix, cmd)\n\n\ndef install_environment(\n prefix: Prefix, version: str, additional_dependencies: Sequence[str],\n) -> None: # pragma: win32 no cover\n helpers.assert_version_default('docker', version)\n helpers.assert_no_additional_deps('docker', additional_dependencies)\n\n directory = prefix.path(\n helpers.environment_dir(ENVIRONMENT_DIR, C.DEFAULT),\n )\n\n # Docker doesn't really have relevant disk environment, but pre-commit\n # still needs to cleanup its state files on failure\n with clean_path_on_failure(directory):\n build_docker_image(prefix, pull=True)\n os.mkdir(directory)\n\n\ndef get_docker_user() -> Tuple[str, ...]: # pragma: win32 no cover\n try:\n return ('-u', f'{os.getuid()}:{os.getgid()}')\n except AttributeError:\n return ()\n\n\ndef docker_cmd() -> Tuple[str, ...]: # pragma: win32 no cover\n return (\n 'docker', 'run',\n '--rm',\n *get_docker_user(),\n # https://docs.docker.com/engine/reference/commandline/run/#mount-volumes-from-container-volumes-from\n # The `Z` option tells Docker to label the content with a private\n # unshared label. Only the current container can use a private volume.\n '-v', f'{_get_docker_path(os.getcwd())}:/src:rw,Z',\n '--workdir', '/src',\n )\n\n\ndef run_hook(\n hook: Hook,\n file_args: Sequence[str],\n color: bool,\n) -> Tuple[int, bytes]: # pragma: win32 no cover\n # Rebuild the docker image in case it has gone missing, as many people do\n # automated cleanup of docker images.\n build_docker_image(hook.prefix, pull=False)\n\n entry_exe, *cmd_rest = hook.cmd\n\n entry_tag = ('--entrypoint', entry_exe, docker_tag(hook.prefix))\n cmd = (*docker_cmd(), *entry_tag, *cmd_rest)\n return helpers.run_xargs(hook, cmd, file_args, color=color)\n", "path": "pre_commit/languages/docker.py"}]}
| 2,512 | 209 |
gh_patches_debug_10060
|
rasdani/github-patches
|
git_diff
|
freqtrade__freqtrade-2100
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Strategy list is space separated
`--strategy-list Strat1,Strat2` produces an error while `--strategy-list Strat1 Strat2` works
It became a space separated list somehow while its description states it's a comma-separated list:
```
--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]
Provide **a comma-separated list** of strategies to
backtest. Please note that ticker-interval needs to be
set either in config or via command line. When using
this together with `--export trades`, the strategy-
name is injected into the filename (so `backtest-
data.json` becomes `backtest-data-
DefaultStrategy.json`
```
Which direction this should be fixed to?
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `freqtrade/configuration/cli_options.py`
Content:
```
1 """
2 Definition of cli arguments used in arguments.py
3 """
4 import argparse
5 import os
6
7 from freqtrade import __version__, constants
8
9
10 def check_int_positive(value: str) -> int:
11 try:
12 uint = int(value)
13 if uint <= 0:
14 raise ValueError
15 except ValueError:
16 raise argparse.ArgumentTypeError(
17 f"{value} is invalid for this parameter, should be a positive integer value"
18 )
19 return uint
20
21
22 class Arg:
23 # Optional CLI arguments
24 def __init__(self, *args, **kwargs):
25 self.cli = args
26 self.kwargs = kwargs
27
28
29 # List of available command line options
30 AVAILABLE_CLI_OPTIONS = {
31 # Common options
32 "verbosity": Arg(
33 '-v', '--verbose',
34 help='Verbose mode (-vv for more, -vvv to get all messages).',
35 action='count',
36 default=0,
37 ),
38 "logfile": Arg(
39 '--logfile',
40 help='Log to the file specified.',
41 metavar='FILE',
42 ),
43 "version": Arg(
44 '-V', '--version',
45 action='version',
46 version=f'%(prog)s {__version__}',
47 ),
48 "config": Arg(
49 '-c', '--config',
50 help=f'Specify configuration file (default: `{constants.DEFAULT_CONFIG}`). '
51 f'Multiple --config options may be used. '
52 f'Can be set to `-` to read config from stdin.',
53 action='append',
54 metavar='PATH',
55 ),
56 "datadir": Arg(
57 '-d', '--datadir',
58 help='Path to backtest data.',
59 metavar='PATH',
60 ),
61 # Main options
62 "strategy": Arg(
63 '-s', '--strategy',
64 help='Specify strategy class name (default: `%(default)s`).',
65 metavar='NAME',
66 default='DefaultStrategy',
67 ),
68 "strategy_path": Arg(
69 '--strategy-path',
70 help='Specify additional strategy lookup path.',
71 metavar='PATH',
72 ),
73 "db_url": Arg(
74 '--db-url',
75 help=f'Override trades database URL, this is useful in custom deployments '
76 f'(default: `{constants.DEFAULT_DB_PROD_URL}` for Live Run mode, '
77 f'`{constants.DEFAULT_DB_DRYRUN_URL}` for Dry Run).',
78 metavar='PATH',
79 ),
80 "sd_notify": Arg(
81 '--sd-notify',
82 help='Notify systemd service manager.',
83 action='store_true',
84 ),
85 # Optimize common
86 "ticker_interval": Arg(
87 '-i', '--ticker-interval',
88 help='Specify ticker interval (`1m`, `5m`, `30m`, `1h`, `1d`).',
89 ),
90 "timerange": Arg(
91 '--timerange',
92 help='Specify what timerange of data to use.',
93 ),
94 "max_open_trades": Arg(
95 '--max_open_trades',
96 help='Specify max_open_trades to use.',
97 type=int,
98 metavar='INT',
99 ),
100 "stake_amount": Arg(
101 '--stake_amount',
102 help='Specify stake_amount.',
103 type=float,
104 ),
105 "refresh_pairs": Arg(
106 '-r', '--refresh-pairs-cached',
107 help='Refresh the pairs files in tests/testdata with the latest data from the '
108 'exchange. Use it if you want to run your optimization commands with '
109 'up-to-date data.',
110 action='store_true',
111 ),
112 # Backtesting
113 "position_stacking": Arg(
114 '--eps', '--enable-position-stacking',
115 help='Allow buying the same pair multiple times (position stacking).',
116 action='store_true',
117 default=False,
118 ),
119 "use_max_market_positions": Arg(
120 '--dmmp', '--disable-max-market-positions',
121 help='Disable applying `max_open_trades` during backtest '
122 '(same as setting `max_open_trades` to a very high number).',
123 action='store_false',
124 default=True,
125 ),
126 "live": Arg(
127 '-l', '--live',
128 help='Use live data.',
129 action='store_true',
130 ),
131 "strategy_list": Arg(
132 '--strategy-list',
133 help='Provide a comma-separated list of strategies to backtest. '
134 'Please note that ticker-interval needs to be set either in config '
135 'or via command line. When using this together with `--export trades`, '
136 'the strategy-name is injected into the filename '
137 '(so `backtest-data.json` becomes `backtest-data-DefaultStrategy.json`',
138 nargs='+',
139 ),
140 "export": Arg(
141 '--export',
142 help='Export backtest results, argument are: trades. '
143 'Example: `--export=trades`',
144 ),
145 "exportfilename": Arg(
146 '--export-filename',
147 help='Save backtest results to the file with this filename (default: `%(default)s`). '
148 'Requires `--export` to be set as well. '
149 'Example: `--export-filename=user_data/backtest_data/backtest_today.json`',
150 metavar='PATH',
151 default=os.path.join('user_data', 'backtest_data',
152 'backtest-result.json'),
153 ),
154 # Edge
155 "stoploss_range": Arg(
156 '--stoplosses',
157 help='Defines a range of stoploss values against which edge will assess the strategy. '
158 'The format is "min,max,step" (without any space). '
159 'Example: `--stoplosses=-0.01,-0.1,-0.001`',
160 ),
161 # Hyperopt
162 "hyperopt": Arg(
163 '--customhyperopt',
164 help='Specify hyperopt class name (default: `%(default)s`).',
165 metavar='NAME',
166 default=constants.DEFAULT_HYPEROPT,
167 ),
168 "hyperopt_path": Arg(
169 '--hyperopt-path',
170 help='Specify additional lookup path for Hyperopts and Hyperopt Loss functions.',
171 metavar='PATH',
172 ),
173 "epochs": Arg(
174 '-e', '--epochs',
175 help='Specify number of epochs (default: %(default)d).',
176 type=check_int_positive,
177 metavar='INT',
178 default=constants.HYPEROPT_EPOCH,
179 ),
180 "spaces": Arg(
181 '-s', '--spaces',
182 help='Specify which parameters to hyperopt. Space-separated list. '
183 'Default: `%(default)s`.',
184 choices=['all', 'buy', 'sell', 'roi', 'stoploss'],
185 nargs='+',
186 default='all',
187 ),
188 "print_all": Arg(
189 '--print-all',
190 help='Print all results, not only the best ones.',
191 action='store_true',
192 default=False,
193 ),
194 "hyperopt_jobs": Arg(
195 '-j', '--job-workers',
196 help='The number of concurrently running jobs for hyperoptimization '
197 '(hyperopt worker processes). '
198 'If -1 (default), all CPUs are used, for -2, all CPUs but one are used, etc. '
199 'If 1 is given, no parallel computing code is used at all.',
200 type=int,
201 metavar='JOBS',
202 default=-1,
203 ),
204 "hyperopt_random_state": Arg(
205 '--random-state',
206 help='Set random state to some positive integer for reproducible hyperopt results.',
207 type=check_int_positive,
208 metavar='INT',
209 ),
210 "hyperopt_min_trades": Arg(
211 '--min-trades',
212 help="Set minimal desired number of trades for evaluations in the hyperopt "
213 "optimization path (default: 1).",
214 type=check_int_positive,
215 metavar='INT',
216 default=1,
217 ),
218 "hyperopt_continue": Arg(
219 "--continue",
220 help="Continue hyperopt from previous runs. "
221 "By default, temporary files will be removed and hyperopt will start from scratch.",
222 default=False,
223 action='store_true',
224 ),
225 "hyperopt_loss": Arg(
226 '--hyperopt-loss',
227 help='Specify the class name of the hyperopt loss function class (IHyperOptLoss). '
228 'Different functions can generate completely different results, '
229 'since the target for optimization is different. (default: `%(default)s`).',
230 metavar='NAME',
231 default=constants.DEFAULT_HYPEROPT_LOSS,
232 ),
233 # List exchanges
234 "print_one_column": Arg(
235 '-1', '--one-column',
236 help='Print exchanges in one column.',
237 action='store_true',
238 ),
239 # Script options
240 "pairs": Arg(
241 '-p', '--pairs',
242 help='Show profits for only these pairs. Pairs are comma-separated.',
243 ),
244 # Download data
245 "pairs_file": Arg(
246 '--pairs-file',
247 help='File containing a list of pairs to download.',
248 metavar='FILE',
249 ),
250 "days": Arg(
251 '--days',
252 help='Download data for given number of days.',
253 type=check_int_positive,
254 metavar='INT',
255 ),
256 "exchange": Arg(
257 '--exchange',
258 help=f'Exchange name (default: `{constants.DEFAULT_EXCHANGE}`). '
259 f'Only valid if no config is provided.',
260 ),
261 "timeframes": Arg(
262 '-t', '--timeframes',
263 help=f'Specify which tickers to download. Space-separated list. '
264 f'Default: `{constants.DEFAULT_DOWNLOAD_TICKER_INTERVALS}`.',
265 choices=['1m', '3m', '5m', '15m', '30m', '1h', '2h', '4h',
266 '6h', '8h', '12h', '1d', '3d', '1w'],
267 nargs='+',
268 ),
269 "erase": Arg(
270 '--erase',
271 help='Clean all existing data for the selected exchange/pairs/timeframes.',
272 action='store_true',
273 ),
274 # Plot dataframe
275 "indicators1": Arg(
276 '--indicators1',
277 help='Set indicators from your strategy you want in the first row of the graph. '
278 'Comma-separated list. Example: `ema3,ema5`. Default: `%(default)s`.',
279 default='sma,ema3,ema5',
280 ),
281 "indicators2": Arg(
282 '--indicators2',
283 help='Set indicators from your strategy you want in the third row of the graph. '
284 'Comma-separated list. Example: `fastd,fastk`. Default: `%(default)s`.',
285 default='macd,macdsignal',
286 ),
287 "plot_limit": Arg(
288 '--plot-limit',
289 help='Specify tick limit for plotting. Notice: too high values cause huge files. '
290 'Default: %(default)s.',
291 type=check_int_positive,
292 metavar='INT',
293 default=750,
294 ),
295 "trade_source": Arg(
296 '--trade-source',
297 help='Specify the source for trades (Can be DB or file (backtest file)) '
298 'Default: %(default)s',
299 choices=["DB", "file"],
300 default="file",
301 ),
302 }
303
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/freqtrade/configuration/cli_options.py b/freqtrade/configuration/cli_options.py
--- a/freqtrade/configuration/cli_options.py
+++ b/freqtrade/configuration/cli_options.py
@@ -130,7 +130,7 @@
),
"strategy_list": Arg(
'--strategy-list',
- help='Provide a comma-separated list of strategies to backtest. '
+ help='Provide a space-separated list of strategies to backtest. '
'Please note that ticker-interval needs to be set either in config '
'or via command line. When using this together with `--export trades`, '
'the strategy-name is injected into the filename '
|
{"golden_diff": "diff --git a/freqtrade/configuration/cli_options.py b/freqtrade/configuration/cli_options.py\n--- a/freqtrade/configuration/cli_options.py\n+++ b/freqtrade/configuration/cli_options.py\n@@ -130,7 +130,7 @@\n ),\n \"strategy_list\": Arg(\n '--strategy-list',\n- help='Provide a comma-separated list of strategies to backtest. '\n+ help='Provide a space-separated list of strategies to backtest. '\n 'Please note that ticker-interval needs to be set either in config '\n 'or via command line. When using this together with `--export trades`, '\n 'the strategy-name is injected into the filename '\n", "issue": "Strategy list is space separated\n`--strategy-list Strat1,Strat2` produces an error while `--strategy-list Strat1 Strat2` works\r\n\r\nIt became a space separated list somehow while its description states it's a comma-separated list:\r\n```\r\n --strategy-list STRATEGY_LIST [STRATEGY_LIST ...]\r\n Provide **a comma-separated list** of strategies to\r\n backtest. Please note that ticker-interval needs to be\r\n set either in config or via command line. When using\r\n this together with `--export trades`, the strategy-\r\n name is injected into the filename (so `backtest-\r\n data.json` becomes `backtest-data-\r\n DefaultStrategy.json`\r\n```\r\n\r\nWhich direction this should be fixed to?\r\n\n", "before_files": [{"content": "\"\"\"\nDefinition of cli arguments used in arguments.py\n\"\"\"\nimport argparse\nimport os\n\nfrom freqtrade import __version__, constants\n\n\ndef check_int_positive(value: str) -> int:\n try:\n uint = int(value)\n if uint <= 0:\n raise ValueError\n except ValueError:\n raise argparse.ArgumentTypeError(\n f\"{value} is invalid for this parameter, should be a positive integer value\"\n )\n return uint\n\n\nclass Arg:\n # Optional CLI arguments\n def __init__(self, *args, **kwargs):\n self.cli = args\n self.kwargs = kwargs\n\n\n# List of available command line options\nAVAILABLE_CLI_OPTIONS = {\n # Common options\n \"verbosity\": Arg(\n '-v', '--verbose',\n help='Verbose mode (-vv for more, -vvv to get all messages).',\n action='count',\n default=0,\n ),\n \"logfile\": Arg(\n '--logfile',\n help='Log to the file specified.',\n metavar='FILE',\n ),\n \"version\": Arg(\n '-V', '--version',\n action='version',\n version=f'%(prog)s {__version__}',\n ),\n \"config\": Arg(\n '-c', '--config',\n help=f'Specify configuration file (default: `{constants.DEFAULT_CONFIG}`). '\n f'Multiple --config options may be used. '\n f'Can be set to `-` to read config from stdin.',\n action='append',\n metavar='PATH',\n ),\n \"datadir\": Arg(\n '-d', '--datadir',\n help='Path to backtest data.',\n metavar='PATH',\n ),\n # Main options\n \"strategy\": Arg(\n '-s', '--strategy',\n help='Specify strategy class name (default: `%(default)s`).',\n metavar='NAME',\n default='DefaultStrategy',\n ),\n \"strategy_path\": Arg(\n '--strategy-path',\n help='Specify additional strategy lookup path.',\n metavar='PATH',\n ),\n \"db_url\": Arg(\n '--db-url',\n help=f'Override trades database URL, this is useful in custom deployments '\n f'(default: `{constants.DEFAULT_DB_PROD_URL}` for Live Run mode, '\n f'`{constants.DEFAULT_DB_DRYRUN_URL}` for Dry Run).',\n metavar='PATH',\n ),\n \"sd_notify\": Arg(\n '--sd-notify',\n help='Notify systemd service manager.',\n action='store_true',\n ),\n # Optimize common\n \"ticker_interval\": Arg(\n '-i', '--ticker-interval',\n help='Specify ticker interval (`1m`, `5m`, `30m`, `1h`, `1d`).',\n ),\n \"timerange\": Arg(\n '--timerange',\n help='Specify what timerange of data to use.',\n ),\n \"max_open_trades\": Arg(\n '--max_open_trades',\n help='Specify max_open_trades to use.',\n type=int,\n metavar='INT',\n ),\n \"stake_amount\": Arg(\n '--stake_amount',\n help='Specify stake_amount.',\n type=float,\n ),\n \"refresh_pairs\": Arg(\n '-r', '--refresh-pairs-cached',\n help='Refresh the pairs files in tests/testdata with the latest data from the '\n 'exchange. Use it if you want to run your optimization commands with '\n 'up-to-date data.',\n action='store_true',\n ),\n # Backtesting\n \"position_stacking\": Arg(\n '--eps', '--enable-position-stacking',\n help='Allow buying the same pair multiple times (position stacking).',\n action='store_true',\n default=False,\n ),\n \"use_max_market_positions\": Arg(\n '--dmmp', '--disable-max-market-positions',\n help='Disable applying `max_open_trades` during backtest '\n '(same as setting `max_open_trades` to a very high number).',\n action='store_false',\n default=True,\n ),\n \"live\": Arg(\n '-l', '--live',\n help='Use live data.',\n action='store_true',\n ),\n \"strategy_list\": Arg(\n '--strategy-list',\n help='Provide a comma-separated list of strategies to backtest. '\n 'Please note that ticker-interval needs to be set either in config '\n 'or via command line. When using this together with `--export trades`, '\n 'the strategy-name is injected into the filename '\n '(so `backtest-data.json` becomes `backtest-data-DefaultStrategy.json`',\n nargs='+',\n ),\n \"export\": Arg(\n '--export',\n help='Export backtest results, argument are: trades. '\n 'Example: `--export=trades`',\n ),\n \"exportfilename\": Arg(\n '--export-filename',\n help='Save backtest results to the file with this filename (default: `%(default)s`). '\n 'Requires `--export` to be set as well. '\n 'Example: `--export-filename=user_data/backtest_data/backtest_today.json`',\n metavar='PATH',\n default=os.path.join('user_data', 'backtest_data',\n 'backtest-result.json'),\n ),\n # Edge\n \"stoploss_range\": Arg(\n '--stoplosses',\n help='Defines a range of stoploss values against which edge will assess the strategy. '\n 'The format is \"min,max,step\" (without any space). '\n 'Example: `--stoplosses=-0.01,-0.1,-0.001`',\n ),\n # Hyperopt\n \"hyperopt\": Arg(\n '--customhyperopt',\n help='Specify hyperopt class name (default: `%(default)s`).',\n metavar='NAME',\n default=constants.DEFAULT_HYPEROPT,\n ),\n \"hyperopt_path\": Arg(\n '--hyperopt-path',\n help='Specify additional lookup path for Hyperopts and Hyperopt Loss functions.',\n metavar='PATH',\n ),\n \"epochs\": Arg(\n '-e', '--epochs',\n help='Specify number of epochs (default: %(default)d).',\n type=check_int_positive,\n metavar='INT',\n default=constants.HYPEROPT_EPOCH,\n ),\n \"spaces\": Arg(\n '-s', '--spaces',\n help='Specify which parameters to hyperopt. Space-separated list. '\n 'Default: `%(default)s`.',\n choices=['all', 'buy', 'sell', 'roi', 'stoploss'],\n nargs='+',\n default='all',\n ),\n \"print_all\": Arg(\n '--print-all',\n help='Print all results, not only the best ones.',\n action='store_true',\n default=False,\n ),\n \"hyperopt_jobs\": Arg(\n '-j', '--job-workers',\n help='The number of concurrently running jobs for hyperoptimization '\n '(hyperopt worker processes). '\n 'If -1 (default), all CPUs are used, for -2, all CPUs but one are used, etc. '\n 'If 1 is given, no parallel computing code is used at all.',\n type=int,\n metavar='JOBS',\n default=-1,\n ),\n \"hyperopt_random_state\": Arg(\n '--random-state',\n help='Set random state to some positive integer for reproducible hyperopt results.',\n type=check_int_positive,\n metavar='INT',\n ),\n \"hyperopt_min_trades\": Arg(\n '--min-trades',\n help=\"Set minimal desired number of trades for evaluations in the hyperopt \"\n \"optimization path (default: 1).\",\n type=check_int_positive,\n metavar='INT',\n default=1,\n ),\n \"hyperopt_continue\": Arg(\n \"--continue\",\n help=\"Continue hyperopt from previous runs. \"\n \"By default, temporary files will be removed and hyperopt will start from scratch.\",\n default=False,\n action='store_true',\n ),\n \"hyperopt_loss\": Arg(\n '--hyperopt-loss',\n help='Specify the class name of the hyperopt loss function class (IHyperOptLoss). '\n 'Different functions can generate completely different results, '\n 'since the target for optimization is different. (default: `%(default)s`).',\n metavar='NAME',\n default=constants.DEFAULT_HYPEROPT_LOSS,\n ),\n # List exchanges\n \"print_one_column\": Arg(\n '-1', '--one-column',\n help='Print exchanges in one column.',\n action='store_true',\n ),\n # Script options\n \"pairs\": Arg(\n '-p', '--pairs',\n help='Show profits for only these pairs. Pairs are comma-separated.',\n ),\n # Download data\n \"pairs_file\": Arg(\n '--pairs-file',\n help='File containing a list of pairs to download.',\n metavar='FILE',\n ),\n \"days\": Arg(\n '--days',\n help='Download data for given number of days.',\n type=check_int_positive,\n metavar='INT',\n ),\n \"exchange\": Arg(\n '--exchange',\n help=f'Exchange name (default: `{constants.DEFAULT_EXCHANGE}`). '\n f'Only valid if no config is provided.',\n ),\n \"timeframes\": Arg(\n '-t', '--timeframes',\n help=f'Specify which tickers to download. Space-separated list. '\n f'Default: `{constants.DEFAULT_DOWNLOAD_TICKER_INTERVALS}`.',\n choices=['1m', '3m', '5m', '15m', '30m', '1h', '2h', '4h',\n '6h', '8h', '12h', '1d', '3d', '1w'],\n nargs='+',\n ),\n \"erase\": Arg(\n '--erase',\n help='Clean all existing data for the selected exchange/pairs/timeframes.',\n action='store_true',\n ),\n # Plot dataframe\n \"indicators1\": Arg(\n '--indicators1',\n help='Set indicators from your strategy you want in the first row of the graph. '\n 'Comma-separated list. Example: `ema3,ema5`. Default: `%(default)s`.',\n default='sma,ema3,ema5',\n ),\n \"indicators2\": Arg(\n '--indicators2',\n help='Set indicators from your strategy you want in the third row of the graph. '\n 'Comma-separated list. Example: `fastd,fastk`. Default: `%(default)s`.',\n default='macd,macdsignal',\n ),\n \"plot_limit\": Arg(\n '--plot-limit',\n help='Specify tick limit for plotting. Notice: too high values cause huge files. '\n 'Default: %(default)s.',\n type=check_int_positive,\n metavar='INT',\n default=750,\n ),\n \"trade_source\": Arg(\n '--trade-source',\n help='Specify the source for trades (Can be DB or file (backtest file)) '\n 'Default: %(default)s',\n choices=[\"DB\", \"file\"],\n default=\"file\",\n ),\n}\n", "path": "freqtrade/configuration/cli_options.py"}], "after_files": [{"content": "\"\"\"\nDefinition of cli arguments used in arguments.py\n\"\"\"\nimport argparse\nimport os\n\nfrom freqtrade import __version__, constants\n\n\ndef check_int_positive(value: str) -> int:\n try:\n uint = int(value)\n if uint <= 0:\n raise ValueError\n except ValueError:\n raise argparse.ArgumentTypeError(\n f\"{value} is invalid for this parameter, should be a positive integer value\"\n )\n return uint\n\n\nclass Arg:\n # Optional CLI arguments\n def __init__(self, *args, **kwargs):\n self.cli = args\n self.kwargs = kwargs\n\n\n# List of available command line options\nAVAILABLE_CLI_OPTIONS = {\n # Common options\n \"verbosity\": Arg(\n '-v', '--verbose',\n help='Verbose mode (-vv for more, -vvv to get all messages).',\n action='count',\n default=0,\n ),\n \"logfile\": Arg(\n '--logfile',\n help='Log to the file specified.',\n metavar='FILE',\n ),\n \"version\": Arg(\n '-V', '--version',\n action='version',\n version=f'%(prog)s {__version__}',\n ),\n \"config\": Arg(\n '-c', '--config',\n help=f'Specify configuration file (default: `{constants.DEFAULT_CONFIG}`). '\n f'Multiple --config options may be used. '\n f'Can be set to `-` to read config from stdin.',\n action='append',\n metavar='PATH',\n ),\n \"datadir\": Arg(\n '-d', '--datadir',\n help='Path to backtest data.',\n metavar='PATH',\n ),\n # Main options\n \"strategy\": Arg(\n '-s', '--strategy',\n help='Specify strategy class name (default: `%(default)s`).',\n metavar='NAME',\n default='DefaultStrategy',\n ),\n \"strategy_path\": Arg(\n '--strategy-path',\n help='Specify additional strategy lookup path.',\n metavar='PATH',\n ),\n \"db_url\": Arg(\n '--db-url',\n help=f'Override trades database URL, this is useful in custom deployments '\n f'(default: `{constants.DEFAULT_DB_PROD_URL}` for Live Run mode, '\n f'`{constants.DEFAULT_DB_DRYRUN_URL}` for Dry Run).',\n metavar='PATH',\n ),\n \"sd_notify\": Arg(\n '--sd-notify',\n help='Notify systemd service manager.',\n action='store_true',\n ),\n # Optimize common\n \"ticker_interval\": Arg(\n '-i', '--ticker-interval',\n help='Specify ticker interval (`1m`, `5m`, `30m`, `1h`, `1d`).',\n ),\n \"timerange\": Arg(\n '--timerange',\n help='Specify what timerange of data to use.',\n ),\n \"max_open_trades\": Arg(\n '--max_open_trades',\n help='Specify max_open_trades to use.',\n type=int,\n metavar='INT',\n ),\n \"stake_amount\": Arg(\n '--stake_amount',\n help='Specify stake_amount.',\n type=float,\n ),\n \"refresh_pairs\": Arg(\n '-r', '--refresh-pairs-cached',\n help='Refresh the pairs files in tests/testdata with the latest data from the '\n 'exchange. Use it if you want to run your optimization commands with '\n 'up-to-date data.',\n action='store_true',\n ),\n # Backtesting\n \"position_stacking\": Arg(\n '--eps', '--enable-position-stacking',\n help='Allow buying the same pair multiple times (position stacking).',\n action='store_true',\n default=False,\n ),\n \"use_max_market_positions\": Arg(\n '--dmmp', '--disable-max-market-positions',\n help='Disable applying `max_open_trades` during backtest '\n '(same as setting `max_open_trades` to a very high number).',\n action='store_false',\n default=True,\n ),\n \"live\": Arg(\n '-l', '--live',\n help='Use live data.',\n action='store_true',\n ),\n \"strategy_list\": Arg(\n '--strategy-list',\n help='Provide a space-separated list of strategies to backtest. '\n 'Please note that ticker-interval needs to be set either in config '\n 'or via command line. When using this together with `--export trades`, '\n 'the strategy-name is injected into the filename '\n '(so `backtest-data.json` becomes `backtest-data-DefaultStrategy.json`',\n nargs='+',\n ),\n \"export\": Arg(\n '--export',\n help='Export backtest results, argument are: trades. '\n 'Example: `--export=trades`',\n ),\n \"exportfilename\": Arg(\n '--export-filename',\n help='Save backtest results to the file with this filename (default: `%(default)s`). '\n 'Requires `--export` to be set as well. '\n 'Example: `--export-filename=user_data/backtest_data/backtest_today.json`',\n metavar='PATH',\n default=os.path.join('user_data', 'backtest_data',\n 'backtest-result.json'),\n ),\n # Edge\n \"stoploss_range\": Arg(\n '--stoplosses',\n help='Defines a range of stoploss values against which edge will assess the strategy. '\n 'The format is \"min,max,step\" (without any space). '\n 'Example: `--stoplosses=-0.01,-0.1,-0.001`',\n ),\n # Hyperopt\n \"hyperopt\": Arg(\n '--customhyperopt',\n help='Specify hyperopt class name (default: `%(default)s`).',\n metavar='NAME',\n default=constants.DEFAULT_HYPEROPT,\n ),\n \"hyperopt_path\": Arg(\n '--hyperopt-path',\n help='Specify additional lookup path for Hyperopts and Hyperopt Loss functions.',\n metavar='PATH',\n ),\n \"epochs\": Arg(\n '-e', '--epochs',\n help='Specify number of epochs (default: %(default)d).',\n type=check_int_positive,\n metavar='INT',\n default=constants.HYPEROPT_EPOCH,\n ),\n \"spaces\": Arg(\n '-s', '--spaces',\n help='Specify which parameters to hyperopt. Space-separated list. '\n 'Default: `%(default)s`.',\n choices=['all', 'buy', 'sell', 'roi', 'stoploss'],\n nargs='+',\n default='all',\n ),\n \"print_all\": Arg(\n '--print-all',\n help='Print all results, not only the best ones.',\n action='store_true',\n default=False,\n ),\n \"hyperopt_jobs\": Arg(\n '-j', '--job-workers',\n help='The number of concurrently running jobs for hyperoptimization '\n '(hyperopt worker processes). '\n 'If -1 (default), all CPUs are used, for -2, all CPUs but one are used, etc. '\n 'If 1 is given, no parallel computing code is used at all.',\n type=int,\n metavar='JOBS',\n default=-1,\n ),\n \"hyperopt_random_state\": Arg(\n '--random-state',\n help='Set random state to some positive integer for reproducible hyperopt results.',\n type=check_int_positive,\n metavar='INT',\n ),\n \"hyperopt_min_trades\": Arg(\n '--min-trades',\n help=\"Set minimal desired number of trades for evaluations in the hyperopt \"\n \"optimization path (default: 1).\",\n type=check_int_positive,\n metavar='INT',\n default=1,\n ),\n \"hyperopt_continue\": Arg(\n \"--continue\",\n help=\"Continue hyperopt from previous runs. \"\n \"By default, temporary files will be removed and hyperopt will start from scratch.\",\n default=False,\n action='store_true',\n ),\n \"hyperopt_loss\": Arg(\n '--hyperopt-loss',\n help='Specify the class name of the hyperopt loss function class (IHyperOptLoss). '\n 'Different functions can generate completely different results, '\n 'since the target for optimization is different. (default: `%(default)s`).',\n metavar='NAME',\n default=constants.DEFAULT_HYPEROPT_LOSS,\n ),\n # List exchanges\n \"print_one_column\": Arg(\n '-1', '--one-column',\n help='Print exchanges in one column.',\n action='store_true',\n ),\n # Script options\n \"pairs\": Arg(\n '-p', '--pairs',\n help='Show profits for only these pairs. Pairs are comma-separated.',\n ),\n # Download data\n \"pairs_file\": Arg(\n '--pairs-file',\n help='File containing a list of pairs to download.',\n metavar='FILE',\n ),\n \"days\": Arg(\n '--days',\n help='Download data for given number of days.',\n type=check_int_positive,\n metavar='INT',\n ),\n \"exchange\": Arg(\n '--exchange',\n help=f'Exchange name (default: `{constants.DEFAULT_EXCHANGE}`). '\n f'Only valid if no config is provided.',\n ),\n \"timeframes\": Arg(\n '-t', '--timeframes',\n help=f'Specify which tickers to download. Space-separated list. '\n f'Default: `{constants.DEFAULT_DOWNLOAD_TICKER_INTERVALS}`.',\n choices=['1m', '3m', '5m', '15m', '30m', '1h', '2h', '4h',\n '6h', '8h', '12h', '1d', '3d', '1w'],\n nargs='+',\n ),\n \"erase\": Arg(\n '--erase',\n help='Clean all existing data for the selected exchange/pairs/timeframes.',\n action='store_true',\n ),\n # Plot dataframe\n \"indicators1\": Arg(\n '--indicators1',\n help='Set indicators from your strategy you want in the first row of the graph. '\n 'Comma-separated list. Example: `ema3,ema5`. Default: `%(default)s`.',\n default='sma,ema3,ema5',\n ),\n \"indicators2\": Arg(\n '--indicators2',\n help='Set indicators from your strategy you want in the third row of the graph. '\n 'Comma-separated list. Example: `fastd,fastk`. Default: `%(default)s`.',\n default='macd,macdsignal',\n ),\n \"plot_limit\": Arg(\n '--plot-limit',\n help='Specify tick limit for plotting. Notice: too high values cause huge files. '\n 'Default: %(default)s.',\n type=check_int_positive,\n metavar='INT',\n default=750,\n ),\n \"trade_source\": Arg(\n '--trade-source',\n help='Specify the source for trades (Can be DB or file (backtest file)) '\n 'Default: %(default)s',\n choices=[\"DB\", \"file\"],\n default=\"file\",\n ),\n}\n", "path": "freqtrade/configuration/cli_options.py"}]}
| 3,596 | 145 |
gh_patches_debug_8510
|
rasdani/github-patches
|
git_diff
|
ibis-project__ibis-8417
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
docs: explain you only need to close a conn.raw_sql() if you are running a query that returns results
### Please describe the issue
I was following the advise of https://ibis-project.org/how-to/extending/sql#backend.raw_sql, and closing the returned cursor.
But the actual SQL I was running was an `EXPLAIN SELECT ...` query. I was getting errors, eventually after a lot of headscratching I think I have found that I do NOT want to close the cursor after this query.
Possible actions:
1. be more precise with what sorts of SQL statements require the close.
2. make it so ALL queries require a close, so there is no distinction.
3. UX: make the returned object itself closable, so I don't have to do `from contextlib import closing` and I can just do `with conn.raw_sql(x) as cursor:`
### Code of Conduct
- [X] I agree to follow this project's Code of Conduct
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `ibis/config.py`
Content:
```
1 from __future__ import annotations
2
3 import contextlib
4 from typing import Annotated, Any, Callable, Optional
5
6 from public import public
7
8 import ibis.common.exceptions as com
9 from ibis.common.grounds import Annotable
10 from ibis.common.patterns import Between
11
12 PosInt = Annotated[int, Between(lower=0)]
13
14
15 class Config(Annotable):
16 def get(self, key: str) -> Any:
17 value = self
18 for field in key.split("."):
19 value = getattr(value, field)
20 return value
21
22 def set(self, key: str, value: Any) -> None:
23 *prefix, key = key.split(".")
24 conf = self
25 for field in prefix:
26 conf = getattr(conf, field)
27 setattr(conf, key, value)
28
29 @contextlib.contextmanager
30 def _with_temporary(self, options):
31 try:
32 old = {}
33 for key, value in options.items():
34 old[key] = self.get(key)
35 self.set(key, value)
36 yield
37 finally:
38 for key, value in old.items():
39 self.set(key, value)
40
41 def __call__(self, options):
42 return self._with_temporary(options)
43
44
45 class ContextAdjustment(Config):
46 """Options related to time context adjustment.
47
48 Attributes
49 ----------
50 time_col : str
51 Name of the timestamp column for execution with a `timecontext`. See
52 `ibis/expr/timecontext.py` for details.
53
54 """
55
56 time_col: str = "time"
57
58
59 class SQL(Config):
60 """SQL-related options.
61
62 Attributes
63 ----------
64 default_limit : int | None
65 Number of rows to be retrieved for a table expression without an
66 explicit limit. [](`None`) means no limit.
67 default_dialect : str
68 Dialect to use for printing SQL when the backend cannot be determined.
69
70 """
71
72 default_limit: Optional[PosInt] = None
73 default_dialect: str = "duckdb"
74
75
76 class Interactive(Config):
77 """Options controlling the interactive repr.
78
79 Attributes
80 ----------
81 max_rows : int
82 Maximum rows to pretty print.
83 max_columns : int | None
84 The maximum number of columns to pretty print. If 0 (the default), the
85 number of columns will be inferred from output console size. Set to
86 `None` for no limit.
87 max_length : int
88 Maximum length for pretty-printed arrays and maps.
89 max_string : int
90 Maximum length for pretty-printed strings.
91 max_depth : int
92 Maximum depth for nested data types.
93 show_types : bool
94 Show the inferred type of value expressions in the interactive repr.
95
96 """
97
98 max_rows: int = 10
99 max_columns: Optional[int] = 0
100 max_length: int = 2
101 max_string: int = 80
102 max_depth: int = 1
103 show_types: bool = True
104
105
106 class Repr(Config):
107 """Expression printing options.
108
109 Attributes
110 ----------
111 depth : int
112 The maximum number of expression nodes to print when repring.
113 table_columns : int
114 The number of columns to show in leaf table expressions.
115 table_rows : int
116 The number of rows to show for in memory tables.
117 query_text_length : int
118 The maximum number of characters to show in the `query` field repr of
119 SQLQueryResult operations.
120 show_types : bool
121 Show the inferred type of value expressions in the repr.
122 interactive : bool
123 Options controlling the interactive repr.
124
125 """
126
127 depth: Optional[PosInt] = None
128 table_columns: Optional[PosInt] = None
129 table_rows: PosInt = 10
130 query_text_length: PosInt = 80
131 show_types: bool = False
132 interactive: Interactive = Interactive()
133
134
135 class Options(Config):
136 """Ibis configuration options.
137
138 Attributes
139 ----------
140 interactive : bool
141 Show the first few rows of computing an expression when in a repl.
142 repr : Repr
143 Options controlling expression printing.
144 verbose : bool
145 Run in verbose mode if [](`True`)
146 verbose_log: Callable[[str], None] | None
147 A callable to use when logging.
148 graphviz_repr : bool
149 Render expressions as GraphViz PNGs when running in a Jupyter notebook.
150 default_backend : Optional[ibis.backends.BaseBackend], default None
151 The default backend to use for execution, defaults to DuckDB if not
152 set.
153 context_adjustment : ContextAdjustment
154 Options related to time context adjustment.
155 sql: SQL
156 SQL-related options.
157 clickhouse : Config | None
158 Clickhouse specific options.
159 dask : Config | None
160 Dask specific options.
161 impala : Config | None
162 Impala specific options.
163 pandas : Config | None
164 Pandas specific options.
165 pyspark : Config | None
166 PySpark specific options.
167
168 """
169
170 interactive: bool = False
171 repr: Repr = Repr()
172 verbose: bool = False
173 verbose_log: Optional[Callable] = None
174 graphviz_repr: bool = False
175 default_backend: Optional[Any] = None
176 context_adjustment: ContextAdjustment = ContextAdjustment()
177 sql: SQL = SQL()
178 clickhouse: Optional[Config] = None
179 dask: Optional[Config] = None
180 impala: Optional[Config] = None
181 pandas: Optional[Config] = None
182 pyspark: Optional[Config] = None
183
184
185 def _default_backend() -> Any:
186 if (backend := options.default_backend) is not None:
187 return backend
188
189 try:
190 import duckdb as _ # noqa: F401
191 except ImportError:
192 raise com.IbisError(
193 """\
194 You have used a function that relies on the default backend, but the default
195 backend (DuckDB) is not installed.
196
197 You may specify an alternate backend to use, e.g.
198
199 ibis.set_backend("polars")
200
201 or to install the DuckDB backend, run:
202
203 pip install 'ibis-framework[duckdb]'
204
205 or
206
207 conda install -c conda-forge ibis-framework
208
209 For more information on available backends, visit https://ibis-project.org/install
210 """
211 )
212
213 import ibis
214
215 options.default_backend = con = ibis.duckdb.connect(":memory:")
216 return con
217
218
219 options = Options()
220
221
222 @public
223 def option_context(key, new_value):
224 return options({key: new_value})
225
226
227 public(options=options)
228
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/ibis/config.py b/ibis/config.py
--- a/ibis/config.py
+++ b/ibis/config.py
@@ -147,7 +147,7 @@
A callable to use when logging.
graphviz_repr : bool
Render expressions as GraphViz PNGs when running in a Jupyter notebook.
- default_backend : Optional[ibis.backends.BaseBackend], default None
+ default_backend : Optional[ibis.backends.BaseBackend]
The default backend to use for execution, defaults to DuckDB if not
set.
context_adjustment : ContextAdjustment
|
{"golden_diff": "diff --git a/ibis/config.py b/ibis/config.py\n--- a/ibis/config.py\n+++ b/ibis/config.py\n@@ -147,7 +147,7 @@\n A callable to use when logging.\n graphviz_repr : bool\n Render expressions as GraphViz PNGs when running in a Jupyter notebook.\n- default_backend : Optional[ibis.backends.BaseBackend], default None\n+ default_backend : Optional[ibis.backends.BaseBackend]\n The default backend to use for execution, defaults to DuckDB if not\n set.\n context_adjustment : ContextAdjustment\n", "issue": "docs: explain you only need to close a conn.raw_sql() if you are running a query that returns results\n### Please describe the issue\n\nI was following the advise of https://ibis-project.org/how-to/extending/sql#backend.raw_sql, and closing the returned cursor.\r\n\r\nBut the actual SQL I was running was an `EXPLAIN SELECT ...` query. I was getting errors, eventually after a lot of headscratching I think I have found that I do NOT want to close the cursor after this query.\r\n\r\nPossible actions:\r\n1. be more precise with what sorts of SQL statements require the close.\r\n2. make it so ALL queries require a close, so there is no distinction.\r\n3. UX: make the returned object itself closable, so I don't have to do `from contextlib import closing` and I can just do `with conn.raw_sql(x) as cursor:`\n\n### Code of Conduct\n\n- [X] I agree to follow this project's Code of Conduct\n", "before_files": [{"content": "from __future__ import annotations\n\nimport contextlib\nfrom typing import Annotated, Any, Callable, Optional\n\nfrom public import public\n\nimport ibis.common.exceptions as com\nfrom ibis.common.grounds import Annotable\nfrom ibis.common.patterns import Between\n\nPosInt = Annotated[int, Between(lower=0)]\n\n\nclass Config(Annotable):\n def get(self, key: str) -> Any:\n value = self\n for field in key.split(\".\"):\n value = getattr(value, field)\n return value\n\n def set(self, key: str, value: Any) -> None:\n *prefix, key = key.split(\".\")\n conf = self\n for field in prefix:\n conf = getattr(conf, field)\n setattr(conf, key, value)\n\n @contextlib.contextmanager\n def _with_temporary(self, options):\n try:\n old = {}\n for key, value in options.items():\n old[key] = self.get(key)\n self.set(key, value)\n yield\n finally:\n for key, value in old.items():\n self.set(key, value)\n\n def __call__(self, options):\n return self._with_temporary(options)\n\n\nclass ContextAdjustment(Config):\n \"\"\"Options related to time context adjustment.\n\n Attributes\n ----------\n time_col : str\n Name of the timestamp column for execution with a `timecontext`. See\n `ibis/expr/timecontext.py` for details.\n\n \"\"\"\n\n time_col: str = \"time\"\n\n\nclass SQL(Config):\n \"\"\"SQL-related options.\n\n Attributes\n ----------\n default_limit : int | None\n Number of rows to be retrieved for a table expression without an\n explicit limit. [](`None`) means no limit.\n default_dialect : str\n Dialect to use for printing SQL when the backend cannot be determined.\n\n \"\"\"\n\n default_limit: Optional[PosInt] = None\n default_dialect: str = \"duckdb\"\n\n\nclass Interactive(Config):\n \"\"\"Options controlling the interactive repr.\n\n Attributes\n ----------\n max_rows : int\n Maximum rows to pretty print.\n max_columns : int | None\n The maximum number of columns to pretty print. If 0 (the default), the\n number of columns will be inferred from output console size. Set to\n `None` for no limit.\n max_length : int\n Maximum length for pretty-printed arrays and maps.\n max_string : int\n Maximum length for pretty-printed strings.\n max_depth : int\n Maximum depth for nested data types.\n show_types : bool\n Show the inferred type of value expressions in the interactive repr.\n\n \"\"\"\n\n max_rows: int = 10\n max_columns: Optional[int] = 0\n max_length: int = 2\n max_string: int = 80\n max_depth: int = 1\n show_types: bool = True\n\n\nclass Repr(Config):\n \"\"\"Expression printing options.\n\n Attributes\n ----------\n depth : int\n The maximum number of expression nodes to print when repring.\n table_columns : int\n The number of columns to show in leaf table expressions.\n table_rows : int\n The number of rows to show for in memory tables.\n query_text_length : int\n The maximum number of characters to show in the `query` field repr of\n SQLQueryResult operations.\n show_types : bool\n Show the inferred type of value expressions in the repr.\n interactive : bool\n Options controlling the interactive repr.\n\n \"\"\"\n\n depth: Optional[PosInt] = None\n table_columns: Optional[PosInt] = None\n table_rows: PosInt = 10\n query_text_length: PosInt = 80\n show_types: bool = False\n interactive: Interactive = Interactive()\n\n\nclass Options(Config):\n \"\"\"Ibis configuration options.\n\n Attributes\n ----------\n interactive : bool\n Show the first few rows of computing an expression when in a repl.\n repr : Repr\n Options controlling expression printing.\n verbose : bool\n Run in verbose mode if [](`True`)\n verbose_log: Callable[[str], None] | None\n A callable to use when logging.\n graphviz_repr : bool\n Render expressions as GraphViz PNGs when running in a Jupyter notebook.\n default_backend : Optional[ibis.backends.BaseBackend], default None\n The default backend to use for execution, defaults to DuckDB if not\n set.\n context_adjustment : ContextAdjustment\n Options related to time context adjustment.\n sql: SQL\n SQL-related options.\n clickhouse : Config | None\n Clickhouse specific options.\n dask : Config | None\n Dask specific options.\n impala : Config | None\n Impala specific options.\n pandas : Config | None\n Pandas specific options.\n pyspark : Config | None\n PySpark specific options.\n\n \"\"\"\n\n interactive: bool = False\n repr: Repr = Repr()\n verbose: bool = False\n verbose_log: Optional[Callable] = None\n graphviz_repr: bool = False\n default_backend: Optional[Any] = None\n context_adjustment: ContextAdjustment = ContextAdjustment()\n sql: SQL = SQL()\n clickhouse: Optional[Config] = None\n dask: Optional[Config] = None\n impala: Optional[Config] = None\n pandas: Optional[Config] = None\n pyspark: Optional[Config] = None\n\n\ndef _default_backend() -> Any:\n if (backend := options.default_backend) is not None:\n return backend\n\n try:\n import duckdb as _ # noqa: F401\n except ImportError:\n raise com.IbisError(\n \"\"\"\\\nYou have used a function that relies on the default backend, but the default\nbackend (DuckDB) is not installed.\n\nYou may specify an alternate backend to use, e.g.\n\nibis.set_backend(\"polars\")\n\nor to install the DuckDB backend, run:\n\n pip install 'ibis-framework[duckdb]'\n\nor\n\n conda install -c conda-forge ibis-framework\n\nFor more information on available backends, visit https://ibis-project.org/install\n\"\"\"\n )\n\n import ibis\n\n options.default_backend = con = ibis.duckdb.connect(\":memory:\")\n return con\n\n\noptions = Options()\n\n\n@public\ndef option_context(key, new_value):\n return options({key: new_value})\n\n\npublic(options=options)\n", "path": "ibis/config.py"}], "after_files": [{"content": "from __future__ import annotations\n\nimport contextlib\nfrom typing import Annotated, Any, Callable, Optional\n\nfrom public import public\n\nimport ibis.common.exceptions as com\nfrom ibis.common.grounds import Annotable\nfrom ibis.common.patterns import Between\n\nPosInt = Annotated[int, Between(lower=0)]\n\n\nclass Config(Annotable):\n def get(self, key: str) -> Any:\n value = self\n for field in key.split(\".\"):\n value = getattr(value, field)\n return value\n\n def set(self, key: str, value: Any) -> None:\n *prefix, key = key.split(\".\")\n conf = self\n for field in prefix:\n conf = getattr(conf, field)\n setattr(conf, key, value)\n\n @contextlib.contextmanager\n def _with_temporary(self, options):\n try:\n old = {}\n for key, value in options.items():\n old[key] = self.get(key)\n self.set(key, value)\n yield\n finally:\n for key, value in old.items():\n self.set(key, value)\n\n def __call__(self, options):\n return self._with_temporary(options)\n\n\nclass ContextAdjustment(Config):\n \"\"\"Options related to time context adjustment.\n\n Attributes\n ----------\n time_col : str\n Name of the timestamp column for execution with a `timecontext`. See\n `ibis/expr/timecontext.py` for details.\n\n \"\"\"\n\n time_col: str = \"time\"\n\n\nclass SQL(Config):\n \"\"\"SQL-related options.\n\n Attributes\n ----------\n default_limit : int | None\n Number of rows to be retrieved for a table expression without an\n explicit limit. [](`None`) means no limit.\n default_dialect : str\n Dialect to use for printing SQL when the backend cannot be determined.\n\n \"\"\"\n\n default_limit: Optional[PosInt] = None\n default_dialect: str = \"duckdb\"\n\n\nclass Interactive(Config):\n \"\"\"Options controlling the interactive repr.\n\n Attributes\n ----------\n max_rows : int\n Maximum rows to pretty print.\n max_columns : int | None\n The maximum number of columns to pretty print. If 0 (the default), the\n number of columns will be inferred from output console size. Set to\n `None` for no limit.\n max_length : int\n Maximum length for pretty-printed arrays and maps.\n max_string : int\n Maximum length for pretty-printed strings.\n max_depth : int\n Maximum depth for nested data types.\n show_types : bool\n Show the inferred type of value expressions in the interactive repr.\n\n \"\"\"\n\n max_rows: int = 10\n max_columns: Optional[int] = 0\n max_length: int = 2\n max_string: int = 80\n max_depth: int = 1\n show_types: bool = True\n\n\nclass Repr(Config):\n \"\"\"Expression printing options.\n\n Attributes\n ----------\n depth : int\n The maximum number of expression nodes to print when repring.\n table_columns : int\n The number of columns to show in leaf table expressions.\n table_rows : int\n The number of rows to show for in memory tables.\n query_text_length : int\n The maximum number of characters to show in the `query` field repr of\n SQLQueryResult operations.\n show_types : bool\n Show the inferred type of value expressions in the repr.\n interactive : bool\n Options controlling the interactive repr.\n\n \"\"\"\n\n depth: Optional[PosInt] = None\n table_columns: Optional[PosInt] = None\n table_rows: PosInt = 10\n query_text_length: PosInt = 80\n show_types: bool = False\n interactive: Interactive = Interactive()\n\n\nclass Options(Config):\n \"\"\"Ibis configuration options.\n\n Attributes\n ----------\n interactive : bool\n Show the first few rows of computing an expression when in a repl.\n repr : Repr\n Options controlling expression printing.\n verbose : bool\n Run in verbose mode if [](`True`)\n verbose_log: Callable[[str], None] | None\n A callable to use when logging.\n graphviz_repr : bool\n Render expressions as GraphViz PNGs when running in a Jupyter notebook.\n default_backend : Optional[ibis.backends.BaseBackend]\n The default backend to use for execution, defaults to DuckDB if not\n set.\n context_adjustment : ContextAdjustment\n Options related to time context adjustment.\n sql: SQL\n SQL-related options.\n clickhouse : Config | None\n Clickhouse specific options.\n dask : Config | None\n Dask specific options.\n impala : Config | None\n Impala specific options.\n pandas : Config | None\n Pandas specific options.\n pyspark : Config | None\n PySpark specific options.\n\n \"\"\"\n\n interactive: bool = False\n repr: Repr = Repr()\n verbose: bool = False\n verbose_log: Optional[Callable] = None\n graphviz_repr: bool = False\n default_backend: Optional[Any] = None\n context_adjustment: ContextAdjustment = ContextAdjustment()\n sql: SQL = SQL()\n clickhouse: Optional[Config] = None\n dask: Optional[Config] = None\n impala: Optional[Config] = None\n pandas: Optional[Config] = None\n pyspark: Optional[Config] = None\n\n\ndef _default_backend() -> Any:\n if (backend := options.default_backend) is not None:\n return backend\n\n try:\n import duckdb as _ # noqa: F401\n except ImportError:\n raise com.IbisError(\n \"\"\"\\\nYou have used a function that relies on the default backend, but the default\nbackend (DuckDB) is not installed.\n\nYou may specify an alternate backend to use, e.g.\n\nibis.set_backend(\"polars\")\n\nor to install the DuckDB backend, run:\n\n pip install 'ibis-framework[duckdb]'\n\nor\n\n conda install -c conda-forge ibis-framework\n\nFor more information on available backends, visit https://ibis-project.org/install\n\"\"\"\n )\n\n import ibis\n\n options.default_backend = con = ibis.duckdb.connect(\":memory:\")\n return con\n\n\noptions = Options()\n\n\n@public\ndef option_context(key, new_value):\n return options({key: new_value})\n\n\npublic(options=options)\n", "path": "ibis/config.py"}]}
| 2,482 | 135 |
gh_patches_debug_1846
|
rasdani/github-patches
|
git_diff
|
liqd__a4-meinberlin-2082
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
dashboard: district "gesamtstädtisch" ist ---
in dashboard the default district is "---" and should be changed to "Gesamtstädtisch"
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `meinberlin/apps/projects/forms.py`
Content:
```
1 from django import forms
2 from django.conf import settings
3 from django.contrib.auth import get_user_model
4 from django.core.exceptions import ValidationError
5 from django.utils.translation import ugettext_lazy as _
6
7 from adhocracy4.dashboard.forms import ProjectDashboardForm
8 from adhocracy4.maps import widgets as maps_widgets
9 from adhocracy4.projects.models import Project
10 from meinberlin.apps.users import fields as user_fields
11
12 from .models import ModeratorInvite
13 from .models import ParticipantInvite
14
15 User = get_user_model()
16
17
18 class InviteForm(forms.ModelForm):
19 accept = forms.CharField(required=False)
20 reject = forms.CharField(required=False)
21
22 def clean(self):
23 data = self.data
24 if 'accept' not in data and 'reject' not in data:
25 raise ValidationError('Reject or accept')
26 return data
27
28 def is_accepted(self):
29 data = self.data
30 return 'accept' in data and 'reject' not in data
31
32
33 class ParticipantInviteForm(InviteForm):
34
35 class Meta:
36 model = ParticipantInvite
37 fields = ['accept', 'reject']
38
39
40 class ModeratorInviteForm(InviteForm):
41
42 class Meta:
43 model = ModeratorInvite
44 fields = ['accept', 'reject']
45
46
47 class InviteUsersFromEmailForm(forms.Form):
48 add_users = user_fields.CommaSeparatedEmailField(
49 required=False,
50 label=_('Invite users via email')
51 )
52
53 add_users_upload = user_fields.EmailFileField(
54 required=False,
55 label=_('Invite users via file upload'),
56 help_text=_('Upload a csv file containing email addresses.')
57 )
58
59 def __init__(self, *args, **kwargs):
60 labels = kwargs.pop('labels', None)
61 super().__init__(*args, **kwargs)
62
63 if labels:
64 self.fields['add_users'].label = labels[0]
65 self.fields['add_users_upload'].label = labels[1]
66
67 def clean(self):
68 cleaned_data = super().clean()
69 add_users = self.data.get('add_users')
70 add_users_upload = self.files.get('add_users_upload')
71 if not self.errors and not add_users and not add_users_upload:
72 raise ValidationError(
73 _('Please enter email addresses or upload a file'))
74 return cleaned_data
75
76
77 class TopicForm(ProjectDashboardForm):
78
79 class Meta:
80 model = Project
81 fields = ['topics']
82 required_for_project_publish = ['topics']
83
84
85 class PointForm(ProjectDashboardForm):
86
87 class Meta:
88 model = Project
89 fields = ['administrative_district', 'point']
90 required_for_project_publish = []
91 widgets = {
92 'point': maps_widgets.MapChoosePointWidget(
93 polygon=settings.BERLIN_POLYGON)
94 }
95
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/meinberlin/apps/projects/forms.py b/meinberlin/apps/projects/forms.py
--- a/meinberlin/apps/projects/forms.py
+++ b/meinberlin/apps/projects/forms.py
@@ -92,3 +92,7 @@
'point': maps_widgets.MapChoosePointWidget(
polygon=settings.BERLIN_POLYGON)
}
+
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ self.fields['administrative_district'].empty_label = _('City wide')
|
{"golden_diff": "diff --git a/meinberlin/apps/projects/forms.py b/meinberlin/apps/projects/forms.py\n--- a/meinberlin/apps/projects/forms.py\n+++ b/meinberlin/apps/projects/forms.py\n@@ -92,3 +92,7 @@\n 'point': maps_widgets.MapChoosePointWidget(\n polygon=settings.BERLIN_POLYGON)\n }\n+\n+ def __init__(self, *args, **kwargs):\n+ super().__init__(*args, **kwargs)\n+ self.fields['administrative_district'].empty_label = _('City wide')\n", "issue": "dashboard: district \"gesamtst\u00e4dtisch\" ist ---\nin dashboard the default district is \"---\" and should be changed to \"Gesamtst\u00e4dtisch\"\n", "before_files": [{"content": "from django import forms\nfrom django.conf import settings\nfrom django.contrib.auth import get_user_model\nfrom django.core.exceptions import ValidationError\nfrom django.utils.translation import ugettext_lazy as _\n\nfrom adhocracy4.dashboard.forms import ProjectDashboardForm\nfrom adhocracy4.maps import widgets as maps_widgets\nfrom adhocracy4.projects.models import Project\nfrom meinberlin.apps.users import fields as user_fields\n\nfrom .models import ModeratorInvite\nfrom .models import ParticipantInvite\n\nUser = get_user_model()\n\n\nclass InviteForm(forms.ModelForm):\n accept = forms.CharField(required=False)\n reject = forms.CharField(required=False)\n\n def clean(self):\n data = self.data\n if 'accept' not in data and 'reject' not in data:\n raise ValidationError('Reject or accept')\n return data\n\n def is_accepted(self):\n data = self.data\n return 'accept' in data and 'reject' not in data\n\n\nclass ParticipantInviteForm(InviteForm):\n\n class Meta:\n model = ParticipantInvite\n fields = ['accept', 'reject']\n\n\nclass ModeratorInviteForm(InviteForm):\n\n class Meta:\n model = ModeratorInvite\n fields = ['accept', 'reject']\n\n\nclass InviteUsersFromEmailForm(forms.Form):\n add_users = user_fields.CommaSeparatedEmailField(\n required=False,\n label=_('Invite users via email')\n )\n\n add_users_upload = user_fields.EmailFileField(\n required=False,\n label=_('Invite users via file upload'),\n help_text=_('Upload a csv file containing email addresses.')\n )\n\n def __init__(self, *args, **kwargs):\n labels = kwargs.pop('labels', None)\n super().__init__(*args, **kwargs)\n\n if labels:\n self.fields['add_users'].label = labels[0]\n self.fields['add_users_upload'].label = labels[1]\n\n def clean(self):\n cleaned_data = super().clean()\n add_users = self.data.get('add_users')\n add_users_upload = self.files.get('add_users_upload')\n if not self.errors and not add_users and not add_users_upload:\n raise ValidationError(\n _('Please enter email addresses or upload a file'))\n return cleaned_data\n\n\nclass TopicForm(ProjectDashboardForm):\n\n class Meta:\n model = Project\n fields = ['topics']\n required_for_project_publish = ['topics']\n\n\nclass PointForm(ProjectDashboardForm):\n\n class Meta:\n model = Project\n fields = ['administrative_district', 'point']\n required_for_project_publish = []\n widgets = {\n 'point': maps_widgets.MapChoosePointWidget(\n polygon=settings.BERLIN_POLYGON)\n }\n", "path": "meinberlin/apps/projects/forms.py"}], "after_files": [{"content": "from django import forms\nfrom django.conf import settings\nfrom django.contrib.auth import get_user_model\nfrom django.core.exceptions import ValidationError\nfrom django.utils.translation import ugettext_lazy as _\n\nfrom adhocracy4.dashboard.forms import ProjectDashboardForm\nfrom adhocracy4.maps import widgets as maps_widgets\nfrom adhocracy4.projects.models import Project\nfrom meinberlin.apps.users import fields as user_fields\n\nfrom .models import ModeratorInvite\nfrom .models import ParticipantInvite\n\nUser = get_user_model()\n\n\nclass InviteForm(forms.ModelForm):\n accept = forms.CharField(required=False)\n reject = forms.CharField(required=False)\n\n def clean(self):\n data = self.data\n if 'accept' not in data and 'reject' not in data:\n raise ValidationError('Reject or accept')\n return data\n\n def is_accepted(self):\n data = self.data\n return 'accept' in data and 'reject' not in data\n\n\nclass ParticipantInviteForm(InviteForm):\n\n class Meta:\n model = ParticipantInvite\n fields = ['accept', 'reject']\n\n\nclass ModeratorInviteForm(InviteForm):\n\n class Meta:\n model = ModeratorInvite\n fields = ['accept', 'reject']\n\n\nclass InviteUsersFromEmailForm(forms.Form):\n add_users = user_fields.CommaSeparatedEmailField(\n required=False,\n label=_('Invite users via email')\n )\n\n add_users_upload = user_fields.EmailFileField(\n required=False,\n label=_('Invite users via file upload'),\n help_text=_('Upload a csv file containing email addresses.')\n )\n\n def __init__(self, *args, **kwargs):\n labels = kwargs.pop('labels', None)\n super().__init__(*args, **kwargs)\n\n if labels:\n self.fields['add_users'].label = labels[0]\n self.fields['add_users_upload'].label = labels[1]\n\n def clean(self):\n cleaned_data = super().clean()\n add_users = self.data.get('add_users')\n add_users_upload = self.files.get('add_users_upload')\n if not self.errors and not add_users and not add_users_upload:\n raise ValidationError(\n _('Please enter email addresses or upload a file'))\n return cleaned_data\n\n\nclass TopicForm(ProjectDashboardForm):\n\n class Meta:\n model = Project\n fields = ['topics']\n required_for_project_publish = ['topics']\n\n\nclass PointForm(ProjectDashboardForm):\n\n class Meta:\n model = Project\n fields = ['administrative_district', 'point']\n required_for_project_publish = []\n widgets = {\n 'point': maps_widgets.MapChoosePointWidget(\n polygon=settings.BERLIN_POLYGON)\n }\n\n def __init__(self, *args, **kwargs):\n super().__init__(*args, **kwargs)\n self.fields['administrative_district'].empty_label = _('City wide')\n", "path": "meinberlin/apps/projects/forms.py"}]}
| 1,046 | 120 |
gh_patches_debug_8690
|
rasdani/github-patches
|
git_diff
|
urllib3__urllib3-2379
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Collect mypy requirements in their own file
We currently install mypy dependencies one by one:
https://github.com/urllib3/urllib3/blob/0a4839af7103e9ad71d26bf5ba7914e765577efe/noxfile.py#L162-L169
It was fine initially, but we currently install 8 dependencies that way. That's slower than necessary and isn't a format tools like dependabot can understand.
Instead, put those dependencies in a file called `mypy-requirements.txt` and install them just like we install dev-requirements.txt:
https://github.com/urllib3/urllib3/blob/0a4839af7103e9ad71d26bf5ba7914e765577efe/noxfile.py#L23
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `noxfile.py`
Content:
```
1 import os
2 import shutil
3 import subprocess
4
5 import nox
6
7 SOURCE_FILES = [
8 "docs/",
9 "dummyserver/",
10 "src/",
11 "test/",
12 "noxfile.py",
13 "setup.py",
14 ]
15
16
17 def tests_impl(
18 session: nox.Session,
19 extras: str = "socks,secure,brotli",
20 byte_string_comparisons: bool = True,
21 ) -> None:
22 # Install deps and the package itself.
23 session.install("-r", "dev-requirements.txt")
24 session.install(f".[{extras}]")
25
26 # Show the pip version.
27 session.run("pip", "--version")
28 # Print the Python version and bytesize.
29 session.run("python", "--version")
30 session.run("python", "-c", "import struct; print(struct.calcsize('P') * 8)")
31 # Print OpenSSL information.
32 session.run("python", "-m", "OpenSSL.debug")
33
34 # Inspired from https://github.com/pyca/cryptography
35 # We use parallel mode and then combine here so that coverage.py will take
36 # the paths like .tox/pyXY/lib/pythonX.Y/site-packages/urllib3/__init__.py
37 # and collapse them into src/urllib3/__init__.py.
38
39 session.run(
40 "python",
41 *(("-bb",) if byte_string_comparisons else ()),
42 "-m",
43 "coverage",
44 "run",
45 "--parallel-mode",
46 "-m",
47 "pytest",
48 "-r",
49 "a",
50 "--tb=native",
51 "--no-success-flaky-report",
52 *(session.posargs or ("test/",)),
53 env={"PYTHONWARNINGS": "always::DeprecationWarning"},
54 )
55 session.run("coverage", "combine")
56 session.run("coverage", "report", "-m")
57 session.run("coverage", "xml")
58
59
60 @nox.session(python=["3.7", "3.8", "3.9", "3.10", "pypy"])
61 def test(session: nox.Session) -> None:
62 tests_impl(session)
63
64
65 @nox.session(python=["2.7"])
66 def unsupported_python2(session: nox.Session) -> None:
67 # Can't check both returncode and output with session.run
68 process = subprocess.run(
69 ["python", "setup.py", "install"],
70 env={**session.env},
71 text=True,
72 capture_output=True,
73 )
74 assert process.returncode == 1
75 print(process.stderr)
76 assert "Unsupported Python version" in process.stderr
77
78
79 @nox.session(python=["3"])
80 def test_brotlipy(session: nox.Session) -> None:
81 """Check that if 'brotlipy' is installed instead of 'brotli' or
82 'brotlicffi' that we still don't blow up.
83 """
84 session.install("brotlipy")
85 tests_impl(session, extras="socks,secure", byte_string_comparisons=False)
86
87
88 def git_clone(session: nox.Session, git_url: str) -> None:
89 session.run("git", "clone", "--depth", "1", git_url, external=True)
90
91
92 @nox.session()
93 def downstream_botocore(session: nox.Session) -> None:
94 root = os.getcwd()
95 tmp_dir = session.create_tmp()
96
97 session.cd(tmp_dir)
98 git_clone(session, "https://github.com/boto/botocore")
99 session.chdir("botocore")
100 session.run("git", "rev-parse", "HEAD", external=True)
101 session.run("python", "scripts/ci/install")
102
103 session.cd(root)
104 session.install(".", silent=False)
105 session.cd(f"{tmp_dir}/botocore")
106
107 session.run("python", "-c", "import urllib3; print(urllib3.__version__)")
108 session.run("python", "scripts/ci/run-tests")
109
110
111 @nox.session()
112 def downstream_requests(session: nox.Session) -> None:
113 root = os.getcwd()
114 tmp_dir = session.create_tmp()
115
116 session.cd(tmp_dir)
117 git_clone(session, "https://github.com/psf/requests")
118 session.chdir("requests")
119 session.run("git", "apply", f"{root}/ci/requests.patch", external=True)
120 session.run("git", "rev-parse", "HEAD", external=True)
121 session.install(".[socks]", silent=False)
122 session.install("-r", "requirements-dev.txt", silent=False)
123
124 session.cd(root)
125 session.install(".", silent=False)
126 session.cd(f"{tmp_dir}/requests")
127
128 session.run("python", "-c", "import urllib3; print(urllib3.__version__)")
129 session.run("pytest", "tests")
130
131
132 @nox.session()
133 def format(session: nox.Session) -> None:
134 """Run code formatters."""
135 session.install("pre-commit")
136 session.run("pre-commit", "--version")
137
138 process = subprocess.run(
139 ["pre-commit", "run", "--all-files"],
140 env=session.env,
141 text=True,
142 stdout=subprocess.PIPE,
143 stderr=subprocess.STDOUT,
144 )
145 # Ensure that pre-commit itself ran successfully
146 assert process.returncode in (0, 1)
147
148 lint(session)
149
150
151 @nox.session
152 def lint(session: nox.Session) -> None:
153 session.install("pre-commit")
154 session.run("pre-commit", "run", "--all-files")
155
156 mypy(session)
157
158
159 @nox.session(python="3.8")
160 def mypy(session: nox.Session) -> None:
161 """Run mypy."""
162 session.install("mypy==0.910")
163 session.install("idna>=2.0.0")
164 session.install("cryptography>=1.3.4")
165 session.install("tornado>=6.1")
166 session.install("pytest>=6.2")
167 session.install("trustme==0.9.0")
168 session.install("types-python-dateutil")
169 session.install("nox")
170 session.run("mypy", "--version")
171 session.run(
172 "mypy",
173 "src/urllib3",
174 "dummyserver",
175 "noxfile.py",
176 "test/__init__.py",
177 "test/conftest.py",
178 "test/port_helpers.py",
179 "test/test_retry.py",
180 "test/test_wait.py",
181 "test/tz_stub.py",
182 )
183
184
185 @nox.session
186 def docs(session: nox.Session) -> None:
187 session.install("-r", "docs/requirements.txt")
188 session.install(".[socks,secure,brotli]")
189
190 session.chdir("docs")
191 if os.path.exists("_build"):
192 shutil.rmtree("_build")
193 session.run("sphinx-build", "-b", "html", "-W", ".", "_build/html")
194
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/noxfile.py b/noxfile.py
--- a/noxfile.py
+++ b/noxfile.py
@@ -159,14 +159,7 @@
@nox.session(python="3.8")
def mypy(session: nox.Session) -> None:
"""Run mypy."""
- session.install("mypy==0.910")
- session.install("idna>=2.0.0")
- session.install("cryptography>=1.3.4")
- session.install("tornado>=6.1")
- session.install("pytest>=6.2")
- session.install("trustme==0.9.0")
- session.install("types-python-dateutil")
- session.install("nox")
+ session.install("-r", "mypy-requirements.txt")
session.run("mypy", "--version")
session.run(
"mypy",
|
{"golden_diff": "diff --git a/noxfile.py b/noxfile.py\n--- a/noxfile.py\n+++ b/noxfile.py\n@@ -159,14 +159,7 @@\n @nox.session(python=\"3.8\")\n def mypy(session: nox.Session) -> None:\n \"\"\"Run mypy.\"\"\"\n- session.install(\"mypy==0.910\")\n- session.install(\"idna>=2.0.0\")\n- session.install(\"cryptography>=1.3.4\")\n- session.install(\"tornado>=6.1\")\n- session.install(\"pytest>=6.2\")\n- session.install(\"trustme==0.9.0\")\n- session.install(\"types-python-dateutil\")\n- session.install(\"nox\")\n+ session.install(\"-r\", \"mypy-requirements.txt\")\n session.run(\"mypy\", \"--version\")\n session.run(\n \"mypy\",\n", "issue": "Collect mypy requirements in their own file\nWe currently install mypy dependencies one by one:\r\n\r\nhttps://github.com/urllib3/urllib3/blob/0a4839af7103e9ad71d26bf5ba7914e765577efe/noxfile.py#L162-L169\r\n\r\nIt was fine initially, but we currently install 8 dependencies that way. That's slower than necessary and isn't a format tools like dependabot can understand.\r\n\r\nInstead, put those dependencies in a file called `mypy-requirements.txt` and install them just like we install dev-requirements.txt:\r\n\r\nhttps://github.com/urllib3/urllib3/blob/0a4839af7103e9ad71d26bf5ba7914e765577efe/noxfile.py#L23\n", "before_files": [{"content": "import os\nimport shutil\nimport subprocess\n\nimport nox\n\nSOURCE_FILES = [\n \"docs/\",\n \"dummyserver/\",\n \"src/\",\n \"test/\",\n \"noxfile.py\",\n \"setup.py\",\n]\n\n\ndef tests_impl(\n session: nox.Session,\n extras: str = \"socks,secure,brotli\",\n byte_string_comparisons: bool = True,\n) -> None:\n # Install deps and the package itself.\n session.install(\"-r\", \"dev-requirements.txt\")\n session.install(f\".[{extras}]\")\n\n # Show the pip version.\n session.run(\"pip\", \"--version\")\n # Print the Python version and bytesize.\n session.run(\"python\", \"--version\")\n session.run(\"python\", \"-c\", \"import struct; print(struct.calcsize('P') * 8)\")\n # Print OpenSSL information.\n session.run(\"python\", \"-m\", \"OpenSSL.debug\")\n\n # Inspired from https://github.com/pyca/cryptography\n # We use parallel mode and then combine here so that coverage.py will take\n # the paths like .tox/pyXY/lib/pythonX.Y/site-packages/urllib3/__init__.py\n # and collapse them into src/urllib3/__init__.py.\n\n session.run(\n \"python\",\n *((\"-bb\",) if byte_string_comparisons else ()),\n \"-m\",\n \"coverage\",\n \"run\",\n \"--parallel-mode\",\n \"-m\",\n \"pytest\",\n \"-r\",\n \"a\",\n \"--tb=native\",\n \"--no-success-flaky-report\",\n *(session.posargs or (\"test/\",)),\n env={\"PYTHONWARNINGS\": \"always::DeprecationWarning\"},\n )\n session.run(\"coverage\", \"combine\")\n session.run(\"coverage\", \"report\", \"-m\")\n session.run(\"coverage\", \"xml\")\n\n\[email protected](python=[\"3.7\", \"3.8\", \"3.9\", \"3.10\", \"pypy\"])\ndef test(session: nox.Session) -> None:\n tests_impl(session)\n\n\[email protected](python=[\"2.7\"])\ndef unsupported_python2(session: nox.Session) -> None:\n # Can't check both returncode and output with session.run\n process = subprocess.run(\n [\"python\", \"setup.py\", \"install\"],\n env={**session.env},\n text=True,\n capture_output=True,\n )\n assert process.returncode == 1\n print(process.stderr)\n assert \"Unsupported Python version\" in process.stderr\n\n\[email protected](python=[\"3\"])\ndef test_brotlipy(session: nox.Session) -> None:\n \"\"\"Check that if 'brotlipy' is installed instead of 'brotli' or\n 'brotlicffi' that we still don't blow up.\n \"\"\"\n session.install(\"brotlipy\")\n tests_impl(session, extras=\"socks,secure\", byte_string_comparisons=False)\n\n\ndef git_clone(session: nox.Session, git_url: str) -> None:\n session.run(\"git\", \"clone\", \"--depth\", \"1\", git_url, external=True)\n\n\[email protected]()\ndef downstream_botocore(session: nox.Session) -> None:\n root = os.getcwd()\n tmp_dir = session.create_tmp()\n\n session.cd(tmp_dir)\n git_clone(session, \"https://github.com/boto/botocore\")\n session.chdir(\"botocore\")\n session.run(\"git\", \"rev-parse\", \"HEAD\", external=True)\n session.run(\"python\", \"scripts/ci/install\")\n\n session.cd(root)\n session.install(\".\", silent=False)\n session.cd(f\"{tmp_dir}/botocore\")\n\n session.run(\"python\", \"-c\", \"import urllib3; print(urllib3.__version__)\")\n session.run(\"python\", \"scripts/ci/run-tests\")\n\n\[email protected]()\ndef downstream_requests(session: nox.Session) -> None:\n root = os.getcwd()\n tmp_dir = session.create_tmp()\n\n session.cd(tmp_dir)\n git_clone(session, \"https://github.com/psf/requests\")\n session.chdir(\"requests\")\n session.run(\"git\", \"apply\", f\"{root}/ci/requests.patch\", external=True)\n session.run(\"git\", \"rev-parse\", \"HEAD\", external=True)\n session.install(\".[socks]\", silent=False)\n session.install(\"-r\", \"requirements-dev.txt\", silent=False)\n\n session.cd(root)\n session.install(\".\", silent=False)\n session.cd(f\"{tmp_dir}/requests\")\n\n session.run(\"python\", \"-c\", \"import urllib3; print(urllib3.__version__)\")\n session.run(\"pytest\", \"tests\")\n\n\[email protected]()\ndef format(session: nox.Session) -> None:\n \"\"\"Run code formatters.\"\"\"\n session.install(\"pre-commit\")\n session.run(\"pre-commit\", \"--version\")\n\n process = subprocess.run(\n [\"pre-commit\", \"run\", \"--all-files\"],\n env=session.env,\n text=True,\n stdout=subprocess.PIPE,\n stderr=subprocess.STDOUT,\n )\n # Ensure that pre-commit itself ran successfully\n assert process.returncode in (0, 1)\n\n lint(session)\n\n\[email protected]\ndef lint(session: nox.Session) -> None:\n session.install(\"pre-commit\")\n session.run(\"pre-commit\", \"run\", \"--all-files\")\n\n mypy(session)\n\n\[email protected](python=\"3.8\")\ndef mypy(session: nox.Session) -> None:\n \"\"\"Run mypy.\"\"\"\n session.install(\"mypy==0.910\")\n session.install(\"idna>=2.0.0\")\n session.install(\"cryptography>=1.3.4\")\n session.install(\"tornado>=6.1\")\n session.install(\"pytest>=6.2\")\n session.install(\"trustme==0.9.0\")\n session.install(\"types-python-dateutil\")\n session.install(\"nox\")\n session.run(\"mypy\", \"--version\")\n session.run(\n \"mypy\",\n \"src/urllib3\",\n \"dummyserver\",\n \"noxfile.py\",\n \"test/__init__.py\",\n \"test/conftest.py\",\n \"test/port_helpers.py\",\n \"test/test_retry.py\",\n \"test/test_wait.py\",\n \"test/tz_stub.py\",\n )\n\n\[email protected]\ndef docs(session: nox.Session) -> None:\n session.install(\"-r\", \"docs/requirements.txt\")\n session.install(\".[socks,secure,brotli]\")\n\n session.chdir(\"docs\")\n if os.path.exists(\"_build\"):\n shutil.rmtree(\"_build\")\n session.run(\"sphinx-build\", \"-b\", \"html\", \"-W\", \".\", \"_build/html\")\n", "path": "noxfile.py"}], "after_files": [{"content": "import os\nimport shutil\nimport subprocess\n\nimport nox\n\nSOURCE_FILES = [\n \"docs/\",\n \"dummyserver/\",\n \"src/\",\n \"test/\",\n \"noxfile.py\",\n \"setup.py\",\n]\n\n\ndef tests_impl(\n session: nox.Session,\n extras: str = \"socks,secure,brotli\",\n byte_string_comparisons: bool = True,\n) -> None:\n # Install deps and the package itself.\n session.install(\"-r\", \"dev-requirements.txt\")\n session.install(f\".[{extras}]\")\n\n # Show the pip version.\n session.run(\"pip\", \"--version\")\n # Print the Python version and bytesize.\n session.run(\"python\", \"--version\")\n session.run(\"python\", \"-c\", \"import struct; print(struct.calcsize('P') * 8)\")\n # Print OpenSSL information.\n session.run(\"python\", \"-m\", \"OpenSSL.debug\")\n\n # Inspired from https://github.com/pyca/cryptography\n # We use parallel mode and then combine here so that coverage.py will take\n # the paths like .tox/pyXY/lib/pythonX.Y/site-packages/urllib3/__init__.py\n # and collapse them into src/urllib3/__init__.py.\n\n session.run(\n \"python\",\n *((\"-bb\",) if byte_string_comparisons else ()),\n \"-m\",\n \"coverage\",\n \"run\",\n \"--parallel-mode\",\n \"-m\",\n \"pytest\",\n \"-r\",\n \"a\",\n \"--tb=native\",\n \"--no-success-flaky-report\",\n *(session.posargs or (\"test/\",)),\n env={\"PYTHONWARNINGS\": \"always::DeprecationWarning\"},\n )\n session.run(\"coverage\", \"combine\")\n session.run(\"coverage\", \"report\", \"-m\")\n session.run(\"coverage\", \"xml\")\n\n\[email protected](python=[\"3.7\", \"3.8\", \"3.9\", \"3.10\", \"pypy\"])\ndef test(session: nox.Session) -> None:\n tests_impl(session)\n\n\[email protected](python=[\"2.7\"])\ndef unsupported_python2(session: nox.Session) -> None:\n # Can't check both returncode and output with session.run\n process = subprocess.run(\n [\"python\", \"setup.py\", \"install\"],\n env={**session.env},\n text=True,\n capture_output=True,\n )\n assert process.returncode == 1\n print(process.stderr)\n assert \"Unsupported Python version\" in process.stderr\n\n\[email protected](python=[\"3\"])\ndef test_brotlipy(session: nox.Session) -> None:\n \"\"\"Check that if 'brotlipy' is installed instead of 'brotli' or\n 'brotlicffi' that we still don't blow up.\n \"\"\"\n session.install(\"brotlipy\")\n tests_impl(session, extras=\"socks,secure\", byte_string_comparisons=False)\n\n\ndef git_clone(session: nox.Session, git_url: str) -> None:\n session.run(\"git\", \"clone\", \"--depth\", \"1\", git_url, external=True)\n\n\[email protected]()\ndef downstream_botocore(session: nox.Session) -> None:\n root = os.getcwd()\n tmp_dir = session.create_tmp()\n\n session.cd(tmp_dir)\n git_clone(session, \"https://github.com/boto/botocore\")\n session.chdir(\"botocore\")\n session.run(\"git\", \"rev-parse\", \"HEAD\", external=True)\n session.run(\"python\", \"scripts/ci/install\")\n\n session.cd(root)\n session.install(\".\", silent=False)\n session.cd(f\"{tmp_dir}/botocore\")\n\n session.run(\"python\", \"-c\", \"import urllib3; print(urllib3.__version__)\")\n session.run(\"python\", \"scripts/ci/run-tests\")\n\n\[email protected]()\ndef downstream_requests(session: nox.Session) -> None:\n root = os.getcwd()\n tmp_dir = session.create_tmp()\n\n session.cd(tmp_dir)\n git_clone(session, \"https://github.com/psf/requests\")\n session.chdir(\"requests\")\n session.run(\"git\", \"apply\", f\"{root}/ci/requests.patch\", external=True)\n session.run(\"git\", \"rev-parse\", \"HEAD\", external=True)\n session.install(\".[socks]\", silent=False)\n session.install(\"-r\", \"requirements-dev.txt\", silent=False)\n\n session.cd(root)\n session.install(\".\", silent=False)\n session.cd(f\"{tmp_dir}/requests\")\n\n session.run(\"python\", \"-c\", \"import urllib3; print(urllib3.__version__)\")\n session.run(\"pytest\", \"tests\")\n\n\[email protected]()\ndef format(session: nox.Session) -> None:\n \"\"\"Run code formatters.\"\"\"\n session.install(\"pre-commit\")\n session.run(\"pre-commit\", \"--version\")\n\n process = subprocess.run(\n [\"pre-commit\", \"run\", \"--all-files\"],\n env=session.env,\n text=True,\n stdout=subprocess.PIPE,\n stderr=subprocess.STDOUT,\n )\n # Ensure that pre-commit itself ran successfully\n assert process.returncode in (0, 1)\n\n lint(session)\n\n\[email protected]\ndef lint(session: nox.Session) -> None:\n session.install(\"pre-commit\")\n session.run(\"pre-commit\", \"run\", \"--all-files\")\n\n mypy(session)\n\n\[email protected](python=\"3.8\")\ndef mypy(session: nox.Session) -> None:\n \"\"\"Run mypy.\"\"\"\n session.install(\"-r\", \"mypy-requirements.txt\")\n session.run(\"mypy\", \"--version\")\n session.run(\n \"mypy\",\n \"src/urllib3\",\n \"dummyserver\",\n \"noxfile.py\",\n \"test/__init__.py\",\n \"test/conftest.py\",\n \"test/port_helpers.py\",\n \"test/test_retry.py\",\n \"test/test_wait.py\",\n \"test/tz_stub.py\",\n )\n\n\[email protected]\ndef docs(session: nox.Session) -> None:\n session.install(\"-r\", \"docs/requirements.txt\")\n session.install(\".[socks,secure,brotli]\")\n\n session.chdir(\"docs\")\n if os.path.exists(\"_build\"):\n shutil.rmtree(\"_build\")\n session.run(\"sphinx-build\", \"-b\", \"html\", \"-W\", \".\", \"_build/html\")\n", "path": "noxfile.py"}]}
| 2,384 | 200 |
gh_patches_debug_29241
|
rasdani/github-patches
|
git_diff
|
ytdl-org__youtube-dl-14548
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
parliamentlive.tv has stopped working
## Please follow the guide below
- You will be asked some questions and requested to provide some information, please read them **carefully** and answer honestly
- Put an `x` into all the boxes [ ] relevant to your *issue* (like this: `[x]`)
- Use the *Preview* tab to see what your issue will actually look like
---
### Make sure you are using the *latest* version: run `youtube-dl --version` and ensure your version is *2017.10.15.1*. If it's not, read [this FAQ entry](https://github.com/rg3/youtube-dl/blob/master/README.md#how-do-i-update-youtube-dl) and update. Issues with outdated version will be rejected.
- [X] I've **verified** and **I assure** that I'm running youtube-dl **2017.10.15.1**
### Before submitting an *issue* make sure you have:
- [X] At least skimmed through the [README](https://github.com/rg3/youtube-dl/blob/master/README.md), **most notably** the [FAQ](https://github.com/rg3/youtube-dl#faq) and [BUGS](https://github.com/rg3/youtube-dl#bugs) sections
- [X] [Searched](https://github.com/rg3/youtube-dl/search?type=Issues) the bugtracker for similar issues including closed ones
### What is the purpose of your *issue*?
- [X] Bug report (encountered problems with youtube-dl)
- [ ] Site support request (request for adding support for a new site)
- [ ] Feature request (request for a new functionality)
- [ ] Question
- [ ] Other
---
### The following sections concretize particular purposed issues, you can erase any section (the contents between triple ---) not applicable to your *issue*
---
### If the purpose of this *issue* is a *bug report*, *site support request* or you are not completely sure provide the full verbose output as follows:
Add the `-v` flag to **your command line** you run youtube-dl with (`youtube-dl -v <your command line>`), copy the **whole** output and insert it here. It should look similar to one below (replace it with **your** log inserted between triple ```):
```
youtube-dl --verbose http://parliamentlive.tv/Event/Index/1c220590-96fc-4cb6-976f-ade4f23f0b65
[debug] System config: []
[debug] User config: []
[debug] Custom config: []
[debug] Command-line args: [u'--verbose', u'http://parliamentlive.tv/Event/Index/1c220590-96fc-4cb6-976f-ade4f23f0b65']
[debug] Encodings: locale UTF-8, fs utf-8, out UTF-8, pref UTF-8
[debug] youtube-dl version 2017.10.15.1
[debug] Python version 2.7.10 - Darwin-17.0.0-x86_64-i386-64bit
[debug] exe versions: ffmpeg 3.4, ffprobe 3.4, rtmpdump 2.4
[debug] Proxy map: {}
[parliamentlive.tv] 1c220590-96fc-4cb6-976f-ade4f23f0b65: Downloading webpage
ERROR: Unable to extract kaltura widget config; please report this issue on https://yt-dl.org/bug . Make sure you are using the latest version; type youtube-dl -U to update. Be sure to call youtube-dl with the --verbose flag and include its complete output.
Traceback (most recent call last):
File "/usr/local/bin/youtube-dl/youtube_dl/YoutubeDL.py", line 784, in extract_info
ie_result = ie.extract(url)
File "/usr/local/bin/youtube-dl/youtube_dl/extractor/common.py", line 434, in extract
ie_result = self._real_extract(url)
File "/usr/local/bin/youtube-dl/youtube_dl/extractor/parliamentliveuk.py", line 32, in _real_extract
webpage, 'kaltura widget config'), video_id)
File "/usr/local/bin/youtube-dl/youtube_dl/extractor/common.py", line 797, in _search_regex
raise RegexNotFoundError('Unable to extract %s' % _name)
RegexNotFoundError: Unable to extract kaltura widget config; please report this issue on https://yt-dl.org/bug . Make sure you are using the latest version; type youtube-dl -U to update. Be sure to call youtube-dl with the --verbose flag and include its complete output.
```
---
### If the purpose of this *issue* is a *site support request* please provide all kinds of example URLs support for which should be included (replace following example URLs by **yours**):
- Single video: http://parliamentlive.tv/Event/Index/1c220590-96fc-4cb6-976f-ade4f23f0b65
Note that **youtube-dl does not support sites dedicated to [copyright infringement](https://github.com/rg3/youtube-dl#can-you-add-support-for-this-anime-video-site-or-site-which-shows-current-movies-for-free)**. In order for site support request to be accepted all provided example URLs should not violate any copyrights.
---
### Description of your *issue*, suggested solution and other information
Parliamentlive.tv seems to have stopped working. The above error log is for the first video I tried but I have recreated this on several videos on the site.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `youtube_dl/extractor/parliamentliveuk.py`
Content:
```
1 from __future__ import unicode_literals
2
3 from .common import InfoExtractor
4
5
6 class ParliamentLiveUKIE(InfoExtractor):
7 IE_NAME = 'parliamentlive.tv'
8 IE_DESC = 'UK parliament videos'
9 _VALID_URL = r'(?i)https?://(?:www\.)?parliamentlive\.tv/Event/Index/(?P<id>[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12})'
10
11 _TESTS = [{
12 'url': 'http://parliamentlive.tv/Event/Index/c1e9d44d-fd6c-4263-b50f-97ed26cc998b',
13 'info_dict': {
14 'id': 'c1e9d44d-fd6c-4263-b50f-97ed26cc998b',
15 'ext': 'mp4',
16 'title': 'Home Affairs Committee',
17 'uploader_id': 'FFMPEG-01',
18 'timestamp': 1422696664,
19 'upload_date': '20150131',
20 },
21 }, {
22 'url': 'http://parliamentlive.tv/event/index/3f24936f-130f-40bf-9a5d-b3d6479da6a4',
23 'only_matching': True,
24 }]
25
26 def _real_extract(self, url):
27 video_id = self._match_id(url)
28 webpage = self._download_webpage(
29 'http://vodplayer.parliamentlive.tv/?mid=' + video_id, video_id)
30 widget_config = self._parse_json(self._search_regex(
31 r'kWidgetConfig\s*=\s*({.+});',
32 webpage, 'kaltura widget config'), video_id)
33 kaltura_url = 'kaltura:%s:%s' % (widget_config['wid'][1:], widget_config['entry_id'])
34 event_title = self._download_json(
35 'http://parliamentlive.tv/Event/GetShareVideo/' + video_id, video_id)['event']['title']
36 return {
37 '_type': 'url_transparent',
38 'id': video_id,
39 'title': event_title,
40 'description': '',
41 'url': kaltura_url,
42 'ie_key': 'Kaltura',
43 }
44
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/youtube_dl/extractor/parliamentliveuk.py b/youtube_dl/extractor/parliamentliveuk.py
--- a/youtube_dl/extractor/parliamentliveuk.py
+++ b/youtube_dl/extractor/parliamentliveuk.py
@@ -11,7 +11,7 @@
_TESTS = [{
'url': 'http://parliamentlive.tv/Event/Index/c1e9d44d-fd6c-4263-b50f-97ed26cc998b',
'info_dict': {
- 'id': 'c1e9d44d-fd6c-4263-b50f-97ed26cc998b',
+ 'id': '1_af9nv9ym',
'ext': 'mp4',
'title': 'Home Affairs Committee',
'uploader_id': 'FFMPEG-01',
@@ -28,14 +28,14 @@
webpage = self._download_webpage(
'http://vodplayer.parliamentlive.tv/?mid=' + video_id, video_id)
widget_config = self._parse_json(self._search_regex(
- r'kWidgetConfig\s*=\s*({.+});',
+ r'(?s)kWidgetConfig\s*=\s*({.+});',
webpage, 'kaltura widget config'), video_id)
- kaltura_url = 'kaltura:%s:%s' % (widget_config['wid'][1:], widget_config['entry_id'])
+ kaltura_url = 'kaltura:%s:%s' % (
+ widget_config['wid'][1:], widget_config['entry_id'])
event_title = self._download_json(
'http://parliamentlive.tv/Event/GetShareVideo/' + video_id, video_id)['event']['title']
return {
'_type': 'url_transparent',
- 'id': video_id,
'title': event_title,
'description': '',
'url': kaltura_url,
|
{"golden_diff": "diff --git a/youtube_dl/extractor/parliamentliveuk.py b/youtube_dl/extractor/parliamentliveuk.py\n--- a/youtube_dl/extractor/parliamentliveuk.py\n+++ b/youtube_dl/extractor/parliamentliveuk.py\n@@ -11,7 +11,7 @@\n _TESTS = [{\n 'url': 'http://parliamentlive.tv/Event/Index/c1e9d44d-fd6c-4263-b50f-97ed26cc998b',\n 'info_dict': {\n- 'id': 'c1e9d44d-fd6c-4263-b50f-97ed26cc998b',\n+ 'id': '1_af9nv9ym',\n 'ext': 'mp4',\n 'title': 'Home Affairs Committee',\n 'uploader_id': 'FFMPEG-01',\n@@ -28,14 +28,14 @@\n webpage = self._download_webpage(\n 'http://vodplayer.parliamentlive.tv/?mid=' + video_id, video_id)\n widget_config = self._parse_json(self._search_regex(\n- r'kWidgetConfig\\s*=\\s*({.+});',\n+ r'(?s)kWidgetConfig\\s*=\\s*({.+});',\n webpage, 'kaltura widget config'), video_id)\n- kaltura_url = 'kaltura:%s:%s' % (widget_config['wid'][1:], widget_config['entry_id'])\n+ kaltura_url = 'kaltura:%s:%s' % (\n+ widget_config['wid'][1:], widget_config['entry_id'])\n event_title = self._download_json(\n 'http://parliamentlive.tv/Event/GetShareVideo/' + video_id, video_id)['event']['title']\n return {\n '_type': 'url_transparent',\n- 'id': video_id,\n 'title': event_title,\n 'description': '',\n 'url': kaltura_url,\n", "issue": "parliamentlive.tv has stopped working\n## Please follow the guide below\r\n\r\n- You will be asked some questions and requested to provide some information, please read them **carefully** and answer honestly\r\n- Put an `x` into all the boxes [ ] relevant to your *issue* (like this: `[x]`)\r\n- Use the *Preview* tab to see what your issue will actually look like\r\n\r\n---\r\n\r\n### Make sure you are using the *latest* version: run `youtube-dl --version` and ensure your version is *2017.10.15.1*. If it's not, read [this FAQ entry](https://github.com/rg3/youtube-dl/blob/master/README.md#how-do-i-update-youtube-dl) and update. Issues with outdated version will be rejected.\r\n- [X] I've **verified** and **I assure** that I'm running youtube-dl **2017.10.15.1**\r\n\r\n### Before submitting an *issue* make sure you have:\r\n- [X] At least skimmed through the [README](https://github.com/rg3/youtube-dl/blob/master/README.md), **most notably** the [FAQ](https://github.com/rg3/youtube-dl#faq) and [BUGS](https://github.com/rg3/youtube-dl#bugs) sections\r\n- [X] [Searched](https://github.com/rg3/youtube-dl/search?type=Issues) the bugtracker for similar issues including closed ones\r\n\r\n### What is the purpose of your *issue*?\r\n- [X] Bug report (encountered problems with youtube-dl)\r\n- [ ] Site support request (request for adding support for a new site)\r\n- [ ] Feature request (request for a new functionality)\r\n- [ ] Question\r\n- [ ] Other\r\n\r\n---\r\n\r\n### The following sections concretize particular purposed issues, you can erase any section (the contents between triple ---) not applicable to your *issue*\r\n\r\n---\r\n\r\n### If the purpose of this *issue* is a *bug report*, *site support request* or you are not completely sure provide the full verbose output as follows:\r\n\r\nAdd the `-v` flag to **your command line** you run youtube-dl with (`youtube-dl -v <your command line>`), copy the **whole** output and insert it here. It should look similar to one below (replace it with **your** log inserted between triple ```):\r\n\r\n```\r\nyoutube-dl --verbose http://parliamentlive.tv/Event/Index/1c220590-96fc-4cb6-976f-ade4f23f0b65\r\n[debug] System config: []\r\n[debug] User config: []\r\n[debug] Custom config: []\r\n[debug] Command-line args: [u'--verbose', u'http://parliamentlive.tv/Event/Index/1c220590-96fc-4cb6-976f-ade4f23f0b65']\r\n[debug] Encodings: locale UTF-8, fs utf-8, out UTF-8, pref UTF-8\r\n[debug] youtube-dl version 2017.10.15.1\r\n[debug] Python version 2.7.10 - Darwin-17.0.0-x86_64-i386-64bit\r\n[debug] exe versions: ffmpeg 3.4, ffprobe 3.4, rtmpdump 2.4\r\n[debug] Proxy map: {}\r\n[parliamentlive.tv] 1c220590-96fc-4cb6-976f-ade4f23f0b65: Downloading webpage\r\nERROR: Unable to extract kaltura widget config; please report this issue on https://yt-dl.org/bug . Make sure you are using the latest version; type youtube-dl -U to update. Be sure to call youtube-dl with the --verbose flag and include its complete output.\r\nTraceback (most recent call last):\r\n File \"/usr/local/bin/youtube-dl/youtube_dl/YoutubeDL.py\", line 784, in extract_info\r\n ie_result = ie.extract(url)\r\n File \"/usr/local/bin/youtube-dl/youtube_dl/extractor/common.py\", line 434, in extract\r\n ie_result = self._real_extract(url)\r\n File \"/usr/local/bin/youtube-dl/youtube_dl/extractor/parliamentliveuk.py\", line 32, in _real_extract\r\n webpage, 'kaltura widget config'), video_id)\r\n File \"/usr/local/bin/youtube-dl/youtube_dl/extractor/common.py\", line 797, in _search_regex\r\n raise RegexNotFoundError('Unable to extract %s' % _name)\r\nRegexNotFoundError: Unable to extract kaltura widget config; please report this issue on https://yt-dl.org/bug . Make sure you are using the latest version; type youtube-dl -U to update. Be sure to call youtube-dl with the --verbose flag and include its complete output.\r\n```\r\n\r\n---\r\n\r\n### If the purpose of this *issue* is a *site support request* please provide all kinds of example URLs support for which should be included (replace following example URLs by **yours**):\r\n- Single video: http://parliamentlive.tv/Event/Index/1c220590-96fc-4cb6-976f-ade4f23f0b65\r\n\r\nNote that **youtube-dl does not support sites dedicated to [copyright infringement](https://github.com/rg3/youtube-dl#can-you-add-support-for-this-anime-video-site-or-site-which-shows-current-movies-for-free)**. In order for site support request to be accepted all provided example URLs should not violate any copyrights.\r\n\r\n---\r\n\r\n### Description of your *issue*, suggested solution and other information\r\n\r\nParliamentlive.tv seems to have stopped working. The above error log is for the first video I tried but I have recreated this on several videos on the site.\n", "before_files": [{"content": "from __future__ import unicode_literals\n\nfrom .common import InfoExtractor\n\n\nclass ParliamentLiveUKIE(InfoExtractor):\n IE_NAME = 'parliamentlive.tv'\n IE_DESC = 'UK parliament videos'\n _VALID_URL = r'(?i)https?://(?:www\\.)?parliamentlive\\.tv/Event/Index/(?P<id>[\\da-f]{8}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{12})'\n\n _TESTS = [{\n 'url': 'http://parliamentlive.tv/Event/Index/c1e9d44d-fd6c-4263-b50f-97ed26cc998b',\n 'info_dict': {\n 'id': 'c1e9d44d-fd6c-4263-b50f-97ed26cc998b',\n 'ext': 'mp4',\n 'title': 'Home Affairs Committee',\n 'uploader_id': 'FFMPEG-01',\n 'timestamp': 1422696664,\n 'upload_date': '20150131',\n },\n }, {\n 'url': 'http://parliamentlive.tv/event/index/3f24936f-130f-40bf-9a5d-b3d6479da6a4',\n 'only_matching': True,\n }]\n\n def _real_extract(self, url):\n video_id = self._match_id(url)\n webpage = self._download_webpage(\n 'http://vodplayer.parliamentlive.tv/?mid=' + video_id, video_id)\n widget_config = self._parse_json(self._search_regex(\n r'kWidgetConfig\\s*=\\s*({.+});',\n webpage, 'kaltura widget config'), video_id)\n kaltura_url = 'kaltura:%s:%s' % (widget_config['wid'][1:], widget_config['entry_id'])\n event_title = self._download_json(\n 'http://parliamentlive.tv/Event/GetShareVideo/' + video_id, video_id)['event']['title']\n return {\n '_type': 'url_transparent',\n 'id': video_id,\n 'title': event_title,\n 'description': '',\n 'url': kaltura_url,\n 'ie_key': 'Kaltura',\n }\n", "path": "youtube_dl/extractor/parliamentliveuk.py"}], "after_files": [{"content": "from __future__ import unicode_literals\n\nfrom .common import InfoExtractor\n\n\nclass ParliamentLiveUKIE(InfoExtractor):\n IE_NAME = 'parliamentlive.tv'\n IE_DESC = 'UK parliament videos'\n _VALID_URL = r'(?i)https?://(?:www\\.)?parliamentlive\\.tv/Event/Index/(?P<id>[\\da-f]{8}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{12})'\n\n _TESTS = [{\n 'url': 'http://parliamentlive.tv/Event/Index/c1e9d44d-fd6c-4263-b50f-97ed26cc998b',\n 'info_dict': {\n 'id': '1_af9nv9ym',\n 'ext': 'mp4',\n 'title': 'Home Affairs Committee',\n 'uploader_id': 'FFMPEG-01',\n 'timestamp': 1422696664,\n 'upload_date': '20150131',\n },\n }, {\n 'url': 'http://parliamentlive.tv/event/index/3f24936f-130f-40bf-9a5d-b3d6479da6a4',\n 'only_matching': True,\n }]\n\n def _real_extract(self, url):\n video_id = self._match_id(url)\n webpage = self._download_webpage(\n 'http://vodplayer.parliamentlive.tv/?mid=' + video_id, video_id)\n widget_config = self._parse_json(self._search_regex(\n r'(?s)kWidgetConfig\\s*=\\s*({.+});',\n webpage, 'kaltura widget config'), video_id)\n kaltura_url = 'kaltura:%s:%s' % (\n widget_config['wid'][1:], widget_config['entry_id'])\n event_title = self._download_json(\n 'http://parliamentlive.tv/Event/GetShareVideo/' + video_id, video_id)['event']['title']\n return {\n '_type': 'url_transparent',\n 'title': event_title,\n 'description': '',\n 'url': kaltura_url,\n 'ie_key': 'Kaltura',\n }\n", "path": "youtube_dl/extractor/parliamentliveuk.py"}]}
| 2,196 | 451 |
gh_patches_debug_3816
|
rasdani/github-patches
|
git_diff
|
ray-project__ray-7877
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[ray] Build failure when installing from source
<!--Please include [tune], [rllib], [autoscaler] etc. in the issue title if relevant-->
### What is the problem?
I am trying to install ray from source. However, I receive the following error during the install process:
```
HEAD is now at 8ffe41c apply cpython patch bpo-39492 for the reference count issue
+ /usr/bin/python setup.py bdist_wheel
usage: setup.py [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...]
or: setup.py --help [cmd1 cmd2 ...]
or: setup.py --help-commands
or: setup.py cmd --help
error: invalid command 'bdist_wheel'
Traceback (most recent call last):
File "setup.py", line 178, in <module>
setup(
File "/usr/lib/python3.8/site-packages/setuptools/__init__.py", line 144, in setup
return distutils.core.setup(**attrs)
File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
dist.run_commands()
File "/usr/lib/python3.8/distutils/dist.py", line 966, in run_commands
self.run_command(cmd)
File "/usr/lib/python3.8/distutils/dist.py", line 985, in run_command
cmd_obj.run()
File "/usr/lib/python3.8/distutils/command/build.py", line 135, in run
self.run_command(cmd_name)
File "/usr/lib/python3.8/distutils/cmd.py", line 313, in run_command
self.distribution.run_command(command)
File "/usr/lib/python3.8/distutils/dist.py", line 985, in run_command
cmd_obj.run()
File "setup.py", line 107, in run
subprocess.check_call(command)
File "/usr/lib/python3.8/subprocess.py", line 364, in check_call
raise CalledProcessError(retcode, cmd)
subprocess.CalledProcessError: Command '['../build.sh', '-p', '/usr/bin/python']' returned non-zero exit status 1.
```
Note: `error invalid command 'bdist_wheel'`
*Ray version and other system information (Python version, TensorFlow version, OS):*
ray: 0.8.4
python: 3.8.2
os: Arch Linux
### Reproduction (REQUIRED)
Please provide a script that can be run to reproduce the issue. The script should have **no external library dependencies** (i.e., use fake or mock data / environments):
If we cannot run your script, we cannot fix your issue.
- [ ] I have verified my script runs in a clean environment and reproduces the issue.
- [ ] I have verified the issue also occurs with the [latest wheels](https://ray.readthedocs.io/en/latest/installation.html).
The above does not apply since this is a build issue.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `python/setup.py`
Content:
```
1 from itertools import chain
2 import os
3 import re
4 import shutil
5 import subprocess
6 import sys
7
8 from setuptools import setup, find_packages, Distribution
9 import setuptools.command.build_ext as _build_ext
10
11 # Ideally, we could include these files by putting them in a
12 # MANIFEST.in or using the package_data argument to setup, but the
13 # MANIFEST.in gets applied at the very beginning when setup.py runs
14 # before these files have been created, so we have to move the files
15 # manually.
16
17 # NOTE: The lists below must be kept in sync with ray/BUILD.bazel.
18 ray_files = [
19 "ray/core/src/ray/thirdparty/redis/src/redis-server",
20 "ray/core/src/ray/gcs/redis_module/libray_redis_module.so",
21 "ray/core/src/plasma/plasma_store_server",
22 "ray/_raylet.so",
23 "ray/core/src/ray/raylet/raylet_monitor",
24 "ray/core/src/ray/gcs/gcs_server",
25 "ray/core/src/ray/raylet/raylet",
26 "ray/streaming/_streaming.so",
27 ]
28
29 build_java = os.getenv("RAY_INSTALL_JAVA") == "1"
30 if build_java:
31 ray_files.append("ray/jars/ray_dist.jar")
32
33 # These are the directories where automatically generated Python protobuf
34 # bindings are created.
35 generated_python_directories = [
36 "ray/core/generated",
37 "ray/streaming/generated",
38 ]
39
40 optional_ray_files = []
41
42 ray_autoscaler_files = [
43 "ray/autoscaler/aws/example-full.yaml",
44 "ray/autoscaler/azure/example-full.yaml",
45 "ray/autoscaler/gcp/example-full.yaml",
46 "ray/autoscaler/local/example-full.yaml",
47 "ray/autoscaler/kubernetes/example-full.yaml",
48 "ray/autoscaler/kubernetes/kubectl-rsync.sh",
49 "ray/autoscaler/ray-schema.json"
50 ]
51
52 ray_project_files = [
53 "ray/projects/schema.json", "ray/projects/templates/cluster_template.yaml",
54 "ray/projects/templates/project_template.yaml",
55 "ray/projects/templates/requirements.txt"
56 ]
57
58 ray_dashboard_files = [
59 os.path.join(dirpath, filename)
60 for dirpath, dirnames, filenames in os.walk("ray/dashboard/client/build")
61 for filename in filenames
62 ]
63
64 optional_ray_files += ray_autoscaler_files
65 optional_ray_files += ray_project_files
66 optional_ray_files += ray_dashboard_files
67
68 if "RAY_USE_NEW_GCS" in os.environ and os.environ["RAY_USE_NEW_GCS"] == "on":
69 ray_files += [
70 "ray/core/src/credis/build/src/libmember.so",
71 "ray/core/src/credis/build/src/libmaster.so",
72 "ray/core/src/credis/redis/src/redis-server"
73 ]
74
75 extras = {
76 "debug": [],
77 "dashboard": ["requests"],
78 "serve": ["uvicorn", "pygments", "werkzeug", "flask", "pandas", "blist"],
79 "tune": ["tabulate", "tensorboardX", "pandas"]
80 }
81
82 extras["rllib"] = extras["tune"] + [
83 "atari_py",
84 "dm_tree",
85 "gym[atari]",
86 "lz4",
87 "opencv-python-headless",
88 "pyyaml",
89 "scipy",
90 ]
91
92 extras["streaming"] = ["msgpack >= 0.6.2"]
93
94 extras["all"] = list(set(chain.from_iterable(extras.values())))
95
96
97 class build_ext(_build_ext.build_ext):
98 def run(self):
99 # Note: We are passing in sys.executable so that we use the same
100 # version of Python to build packages inside the build.sh script. Note
101 # that certain flags will not be passed along such as --user or sudo.
102 # TODO(rkn): Fix this.
103 command = ["../build.sh", "-p", sys.executable]
104 if build_java:
105 # Also build binaries for Java if the above env variable exists.
106 command += ["-l", "python,java"]
107 subprocess.check_call(command)
108
109 # We also need to install pickle5 along with Ray, so make sure that the
110 # relevant non-Python pickle5 files get copied.
111 pickle5_files = self.walk_directory("./ray/pickle5_files/pickle5")
112
113 thirdparty_files = self.walk_directory("./ray/thirdparty_files")
114
115 files_to_include = ray_files + pickle5_files + thirdparty_files
116
117 # Copy over the autogenerated protobuf Python bindings.
118 for directory in generated_python_directories:
119 for filename in os.listdir(directory):
120 if filename[-3:] == ".py":
121 files_to_include.append(os.path.join(directory, filename))
122
123 for filename in files_to_include:
124 self.move_file(filename)
125
126 # Try to copy over the optional files.
127 for filename in optional_ray_files:
128 try:
129 self.move_file(filename)
130 except Exception:
131 print("Failed to copy optional file {}. This is ok."
132 .format(filename))
133
134 def walk_directory(self, directory):
135 file_list = []
136 for (root, dirs, filenames) in os.walk(directory):
137 for name in filenames:
138 file_list.append(os.path.join(root, name))
139 return file_list
140
141 def move_file(self, filename):
142 # TODO(rkn): This feels very brittle. It may not handle all cases. See
143 # https://github.com/apache/arrow/blob/master/python/setup.py for an
144 # example.
145 source = filename
146 destination = os.path.join(self.build_lib, filename)
147 # Create the target directory if it doesn't already exist.
148 parent_directory = os.path.dirname(destination)
149 if not os.path.exists(parent_directory):
150 os.makedirs(parent_directory)
151 if not os.path.exists(destination):
152 print("Copying {} to {}.".format(source, destination))
153 shutil.copy(source, destination, follow_symlinks=True)
154
155
156 class BinaryDistribution(Distribution):
157 def has_ext_modules(self):
158 return True
159
160
161 def find_version(*filepath):
162 # Extract version information from filepath
163 here = os.path.abspath(os.path.dirname(__file__))
164 with open(os.path.join(here, *filepath)) as fp:
165 version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
166 fp.read(), re.M)
167 if version_match:
168 return version_match.group(1)
169 raise RuntimeError("Unable to find version string.")
170
171
172 requires = [
173 "numpy >= 1.16", "filelock", "jsonschema", "click", "colorama", "pyyaml",
174 "redis >= 3.3.2", "protobuf >= 3.8.0", "py-spy >= 0.2.0", "aiohttp",
175 "google", "grpcio"
176 ]
177
178 setup(
179 name="ray",
180 version=find_version("ray", "__init__.py"),
181 author="Ray Team",
182 author_email="[email protected]",
183 description=("A system for parallel and distributed Python that unifies "
184 "the ML ecosystem."),
185 long_description=open("../README.rst").read(),
186 url="https://github.com/ray-project/ray",
187 keywords=("ray distributed parallel machine-learning "
188 "reinforcement-learning deep-learning python"),
189 packages=find_packages(),
190 cmdclass={"build_ext": build_ext},
191 # The BinaryDistribution argument triggers build_ext.
192 distclass=BinaryDistribution,
193 install_requires=requires,
194 setup_requires=["cython >= 0.29.14"],
195 extras_require=extras,
196 entry_points={
197 "console_scripts": [
198 "ray=ray.scripts.scripts:main",
199 "rllib=ray.rllib.scripts:cli [rllib]", "tune=ray.tune.scripts:cli"
200 ]
201 },
202 include_package_data=True,
203 zip_safe=False,
204 license="Apache 2.0")
205
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/python/setup.py b/python/setup.py
--- a/python/setup.py
+++ b/python/setup.py
@@ -191,7 +191,7 @@
# The BinaryDistribution argument triggers build_ext.
distclass=BinaryDistribution,
install_requires=requires,
- setup_requires=["cython >= 0.29.14"],
+ setup_requires=["cython >= 0.29.14", "wheel"],
extras_require=extras,
entry_points={
"console_scripts": [
|
{"golden_diff": "diff --git a/python/setup.py b/python/setup.py\n--- a/python/setup.py\n+++ b/python/setup.py\n@@ -191,7 +191,7 @@\n # The BinaryDistribution argument triggers build_ext.\n distclass=BinaryDistribution,\n install_requires=requires,\n- setup_requires=[\"cython >= 0.29.14\"],\n+ setup_requires=[\"cython >= 0.29.14\", \"wheel\"],\n extras_require=extras,\n entry_points={\n \"console_scripts\": [\n", "issue": "[ray] Build failure when installing from source\n<!--Please include [tune], [rllib], [autoscaler] etc. in the issue title if relevant-->\r\n\r\n### What is the problem?\r\nI am trying to install ray from source. However, I receive the following error during the install process:\r\n```\r\nHEAD is now at 8ffe41c apply cpython patch bpo-39492 for the reference count issue\r\n+ /usr/bin/python setup.py bdist_wheel\r\nusage: setup.py [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...]\r\n or: setup.py --help [cmd1 cmd2 ...]\r\n or: setup.py --help-commands\r\n or: setup.py cmd --help\r\n\r\nerror: invalid command 'bdist_wheel'\r\nTraceback (most recent call last):\r\n File \"setup.py\", line 178, in <module>\r\n setup(\r\n File \"/usr/lib/python3.8/site-packages/setuptools/__init__.py\", line 144, in setup\r\n return distutils.core.setup(**attrs)\r\n File \"/usr/lib/python3.8/distutils/core.py\", line 148, in setup\r\n dist.run_commands()\r\n File \"/usr/lib/python3.8/distutils/dist.py\", line 966, in run_commands\r\n self.run_command(cmd)\r\n File \"/usr/lib/python3.8/distutils/dist.py\", line 985, in run_command\r\n cmd_obj.run()\r\n File \"/usr/lib/python3.8/distutils/command/build.py\", line 135, in run\r\n self.run_command(cmd_name)\r\n File \"/usr/lib/python3.8/distutils/cmd.py\", line 313, in run_command\r\n self.distribution.run_command(command)\r\n File \"/usr/lib/python3.8/distutils/dist.py\", line 985, in run_command\r\n cmd_obj.run()\r\n File \"setup.py\", line 107, in run\r\n subprocess.check_call(command)\r\n File \"/usr/lib/python3.8/subprocess.py\", line 364, in check_call\r\n raise CalledProcessError(retcode, cmd)\r\nsubprocess.CalledProcessError: Command '['../build.sh', '-p', '/usr/bin/python']' returned non-zero exit status 1.\r\n```\r\n\r\nNote: `error invalid command 'bdist_wheel'`\r\n\r\n*Ray version and other system information (Python version, TensorFlow version, OS):*\r\nray: 0.8.4\r\npython: 3.8.2\r\nos: Arch Linux\r\n\r\n### Reproduction (REQUIRED)\r\nPlease provide a script that can be run to reproduce the issue. The script should have **no external library dependencies** (i.e., use fake or mock data / environments):\r\n\r\nIf we cannot run your script, we cannot fix your issue.\r\n\r\n- [ ] I have verified my script runs in a clean environment and reproduces the issue.\r\n- [ ] I have verified the issue also occurs with the [latest wheels](https://ray.readthedocs.io/en/latest/installation.html).\r\n\r\nThe above does not apply since this is a build issue.\r\n\n", "before_files": [{"content": "from itertools import chain\nimport os\nimport re\nimport shutil\nimport subprocess\nimport sys\n\nfrom setuptools import setup, find_packages, Distribution\nimport setuptools.command.build_ext as _build_ext\n\n# Ideally, we could include these files by putting them in a\n# MANIFEST.in or using the package_data argument to setup, but the\n# MANIFEST.in gets applied at the very beginning when setup.py runs\n# before these files have been created, so we have to move the files\n# manually.\n\n# NOTE: The lists below must be kept in sync with ray/BUILD.bazel.\nray_files = [\n \"ray/core/src/ray/thirdparty/redis/src/redis-server\",\n \"ray/core/src/ray/gcs/redis_module/libray_redis_module.so\",\n \"ray/core/src/plasma/plasma_store_server\",\n \"ray/_raylet.so\",\n \"ray/core/src/ray/raylet/raylet_monitor\",\n \"ray/core/src/ray/gcs/gcs_server\",\n \"ray/core/src/ray/raylet/raylet\",\n \"ray/streaming/_streaming.so\",\n]\n\nbuild_java = os.getenv(\"RAY_INSTALL_JAVA\") == \"1\"\nif build_java:\n ray_files.append(\"ray/jars/ray_dist.jar\")\n\n# These are the directories where automatically generated Python protobuf\n# bindings are created.\ngenerated_python_directories = [\n \"ray/core/generated\",\n \"ray/streaming/generated\",\n]\n\noptional_ray_files = []\n\nray_autoscaler_files = [\n \"ray/autoscaler/aws/example-full.yaml\",\n \"ray/autoscaler/azure/example-full.yaml\",\n \"ray/autoscaler/gcp/example-full.yaml\",\n \"ray/autoscaler/local/example-full.yaml\",\n \"ray/autoscaler/kubernetes/example-full.yaml\",\n \"ray/autoscaler/kubernetes/kubectl-rsync.sh\",\n \"ray/autoscaler/ray-schema.json\"\n]\n\nray_project_files = [\n \"ray/projects/schema.json\", \"ray/projects/templates/cluster_template.yaml\",\n \"ray/projects/templates/project_template.yaml\",\n \"ray/projects/templates/requirements.txt\"\n]\n\nray_dashboard_files = [\n os.path.join(dirpath, filename)\n for dirpath, dirnames, filenames in os.walk(\"ray/dashboard/client/build\")\n for filename in filenames\n]\n\noptional_ray_files += ray_autoscaler_files\noptional_ray_files += ray_project_files\noptional_ray_files += ray_dashboard_files\n\nif \"RAY_USE_NEW_GCS\" in os.environ and os.environ[\"RAY_USE_NEW_GCS\"] == \"on\":\n ray_files += [\n \"ray/core/src/credis/build/src/libmember.so\",\n \"ray/core/src/credis/build/src/libmaster.so\",\n \"ray/core/src/credis/redis/src/redis-server\"\n ]\n\nextras = {\n \"debug\": [],\n \"dashboard\": [\"requests\"],\n \"serve\": [\"uvicorn\", \"pygments\", \"werkzeug\", \"flask\", \"pandas\", \"blist\"],\n \"tune\": [\"tabulate\", \"tensorboardX\", \"pandas\"]\n}\n\nextras[\"rllib\"] = extras[\"tune\"] + [\n \"atari_py\",\n \"dm_tree\",\n \"gym[atari]\",\n \"lz4\",\n \"opencv-python-headless\",\n \"pyyaml\",\n \"scipy\",\n]\n\nextras[\"streaming\"] = [\"msgpack >= 0.6.2\"]\n\nextras[\"all\"] = list(set(chain.from_iterable(extras.values())))\n\n\nclass build_ext(_build_ext.build_ext):\n def run(self):\n # Note: We are passing in sys.executable so that we use the same\n # version of Python to build packages inside the build.sh script. Note\n # that certain flags will not be passed along such as --user or sudo.\n # TODO(rkn): Fix this.\n command = [\"../build.sh\", \"-p\", sys.executable]\n if build_java:\n # Also build binaries for Java if the above env variable exists.\n command += [\"-l\", \"python,java\"]\n subprocess.check_call(command)\n\n # We also need to install pickle5 along with Ray, so make sure that the\n # relevant non-Python pickle5 files get copied.\n pickle5_files = self.walk_directory(\"./ray/pickle5_files/pickle5\")\n\n thirdparty_files = self.walk_directory(\"./ray/thirdparty_files\")\n\n files_to_include = ray_files + pickle5_files + thirdparty_files\n\n # Copy over the autogenerated protobuf Python bindings.\n for directory in generated_python_directories:\n for filename in os.listdir(directory):\n if filename[-3:] == \".py\":\n files_to_include.append(os.path.join(directory, filename))\n\n for filename in files_to_include:\n self.move_file(filename)\n\n # Try to copy over the optional files.\n for filename in optional_ray_files:\n try:\n self.move_file(filename)\n except Exception:\n print(\"Failed to copy optional file {}. This is ok.\"\n .format(filename))\n\n def walk_directory(self, directory):\n file_list = []\n for (root, dirs, filenames) in os.walk(directory):\n for name in filenames:\n file_list.append(os.path.join(root, name))\n return file_list\n\n def move_file(self, filename):\n # TODO(rkn): This feels very brittle. It may not handle all cases. See\n # https://github.com/apache/arrow/blob/master/python/setup.py for an\n # example.\n source = filename\n destination = os.path.join(self.build_lib, filename)\n # Create the target directory if it doesn't already exist.\n parent_directory = os.path.dirname(destination)\n if not os.path.exists(parent_directory):\n os.makedirs(parent_directory)\n if not os.path.exists(destination):\n print(\"Copying {} to {}.\".format(source, destination))\n shutil.copy(source, destination, follow_symlinks=True)\n\n\nclass BinaryDistribution(Distribution):\n def has_ext_modules(self):\n return True\n\n\ndef find_version(*filepath):\n # Extract version information from filepath\n here = os.path.abspath(os.path.dirname(__file__))\n with open(os.path.join(here, *filepath)) as fp:\n version_match = re.search(r\"^__version__ = ['\\\"]([^'\\\"]*)['\\\"]\",\n fp.read(), re.M)\n if version_match:\n return version_match.group(1)\n raise RuntimeError(\"Unable to find version string.\")\n\n\nrequires = [\n \"numpy >= 1.16\", \"filelock\", \"jsonschema\", \"click\", \"colorama\", \"pyyaml\",\n \"redis >= 3.3.2\", \"protobuf >= 3.8.0\", \"py-spy >= 0.2.0\", \"aiohttp\",\n \"google\", \"grpcio\"\n]\n\nsetup(\n name=\"ray\",\n version=find_version(\"ray\", \"__init__.py\"),\n author=\"Ray Team\",\n author_email=\"[email protected]\",\n description=(\"A system for parallel and distributed Python that unifies \"\n \"the ML ecosystem.\"),\n long_description=open(\"../README.rst\").read(),\n url=\"https://github.com/ray-project/ray\",\n keywords=(\"ray distributed parallel machine-learning \"\n \"reinforcement-learning deep-learning python\"),\n packages=find_packages(),\n cmdclass={\"build_ext\": build_ext},\n # The BinaryDistribution argument triggers build_ext.\n distclass=BinaryDistribution,\n install_requires=requires,\n setup_requires=[\"cython >= 0.29.14\"],\n extras_require=extras,\n entry_points={\n \"console_scripts\": [\n \"ray=ray.scripts.scripts:main\",\n \"rllib=ray.rllib.scripts:cli [rllib]\", \"tune=ray.tune.scripts:cli\"\n ]\n },\n include_package_data=True,\n zip_safe=False,\n license=\"Apache 2.0\")\n", "path": "python/setup.py"}], "after_files": [{"content": "from itertools import chain\nimport os\nimport re\nimport shutil\nimport subprocess\nimport sys\n\nfrom setuptools import setup, find_packages, Distribution\nimport setuptools.command.build_ext as _build_ext\n\n# Ideally, we could include these files by putting them in a\n# MANIFEST.in or using the package_data argument to setup, but the\n# MANIFEST.in gets applied at the very beginning when setup.py runs\n# before these files have been created, so we have to move the files\n# manually.\n\n# NOTE: The lists below must be kept in sync with ray/BUILD.bazel.\nray_files = [\n \"ray/core/src/ray/thirdparty/redis/src/redis-server\",\n \"ray/core/src/ray/gcs/redis_module/libray_redis_module.so\",\n \"ray/core/src/plasma/plasma_store_server\",\n \"ray/_raylet.so\",\n \"ray/core/src/ray/raylet/raylet_monitor\",\n \"ray/core/src/ray/gcs/gcs_server\",\n \"ray/core/src/ray/raylet/raylet\",\n \"ray/streaming/_streaming.so\",\n]\n\nbuild_java = os.getenv(\"RAY_INSTALL_JAVA\") == \"1\"\nif build_java:\n ray_files.append(\"ray/jars/ray_dist.jar\")\n\n# These are the directories where automatically generated Python protobuf\n# bindings are created.\ngenerated_python_directories = [\n \"ray/core/generated\",\n \"ray/streaming/generated\",\n]\n\noptional_ray_files = []\n\nray_autoscaler_files = [\n \"ray/autoscaler/aws/example-full.yaml\",\n \"ray/autoscaler/azure/example-full.yaml\",\n \"ray/autoscaler/gcp/example-full.yaml\",\n \"ray/autoscaler/local/example-full.yaml\",\n \"ray/autoscaler/kubernetes/example-full.yaml\",\n \"ray/autoscaler/kubernetes/kubectl-rsync.sh\",\n \"ray/autoscaler/ray-schema.json\"\n]\n\nray_project_files = [\n \"ray/projects/schema.json\", \"ray/projects/templates/cluster_template.yaml\",\n \"ray/projects/templates/project_template.yaml\",\n \"ray/projects/templates/requirements.txt\"\n]\n\nray_dashboard_files = [\n os.path.join(dirpath, filename)\n for dirpath, dirnames, filenames in os.walk(\"ray/dashboard/client/build\")\n for filename in filenames\n]\n\noptional_ray_files += ray_autoscaler_files\noptional_ray_files += ray_project_files\noptional_ray_files += ray_dashboard_files\n\nif \"RAY_USE_NEW_GCS\" in os.environ and os.environ[\"RAY_USE_NEW_GCS\"] == \"on\":\n ray_files += [\n \"ray/core/src/credis/build/src/libmember.so\",\n \"ray/core/src/credis/build/src/libmaster.so\",\n \"ray/core/src/credis/redis/src/redis-server\"\n ]\n\nextras = {\n \"debug\": [],\n \"dashboard\": [\"requests\"],\n \"serve\": [\"uvicorn\", \"pygments\", \"werkzeug\", \"flask\", \"pandas\", \"blist\"],\n \"tune\": [\"tabulate\", \"tensorboardX\", \"pandas\"]\n}\n\nextras[\"rllib\"] = extras[\"tune\"] + [\n \"atari_py\",\n \"dm_tree\",\n \"gym[atari]\",\n \"lz4\",\n \"opencv-python-headless\",\n \"pyyaml\",\n \"scipy\",\n]\n\nextras[\"streaming\"] = [\"msgpack >= 0.6.2\"]\n\nextras[\"all\"] = list(set(chain.from_iterable(extras.values())))\n\n\nclass build_ext(_build_ext.build_ext):\n def run(self):\n # Note: We are passing in sys.executable so that we use the same\n # version of Python to build packages inside the build.sh script. Note\n # that certain flags will not be passed along such as --user or sudo.\n # TODO(rkn): Fix this.\n command = [\"../build.sh\", \"-p\", sys.executable]\n if build_java:\n # Also build binaries for Java if the above env variable exists.\n command += [\"-l\", \"python,java\"]\n subprocess.check_call(command)\n\n # We also need to install pickle5 along with Ray, so make sure that the\n # relevant non-Python pickle5 files get copied.\n pickle5_files = self.walk_directory(\"./ray/pickle5_files/pickle5\")\n\n thirdparty_files = self.walk_directory(\"./ray/thirdparty_files\")\n\n files_to_include = ray_files + pickle5_files + thirdparty_files\n\n # Copy over the autogenerated protobuf Python bindings.\n for directory in generated_python_directories:\n for filename in os.listdir(directory):\n if filename[-3:] == \".py\":\n files_to_include.append(os.path.join(directory, filename))\n\n for filename in files_to_include:\n self.move_file(filename)\n\n # Try to copy over the optional files.\n for filename in optional_ray_files:\n try:\n self.move_file(filename)\n except Exception:\n print(\"Failed to copy optional file {}. This is ok.\"\n .format(filename))\n\n def walk_directory(self, directory):\n file_list = []\n for (root, dirs, filenames) in os.walk(directory):\n for name in filenames:\n file_list.append(os.path.join(root, name))\n return file_list\n\n def move_file(self, filename):\n # TODO(rkn): This feels very brittle. It may not handle all cases. See\n # https://github.com/apache/arrow/blob/master/python/setup.py for an\n # example.\n source = filename\n destination = os.path.join(self.build_lib, filename)\n # Create the target directory if it doesn't already exist.\n parent_directory = os.path.dirname(destination)\n if not os.path.exists(parent_directory):\n os.makedirs(parent_directory)\n if not os.path.exists(destination):\n print(\"Copying {} to {}.\".format(source, destination))\n shutil.copy(source, destination, follow_symlinks=True)\n\n\nclass BinaryDistribution(Distribution):\n def has_ext_modules(self):\n return True\n\n\ndef find_version(*filepath):\n # Extract version information from filepath\n here = os.path.abspath(os.path.dirname(__file__))\n with open(os.path.join(here, *filepath)) as fp:\n version_match = re.search(r\"^__version__ = ['\\\"]([^'\\\"]*)['\\\"]\",\n fp.read(), re.M)\n if version_match:\n return version_match.group(1)\n raise RuntimeError(\"Unable to find version string.\")\n\n\nrequires = [\n \"numpy >= 1.16\", \"filelock\", \"jsonschema\", \"click\", \"colorama\", \"pyyaml\",\n \"redis >= 3.3.2\", \"protobuf >= 3.8.0\", \"py-spy >= 0.2.0\", \"aiohttp\",\n \"google\", \"grpcio\"\n]\n\nsetup(\n name=\"ray\",\n version=find_version(\"ray\", \"__init__.py\"),\n author=\"Ray Team\",\n author_email=\"[email protected]\",\n description=(\"A system for parallel and distributed Python that unifies \"\n \"the ML ecosystem.\"),\n long_description=open(\"../README.rst\").read(),\n url=\"https://github.com/ray-project/ray\",\n keywords=(\"ray distributed parallel machine-learning \"\n \"reinforcement-learning deep-learning python\"),\n packages=find_packages(),\n cmdclass={\"build_ext\": build_ext},\n # The BinaryDistribution argument triggers build_ext.\n distclass=BinaryDistribution,\n install_requires=requires,\n setup_requires=[\"cython >= 0.29.14\", \"wheel\"],\n extras_require=extras,\n entry_points={\n \"console_scripts\": [\n \"ray=ray.scripts.scripts:main\",\n \"rllib=ray.rllib.scripts:cli [rllib]\", \"tune=ray.tune.scripts:cli\"\n ]\n },\n include_package_data=True,\n zip_safe=False,\n license=\"Apache 2.0\")\n", "path": "python/setup.py"}]}
| 3,114 | 114 |
gh_patches_debug_39165
|
rasdani/github-patches
|
git_diff
|
celery__kombu-295
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Mongodb url is broken in Kombu 3.0.1
Upgrading to version 3.0.1, a mongodb url like mongodb://localhost/wq fails as the // gets converted to / by some code in transport/mongodb.py - basically it seems to boil down to this code:-
```
if '/' in hostname[10:]:
if not client.userid:
hostname = hostname.replace('/' + client.virtual_host, '/')
else:
hostname = hostname.replace('/' + client.virtual_host, '/' + authdb)
```
by default virtual_host == '/' so basically hostname becomes:-
mongodb:/localhost/wq instead of mongodb://localhost/wq causing the MongoClient to fail wit a port not an integer error.
right now can work around this by setting the url to mongodb:////localhost/wq but its a kludge.
mongodb transport no longer honors configured port.
The mongodb transport in kombu version 2.1.3 (version according to pypi) has changed the BrokerConnection arguments that it uses. We are passing in hostname, port, and transport in as separate BrokerConnection arguments, but the mongodb transport now expects to get all that information out of hostname, which it assumes is a mongodb:// URI.
For some history, version 1.5.0 changed the parse_url() function so that the port was no longer parsed out of mongodb:// URIs. So we were forced to pass the hostname, port, and transport in as separate BrokerConnection arguments. Now, we are being forced back to passing a mongodb:// URI in as the hostname.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `kombu/transport/mongodb.py`
Content:
```
1 """
2 kombu.transport.mongodb
3 =======================
4
5 MongoDB transport.
6
7 :copyright: (c) 2010 - 2013 by Flavio Percoco Premoli.
8 :license: BSD, see LICENSE for more details.
9
10 """
11 from __future__ import absolute_import
12
13 import pymongo
14
15 from pymongo import errors
16 from anyjson import loads, dumps
17 from pymongo import MongoClient
18
19 from kombu.five import Empty
20 from kombu.syn import _detect_environment
21 from kombu.utils.encoding import bytes_to_str
22
23 from . import virtual
24
25 DEFAULT_HOST = '127.0.0.1'
26 DEFAULT_PORT = 27017
27
28 __author__ = """\
29 Flavio [FlaPer87] Percoco Premoli <[email protected]>;\
30 Scott Lyons <[email protected]>;\
31 """
32
33
34 class Channel(virtual.Channel):
35 _client = None
36 supports_fanout = True
37 _fanout_queues = {}
38
39 def __init__(self, *vargs, **kwargs):
40 super_ = super(Channel, self)
41 super_.__init__(*vargs, **kwargs)
42
43 self._queue_cursors = {}
44 self._queue_readcounts = {}
45
46 def _new_queue(self, queue, **kwargs):
47 pass
48
49 def _get(self, queue):
50 try:
51 if queue in self._fanout_queues:
52 msg = next(self._queue_cursors[queue])
53 self._queue_readcounts[queue] += 1
54 return loads(bytes_to_str(msg['payload']))
55 else:
56 msg = self.client.command(
57 'findandmodify', 'messages',
58 query={'queue': queue},
59 sort={'_id': pymongo.ASCENDING}, remove=True,
60 )
61 except errors.OperationFailure as exc:
62 if 'No matching object found' in exc.args[0]:
63 raise Empty()
64 raise
65 except StopIteration:
66 raise Empty()
67
68 # as of mongo 2.0 empty results won't raise an error
69 if msg['value'] is None:
70 raise Empty()
71 return loads(bytes_to_str(msg['value']['payload']))
72
73 def _size(self, queue):
74 if queue in self._fanout_queues:
75 return (self._queue_cursors[queue].count() -
76 self._queue_readcounts[queue])
77
78 return self.client.messages.find({'queue': queue}).count()
79
80 def _put(self, queue, message, **kwargs):
81 self.client.messages.insert({'payload': dumps(message),
82 'queue': queue})
83
84 def _purge(self, queue):
85 size = self._size(queue)
86 if queue in self._fanout_queues:
87 cursor = self._queue_cursors[queue]
88 cursor.rewind()
89 self._queue_cursors[queue] = cursor.skip(cursor.count())
90 else:
91 self.client.messages.remove({'queue': queue})
92 return size
93
94 def _open(self, scheme='mongodb://'):
95 # See mongodb uri documentation:
96 # http://www.mongodb.org/display/DOCS/Connections
97 client = self.connection.client
98 options = client.transport_options
99 hostname = client.hostname or DEFAULT_HOST
100 dbname = client.virtual_host
101
102 if dbname in ['/', None]:
103 dbname = "kombu_default"
104 if not hostname.startswith(scheme):
105 hostname = scheme + hostname
106
107 if not hostname[len(scheme):]:
108 hostname += 'localhost'
109
110 # XXX What does this do? [ask]
111 urest = hostname[len(scheme):]
112 if '/' in urest:
113 if not client.userid:
114 urest = urest.replace('/' + client.virtual_host, '/')
115 hostname = ''.join([scheme, urest])
116
117 # At this point we expect the hostname to be something like
118 # (considering replica set form too):
119 #
120 # mongodb://[username:password@]host1[:port1][,host2[:port2],
121 # ...[,hostN[:portN]]][/[?options]]
122 options.setdefault('auto_start_request', True)
123 mongoconn = MongoClient(
124 host=hostname, ssl=client.ssl,
125 auto_start_request=options['auto_start_request'],
126 use_greenlets=_detect_environment() != 'default',
127 )
128 database = getattr(mongoconn, dbname)
129
130 version = mongoconn.server_info()['version']
131 if tuple(map(int, version.split('.')[:2])) < (1, 3):
132 raise NotImplementedError(
133 'Kombu requires MongoDB version 1.3+ (server is {0})'.format(
134 version))
135
136 self.db = database
137 col = database.messages
138 col.ensure_index([('queue', 1), ('_id', 1)], background=True)
139
140 if 'messages.broadcast' not in database.collection_names():
141 capsize = options.get('capped_queue_size') or 100000
142 database.create_collection('messages.broadcast',
143 size=capsize, capped=True)
144
145 self.bcast = getattr(database, 'messages.broadcast')
146 self.bcast.ensure_index([('queue', 1)])
147
148 self.routing = getattr(database, 'messages.routing')
149 self.routing.ensure_index([('queue', 1), ('exchange', 1)])
150 return database
151
152 #TODO: Store a more complete exchange metatable in the routing collection
153 def get_table(self, exchange):
154 """Get table of bindings for ``exchange``."""
155 localRoutes = frozenset(self.state.exchanges[exchange]['table'])
156 brokerRoutes = self.client.messages.routing.find(
157 {'exchange': exchange}
158 )
159
160 return localRoutes | frozenset((r['routing_key'],
161 r['pattern'],
162 r['queue']) for r in brokerRoutes)
163
164 def _put_fanout(self, exchange, message, **kwargs):
165 """Deliver fanout message."""
166 self.client.messages.broadcast.insert({'payload': dumps(message),
167 'queue': exchange})
168
169 def _queue_bind(self, exchange, routing_key, pattern, queue):
170 if self.typeof(exchange).type == 'fanout':
171 cursor = self.bcast.find(query={'queue': exchange},
172 sort=[('$natural', 1)], tailable=True)
173 # Fast forward the cursor past old events
174 self._queue_cursors[queue] = cursor.skip(cursor.count())
175 self._queue_readcounts[queue] = cursor.count()
176 self._fanout_queues[queue] = exchange
177
178 meta = {'exchange': exchange,
179 'queue': queue,
180 'routing_key': routing_key,
181 'pattern': pattern}
182 self.client.messages.routing.update(meta, meta, upsert=True)
183
184 def queue_delete(self, queue, **kwargs):
185 self.routing.remove({'queue': queue})
186 super(Channel, self).queue_delete(queue, **kwargs)
187 if queue in self._fanout_queues:
188 self._queue_cursors[queue].close()
189 self._queue_cursors.pop(queue, None)
190 self._fanout_queues.pop(queue, None)
191
192 @property
193 def client(self):
194 if self._client is None:
195 self._client = self._open()
196 return self._client
197
198
199 class Transport(virtual.Transport):
200 Channel = Channel
201
202 can_parse_url = True
203 polling_interval = 1
204 default_port = DEFAULT_PORT
205 connection_errors = (
206 virtual.Transport.connection_errors + (errors.ConnectionFailure, )
207 )
208 channel_errors = (
209 virtual.Transport.channel_errors + (
210 errors.ConnectionFailure,
211 errors.OperationFailure)
212 )
213 driver_type = 'mongodb'
214 driver_name = 'pymongo'
215
216 def driver_version(self):
217 return pymongo.version
218
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/kombu/transport/mongodb.py b/kombu/transport/mongodb.py
--- a/kombu/transport/mongodb.py
+++ b/kombu/transport/mongodb.py
@@ -14,7 +14,7 @@
from pymongo import errors
from anyjson import loads, dumps
-from pymongo import MongoClient
+from pymongo import MongoClient, uri_parser
from kombu.five import Empty
from kombu.syn import _detect_environment
@@ -91,38 +91,52 @@
self.client.messages.remove({'queue': queue})
return size
- def _open(self, scheme='mongodb://'):
+ def _parse_uri(self, scheme='mongodb://'):
# See mongodb uri documentation:
- # http://www.mongodb.org/display/DOCS/Connections
+ # http://docs.mongodb.org/manual/reference/connection-string/
client = self.connection.client
- options = client.transport_options
- hostname = client.hostname or DEFAULT_HOST
- dbname = client.virtual_host
+ hostname = client.hostname
- if dbname in ['/', None]:
- dbname = "kombu_default"
if not hostname.startswith(scheme):
hostname = scheme + hostname
if not hostname[len(scheme):]:
- hostname += 'localhost'
-
- # XXX What does this do? [ask]
- urest = hostname[len(scheme):]
- if '/' in urest:
- if not client.userid:
- urest = urest.replace('/' + client.virtual_host, '/')
- hostname = ''.join([scheme, urest])
-
- # At this point we expect the hostname to be something like
- # (considering replica set form too):
- #
- # mongodb://[username:password@]host1[:port1][,host2[:port2],
- # ...[,hostN[:portN]]][/[?options]]
- options.setdefault('auto_start_request', True)
+ hostname += DEFAULT_HOST
+
+ if client.userid and '@' not in hostname:
+ head, tail = hostname.split('://')
+
+ credentials = client.userid
+ if client.password:
+ credentials += ':' + client.password
+
+ hostname = head + '://' + credentials + '@' + tail
+
+ port = client.port if client.port is not None else DEFAULT_PORT
+
+ parsed = uri_parser.parse_uri(hostname, port)
+
+ dbname = parsed['database'] or client.virtual_host
+
+ if dbname in ('/', None):
+ dbname = 'kombu_default'
+
+ options = {'auto_start_request': True,
+ 'ssl': client.ssl,
+ 'connectTimeoutMS': int(client.connect_timeout * 1000)
+ if client.connect_timeout else None}
+ options.update(client.transport_options)
+ options.update(parsed['options'])
+
+ return hostname, dbname, options
+
+ def _open(self, scheme='mongodb://'):
+ hostname, dbname, options = self._parse_uri(scheme=scheme)
+
mongoconn = MongoClient(
- host=hostname, ssl=client.ssl,
+ host=hostname, ssl=options['ssl'],
auto_start_request=options['auto_start_request'],
+ connectTimeoutMS=options['connectTimeoutMS'],
use_greenlets=_detect_environment() != 'default',
)
database = getattr(mongoconn, dbname)
|
{"golden_diff": "diff --git a/kombu/transport/mongodb.py b/kombu/transport/mongodb.py\n--- a/kombu/transport/mongodb.py\n+++ b/kombu/transport/mongodb.py\n@@ -14,7 +14,7 @@\n \n from pymongo import errors\n from anyjson import loads, dumps\n-from pymongo import MongoClient\n+from pymongo import MongoClient, uri_parser\n \n from kombu.five import Empty\n from kombu.syn import _detect_environment\n@@ -91,38 +91,52 @@\n self.client.messages.remove({'queue': queue})\n return size\n \n- def _open(self, scheme='mongodb://'):\n+ def _parse_uri(self, scheme='mongodb://'):\n # See mongodb uri documentation:\n- # http://www.mongodb.org/display/DOCS/Connections\n+ # http://docs.mongodb.org/manual/reference/connection-string/\n client = self.connection.client\n- options = client.transport_options\n- hostname = client.hostname or DEFAULT_HOST\n- dbname = client.virtual_host\n+ hostname = client.hostname\n \n- if dbname in ['/', None]:\n- dbname = \"kombu_default\"\n if not hostname.startswith(scheme):\n hostname = scheme + hostname\n \n if not hostname[len(scheme):]:\n- hostname += 'localhost'\n-\n- # XXX What does this do? [ask]\n- urest = hostname[len(scheme):]\n- if '/' in urest:\n- if not client.userid:\n- urest = urest.replace('/' + client.virtual_host, '/')\n- hostname = ''.join([scheme, urest])\n-\n- # At this point we expect the hostname to be something like\n- # (considering replica set form too):\n- #\n- # mongodb://[username:password@]host1[:port1][,host2[:port2],\n- # ...[,hostN[:portN]]][/[?options]]\n- options.setdefault('auto_start_request', True)\n+ hostname += DEFAULT_HOST\n+\n+ if client.userid and '@' not in hostname:\n+ head, tail = hostname.split('://')\n+\n+ credentials = client.userid\n+ if client.password:\n+ credentials += ':' + client.password\n+\n+ hostname = head + '://' + credentials + '@' + tail\n+\n+ port = client.port if client.port is not None else DEFAULT_PORT\n+\n+ parsed = uri_parser.parse_uri(hostname, port)\n+\n+ dbname = parsed['database'] or client.virtual_host\n+\n+ if dbname in ('/', None):\n+ dbname = 'kombu_default'\n+\n+ options = {'auto_start_request': True,\n+ 'ssl': client.ssl,\n+ 'connectTimeoutMS': int(client.connect_timeout * 1000)\n+ if client.connect_timeout else None}\n+ options.update(client.transport_options)\n+ options.update(parsed['options'])\n+\n+ return hostname, dbname, options\n+\n+ def _open(self, scheme='mongodb://'):\n+ hostname, dbname, options = self._parse_uri(scheme=scheme)\n+\n mongoconn = MongoClient(\n- host=hostname, ssl=client.ssl,\n+ host=hostname, ssl=options['ssl'],\n auto_start_request=options['auto_start_request'],\n+ connectTimeoutMS=options['connectTimeoutMS'],\n use_greenlets=_detect_environment() != 'default',\n )\n database = getattr(mongoconn, dbname)\n", "issue": "Mongodb url is broken in Kombu 3.0.1\nUpgrading to version 3.0.1, a mongodb url like mongodb://localhost/wq fails as the // gets converted to / by some code in transport/mongodb.py - basically it seems to boil down to this code:-\n\n```\n if '/' in hostname[10:]:\n if not client.userid:\n hostname = hostname.replace('/' + client.virtual_host, '/')\n else:\n hostname = hostname.replace('/' + client.virtual_host, '/' + authdb)\n```\n\nby default virtual_host == '/' so basically hostname becomes:-\n\nmongodb:/localhost/wq instead of mongodb://localhost/wq causing the MongoClient to fail wit a port not an integer error.\n\nright now can work around this by setting the url to mongodb:////localhost/wq but its a kludge.\n\nmongodb transport no longer honors configured port.\nThe mongodb transport in kombu version 2.1.3 (version according to pypi) has changed the BrokerConnection arguments that it uses. We are passing in hostname, port, and transport in as separate BrokerConnection arguments, but the mongodb transport now expects to get all that information out of hostname, which it assumes is a mongodb:// URI.\n\nFor some history, version 1.5.0 changed the parse_url() function so that the port was no longer parsed out of mongodb:// URIs. So we were forced to pass the hostname, port, and transport in as separate BrokerConnection arguments. Now, we are being forced back to passing a mongodb:// URI in as the hostname.\n\n", "before_files": [{"content": "\"\"\"\nkombu.transport.mongodb\n=======================\n\nMongoDB transport.\n\n:copyright: (c) 2010 - 2013 by Flavio Percoco Premoli.\n:license: BSD, see LICENSE for more details.\n\n\"\"\"\nfrom __future__ import absolute_import\n\nimport pymongo\n\nfrom pymongo import errors\nfrom anyjson import loads, dumps\nfrom pymongo import MongoClient\n\nfrom kombu.five import Empty\nfrom kombu.syn import _detect_environment\nfrom kombu.utils.encoding import bytes_to_str\n\nfrom . import virtual\n\nDEFAULT_HOST = '127.0.0.1'\nDEFAULT_PORT = 27017\n\n__author__ = \"\"\"\\\nFlavio [FlaPer87] Percoco Premoli <[email protected]>;\\\nScott Lyons <[email protected]>;\\\n\"\"\"\n\n\nclass Channel(virtual.Channel):\n _client = None\n supports_fanout = True\n _fanout_queues = {}\n\n def __init__(self, *vargs, **kwargs):\n super_ = super(Channel, self)\n super_.__init__(*vargs, **kwargs)\n\n self._queue_cursors = {}\n self._queue_readcounts = {}\n\n def _new_queue(self, queue, **kwargs):\n pass\n\n def _get(self, queue):\n try:\n if queue in self._fanout_queues:\n msg = next(self._queue_cursors[queue])\n self._queue_readcounts[queue] += 1\n return loads(bytes_to_str(msg['payload']))\n else:\n msg = self.client.command(\n 'findandmodify', 'messages',\n query={'queue': queue},\n sort={'_id': pymongo.ASCENDING}, remove=True,\n )\n except errors.OperationFailure as exc:\n if 'No matching object found' in exc.args[0]:\n raise Empty()\n raise\n except StopIteration:\n raise Empty()\n\n # as of mongo 2.0 empty results won't raise an error\n if msg['value'] is None:\n raise Empty()\n return loads(bytes_to_str(msg['value']['payload']))\n\n def _size(self, queue):\n if queue in self._fanout_queues:\n return (self._queue_cursors[queue].count() -\n self._queue_readcounts[queue])\n\n return self.client.messages.find({'queue': queue}).count()\n\n def _put(self, queue, message, **kwargs):\n self.client.messages.insert({'payload': dumps(message),\n 'queue': queue})\n\n def _purge(self, queue):\n size = self._size(queue)\n if queue in self._fanout_queues:\n cursor = self._queue_cursors[queue]\n cursor.rewind()\n self._queue_cursors[queue] = cursor.skip(cursor.count())\n else:\n self.client.messages.remove({'queue': queue})\n return size\n\n def _open(self, scheme='mongodb://'):\n # See mongodb uri documentation:\n # http://www.mongodb.org/display/DOCS/Connections\n client = self.connection.client\n options = client.transport_options\n hostname = client.hostname or DEFAULT_HOST\n dbname = client.virtual_host\n\n if dbname in ['/', None]:\n dbname = \"kombu_default\"\n if not hostname.startswith(scheme):\n hostname = scheme + hostname\n\n if not hostname[len(scheme):]:\n hostname += 'localhost'\n\n # XXX What does this do? [ask]\n urest = hostname[len(scheme):]\n if '/' in urest:\n if not client.userid:\n urest = urest.replace('/' + client.virtual_host, '/')\n hostname = ''.join([scheme, urest])\n\n # At this point we expect the hostname to be something like\n # (considering replica set form too):\n #\n # mongodb://[username:password@]host1[:port1][,host2[:port2],\n # ...[,hostN[:portN]]][/[?options]]\n options.setdefault('auto_start_request', True)\n mongoconn = MongoClient(\n host=hostname, ssl=client.ssl,\n auto_start_request=options['auto_start_request'],\n use_greenlets=_detect_environment() != 'default',\n )\n database = getattr(mongoconn, dbname)\n\n version = mongoconn.server_info()['version']\n if tuple(map(int, version.split('.')[:2])) < (1, 3):\n raise NotImplementedError(\n 'Kombu requires MongoDB version 1.3+ (server is {0})'.format(\n version))\n\n self.db = database\n col = database.messages\n col.ensure_index([('queue', 1), ('_id', 1)], background=True)\n\n if 'messages.broadcast' not in database.collection_names():\n capsize = options.get('capped_queue_size') or 100000\n database.create_collection('messages.broadcast',\n size=capsize, capped=True)\n\n self.bcast = getattr(database, 'messages.broadcast')\n self.bcast.ensure_index([('queue', 1)])\n\n self.routing = getattr(database, 'messages.routing')\n self.routing.ensure_index([('queue', 1), ('exchange', 1)])\n return database\n\n #TODO: Store a more complete exchange metatable in the routing collection\n def get_table(self, exchange):\n \"\"\"Get table of bindings for ``exchange``.\"\"\"\n localRoutes = frozenset(self.state.exchanges[exchange]['table'])\n brokerRoutes = self.client.messages.routing.find(\n {'exchange': exchange}\n )\n\n return localRoutes | frozenset((r['routing_key'],\n r['pattern'],\n r['queue']) for r in brokerRoutes)\n\n def _put_fanout(self, exchange, message, **kwargs):\n \"\"\"Deliver fanout message.\"\"\"\n self.client.messages.broadcast.insert({'payload': dumps(message),\n 'queue': exchange})\n\n def _queue_bind(self, exchange, routing_key, pattern, queue):\n if self.typeof(exchange).type == 'fanout':\n cursor = self.bcast.find(query={'queue': exchange},\n sort=[('$natural', 1)], tailable=True)\n # Fast forward the cursor past old events\n self._queue_cursors[queue] = cursor.skip(cursor.count())\n self._queue_readcounts[queue] = cursor.count()\n self._fanout_queues[queue] = exchange\n\n meta = {'exchange': exchange,\n 'queue': queue,\n 'routing_key': routing_key,\n 'pattern': pattern}\n self.client.messages.routing.update(meta, meta, upsert=True)\n\n def queue_delete(self, queue, **kwargs):\n self.routing.remove({'queue': queue})\n super(Channel, self).queue_delete(queue, **kwargs)\n if queue in self._fanout_queues:\n self._queue_cursors[queue].close()\n self._queue_cursors.pop(queue, None)\n self._fanout_queues.pop(queue, None)\n\n @property\n def client(self):\n if self._client is None:\n self._client = self._open()\n return self._client\n\n\nclass Transport(virtual.Transport):\n Channel = Channel\n\n can_parse_url = True\n polling_interval = 1\n default_port = DEFAULT_PORT\n connection_errors = (\n virtual.Transport.connection_errors + (errors.ConnectionFailure, )\n )\n channel_errors = (\n virtual.Transport.channel_errors + (\n errors.ConnectionFailure,\n errors.OperationFailure)\n )\n driver_type = 'mongodb'\n driver_name = 'pymongo'\n\n def driver_version(self):\n return pymongo.version\n", "path": "kombu/transport/mongodb.py"}], "after_files": [{"content": "\"\"\"\nkombu.transport.mongodb\n=======================\n\nMongoDB transport.\n\n:copyright: (c) 2010 - 2013 by Flavio Percoco Premoli.\n:license: BSD, see LICENSE for more details.\n\n\"\"\"\nfrom __future__ import absolute_import\n\nimport pymongo\n\nfrom pymongo import errors\nfrom anyjson import loads, dumps\nfrom pymongo import MongoClient, uri_parser\n\nfrom kombu.five import Empty\nfrom kombu.syn import _detect_environment\nfrom kombu.utils.encoding import bytes_to_str\n\nfrom . import virtual\n\nDEFAULT_HOST = '127.0.0.1'\nDEFAULT_PORT = 27017\n\n__author__ = \"\"\"\\\nFlavio [FlaPer87] Percoco Premoli <[email protected]>;\\\nScott Lyons <[email protected]>;\\\n\"\"\"\n\n\nclass Channel(virtual.Channel):\n _client = None\n supports_fanout = True\n _fanout_queues = {}\n\n def __init__(self, *vargs, **kwargs):\n super_ = super(Channel, self)\n super_.__init__(*vargs, **kwargs)\n\n self._queue_cursors = {}\n self._queue_readcounts = {}\n\n def _new_queue(self, queue, **kwargs):\n pass\n\n def _get(self, queue):\n try:\n if queue in self._fanout_queues:\n msg = next(self._queue_cursors[queue])\n self._queue_readcounts[queue] += 1\n return loads(bytes_to_str(msg['payload']))\n else:\n msg = self.client.command(\n 'findandmodify', 'messages',\n query={'queue': queue},\n sort={'_id': pymongo.ASCENDING}, remove=True,\n )\n except errors.OperationFailure as exc:\n if 'No matching object found' in exc.args[0]:\n raise Empty()\n raise\n except StopIteration:\n raise Empty()\n\n # as of mongo 2.0 empty results won't raise an error\n if msg['value'] is None:\n raise Empty()\n return loads(bytes_to_str(msg['value']['payload']))\n\n def _size(self, queue):\n if queue in self._fanout_queues:\n return (self._queue_cursors[queue].count() -\n self._queue_readcounts[queue])\n\n return self.client.messages.find({'queue': queue}).count()\n\n def _put(self, queue, message, **kwargs):\n self.client.messages.insert({'payload': dumps(message),\n 'queue': queue})\n\n def _purge(self, queue):\n size = self._size(queue)\n if queue in self._fanout_queues:\n cursor = self._queue_cursors[queue]\n cursor.rewind()\n self._queue_cursors[queue] = cursor.skip(cursor.count())\n else:\n self.client.messages.remove({'queue': queue})\n return size\n\n def _parse_uri(self, scheme='mongodb://'):\n # See mongodb uri documentation:\n # http://docs.mongodb.org/manual/reference/connection-string/\n client = self.connection.client\n hostname = client.hostname\n\n if not hostname.startswith(scheme):\n hostname = scheme + hostname\n\n if not hostname[len(scheme):]:\n hostname += DEFAULT_HOST\n\n if client.userid and '@' not in hostname:\n head, tail = hostname.split('://')\n\n credentials = client.userid\n if client.password:\n credentials += ':' + client.password\n\n hostname = head + '://' + credentials + '@' + tail\n\n port = client.port if client.port is not None else DEFAULT_PORT\n\n parsed = uri_parser.parse_uri(hostname, port)\n\n dbname = parsed['database'] or client.virtual_host\n\n if dbname in ('/', None):\n dbname = 'kombu_default'\n\n options = {'auto_start_request': True,\n 'ssl': client.ssl,\n 'connectTimeoutMS': int(client.connect_timeout * 1000)\n if client.connect_timeout else None}\n options.update(client.transport_options)\n options.update(parsed['options'])\n\n return hostname, dbname, options\n\n def _open(self, scheme='mongodb://'):\n hostname, dbname, options = self._parse_uri(scheme=scheme)\n\n mongoconn = MongoClient(\n host=hostname, ssl=options['ssl'],\n auto_start_request=options['auto_start_request'],\n connectTimeoutMS=options['connectTimeoutMS'],\n use_greenlets=_detect_environment() != 'default',\n )\n database = getattr(mongoconn, dbname)\n\n version = mongoconn.server_info()['version']\n if tuple(map(int, version.split('.')[:2])) < (1, 3):\n raise NotImplementedError(\n 'Kombu requires MongoDB version 1.3+ (server is {0})'.format(\n version))\n\n self.db = database\n col = database.messages\n col.ensure_index([('queue', 1), ('_id', 1)], background=True)\n\n if 'messages.broadcast' not in database.collection_names():\n capsize = options.get('capped_queue_size') or 100000\n database.create_collection('messages.broadcast',\n size=capsize, capped=True)\n\n self.bcast = getattr(database, 'messages.broadcast')\n self.bcast.ensure_index([('queue', 1)])\n\n self.routing = getattr(database, 'messages.routing')\n self.routing.ensure_index([('queue', 1), ('exchange', 1)])\n return database\n\n #TODO: Store a more complete exchange metatable in the routing collection\n def get_table(self, exchange):\n \"\"\"Get table of bindings for ``exchange``.\"\"\"\n localRoutes = frozenset(self.state.exchanges[exchange]['table'])\n brokerRoutes = self.client.messages.routing.find(\n {'exchange': exchange}\n )\n\n return localRoutes | frozenset((r['routing_key'],\n r['pattern'],\n r['queue']) for r in brokerRoutes)\n\n def _put_fanout(self, exchange, message, **kwargs):\n \"\"\"Deliver fanout message.\"\"\"\n self.client.messages.broadcast.insert({'payload': dumps(message),\n 'queue': exchange})\n\n def _queue_bind(self, exchange, routing_key, pattern, queue):\n if self.typeof(exchange).type == 'fanout':\n cursor = self.bcast.find(query={'queue': exchange},\n sort=[('$natural', 1)], tailable=True)\n # Fast forward the cursor past old events\n self._queue_cursors[queue] = cursor.skip(cursor.count())\n self._queue_readcounts[queue] = cursor.count()\n self._fanout_queues[queue] = exchange\n\n meta = {'exchange': exchange,\n 'queue': queue,\n 'routing_key': routing_key,\n 'pattern': pattern}\n self.client.messages.routing.update(meta, meta, upsert=True)\n\n def queue_delete(self, queue, **kwargs):\n self.routing.remove({'queue': queue})\n super(Channel, self).queue_delete(queue, **kwargs)\n if queue in self._fanout_queues:\n self._queue_cursors[queue].close()\n self._queue_cursors.pop(queue, None)\n self._fanout_queues.pop(queue, None)\n\n @property\n def client(self):\n if self._client is None:\n self._client = self._open()\n return self._client\n\n\nclass Transport(virtual.Transport):\n Channel = Channel\n\n can_parse_url = True\n polling_interval = 1\n default_port = DEFAULT_PORT\n connection_errors = (\n virtual.Transport.connection_errors + (errors.ConnectionFailure, )\n )\n channel_errors = (\n virtual.Transport.channel_errors + (\n errors.ConnectionFailure,\n errors.OperationFailure)\n )\n driver_type = 'mongodb'\n driver_name = 'pymongo'\n\n def driver_version(self):\n return pymongo.version\n", "path": "kombu/transport/mongodb.py"}]}
| 2,777 | 742 |
gh_patches_debug_18611
|
rasdani/github-patches
|
git_diff
|
jupyterhub__zero-to-jupyterhub-k8s-574
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Cull_idle fails for some users with non ascii usernames
At the moment Cull Idle queries the API for the users with inactive running servers and sends a `DELETE` to the endpoint users/USERNAME/server. https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/706a8f7637881ace06b66c90c5267019d75d2cf0/images/hub/cull_idle_servers.py#L69 This works for most users, but fails with users with non ASCII usernames as the api responds with a 404.
By url-encoding the username we can make sure it works for every user.
Cull_idle fails for some users with non ascii usernames
At the moment Cull Idle queries the API for the users with inactive running servers and sends a `DELETE` to the endpoint users/USERNAME/server. https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/706a8f7637881ace06b66c90c5267019d75d2cf0/images/hub/cull_idle_servers.py#L69 This works for most users, but fails with users with non ASCII usernames as the api responds with a 404.
By url-encoding the username we can make sure it works for every user.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `images/hub/cull_idle_servers.py`
Content:
```
1 #!/usr/bin/env python3
2 # Imported from https://github.com/jupyterhub/jupyterhub/blob/0.8.0rc1/examples/cull-idle/cull_idle_servers.py
3 """script to monitor and cull idle single-user servers
4
5 Caveats:
6
7 last_activity is not updated with high frequency,
8 so cull timeout should be greater than the sum of:
9
10 - single-user websocket ping interval (default: 30s)
11 - JupyterHub.last_activity_interval (default: 5 minutes)
12
13 You can run this as a service managed by JupyterHub with this in your config::
14
15
16 c.JupyterHub.services = [
17 {
18 'name': 'cull-idle',
19 'admin': True,
20 'command': 'python cull_idle_servers.py --timeout=3600'.split(),
21 }
22 ]
23
24 Or run it manually by generating an API token and storing it in `JUPYTERHUB_API_TOKEN`:
25
26 export JUPYTERHUB_API_TOKEN=`jupyterhub token`
27 python cull_idle_servers.py [--timeout=900] [--url=http://127.0.0.1:8081/hub/api]
28 """
29
30 import datetime
31 import json
32 import os
33
34 from dateutil.parser import parse as parse_date
35
36 from tornado.gen import coroutine
37 from tornado.log import app_log
38 from tornado.httpclient import AsyncHTTPClient, HTTPRequest
39 from tornado.ioloop import IOLoop, PeriodicCallback
40 from tornado.options import define, options, parse_command_line
41
42
43 @coroutine
44 def cull_idle(url, api_token, timeout, cull_users=False):
45 """Shutdown idle single-user servers
46
47 If cull_users, inactive *users* will be deleted as well.
48 """
49 auth_header = {
50 'Authorization': 'token %s' % api_token
51 }
52 req = HTTPRequest(url=url + '/users',
53 headers=auth_header,
54 )
55 now = datetime.datetime.utcnow()
56 cull_limit = now - datetime.timedelta(seconds=timeout)
57 client = AsyncHTTPClient()
58 resp = yield client.fetch(req)
59 users = json.loads(resp.body.decode('utf8', 'replace'))
60 futures = []
61
62 @coroutine
63 def cull_one(user, last_activity):
64 """cull one user"""
65
66 # shutdown server first. Hub doesn't allow deleting users with running servers.
67 if user['server']:
68 app_log.info("Culling server for %s (inactive since %s)", user['name'], last_activity)
69 req = HTTPRequest(url=url + '/users/%s/server' % user['name'],
70 method='DELETE',
71 headers=auth_header,
72 )
73 resp = yield client.fetch(req)
74 if resp.code == 202:
75 msg = "Server for {} is slow to stop.".format(user['name'])
76 if cull_users:
77 app_log.warning(msg + " Not culling user yet.")
78 # return here so we don't continue to cull the user
79 # which will fail if the server is still trying to shutdown
80 return
81 app_log.warning(msg)
82 if cull_users:
83 app_log.info("Culling user %s (inactive since %s)", user['name'], last_activity)
84 req = HTTPRequest(url=url + '/users/%s' % user['name'],
85 method='DELETE',
86 headers=auth_header,
87 )
88 yield client.fetch(req)
89
90 for user in users:
91 if not user['server'] and not cull_users:
92 # server not running and not culling users, nothing to do
93 continue
94 if not user['last_activity']:
95 continue
96 last_activity = parse_date(user['last_activity'])
97 if last_activity < cull_limit:
98 # user might be in a transition (e.g. starting or stopping)
99 # don't try to cull if this is happening
100 if user['pending']:
101 app_log.warning("Not culling user %s with pending %s", user['name'], user['pending'])
102 continue
103 futures.append((user['name'], cull_one(user, last_activity)))
104 else:
105 app_log.debug("Not culling %s (active since %s)", user['name'], last_activity)
106
107 for (name, f) in futures:
108 try:
109 yield f
110 except Exception:
111 app_log.exception("Error culling %s", name)
112 else:
113 app_log.debug("Finished culling %s", name)
114
115
116 if __name__ == '__main__':
117 define('url', default=os.environ.get('JUPYTERHUB_API_URL'), help="The JupyterHub API URL")
118 define('timeout', default=600, help="The idle timeout (in seconds)")
119 define('cull_every', default=0, help="The interval (in seconds) for checking for idle servers to cull")
120 define('cull_users', default=False,
121 help="""Cull users in addition to servers.
122 This is for use in temporary-user cases such as tmpnb.""",
123 )
124
125 parse_command_line()
126 if not options.cull_every:
127 options.cull_every = options.timeout // 2
128 api_token = os.environ['JUPYTERHUB_API_TOKEN']
129
130 try:
131 AsyncHTTPClient.configure("tornado.curl_httpclient.CurlAsyncHTTPClient")
132 except ImportError as e:
133 app_log.warning("Could not load pycurl: %s\npycurl is recommended if you have a large number of users.", e)
134
135 loop = IOLoop.current()
136 cull = lambda : cull_idle(options.url, api_token, options.timeout, options.cull_users)
137 # schedule first cull immediately
138 # because PeriodicCallback doesn't start until the end of the first interval
139 loop.add_callback(cull)
140 # schedule periodic cull
141 pc = PeriodicCallback(cull, 1e3 * options.cull_every)
142 pc.start()
143 try:
144 loop.start()
145 except KeyboardInterrupt:
146 pass
147
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/images/hub/cull_idle_servers.py b/images/hub/cull_idle_servers.py
--- a/images/hub/cull_idle_servers.py
+++ b/images/hub/cull_idle_servers.py
@@ -31,6 +31,11 @@
import json
import os
+try:
+ from urllib.parse import quote
+except ImportError:
+ from urllib import quote
+
from dateutil.parser import parse as parse_date
from tornado.gen import coroutine
@@ -66,7 +71,7 @@
# shutdown server first. Hub doesn't allow deleting users with running servers.
if user['server']:
app_log.info("Culling server for %s (inactive since %s)", user['name'], last_activity)
- req = HTTPRequest(url=url + '/users/%s/server' % user['name'],
+ req = HTTPRequest(url=url + '/users/%s/server' % quote(user['name']),
method='DELETE',
headers=auth_header,
)
|
{"golden_diff": "diff --git a/images/hub/cull_idle_servers.py b/images/hub/cull_idle_servers.py\n--- a/images/hub/cull_idle_servers.py\n+++ b/images/hub/cull_idle_servers.py\n@@ -31,6 +31,11 @@\n import json\n import os\n \n+try:\n+ from urllib.parse import quote\n+except ImportError:\n+ from urllib import quote\n+\n from dateutil.parser import parse as parse_date\n \n from tornado.gen import coroutine\n@@ -66,7 +71,7 @@\n # shutdown server first. Hub doesn't allow deleting users with running servers.\n if user['server']:\n app_log.info(\"Culling server for %s (inactive since %s)\", user['name'], last_activity)\n- req = HTTPRequest(url=url + '/users/%s/server' % user['name'],\n+ req = HTTPRequest(url=url + '/users/%s/server' % quote(user['name']),\n method='DELETE',\n headers=auth_header,\n )\n", "issue": "Cull_idle fails for some users with non ascii usernames\nAt the moment Cull Idle queries the API for the users with inactive running servers and sends a `DELETE` to the endpoint users/USERNAME/server. https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/706a8f7637881ace06b66c90c5267019d75d2cf0/images/hub/cull_idle_servers.py#L69 This works for most users, but fails with users with non ASCII usernames as the api responds with a 404.\r\n\r\nBy url-encoding the username we can make sure it works for every user.\nCull_idle fails for some users with non ascii usernames\nAt the moment Cull Idle queries the API for the users with inactive running servers and sends a `DELETE` to the endpoint users/USERNAME/server. https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/706a8f7637881ace06b66c90c5267019d75d2cf0/images/hub/cull_idle_servers.py#L69 This works for most users, but fails with users with non ASCII usernames as the api responds with a 404.\r\n\r\nBy url-encoding the username we can make sure it works for every user.\n", "before_files": [{"content": "#!/usr/bin/env python3\n# Imported from https://github.com/jupyterhub/jupyterhub/blob/0.8.0rc1/examples/cull-idle/cull_idle_servers.py\n\"\"\"script to monitor and cull idle single-user servers\n\nCaveats:\n\nlast_activity is not updated with high frequency,\nso cull timeout should be greater than the sum of:\n\n- single-user websocket ping interval (default: 30s)\n- JupyterHub.last_activity_interval (default: 5 minutes)\n\nYou can run this as a service managed by JupyterHub with this in your config::\n\n\n c.JupyterHub.services = [\n {\n 'name': 'cull-idle',\n 'admin': True,\n 'command': 'python cull_idle_servers.py --timeout=3600'.split(),\n }\n ]\n\nOr run it manually by generating an API token and storing it in `JUPYTERHUB_API_TOKEN`:\n\n export JUPYTERHUB_API_TOKEN=`jupyterhub token`\n python cull_idle_servers.py [--timeout=900] [--url=http://127.0.0.1:8081/hub/api]\n\"\"\"\n\nimport datetime\nimport json\nimport os\n\nfrom dateutil.parser import parse as parse_date\n\nfrom tornado.gen import coroutine\nfrom tornado.log import app_log\nfrom tornado.httpclient import AsyncHTTPClient, HTTPRequest\nfrom tornado.ioloop import IOLoop, PeriodicCallback\nfrom tornado.options import define, options, parse_command_line\n\n\n@coroutine\ndef cull_idle(url, api_token, timeout, cull_users=False):\n \"\"\"Shutdown idle single-user servers\n\n If cull_users, inactive *users* will be deleted as well.\n \"\"\"\n auth_header = {\n 'Authorization': 'token %s' % api_token\n }\n req = HTTPRequest(url=url + '/users',\n headers=auth_header,\n )\n now = datetime.datetime.utcnow()\n cull_limit = now - datetime.timedelta(seconds=timeout)\n client = AsyncHTTPClient()\n resp = yield client.fetch(req)\n users = json.loads(resp.body.decode('utf8', 'replace'))\n futures = []\n\n @coroutine\n def cull_one(user, last_activity):\n \"\"\"cull one user\"\"\"\n\n # shutdown server first. Hub doesn't allow deleting users with running servers.\n if user['server']:\n app_log.info(\"Culling server for %s (inactive since %s)\", user['name'], last_activity)\n req = HTTPRequest(url=url + '/users/%s/server' % user['name'],\n method='DELETE',\n headers=auth_header,\n )\n resp = yield client.fetch(req)\n if resp.code == 202:\n msg = \"Server for {} is slow to stop.\".format(user['name'])\n if cull_users:\n app_log.warning(msg + \" Not culling user yet.\")\n # return here so we don't continue to cull the user\n # which will fail if the server is still trying to shutdown\n return\n app_log.warning(msg)\n if cull_users:\n app_log.info(\"Culling user %s (inactive since %s)\", user['name'], last_activity)\n req = HTTPRequest(url=url + '/users/%s' % user['name'],\n method='DELETE',\n headers=auth_header,\n )\n yield client.fetch(req)\n\n for user in users:\n if not user['server'] and not cull_users:\n # server not running and not culling users, nothing to do\n continue\n if not user['last_activity']:\n continue\n last_activity = parse_date(user['last_activity'])\n if last_activity < cull_limit:\n # user might be in a transition (e.g. starting or stopping)\n # don't try to cull if this is happening\n if user['pending']:\n app_log.warning(\"Not culling user %s with pending %s\", user['name'], user['pending'])\n continue\n futures.append((user['name'], cull_one(user, last_activity)))\n else:\n app_log.debug(\"Not culling %s (active since %s)\", user['name'], last_activity)\n\n for (name, f) in futures:\n try:\n yield f\n except Exception:\n app_log.exception(\"Error culling %s\", name)\n else:\n app_log.debug(\"Finished culling %s\", name)\n\n\nif __name__ == '__main__':\n define('url', default=os.environ.get('JUPYTERHUB_API_URL'), help=\"The JupyterHub API URL\")\n define('timeout', default=600, help=\"The idle timeout (in seconds)\")\n define('cull_every', default=0, help=\"The interval (in seconds) for checking for idle servers to cull\")\n define('cull_users', default=False,\n help=\"\"\"Cull users in addition to servers.\n This is for use in temporary-user cases such as tmpnb.\"\"\",\n )\n\n parse_command_line()\n if not options.cull_every:\n options.cull_every = options.timeout // 2\n api_token = os.environ['JUPYTERHUB_API_TOKEN']\n\n try:\n AsyncHTTPClient.configure(\"tornado.curl_httpclient.CurlAsyncHTTPClient\")\n except ImportError as e:\n app_log.warning(\"Could not load pycurl: %s\\npycurl is recommended if you have a large number of users.\", e)\n\n loop = IOLoop.current()\n cull = lambda : cull_idle(options.url, api_token, options.timeout, options.cull_users)\n # schedule first cull immediately\n # because PeriodicCallback doesn't start until the end of the first interval\n loop.add_callback(cull)\n # schedule periodic cull\n pc = PeriodicCallback(cull, 1e3 * options.cull_every)\n pc.start()\n try:\n loop.start()\n except KeyboardInterrupt:\n pass\n", "path": "images/hub/cull_idle_servers.py"}], "after_files": [{"content": "#!/usr/bin/env python3\n# Imported from https://github.com/jupyterhub/jupyterhub/blob/0.8.0rc1/examples/cull-idle/cull_idle_servers.py\n\"\"\"script to monitor and cull idle single-user servers\n\nCaveats:\n\nlast_activity is not updated with high frequency,\nso cull timeout should be greater than the sum of:\n\n- single-user websocket ping interval (default: 30s)\n- JupyterHub.last_activity_interval (default: 5 minutes)\n\nYou can run this as a service managed by JupyterHub with this in your config::\n\n\n c.JupyterHub.services = [\n {\n 'name': 'cull-idle',\n 'admin': True,\n 'command': 'python cull_idle_servers.py --timeout=3600'.split(),\n }\n ]\n\nOr run it manually by generating an API token and storing it in `JUPYTERHUB_API_TOKEN`:\n\n export JUPYTERHUB_API_TOKEN=`jupyterhub token`\n python cull_idle_servers.py [--timeout=900] [--url=http://127.0.0.1:8081/hub/api]\n\"\"\"\n\nimport datetime\nimport json\nimport os\n\ntry:\n from urllib.parse import quote\nexcept ImportError:\n from urllib import quote\n\nfrom dateutil.parser import parse as parse_date\n\nfrom tornado.gen import coroutine\nfrom tornado.log import app_log\nfrom tornado.httpclient import AsyncHTTPClient, HTTPRequest\nfrom tornado.ioloop import IOLoop, PeriodicCallback\nfrom tornado.options import define, options, parse_command_line\n\n\n@coroutine\ndef cull_idle(url, api_token, timeout, cull_users=False):\n \"\"\"Shutdown idle single-user servers\n\n If cull_users, inactive *users* will be deleted as well.\n \"\"\"\n auth_header = {\n 'Authorization': 'token %s' % api_token\n }\n req = HTTPRequest(url=url + '/users',\n headers=auth_header,\n )\n now = datetime.datetime.utcnow()\n cull_limit = now - datetime.timedelta(seconds=timeout)\n client = AsyncHTTPClient()\n resp = yield client.fetch(req)\n users = json.loads(resp.body.decode('utf8', 'replace'))\n futures = []\n\n @coroutine\n def cull_one(user, last_activity):\n \"\"\"cull one user\"\"\"\n\n # shutdown server first. Hub doesn't allow deleting users with running servers.\n if user['server']:\n app_log.info(\"Culling server for %s (inactive since %s)\", user['name'], last_activity)\n req = HTTPRequest(url=url + '/users/%s/server' % quote(user['name']),\n method='DELETE',\n headers=auth_header,\n )\n resp = yield client.fetch(req)\n if resp.code == 202:\n msg = \"Server for {} is slow to stop.\".format(user['name'])\n if cull_users:\n app_log.warning(msg + \" Not culling user yet.\")\n # return here so we don't continue to cull the user\n # which will fail if the server is still trying to shutdown\n return\n app_log.warning(msg)\n if cull_users:\n app_log.info(\"Culling user %s (inactive since %s)\", user['name'], last_activity)\n req = HTTPRequest(url=url + '/users/%s' % user['name'],\n method='DELETE',\n headers=auth_header,\n )\n yield client.fetch(req)\n\n for user in users:\n if not user['server'] and not cull_users:\n # server not running and not culling users, nothing to do\n continue\n if not user['last_activity']:\n continue\n last_activity = parse_date(user['last_activity'])\n if last_activity < cull_limit:\n # user might be in a transition (e.g. starting or stopping)\n # don't try to cull if this is happening\n if user['pending']:\n app_log.warning(\"Not culling user %s with pending %s\", user['name'], user['pending'])\n continue\n futures.append((user['name'], cull_one(user, last_activity)))\n else:\n app_log.debug(\"Not culling %s (active since %s)\", user['name'], last_activity)\n\n for (name, f) in futures:\n try:\n yield f\n except Exception:\n app_log.exception(\"Error culling %s\", name)\n else:\n app_log.debug(\"Finished culling %s\", name)\n\n\nif __name__ == '__main__':\n define('url', default=os.environ.get('JUPYTERHUB_API_URL'), help=\"The JupyterHub API URL\")\n define('timeout', default=600, help=\"The idle timeout (in seconds)\")\n define('cull_every', default=0, help=\"The interval (in seconds) for checking for idle servers to cull\")\n define('cull_users', default=False,\n help=\"\"\"Cull users in addition to servers.\n This is for use in temporary-user cases such as tmpnb.\"\"\",\n )\n\n parse_command_line()\n if not options.cull_every:\n options.cull_every = options.timeout // 2\n api_token = os.environ['JUPYTERHUB_API_TOKEN']\n\n try:\n AsyncHTTPClient.configure(\"tornado.curl_httpclient.CurlAsyncHTTPClient\")\n except ImportError as e:\n app_log.warning(\"Could not load pycurl: %s\\npycurl is recommended if you have a large number of users.\", e)\n\n loop = IOLoop.current()\n cull = lambda : cull_idle(options.url, api_token, options.timeout, options.cull_users)\n # schedule first cull immediately\n # because PeriodicCallback doesn't start until the end of the first interval\n loop.add_callback(cull)\n # schedule periodic cull\n pc = PeriodicCallback(cull, 1e3 * options.cull_every)\n pc.start()\n try:\n loop.start()\n except KeyboardInterrupt:\n pass\n", "path": "images/hub/cull_idle_servers.py"}]}
| 2,185 | 214 |
gh_patches_debug_39943
|
rasdani/github-patches
|
git_diff
|
pypa__pip-2798
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
pip --no-cache-dir still warns about a cache folder
If I use the `--no-cache-dir` option, I expect it to not even try to figure out any cache, but you can see that it still does, and suggest to use `sudo -H`
```
$ sudo pip --no-cache-dir --disable-pip-version-check search glop
The directory '/home/ubuntu/.cache/pip/log' or its parent directory is not owned by the current user and the debug log has been disabled. Please check the permissions and owner of that directory. If executing pip with sudo, you may want sudo's -H flag.
/usr/local/lib/python2.7/dist-packages/pip/_vendor/requests/packages/urllib3/util/ssl_.py:79: InsecurePlatformWarning: A true SSLContext object is not available. This prevents urllib3 from configuring SSL appropriately and may cause certain SSL connections to fail. For more information, see https://urllib3.readthedocs.org/en/latest/security.html#insecureplatformwarning.
InsecurePlatformWarning
glopen - Open-like interface to globus remotes
glopy - Python library wrapping Globus Toolkit credential library
```
Verbose:
```
$ sudo pip --verbose --no-cache-dir --disable-pip-version-check search glop
The directory '/home/ubuntu/.cache/pip/log' or its parent directory is not owned by the current user and the debug log has been disabled. Please check the permissions and owner of that directory. If executing pip with sudo, you may want sudo's -H flag.
Starting new HTTPS connection (1): pypi.python.org
/usr/local/lib/python2.7/dist-packages/pip/_vendor/requests/packages/urllib3/util/ssl_.py:79: InsecurePlatformWarning: A true SSLContext object is not available. This prevents urllib3 from configuring SSL appropriately and may cause certain SSL connections to fail. For more information, see https://urllib3.readthedocs.org/en/latest/security.html#insecureplatformwarning.
InsecurePlatformWarning
"POST /pypi HTTP/1.1" 200 None
glopen - Open-like interface to globus remotes
glopy - Python library wrapping Globus Toolkit credential library
```
Version:
```
$ pip --version
pip 6.1.1 from /usr/local/lib/python2.7/dist-packages (python 2.7)
```
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `pip/basecommand.py`
Content:
```
1 """Base Command class, and related routines"""
2 from __future__ import absolute_import
3
4 import logging
5 import os
6 import sys
7 import traceback
8 import optparse
9 import warnings
10
11 from pip._vendor.six import StringIO
12
13 from pip import cmdoptions
14 from pip.locations import running_under_virtualenv
15 from pip.download import PipSession
16 from pip.exceptions import (BadCommand, InstallationError, UninstallationError,
17 CommandError, PreviousBuildDirError)
18 from pip.compat import logging_dictConfig
19 from pip.baseparser import ConfigOptionParser, UpdatingDefaultsHelpFormatter
20 from pip.req import InstallRequirement, parse_requirements
21 from pip.status_codes import (
22 SUCCESS, ERROR, UNKNOWN_ERROR, VIRTUALENV_NOT_FOUND,
23 PREVIOUS_BUILD_DIR_ERROR,
24 )
25 from pip.utils import appdirs, get_prog, normalize_path
26 from pip.utils.deprecation import RemovedInPip8Warning
27 from pip.utils.filesystem import check_path_owner
28 from pip.utils.logging import IndentingFormatter
29 from pip.utils.outdated import pip_version_check
30
31
32 __all__ = ['Command']
33
34
35 logger = logging.getLogger(__name__)
36
37
38 class Command(object):
39 name = None
40 usage = None
41 hidden = False
42 log_streams = ("ext://sys.stdout", "ext://sys.stderr")
43
44 def __init__(self, isolated=False):
45 parser_kw = {
46 'usage': self.usage,
47 'prog': '%s %s' % (get_prog(), self.name),
48 'formatter': UpdatingDefaultsHelpFormatter(),
49 'add_help_option': False,
50 'name': self.name,
51 'description': self.__doc__,
52 'isolated': isolated,
53 }
54
55 self.parser = ConfigOptionParser(**parser_kw)
56
57 # Commands should add options to this option group
58 optgroup_name = '%s Options' % self.name.capitalize()
59 self.cmd_opts = optparse.OptionGroup(self.parser, optgroup_name)
60
61 # Add the general options
62 gen_opts = cmdoptions.make_option_group(
63 cmdoptions.general_group,
64 self.parser,
65 )
66 self.parser.add_option_group(gen_opts)
67
68 def _build_session(self, options, retries=None, timeout=None):
69 session = PipSession(
70 cache=(
71 normalize_path(os.path.join(options.cache_dir, "http"))
72 if options.cache_dir else None
73 ),
74 retries=retries if retries is not None else options.retries,
75 insecure_hosts=options.trusted_hosts,
76 )
77
78 # Handle custom ca-bundles from the user
79 if options.cert:
80 session.verify = options.cert
81
82 # Handle SSL client certificate
83 if options.client_cert:
84 session.cert = options.client_cert
85
86 # Handle timeouts
87 if options.timeout or timeout:
88 session.timeout = (
89 timeout if timeout is not None else options.timeout
90 )
91
92 # Handle configured proxies
93 if options.proxy:
94 session.proxies = {
95 "http": options.proxy,
96 "https": options.proxy,
97 }
98
99 # Determine if we can prompt the user for authentication or not
100 session.auth.prompting = not options.no_input
101
102 return session
103
104 def parse_args(self, args):
105 # factored out for testability
106 return self.parser.parse_args(args)
107
108 def main(self, args):
109 options, args = self.parse_args(args)
110
111 if options.quiet:
112 if options.quiet == 1:
113 level = "WARNING"
114 if options.quiet == 2:
115 level = "ERROR"
116 else:
117 level = "CRITICAL"
118 elif options.verbose:
119 level = "DEBUG"
120 else:
121 level = "INFO"
122
123 # Compute the path for our debug log.
124 debug_log_path = os.path.join(appdirs.user_log_dir("pip"), "debug.log")
125
126 # Ensure that the path for our debug log is owned by the current user
127 # and if it is not, disable the debug log.
128 write_debug_log = check_path_owner(debug_log_path)
129
130 logging_dictConfig({
131 "version": 1,
132 "disable_existing_loggers": False,
133 "filters": {
134 "exclude_warnings": {
135 "()": "pip.utils.logging.MaxLevelFilter",
136 "level": logging.WARNING,
137 },
138 },
139 "formatters": {
140 "indent": {
141 "()": IndentingFormatter,
142 "format": (
143 "%(message)s"
144 if not options.log_explicit_levels
145 else "[%(levelname)s] %(message)s"
146 ),
147 },
148 },
149 "handlers": {
150 "console": {
151 "level": level,
152 "class": "pip.utils.logging.ColorizedStreamHandler",
153 "stream": self.log_streams[0],
154 "filters": ["exclude_warnings"],
155 "formatter": "indent",
156 },
157 "console_errors": {
158 "level": "WARNING",
159 "class": "pip.utils.logging.ColorizedStreamHandler",
160 "stream": self.log_streams[1],
161 "formatter": "indent",
162 },
163 "debug_log": {
164 "level": "DEBUG",
165 "class": "pip.utils.logging.BetterRotatingFileHandler",
166 "filename": debug_log_path,
167 "maxBytes": 10 * 1000 * 1000, # 10 MB
168 "backupCount": 1,
169 "delay": True,
170 "formatter": "indent",
171 },
172 "user_log": {
173 "level": "DEBUG",
174 "class": "pip.utils.logging.BetterRotatingFileHandler",
175 "filename": options.log or "/dev/null",
176 "delay": True,
177 "formatter": "indent",
178 },
179 },
180 "root": {
181 "level": level,
182 "handlers": list(filter(None, [
183 "console",
184 "console_errors",
185 "debug_log" if write_debug_log else None,
186 "user_log" if options.log else None,
187 ])),
188 },
189 # Disable any logging besides WARNING unless we have DEBUG level
190 # logging enabled. These use both pip._vendor and the bare names
191 # for the case where someone unbundles our libraries.
192 "loggers": dict(
193 (
194 name,
195 {
196 "level": (
197 "WARNING"
198 if level in ["INFO", "ERROR"]
199 else "DEBUG"
200 ),
201 },
202 )
203 for name in ["pip._vendor", "distlib", "requests", "urllib3"]
204 ),
205 })
206
207 # We add this warning here instead of up above, because the logger
208 # hasn't been configured until just now.
209 if not write_debug_log:
210 logger.warning(
211 "The directory '%s' or its parent directory is not owned by "
212 "the current user and the debug log has been disabled. Please "
213 "check the permissions and owner of that directory. If "
214 "executing pip with sudo, you may want sudo's -H flag.",
215 os.path.dirname(debug_log_path),
216 )
217
218 if options.log_explicit_levels:
219 warnings.warn(
220 "--log-explicit-levels has been deprecated and will be removed"
221 " in a future version.",
222 RemovedInPip8Warning,
223 )
224
225 # TODO: try to get these passing down from the command?
226 # without resorting to os.environ to hold these.
227
228 if options.no_input:
229 os.environ['PIP_NO_INPUT'] = '1'
230
231 if options.exists_action:
232 os.environ['PIP_EXISTS_ACTION'] = ' '.join(options.exists_action)
233
234 if options.require_venv:
235 # If a venv is required check if it can really be found
236 if not running_under_virtualenv():
237 logger.critical(
238 'Could not find an activated virtualenv (required).'
239 )
240 sys.exit(VIRTUALENV_NOT_FOUND)
241
242 # Check if we're using the latest version of pip available
243 if (not options.disable_pip_version_check and not
244 getattr(options, "no_index", False)):
245 with self._build_session(
246 options,
247 retries=0,
248 timeout=min(5, options.timeout)) as session:
249 pip_version_check(session)
250
251 try:
252 status = self.run(options, args)
253 # FIXME: all commands should return an exit status
254 # and when it is done, isinstance is not needed anymore
255 if isinstance(status, int):
256 return status
257 except PreviousBuildDirError as exc:
258 logger.critical(str(exc))
259 logger.debug('Exception information:\n%s', format_exc())
260
261 return PREVIOUS_BUILD_DIR_ERROR
262 except (InstallationError, UninstallationError, BadCommand) as exc:
263 logger.critical(str(exc))
264 logger.debug('Exception information:\n%s', format_exc())
265
266 return ERROR
267 except CommandError as exc:
268 logger.critical('ERROR: %s', exc)
269 logger.debug('Exception information:\n%s', format_exc())
270
271 return ERROR
272 except KeyboardInterrupt:
273 logger.critical('Operation cancelled by user')
274 logger.debug('Exception information:\n%s', format_exc())
275
276 return ERROR
277 except:
278 logger.critical('Exception:\n%s', format_exc())
279
280 return UNKNOWN_ERROR
281
282 return SUCCESS
283
284
285 class RequirementCommand(Command):
286
287 @staticmethod
288 def populate_requirement_set(requirement_set, args, options, finder,
289 session, name, wheel_cache):
290 """
291 Marshal cmd line args into a requirement set.
292 """
293 for req in args:
294 requirement_set.add_requirement(
295 InstallRequirement.from_line(
296 req, None, isolated=options.isolated_mode,
297 wheel_cache=wheel_cache
298 )
299 )
300
301 for req in options.editables:
302 requirement_set.add_requirement(
303 InstallRequirement.from_editable(
304 req,
305 default_vcs=options.default_vcs,
306 isolated=options.isolated_mode,
307 wheel_cache=wheel_cache
308 )
309 )
310
311 found_req_in_file = False
312 for filename in options.requirements:
313 for req in parse_requirements(
314 filename,
315 finder=finder, options=options, session=session,
316 wheel_cache=wheel_cache):
317 found_req_in_file = True
318 requirement_set.add_requirement(req)
319
320 if not (args or options.editables or found_req_in_file):
321 opts = {'name': name}
322 if options.find_links:
323 msg = ('You must give at least one requirement to '
324 '%(name)s (maybe you meant "pip %(name)s '
325 '%(links)s"?)' %
326 dict(opts, links=' '.join(options.find_links)))
327 else:
328 msg = ('You must give at least one requirement '
329 'to %(name)s (see "pip help %(name)s")' % opts)
330 logger.warning(msg)
331
332
333 def format_exc(exc_info=None):
334 if exc_info is None:
335 exc_info = sys.exc_info()
336 out = StringIO()
337 traceback.print_exception(*exc_info, **dict(file=out))
338 return out.getvalue()
339
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/pip/basecommand.py b/pip/basecommand.py
--- a/pip/basecommand.py
+++ b/pip/basecommand.py
@@ -22,9 +22,8 @@
SUCCESS, ERROR, UNKNOWN_ERROR, VIRTUALENV_NOT_FOUND,
PREVIOUS_BUILD_DIR_ERROR,
)
-from pip.utils import appdirs, get_prog, normalize_path
+from pip.utils import get_prog, normalize_path
from pip.utils.deprecation import RemovedInPip8Warning
-from pip.utils.filesystem import check_path_owner
from pip.utils.logging import IndentingFormatter
from pip.utils.outdated import pip_version_check
@@ -120,13 +119,6 @@
else:
level = "INFO"
- # Compute the path for our debug log.
- debug_log_path = os.path.join(appdirs.user_log_dir("pip"), "debug.log")
-
- # Ensure that the path for our debug log is owned by the current user
- # and if it is not, disable the debug log.
- write_debug_log = check_path_owner(debug_log_path)
-
logging_dictConfig({
"version": 1,
"disable_existing_loggers": False,
@@ -160,15 +152,6 @@
"stream": self.log_streams[1],
"formatter": "indent",
},
- "debug_log": {
- "level": "DEBUG",
- "class": "pip.utils.logging.BetterRotatingFileHandler",
- "filename": debug_log_path,
- "maxBytes": 10 * 1000 * 1000, # 10 MB
- "backupCount": 1,
- "delay": True,
- "formatter": "indent",
- },
"user_log": {
"level": "DEBUG",
"class": "pip.utils.logging.BetterRotatingFileHandler",
@@ -182,7 +165,6 @@
"handlers": list(filter(None, [
"console",
"console_errors",
- "debug_log" if write_debug_log else None,
"user_log" if options.log else None,
])),
},
@@ -204,17 +186,6 @@
),
})
- # We add this warning here instead of up above, because the logger
- # hasn't been configured until just now.
- if not write_debug_log:
- logger.warning(
- "The directory '%s' or its parent directory is not owned by "
- "the current user and the debug log has been disabled. Please "
- "check the permissions and owner of that directory. If "
- "executing pip with sudo, you may want sudo's -H flag.",
- os.path.dirname(debug_log_path),
- )
-
if options.log_explicit_levels:
warnings.warn(
"--log-explicit-levels has been deprecated and will be removed"
|
{"golden_diff": "diff --git a/pip/basecommand.py b/pip/basecommand.py\n--- a/pip/basecommand.py\n+++ b/pip/basecommand.py\n@@ -22,9 +22,8 @@\n SUCCESS, ERROR, UNKNOWN_ERROR, VIRTUALENV_NOT_FOUND,\n PREVIOUS_BUILD_DIR_ERROR,\n )\n-from pip.utils import appdirs, get_prog, normalize_path\n+from pip.utils import get_prog, normalize_path\n from pip.utils.deprecation import RemovedInPip8Warning\n-from pip.utils.filesystem import check_path_owner\n from pip.utils.logging import IndentingFormatter\n from pip.utils.outdated import pip_version_check\n \n@@ -120,13 +119,6 @@\n else:\n level = \"INFO\"\n \n- # Compute the path for our debug log.\n- debug_log_path = os.path.join(appdirs.user_log_dir(\"pip\"), \"debug.log\")\n-\n- # Ensure that the path for our debug log is owned by the current user\n- # and if it is not, disable the debug log.\n- write_debug_log = check_path_owner(debug_log_path)\n-\n logging_dictConfig({\n \"version\": 1,\n \"disable_existing_loggers\": False,\n@@ -160,15 +152,6 @@\n \"stream\": self.log_streams[1],\n \"formatter\": \"indent\",\n },\n- \"debug_log\": {\n- \"level\": \"DEBUG\",\n- \"class\": \"pip.utils.logging.BetterRotatingFileHandler\",\n- \"filename\": debug_log_path,\n- \"maxBytes\": 10 * 1000 * 1000, # 10 MB\n- \"backupCount\": 1,\n- \"delay\": True,\n- \"formatter\": \"indent\",\n- },\n \"user_log\": {\n \"level\": \"DEBUG\",\n \"class\": \"pip.utils.logging.BetterRotatingFileHandler\",\n@@ -182,7 +165,6 @@\n \"handlers\": list(filter(None, [\n \"console\",\n \"console_errors\",\n- \"debug_log\" if write_debug_log else None,\n \"user_log\" if options.log else None,\n ])),\n },\n@@ -204,17 +186,6 @@\n ),\n })\n \n- # We add this warning here instead of up above, because the logger\n- # hasn't been configured until just now.\n- if not write_debug_log:\n- logger.warning(\n- \"The directory '%s' or its parent directory is not owned by \"\n- \"the current user and the debug log has been disabled. Please \"\n- \"check the permissions and owner of that directory. If \"\n- \"executing pip with sudo, you may want sudo's -H flag.\",\n- os.path.dirname(debug_log_path),\n- )\n-\n if options.log_explicit_levels:\n warnings.warn(\n \"--log-explicit-levels has been deprecated and will be removed\"\n", "issue": "pip --no-cache-dir still warns about a cache folder\nIf I use the `--no-cache-dir` option, I expect it to not even try to figure out any cache, but you can see that it still does, and suggest to use `sudo -H`\n\n```\n$ sudo pip --no-cache-dir --disable-pip-version-check search glop\nThe directory '/home/ubuntu/.cache/pip/log' or its parent directory is not owned by the current user and the debug log has been disabled. Please check the permissions and owner of that directory. If executing pip with sudo, you may want sudo's -H flag.\n/usr/local/lib/python2.7/dist-packages/pip/_vendor/requests/packages/urllib3/util/ssl_.py:79: InsecurePlatformWarning: A true SSLContext object is not available. This prevents urllib3 from configuring SSL appropriately and may cause certain SSL connections to fail. For more information, see https://urllib3.readthedocs.org/en/latest/security.html#insecureplatformwarning.\n InsecurePlatformWarning\nglopen - Open-like interface to globus remotes\nglopy - Python library wrapping Globus Toolkit credential library\n```\n\nVerbose:\n\n```\n$ sudo pip --verbose --no-cache-dir --disable-pip-version-check search glop\nThe directory '/home/ubuntu/.cache/pip/log' or its parent directory is not owned by the current user and the debug log has been disabled. Please check the permissions and owner of that directory. If executing pip with sudo, you may want sudo's -H flag.\nStarting new HTTPS connection (1): pypi.python.org\n/usr/local/lib/python2.7/dist-packages/pip/_vendor/requests/packages/urllib3/util/ssl_.py:79: InsecurePlatformWarning: A true SSLContext object is not available. This prevents urllib3 from configuring SSL appropriately and may cause certain SSL connections to fail. For more information, see https://urllib3.readthedocs.org/en/latest/security.html#insecureplatformwarning.\n InsecurePlatformWarning\n\"POST /pypi HTTP/1.1\" 200 None\nglopen - Open-like interface to globus remotes\nglopy - Python library wrapping Globus Toolkit credential library\n```\n\nVersion:\n\n```\n$ pip --version\npip 6.1.1 from /usr/local/lib/python2.7/dist-packages (python 2.7)\n```\n\n", "before_files": [{"content": "\"\"\"Base Command class, and related routines\"\"\"\nfrom __future__ import absolute_import\n\nimport logging\nimport os\nimport sys\nimport traceback\nimport optparse\nimport warnings\n\nfrom pip._vendor.six import StringIO\n\nfrom pip import cmdoptions\nfrom pip.locations import running_under_virtualenv\nfrom pip.download import PipSession\nfrom pip.exceptions import (BadCommand, InstallationError, UninstallationError,\n CommandError, PreviousBuildDirError)\nfrom pip.compat import logging_dictConfig\nfrom pip.baseparser import ConfigOptionParser, UpdatingDefaultsHelpFormatter\nfrom pip.req import InstallRequirement, parse_requirements\nfrom pip.status_codes import (\n SUCCESS, ERROR, UNKNOWN_ERROR, VIRTUALENV_NOT_FOUND,\n PREVIOUS_BUILD_DIR_ERROR,\n)\nfrom pip.utils import appdirs, get_prog, normalize_path\nfrom pip.utils.deprecation import RemovedInPip8Warning\nfrom pip.utils.filesystem import check_path_owner\nfrom pip.utils.logging import IndentingFormatter\nfrom pip.utils.outdated import pip_version_check\n\n\n__all__ = ['Command']\n\n\nlogger = logging.getLogger(__name__)\n\n\nclass Command(object):\n name = None\n usage = None\n hidden = False\n log_streams = (\"ext://sys.stdout\", \"ext://sys.stderr\")\n\n def __init__(self, isolated=False):\n parser_kw = {\n 'usage': self.usage,\n 'prog': '%s %s' % (get_prog(), self.name),\n 'formatter': UpdatingDefaultsHelpFormatter(),\n 'add_help_option': False,\n 'name': self.name,\n 'description': self.__doc__,\n 'isolated': isolated,\n }\n\n self.parser = ConfigOptionParser(**parser_kw)\n\n # Commands should add options to this option group\n optgroup_name = '%s Options' % self.name.capitalize()\n self.cmd_opts = optparse.OptionGroup(self.parser, optgroup_name)\n\n # Add the general options\n gen_opts = cmdoptions.make_option_group(\n cmdoptions.general_group,\n self.parser,\n )\n self.parser.add_option_group(gen_opts)\n\n def _build_session(self, options, retries=None, timeout=None):\n session = PipSession(\n cache=(\n normalize_path(os.path.join(options.cache_dir, \"http\"))\n if options.cache_dir else None\n ),\n retries=retries if retries is not None else options.retries,\n insecure_hosts=options.trusted_hosts,\n )\n\n # Handle custom ca-bundles from the user\n if options.cert:\n session.verify = options.cert\n\n # Handle SSL client certificate\n if options.client_cert:\n session.cert = options.client_cert\n\n # Handle timeouts\n if options.timeout or timeout:\n session.timeout = (\n timeout if timeout is not None else options.timeout\n )\n\n # Handle configured proxies\n if options.proxy:\n session.proxies = {\n \"http\": options.proxy,\n \"https\": options.proxy,\n }\n\n # Determine if we can prompt the user for authentication or not\n session.auth.prompting = not options.no_input\n\n return session\n\n def parse_args(self, args):\n # factored out for testability\n return self.parser.parse_args(args)\n\n def main(self, args):\n options, args = self.parse_args(args)\n\n if options.quiet:\n if options.quiet == 1:\n level = \"WARNING\"\n if options.quiet == 2:\n level = \"ERROR\"\n else:\n level = \"CRITICAL\"\n elif options.verbose:\n level = \"DEBUG\"\n else:\n level = \"INFO\"\n\n # Compute the path for our debug log.\n debug_log_path = os.path.join(appdirs.user_log_dir(\"pip\"), \"debug.log\")\n\n # Ensure that the path for our debug log is owned by the current user\n # and if it is not, disable the debug log.\n write_debug_log = check_path_owner(debug_log_path)\n\n logging_dictConfig({\n \"version\": 1,\n \"disable_existing_loggers\": False,\n \"filters\": {\n \"exclude_warnings\": {\n \"()\": \"pip.utils.logging.MaxLevelFilter\",\n \"level\": logging.WARNING,\n },\n },\n \"formatters\": {\n \"indent\": {\n \"()\": IndentingFormatter,\n \"format\": (\n \"%(message)s\"\n if not options.log_explicit_levels\n else \"[%(levelname)s] %(message)s\"\n ),\n },\n },\n \"handlers\": {\n \"console\": {\n \"level\": level,\n \"class\": \"pip.utils.logging.ColorizedStreamHandler\",\n \"stream\": self.log_streams[0],\n \"filters\": [\"exclude_warnings\"],\n \"formatter\": \"indent\",\n },\n \"console_errors\": {\n \"level\": \"WARNING\",\n \"class\": \"pip.utils.logging.ColorizedStreamHandler\",\n \"stream\": self.log_streams[1],\n \"formatter\": \"indent\",\n },\n \"debug_log\": {\n \"level\": \"DEBUG\",\n \"class\": \"pip.utils.logging.BetterRotatingFileHandler\",\n \"filename\": debug_log_path,\n \"maxBytes\": 10 * 1000 * 1000, # 10 MB\n \"backupCount\": 1,\n \"delay\": True,\n \"formatter\": \"indent\",\n },\n \"user_log\": {\n \"level\": \"DEBUG\",\n \"class\": \"pip.utils.logging.BetterRotatingFileHandler\",\n \"filename\": options.log or \"/dev/null\",\n \"delay\": True,\n \"formatter\": \"indent\",\n },\n },\n \"root\": {\n \"level\": level,\n \"handlers\": list(filter(None, [\n \"console\",\n \"console_errors\",\n \"debug_log\" if write_debug_log else None,\n \"user_log\" if options.log else None,\n ])),\n },\n # Disable any logging besides WARNING unless we have DEBUG level\n # logging enabled. These use both pip._vendor and the bare names\n # for the case where someone unbundles our libraries.\n \"loggers\": dict(\n (\n name,\n {\n \"level\": (\n \"WARNING\"\n if level in [\"INFO\", \"ERROR\"]\n else \"DEBUG\"\n ),\n },\n )\n for name in [\"pip._vendor\", \"distlib\", \"requests\", \"urllib3\"]\n ),\n })\n\n # We add this warning here instead of up above, because the logger\n # hasn't been configured until just now.\n if not write_debug_log:\n logger.warning(\n \"The directory '%s' or its parent directory is not owned by \"\n \"the current user and the debug log has been disabled. Please \"\n \"check the permissions and owner of that directory. If \"\n \"executing pip with sudo, you may want sudo's -H flag.\",\n os.path.dirname(debug_log_path),\n )\n\n if options.log_explicit_levels:\n warnings.warn(\n \"--log-explicit-levels has been deprecated and will be removed\"\n \" in a future version.\",\n RemovedInPip8Warning,\n )\n\n # TODO: try to get these passing down from the command?\n # without resorting to os.environ to hold these.\n\n if options.no_input:\n os.environ['PIP_NO_INPUT'] = '1'\n\n if options.exists_action:\n os.environ['PIP_EXISTS_ACTION'] = ' '.join(options.exists_action)\n\n if options.require_venv:\n # If a venv is required check if it can really be found\n if not running_under_virtualenv():\n logger.critical(\n 'Could not find an activated virtualenv (required).'\n )\n sys.exit(VIRTUALENV_NOT_FOUND)\n\n # Check if we're using the latest version of pip available\n if (not options.disable_pip_version_check and not\n getattr(options, \"no_index\", False)):\n with self._build_session(\n options,\n retries=0,\n timeout=min(5, options.timeout)) as session:\n pip_version_check(session)\n\n try:\n status = self.run(options, args)\n # FIXME: all commands should return an exit status\n # and when it is done, isinstance is not needed anymore\n if isinstance(status, int):\n return status\n except PreviousBuildDirError as exc:\n logger.critical(str(exc))\n logger.debug('Exception information:\\n%s', format_exc())\n\n return PREVIOUS_BUILD_DIR_ERROR\n except (InstallationError, UninstallationError, BadCommand) as exc:\n logger.critical(str(exc))\n logger.debug('Exception information:\\n%s', format_exc())\n\n return ERROR\n except CommandError as exc:\n logger.critical('ERROR: %s', exc)\n logger.debug('Exception information:\\n%s', format_exc())\n\n return ERROR\n except KeyboardInterrupt:\n logger.critical('Operation cancelled by user')\n logger.debug('Exception information:\\n%s', format_exc())\n\n return ERROR\n except:\n logger.critical('Exception:\\n%s', format_exc())\n\n return UNKNOWN_ERROR\n\n return SUCCESS\n\n\nclass RequirementCommand(Command):\n\n @staticmethod\n def populate_requirement_set(requirement_set, args, options, finder,\n session, name, wheel_cache):\n \"\"\"\n Marshal cmd line args into a requirement set.\n \"\"\"\n for req in args:\n requirement_set.add_requirement(\n InstallRequirement.from_line(\n req, None, isolated=options.isolated_mode,\n wheel_cache=wheel_cache\n )\n )\n\n for req in options.editables:\n requirement_set.add_requirement(\n InstallRequirement.from_editable(\n req,\n default_vcs=options.default_vcs,\n isolated=options.isolated_mode,\n wheel_cache=wheel_cache\n )\n )\n\n found_req_in_file = False\n for filename in options.requirements:\n for req in parse_requirements(\n filename,\n finder=finder, options=options, session=session,\n wheel_cache=wheel_cache):\n found_req_in_file = True\n requirement_set.add_requirement(req)\n\n if not (args or options.editables or found_req_in_file):\n opts = {'name': name}\n if options.find_links:\n msg = ('You must give at least one requirement to '\n '%(name)s (maybe you meant \"pip %(name)s '\n '%(links)s\"?)' %\n dict(opts, links=' '.join(options.find_links)))\n else:\n msg = ('You must give at least one requirement '\n 'to %(name)s (see \"pip help %(name)s\")' % opts)\n logger.warning(msg)\n\n\ndef format_exc(exc_info=None):\n if exc_info is None:\n exc_info = sys.exc_info()\n out = StringIO()\n traceback.print_exception(*exc_info, **dict(file=out))\n return out.getvalue()\n", "path": "pip/basecommand.py"}], "after_files": [{"content": "\"\"\"Base Command class, and related routines\"\"\"\nfrom __future__ import absolute_import\n\nimport logging\nimport os\nimport sys\nimport traceback\nimport optparse\nimport warnings\n\nfrom pip._vendor.six import StringIO\n\nfrom pip import cmdoptions\nfrom pip.locations import running_under_virtualenv\nfrom pip.download import PipSession\nfrom pip.exceptions import (BadCommand, InstallationError, UninstallationError,\n CommandError, PreviousBuildDirError)\nfrom pip.compat import logging_dictConfig\nfrom pip.baseparser import ConfigOptionParser, UpdatingDefaultsHelpFormatter\nfrom pip.req import InstallRequirement, parse_requirements\nfrom pip.status_codes import (\n SUCCESS, ERROR, UNKNOWN_ERROR, VIRTUALENV_NOT_FOUND,\n PREVIOUS_BUILD_DIR_ERROR,\n)\nfrom pip.utils import get_prog, normalize_path\nfrom pip.utils.deprecation import RemovedInPip8Warning\nfrom pip.utils.logging import IndentingFormatter\nfrom pip.utils.outdated import pip_version_check\n\n\n__all__ = ['Command']\n\n\nlogger = logging.getLogger(__name__)\n\n\nclass Command(object):\n name = None\n usage = None\n hidden = False\n log_streams = (\"ext://sys.stdout\", \"ext://sys.stderr\")\n\n def __init__(self, isolated=False):\n parser_kw = {\n 'usage': self.usage,\n 'prog': '%s %s' % (get_prog(), self.name),\n 'formatter': UpdatingDefaultsHelpFormatter(),\n 'add_help_option': False,\n 'name': self.name,\n 'description': self.__doc__,\n 'isolated': isolated,\n }\n\n self.parser = ConfigOptionParser(**parser_kw)\n\n # Commands should add options to this option group\n optgroup_name = '%s Options' % self.name.capitalize()\n self.cmd_opts = optparse.OptionGroup(self.parser, optgroup_name)\n\n # Add the general options\n gen_opts = cmdoptions.make_option_group(\n cmdoptions.general_group,\n self.parser,\n )\n self.parser.add_option_group(gen_opts)\n\n def _build_session(self, options, retries=None, timeout=None):\n session = PipSession(\n cache=(\n normalize_path(os.path.join(options.cache_dir, \"http\"))\n if options.cache_dir else None\n ),\n retries=retries if retries is not None else options.retries,\n insecure_hosts=options.trusted_hosts,\n )\n\n # Handle custom ca-bundles from the user\n if options.cert:\n session.verify = options.cert\n\n # Handle SSL client certificate\n if options.client_cert:\n session.cert = options.client_cert\n\n # Handle timeouts\n if options.timeout or timeout:\n session.timeout = (\n timeout if timeout is not None else options.timeout\n )\n\n # Handle configured proxies\n if options.proxy:\n session.proxies = {\n \"http\": options.proxy,\n \"https\": options.proxy,\n }\n\n # Determine if we can prompt the user for authentication or not\n session.auth.prompting = not options.no_input\n\n return session\n\n def parse_args(self, args):\n # factored out for testability\n return self.parser.parse_args(args)\n\n def main(self, args):\n options, args = self.parse_args(args)\n\n if options.quiet:\n if options.quiet == 1:\n level = \"WARNING\"\n if options.quiet == 2:\n level = \"ERROR\"\n else:\n level = \"CRITICAL\"\n elif options.verbose:\n level = \"DEBUG\"\n else:\n level = \"INFO\"\n\n logging_dictConfig({\n \"version\": 1,\n \"disable_existing_loggers\": False,\n \"filters\": {\n \"exclude_warnings\": {\n \"()\": \"pip.utils.logging.MaxLevelFilter\",\n \"level\": logging.WARNING,\n },\n },\n \"formatters\": {\n \"indent\": {\n \"()\": IndentingFormatter,\n \"format\": (\n \"%(message)s\"\n if not options.log_explicit_levels\n else \"[%(levelname)s] %(message)s\"\n ),\n },\n },\n \"handlers\": {\n \"console\": {\n \"level\": level,\n \"class\": \"pip.utils.logging.ColorizedStreamHandler\",\n \"stream\": self.log_streams[0],\n \"filters\": [\"exclude_warnings\"],\n \"formatter\": \"indent\",\n },\n \"console_errors\": {\n \"level\": \"WARNING\",\n \"class\": \"pip.utils.logging.ColorizedStreamHandler\",\n \"stream\": self.log_streams[1],\n \"formatter\": \"indent\",\n },\n \"user_log\": {\n \"level\": \"DEBUG\",\n \"class\": \"pip.utils.logging.BetterRotatingFileHandler\",\n \"filename\": options.log or \"/dev/null\",\n \"delay\": True,\n \"formatter\": \"indent\",\n },\n },\n \"root\": {\n \"level\": level,\n \"handlers\": list(filter(None, [\n \"console\",\n \"console_errors\",\n \"user_log\" if options.log else None,\n ])),\n },\n # Disable any logging besides WARNING unless we have DEBUG level\n # logging enabled. These use both pip._vendor and the bare names\n # for the case where someone unbundles our libraries.\n \"loggers\": dict(\n (\n name,\n {\n \"level\": (\n \"WARNING\"\n if level in [\"INFO\", \"ERROR\"]\n else \"DEBUG\"\n ),\n },\n )\n for name in [\"pip._vendor\", \"distlib\", \"requests\", \"urllib3\"]\n ),\n })\n\n if options.log_explicit_levels:\n warnings.warn(\n \"--log-explicit-levels has been deprecated and will be removed\"\n \" in a future version.\",\n RemovedInPip8Warning,\n )\n\n # TODO: try to get these passing down from the command?\n # without resorting to os.environ to hold these.\n\n if options.no_input:\n os.environ['PIP_NO_INPUT'] = '1'\n\n if options.exists_action:\n os.environ['PIP_EXISTS_ACTION'] = ' '.join(options.exists_action)\n\n if options.require_venv:\n # If a venv is required check if it can really be found\n if not running_under_virtualenv():\n logger.critical(\n 'Could not find an activated virtualenv (required).'\n )\n sys.exit(VIRTUALENV_NOT_FOUND)\n\n # Check if we're using the latest version of pip available\n if (not options.disable_pip_version_check and not\n getattr(options, \"no_index\", False)):\n with self._build_session(\n options,\n retries=0,\n timeout=min(5, options.timeout)) as session:\n pip_version_check(session)\n\n try:\n status = self.run(options, args)\n # FIXME: all commands should return an exit status\n # and when it is done, isinstance is not needed anymore\n if isinstance(status, int):\n return status\n except PreviousBuildDirError as exc:\n logger.critical(str(exc))\n logger.debug('Exception information:\\n%s', format_exc())\n\n return PREVIOUS_BUILD_DIR_ERROR\n except (InstallationError, UninstallationError, BadCommand) as exc:\n logger.critical(str(exc))\n logger.debug('Exception information:\\n%s', format_exc())\n\n return ERROR\n except CommandError as exc:\n logger.critical('ERROR: %s', exc)\n logger.debug('Exception information:\\n%s', format_exc())\n\n return ERROR\n except KeyboardInterrupt:\n logger.critical('Operation cancelled by user')\n logger.debug('Exception information:\\n%s', format_exc())\n\n return ERROR\n except:\n logger.critical('Exception:\\n%s', format_exc())\n\n return UNKNOWN_ERROR\n\n return SUCCESS\n\n\nclass RequirementCommand(Command):\n\n @staticmethod\n def populate_requirement_set(requirement_set, args, options, finder,\n session, name, wheel_cache):\n \"\"\"\n Marshal cmd line args into a requirement set.\n \"\"\"\n for req in args:\n requirement_set.add_requirement(\n InstallRequirement.from_line(\n req, None, isolated=options.isolated_mode,\n wheel_cache=wheel_cache\n )\n )\n\n for req in options.editables:\n requirement_set.add_requirement(\n InstallRequirement.from_editable(\n req,\n default_vcs=options.default_vcs,\n isolated=options.isolated_mode,\n wheel_cache=wheel_cache\n )\n )\n\n found_req_in_file = False\n for filename in options.requirements:\n for req in parse_requirements(\n filename,\n finder=finder, options=options, session=session,\n wheel_cache=wheel_cache):\n found_req_in_file = True\n requirement_set.add_requirement(req)\n\n if not (args or options.editables or found_req_in_file):\n opts = {'name': name}\n if options.find_links:\n msg = ('You must give at least one requirement to '\n '%(name)s (maybe you meant \"pip %(name)s '\n '%(links)s\"?)' %\n dict(opts, links=' '.join(options.find_links)))\n else:\n msg = ('You must give at least one requirement '\n 'to %(name)s (see \"pip help %(name)s\")' % opts)\n logger.warning(msg)\n\n\ndef format_exc(exc_info=None):\n if exc_info is None:\n exc_info = sys.exc_info()\n out = StringIO()\n traceback.print_exception(*exc_info, **dict(file=out))\n return out.getvalue()\n", "path": "pip/basecommand.py"}]}
| 3,991 | 644 |
gh_patches_debug_23214
|
rasdani/github-patches
|
git_diff
|
pretalx__pretalx-84
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
resetting schedule to an old version can make submissions unavailable
1. create submission: sub1
2. publish a schedule containing only sub1: ScheduleA
3. create submission: sub2
4. publish a schedule containing both sub1 and sub2: ScheduleB
5. reset the current draft to ScheduleA
Sub2 is not part of the current draft and should therefore be visible in the list on the right. But the list is empty. Resetting the draft to ScheduleB restores the talk.
resetting schedule to an old version can make submissions unavailable
1. create submission: sub1
2. publish a schedule containing only sub1: ScheduleA
3. create submission: sub2
4. publish a schedule containing both sub1 and sub2: ScheduleB
5. reset the current draft to ScheduleA
Sub2 is not part of the current draft and should therefore be visible in the list on the right. But the list is empty. Resetting the draft to ScheduleB restores the talk.
resetting schedule to an old version can make submissions unavailable
1. create submission: sub1
2. publish a schedule containing only sub1: ScheduleA
3. create submission: sub2
4. publish a schedule containing both sub1 and sub2: ScheduleB
5. reset the current draft to ScheduleA
Sub2 is not part of the current draft and should therefore be visible in the list on the right. But the list is empty. Resetting the draft to ScheduleB restores the talk.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `src/pretalx/schedule/models/schedule.py`
Content:
```
1 from collections import defaultdict
2 from contextlib import suppress
3
4 import pytz
5 from django.db import models, transaction
6 from django.template.loader import get_template
7 from django.utils.functional import cached_property
8 from django.utils.timezone import now, override as tzoverride
9 from django.utils.translation import override, ugettext_lazy as _
10
11 from pretalx.common.mixins import LogMixin
12 from pretalx.mail.models import QueuedMail
13 from pretalx.person.models import User
14 from pretalx.submission.models import SubmissionStates
15
16
17 class Schedule(LogMixin, models.Model):
18 event = models.ForeignKey(
19 to='event.Event',
20 on_delete=models.PROTECT,
21 related_name='schedules',
22 )
23 version = models.CharField(
24 max_length=200,
25 null=True, blank=True,
26 )
27 published = models.DateTimeField(
28 null=True, blank=True
29 )
30
31 class Meta:
32 ordering = ('-published', )
33 unique_together = (('event', 'version'), )
34
35 @transaction.atomic
36 def freeze(self, name, user=None):
37 from pretalx.schedule.models import TalkSlot
38 if self.version:
39 raise Exception(f'Cannot freeze schedule version: already versioned as "{self.version}".')
40
41 self.version = name
42 self.published = now()
43 self.save(update_fields=['published', 'version'])
44 self.log_action('pretalx.schedule.release', person=user, orga=True)
45
46 wip_schedule = Schedule.objects.create(event=self.event)
47
48 # Set visibility
49 self.talks.filter(
50 start__isnull=False, submission__state=SubmissionStates.CONFIRMED, is_visible=False
51 ).update(is_visible=True)
52 self.talks.filter(is_visible=True).exclude(
53 start__isnull=False, submission__state=SubmissionStates.CONFIRMED
54 ).update(is_visible=False)
55
56 talks = []
57 for talk in self.talks.select_related('submission', 'room').all():
58 talks.append(talk.copy_to_schedule(wip_schedule, save=False))
59 TalkSlot.objects.bulk_create(talks)
60
61 self.notify_speakers()
62
63 with suppress(AttributeError):
64 del wip_schedule.event.wip_schedule
65
66 return self, wip_schedule
67
68 def unfreeze(self, user=None):
69 from pretalx.schedule.models import TalkSlot
70 if not self.version:
71 raise Exception('Cannot unfreeze schedule version: not released yet.')
72 self.event.wip_schedule.talks.all().delete()
73 self.event.wip_schedule.delete()
74 wip_schedule = Schedule.objects.create(event=self.event)
75 talks = []
76 for talk in self.talks.all():
77 talks.append(talk.copy_to_schedule(wip_schedule, save=False))
78 TalkSlot.objects.bulk_create(talks)
79 return self, wip_schedule
80
81 @cached_property
82 def scheduled_talks(self):
83 return self.talks.filter(
84 room__isnull=False,
85 start__isnull=False,
86 )
87
88 @cached_property
89 def previous_schedule(self):
90 return self.event.schedules.filter(published__lt=self.published).order_by('-published').first()
91
92 @cached_property
93 def changes(self):
94 tz = pytz.timezone(self.event.timezone)
95 result = {
96 'count': 0,
97 'action': 'update',
98 'new_talks': [],
99 'canceled_talks': [],
100 'moved_talks': [],
101 }
102 if not self.previous_schedule:
103 result['action'] = 'create'
104 return result
105
106 new_slots = set(
107 talk
108 for talk in self.talks.select_related('submission', 'submission__event', 'room').all()
109 if talk.is_visible
110 )
111 old_slots = set(
112 talk
113 for talk in self.previous_schedule.talks.select_related('submission', 'submission__event', 'room').all()
114 if talk.is_visible
115 )
116
117 new_submissions = set(talk.submission for talk in new_slots)
118 old_submissions = set(talk.submission for talk in old_slots)
119
120 new_slot_by_submission = {talk.submission: talk for talk in new_slots}
121 old_slot_by_submission = {talk.submission: talk for talk in old_slots}
122
123 result['new_talks'] = [new_slot_by_submission.get(s) for s in new_submissions - old_submissions]
124 result['canceled_talks'] = [old_slot_by_submission.get(s) for s in old_submissions - new_submissions]
125
126 for submission in (new_submissions & old_submissions):
127 old_slot = old_slot_by_submission.get(submission)
128 new_slot = new_slot_by_submission.get(submission)
129 if new_slot.room and not old_slot.room:
130 result['new_talks'].append(new_slot)
131 elif not new_slot.room and old_slot.room:
132 result['canceled_talks'].append(new_slot)
133 elif old_slot.start != new_slot.start or old_slot.room != new_slot.room:
134 if new_slot.room:
135 result['moved_talks'].append({
136 'submission': submission,
137 'old_start': old_slot.start.astimezone(tz),
138 'new_start': new_slot.start.astimezone(tz),
139 'old_room': old_slot.room.name,
140 'new_room': new_slot.room.name,
141 })
142
143 result['count'] = len(result['new_talks']) + len(result['canceled_talks']) + len(result['moved_talks'])
144 return result
145
146 def notify_speakers(self):
147 tz = pytz.timezone(self.event.timezone)
148 speakers = defaultdict(lambda: {'create': [], 'update': []})
149 if self.changes['action'] == 'create':
150 speakers = {
151 speaker: {'create': self.talks.filter(submission__speakers=speaker), 'update': []}
152 for speaker in User.objects.filter(submissions__slots__schedule=self)
153 }
154 else:
155 if self.changes['count'] == len(self.changes['canceled_talks']):
156 return
157
158 for new_talk in self.changes['new_talks']:
159 for speaker in new_talk.submission.speakers.all():
160 speakers[speaker]['create'].append(new_talk)
161 for moved_talk in self.changes['moved_talks']:
162 for speaker in moved_talk['submission'].speakers.all():
163 speakers[speaker]['update'].append(moved_talk)
164 for speaker in speakers:
165 with override(speaker.locale), tzoverride(tz):
166 text = get_template('schedule/speaker_notification.txt').render(
167 {'speaker': speaker, **speakers[speaker]}
168 )
169 QueuedMail.objects.create(
170 event=self.event,
171 to=speaker.email,
172 reply_to=self.event.email,
173 subject=_('[{event}] New schedule!').format(event=self.event.slug),
174 text=text
175 )
176
177 def __str__(self) -> str:
178 return str(self.version) or _(f'WIP Schedule for {self.event}')
179
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/src/pretalx/schedule/models/schedule.py b/src/pretalx/schedule/models/schedule.py
--- a/src/pretalx/schedule/models/schedule.py
+++ b/src/pretalx/schedule/models/schedule.py
@@ -69,13 +69,25 @@
from pretalx.schedule.models import TalkSlot
if not self.version:
raise Exception('Cannot unfreeze schedule version: not released yet.')
+
+ # collect all talks, which have been added since this schedule (#72)
+ submission_ids = self.talks.all().values_list('submission_id', flat=True)
+ talks = self.event.wip_schedule.talks \
+ .exclude(submission_id__in=submission_ids) \
+ .union(self.talks.all())
+
+ wip_schedule = Schedule.objects.create(event=self.event)
+ new_talks = []
+ for talk in talks:
+ new_talks.append(talk.copy_to_schedule(wip_schedule, save=False))
+ TalkSlot.objects.bulk_create(new_talks)
+
self.event.wip_schedule.talks.all().delete()
self.event.wip_schedule.delete()
- wip_schedule = Schedule.objects.create(event=self.event)
- talks = []
- for talk in self.talks.all():
- talks.append(talk.copy_to_schedule(wip_schedule, save=False))
- TalkSlot.objects.bulk_create(talks)
+
+ with suppress(AttributeError):
+ del wip_schedule.event.wip_schedule
+
return self, wip_schedule
@cached_property
|
{"golden_diff": "diff --git a/src/pretalx/schedule/models/schedule.py b/src/pretalx/schedule/models/schedule.py\n--- a/src/pretalx/schedule/models/schedule.py\n+++ b/src/pretalx/schedule/models/schedule.py\n@@ -69,13 +69,25 @@\n from pretalx.schedule.models import TalkSlot\n if not self.version:\n raise Exception('Cannot unfreeze schedule version: not released yet.')\n+\n+ # collect all talks, which have been added since this schedule (#72)\n+ submission_ids = self.talks.all().values_list('submission_id', flat=True)\n+ talks = self.event.wip_schedule.talks \\\n+ .exclude(submission_id__in=submission_ids) \\\n+ .union(self.talks.all())\n+\n+ wip_schedule = Schedule.objects.create(event=self.event)\n+ new_talks = []\n+ for talk in talks:\n+ new_talks.append(talk.copy_to_schedule(wip_schedule, save=False))\n+ TalkSlot.objects.bulk_create(new_talks)\n+\n self.event.wip_schedule.talks.all().delete()\n self.event.wip_schedule.delete()\n- wip_schedule = Schedule.objects.create(event=self.event)\n- talks = []\n- for talk in self.talks.all():\n- talks.append(talk.copy_to_schedule(wip_schedule, save=False))\n- TalkSlot.objects.bulk_create(talks)\n+\n+ with suppress(AttributeError):\n+ del wip_schedule.event.wip_schedule\n+\n return self, wip_schedule\n \n @cached_property\n", "issue": "resetting schedule to an old version can make submissions unavailable\n1. create submission: sub1\r\n2. publish a schedule containing only sub1: ScheduleA\r\n3. create submission: sub2\r\n4. publish a schedule containing both sub1 and sub2: ScheduleB\r\n5. reset the current draft to ScheduleA\r\n\r\nSub2 is not part of the current draft and should therefore be visible in the list on the right. But the list is empty. Resetting the draft to ScheduleB restores the talk.\nresetting schedule to an old version can make submissions unavailable\n1. create submission: sub1\r\n2. publish a schedule containing only sub1: ScheduleA\r\n3. create submission: sub2\r\n4. publish a schedule containing both sub1 and sub2: ScheduleB\r\n5. reset the current draft to ScheduleA\r\n\r\nSub2 is not part of the current draft and should therefore be visible in the list on the right. But the list is empty. Resetting the draft to ScheduleB restores the talk.\nresetting schedule to an old version can make submissions unavailable\n1. create submission: sub1\r\n2. publish a schedule containing only sub1: ScheduleA\r\n3. create submission: sub2\r\n4. publish a schedule containing both sub1 and sub2: ScheduleB\r\n5. reset the current draft to ScheduleA\r\n\r\nSub2 is not part of the current draft and should therefore be visible in the list on the right. But the list is empty. Resetting the draft to ScheduleB restores the talk.\n", "before_files": [{"content": "from collections import defaultdict\nfrom contextlib import suppress\n\nimport pytz\nfrom django.db import models, transaction\nfrom django.template.loader import get_template\nfrom django.utils.functional import cached_property\nfrom django.utils.timezone import now, override as tzoverride\nfrom django.utils.translation import override, ugettext_lazy as _\n\nfrom pretalx.common.mixins import LogMixin\nfrom pretalx.mail.models import QueuedMail\nfrom pretalx.person.models import User\nfrom pretalx.submission.models import SubmissionStates\n\n\nclass Schedule(LogMixin, models.Model):\n event = models.ForeignKey(\n to='event.Event',\n on_delete=models.PROTECT,\n related_name='schedules',\n )\n version = models.CharField(\n max_length=200,\n null=True, blank=True,\n )\n published = models.DateTimeField(\n null=True, blank=True\n )\n\n class Meta:\n ordering = ('-published', )\n unique_together = (('event', 'version'), )\n\n @transaction.atomic\n def freeze(self, name, user=None):\n from pretalx.schedule.models import TalkSlot\n if self.version:\n raise Exception(f'Cannot freeze schedule version: already versioned as \"{self.version}\".')\n\n self.version = name\n self.published = now()\n self.save(update_fields=['published', 'version'])\n self.log_action('pretalx.schedule.release', person=user, orga=True)\n\n wip_schedule = Schedule.objects.create(event=self.event)\n\n # Set visibility\n self.talks.filter(\n start__isnull=False, submission__state=SubmissionStates.CONFIRMED, is_visible=False\n ).update(is_visible=True)\n self.talks.filter(is_visible=True).exclude(\n start__isnull=False, submission__state=SubmissionStates.CONFIRMED\n ).update(is_visible=False)\n\n talks = []\n for talk in self.talks.select_related('submission', 'room').all():\n talks.append(talk.copy_to_schedule(wip_schedule, save=False))\n TalkSlot.objects.bulk_create(talks)\n\n self.notify_speakers()\n\n with suppress(AttributeError):\n del wip_schedule.event.wip_schedule\n\n return self, wip_schedule\n\n def unfreeze(self, user=None):\n from pretalx.schedule.models import TalkSlot\n if not self.version:\n raise Exception('Cannot unfreeze schedule version: not released yet.')\n self.event.wip_schedule.talks.all().delete()\n self.event.wip_schedule.delete()\n wip_schedule = Schedule.objects.create(event=self.event)\n talks = []\n for talk in self.talks.all():\n talks.append(talk.copy_to_schedule(wip_schedule, save=False))\n TalkSlot.objects.bulk_create(talks)\n return self, wip_schedule\n\n @cached_property\n def scheduled_talks(self):\n return self.talks.filter(\n room__isnull=False,\n start__isnull=False,\n )\n\n @cached_property\n def previous_schedule(self):\n return self.event.schedules.filter(published__lt=self.published).order_by('-published').first()\n\n @cached_property\n def changes(self):\n tz = pytz.timezone(self.event.timezone)\n result = {\n 'count': 0,\n 'action': 'update',\n 'new_talks': [],\n 'canceled_talks': [],\n 'moved_talks': [],\n }\n if not self.previous_schedule:\n result['action'] = 'create'\n return result\n\n new_slots = set(\n talk\n for talk in self.talks.select_related('submission', 'submission__event', 'room').all()\n if talk.is_visible\n )\n old_slots = set(\n talk\n for talk in self.previous_schedule.talks.select_related('submission', 'submission__event', 'room').all()\n if talk.is_visible\n )\n\n new_submissions = set(talk.submission for talk in new_slots)\n old_submissions = set(talk.submission for talk in old_slots)\n\n new_slot_by_submission = {talk.submission: talk for talk in new_slots}\n old_slot_by_submission = {talk.submission: talk for talk in old_slots}\n\n result['new_talks'] = [new_slot_by_submission.get(s) for s in new_submissions - old_submissions]\n result['canceled_talks'] = [old_slot_by_submission.get(s) for s in old_submissions - new_submissions]\n\n for submission in (new_submissions & old_submissions):\n old_slot = old_slot_by_submission.get(submission)\n new_slot = new_slot_by_submission.get(submission)\n if new_slot.room and not old_slot.room:\n result['new_talks'].append(new_slot)\n elif not new_slot.room and old_slot.room:\n result['canceled_talks'].append(new_slot)\n elif old_slot.start != new_slot.start or old_slot.room != new_slot.room:\n if new_slot.room:\n result['moved_talks'].append({\n 'submission': submission,\n 'old_start': old_slot.start.astimezone(tz),\n 'new_start': new_slot.start.astimezone(tz),\n 'old_room': old_slot.room.name,\n 'new_room': new_slot.room.name,\n })\n\n result['count'] = len(result['new_talks']) + len(result['canceled_talks']) + len(result['moved_talks'])\n return result\n\n def notify_speakers(self):\n tz = pytz.timezone(self.event.timezone)\n speakers = defaultdict(lambda: {'create': [], 'update': []})\n if self.changes['action'] == 'create':\n speakers = {\n speaker: {'create': self.talks.filter(submission__speakers=speaker), 'update': []}\n for speaker in User.objects.filter(submissions__slots__schedule=self)\n }\n else:\n if self.changes['count'] == len(self.changes['canceled_talks']):\n return\n\n for new_talk in self.changes['new_talks']:\n for speaker in new_talk.submission.speakers.all():\n speakers[speaker]['create'].append(new_talk)\n for moved_talk in self.changes['moved_talks']:\n for speaker in moved_talk['submission'].speakers.all():\n speakers[speaker]['update'].append(moved_talk)\n for speaker in speakers:\n with override(speaker.locale), tzoverride(tz):\n text = get_template('schedule/speaker_notification.txt').render(\n {'speaker': speaker, **speakers[speaker]}\n )\n QueuedMail.objects.create(\n event=self.event,\n to=speaker.email,\n reply_to=self.event.email,\n subject=_('[{event}] New schedule!').format(event=self.event.slug),\n text=text\n )\n\n def __str__(self) -> str:\n return str(self.version) or _(f'WIP Schedule for {self.event}')\n", "path": "src/pretalx/schedule/models/schedule.py"}], "after_files": [{"content": "from collections import defaultdict\nfrom contextlib import suppress\n\nimport pytz\nfrom django.db import models, transaction\nfrom django.template.loader import get_template\nfrom django.utils.functional import cached_property\nfrom django.utils.timezone import now, override as tzoverride\nfrom django.utils.translation import override, ugettext_lazy as _\n\nfrom pretalx.common.mixins import LogMixin\nfrom pretalx.mail.models import QueuedMail\nfrom pretalx.person.models import User\nfrom pretalx.submission.models import SubmissionStates\n\n\nclass Schedule(LogMixin, models.Model):\n event = models.ForeignKey(\n to='event.Event',\n on_delete=models.PROTECT,\n related_name='schedules',\n )\n version = models.CharField(\n max_length=200,\n null=True, blank=True,\n )\n published = models.DateTimeField(\n null=True, blank=True\n )\n\n class Meta:\n ordering = ('-published', )\n unique_together = (('event', 'version'), )\n\n @transaction.atomic\n def freeze(self, name, user=None):\n from pretalx.schedule.models import TalkSlot\n if self.version:\n raise Exception(f'Cannot freeze schedule version: already versioned as \"{self.version}\".')\n\n self.version = name\n self.published = now()\n self.save(update_fields=['published', 'version'])\n self.log_action('pretalx.schedule.release', person=user, orga=True)\n\n wip_schedule = Schedule.objects.create(event=self.event)\n\n # Set visibility\n self.talks.filter(\n start__isnull=False, submission__state=SubmissionStates.CONFIRMED, is_visible=False\n ).update(is_visible=True)\n self.talks.filter(is_visible=True).exclude(\n start__isnull=False, submission__state=SubmissionStates.CONFIRMED\n ).update(is_visible=False)\n\n talks = []\n for talk in self.talks.select_related('submission', 'room').all():\n talks.append(talk.copy_to_schedule(wip_schedule, save=False))\n TalkSlot.objects.bulk_create(talks)\n\n self.notify_speakers()\n\n with suppress(AttributeError):\n del wip_schedule.event.wip_schedule\n\n return self, wip_schedule\n\n def unfreeze(self, user=None):\n from pretalx.schedule.models import TalkSlot\n if not self.version:\n raise Exception('Cannot unfreeze schedule version: not released yet.')\n\n # collect all talks, which have been added since this schedule (#72)\n submission_ids = self.talks.all().values_list('submission_id', flat=True)\n talks = self.event.wip_schedule.talks \\\n .exclude(submission_id__in=submission_ids) \\\n .union(self.talks.all())\n\n wip_schedule = Schedule.objects.create(event=self.event)\n new_talks = []\n for talk in talks:\n new_talks.append(talk.copy_to_schedule(wip_schedule, save=False))\n TalkSlot.objects.bulk_create(new_talks)\n\n self.event.wip_schedule.talks.all().delete()\n self.event.wip_schedule.delete()\n\n with suppress(AttributeError):\n del wip_schedule.event.wip_schedule\n\n return self, wip_schedule\n\n @cached_property\n def scheduled_talks(self):\n return self.talks.filter(\n room__isnull=False,\n start__isnull=False,\n )\n\n @cached_property\n def previous_schedule(self):\n return self.event.schedules.filter(published__lt=self.published).order_by('-published').first()\n\n @cached_property\n def changes(self):\n tz = pytz.timezone(self.event.timezone)\n result = {\n 'count': 0,\n 'action': 'update',\n 'new_talks': [],\n 'canceled_talks': [],\n 'moved_talks': [],\n }\n if not self.previous_schedule:\n result['action'] = 'create'\n return result\n\n new_slots = set(\n talk\n for talk in self.talks.select_related('submission', 'submission__event', 'room').all()\n if talk.is_visible\n )\n old_slots = set(\n talk\n for talk in self.previous_schedule.talks.select_related('submission', 'submission__event', 'room').all()\n if talk.is_visible\n )\n\n new_submissions = set(talk.submission for talk in new_slots)\n old_submissions = set(talk.submission for talk in old_slots)\n\n new_slot_by_submission = {talk.submission: talk for talk in new_slots}\n old_slot_by_submission = {talk.submission: talk for talk in old_slots}\n\n result['new_talks'] = [new_slot_by_submission.get(s) for s in new_submissions - old_submissions]\n result['canceled_talks'] = [old_slot_by_submission.get(s) for s in old_submissions - new_submissions]\n\n for submission in (new_submissions & old_submissions):\n old_slot = old_slot_by_submission.get(submission)\n new_slot = new_slot_by_submission.get(submission)\n if new_slot.room and not old_slot.room:\n result['new_talks'].append(new_slot)\n elif not new_slot.room and old_slot.room:\n result['canceled_talks'].append(new_slot)\n elif old_slot.start != new_slot.start or old_slot.room != new_slot.room:\n if new_slot.room:\n result['moved_talks'].append({\n 'submission': submission,\n 'old_start': old_slot.start.astimezone(tz),\n 'new_start': new_slot.start.astimezone(tz),\n 'old_room': old_slot.room.name,\n 'new_room': new_slot.room.name,\n })\n\n result['count'] = len(result['new_talks']) + len(result['canceled_talks']) + len(result['moved_talks'])\n return result\n\n def notify_speakers(self):\n tz = pytz.timezone(self.event.timezone)\n speakers = defaultdict(lambda: {'create': [], 'update': []})\n if self.changes['action'] == 'create':\n speakers = {\n speaker: {'create': self.talks.filter(submission__speakers=speaker), 'update': []}\n for speaker in User.objects.filter(submissions__slots__schedule=self)\n }\n else:\n if self.changes['count'] == len(self.changes['canceled_talks']):\n return\n\n for new_talk in self.changes['new_talks']:\n for speaker in new_talk.submission.speakers.all():\n speakers[speaker]['create'].append(new_talk)\n for moved_talk in self.changes['moved_talks']:\n for speaker in moved_talk['submission'].speakers.all():\n speakers[speaker]['update'].append(moved_talk)\n for speaker in speakers:\n with override(speaker.locale), tzoverride(tz):\n text = get_template('schedule/speaker_notification.txt').render(\n {'speaker': speaker, **speakers[speaker]}\n )\n QueuedMail.objects.create(\n event=self.event,\n to=speaker.email,\n reply_to=self.event.email,\n subject=_('[{event}] New schedule!').format(event=self.event.slug),\n text=text\n )\n\n def __str__(self) -> str:\n return str(self.version) or _(f'WIP Schedule for {self.event}')\n", "path": "src/pretalx/schedule/models/schedule.py"}]}
| 2,510 | 348 |
gh_patches_debug_12881
|
rasdani/github-patches
|
git_diff
|
Lightning-AI__pytorch-lightning-771
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
ModelCheckpoint Filepath Doesn't Use Logger Save Dir
# 🐛 Bug
Not sure if this is intended, but the model checkpoint isn't using the same directory as the logger, even if the logger exists. I would have expected this line [here](https://github.com/PyTorchLightning/pytorch-lightning/blob/588ad8377167c0b7d29cf4f362dbf42015f7568d/pytorch_lightning/trainer/callback_config.py#L28) to be `self.logger.save_dir` instead of `self.default_save_path`.
Thank you,
-Collin
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `pytorch_lightning/trainer/callback_config.py`
Content:
```
1 import os
2 from abc import ABC
3
4 from pytorch_lightning.callbacks import ModelCheckpoint, EarlyStopping
5
6
7 class TrainerCallbackConfigMixin(ABC):
8
9 def __init__(self):
10 # this is just a summary on variables used in this abstract class,
11 # the proper values/initialisation should be done in child class
12 self.default_save_path = None
13 self.save_checkpoint = None
14 self.slurm_job_id = None
15
16 def configure_checkpoint_callback(self):
17 """
18 Weight path set in this priority:
19 Checkpoint_callback's path (if passed in).
20 User provided weights_saved_path
21 Otherwise use os.getcwd()
22 """
23 if self.checkpoint_callback is True:
24 # init a default one
25 if self.logger is not None:
26 ckpt_path = os.path.join(
27 self.default_save_path,
28 self.logger.name,
29 f'version_{self.logger.version}',
30 "checkpoints"
31 )
32 else:
33 ckpt_path = os.path.join(self.default_save_path, "checkpoints")
34
35 self.checkpoint_callback = ModelCheckpoint(
36 filepath=ckpt_path
37 )
38 elif self.checkpoint_callback is False:
39 self.checkpoint_callback = None
40
41 if self.checkpoint_callback:
42 # set the path for the callbacks
43 self.checkpoint_callback.save_function = self.save_checkpoint
44
45 # if checkpoint callback used, then override the weights path
46 self.weights_save_path = self.checkpoint_callback.filepath
47
48 # if weights_save_path is still none here, set to current working dir
49 if self.weights_save_path is None:
50 self.weights_save_path = self.default_save_path
51
52 def configure_early_stopping(self, early_stop_callback):
53 if early_stop_callback is True:
54 self.early_stop_callback = EarlyStopping(
55 monitor='val_loss',
56 patience=3,
57 strict=True,
58 verbose=True,
59 mode='min'
60 )
61 self.enable_early_stop = True
62 elif early_stop_callback is None:
63 self.early_stop_callback = EarlyStopping(
64 monitor='val_loss',
65 patience=3,
66 strict=False,
67 verbose=False,
68 mode='min'
69 )
70 self.enable_early_stop = True
71 elif not early_stop_callback:
72 self.early_stop_callback = None
73 self.enable_early_stop = False
74 else:
75 self.early_stop_callback = early_stop_callback
76 self.enable_early_stop = True
77
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/pytorch_lightning/trainer/callback_config.py b/pytorch_lightning/trainer/callback_config.py
--- a/pytorch_lightning/trainer/callback_config.py
+++ b/pytorch_lightning/trainer/callback_config.py
@@ -23,8 +23,11 @@
if self.checkpoint_callback is True:
# init a default one
if self.logger is not None:
+ save_dir = (getattr(self.logger, 'save_dir', None) or
+ getattr(self.logger, '_save_dir', None) or
+ self.default_save_path)
ckpt_path = os.path.join(
- self.default_save_path,
+ save_dir,
self.logger.name,
f'version_{self.logger.version}',
"checkpoints"
|
{"golden_diff": "diff --git a/pytorch_lightning/trainer/callback_config.py b/pytorch_lightning/trainer/callback_config.py\n--- a/pytorch_lightning/trainer/callback_config.py\n+++ b/pytorch_lightning/trainer/callback_config.py\n@@ -23,8 +23,11 @@\n if self.checkpoint_callback is True:\n # init a default one\n if self.logger is not None:\n+ save_dir = (getattr(self.logger, 'save_dir', None) or\n+ getattr(self.logger, '_save_dir', None) or\n+ self.default_save_path)\n ckpt_path = os.path.join(\n- self.default_save_path,\n+ save_dir,\n self.logger.name,\n f'version_{self.logger.version}',\n \"checkpoints\"\n", "issue": "ModelCheckpoint Filepath Doesn't Use Logger Save Dir\n# \ud83d\udc1b Bug\r\n\r\nNot sure if this is intended, but the model checkpoint isn't using the same directory as the logger, even if the logger exists. I would have expected this line [here](https://github.com/PyTorchLightning/pytorch-lightning/blob/588ad8377167c0b7d29cf4f362dbf42015f7568d/pytorch_lightning/trainer/callback_config.py#L28) to be `self.logger.save_dir` instead of `self.default_save_path`. \r\n\r\nThank you,\r\n-Collin\n", "before_files": [{"content": "import os\nfrom abc import ABC\n\nfrom pytorch_lightning.callbacks import ModelCheckpoint, EarlyStopping\n\n\nclass TrainerCallbackConfigMixin(ABC):\n\n def __init__(self):\n # this is just a summary on variables used in this abstract class,\n # the proper values/initialisation should be done in child class\n self.default_save_path = None\n self.save_checkpoint = None\n self.slurm_job_id = None\n\n def configure_checkpoint_callback(self):\n \"\"\"\n Weight path set in this priority:\n Checkpoint_callback's path (if passed in).\n User provided weights_saved_path\n Otherwise use os.getcwd()\n \"\"\"\n if self.checkpoint_callback is True:\n # init a default one\n if self.logger is not None:\n ckpt_path = os.path.join(\n self.default_save_path,\n self.logger.name,\n f'version_{self.logger.version}',\n \"checkpoints\"\n )\n else:\n ckpt_path = os.path.join(self.default_save_path, \"checkpoints\")\n\n self.checkpoint_callback = ModelCheckpoint(\n filepath=ckpt_path\n )\n elif self.checkpoint_callback is False:\n self.checkpoint_callback = None\n\n if self.checkpoint_callback:\n # set the path for the callbacks\n self.checkpoint_callback.save_function = self.save_checkpoint\n\n # if checkpoint callback used, then override the weights path\n self.weights_save_path = self.checkpoint_callback.filepath\n\n # if weights_save_path is still none here, set to current working dir\n if self.weights_save_path is None:\n self.weights_save_path = self.default_save_path\n\n def configure_early_stopping(self, early_stop_callback):\n if early_stop_callback is True:\n self.early_stop_callback = EarlyStopping(\n monitor='val_loss',\n patience=3,\n strict=True,\n verbose=True,\n mode='min'\n )\n self.enable_early_stop = True\n elif early_stop_callback is None:\n self.early_stop_callback = EarlyStopping(\n monitor='val_loss',\n patience=3,\n strict=False,\n verbose=False,\n mode='min'\n )\n self.enable_early_stop = True\n elif not early_stop_callback:\n self.early_stop_callback = None\n self.enable_early_stop = False\n else:\n self.early_stop_callback = early_stop_callback\n self.enable_early_stop = True\n", "path": "pytorch_lightning/trainer/callback_config.py"}], "after_files": [{"content": "import os\nfrom abc import ABC\n\nfrom pytorch_lightning.callbacks import ModelCheckpoint, EarlyStopping\n\n\nclass TrainerCallbackConfigMixin(ABC):\n\n def __init__(self):\n # this is just a summary on variables used in this abstract class,\n # the proper values/initialisation should be done in child class\n self.default_save_path = None\n self.save_checkpoint = None\n self.slurm_job_id = None\n\n def configure_checkpoint_callback(self):\n \"\"\"\n Weight path set in this priority:\n Checkpoint_callback's path (if passed in).\n User provided weights_saved_path\n Otherwise use os.getcwd()\n \"\"\"\n if self.checkpoint_callback is True:\n # init a default one\n if self.logger is not None:\n save_dir = (getattr(self.logger, 'save_dir', None) or\n getattr(self.logger, '_save_dir', None) or\n self.default_save_path)\n ckpt_path = os.path.join(\n save_dir,\n self.logger.name,\n f'version_{self.logger.version}',\n \"checkpoints\"\n )\n else:\n ckpt_path = os.path.join(self.default_save_path, \"checkpoints\")\n\n self.checkpoint_callback = ModelCheckpoint(\n filepath=ckpt_path\n )\n elif self.checkpoint_callback is False:\n self.checkpoint_callback = None\n\n if self.checkpoint_callback:\n # set the path for the callbacks\n self.checkpoint_callback.save_function = self.save_checkpoint\n\n # if checkpoint callback used, then override the weights path\n self.weights_save_path = self.checkpoint_callback.filepath\n\n # if weights_save_path is still none here, set to current working dir\n if self.weights_save_path is None:\n self.weights_save_path = self.default_save_path\n\n def configure_early_stopping(self, early_stop_callback):\n if early_stop_callback is True:\n self.early_stop_callback = EarlyStopping(\n monitor='val_loss',\n patience=3,\n strict=True,\n verbose=True,\n mode='min'\n )\n self.enable_early_stop = True\n elif early_stop_callback is None:\n self.early_stop_callback = EarlyStopping(\n monitor='val_loss',\n patience=3,\n strict=False,\n verbose=False,\n mode='min'\n )\n self.enable_early_stop = True\n elif not early_stop_callback:\n self.early_stop_callback = None\n self.enable_early_stop = False\n else:\n self.early_stop_callback = early_stop_callback\n self.enable_early_stop = True\n", "path": "pytorch_lightning/trainer/callback_config.py"}]}
| 1,069 | 165 |
gh_patches_debug_573
|
rasdani/github-patches
|
git_diff
|
google-research__text-to-text-transfer-transformer-351
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Unable to import tensorflow_gcs_config in t5_trivia colab notebook
Upon running line `import tensorflow_gcs_config` (in t5_trivia colab notebook, setup section) I get this error,
```
---------------------------------------------------------------------------
NotImplementedError Traceback (most recent call last)
<ipython-input-2-3bb7f36f8553> in <module>()
----> 1 import tensorflow_gcs_config
1 frames
/usr/local/lib/python3.6/dist-packages/tensorflow_gcs_config/__init__.py in _load_library(filename, lib)
55 raise NotImplementedError(
56 "unable to open file: " +
---> 57 "{}, from paths: {}\ncaused by: {}".format(filename, filenames, errs))
58
59 _gcs_config_so = _load_library("_gcs_config_ops.so")
NotImplementedError: unable to open file: _gcs_config_ops.so, from paths: ['/usr/local/lib/python3.6/dist-packages/tensorflow_gcs_config/_gcs_config_ops.so']
caused by: ['/usr/local/lib/python3.6/dist-packages/tensorflow_gcs_config/_gcs_config_ops.so: undefined symbol: _ZN10tensorflow15OpKernelContext5inputEN4absl11string_viewEPPKNS_6TensorE']
```
`tf.__version__` is '2.3.0'
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `t5/version.py`
Content:
```
1 # Copyright 2020 The T5 Authors.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 # Lint as: python3
16 r"""Separate file for storing the current version of T5.
17
18 Stored in a separate file so that setup.py can reference the version without
19 pulling in all the dependencies in __init__.py.
20 """
21 __version__ = '0.6.3'
22
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/t5/version.py b/t5/version.py
--- a/t5/version.py
+++ b/t5/version.py
@@ -18,4 +18,4 @@
Stored in a separate file so that setup.py can reference the version without
pulling in all the dependencies in __init__.py.
"""
-__version__ = '0.6.3'
+__version__ = '0.6.4'
|
{"golden_diff": "diff --git a/t5/version.py b/t5/version.py\n--- a/t5/version.py\n+++ b/t5/version.py\n@@ -18,4 +18,4 @@\n Stored in a separate file so that setup.py can reference the version without\n pulling in all the dependencies in __init__.py.\n \"\"\"\n-__version__ = '0.6.3'\n+__version__ = '0.6.4'\n", "issue": "Unable to import tensorflow_gcs_config in t5_trivia colab notebook\nUpon running line `import tensorflow_gcs_config` (in t5_trivia colab notebook, setup section) I get this error,\r\n```\r\n---------------------------------------------------------------------------\r\nNotImplementedError Traceback (most recent call last)\r\n<ipython-input-2-3bb7f36f8553> in <module>()\r\n----> 1 import tensorflow_gcs_config\r\n\r\n1 frames\r\n/usr/local/lib/python3.6/dist-packages/tensorflow_gcs_config/__init__.py in _load_library(filename, lib)\r\n 55 raise NotImplementedError(\r\n 56 \"unable to open file: \" +\r\n---> 57 \"{}, from paths: {}\\ncaused by: {}\".format(filename, filenames, errs))\r\n 58 \r\n 59 _gcs_config_so = _load_library(\"_gcs_config_ops.so\")\r\n\r\nNotImplementedError: unable to open file: _gcs_config_ops.so, from paths: ['/usr/local/lib/python3.6/dist-packages/tensorflow_gcs_config/_gcs_config_ops.so']\r\ncaused by: ['/usr/local/lib/python3.6/dist-packages/tensorflow_gcs_config/_gcs_config_ops.so: undefined symbol: _ZN10tensorflow15OpKernelContext5inputEN4absl11string_viewEPPKNS_6TensorE']\r\n```\r\n`tf.__version__` is '2.3.0'\n", "before_files": [{"content": "# Copyright 2020 The T5 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 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\n# Lint as: python3\nr\"\"\"Separate file for storing the current version of T5.\n\nStored in a separate file so that setup.py can reference the version without\npulling in all the dependencies in __init__.py.\n\"\"\"\n__version__ = '0.6.3'\n", "path": "t5/version.py"}], "after_files": [{"content": "# Copyright 2020 The T5 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 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\n# Lint as: python3\nr\"\"\"Separate file for storing the current version of T5.\n\nStored in a separate file so that setup.py can reference the version without\npulling in all the dependencies in __init__.py.\n\"\"\"\n__version__ = '0.6.4'\n", "path": "t5/version.py"}]}
| 799 | 91 |
gh_patches_debug_14719
|
rasdani/github-patches
|
git_diff
|
conan-io__conan-center-index-7436
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[request] imguizmo/1.83
### Package Details
* Package Name/Version: **imguizmo/1.83**
* Changelog: **https://github.com/CedricGuillemet/ImGuizmo/releases/tag/1.83**
The above mentioned version is newly released by the upstream project and not yet available as a recipe. Please add this version.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `recipes/imguizmo/all/conanfile.py`
Content:
```
1 import os
2 import glob
3 from conans import ConanFile, CMake, tools
4
5
6 class ImGuizmoConan(ConanFile):
7 name = "imguizmo"
8 url = "https://github.com/conan-io/conan-center-index"
9 homepage = "https://github.com/CedricGuillemet/ImGuizmo"
10 description = "Immediate mode 3D gizmo for scene editing and other controls based on Dear Imgui"
11 topics = ("conan", "imgui", "3d", "graphics", "guizmo")
12 license = "MIT"
13 settings = "os", "arch", "compiler", "build_type"
14
15 exports_sources = ["CMakeLists.txt"]
16 generators = "cmake"
17 requires = "imgui/1.82"
18
19 options = {
20 "shared": [True, False],
21 "fPIC": [True, False]
22 }
23 default_options = {
24 "shared": False,
25 "fPIC": True
26 }
27
28 _cmake = None
29
30 @property
31 def _source_subfolder(self):
32 return "source_subfolder"
33
34 def config_options(self):
35 if self.settings.os == "Windows":
36 del self.options.fPIC
37
38 def configure(self):
39 if self.options.shared:
40 del self.options.fPIC
41
42 def source(self):
43 tools.get(**self.conan_data["sources"][self.version])
44 extracted_dir = glob.glob("ImGuizmo-*/")[0]
45 os.rename(extracted_dir, self._source_subfolder)
46
47 def _configure_cmake(self):
48 if self._cmake:
49 return self._cmake
50 self._cmake = CMake(self)
51 self._cmake.configure()
52 return self._cmake
53
54 def build(self):
55 cmake = self._configure_cmake()
56 cmake.build()
57
58 def package(self):
59 self.copy(pattern="LICENSE", dst="licenses", src=self._source_subfolder)
60 cmake = self._configure_cmake()
61 cmake.install()
62
63 def package_info(self):
64 self.cpp_info.libs = ["imguizmo"]
65
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/recipes/imguizmo/all/conanfile.py b/recipes/imguizmo/all/conanfile.py
--- a/recipes/imguizmo/all/conanfile.py
+++ b/recipes/imguizmo/all/conanfile.py
@@ -14,7 +14,6 @@
exports_sources = ["CMakeLists.txt"]
generators = "cmake"
- requires = "imgui/1.82"
options = {
"shared": [True, False],
@@ -44,6 +43,12 @@
extracted_dir = glob.glob("ImGuizmo-*/")[0]
os.rename(extracted_dir, self._source_subfolder)
+ def requirements(self):
+ if self.version == "cci.20210223":
+ self.requires("imgui/1.82")
+ else:
+ self.requires("imgui/1.83")
+
def _configure_cmake(self):
if self._cmake:
return self._cmake
|
{"golden_diff": "diff --git a/recipes/imguizmo/all/conanfile.py b/recipes/imguizmo/all/conanfile.py\n--- a/recipes/imguizmo/all/conanfile.py\n+++ b/recipes/imguizmo/all/conanfile.py\n@@ -14,7 +14,6 @@\n \n exports_sources = [\"CMakeLists.txt\"]\n generators = \"cmake\"\n- requires = \"imgui/1.82\"\n \n options = {\n \"shared\": [True, False],\n@@ -44,6 +43,12 @@\n extracted_dir = glob.glob(\"ImGuizmo-*/\")[0]\n os.rename(extracted_dir, self._source_subfolder)\n \n+ def requirements(self):\n+ if self.version == \"cci.20210223\":\n+ self.requires(\"imgui/1.82\")\n+ else:\n+ self.requires(\"imgui/1.83\")\n+\n def _configure_cmake(self):\n if self._cmake:\n return self._cmake\n", "issue": "[request] imguizmo/1.83\n### Package Details\r\n * Package Name/Version: **imguizmo/1.83**\r\n * Changelog: **https://github.com/CedricGuillemet/ImGuizmo/releases/tag/1.83**\r\n\r\nThe above mentioned version is newly released by the upstream project and not yet available as a recipe. Please add this version.\n", "before_files": [{"content": "import os\nimport glob\nfrom conans import ConanFile, CMake, tools\n\n\nclass ImGuizmoConan(ConanFile):\n name = \"imguizmo\"\n url = \"https://github.com/conan-io/conan-center-index\"\n homepage = \"https://github.com/CedricGuillemet/ImGuizmo\"\n description = \"Immediate mode 3D gizmo for scene editing and other controls based on Dear Imgui\"\n topics = (\"conan\", \"imgui\", \"3d\", \"graphics\", \"guizmo\")\n license = \"MIT\"\n settings = \"os\", \"arch\", \"compiler\", \"build_type\"\n\n exports_sources = [\"CMakeLists.txt\"]\n generators = \"cmake\"\n requires = \"imgui/1.82\"\n\n options = {\n \"shared\": [True, False],\n \"fPIC\": [True, False]\n }\n default_options = {\n \"shared\": False,\n \"fPIC\": True\n }\n\n _cmake = None\n\n @property\n def _source_subfolder(self):\n return \"source_subfolder\"\n\n def config_options(self):\n if self.settings.os == \"Windows\":\n del self.options.fPIC\n\n def configure(self):\n if self.options.shared:\n del self.options.fPIC\n\n def source(self):\n tools.get(**self.conan_data[\"sources\"][self.version])\n extracted_dir = glob.glob(\"ImGuizmo-*/\")[0]\n os.rename(extracted_dir, self._source_subfolder)\n\n def _configure_cmake(self):\n if self._cmake:\n return self._cmake\n self._cmake = CMake(self)\n self._cmake.configure()\n return self._cmake\n\n def build(self):\n cmake = self._configure_cmake()\n cmake.build()\n\n def package(self):\n self.copy(pattern=\"LICENSE\", dst=\"licenses\", src=self._source_subfolder)\n cmake = self._configure_cmake()\n cmake.install()\n\n def package_info(self):\n self.cpp_info.libs = [\"imguizmo\"]\n", "path": "recipes/imguizmo/all/conanfile.py"}], "after_files": [{"content": "import os\nimport glob\nfrom conans import ConanFile, CMake, tools\n\n\nclass ImGuizmoConan(ConanFile):\n name = \"imguizmo\"\n url = \"https://github.com/conan-io/conan-center-index\"\n homepage = \"https://github.com/CedricGuillemet/ImGuizmo\"\n description = \"Immediate mode 3D gizmo for scene editing and other controls based on Dear Imgui\"\n topics = (\"conan\", \"imgui\", \"3d\", \"graphics\", \"guizmo\")\n license = \"MIT\"\n settings = \"os\", \"arch\", \"compiler\", \"build_type\"\n\n exports_sources = [\"CMakeLists.txt\"]\n generators = \"cmake\"\n\n options = {\n \"shared\": [True, False],\n \"fPIC\": [True, False]\n }\n default_options = {\n \"shared\": False,\n \"fPIC\": True\n }\n\n _cmake = None\n\n @property\n def _source_subfolder(self):\n return \"source_subfolder\"\n\n def config_options(self):\n if self.settings.os == \"Windows\":\n del self.options.fPIC\n\n def configure(self):\n if self.options.shared:\n del self.options.fPIC\n\n def source(self):\n tools.get(**self.conan_data[\"sources\"][self.version])\n extracted_dir = glob.glob(\"ImGuizmo-*/\")[0]\n os.rename(extracted_dir, self._source_subfolder)\n\n def requirements(self):\n if self.version == \"cci.20210223\":\n self.requires(\"imgui/1.82\")\n else:\n self.requires(\"imgui/1.83\")\n\n def _configure_cmake(self):\n if self._cmake:\n return self._cmake\n self._cmake = CMake(self)\n self._cmake.configure()\n return self._cmake\n\n def build(self):\n cmake = self._configure_cmake()\n cmake.build()\n\n def package(self):\n self.copy(pattern=\"LICENSE\", dst=\"licenses\", src=self._source_subfolder)\n cmake = self._configure_cmake()\n cmake.install()\n\n def package_info(self):\n self.cpp_info.libs = [\"imguizmo\"]\n", "path": "recipes/imguizmo/all/conanfile.py"}]}
| 939 | 233 |
gh_patches_debug_3362
|
rasdani/github-patches
|
git_diff
|
sunpy__sunpy-4468
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
sunpy logo link broken
The link to "sunpy logo" here: https://sunpy.org/about#acknowledging-sunpy-in-posters-and-talks just redirects to the same page instead of a logo.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `docs/conf.py`
Content:
```
1 """
2 Configuration file for the Sphinx documentation builder.
3
4 isort:skip_file
5 """
6 # flake8: NOQA: E402
7
8 # -- stdlib imports ------------------------------------------------------------
9 import os
10 import sys
11 import datetime
12 from pkg_resources import get_distribution, DistributionNotFound
13
14 # -- Check for dependencies ----------------------------------------------------
15
16 doc_requires = get_distribution("sunpy").requires(extras=("docs",))
17 missing_requirements = []
18 for requirement in doc_requires:
19 try:
20 get_distribution(requirement)
21 except Exception as e:
22 missing_requirements.append(requirement.name)
23 if missing_requirements:
24 print(
25 f"The {' '.join(missing_requirements)} package(s) could not be found and "
26 "is needed to build the documentation, please install the 'docs' requirements."
27 )
28 sys.exit(1)
29
30 # -- Read the Docs Specific Configuration --------------------------------------
31
32 # This needs to be done before sunpy is imported
33 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
34 if on_rtd:
35 os.environ['SUNPY_CONFIGDIR'] = '/home/docs/'
36 os.environ['HOME'] = '/home/docs/'
37 os.environ['LANG'] = 'C'
38 os.environ['LC_ALL'] = 'C'
39
40 # -- Non stdlib imports --------------------------------------------------------
41
42 import ruamel.yaml as yaml # NOQA
43 from sphinx_gallery.sorting import ExplicitOrder # NOQA
44 from sphinx_gallery.sorting import ExampleTitleSortKey # NOQA
45
46 import sunpy # NOQA
47 from sunpy import __version__ # NOQA
48
49 # -- Project information -------------------------------------------------------
50
51 project = 'SunPy'
52 author = 'The SunPy Community'
53 copyright = '{}, {}'.format(datetime.datetime.now().year, author)
54
55 # The full version, including alpha/beta/rc tags
56 release = __version__
57 is_development = '.dev' in __version__
58
59 # -- SunPy Sample Data and Config ----------------------------------------------
60
61 # We set the logger to debug so that we can see any sample data download errors
62 # in the CI, especially RTD.
63 ori_level = sunpy.log.level
64 sunpy.log.setLevel("DEBUG")
65 import sunpy.data.sample # NOQA
66 sunpy.log.setLevel(ori_level)
67
68 # For the linkcheck
69 linkcheck_ignore = [r"https://doi.org/\d+",
70 r"https://riot.im/\d+",
71 r"https://github.com/\d+",
72 r"https://docs.sunpy.org/\d+"]
73 linkcheck_anchors = False
74
75 # This is added to the end of RST files - a good place to put substitutions to
76 # be used globally.
77 rst_epilog = """
78 .. SunPy
79 .. _SunPy: https://sunpy.org
80 .. _`SunPy mailing list`: https://groups.google.com/group/sunpy
81 .. _`SunPy dev mailing list`: https://groups.google.com/group/sunpy-dev
82 """
83
84 # -- General configuration -----------------------------------------------------
85
86 # Suppress warnings about overriding directives as we overload some of the
87 # doctest extensions.
88 suppress_warnings = ['app.add_directive', ]
89
90 # Add any Sphinx extension module names here, as strings. They can be
91 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
92 # ones.
93 extensions = [
94 'matplotlib.sphinxext.plot_directive',
95 'sphinx_automodapi.automodapi',
96 'sphinx_automodapi.smart_resolver',
97 'sphinx_gallery.gen_gallery',
98 'sphinx.ext.autodoc',
99 'sphinx.ext.coverage',
100 'sphinx.ext.doctest',
101 'sphinx.ext.inheritance_diagram',
102 'sphinx.ext.intersphinx',
103 'sphinx.ext.mathjax',
104 'sphinx.ext.napoleon',
105 'sphinx.ext.todo',
106 'sphinx.ext.viewcode',
107 'sunpy.util.sphinx.changelog',
108 'sunpy.util.sphinx.doctest',
109 'sunpy.util.sphinx.generate',
110 ]
111
112 # Add any paths that contain templates here, relative to this directory.
113 # templates_path = ['_templates']
114
115 # List of patterns, relative to source directory, that match files and
116 # directories to ignore when looking for source files.
117 # This pattern also affects html_static_path and html_extra_path.
118 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
119
120 # The suffix(es) of source filenames.
121 # You can specify multiple suffix as a list of string:
122 source_suffix = '.rst'
123
124 # The master toctree document.
125 master_doc = 'index'
126
127 # The reST default role (used for this markup: `text`) to use for all
128 # documents. Set to the "smart" one.
129 default_role = 'obj'
130
131 # Disable having a separate return type row
132 napoleon_use_rtype = False
133
134 # Disable google style docstrings
135 napoleon_google_docstring = False
136
137 # -- Options for intersphinx extension -----------------------------------------
138
139 # Example configuration for intersphinx: refer to the Python standard library.
140 intersphinx_mapping = {
141 'python': ('https://docs.python.org/3/',
142 (None, 'http://www.astropy.org/astropy-data/intersphinx/python3.inv')),
143 'numpy': ('https://numpy.org/doc/stable/',
144 (None, 'http://www.astropy.org/astropy-data/intersphinx/numpy.inv')),
145 'scipy': ('https://docs.scipy.org/doc/scipy/reference/',
146 (None, 'http://www.astropy.org/astropy-data/intersphinx/scipy.inv')),
147 'matplotlib': ('https://matplotlib.org/',
148 (None, 'http://www.astropy.org/astropy-data/intersphinx/matplotlib.inv')),
149 'astropy': ('https://docs.astropy.org/en/stable/', None),
150 'sqlalchemy': ('https://docs.sqlalchemy.org/en/latest/', None),
151 'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
152 'skimage': ('https://scikit-image.org/docs/stable/', None),
153 'drms': ('https://docs.sunpy.org/projects/drms/en/stable/', None),
154 'parfive': ('https://parfive.readthedocs.io/en/latest/', None),
155 'reproject': ('https://reproject.readthedocs.io/en/stable/', None),
156 }
157
158 # -- Options for HTML output ---------------------------------------------------
159
160 # The theme to use for HTML and HTML Help pages. See the documentation for
161 # a list of builtin themes.
162
163 from sunpy_sphinx_theme.conf import * # NOQA
164
165 # Add any paths that contain custom static files (such as style sheets) here,
166 # relative to this directory. They are copied after the builtin static files,
167 # so a file named "default.css" will overwrite the builtin "default.css".
168 # html_static_path = ['_static']
169
170 # Render inheritance diagrams in SVG
171 graphviz_output_format = "svg"
172
173 graphviz_dot_args = [
174 '-Nfontsize=10',
175 '-Nfontname=Helvetica Neue, Helvetica, Arial, sans-serif',
176 '-Efontsize=10',
177 '-Efontname=Helvetica Neue, Helvetica, Arial, sans-serif',
178 '-Gfontsize=10',
179 '-Gfontname=Helvetica Neue, Helvetica, Arial, sans-serif'
180 ]
181
182 # -- Sphinx Gallery ------------------------------------------------------------
183
184 sphinx_gallery_conf = {
185 'backreferences_dir': os.path.join('generated', 'modules'),
186 'filename_pattern': '^((?!skip_).)*$',
187 'examples_dirs': os.path.join('..', 'examples'),
188 'subsection_order': ExplicitOrder([
189 '../examples/acquiring_data',
190 '../examples/map',
191 '../examples/map_transformations',
192 '../examples/time_series',
193 '../examples/units_and_coordinates',
194 '../examples/plotting',
195 '../examples/differential_rotation',
196 '../examples/saving_and_loading_data',
197 '../examples/computer_vision_techniques',
198 '../examples/developer_tools'
199 ]),
200 'within_subsection_order': ExampleTitleSortKey,
201 'gallery_dirs': os.path.join('generated', 'gallery'),
202 'default_thumb_file': os.path.join('logo', 'sunpy_icon_128x128.png'),
203 'abort_on_example_error': False,
204 'plot_gallery': 'True',
205 'remove_config_comments': True,
206 'doc_module': ('sunpy'),
207 }
208
209 # -- Stability Page ------------------------------------------------------------
210
211 with open('./dev_guide/sunpy_stability.yaml', 'r') as estability:
212 sunpy_modules = yaml.load(estability.read(), Loader=yaml.Loader)
213
214 html_context = {
215 'sunpy_modules': sunpy_modules
216 }
217
218
219 def rstjinja(app, docname, source):
220 """
221 Render our pages as a jinja template for fancy templating goodness.
222 """
223 # Make sure we're outputting HTML
224 if app.builder.format != 'html':
225 return
226 src = source[0]
227 if "Current status" in src[:20]:
228 rendered = app.builder.templates.render_string(
229 src, app.config.html_context
230 )
231 source[0] = rendered
232
233
234 # -- Sphinx setup --------------------------------------------------------------
235 def setup(app):
236 # Generate the stability page
237 app.connect("source-read", rstjinja)
238
239 # The theme conf provides a fix for circle ci redirections
240 fix_circleci(app)
241
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/docs/conf.py b/docs/conf.py
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -67,7 +67,7 @@
# For the linkcheck
linkcheck_ignore = [r"https://doi.org/\d+",
- r"https://riot.im/\d+",
+ r"https://element.io/\d+",
r"https://github.com/\d+",
r"https://docs.sunpy.org/\d+"]
linkcheck_anchors = False
|
{"golden_diff": "diff --git a/docs/conf.py b/docs/conf.py\n--- a/docs/conf.py\n+++ b/docs/conf.py\n@@ -67,7 +67,7 @@\n \n # For the linkcheck\n linkcheck_ignore = [r\"https://doi.org/\\d+\",\n- r\"https://riot.im/\\d+\",\n+ r\"https://element.io/\\d+\",\n r\"https://github.com/\\d+\",\n r\"https://docs.sunpy.org/\\d+\"]\n linkcheck_anchors = False\n", "issue": "sunpy logo link broken\nThe link to \"sunpy logo\" here: https://sunpy.org/about#acknowledging-sunpy-in-posters-and-talks just redirects to the same page instead of a logo.\n", "before_files": [{"content": "\"\"\"\nConfiguration file for the Sphinx documentation builder.\n\nisort:skip_file\n\"\"\"\n# flake8: NOQA: E402\n\n# -- stdlib imports ------------------------------------------------------------\nimport os\nimport sys\nimport datetime\nfrom pkg_resources import get_distribution, DistributionNotFound\n\n# -- Check for dependencies ----------------------------------------------------\n\ndoc_requires = get_distribution(\"sunpy\").requires(extras=(\"docs\",))\nmissing_requirements = []\nfor requirement in doc_requires:\n try:\n get_distribution(requirement)\n except Exception as e:\n missing_requirements.append(requirement.name)\nif missing_requirements:\n print(\n f\"The {' '.join(missing_requirements)} package(s) could not be found and \"\n \"is needed to build the documentation, please install the 'docs' requirements.\"\n )\n sys.exit(1)\n\n# -- Read the Docs Specific Configuration --------------------------------------\n\n# This needs to be done before sunpy is imported\non_rtd = os.environ.get('READTHEDOCS', None) == 'True'\nif on_rtd:\n os.environ['SUNPY_CONFIGDIR'] = '/home/docs/'\n os.environ['HOME'] = '/home/docs/'\n os.environ['LANG'] = 'C'\n os.environ['LC_ALL'] = 'C'\n\n# -- Non stdlib imports --------------------------------------------------------\n\nimport ruamel.yaml as yaml # NOQA\nfrom sphinx_gallery.sorting import ExplicitOrder # NOQA\nfrom sphinx_gallery.sorting import ExampleTitleSortKey # NOQA\n\nimport sunpy # NOQA\nfrom sunpy import __version__ # NOQA\n\n# -- Project information -------------------------------------------------------\n\nproject = 'SunPy'\nauthor = 'The SunPy Community'\ncopyright = '{}, {}'.format(datetime.datetime.now().year, author)\n\n# The full version, including alpha/beta/rc tags\nrelease = __version__\nis_development = '.dev' in __version__\n\n# -- SunPy Sample Data and Config ----------------------------------------------\n\n# We set the logger to debug so that we can see any sample data download errors\n# in the CI, especially RTD.\nori_level = sunpy.log.level\nsunpy.log.setLevel(\"DEBUG\")\nimport sunpy.data.sample # NOQA\nsunpy.log.setLevel(ori_level)\n\n# For the linkcheck\nlinkcheck_ignore = [r\"https://doi.org/\\d+\",\n r\"https://riot.im/\\d+\",\n r\"https://github.com/\\d+\",\n r\"https://docs.sunpy.org/\\d+\"]\nlinkcheck_anchors = False\n\n# This is added to the end of RST files - a good place to put substitutions to\n# be used globally.\nrst_epilog = \"\"\"\n.. SunPy\n.. _SunPy: https://sunpy.org\n.. _`SunPy mailing list`: https://groups.google.com/group/sunpy\n.. _`SunPy dev mailing list`: https://groups.google.com/group/sunpy-dev\n\"\"\"\n\n# -- General configuration -----------------------------------------------------\n\n# Suppress warnings about overriding directives as we overload some of the\n# doctest extensions.\nsuppress_warnings = ['app.add_directive', ]\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n 'matplotlib.sphinxext.plot_directive',\n 'sphinx_automodapi.automodapi',\n 'sphinx_automodapi.smart_resolver',\n 'sphinx_gallery.gen_gallery',\n 'sphinx.ext.autodoc',\n 'sphinx.ext.coverage',\n 'sphinx.ext.doctest',\n 'sphinx.ext.inheritance_diagram',\n 'sphinx.ext.intersphinx',\n 'sphinx.ext.mathjax',\n 'sphinx.ext.napoleon',\n 'sphinx.ext.todo',\n 'sphinx.ext.viewcode',\n 'sunpy.util.sphinx.changelog',\n 'sunpy.util.sphinx.doctest',\n 'sunpy.util.sphinx.generate',\n]\n\n# Add any paths that contain templates here, relative to this directory.\n# templates_path = ['_templates']\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\n# This pattern also affects html_static_path and html_extra_path.\nexclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']\n\n# The suffix(es) of source filenames.\n# You can specify multiple suffix as a list of string:\nsource_suffix = '.rst'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# The reST default role (used for this markup: `text`) to use for all\n# documents. Set to the \"smart\" one.\ndefault_role = 'obj'\n\n# Disable having a separate return type row\nnapoleon_use_rtype = False\n\n# Disable google style docstrings\nnapoleon_google_docstring = False\n\n# -- Options for intersphinx extension -----------------------------------------\n\n# Example configuration for intersphinx: refer to the Python standard library.\nintersphinx_mapping = {\n 'python': ('https://docs.python.org/3/',\n (None, 'http://www.astropy.org/astropy-data/intersphinx/python3.inv')),\n 'numpy': ('https://numpy.org/doc/stable/',\n (None, 'http://www.astropy.org/astropy-data/intersphinx/numpy.inv')),\n 'scipy': ('https://docs.scipy.org/doc/scipy/reference/',\n (None, 'http://www.astropy.org/astropy-data/intersphinx/scipy.inv')),\n 'matplotlib': ('https://matplotlib.org/',\n (None, 'http://www.astropy.org/astropy-data/intersphinx/matplotlib.inv')),\n 'astropy': ('https://docs.astropy.org/en/stable/', None),\n 'sqlalchemy': ('https://docs.sqlalchemy.org/en/latest/', None),\n 'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),\n 'skimage': ('https://scikit-image.org/docs/stable/', None),\n 'drms': ('https://docs.sunpy.org/projects/drms/en/stable/', None),\n 'parfive': ('https://parfive.readthedocs.io/en/latest/', None),\n 'reproject': ('https://reproject.readthedocs.io/en/stable/', None),\n}\n\n# -- Options for HTML output ---------------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\n\nfrom sunpy_sphinx_theme.conf import * # NOQA\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\n# html_static_path = ['_static']\n\n# Render inheritance diagrams in SVG\ngraphviz_output_format = \"svg\"\n\ngraphviz_dot_args = [\n '-Nfontsize=10',\n '-Nfontname=Helvetica Neue, Helvetica, Arial, sans-serif',\n '-Efontsize=10',\n '-Efontname=Helvetica Neue, Helvetica, Arial, sans-serif',\n '-Gfontsize=10',\n '-Gfontname=Helvetica Neue, Helvetica, Arial, sans-serif'\n]\n\n# -- Sphinx Gallery ------------------------------------------------------------\n\nsphinx_gallery_conf = {\n 'backreferences_dir': os.path.join('generated', 'modules'),\n 'filename_pattern': '^((?!skip_).)*$',\n 'examples_dirs': os.path.join('..', 'examples'),\n 'subsection_order': ExplicitOrder([\n '../examples/acquiring_data',\n '../examples/map',\n '../examples/map_transformations',\n '../examples/time_series',\n '../examples/units_and_coordinates',\n '../examples/plotting',\n '../examples/differential_rotation',\n '../examples/saving_and_loading_data',\n '../examples/computer_vision_techniques',\n '../examples/developer_tools'\n ]),\n 'within_subsection_order': ExampleTitleSortKey,\n 'gallery_dirs': os.path.join('generated', 'gallery'),\n 'default_thumb_file': os.path.join('logo', 'sunpy_icon_128x128.png'),\n 'abort_on_example_error': False,\n 'plot_gallery': 'True',\n 'remove_config_comments': True,\n 'doc_module': ('sunpy'),\n}\n\n# -- Stability Page ------------------------------------------------------------\n\nwith open('./dev_guide/sunpy_stability.yaml', 'r') as estability:\n sunpy_modules = yaml.load(estability.read(), Loader=yaml.Loader)\n\nhtml_context = {\n 'sunpy_modules': sunpy_modules\n}\n\n\ndef rstjinja(app, docname, source):\n \"\"\"\n Render our pages as a jinja template for fancy templating goodness.\n \"\"\"\n # Make sure we're outputting HTML\n if app.builder.format != 'html':\n return\n src = source[0]\n if \"Current status\" in src[:20]:\n rendered = app.builder.templates.render_string(\n src, app.config.html_context\n )\n source[0] = rendered\n\n\n# -- Sphinx setup --------------------------------------------------------------\ndef setup(app):\n # Generate the stability page\n app.connect(\"source-read\", rstjinja)\n\n # The theme conf provides a fix for circle ci redirections\n fix_circleci(app)\n", "path": "docs/conf.py"}], "after_files": [{"content": "\"\"\"\nConfiguration file for the Sphinx documentation builder.\n\nisort:skip_file\n\"\"\"\n# flake8: NOQA: E402\n\n# -- stdlib imports ------------------------------------------------------------\nimport os\nimport sys\nimport datetime\nfrom pkg_resources import get_distribution, DistributionNotFound\n\n# -- Check for dependencies ----------------------------------------------------\n\ndoc_requires = get_distribution(\"sunpy\").requires(extras=(\"docs\",))\nmissing_requirements = []\nfor requirement in doc_requires:\n try:\n get_distribution(requirement)\n except Exception as e:\n missing_requirements.append(requirement.name)\nif missing_requirements:\n print(\n f\"The {' '.join(missing_requirements)} package(s) could not be found and \"\n \"is needed to build the documentation, please install the 'docs' requirements.\"\n )\n sys.exit(1)\n\n# -- Read the Docs Specific Configuration --------------------------------------\n\n# This needs to be done before sunpy is imported\non_rtd = os.environ.get('READTHEDOCS', None) == 'True'\nif on_rtd:\n os.environ['SUNPY_CONFIGDIR'] = '/home/docs/'\n os.environ['HOME'] = '/home/docs/'\n os.environ['LANG'] = 'C'\n os.environ['LC_ALL'] = 'C'\n\n# -- Non stdlib imports --------------------------------------------------------\n\nimport ruamel.yaml as yaml # NOQA\nfrom sphinx_gallery.sorting import ExplicitOrder # NOQA\nfrom sphinx_gallery.sorting import ExampleTitleSortKey # NOQA\n\nimport sunpy # NOQA\nfrom sunpy import __version__ # NOQA\n\n# -- Project information -------------------------------------------------------\n\nproject = 'SunPy'\nauthor = 'The SunPy Community'\ncopyright = '{}, {}'.format(datetime.datetime.now().year, author)\n\n# The full version, including alpha/beta/rc tags\nrelease = __version__\nis_development = '.dev' in __version__\n\n# -- SunPy Sample Data and Config ----------------------------------------------\n\n# We set the logger to debug so that we can see any sample data download errors\n# in the CI, especially RTD.\nori_level = sunpy.log.level\nsunpy.log.setLevel(\"DEBUG\")\nimport sunpy.data.sample # NOQA\nsunpy.log.setLevel(ori_level)\n\n# For the linkcheck\nlinkcheck_ignore = [r\"https://doi.org/\\d+\",\n r\"https://element.io/\\d+\",\n r\"https://github.com/\\d+\",\n r\"https://docs.sunpy.org/\\d+\"]\nlinkcheck_anchors = False\n\n# This is added to the end of RST files - a good place to put substitutions to\n# be used globally.\nrst_epilog = \"\"\"\n.. SunPy\n.. _SunPy: https://sunpy.org\n.. _`SunPy mailing list`: https://groups.google.com/group/sunpy\n.. _`SunPy dev mailing list`: https://groups.google.com/group/sunpy-dev\n\"\"\"\n\n# -- General configuration -----------------------------------------------------\n\n# Suppress warnings about overriding directives as we overload some of the\n# doctest extensions.\nsuppress_warnings = ['app.add_directive', ]\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n 'matplotlib.sphinxext.plot_directive',\n 'sphinx_automodapi.automodapi',\n 'sphinx_automodapi.smart_resolver',\n 'sphinx_gallery.gen_gallery',\n 'sphinx.ext.autodoc',\n 'sphinx.ext.coverage',\n 'sphinx.ext.doctest',\n 'sphinx.ext.inheritance_diagram',\n 'sphinx.ext.intersphinx',\n 'sphinx.ext.mathjax',\n 'sphinx.ext.napoleon',\n 'sphinx.ext.todo',\n 'sphinx.ext.viewcode',\n 'sunpy.util.sphinx.changelog',\n 'sunpy.util.sphinx.doctest',\n 'sunpy.util.sphinx.generate',\n]\n\n# Add any paths that contain templates here, relative to this directory.\n# templates_path = ['_templates']\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\n# This pattern also affects html_static_path and html_extra_path.\nexclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']\n\n# The suffix(es) of source filenames.\n# You can specify multiple suffix as a list of string:\nsource_suffix = '.rst'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# The reST default role (used for this markup: `text`) to use for all\n# documents. Set to the \"smart\" one.\ndefault_role = 'obj'\n\n# Disable having a separate return type row\nnapoleon_use_rtype = False\n\n# Disable google style docstrings\nnapoleon_google_docstring = False\n\n# -- Options for intersphinx extension -----------------------------------------\n\n# Example configuration for intersphinx: refer to the Python standard library.\nintersphinx_mapping = {\n 'python': ('https://docs.python.org/3/',\n (None, 'http://www.astropy.org/astropy-data/intersphinx/python3.inv')),\n 'numpy': ('https://numpy.org/doc/stable/',\n (None, 'http://www.astropy.org/astropy-data/intersphinx/numpy.inv')),\n 'scipy': ('https://docs.scipy.org/doc/scipy/reference/',\n (None, 'http://www.astropy.org/astropy-data/intersphinx/scipy.inv')),\n 'matplotlib': ('https://matplotlib.org/',\n (None, 'http://www.astropy.org/astropy-data/intersphinx/matplotlib.inv')),\n 'astropy': ('https://docs.astropy.org/en/stable/', None),\n 'sqlalchemy': ('https://docs.sqlalchemy.org/en/latest/', None),\n 'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),\n 'skimage': ('https://scikit-image.org/docs/stable/', None),\n 'drms': ('https://docs.sunpy.org/projects/drms/en/stable/', None),\n 'parfive': ('https://parfive.readthedocs.io/en/latest/', None),\n 'reproject': ('https://reproject.readthedocs.io/en/stable/', None),\n}\n\n# -- Options for HTML output ---------------------------------------------------\n\n# The theme to use for HTML and HTML Help pages. See the documentation for\n# a list of builtin themes.\n\nfrom sunpy_sphinx_theme.conf import * # NOQA\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\n# html_static_path = ['_static']\n\n# Render inheritance diagrams in SVG\ngraphviz_output_format = \"svg\"\n\ngraphviz_dot_args = [\n '-Nfontsize=10',\n '-Nfontname=Helvetica Neue, Helvetica, Arial, sans-serif',\n '-Efontsize=10',\n '-Efontname=Helvetica Neue, Helvetica, Arial, sans-serif',\n '-Gfontsize=10',\n '-Gfontname=Helvetica Neue, Helvetica, Arial, sans-serif'\n]\n\n# -- Sphinx Gallery ------------------------------------------------------------\n\nsphinx_gallery_conf = {\n 'backreferences_dir': os.path.join('generated', 'modules'),\n 'filename_pattern': '^((?!skip_).)*$',\n 'examples_dirs': os.path.join('..', 'examples'),\n 'subsection_order': ExplicitOrder([\n '../examples/acquiring_data',\n '../examples/map',\n '../examples/map_transformations',\n '../examples/time_series',\n '../examples/units_and_coordinates',\n '../examples/plotting',\n '../examples/differential_rotation',\n '../examples/saving_and_loading_data',\n '../examples/computer_vision_techniques',\n '../examples/developer_tools'\n ]),\n 'within_subsection_order': ExampleTitleSortKey,\n 'gallery_dirs': os.path.join('generated', 'gallery'),\n 'default_thumb_file': os.path.join('logo', 'sunpy_icon_128x128.png'),\n 'abort_on_example_error': False,\n 'plot_gallery': 'True',\n 'remove_config_comments': True,\n 'doc_module': ('sunpy'),\n}\n\n# -- Stability Page ------------------------------------------------------------\n\nwith open('./dev_guide/sunpy_stability.yaml', 'r') as estability:\n sunpy_modules = yaml.load(estability.read(), Loader=yaml.Loader)\n\nhtml_context = {\n 'sunpy_modules': sunpy_modules\n}\n\n\ndef rstjinja(app, docname, source):\n \"\"\"\n Render our pages as a jinja template for fancy templating goodness.\n \"\"\"\n # Make sure we're outputting HTML\n if app.builder.format != 'html':\n return\n src = source[0]\n if \"Current status\" in src[:20]:\n rendered = app.builder.templates.render_string(\n src, app.config.html_context\n )\n source[0] = rendered\n\n\n# -- Sphinx setup --------------------------------------------------------------\ndef setup(app):\n # Generate the stability page\n app.connect(\"source-read\", rstjinja)\n\n # The theme conf provides a fix for circle ci redirections\n fix_circleci(app)\n", "path": "docs/conf.py"}]}
| 2,900 | 108 |
gh_patches_debug_11581
|
rasdani/github-patches
|
git_diff
|
urllib3__urllib3-2816
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Make our downstream integration tests re-runnable
Currently our downstream tests both clone a git repository into the venv created by nox. Due to how the setup is written the nox session will fail when run a second time due to the repository already existing. It would be nice to be able to run:
`$ nox -rs downstream_requests` over and over without needing to reclone the repository or manually configure the test setup.
I think checking that the repository exists and if so not applying the git patches and continuing as normal would work okay for this case?
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `noxfile.py`
Content:
```
1 import os
2 import shutil
3 import subprocess
4 import sys
5
6 import nox
7
8 SOURCE_FILES = [
9 "docs/",
10 "dummyserver/",
11 "src/",
12 "test/",
13 "noxfile.py",
14 "setup.py",
15 ]
16
17
18 def tests_impl(
19 session: nox.Session,
20 extras: str = "socks,secure,brotli,zstd",
21 byte_string_comparisons: bool = True,
22 ) -> None:
23 # Install deps and the package itself.
24 session.install("-r", "dev-requirements.txt")
25 session.install(f".[{extras}]")
26
27 # Show the pip version.
28 session.run("pip", "--version")
29 # Print the Python version and bytesize.
30 session.run("python", "--version")
31 session.run("python", "-c", "import struct; print(struct.calcsize('P') * 8)")
32 # Print OpenSSL information.
33 session.run("python", "-m", "OpenSSL.debug")
34
35 memray_supported = True
36 if sys.implementation.name != "cpython" or sys.version_info < (3, 8):
37 memray_supported = False # pytest-memray requires CPython 3.8+
38 elif sys.platform == "win32":
39 memray_supported = False
40
41 # Inspired from https://hynek.me/articles/ditch-codecov-python/
42 # We use parallel mode and then combine in a later CI step
43 session.run(
44 "python",
45 *(("-bb",) if byte_string_comparisons else ()),
46 "-m",
47 "coverage",
48 "run",
49 "--parallel-mode",
50 "-m",
51 "pytest",
52 *("--memray", "--hide-memray-summary") if memray_supported else (),
53 "-v",
54 "-ra",
55 f"--color={'yes' if 'GITHUB_ACTIONS' in os.environ else 'auto'}",
56 "--tb=native",
57 "--no-success-flaky-report",
58 *(session.posargs or ("test/",)),
59 env={"PYTHONWARNINGS": "always::DeprecationWarning"},
60 )
61
62
63 @nox.session(python=["3.7", "3.8", "3.9", "3.10", "3.11", "pypy"])
64 def test(session: nox.Session) -> None:
65 tests_impl(session)
66
67
68 @nox.session(python=["2.7"])
69 def unsupported_setup_py(session: nox.Session) -> None:
70 # Can't check both returncode and output with session.run
71 process = subprocess.run(
72 ["python", "setup.py", "install"],
73 env={**session.env},
74 text=True,
75 capture_output=True,
76 )
77 assert process.returncode == 1
78 print(process.stderr)
79 assert "Please use `python -m pip install .` instead." in process.stderr
80
81
82 @nox.session(python=["3"])
83 def test_brotlipy(session: nox.Session) -> None:
84 """Check that if 'brotlipy' is installed instead of 'brotli' or
85 'brotlicffi' that we still don't blow up.
86 """
87 session.install("brotlipy")
88 tests_impl(session, extras="socks,secure", byte_string_comparisons=False)
89
90
91 def git_clone(session: nox.Session, git_url: str) -> None:
92 session.run("git", "clone", "--depth", "1", git_url, external=True)
93
94
95 @nox.session()
96 def downstream_botocore(session: nox.Session) -> None:
97 root = os.getcwd()
98 tmp_dir = session.create_tmp()
99
100 session.cd(tmp_dir)
101 git_clone(session, "https://github.com/boto/botocore")
102 session.chdir("botocore")
103 for patch in [
104 "0001-Mark-100-Continue-tests-as-failing.patch",
105 "0002-Stop-relying-on-removed-DEFAULT_CIPHERS.patch",
106 ]:
107 session.run("git", "apply", f"{root}/ci/{patch}", external=True)
108 session.run("git", "rev-parse", "HEAD", external=True)
109 session.run("python", "scripts/ci/install")
110
111 session.cd(root)
112 session.install(".", silent=False)
113 session.cd(f"{tmp_dir}/botocore")
114
115 session.run("python", "-c", "import urllib3; print(urllib3.__version__)")
116 session.run("python", "scripts/ci/run-tests")
117
118
119 @nox.session()
120 def downstream_requests(session: nox.Session) -> None:
121 root = os.getcwd()
122 tmp_dir = session.create_tmp()
123
124 session.cd(tmp_dir)
125 git_clone(session, "https://github.com/psf/requests")
126 session.chdir("requests")
127 session.run(
128 "git", "apply", f"{root}/ci/0003-requests-removed-warnings.patch", external=True
129 )
130 session.run(
131 "git", "apply", f"{root}/ci/0004-requests-chunked-requests.patch", external=True
132 )
133 session.run("git", "rev-parse", "HEAD", external=True)
134 session.install(".[socks]", silent=False)
135 session.install("-r", "requirements-dev.txt", silent=False)
136
137 session.cd(root)
138 session.install(".", silent=False)
139 session.cd(f"{tmp_dir}/requests")
140
141 session.run("python", "-c", "import urllib3; print(urllib3.__version__)")
142 session.run("pytest", "tests")
143
144
145 @nox.session()
146 def format(session: nox.Session) -> None:
147 """Run code formatters."""
148 lint(session)
149
150
151 @nox.session
152 def lint(session: nox.Session) -> None:
153 session.install("pre-commit")
154 session.run("pre-commit", "run", "--all-files")
155
156 mypy(session)
157
158
159 @nox.session(python="3.8")
160 def mypy(session: nox.Session) -> None:
161 """Run mypy."""
162 session.install("-r", "mypy-requirements.txt")
163 session.run("mypy", "--version")
164 session.run(
165 "mypy",
166 "dummyserver",
167 "noxfile.py",
168 "src/urllib3",
169 "test",
170 )
171
172
173 @nox.session
174 def docs(session: nox.Session) -> None:
175 session.install("-r", "docs/requirements.txt")
176 session.install(".[socks,secure,brotli,zstd]")
177
178 session.chdir("docs")
179 if os.path.exists("_build"):
180 shutil.rmtree("_build")
181 session.run("sphinx-build", "-b", "html", "-W", ".", "_build/html")
182
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/noxfile.py b/noxfile.py
--- a/noxfile.py
+++ b/noxfile.py
@@ -89,7 +89,21 @@
def git_clone(session: nox.Session, git_url: str) -> None:
- session.run("git", "clone", "--depth", "1", git_url, external=True)
+ """We either clone the target repository or if already exist
+ simply reset the state and pull.
+ """
+ expected_directory = git_url.split("/")[-1]
+
+ if expected_directory.endswith(".git"):
+ expected_directory = expected_directory[:-4]
+
+ if not os.path.isdir(expected_directory):
+ session.run("git", "clone", "--depth", "1", git_url, external=True)
+ else:
+ session.run(
+ "git", "-C", expected_directory, "reset", "--hard", "HEAD", external=True
+ )
+ session.run("git", "-C", expected_directory, "pull", external=True)
@nox.session()
|
{"golden_diff": "diff --git a/noxfile.py b/noxfile.py\n--- a/noxfile.py\n+++ b/noxfile.py\n@@ -89,7 +89,21 @@\n \n \n def git_clone(session: nox.Session, git_url: str) -> None:\n- session.run(\"git\", \"clone\", \"--depth\", \"1\", git_url, external=True)\n+ \"\"\"We either clone the target repository or if already exist\n+ simply reset the state and pull.\n+ \"\"\"\n+ expected_directory = git_url.split(\"/\")[-1]\n+\n+ if expected_directory.endswith(\".git\"):\n+ expected_directory = expected_directory[:-4]\n+\n+ if not os.path.isdir(expected_directory):\n+ session.run(\"git\", \"clone\", \"--depth\", \"1\", git_url, external=True)\n+ else:\n+ session.run(\n+ \"git\", \"-C\", expected_directory, \"reset\", \"--hard\", \"HEAD\", external=True\n+ )\n+ session.run(\"git\", \"-C\", expected_directory, \"pull\", external=True)\n \n \n @nox.session()\n", "issue": "Make our downstream integration tests re-runnable\nCurrently our downstream tests both clone a git repository into the venv created by nox. Due to how the setup is written the nox session will fail when run a second time due to the repository already existing. It would be nice to be able to run:\r\n\r\n`$ nox -rs downstream_requests` over and over without needing to reclone the repository or manually configure the test setup.\r\n\r\nI think checking that the repository exists and if so not applying the git patches and continuing as normal would work okay for this case?\n", "before_files": [{"content": "import os\nimport shutil\nimport subprocess\nimport sys\n\nimport nox\n\nSOURCE_FILES = [\n \"docs/\",\n \"dummyserver/\",\n \"src/\",\n \"test/\",\n \"noxfile.py\",\n \"setup.py\",\n]\n\n\ndef tests_impl(\n session: nox.Session,\n extras: str = \"socks,secure,brotli,zstd\",\n byte_string_comparisons: bool = True,\n) -> None:\n # Install deps and the package itself.\n session.install(\"-r\", \"dev-requirements.txt\")\n session.install(f\".[{extras}]\")\n\n # Show the pip version.\n session.run(\"pip\", \"--version\")\n # Print the Python version and bytesize.\n session.run(\"python\", \"--version\")\n session.run(\"python\", \"-c\", \"import struct; print(struct.calcsize('P') * 8)\")\n # Print OpenSSL information.\n session.run(\"python\", \"-m\", \"OpenSSL.debug\")\n\n memray_supported = True\n if sys.implementation.name != \"cpython\" or sys.version_info < (3, 8):\n memray_supported = False # pytest-memray requires CPython 3.8+\n elif sys.platform == \"win32\":\n memray_supported = False\n\n # Inspired from https://hynek.me/articles/ditch-codecov-python/\n # We use parallel mode and then combine in a later CI step\n session.run(\n \"python\",\n *((\"-bb\",) if byte_string_comparisons else ()),\n \"-m\",\n \"coverage\",\n \"run\",\n \"--parallel-mode\",\n \"-m\",\n \"pytest\",\n *(\"--memray\", \"--hide-memray-summary\") if memray_supported else (),\n \"-v\",\n \"-ra\",\n f\"--color={'yes' if 'GITHUB_ACTIONS' in os.environ else 'auto'}\",\n \"--tb=native\",\n \"--no-success-flaky-report\",\n *(session.posargs or (\"test/\",)),\n env={\"PYTHONWARNINGS\": \"always::DeprecationWarning\"},\n )\n\n\[email protected](python=[\"3.7\", \"3.8\", \"3.9\", \"3.10\", \"3.11\", \"pypy\"])\ndef test(session: nox.Session) -> None:\n tests_impl(session)\n\n\[email protected](python=[\"2.7\"])\ndef unsupported_setup_py(session: nox.Session) -> None:\n # Can't check both returncode and output with session.run\n process = subprocess.run(\n [\"python\", \"setup.py\", \"install\"],\n env={**session.env},\n text=True,\n capture_output=True,\n )\n assert process.returncode == 1\n print(process.stderr)\n assert \"Please use `python -m pip install .` instead.\" in process.stderr\n\n\[email protected](python=[\"3\"])\ndef test_brotlipy(session: nox.Session) -> None:\n \"\"\"Check that if 'brotlipy' is installed instead of 'brotli' or\n 'brotlicffi' that we still don't blow up.\n \"\"\"\n session.install(\"brotlipy\")\n tests_impl(session, extras=\"socks,secure\", byte_string_comparisons=False)\n\n\ndef git_clone(session: nox.Session, git_url: str) -> None:\n session.run(\"git\", \"clone\", \"--depth\", \"1\", git_url, external=True)\n\n\[email protected]()\ndef downstream_botocore(session: nox.Session) -> None:\n root = os.getcwd()\n tmp_dir = session.create_tmp()\n\n session.cd(tmp_dir)\n git_clone(session, \"https://github.com/boto/botocore\")\n session.chdir(\"botocore\")\n for patch in [\n \"0001-Mark-100-Continue-tests-as-failing.patch\",\n \"0002-Stop-relying-on-removed-DEFAULT_CIPHERS.patch\",\n ]:\n session.run(\"git\", \"apply\", f\"{root}/ci/{patch}\", external=True)\n session.run(\"git\", \"rev-parse\", \"HEAD\", external=True)\n session.run(\"python\", \"scripts/ci/install\")\n\n session.cd(root)\n session.install(\".\", silent=False)\n session.cd(f\"{tmp_dir}/botocore\")\n\n session.run(\"python\", \"-c\", \"import urllib3; print(urllib3.__version__)\")\n session.run(\"python\", \"scripts/ci/run-tests\")\n\n\[email protected]()\ndef downstream_requests(session: nox.Session) -> None:\n root = os.getcwd()\n tmp_dir = session.create_tmp()\n\n session.cd(tmp_dir)\n git_clone(session, \"https://github.com/psf/requests\")\n session.chdir(\"requests\")\n session.run(\n \"git\", \"apply\", f\"{root}/ci/0003-requests-removed-warnings.patch\", external=True\n )\n session.run(\n \"git\", \"apply\", f\"{root}/ci/0004-requests-chunked-requests.patch\", external=True\n )\n session.run(\"git\", \"rev-parse\", \"HEAD\", external=True)\n session.install(\".[socks]\", silent=False)\n session.install(\"-r\", \"requirements-dev.txt\", silent=False)\n\n session.cd(root)\n session.install(\".\", silent=False)\n session.cd(f\"{tmp_dir}/requests\")\n\n session.run(\"python\", \"-c\", \"import urllib3; print(urllib3.__version__)\")\n session.run(\"pytest\", \"tests\")\n\n\[email protected]()\ndef format(session: nox.Session) -> None:\n \"\"\"Run code formatters.\"\"\"\n lint(session)\n\n\[email protected]\ndef lint(session: nox.Session) -> None:\n session.install(\"pre-commit\")\n session.run(\"pre-commit\", \"run\", \"--all-files\")\n\n mypy(session)\n\n\[email protected](python=\"3.8\")\ndef mypy(session: nox.Session) -> None:\n \"\"\"Run mypy.\"\"\"\n session.install(\"-r\", \"mypy-requirements.txt\")\n session.run(\"mypy\", \"--version\")\n session.run(\n \"mypy\",\n \"dummyserver\",\n \"noxfile.py\",\n \"src/urllib3\",\n \"test\",\n )\n\n\[email protected]\ndef docs(session: nox.Session) -> None:\n session.install(\"-r\", \"docs/requirements.txt\")\n session.install(\".[socks,secure,brotli,zstd]\")\n\n session.chdir(\"docs\")\n if os.path.exists(\"_build\"):\n shutil.rmtree(\"_build\")\n session.run(\"sphinx-build\", \"-b\", \"html\", \"-W\", \".\", \"_build/html\")\n", "path": "noxfile.py"}], "after_files": [{"content": "import os\nimport shutil\nimport subprocess\nimport sys\n\nimport nox\n\nSOURCE_FILES = [\n \"docs/\",\n \"dummyserver/\",\n \"src/\",\n \"test/\",\n \"noxfile.py\",\n \"setup.py\",\n]\n\n\ndef tests_impl(\n session: nox.Session,\n extras: str = \"socks,secure,brotli,zstd\",\n byte_string_comparisons: bool = True,\n) -> None:\n # Install deps and the package itself.\n session.install(\"-r\", \"dev-requirements.txt\")\n session.install(f\".[{extras}]\")\n\n # Show the pip version.\n session.run(\"pip\", \"--version\")\n # Print the Python version and bytesize.\n session.run(\"python\", \"--version\")\n session.run(\"python\", \"-c\", \"import struct; print(struct.calcsize('P') * 8)\")\n # Print OpenSSL information.\n session.run(\"python\", \"-m\", \"OpenSSL.debug\")\n\n memray_supported = True\n if sys.implementation.name != \"cpython\" or sys.version_info < (3, 8):\n memray_supported = False # pytest-memray requires CPython 3.8+\n elif sys.platform == \"win32\":\n memray_supported = False\n\n # Inspired from https://hynek.me/articles/ditch-codecov-python/\n # We use parallel mode and then combine in a later CI step\n session.run(\n \"python\",\n *((\"-bb\",) if byte_string_comparisons else ()),\n \"-m\",\n \"coverage\",\n \"run\",\n \"--parallel-mode\",\n \"-m\",\n \"pytest\",\n *(\"--memray\", \"--hide-memray-summary\") if memray_supported else (),\n \"-v\",\n \"-ra\",\n f\"--color={'yes' if 'GITHUB_ACTIONS' in os.environ else 'auto'}\",\n \"--tb=native\",\n \"--no-success-flaky-report\",\n *(session.posargs or (\"test/\",)),\n env={\"PYTHONWARNINGS\": \"always::DeprecationWarning\"},\n )\n\n\[email protected](python=[\"3.7\", \"3.8\", \"3.9\", \"3.10\", \"3.11\", \"pypy\"])\ndef test(session: nox.Session) -> None:\n tests_impl(session)\n\n\[email protected](python=[\"2.7\"])\ndef unsupported_setup_py(session: nox.Session) -> None:\n # Can't check both returncode and output with session.run\n process = subprocess.run(\n [\"python\", \"setup.py\", \"install\"],\n env={**session.env},\n text=True,\n capture_output=True,\n )\n assert process.returncode == 1\n print(process.stderr)\n assert \"Please use `python -m pip install .` instead.\" in process.stderr\n\n\[email protected](python=[\"3\"])\ndef test_brotlipy(session: nox.Session) -> None:\n \"\"\"Check that if 'brotlipy' is installed instead of 'brotli' or\n 'brotlicffi' that we still don't blow up.\n \"\"\"\n session.install(\"brotlipy\")\n tests_impl(session, extras=\"socks,secure\", byte_string_comparisons=False)\n\n\ndef git_clone(session: nox.Session, git_url: str) -> None:\n \"\"\"We either clone the target repository or if already exist\n simply reset the state and pull.\n \"\"\"\n expected_directory = git_url.split(\"/\")[-1]\n\n if expected_directory.endswith(\".git\"):\n expected_directory = expected_directory[:-4]\n\n if not os.path.isdir(expected_directory):\n session.run(\"git\", \"clone\", \"--depth\", \"1\", git_url, external=True)\n else:\n session.run(\n \"git\", \"-C\", expected_directory, \"reset\", \"--hard\", \"HEAD\", external=True\n )\n session.run(\"git\", \"-C\", expected_directory, \"pull\", external=True)\n\n\[email protected]()\ndef downstream_botocore(session: nox.Session) -> None:\n root = os.getcwd()\n tmp_dir = session.create_tmp()\n\n session.cd(tmp_dir)\n git_clone(session, \"https://github.com/boto/botocore\")\n session.chdir(\"botocore\")\n for patch in [\n \"0001-Mark-100-Continue-tests-as-failing.patch\",\n \"0002-Stop-relying-on-removed-DEFAULT_CIPHERS.patch\",\n ]:\n session.run(\"git\", \"apply\", f\"{root}/ci/{patch}\", external=True)\n session.run(\"git\", \"rev-parse\", \"HEAD\", external=True)\n session.run(\"python\", \"scripts/ci/install\")\n\n session.cd(root)\n session.install(\".\", silent=False)\n session.cd(f\"{tmp_dir}/botocore\")\n\n session.run(\"python\", \"-c\", \"import urllib3; print(urllib3.__version__)\")\n session.run(\"python\", \"scripts/ci/run-tests\")\n\n\[email protected]()\ndef downstream_requests(session: nox.Session) -> None:\n root = os.getcwd()\n tmp_dir = session.create_tmp()\n\n session.cd(tmp_dir)\n git_clone(session, \"https://github.com/psf/requests\")\n session.chdir(\"requests\")\n session.run(\n \"git\", \"apply\", f\"{root}/ci/0003-requests-removed-warnings.patch\", external=True\n )\n session.run(\n \"git\", \"apply\", f\"{root}/ci/0004-requests-chunked-requests.patch\", external=True\n )\n session.run(\"git\", \"rev-parse\", \"HEAD\", external=True)\n session.install(\".[socks]\", silent=False)\n session.install(\"-r\", \"requirements-dev.txt\", silent=False)\n\n session.cd(root)\n session.install(\".\", silent=False)\n session.cd(f\"{tmp_dir}/requests\")\n\n session.run(\"python\", \"-c\", \"import urllib3; print(urllib3.__version__)\")\n session.run(\"pytest\", \"tests\")\n\n\[email protected]()\ndef format(session: nox.Session) -> None:\n \"\"\"Run code formatters.\"\"\"\n lint(session)\n\n\[email protected]\ndef lint(session: nox.Session) -> None:\n session.install(\"pre-commit\")\n session.run(\"pre-commit\", \"run\", \"--all-files\")\n\n mypy(session)\n\n\[email protected](python=\"3.8\")\ndef mypy(session: nox.Session) -> None:\n \"\"\"Run mypy.\"\"\"\n session.install(\"-r\", \"mypy-requirements.txt\")\n session.run(\"mypy\", \"--version\")\n session.run(\n \"mypy\",\n \"dummyserver\",\n \"noxfile.py\",\n \"src/urllib3\",\n \"test\",\n )\n\n\[email protected]\ndef docs(session: nox.Session) -> None:\n session.install(\"-r\", \"docs/requirements.txt\")\n session.install(\".[socks,secure,brotli,zstd]\")\n\n session.chdir(\"docs\")\n if os.path.exists(\"_build\"):\n shutil.rmtree(\"_build\")\n session.run(\"sphinx-build\", \"-b\", \"html\", \"-W\", \".\", \"_build/html\")\n", "path": "noxfile.py"}]}
| 2,237 | 231 |
gh_patches_debug_21811
|
rasdani/github-patches
|
git_diff
|
bridgecrewio__checkov-1132
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
CKV_AWS_134: Skip Memcache engine
**Describe the bug**
"snapshot_retention_limit" - parameter only for "Redis" engine and in my TF module for Memcache it doesn't exist. But when I run "checkov" I got the following:
```
Check: CKV_AWS_134: "Ensure that Amazon ElastiCache Redis clusters have automatic backup turned on"
FAILED for resource: aws_elasticache_cluster.memcached
File: /tf.json:0-0
Guide: https://docs.bridgecrew.io/docs/ensure-that-amazon-elasticache-redis-clusters-have-automatic-backup-turned-on
```
**Terraform module**
```
### ElastiCache Memcached CLuster
resource "aws_elasticache_cluster" "memcached" {
cluster_id = lower("${var.basename}-Memcached-Cluster")
engine = var.engine
engine_version = var.engine_version
port = var.port
parameter_group_name = module.common.parameter_group_name
node_type = var.node_type
num_cache_nodes = var.num_cache_nodes
az_mode = var.az_mode
subnet_group_name = module.common.subnet_group_name
security_group_ids = [module.common.sg_id]
apply_immediately = true
tags = var.tags
}
```
**memcache.tf**
```
### ElastiCache: Memcashed Cluster
module "elasticache-memcached" {
source = "../../modules/elasticache/memcached"
basename = local.basename
vpc_id = module.vpc.id
subnets = module.private-subnets.ids
engine_version = "1.6.6"
parameter_group_family = "memcached1.6"
node_type = "cache.t3.small"
num_cache_nodes = 2
# Enable az_mode, when num_cache_nodes > 1
az_mode = "cross-az"
cidr_groups = { ALL = "0.0.0.0/0" }
tags = local.base_tags
}
```
**Expected behavior**
If engine is "memcache" then check must be skipped.
**Desktop:**
- OS: macOS Big Sur - 11.2.1
- Checkov Version: 2.0.77
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `checkov/terraform/checks/resource/aws/ElasticCacheAutomaticBackup.py`
Content:
```
1 from checkov.common.models.enums import CheckCategories, CheckResult
2 from checkov.terraform.checks.resource.base_resource_negative_value_check import BaseResourceNegativeValueCheck
3
4
5 class ElasticCacheAutomaticBackup(BaseResourceNegativeValueCheck):
6 def __init__(self):
7 name = "Ensure that Amazon ElastiCache Redis clusters have automatic backup turned on"
8 id = "CKV_AWS_134"
9 supported_resources = ['aws_elasticache_cluster']
10 categories = [CheckCategories.BACKUP_AND_RECOVERY]
11 super().__init__(name=name, id=id, categories=categories, supported_resources=supported_resources,
12 missing_attribute_result=CheckResult.FAILED)
13
14 def get_inspected_key(self):
15 return 'snapshot_retention_limit'
16
17 def get_forbidden_values(self):
18 return [0]
19
20
21 check = ElasticCacheAutomaticBackup()
22
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/checkov/terraform/checks/resource/aws/ElasticCacheAutomaticBackup.py b/checkov/terraform/checks/resource/aws/ElasticCacheAutomaticBackup.py
--- a/checkov/terraform/checks/resource/aws/ElasticCacheAutomaticBackup.py
+++ b/checkov/terraform/checks/resource/aws/ElasticCacheAutomaticBackup.py
@@ -6,13 +6,24 @@
def __init__(self):
name = "Ensure that Amazon ElastiCache Redis clusters have automatic backup turned on"
id = "CKV_AWS_134"
- supported_resources = ['aws_elasticache_cluster']
+ supported_resources = ["aws_elasticache_cluster"]
categories = [CheckCategories.BACKUP_AND_RECOVERY]
- super().__init__(name=name, id=id, categories=categories, supported_resources=supported_resources,
- missing_attribute_result=CheckResult.FAILED)
+ super().__init__(
+ name=name,
+ id=id,
+ categories=categories,
+ supported_resources=supported_resources,
+ missing_attribute_result=CheckResult.FAILED,
+ )
+
+ def scan_resource_conf(self, conf):
+ if conf.get("engine") == ["memcached"]:
+ return CheckResult.UNKNOWN
+
+ return super().scan_resource_conf(conf)
def get_inspected_key(self):
- return 'snapshot_retention_limit'
+ return "snapshot_retention_limit"
def get_forbidden_values(self):
return [0]
|
{"golden_diff": "diff --git a/checkov/terraform/checks/resource/aws/ElasticCacheAutomaticBackup.py b/checkov/terraform/checks/resource/aws/ElasticCacheAutomaticBackup.py\n--- a/checkov/terraform/checks/resource/aws/ElasticCacheAutomaticBackup.py\n+++ b/checkov/terraform/checks/resource/aws/ElasticCacheAutomaticBackup.py\n@@ -6,13 +6,24 @@\n def __init__(self):\n name = \"Ensure that Amazon ElastiCache Redis clusters have automatic backup turned on\"\n id = \"CKV_AWS_134\"\n- supported_resources = ['aws_elasticache_cluster']\n+ supported_resources = [\"aws_elasticache_cluster\"]\n categories = [CheckCategories.BACKUP_AND_RECOVERY]\n- super().__init__(name=name, id=id, categories=categories, supported_resources=supported_resources,\n- missing_attribute_result=CheckResult.FAILED)\n+ super().__init__(\n+ name=name,\n+ id=id,\n+ categories=categories,\n+ supported_resources=supported_resources,\n+ missing_attribute_result=CheckResult.FAILED,\n+ )\n+\n+ def scan_resource_conf(self, conf):\n+ if conf.get(\"engine\") == [\"memcached\"]:\n+ return CheckResult.UNKNOWN\n+\n+ return super().scan_resource_conf(conf)\n \n def get_inspected_key(self):\n- return 'snapshot_retention_limit'\n+ return \"snapshot_retention_limit\"\n \n def get_forbidden_values(self):\n return [0]\n", "issue": "CKV_AWS_134: Skip Memcache engine\n**Describe the bug**\r\n\"snapshot_retention_limit\" - parameter only for \"Redis\" engine and in my TF module for Memcache it doesn't exist. But when I run \"checkov\" I got the following:\r\n\r\n```\r\nCheck: CKV_AWS_134: \"Ensure that Amazon ElastiCache Redis clusters have automatic backup turned on\"\r\n\tFAILED for resource: aws_elasticache_cluster.memcached\r\n\tFile: /tf.json:0-0\r\n\tGuide: https://docs.bridgecrew.io/docs/ensure-that-amazon-elasticache-redis-clusters-have-automatic-backup-turned-on\r\n```\r\n\r\n**Terraform module**\r\n```\r\n### ElastiCache Memcached CLuster\r\nresource \"aws_elasticache_cluster\" \"memcached\" {\r\n cluster_id = lower(\"${var.basename}-Memcached-Cluster\")\r\n\r\n engine = var.engine\r\n engine_version = var.engine_version\r\n port = var.port\r\n parameter_group_name = module.common.parameter_group_name\r\n\r\n node_type = var.node_type\r\n num_cache_nodes = var.num_cache_nodes\r\n az_mode = var.az_mode\r\n\r\n subnet_group_name = module.common.subnet_group_name\r\n security_group_ids = [module.common.sg_id]\r\n\r\n apply_immediately = true\r\n\r\n tags = var.tags\r\n}\r\n```\r\n\r\n**memcache.tf**\r\n```\r\n### ElastiCache: Memcashed Cluster\r\nmodule \"elasticache-memcached\" {\r\n source = \"../../modules/elasticache/memcached\"\r\n\r\n basename = local.basename\r\n vpc_id = module.vpc.id\r\n subnets = module.private-subnets.ids\r\n\r\n engine_version = \"1.6.6\"\r\n parameter_group_family = \"memcached1.6\"\r\n node_type = \"cache.t3.small\"\r\n num_cache_nodes = 2\r\n\r\n # Enable az_mode, when num_cache_nodes > 1\r\n az_mode = \"cross-az\"\r\n\r\n cidr_groups = { ALL = \"0.0.0.0/0\" }\r\n\r\n tags = local.base_tags\r\n}\r\n```\r\n\r\n**Expected behavior**\r\nIf engine is \"memcache\" then check must be skipped.\r\n\r\n**Desktop:**\r\n - OS: macOS Big Sur - 11.2.1\r\n - Checkov Version: 2.0.77\r\n\n", "before_files": [{"content": "from checkov.common.models.enums import CheckCategories, CheckResult\nfrom checkov.terraform.checks.resource.base_resource_negative_value_check import BaseResourceNegativeValueCheck\n\n\nclass ElasticCacheAutomaticBackup(BaseResourceNegativeValueCheck):\n def __init__(self):\n name = \"Ensure that Amazon ElastiCache Redis clusters have automatic backup turned on\"\n id = \"CKV_AWS_134\"\n supported_resources = ['aws_elasticache_cluster']\n categories = [CheckCategories.BACKUP_AND_RECOVERY]\n super().__init__(name=name, id=id, categories=categories, supported_resources=supported_resources,\n missing_attribute_result=CheckResult.FAILED)\n\n def get_inspected_key(self):\n return 'snapshot_retention_limit'\n\n def get_forbidden_values(self):\n return [0]\n\n\ncheck = ElasticCacheAutomaticBackup()\n", "path": "checkov/terraform/checks/resource/aws/ElasticCacheAutomaticBackup.py"}], "after_files": [{"content": "from checkov.common.models.enums import CheckCategories, CheckResult\nfrom checkov.terraform.checks.resource.base_resource_negative_value_check import BaseResourceNegativeValueCheck\n\n\nclass ElasticCacheAutomaticBackup(BaseResourceNegativeValueCheck):\n def __init__(self):\n name = \"Ensure that Amazon ElastiCache Redis clusters have automatic backup turned on\"\n id = \"CKV_AWS_134\"\n supported_resources = [\"aws_elasticache_cluster\"]\n categories = [CheckCategories.BACKUP_AND_RECOVERY]\n super().__init__(\n name=name,\n id=id,\n categories=categories,\n supported_resources=supported_resources,\n missing_attribute_result=CheckResult.FAILED,\n )\n\n def scan_resource_conf(self, conf):\n if conf.get(\"engine\") == [\"memcached\"]:\n return CheckResult.UNKNOWN\n\n return super().scan_resource_conf(conf)\n\n def get_inspected_key(self):\n return \"snapshot_retention_limit\"\n\n def get_forbidden_values(self):\n return [0]\n\n\ncheck = ElasticCacheAutomaticBackup()\n", "path": "checkov/terraform/checks/resource/aws/ElasticCacheAutomaticBackup.py"}]}
| 983 | 316 |
gh_patches_debug_26450
|
rasdani/github-patches
|
git_diff
|
hylang__hy-2129
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Remove internal `importlib` frames from traceback
Python 3.x uses `_call_with_frames_removed` to remove internal frames from tracebacks. I tried it in #1687, but couldn't get it to work; might be due to this [Python issue](https://bugs.python.org/issue23773).
Regardless, it would be good to remove those frames somehow.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `hy/errors.py`
Content:
```
1 import os
2 import re
3 import sys
4 import traceback
5 import pkgutil
6
7 from functools import reduce
8 from colorama import Fore
9 from contextlib import contextmanager
10 from hy import _initialize_env_var
11
12 _hy_filter_internal_errors = _initialize_env_var('HY_FILTER_INTERNAL_ERRORS',
13 True)
14 COLORED = _initialize_env_var('HY_COLORED_ERRORS', False)
15
16
17 class HyError(Exception):
18 pass
19
20
21 class HyInternalError(HyError):
22 """Unexpected errors occurring during compilation or parsing of Hy code.
23
24 Errors sub-classing this are not intended to be user-facing, and will,
25 hopefully, never be seen by users!
26 """
27
28
29 class HyLanguageError(HyError):
30 """Errors caused by invalid use of the Hy language.
31
32 This, and any errors inheriting from this, are user-facing.
33 """
34
35 def __init__(self, message, expression=None, filename=None, source=None,
36 lineno=1, colno=1):
37 """
38 Parameters
39 ----------
40 message: str
41 The message to display for this error.
42 expression: HyObject, optional
43 The Hy expression generating this error.
44 filename: str, optional
45 The filename for the source code generating this error.
46 Expression-provided information will take precedence of this value.
47 source: str, optional
48 The actual source code generating this error. Expression-provided
49 information will take precedence of this value.
50 lineno: int, optional
51 The line number of the error. Expression-provided information will
52 take precedence of this value.
53 colno: int, optional
54 The column number of the error. Expression-provided information
55 will take precedence of this value.
56 """
57 self.msg = message
58 self.compute_lineinfo(expression, filename, source, lineno, colno)
59
60 if isinstance(self, SyntaxError):
61 syntax_error_args = (self.filename, self.lineno, self.offset,
62 self.text)
63 super(HyLanguageError, self).__init__(message, syntax_error_args)
64 else:
65 super(HyLanguageError, self).__init__(message)
66
67 def compute_lineinfo(self, expression, filename, source, lineno, colno):
68
69 # NOTE: We use `SyntaxError`'s field names (i.e. `text`, `offset`,
70 # `msg`) for compatibility and print-outs.
71 self.text = getattr(expression, 'source', source)
72 self.filename = getattr(expression, 'filename', filename)
73
74 if self.text:
75 lines = self.text.splitlines()
76
77 self.lineno = getattr(expression, 'start_line', lineno)
78 self.offset = getattr(expression, 'start_column', colno)
79 end_column = getattr(expression, 'end_column',
80 len(lines[self.lineno-1]))
81 end_line = getattr(expression, 'end_line', self.lineno)
82
83 # Trim the source down to the essentials.
84 self.text = '\n'.join(lines[self.lineno-1:end_line])
85
86 if end_column:
87 if self.lineno == end_line:
88 self.arrow_offset = end_column
89 else:
90 self.arrow_offset = len(self.text[0])
91
92 self.arrow_offset -= self.offset
93 else:
94 self.arrow_offset = None
95 else:
96 # We could attempt to extract the source given a filename, but we
97 # don't.
98 self.lineno = lineno
99 self.offset = colno
100 self.arrow_offset = None
101
102 def __str__(self):
103 """Provide an exception message that includes SyntaxError-like source
104 line information when available.
105 """
106 # Syntax errors are special and annotate the traceback (instead of what
107 # we would do in the message that follows the traceback).
108 if isinstance(self, SyntaxError):
109 return super(HyLanguageError, self).__str__()
110 # When there isn't extra source information, use the normal message.
111 elif not self.text:
112 return super(HyLanguageError, self).__str__()
113
114 # Re-purpose Python's builtin syntax error formatting.
115 output = traceback.format_exception_only(
116 SyntaxError,
117 SyntaxError(self.msg, (self.filename, self.lineno, self.offset,
118 self.text)))
119
120 arrow_idx, _ = next(((i, x) for i, x in enumerate(output)
121 if x.strip() == '^'),
122 (None, None))
123 if arrow_idx:
124 msg_idx = arrow_idx + 1
125 else:
126 msg_idx, _ = next((i, x) for i, x in enumerate(output)
127 if x.startswith('SyntaxError: '))
128
129 # Get rid of erroneous error-type label.
130 output[msg_idx] = re.sub('^SyntaxError: ', '', output[msg_idx])
131
132 # Extend the text arrow, when given enough source info.
133 if arrow_idx and self.arrow_offset:
134 output[arrow_idx] = '{}{}^\n'.format(output[arrow_idx].rstrip('\n'),
135 '-' * (self.arrow_offset - 1))
136
137 if COLORED:
138 output[msg_idx:] = [Fore.YELLOW + o + Fore.RESET for o in output[msg_idx:]]
139 if arrow_idx:
140 output[arrow_idx] = Fore.GREEN + output[arrow_idx] + Fore.RESET
141 for idx, line in enumerate(output[::msg_idx]):
142 if line.strip().startswith(
143 'File "{}", line'.format(self.filename)):
144 output[idx] = Fore.RED + line + Fore.RESET
145
146 # This resulting string will come after a "<class-name>:" prompt, so
147 # put it down a line.
148 output.insert(0, '\n')
149
150 # Avoid "...expected str instance, ColoredString found"
151 return reduce(lambda x, y: x + y, output)
152
153
154 class HyCompileError(HyInternalError):
155 """Unexpected errors occurring within the compiler."""
156
157
158 class HyTypeError(HyLanguageError, TypeError):
159 """TypeError occurring during the normal use of Hy."""
160
161
162 class HyNameError(HyLanguageError, NameError):
163 """NameError occurring during the normal use of Hy."""
164
165
166 class HyRequireError(HyLanguageError):
167 """Errors arising during the use of `require`
168
169 This, and any errors inheriting from this, are user-facing.
170 """
171
172
173 class HyMacroExpansionError(HyLanguageError):
174 """Errors caused by invalid use of Hy macros.
175
176 This, and any errors inheriting from this, are user-facing.
177 """
178
179
180 class HyEvalError(HyLanguageError):
181 """Errors occurring during code evaluation at compile-time.
182
183 These errors distinguish unexpected errors within the compilation process
184 (i.e. `HyInternalError`s) from unrelated errors in user code evaluated by
185 the compiler (e.g. in `eval-and-compile`).
186
187 This, and any errors inheriting from this, are user-facing.
188 """
189
190
191 class HyIOError(HyInternalError, IOError):
192 """ Subclass used to distinguish between IOErrors raised by Hy itself as
193 opposed to Hy programs.
194 """
195
196
197 class HySyntaxError(HyLanguageError, SyntaxError):
198 """Error during the Lexing of a Hython expression."""
199
200
201 class HyWrapperError(HyError, TypeError):
202 """Errors caused by language model object wrapping.
203
204 These can be caused by improper user-level use of a macro, so they're
205 not really "internal". If they arise due to anything else, they're an
206 internal/compiler problem, though.
207 """
208
209
210 def _module_filter_name(module_name):
211 try:
212 compiler_loader = pkgutil.get_loader(module_name)
213 if not compiler_loader:
214 return None
215
216 filename = compiler_loader.get_filename(module_name)
217 if not filename:
218 return None
219
220 if compiler_loader.is_package(module_name):
221 # Use the package directory (e.g. instead of `.../__init__.py`) so
222 # that we can filter all modules in a package.
223 return os.path.dirname(filename)
224 else:
225 # Normalize filename endings, because tracebacks will use `pyc` when
226 # the loader says `py`.
227 return filename.replace('.pyc', '.py')
228 except Exception:
229 return None
230
231
232 _tb_hidden_modules = {m for m in map(_module_filter_name,
233 ['hy.compiler', 'hy.lex',
234 'hy.cmdline', 'hy.lex.parser',
235 'hy.importer', 'hy._compat',
236 'hy.macros', 'hy.models',
237 'hy.core.result_macros',
238 'rply'])
239 if m is not None}
240
241
242 def hy_exc_filter(exc_type, exc_value, exc_traceback):
243 """Produce exceptions print-outs with all frames originating from the
244 modules in `_tb_hidden_modules` filtered out.
245
246 The frames are actually filtered by each module's filename and only when a
247 subclass of `HyLanguageError` is emitted.
248
249 This does not remove the frames from the actual tracebacks, so debugging
250 will show everything.
251 """
252 # frame = (filename, line number, function name*, text)
253 new_tb = []
254 for frame in traceback.extract_tb(exc_traceback):
255 if not (frame[0].replace('.pyc', '.py') in _tb_hidden_modules or
256 os.path.dirname(frame[0]) in _tb_hidden_modules):
257 new_tb += [frame]
258
259 lines = traceback.format_list(new_tb)
260
261 lines.insert(0, "Traceback (most recent call last):\n")
262
263 lines.extend(traceback.format_exception_only(exc_type, exc_value))
264 output = ''.join(lines)
265
266 return output
267
268
269 def hy_exc_handler(exc_type, exc_value, exc_traceback):
270 """A `sys.excepthook` handler that uses `hy_exc_filter` to
271 remove internal Hy frames from a traceback print-out.
272 """
273 if os.environ.get('HY_DEBUG', False):
274 return sys.__excepthook__(exc_type, exc_value, exc_traceback)
275
276 try:
277 output = hy_exc_filter(exc_type, exc_value, exc_traceback)
278 sys.stderr.write(output)
279 sys.stderr.flush()
280 except Exception:
281 sys.__excepthook__(exc_type, exc_value, exc_traceback)
282
283
284 @contextmanager
285 def filtered_hy_exceptions():
286 """Temporarily apply a `sys.excepthook` that filters Hy internal frames
287 from tracebacks.
288
289 Filtering can be controlled by the variable
290 `hy.errors._hy_filter_internal_errors` and environment variable
291 `HY_FILTER_INTERNAL_ERRORS`.
292 """
293 global _hy_filter_internal_errors
294 if _hy_filter_internal_errors:
295 current_hook = sys.excepthook
296 sys.excepthook = hy_exc_handler
297 yield
298 sys.excepthook = current_hook
299 else:
300 yield
301
```
Path: `hy/_compat.py`
Content:
```
1 import sys
2
3 PY3_7 = sys.version_info >= (3, 7)
4 PY3_8 = sys.version_info >= (3, 8)
5 PY3_9 = sys.version_info >= (3, 9)
6 PY3_10 = sys.version_info >= (3, 10)
7
8
9 if not PY3_9:
10 # Shim `ast.unparse`.
11 import ast, astor.code_gen
12 ast.unparse = astor.code_gen.to_source
13
14
15 if not PY3_7:
16 # Shim `asyncio.run`.
17 import asyncio
18 def f(coro):
19 return asyncio.get_event_loop().run_until_complete(coro)
20 asyncio.run = f
21
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/hy/_compat.py b/hy/_compat.py
--- a/hy/_compat.py
+++ b/hy/_compat.py
@@ -1,9 +1,11 @@
import sys
+import platform
PY3_7 = sys.version_info >= (3, 7)
PY3_8 = sys.version_info >= (3, 8)
PY3_9 = sys.version_info >= (3, 9)
PY3_10 = sys.version_info >= (3, 10)
+PYPY = platform.python_implementation() == "PyPy"
if not PY3_9:
diff --git a/hy/errors.py b/hy/errors.py
--- a/hy/errors.py
+++ b/hy/errors.py
@@ -8,6 +8,7 @@
from colorama import Fore
from contextlib import contextmanager
from hy import _initialize_env_var
+from hy._compat import PYPY
_hy_filter_internal_errors = _initialize_env_var('HY_FILTER_INTERNAL_ERRORS',
True)
@@ -238,6 +239,13 @@
'rply'])
if m is not None}
+# We can't derive these easily from just their module names due
+# to missing magic attributes in internal importlib modules
+_tb_hidden_modules.update(
+ f"<builtin>/frozen {x}" if PYPY else f"<frozen {x}>"
+ for x in ("importlib._bootstrap", "importlib._bootstrap_external")
+)
+
def hy_exc_filter(exc_type, exc_value, exc_traceback):
"""Produce exceptions print-outs with all frames originating from the
|
{"golden_diff": "diff --git a/hy/_compat.py b/hy/_compat.py\n--- a/hy/_compat.py\n+++ b/hy/_compat.py\n@@ -1,9 +1,11 @@\n import sys\n+import platform\n \n PY3_7 = sys.version_info >= (3, 7)\n PY3_8 = sys.version_info >= (3, 8)\n PY3_9 = sys.version_info >= (3, 9)\n PY3_10 = sys.version_info >= (3, 10)\n+PYPY = platform.python_implementation() == \"PyPy\"\n \n \n if not PY3_9:\ndiff --git a/hy/errors.py b/hy/errors.py\n--- a/hy/errors.py\n+++ b/hy/errors.py\n@@ -8,6 +8,7 @@\n from colorama import Fore\n from contextlib import contextmanager\n from hy import _initialize_env_var\n+from hy._compat import PYPY\n \n _hy_filter_internal_errors = _initialize_env_var('HY_FILTER_INTERNAL_ERRORS',\n True)\n@@ -238,6 +239,13 @@\n 'rply'])\n if m is not None}\n \n+# We can't derive these easily from just their module names due\n+# to missing magic attributes in internal importlib modules\n+_tb_hidden_modules.update(\n+ f\"<builtin>/frozen {x}\" if PYPY else f\"<frozen {x}>\"\n+ for x in (\"importlib._bootstrap\", \"importlib._bootstrap_external\")\n+)\n+\n \n def hy_exc_filter(exc_type, exc_value, exc_traceback):\n \"\"\"Produce exceptions print-outs with all frames originating from the\n", "issue": "Remove internal `importlib` frames from traceback\nPython 3.x uses `_call_with_frames_removed` to remove internal frames from tracebacks. I tried it in #1687, but couldn't get it to work; might be due to this [Python issue](https://bugs.python.org/issue23773). \r\nRegardless, it would be good to remove those frames somehow.\n", "before_files": [{"content": "import os\nimport re\nimport sys\nimport traceback\nimport pkgutil\n\nfrom functools import reduce\nfrom colorama import Fore\nfrom contextlib import contextmanager\nfrom hy import _initialize_env_var\n\n_hy_filter_internal_errors = _initialize_env_var('HY_FILTER_INTERNAL_ERRORS',\n True)\nCOLORED = _initialize_env_var('HY_COLORED_ERRORS', False)\n\n\nclass HyError(Exception):\n pass\n\n\nclass HyInternalError(HyError):\n \"\"\"Unexpected errors occurring during compilation or parsing of Hy code.\n\n Errors sub-classing this are not intended to be user-facing, and will,\n hopefully, never be seen by users!\n \"\"\"\n\n\nclass HyLanguageError(HyError):\n \"\"\"Errors caused by invalid use of the Hy language.\n\n This, and any errors inheriting from this, are user-facing.\n \"\"\"\n\n def __init__(self, message, expression=None, filename=None, source=None,\n lineno=1, colno=1):\n \"\"\"\n Parameters\n ----------\n message: str\n The message to display for this error.\n expression: HyObject, optional\n The Hy expression generating this error.\n filename: str, optional\n The filename for the source code generating this error.\n Expression-provided information will take precedence of this value.\n source: str, optional\n The actual source code generating this error. Expression-provided\n information will take precedence of this value.\n lineno: int, optional\n The line number of the error. Expression-provided information will\n take precedence of this value.\n colno: int, optional\n The column number of the error. Expression-provided information\n will take precedence of this value.\n \"\"\"\n self.msg = message\n self.compute_lineinfo(expression, filename, source, lineno, colno)\n\n if isinstance(self, SyntaxError):\n syntax_error_args = (self.filename, self.lineno, self.offset,\n self.text)\n super(HyLanguageError, self).__init__(message, syntax_error_args)\n else:\n super(HyLanguageError, self).__init__(message)\n\n def compute_lineinfo(self, expression, filename, source, lineno, colno):\n\n # NOTE: We use `SyntaxError`'s field names (i.e. `text`, `offset`,\n # `msg`) for compatibility and print-outs.\n self.text = getattr(expression, 'source', source)\n self.filename = getattr(expression, 'filename', filename)\n\n if self.text:\n lines = self.text.splitlines()\n\n self.lineno = getattr(expression, 'start_line', lineno)\n self.offset = getattr(expression, 'start_column', colno)\n end_column = getattr(expression, 'end_column',\n len(lines[self.lineno-1]))\n end_line = getattr(expression, 'end_line', self.lineno)\n\n # Trim the source down to the essentials.\n self.text = '\\n'.join(lines[self.lineno-1:end_line])\n\n if end_column:\n if self.lineno == end_line:\n self.arrow_offset = end_column\n else:\n self.arrow_offset = len(self.text[0])\n\n self.arrow_offset -= self.offset\n else:\n self.arrow_offset = None\n else:\n # We could attempt to extract the source given a filename, but we\n # don't.\n self.lineno = lineno\n self.offset = colno\n self.arrow_offset = None\n\n def __str__(self):\n \"\"\"Provide an exception message that includes SyntaxError-like source\n line information when available.\n \"\"\"\n # Syntax errors are special and annotate the traceback (instead of what\n # we would do in the message that follows the traceback).\n if isinstance(self, SyntaxError):\n return super(HyLanguageError, self).__str__()\n # When there isn't extra source information, use the normal message.\n elif not self.text:\n return super(HyLanguageError, self).__str__()\n\n # Re-purpose Python's builtin syntax error formatting.\n output = traceback.format_exception_only(\n SyntaxError,\n SyntaxError(self.msg, (self.filename, self.lineno, self.offset,\n self.text)))\n\n arrow_idx, _ = next(((i, x) for i, x in enumerate(output)\n if x.strip() == '^'),\n (None, None))\n if arrow_idx:\n msg_idx = arrow_idx + 1\n else:\n msg_idx, _ = next((i, x) for i, x in enumerate(output)\n if x.startswith('SyntaxError: '))\n\n # Get rid of erroneous error-type label.\n output[msg_idx] = re.sub('^SyntaxError: ', '', output[msg_idx])\n\n # Extend the text arrow, when given enough source info.\n if arrow_idx and self.arrow_offset:\n output[arrow_idx] = '{}{}^\\n'.format(output[arrow_idx].rstrip('\\n'),\n '-' * (self.arrow_offset - 1))\n\n if COLORED:\n output[msg_idx:] = [Fore.YELLOW + o + Fore.RESET for o in output[msg_idx:]]\n if arrow_idx:\n output[arrow_idx] = Fore.GREEN + output[arrow_idx] + Fore.RESET\n for idx, line in enumerate(output[::msg_idx]):\n if line.strip().startswith(\n 'File \"{}\", line'.format(self.filename)):\n output[idx] = Fore.RED + line + Fore.RESET\n\n # This resulting string will come after a \"<class-name>:\" prompt, so\n # put it down a line.\n output.insert(0, '\\n')\n\n # Avoid \"...expected str instance, ColoredString found\"\n return reduce(lambda x, y: x + y, output)\n\n\nclass HyCompileError(HyInternalError):\n \"\"\"Unexpected errors occurring within the compiler.\"\"\"\n\n\nclass HyTypeError(HyLanguageError, TypeError):\n \"\"\"TypeError occurring during the normal use of Hy.\"\"\"\n\n\nclass HyNameError(HyLanguageError, NameError):\n \"\"\"NameError occurring during the normal use of Hy.\"\"\"\n\n\nclass HyRequireError(HyLanguageError):\n \"\"\"Errors arising during the use of `require`\n\n This, and any errors inheriting from this, are user-facing.\n \"\"\"\n\n\nclass HyMacroExpansionError(HyLanguageError):\n \"\"\"Errors caused by invalid use of Hy macros.\n\n This, and any errors inheriting from this, are user-facing.\n \"\"\"\n\n\nclass HyEvalError(HyLanguageError):\n \"\"\"Errors occurring during code evaluation at compile-time.\n\n These errors distinguish unexpected errors within the compilation process\n (i.e. `HyInternalError`s) from unrelated errors in user code evaluated by\n the compiler (e.g. in `eval-and-compile`).\n\n This, and any errors inheriting from this, are user-facing.\n \"\"\"\n\n\nclass HyIOError(HyInternalError, IOError):\n \"\"\" Subclass used to distinguish between IOErrors raised by Hy itself as\n opposed to Hy programs.\n \"\"\"\n\n\nclass HySyntaxError(HyLanguageError, SyntaxError):\n \"\"\"Error during the Lexing of a Hython expression.\"\"\"\n\n\nclass HyWrapperError(HyError, TypeError):\n \"\"\"Errors caused by language model object wrapping.\n\n These can be caused by improper user-level use of a macro, so they're\n not really \"internal\". If they arise due to anything else, they're an\n internal/compiler problem, though.\n \"\"\"\n\n\ndef _module_filter_name(module_name):\n try:\n compiler_loader = pkgutil.get_loader(module_name)\n if not compiler_loader:\n return None\n\n filename = compiler_loader.get_filename(module_name)\n if not filename:\n return None\n\n if compiler_loader.is_package(module_name):\n # Use the package directory (e.g. instead of `.../__init__.py`) so\n # that we can filter all modules in a package.\n return os.path.dirname(filename)\n else:\n # Normalize filename endings, because tracebacks will use `pyc` when\n # the loader says `py`.\n return filename.replace('.pyc', '.py')\n except Exception:\n return None\n\n\n_tb_hidden_modules = {m for m in map(_module_filter_name,\n ['hy.compiler', 'hy.lex',\n 'hy.cmdline', 'hy.lex.parser',\n 'hy.importer', 'hy._compat',\n 'hy.macros', 'hy.models',\n 'hy.core.result_macros',\n 'rply'])\n if m is not None}\n\n\ndef hy_exc_filter(exc_type, exc_value, exc_traceback):\n \"\"\"Produce exceptions print-outs with all frames originating from the\n modules in `_tb_hidden_modules` filtered out.\n\n The frames are actually filtered by each module's filename and only when a\n subclass of `HyLanguageError` is emitted.\n\n This does not remove the frames from the actual tracebacks, so debugging\n will show everything.\n \"\"\"\n # frame = (filename, line number, function name*, text)\n new_tb = []\n for frame in traceback.extract_tb(exc_traceback):\n if not (frame[0].replace('.pyc', '.py') in _tb_hidden_modules or\n os.path.dirname(frame[0]) in _tb_hidden_modules):\n new_tb += [frame]\n\n lines = traceback.format_list(new_tb)\n\n lines.insert(0, \"Traceback (most recent call last):\\n\")\n\n lines.extend(traceback.format_exception_only(exc_type, exc_value))\n output = ''.join(lines)\n\n return output\n\n\ndef hy_exc_handler(exc_type, exc_value, exc_traceback):\n \"\"\"A `sys.excepthook` handler that uses `hy_exc_filter` to\n remove internal Hy frames from a traceback print-out.\n \"\"\"\n if os.environ.get('HY_DEBUG', False):\n return sys.__excepthook__(exc_type, exc_value, exc_traceback)\n\n try:\n output = hy_exc_filter(exc_type, exc_value, exc_traceback)\n sys.stderr.write(output)\n sys.stderr.flush()\n except Exception:\n sys.__excepthook__(exc_type, exc_value, exc_traceback)\n\n\n@contextmanager\ndef filtered_hy_exceptions():\n \"\"\"Temporarily apply a `sys.excepthook` that filters Hy internal frames\n from tracebacks.\n\n Filtering can be controlled by the variable\n `hy.errors._hy_filter_internal_errors` and environment variable\n `HY_FILTER_INTERNAL_ERRORS`.\n \"\"\"\n global _hy_filter_internal_errors\n if _hy_filter_internal_errors:\n current_hook = sys.excepthook\n sys.excepthook = hy_exc_handler\n yield\n sys.excepthook = current_hook\n else:\n yield\n", "path": "hy/errors.py"}, {"content": "import sys\n\nPY3_7 = sys.version_info >= (3, 7)\nPY3_8 = sys.version_info >= (3, 8)\nPY3_9 = sys.version_info >= (3, 9)\nPY3_10 = sys.version_info >= (3, 10)\n\n\nif not PY3_9:\n # Shim `ast.unparse`.\n import ast, astor.code_gen\n ast.unparse = astor.code_gen.to_source\n\n\nif not PY3_7:\n # Shim `asyncio.run`.\n import asyncio\n def f(coro):\n return asyncio.get_event_loop().run_until_complete(coro)\n asyncio.run = f\n", "path": "hy/_compat.py"}], "after_files": [{"content": "import os\nimport re\nimport sys\nimport traceback\nimport pkgutil\n\nfrom functools import reduce\nfrom colorama import Fore\nfrom contextlib import contextmanager\nfrom hy import _initialize_env_var\nfrom hy._compat import PYPY\n\n_hy_filter_internal_errors = _initialize_env_var('HY_FILTER_INTERNAL_ERRORS',\n True)\nCOLORED = _initialize_env_var('HY_COLORED_ERRORS', False)\n\n\nclass HyError(Exception):\n pass\n\n\nclass HyInternalError(HyError):\n \"\"\"Unexpected errors occurring during compilation or parsing of Hy code.\n\n Errors sub-classing this are not intended to be user-facing, and will,\n hopefully, never be seen by users!\n \"\"\"\n\n\nclass HyLanguageError(HyError):\n \"\"\"Errors caused by invalid use of the Hy language.\n\n This, and any errors inheriting from this, are user-facing.\n \"\"\"\n\n def __init__(self, message, expression=None, filename=None, source=None,\n lineno=1, colno=1):\n \"\"\"\n Parameters\n ----------\n message: str\n The message to display for this error.\n expression: HyObject, optional\n The Hy expression generating this error.\n filename: str, optional\n The filename for the source code generating this error.\n Expression-provided information will take precedence of this value.\n source: str, optional\n The actual source code generating this error. Expression-provided\n information will take precedence of this value.\n lineno: int, optional\n The line number of the error. Expression-provided information will\n take precedence of this value.\n colno: int, optional\n The column number of the error. Expression-provided information\n will take precedence of this value.\n \"\"\"\n self.msg = message\n self.compute_lineinfo(expression, filename, source, lineno, colno)\n\n if isinstance(self, SyntaxError):\n syntax_error_args = (self.filename, self.lineno, self.offset,\n self.text)\n super(HyLanguageError, self).__init__(message, syntax_error_args)\n else:\n super(HyLanguageError, self).__init__(message)\n\n def compute_lineinfo(self, expression, filename, source, lineno, colno):\n\n # NOTE: We use `SyntaxError`'s field names (i.e. `text`, `offset`,\n # `msg`) for compatibility and print-outs.\n self.text = getattr(expression, 'source', source)\n self.filename = getattr(expression, 'filename', filename)\n\n if self.text:\n lines = self.text.splitlines()\n\n self.lineno = getattr(expression, 'start_line', lineno)\n self.offset = getattr(expression, 'start_column', colno)\n end_column = getattr(expression, 'end_column',\n len(lines[self.lineno-1]))\n end_line = getattr(expression, 'end_line', self.lineno)\n\n # Trim the source down to the essentials.\n self.text = '\\n'.join(lines[self.lineno-1:end_line])\n\n if end_column:\n if self.lineno == end_line:\n self.arrow_offset = end_column\n else:\n self.arrow_offset = len(self.text[0])\n\n self.arrow_offset -= self.offset\n else:\n self.arrow_offset = None\n else:\n # We could attempt to extract the source given a filename, but we\n # don't.\n self.lineno = lineno\n self.offset = colno\n self.arrow_offset = None\n\n def __str__(self):\n \"\"\"Provide an exception message that includes SyntaxError-like source\n line information when available.\n \"\"\"\n # Syntax errors are special and annotate the traceback (instead of what\n # we would do in the message that follows the traceback).\n if isinstance(self, SyntaxError):\n return super(HyLanguageError, self).__str__()\n # When there isn't extra source information, use the normal message.\n elif not self.text:\n return super(HyLanguageError, self).__str__()\n\n # Re-purpose Python's builtin syntax error formatting.\n output = traceback.format_exception_only(\n SyntaxError,\n SyntaxError(self.msg, (self.filename, self.lineno, self.offset,\n self.text)))\n\n arrow_idx, _ = next(((i, x) for i, x in enumerate(output)\n if x.strip() == '^'),\n (None, None))\n if arrow_idx:\n msg_idx = arrow_idx + 1\n else:\n msg_idx, _ = next((i, x) for i, x in enumerate(output)\n if x.startswith('SyntaxError: '))\n\n # Get rid of erroneous error-type label.\n output[msg_idx] = re.sub('^SyntaxError: ', '', output[msg_idx])\n\n # Extend the text arrow, when given enough source info.\n if arrow_idx and self.arrow_offset:\n output[arrow_idx] = '{}{}^\\n'.format(output[arrow_idx].rstrip('\\n'),\n '-' * (self.arrow_offset - 1))\n\n if COLORED:\n output[msg_idx:] = [Fore.YELLOW + o + Fore.RESET for o in output[msg_idx:]]\n if arrow_idx:\n output[arrow_idx] = Fore.GREEN + output[arrow_idx] + Fore.RESET\n for idx, line in enumerate(output[::msg_idx]):\n if line.strip().startswith(\n 'File \"{}\", line'.format(self.filename)):\n output[idx] = Fore.RED + line + Fore.RESET\n\n # This resulting string will come after a \"<class-name>:\" prompt, so\n # put it down a line.\n output.insert(0, '\\n')\n\n # Avoid \"...expected str instance, ColoredString found\"\n return reduce(lambda x, y: x + y, output)\n\n\nclass HyCompileError(HyInternalError):\n \"\"\"Unexpected errors occurring within the compiler.\"\"\"\n\n\nclass HyTypeError(HyLanguageError, TypeError):\n \"\"\"TypeError occurring during the normal use of Hy.\"\"\"\n\n\nclass HyNameError(HyLanguageError, NameError):\n \"\"\"NameError occurring during the normal use of Hy.\"\"\"\n\n\nclass HyRequireError(HyLanguageError):\n \"\"\"Errors arising during the use of `require`\n\n This, and any errors inheriting from this, are user-facing.\n \"\"\"\n\n\nclass HyMacroExpansionError(HyLanguageError):\n \"\"\"Errors caused by invalid use of Hy macros.\n\n This, and any errors inheriting from this, are user-facing.\n \"\"\"\n\n\nclass HyEvalError(HyLanguageError):\n \"\"\"Errors occurring during code evaluation at compile-time.\n\n These errors distinguish unexpected errors within the compilation process\n (i.e. `HyInternalError`s) from unrelated errors in user code evaluated by\n the compiler (e.g. in `eval-and-compile`).\n\n This, and any errors inheriting from this, are user-facing.\n \"\"\"\n\n\nclass HyIOError(HyInternalError, IOError):\n \"\"\" Subclass used to distinguish between IOErrors raised by Hy itself as\n opposed to Hy programs.\n \"\"\"\n\n\nclass HySyntaxError(HyLanguageError, SyntaxError):\n \"\"\"Error during the Lexing of a Hython expression.\"\"\"\n\n\nclass HyWrapperError(HyError, TypeError):\n \"\"\"Errors caused by language model object wrapping.\n\n These can be caused by improper user-level use of a macro, so they're\n not really \"internal\". If they arise due to anything else, they're an\n internal/compiler problem, though.\n \"\"\"\n\n\ndef _module_filter_name(module_name):\n try:\n compiler_loader = pkgutil.get_loader(module_name)\n if not compiler_loader:\n return None\n\n filename = compiler_loader.get_filename(module_name)\n if not filename:\n return None\n\n if compiler_loader.is_package(module_name):\n # Use the package directory (e.g. instead of `.../__init__.py`) so\n # that we can filter all modules in a package.\n return os.path.dirname(filename)\n else:\n # Normalize filename endings, because tracebacks will use `pyc` when\n # the loader says `py`.\n return filename.replace('.pyc', '.py')\n except Exception:\n return None\n\n\n_tb_hidden_modules = {m for m in map(_module_filter_name,\n ['hy.compiler', 'hy.lex',\n 'hy.cmdline', 'hy.lex.parser',\n 'hy.importer', 'hy._compat',\n 'hy.macros', 'hy.models',\n 'hy.core.result_macros',\n 'rply'])\n if m is not None}\n\n# We can't derive these easily from just their module names due\n# to missing magic attributes in internal importlib modules\n_tb_hidden_modules.update(\n f\"<builtin>/frozen {x}\" if PYPY else f\"<frozen {x}>\"\n for x in (\"importlib._bootstrap\", \"importlib._bootstrap_external\")\n)\n\n\ndef hy_exc_filter(exc_type, exc_value, exc_traceback):\n \"\"\"Produce exceptions print-outs with all frames originating from the\n modules in `_tb_hidden_modules` filtered out.\n\n The frames are actually filtered by each module's filename and only when a\n subclass of `HyLanguageError` is emitted.\n\n This does not remove the frames from the actual tracebacks, so debugging\n will show everything.\n \"\"\"\n # frame = (filename, line number, function name*, text)\n new_tb = []\n for frame in traceback.extract_tb(exc_traceback):\n if not (frame[0].replace('.pyc', '.py') in _tb_hidden_modules or\n os.path.dirname(frame[0]) in _tb_hidden_modules):\n new_tb += [frame]\n\n lines = traceback.format_list(new_tb)\n\n lines.insert(0, \"Traceback (most recent call last):\\n\")\n\n lines.extend(traceback.format_exception_only(exc_type, exc_value))\n output = ''.join(lines)\n\n return output\n\n\ndef hy_exc_handler(exc_type, exc_value, exc_traceback):\n \"\"\"A `sys.excepthook` handler that uses `hy_exc_filter` to\n remove internal Hy frames from a traceback print-out.\n \"\"\"\n if os.environ.get('HY_DEBUG', False):\n return sys.__excepthook__(exc_type, exc_value, exc_traceback)\n\n try:\n output = hy_exc_filter(exc_type, exc_value, exc_traceback)\n sys.stderr.write(output)\n sys.stderr.flush()\n except Exception:\n sys.__excepthook__(exc_type, exc_value, exc_traceback)\n\n\n@contextmanager\ndef filtered_hy_exceptions():\n \"\"\"Temporarily apply a `sys.excepthook` that filters Hy internal frames\n from tracebacks.\n\n Filtering can be controlled by the variable\n `hy.errors._hy_filter_internal_errors` and environment variable\n `HY_FILTER_INTERNAL_ERRORS`.\n \"\"\"\n global _hy_filter_internal_errors\n if _hy_filter_internal_errors:\n current_hook = sys.excepthook\n sys.excepthook = hy_exc_handler\n yield\n sys.excepthook = current_hook\n else:\n yield\n", "path": "hy/errors.py"}, {"content": "import sys\nimport platform\n\nPY3_7 = sys.version_info >= (3, 7)\nPY3_8 = sys.version_info >= (3, 8)\nPY3_9 = sys.version_info >= (3, 9)\nPY3_10 = sys.version_info >= (3, 10)\nPYPY = platform.python_implementation() == \"PyPy\"\n\n\nif not PY3_9:\n # Shim `ast.unparse`.\n import ast, astor.code_gen\n ast.unparse = astor.code_gen.to_source\n\n\nif not PY3_7:\n # Shim `asyncio.run`.\n import asyncio\n def f(coro):\n return asyncio.get_event_loop().run_until_complete(coro)\n asyncio.run = f\n", "path": "hy/_compat.py"}]}
| 3,634 | 356 |
gh_patches_debug_18549
|
rasdani/github-patches
|
git_diff
|
catalyst-team__catalyst-1234
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
TracingCallback fails in ConfigAPI
## 🐛 Bug Report
<!-- A clear and concise description of what the bug is. -->
When running TracingCallback the run fails with an RuntimeError.
Apparently, inside the callback, there is a [transfer from any device to `cpu`](https://github.com/catalyst-team/catalyst/blob/a927bed68c1abcd3d28811d1d3d9d7b95e0861a1/catalyst/callbacks/tracing.py#L150) of batch which is used for tracing. And when the `runner.model` is on `cuda` it fails.
### How To Reproduce
Steps to reproduce the behavior:
1. Add
```
trace:
_target_: TracingCallback
input_key: *model_input
logdir: *logdir
```
to [mnist_stages config](https://github.com/catalyst-team/catalyst/blob/master/examples/mnist_stages/config.yml).
2. `sh mnist_stages/run_config.sh`
<!-- If you have a code sample, error messages, stack traces, please provide it here as well -->
### Expected behavior
<!-- A clear and concise description of what you expected to happen. -->
`RuntimeError: Input type (torch.FloatTensor) and weight type (torch.cuda.FloatTensor) should be the same`
### Environment
```bash
# example checklist, fill with your info
Catalyst version: 21.05
PyTorch version: 1.7.1
Is debug build: No
CUDA used to build PyTorch: 10.2
TensorFlow version: N/A
TensorBoard version: N/A
OS: Linux Mint 19.3 Tricia
GCC version: (Ubuntu 7.5.0-3ubuntu1~18.04) 7.5.0
CMake version: version 3.10.2
Python version: 3.8
Is CUDA available: Yes
CUDA runtime version: 9.1.85
GPU models and configuration:
GPU 0: GeForce RTX 2070 SUPER
GPU 1: Quadro P4000
Nvidia driver version: 460.32.03
cuDNN version: Could not collect
```
### Additional context
<!-- Add any other context about the problem here. -->
### Checklist
- [x] bug description
- [x] steps to reproduce
- [x] expected behavior
- [x] environment
- [ ] code sample / screenshots
### FAQ
Please review the FAQ before submitting an issue:
- [ ] I have read the [documentation and FAQ](https://catalyst-team.github.io/catalyst/)
- [ ] I have reviewed the [minimal examples section](https://github.com/catalyst-team/catalyst#minimal-examples)
- [ ] I have checked the [changelog](https://github.com/catalyst-team/catalyst/blob/master/CHANGELOG.md) for main framework updates
- [ ] I have read the [contribution guide](https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md)
- [ ] I have joined [Catalyst slack (#__questions channel)](https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw) for issue discussion
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `catalyst/callbacks/tracing.py`
Content:
```
1 from typing import List, TYPE_CHECKING, Union
2 from pathlib import Path
3
4 import torch
5
6 from catalyst.core import Callback, CallbackNode, CallbackOrder
7 from catalyst.utils.torch import any2device
8 from catalyst.utils.tracing import trace_model
9
10 if TYPE_CHECKING:
11 from catalyst.core import IRunner
12
13
14 class TracingCallback(Callback):
15 """
16 Callback for model tracing.
17
18 Args:
19 input_key: input key from ``runner.batch`` to use for model tracing
20 logdir: path to folder for saving
21 filename: filename
22 method_name: Model's method name that will be used as entrypoint during tracing
23
24 Example:
25
26 .. code-block:: python
27
28 import os
29
30 import torch
31 from torch import nn
32 from torch.utils.data import DataLoader
33
34 from catalyst import dl
35 from catalyst.data import ToTensor
36 from catalyst.contrib.datasets import MNIST
37 from catalyst.contrib.nn.modules import Flatten
38
39 loaders = {
40 "train": DataLoader(
41 MNIST(
42 os.getcwd(), train=False, download=True, transform=ToTensor()
43 ),
44 batch_size=32,
45 ),
46 "valid": DataLoader(
47 MNIST(
48 os.getcwd(), train=False, download=True, transform=ToTensor()
49 ),
50 batch_size=32,
51 ),
52 }
53
54 model = nn.Sequential(
55 Flatten(), nn.Linear(784, 512), nn.ReLU(), nn.Linear(512, 10)
56 )
57 criterion = nn.CrossEntropyLoss()
58 optimizer = torch.optim.Adam(model.parameters(), lr=1e-2)
59 runner = dl.SupervisedRunner()
60 runner.train(
61 model=model,
62 callbacks=[dl.TracingCallback(input_key="features", logdir="./logs")],
63 loaders=loaders,
64 criterion=criterion,
65 optimizer=optimizer,
66 num_epochs=1,
67 logdir="./logs",
68 )
69 """
70
71 def __init__(
72 self,
73 input_key: Union[str, List[str]],
74 logdir: Union[str, Path] = None,
75 filename: str = "traced_model.pth",
76 method_name: str = "forward",
77 ):
78 """
79 Callback for model tracing.
80
81 Args:
82 input_key: input key from ``runner.batch`` to use for model tracing
83 logdir: path to folder for saving
84 filename: filename
85 method_name: Model's method name that will be used as entrypoint during tracing
86
87 Example:
88 .. code-block:: python
89
90 import os
91
92 import torch
93 from torch import nn
94 from torch.utils.data import DataLoader
95
96 from catalyst import dl
97 from catalyst.data import ToTensor
98 from catalyst.contrib.datasets import MNIST
99 from catalyst.contrib.nn.modules import Flatten
100
101 loaders = {
102 "train": DataLoader(
103 MNIST(
104 os.getcwd(), train=False, download=True, transform=ToTensor()
105 ),
106 batch_size=32,
107 ),
108 "valid": DataLoader(
109 MNIST(
110 os.getcwd(), train=False, download=True, transform=ToTensor()
111 ),
112 batch_size=32,
113 ),
114 }
115
116 model = nn.Sequential(
117 Flatten(), nn.Linear(784, 512), nn.ReLU(), nn.Linear(512, 10)
118 )
119 criterion = nn.CrossEntropyLoss()
120 optimizer = torch.optim.Adam(model.parameters(), lr=1e-2)
121 runner = dl.SupervisedRunner()
122 runner.train(
123 model=model,
124 callbacks=[dl.TracingCallback(input_key="features", logdir="./logs")],
125 loaders=loaders,
126 criterion=criterion,
127 optimizer=optimizer,
128 num_epochs=1,
129 logdir="./logs",
130 )
131 """
132 super().__init__(order=CallbackOrder.ExternalExtra, node=CallbackNode.Master)
133 if logdir is not None:
134 self.filename = str(Path(logdir) / filename)
135 else:
136 self.filename = filename
137 self.method_name = method_name
138
139 self.input_key = [input_key] if isinstance(input_key, str) else input_key
140
141 def on_stage_end(self, runner: "IRunner") -> None:
142 """
143 On stage end action.
144
145 Args:
146 runner: runner for experiment
147 """
148 model = runner.model
149 batch = tuple(runner.batch[key] for key in self.input_key)
150 batch = any2device(batch, "cpu")
151 traced_model = trace_model(model=model, batch=batch, method_name=self.method_name)
152 torch.jit.save(traced_model, self.filename)
153
154
155 __all__ = ["TracingCallback"]
156
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/catalyst/callbacks/tracing.py b/catalyst/callbacks/tracing.py
--- a/catalyst/callbacks/tracing.py
+++ b/catalyst/callbacks/tracing.py
@@ -4,7 +4,6 @@
import torch
from catalyst.core import Callback, CallbackNode, CallbackOrder
-from catalyst.utils.torch import any2device
from catalyst.utils.tracing import trace_model
if TYPE_CHECKING:
@@ -145,9 +144,9 @@
Args:
runner: runner for experiment
"""
- model = runner.model
+ model = runner.engine.sync_device(runner.model)
batch = tuple(runner.batch[key] for key in self.input_key)
- batch = any2device(batch, "cpu")
+ batch = runner.engine.sync_device(batch)
traced_model = trace_model(model=model, batch=batch, method_name=self.method_name)
torch.jit.save(traced_model, self.filename)
|
{"golden_diff": "diff --git a/catalyst/callbacks/tracing.py b/catalyst/callbacks/tracing.py\n--- a/catalyst/callbacks/tracing.py\n+++ b/catalyst/callbacks/tracing.py\n@@ -4,7 +4,6 @@\n import torch\n \n from catalyst.core import Callback, CallbackNode, CallbackOrder\n-from catalyst.utils.torch import any2device\n from catalyst.utils.tracing import trace_model\n \n if TYPE_CHECKING:\n@@ -145,9 +144,9 @@\n Args:\n runner: runner for experiment\n \"\"\"\n- model = runner.model\n+ model = runner.engine.sync_device(runner.model)\n batch = tuple(runner.batch[key] for key in self.input_key)\n- batch = any2device(batch, \"cpu\")\n+ batch = runner.engine.sync_device(batch)\n traced_model = trace_model(model=model, batch=batch, method_name=self.method_name)\n torch.jit.save(traced_model, self.filename)\n", "issue": "TracingCallback fails in ConfigAPI\n## \ud83d\udc1b Bug Report\r\n<!-- A clear and concise description of what the bug is. -->\r\nWhen running TracingCallback the run fails with an RuntimeError.\r\n\r\nApparently, inside the callback, there is a [transfer from any device to `cpu`](https://github.com/catalyst-team/catalyst/blob/a927bed68c1abcd3d28811d1d3d9d7b95e0861a1/catalyst/callbacks/tracing.py#L150) of batch which is used for tracing. And when the `runner.model` is on `cuda` it fails.\r\n\r\n### How To Reproduce\r\nSteps to reproduce the behavior:\r\n1. Add \r\n```\r\n trace:\r\n _target_: TracingCallback\r\n input_key: *model_input\r\n logdir: *logdir\r\n```\r\nto [mnist_stages config](https://github.com/catalyst-team/catalyst/blob/master/examples/mnist_stages/config.yml).\r\n2. `sh mnist_stages/run_config.sh`\r\n\r\n<!-- If you have a code sample, error messages, stack traces, please provide it here as well --> \r\n\r\n### Expected behavior\r\n<!-- A clear and concise description of what you expected to happen. -->\r\n`RuntimeError: Input type (torch.FloatTensor) and weight type (torch.cuda.FloatTensor) should be the same`\r\n\r\n\r\n### Environment\r\n```bash\r\n# example checklist, fill with your info\r\nCatalyst version: 21.05\r\nPyTorch version: 1.7.1\r\nIs debug build: No\r\nCUDA used to build PyTorch: 10.2\r\nTensorFlow version: N/A\r\nTensorBoard version: N/A\r\n\r\nOS: Linux Mint 19.3 Tricia\r\nGCC version: (Ubuntu 7.5.0-3ubuntu1~18.04) 7.5.0\r\nCMake version: version 3.10.2\r\n\r\nPython version: 3.8\r\nIs CUDA available: Yes\r\nCUDA runtime version: 9.1.85\r\nGPU models and configuration:\r\nGPU 0: GeForce RTX 2070 SUPER\r\nGPU 1: Quadro P4000\r\n\r\nNvidia driver version: 460.32.03\r\ncuDNN version: Could not collect\r\n```\r\n\r\n\r\n### Additional context\r\n<!-- Add any other context about the problem here. -->\r\n\r\n\r\n### Checklist\r\n- [x] bug description\r\n- [x] steps to reproduce\r\n- [x] expected behavior\r\n- [x] environment\r\n- [ ] code sample / screenshots\r\n \r\n### FAQ\r\nPlease review the FAQ before submitting an issue:\r\n- [ ] I have read the [documentation and FAQ](https://catalyst-team.github.io/catalyst/)\r\n- [ ] I have reviewed the [minimal examples section](https://github.com/catalyst-team/catalyst#minimal-examples)\r\n- [ ] I have checked the [changelog](https://github.com/catalyst-team/catalyst/blob/master/CHANGELOG.md) for main framework updates\r\n- [ ] I have read the [contribution guide](https://github.com/catalyst-team/catalyst/blob/master/CONTRIBUTING.md)\r\n- [ ] I have joined [Catalyst slack (#__questions channel)](https://join.slack.com/t/catalyst-team-core/shared_invite/zt-d9miirnn-z86oKDzFMKlMG4fgFdZafw) for issue discussion\r\n\n", "before_files": [{"content": "from typing import List, TYPE_CHECKING, Union\nfrom pathlib import Path\n\nimport torch\n\nfrom catalyst.core import Callback, CallbackNode, CallbackOrder\nfrom catalyst.utils.torch import any2device\nfrom catalyst.utils.tracing import trace_model\n\nif TYPE_CHECKING:\n from catalyst.core import IRunner\n\n\nclass TracingCallback(Callback):\n \"\"\"\n Callback for model tracing.\n\n Args:\n input_key: input key from ``runner.batch`` to use for model tracing\n logdir: path to folder for saving\n filename: filename\n method_name: Model's method name that will be used as entrypoint during tracing\n\n Example:\n\n .. code-block:: python\n\n import os\n\n import torch\n from torch import nn\n from torch.utils.data import DataLoader\n\n from catalyst import dl\n from catalyst.data import ToTensor\n from catalyst.contrib.datasets import MNIST\n from catalyst.contrib.nn.modules import Flatten\n\n loaders = {\n \"train\": DataLoader(\n MNIST(\n os.getcwd(), train=False, download=True, transform=ToTensor()\n ),\n batch_size=32,\n ),\n \"valid\": DataLoader(\n MNIST(\n os.getcwd(), train=False, download=True, transform=ToTensor()\n ),\n batch_size=32,\n ),\n }\n\n model = nn.Sequential(\n Flatten(), nn.Linear(784, 512), nn.ReLU(), nn.Linear(512, 10)\n )\n criterion = nn.CrossEntropyLoss()\n optimizer = torch.optim.Adam(model.parameters(), lr=1e-2)\n runner = dl.SupervisedRunner()\n runner.train(\n model=model,\n callbacks=[dl.TracingCallback(input_key=\"features\", logdir=\"./logs\")],\n loaders=loaders,\n criterion=criterion,\n optimizer=optimizer,\n num_epochs=1,\n logdir=\"./logs\",\n )\n \"\"\"\n\n def __init__(\n self,\n input_key: Union[str, List[str]],\n logdir: Union[str, Path] = None,\n filename: str = \"traced_model.pth\",\n method_name: str = \"forward\",\n ):\n \"\"\"\n Callback for model tracing.\n\n Args:\n input_key: input key from ``runner.batch`` to use for model tracing\n logdir: path to folder for saving\n filename: filename\n method_name: Model's method name that will be used as entrypoint during tracing\n\n Example:\n .. code-block:: python\n\n import os\n\n import torch\n from torch import nn\n from torch.utils.data import DataLoader\n\n from catalyst import dl\n from catalyst.data import ToTensor\n from catalyst.contrib.datasets import MNIST\n from catalyst.contrib.nn.modules import Flatten\n\n loaders = {\n \"train\": DataLoader(\n MNIST(\n os.getcwd(), train=False, download=True, transform=ToTensor()\n ),\n batch_size=32,\n ),\n \"valid\": DataLoader(\n MNIST(\n os.getcwd(), train=False, download=True, transform=ToTensor()\n ),\n batch_size=32,\n ),\n }\n\n model = nn.Sequential(\n Flatten(), nn.Linear(784, 512), nn.ReLU(), nn.Linear(512, 10)\n )\n criterion = nn.CrossEntropyLoss()\n optimizer = torch.optim.Adam(model.parameters(), lr=1e-2)\n runner = dl.SupervisedRunner()\n runner.train(\n model=model,\n callbacks=[dl.TracingCallback(input_key=\"features\", logdir=\"./logs\")],\n loaders=loaders,\n criterion=criterion,\n optimizer=optimizer,\n num_epochs=1,\n logdir=\"./logs\",\n )\n \"\"\"\n super().__init__(order=CallbackOrder.ExternalExtra, node=CallbackNode.Master)\n if logdir is not None:\n self.filename = str(Path(logdir) / filename)\n else:\n self.filename = filename\n self.method_name = method_name\n\n self.input_key = [input_key] if isinstance(input_key, str) else input_key\n\n def on_stage_end(self, runner: \"IRunner\") -> None:\n \"\"\"\n On stage end action.\n\n Args:\n runner: runner for experiment\n \"\"\"\n model = runner.model\n batch = tuple(runner.batch[key] for key in self.input_key)\n batch = any2device(batch, \"cpu\")\n traced_model = trace_model(model=model, batch=batch, method_name=self.method_name)\n torch.jit.save(traced_model, self.filename)\n\n\n__all__ = [\"TracingCallback\"]\n", "path": "catalyst/callbacks/tracing.py"}], "after_files": [{"content": "from typing import List, TYPE_CHECKING, Union\nfrom pathlib import Path\n\nimport torch\n\nfrom catalyst.core import Callback, CallbackNode, CallbackOrder\nfrom catalyst.utils.tracing import trace_model\n\nif TYPE_CHECKING:\n from catalyst.core import IRunner\n\n\nclass TracingCallback(Callback):\n \"\"\"\n Callback for model tracing.\n\n Args:\n input_key: input key from ``runner.batch`` to use for model tracing\n logdir: path to folder for saving\n filename: filename\n method_name: Model's method name that will be used as entrypoint during tracing\n\n Example:\n\n .. code-block:: python\n\n import os\n\n import torch\n from torch import nn\n from torch.utils.data import DataLoader\n\n from catalyst import dl\n from catalyst.data import ToTensor\n from catalyst.contrib.datasets import MNIST\n from catalyst.contrib.nn.modules import Flatten\n\n loaders = {\n \"train\": DataLoader(\n MNIST(\n os.getcwd(), train=False, download=True, transform=ToTensor()\n ),\n batch_size=32,\n ),\n \"valid\": DataLoader(\n MNIST(\n os.getcwd(), train=False, download=True, transform=ToTensor()\n ),\n batch_size=32,\n ),\n }\n\n model = nn.Sequential(\n Flatten(), nn.Linear(784, 512), nn.ReLU(), nn.Linear(512, 10)\n )\n criterion = nn.CrossEntropyLoss()\n optimizer = torch.optim.Adam(model.parameters(), lr=1e-2)\n runner = dl.SupervisedRunner()\n runner.train(\n model=model,\n callbacks=[dl.TracingCallback(input_key=\"features\", logdir=\"./logs\")],\n loaders=loaders,\n criterion=criterion,\n optimizer=optimizer,\n num_epochs=1,\n logdir=\"./logs\",\n )\n \"\"\"\n\n def __init__(\n self,\n input_key: Union[str, List[str]],\n logdir: Union[str, Path] = None,\n filename: str = \"traced_model.pth\",\n method_name: str = \"forward\",\n ):\n \"\"\"\n Callback for model tracing.\n\n Args:\n input_key: input key from ``runner.batch`` to use for model tracing\n logdir: path to folder for saving\n filename: filename\n method_name: Model's method name that will be used as entrypoint during tracing\n\n Example:\n .. code-block:: python\n\n import os\n\n import torch\n from torch import nn\n from torch.utils.data import DataLoader\n\n from catalyst import dl\n from catalyst.data import ToTensor\n from catalyst.contrib.datasets import MNIST\n from catalyst.contrib.nn.modules import Flatten\n\n loaders = {\n \"train\": DataLoader(\n MNIST(\n os.getcwd(), train=False, download=True, transform=ToTensor()\n ),\n batch_size=32,\n ),\n \"valid\": DataLoader(\n MNIST(\n os.getcwd(), train=False, download=True, transform=ToTensor()\n ),\n batch_size=32,\n ),\n }\n\n model = nn.Sequential(\n Flatten(), nn.Linear(784, 512), nn.ReLU(), nn.Linear(512, 10)\n )\n criterion = nn.CrossEntropyLoss()\n optimizer = torch.optim.Adam(model.parameters(), lr=1e-2)\n runner = dl.SupervisedRunner()\n runner.train(\n model=model,\n callbacks=[dl.TracingCallback(input_key=\"features\", logdir=\"./logs\")],\n loaders=loaders,\n criterion=criterion,\n optimizer=optimizer,\n num_epochs=1,\n logdir=\"./logs\",\n )\n \"\"\"\n super().__init__(order=CallbackOrder.ExternalExtra, node=CallbackNode.Master)\n if logdir is not None:\n self.filename = str(Path(logdir) / filename)\n else:\n self.filename = filename\n self.method_name = method_name\n\n self.input_key = [input_key] if isinstance(input_key, str) else input_key\n\n def on_stage_end(self, runner: \"IRunner\") -> None:\n \"\"\"\n On stage end action.\n\n Args:\n runner: runner for experiment\n \"\"\"\n model = runner.engine.sync_device(runner.model)\n batch = tuple(runner.batch[key] for key in self.input_key)\n batch = runner.engine.sync_device(batch)\n traced_model = trace_model(model=model, batch=batch, method_name=self.method_name)\n torch.jit.save(traced_model, self.filename)\n\n\n__all__ = [\"TracingCallback\"]\n", "path": "catalyst/callbacks/tracing.py"}]}
| 2,366 | 206 |
gh_patches_debug_48934
|
rasdani/github-patches
|
git_diff
|
pfnet__pytorch-pfn-extras-363
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Tests package is not correctly excluded
Currently test codes are installed to site-packages.
`setuptools.find_packages(exclude=['tests'])` needs to be fixed.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `setup.py`
Content:
```
1 import os
2 import setuptools
3
4
5 here = os.path.abspath(os.path.dirname(__file__))
6 # Get __version__ variable
7 exec(open(os.path.join(here, 'pytorch_pfn_extras', '_version.py')).read())
8
9
10 setuptools.setup(
11 name='pytorch-pfn-extras',
12 version=__version__, # NOQA
13 description='Supplementary components to accelerate research and '
14 'development in PyTorch.',
15 author='Preferred Networks, Inc.',
16 license='MIT License',
17 install_requires=['numpy', 'torch'],
18 extras_require={
19 'test': ['pytest'],
20 'onnx': ['onnx'],
21 },
22 python_requires='>=3.6.0',
23 packages=setuptools.find_packages(exclude=['tests']),
24 package_data={'pytorch_pfn_extras': ['py.typed']},
25 )
26
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/setup.py b/setup.py
--- a/setup.py
+++ b/setup.py
@@ -20,6 +20,6 @@
'onnx': ['onnx'],
},
python_requires='>=3.6.0',
- packages=setuptools.find_packages(exclude=['tests']),
+ packages=setuptools.find_packages(exclude=['tests', 'tests.*']),
package_data={'pytorch_pfn_extras': ['py.typed']},
)
|
{"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -20,6 +20,6 @@\n 'onnx': ['onnx'],\n },\n python_requires='>=3.6.0',\n- packages=setuptools.find_packages(exclude=['tests']),\n+ packages=setuptools.find_packages(exclude=['tests', 'tests.*']),\n package_data={'pytorch_pfn_extras': ['py.typed']},\n )\n", "issue": "Tests package is not correctly excluded\nCurrently test codes are installed to site-packages.\r\n\r\n`setuptools.find_packages(exclude=['tests'])` needs to be fixed.\n", "before_files": [{"content": "import os\nimport setuptools\n\n\nhere = os.path.abspath(os.path.dirname(__file__))\n# Get __version__ variable\nexec(open(os.path.join(here, 'pytorch_pfn_extras', '_version.py')).read())\n\n\nsetuptools.setup(\n name='pytorch-pfn-extras',\n version=__version__, # NOQA\n description='Supplementary components to accelerate research and '\n 'development in PyTorch.',\n author='Preferred Networks, Inc.',\n license='MIT License',\n install_requires=['numpy', 'torch'],\n extras_require={\n 'test': ['pytest'],\n 'onnx': ['onnx'],\n },\n python_requires='>=3.6.0',\n packages=setuptools.find_packages(exclude=['tests']),\n package_data={'pytorch_pfn_extras': ['py.typed']},\n)\n", "path": "setup.py"}], "after_files": [{"content": "import os\nimport setuptools\n\n\nhere = os.path.abspath(os.path.dirname(__file__))\n# Get __version__ variable\nexec(open(os.path.join(here, 'pytorch_pfn_extras', '_version.py')).read())\n\n\nsetuptools.setup(\n name='pytorch-pfn-extras',\n version=__version__, # NOQA\n description='Supplementary components to accelerate research and '\n 'development in PyTorch.',\n author='Preferred Networks, Inc.',\n license='MIT License',\n install_requires=['numpy', 'torch'],\n extras_require={\n 'test': ['pytest'],\n 'onnx': ['onnx'],\n },\n python_requires='>=3.6.0',\n packages=setuptools.find_packages(exclude=['tests', 'tests.*']),\n package_data={'pytorch_pfn_extras': ['py.typed']},\n)\n", "path": "setup.py"}]}
| 507 | 99 |
gh_patches_debug_22060
|
rasdani/github-patches
|
git_diff
|
interlegis__sapl-1788
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Cargo de Comissão - permite atribuir cargo indicado como único para mais de um membro
Não deve permitir atribuir o mesmo cargo assinalado como único para mais de um membro da comissão. O cargo deve estar vago.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `sapl/comissoes/forms.py`
Content:
```
1 from django import forms
2 from django.contrib.contenttypes.models import ContentType
3 from django.core.exceptions import ValidationError
4 from django.db import transaction
5 from django.db.models import Q
6 from django.forms import ModelForm
7 from django.utils.translation import ugettext_lazy as _
8
9 from sapl.base.models import Autor, TipoAutor
10 from sapl.comissoes.models import (Comissao, Composicao, DocumentoAcessorio,
11 Participacao, Reuniao)
12 from sapl.parlamentares.models import Legislatura, Mandato, Parlamentar
13
14
15 class ParticipacaoCreateForm(forms.ModelForm):
16
17 parent_pk = forms.CharField(required=False) # widget=forms.HiddenInput())
18
19 class Meta:
20 model = Participacao
21 exclude = ['composicao']
22
23 def __init__(self, user=None, **kwargs):
24 super(ParticipacaoCreateForm, self).__init__(**kwargs)
25
26 if self.instance:
27 comissao = kwargs['initial']
28 comissao_pk = int(comissao['parent_pk'])
29 composicao = Composicao.objects.get(id=comissao_pk)
30 participantes = composicao.participacao_set.all()
31 id_part = [p.parlamentar.id for p in participantes]
32 else:
33 id_part = []
34
35 qs = self.create_participacao()
36
37 parlamentares = Mandato.objects.filter(qs,
38 parlamentar__ativo=True
39 ).prefetch_related('parlamentar').\
40 values_list('parlamentar',
41 flat=True).distinct()
42
43 qs = Parlamentar.objects.filter(id__in=parlamentares).distinct().\
44 exclude(id__in=id_part)
45 eligible = self.verifica()
46 result = list(set(qs) & set(eligible))
47 if not cmp(result, eligible): # se igual a 0 significa que o qs e o eli são iguais!
48 self.fields['parlamentar'].queryset = qs
49 else:
50 ids = [e.id for e in eligible]
51 qs = Parlamentar.objects.filter(id__in=ids)
52 self.fields['parlamentar'].queryset = qs
53
54 def create_participacao(self):
55 composicao = Composicao.objects.get(id=self.initial['parent_pk'])
56 data_inicio_comissao = composicao.periodo.data_inicio
57 data_fim_comissao = composicao.periodo.data_fim
58 q1 = Q(data_fim_mandato__isnull=False,
59 data_fim_mandato__gte=data_inicio_comissao)
60 q2 = Q(data_inicio_mandato__gte=data_inicio_comissao) \
61 & Q(data_inicio_mandato__lte=data_fim_comissao)
62 q3 = Q(data_fim_mandato__isnull=True,
63 data_inicio_mandato__lte=data_inicio_comissao)
64 qs = q1 | q2 | q3
65 return qs
66
67 def verifica(self):
68 composicao = Composicao.objects.get(id=self.initial['parent_pk'])
69 participantes = composicao.participacao_set.all()
70 participantes_id = [p.parlamentar.id for p in participantes]
71 parlamentares = Parlamentar.objects.all().exclude(
72 id__in=participantes_id).order_by('nome_completo')
73 parlamentares = [p for p in parlamentares if p.ativo]
74
75 lista = []
76
77 for p in parlamentares:
78 mandatos = p.mandato_set.all()
79 for m in mandatos:
80 data_inicio = m.data_inicio_mandato
81 data_fim = m.data_fim_mandato
82 comp_data_inicio = composicao.periodo.data_inicio
83 comp_data_fim = composicao.periodo.data_fim
84 if (data_fim and data_fim >= comp_data_inicio)\
85 or (data_inicio >= comp_data_inicio and data_inicio <= comp_data_fim)\
86 or (data_fim is None and data_inicio <= comp_data_inicio):
87 lista.append(p)
88
89 lista = list(set(lista))
90
91 return lista
92
93
94 class ParticipacaoEditForm(forms.ModelForm):
95
96 parent_pk = forms.CharField(required=False) # widget=forms.HiddenInput())
97 nome_parlamentar = forms.CharField(required=False, label='Parlamentar')
98
99 class Meta:
100 model = Participacao
101 fields = ['nome_parlamentar', 'parlamentar', 'cargo', 'titular',
102 'data_designacao', 'data_desligamento',
103 'motivo_desligamento', 'observacao']
104 widgets = {
105 'parlamentar': forms.HiddenInput(),
106 }
107
108 def __init__(self, user=None, **kwargs):
109 super(ParticipacaoEditForm, self).__init__(**kwargs)
110 self.initial['nome_parlamentar'] = Parlamentar.objects.get(
111 id=self.initial['parlamentar']).nome_parlamentar
112 self.fields['nome_parlamentar'].widget.attrs['disabled'] = 'disabled'
113
114
115 class ComissaoForm(forms.ModelForm):
116
117 class Meta:
118 model = Comissao
119 fields = '__all__'
120
121 def clean(self):
122 super(ComissaoForm, self).clean()
123
124 if not self.is_valid():
125 return self.cleaned_data
126
127 if self.cleaned_data['data_extincao']:
128 if (self.cleaned_data['data_extincao'] <
129 self.cleaned_data['data_criacao']):
130 msg = _('Data de extinção não pode ser menor que a de criação')
131 raise ValidationError(msg)
132 return self.cleaned_data
133
134 @transaction.atomic
135 def save(self, commit=True):
136 comissao = super(ComissaoForm, self).save(commit)
137 content_type = ContentType.objects.get_for_model(Comissao)
138 object_id = comissao.pk
139 tipo = TipoAutor.objects.get(descricao__icontains='Comiss')
140 nome = comissao.sigla + ' - ' + comissao.nome
141 Autor.objects.create(
142 content_type=content_type,
143 object_id=object_id,
144 tipo=tipo,
145 nome=nome
146 )
147 return comissao
148
149
150 class ReuniaoForm(ModelForm):
151
152 comissao = forms.ModelChoiceField(queryset=Comissao.objects.all(),
153 widget=forms.HiddenInput())
154
155 class Meta:
156 model = Reuniao
157 exclude = ['cod_andamento_reuniao']
158
159 def clean(self):
160 super(ReuniaoForm, self).clean()
161
162 if not self.is_valid():
163 return self.cleaned_data
164
165 if self.cleaned_data['hora_fim']:
166 if (self.cleaned_data['hora_fim'] <
167 self.cleaned_data['hora_inicio']):
168 msg = _('A hora de término da reunião não pode ser menor que a de início')
169 raise ValidationError(msg)
170 return self.cleaned_data
171
172 class DocumentoAcessorioCreateForm(forms.ModelForm):
173
174 parent_pk = forms.CharField(required=False) # widget=forms.HiddenInput())
175
176 class Meta:
177 model = DocumentoAcessorio
178 exclude = ['reuniao']
179
180 def __init__(self, user=None, **kwargs):
181 super(DocumentoAcessorioCreateForm, self).__init__(**kwargs)
182
183 if self.instance:
184 reuniao = Reuniao.objects.get(id=self.initial['parent_pk'])
185 comissao = reuniao.comissao
186 comissao_pk = comissao.id
187 documentos = reuniao.documentoacessorio_set.all()
188 return self.create_documentoacessorio()
189
190
191 def create_documentoacessorio(self):
192 reuniao = Reuniao.objects.get(id=self.initial['parent_pk'])
193
194
195 class DocumentoAcessorioEditForm(forms.ModelForm):
196
197 parent_pk = forms.CharField(required=False) # widget=forms.HiddenInput())
198
199 class Meta:
200 model = DocumentoAcessorio
201 fields = ['nome', 'data', 'autor', 'ementa',
202 'indexacao', 'arquivo']
203
204 def __init__(self, user=None, **kwargs):
205 super(DocumentoAcessorioEditForm, self).__init__(**kwargs)
206
207
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/sapl/comissoes/forms.py b/sapl/comissoes/forms.py
--- a/sapl/comissoes/forms.py
+++ b/sapl/comissoes/forms.py
@@ -18,6 +18,7 @@
class Meta:
model = Participacao
+ fields = '__all__'
exclude = ['composicao']
def __init__(self, user=None, **kwargs):
@@ -51,6 +52,21 @@
qs = Parlamentar.objects.filter(id__in=ids)
self.fields['parlamentar'].queryset = qs
+
+ def clean(self):
+ cleaned_data = super(ParticipacaoCreateForm, self).clean()
+
+ if not self.is_valid():
+ return cleaned_data
+
+ composicao = Composicao.objects.get(id=self.initial['parent_pk'])
+ cargos_unicos = [c.cargo.nome for c in composicao.participacao_set.filter(cargo__unico=True)]
+
+ if cleaned_data['cargo'].nome in cargos_unicos:
+ msg = _('Este cargo é único para esta Comissão.')
+ raise ValidationError(msg)
+
+
def create_participacao(self):
composicao = Composicao.objects.get(id=self.initial['parent_pk'])
data_inicio_comissao = composicao.periodo.data_inicio
|
{"golden_diff": "diff --git a/sapl/comissoes/forms.py b/sapl/comissoes/forms.py\n--- a/sapl/comissoes/forms.py\n+++ b/sapl/comissoes/forms.py\n@@ -18,6 +18,7 @@\n \n class Meta:\n model = Participacao\n+ fields = '__all__'\n exclude = ['composicao']\n \n def __init__(self, user=None, **kwargs):\n@@ -51,6 +52,21 @@\n qs = Parlamentar.objects.filter(id__in=ids)\n self.fields['parlamentar'].queryset = qs\n \n+\n+ def clean(self):\n+ cleaned_data = super(ParticipacaoCreateForm, self).clean()\n+\n+ if not self.is_valid():\n+ return cleaned_data\n+\n+ composicao = Composicao.objects.get(id=self.initial['parent_pk'])\n+ cargos_unicos = [c.cargo.nome for c in composicao.participacao_set.filter(cargo__unico=True)]\n+\n+ if cleaned_data['cargo'].nome in cargos_unicos:\n+ msg = _('Este cargo \u00e9 \u00fanico para esta Comiss\u00e3o.')\n+ raise ValidationError(msg)\n+\n+\n def create_participacao(self):\n composicao = Composicao.objects.get(id=self.initial['parent_pk'])\n data_inicio_comissao = composicao.periodo.data_inicio\n", "issue": "Cargo de Comiss\u00e3o - permite atribuir cargo indicado como \u00fanico para mais de um membro\nN\u00e3o deve permitir atribuir o mesmo cargo assinalado como \u00fanico para mais de um membro da comiss\u00e3o. O cargo deve estar vago.\n", "before_files": [{"content": "from django import forms\nfrom django.contrib.contenttypes.models import ContentType\nfrom django.core.exceptions import ValidationError\nfrom django.db import transaction\nfrom django.db.models import Q\nfrom django.forms import ModelForm\nfrom django.utils.translation import ugettext_lazy as _\n\nfrom sapl.base.models import Autor, TipoAutor\nfrom sapl.comissoes.models import (Comissao, Composicao, DocumentoAcessorio,\n Participacao, Reuniao)\nfrom sapl.parlamentares.models import Legislatura, Mandato, Parlamentar\n\n\nclass ParticipacaoCreateForm(forms.ModelForm):\n\n parent_pk = forms.CharField(required=False) # widget=forms.HiddenInput())\n\n class Meta:\n model = Participacao\n exclude = ['composicao']\n\n def __init__(self, user=None, **kwargs):\n super(ParticipacaoCreateForm, self).__init__(**kwargs)\n\n if self.instance:\n comissao = kwargs['initial']\n comissao_pk = int(comissao['parent_pk'])\n composicao = Composicao.objects.get(id=comissao_pk)\n participantes = composicao.participacao_set.all()\n id_part = [p.parlamentar.id for p in participantes]\n else:\n id_part = []\n\n qs = self.create_participacao()\n\n parlamentares = Mandato.objects.filter(qs,\n parlamentar__ativo=True\n ).prefetch_related('parlamentar').\\\n values_list('parlamentar',\n flat=True).distinct()\n\n qs = Parlamentar.objects.filter(id__in=parlamentares).distinct().\\\n exclude(id__in=id_part)\n eligible = self.verifica()\n result = list(set(qs) & set(eligible))\n if not cmp(result, eligible): # se igual a 0 significa que o qs e o eli s\u00e3o iguais!\n self.fields['parlamentar'].queryset = qs\n else:\n ids = [e.id for e in eligible]\n qs = Parlamentar.objects.filter(id__in=ids)\n self.fields['parlamentar'].queryset = qs\n\n def create_participacao(self):\n composicao = Composicao.objects.get(id=self.initial['parent_pk'])\n data_inicio_comissao = composicao.periodo.data_inicio\n data_fim_comissao = composicao.periodo.data_fim\n q1 = Q(data_fim_mandato__isnull=False,\n data_fim_mandato__gte=data_inicio_comissao)\n q2 = Q(data_inicio_mandato__gte=data_inicio_comissao) \\\n & Q(data_inicio_mandato__lte=data_fim_comissao)\n q3 = Q(data_fim_mandato__isnull=True,\n data_inicio_mandato__lte=data_inicio_comissao)\n qs = q1 | q2 | q3\n return qs\n\n def verifica(self):\n composicao = Composicao.objects.get(id=self.initial['parent_pk'])\n participantes = composicao.participacao_set.all()\n participantes_id = [p.parlamentar.id for p in participantes]\n parlamentares = Parlamentar.objects.all().exclude(\n id__in=participantes_id).order_by('nome_completo')\n parlamentares = [p for p in parlamentares if p.ativo]\n\n lista = []\n\n for p in parlamentares:\n mandatos = p.mandato_set.all()\n for m in mandatos:\n data_inicio = m.data_inicio_mandato\n data_fim = m.data_fim_mandato\n comp_data_inicio = composicao.periodo.data_inicio\n comp_data_fim = composicao.periodo.data_fim\n if (data_fim and data_fim >= comp_data_inicio)\\\n or (data_inicio >= comp_data_inicio and data_inicio <= comp_data_fim)\\\n or (data_fim is None and data_inicio <= comp_data_inicio):\n lista.append(p)\n\n lista = list(set(lista))\n\n return lista\n\n\nclass ParticipacaoEditForm(forms.ModelForm):\n\n parent_pk = forms.CharField(required=False) # widget=forms.HiddenInput())\n nome_parlamentar = forms.CharField(required=False, label='Parlamentar')\n\n class Meta:\n model = Participacao\n fields = ['nome_parlamentar', 'parlamentar', 'cargo', 'titular',\n 'data_designacao', 'data_desligamento',\n 'motivo_desligamento', 'observacao']\n widgets = {\n 'parlamentar': forms.HiddenInput(),\n }\n\n def __init__(self, user=None, **kwargs):\n super(ParticipacaoEditForm, self).__init__(**kwargs)\n self.initial['nome_parlamentar'] = Parlamentar.objects.get(\n id=self.initial['parlamentar']).nome_parlamentar\n self.fields['nome_parlamentar'].widget.attrs['disabled'] = 'disabled'\n\n\nclass ComissaoForm(forms.ModelForm):\n\n class Meta:\n model = Comissao\n fields = '__all__'\n\n def clean(self):\n super(ComissaoForm, self).clean()\n\n if not self.is_valid():\n return self.cleaned_data\n\n if self.cleaned_data['data_extincao']:\n if (self.cleaned_data['data_extincao'] <\n self.cleaned_data['data_criacao']):\n msg = _('Data de extin\u00e7\u00e3o n\u00e3o pode ser menor que a de cria\u00e7\u00e3o')\n raise ValidationError(msg)\n return self.cleaned_data\n\n @transaction.atomic\n def save(self, commit=True):\n comissao = super(ComissaoForm, self).save(commit)\n content_type = ContentType.objects.get_for_model(Comissao)\n object_id = comissao.pk\n tipo = TipoAutor.objects.get(descricao__icontains='Comiss')\n nome = comissao.sigla + ' - ' + comissao.nome\n Autor.objects.create(\n content_type=content_type,\n object_id=object_id,\n tipo=tipo,\n nome=nome\n )\n return comissao\n\n\nclass ReuniaoForm(ModelForm):\n\n comissao = forms.ModelChoiceField(queryset=Comissao.objects.all(),\n widget=forms.HiddenInput())\n\n class Meta:\n model = Reuniao\n exclude = ['cod_andamento_reuniao']\n\n def clean(self):\n super(ReuniaoForm, self).clean()\n\n if not self.is_valid():\n return self.cleaned_data\n\n if self.cleaned_data['hora_fim']:\n if (self.cleaned_data['hora_fim'] <\n self.cleaned_data['hora_inicio']):\n msg = _('A hora de t\u00e9rmino da reuni\u00e3o n\u00e3o pode ser menor que a de in\u00edcio')\n raise ValidationError(msg)\n return self.cleaned_data\n\nclass DocumentoAcessorioCreateForm(forms.ModelForm):\n\n parent_pk = forms.CharField(required=False) # widget=forms.HiddenInput())\n\n class Meta:\n model = DocumentoAcessorio\n exclude = ['reuniao']\n\n def __init__(self, user=None, **kwargs):\n super(DocumentoAcessorioCreateForm, self).__init__(**kwargs)\n\n if self.instance:\n reuniao = Reuniao.objects.get(id=self.initial['parent_pk'])\n comissao = reuniao.comissao\n comissao_pk = comissao.id\n documentos = reuniao.documentoacessorio_set.all()\n return self.create_documentoacessorio()\n\n\n def create_documentoacessorio(self):\n reuniao = Reuniao.objects.get(id=self.initial['parent_pk'])\n\n\nclass DocumentoAcessorioEditForm(forms.ModelForm):\n\n parent_pk = forms.CharField(required=False) # widget=forms.HiddenInput())\n\n class Meta:\n model = DocumentoAcessorio\n fields = ['nome', 'data', 'autor', 'ementa',\n 'indexacao', 'arquivo']\n\n def __init__(self, user=None, **kwargs):\n super(DocumentoAcessorioEditForm, self).__init__(**kwargs)\n\n", "path": "sapl/comissoes/forms.py"}], "after_files": [{"content": "from django import forms\nfrom django.contrib.contenttypes.models import ContentType\nfrom django.core.exceptions import ValidationError\nfrom django.db import transaction\nfrom django.db.models import Q\nfrom django.forms import ModelForm\nfrom django.utils.translation import ugettext_lazy as _\n\nfrom sapl.base.models import Autor, TipoAutor\nfrom sapl.comissoes.models import (Comissao, Composicao, DocumentoAcessorio,\n Participacao, Reuniao)\nfrom sapl.parlamentares.models import Legislatura, Mandato, Parlamentar\n\n\nclass ParticipacaoCreateForm(forms.ModelForm):\n\n parent_pk = forms.CharField(required=False) # widget=forms.HiddenInput())\n\n class Meta:\n model = Participacao\n fields = '__all__'\n exclude = ['composicao']\n\n def __init__(self, user=None, **kwargs):\n super(ParticipacaoCreateForm, self).__init__(**kwargs)\n\n if self.instance:\n comissao = kwargs['initial']\n comissao_pk = int(comissao['parent_pk'])\n composicao = Composicao.objects.get(id=comissao_pk)\n participantes = composicao.participacao_set.all()\n id_part = [p.parlamentar.id for p in participantes]\n else:\n id_part = []\n\n qs = self.create_participacao()\n\n parlamentares = Mandato.objects.filter(qs,\n parlamentar__ativo=True\n ).prefetch_related('parlamentar').\\\n values_list('parlamentar',\n flat=True).distinct()\n\n qs = Parlamentar.objects.filter(id__in=parlamentares).distinct().\\\n exclude(id__in=id_part)\n eligible = self.verifica()\n result = list(set(qs) & set(eligible))\n if not cmp(result, eligible): # se igual a 0 significa que o qs e o eli s\u00e3o iguais!\n self.fields['parlamentar'].queryset = qs\n else:\n ids = [e.id for e in eligible]\n qs = Parlamentar.objects.filter(id__in=ids)\n self.fields['parlamentar'].queryset = qs\n\n\n def clean(self):\n cleaned_data = super(ParticipacaoCreateForm, self).clean()\n\n if not self.is_valid():\n return cleaned_data\n\n composicao = Composicao.objects.get(id=self.initial['parent_pk'])\n cargos_unicos = [c.cargo.nome for c in composicao.participacao_set.filter(cargo__unico=True)]\n\n if cleaned_data['cargo'].nome in cargos_unicos:\n msg = _('Este cargo \u00e9 \u00fanico para esta Comiss\u00e3o.')\n raise ValidationError(msg)\n\n\n def create_participacao(self):\n composicao = Composicao.objects.get(id=self.initial['parent_pk'])\n data_inicio_comissao = composicao.periodo.data_inicio\n data_fim_comissao = composicao.periodo.data_fim\n q1 = Q(data_fim_mandato__isnull=False,\n data_fim_mandato__gte=data_inicio_comissao)\n q2 = Q(data_inicio_mandato__gte=data_inicio_comissao) \\\n & Q(data_inicio_mandato__lte=data_fim_comissao)\n q3 = Q(data_fim_mandato__isnull=True,\n data_inicio_mandato__lte=data_inicio_comissao)\n qs = q1 | q2 | q3\n return qs\n\n def verifica(self):\n composicao = Composicao.objects.get(id=self.initial['parent_pk'])\n participantes = composicao.participacao_set.all()\n participantes_id = [p.parlamentar.id for p in participantes]\n parlamentares = Parlamentar.objects.all().exclude(\n id__in=participantes_id).order_by('nome_completo')\n parlamentares = [p for p in parlamentares if p.ativo]\n\n lista = []\n\n for p in parlamentares:\n mandatos = p.mandato_set.all()\n for m in mandatos:\n data_inicio = m.data_inicio_mandato\n data_fim = m.data_fim_mandato\n comp_data_inicio = composicao.periodo.data_inicio\n comp_data_fim = composicao.periodo.data_fim\n if (data_fim and data_fim >= comp_data_inicio)\\\n or (data_inicio >= comp_data_inicio and data_inicio <= comp_data_fim)\\\n or (data_fim is None and data_inicio <= comp_data_inicio):\n lista.append(p)\n\n lista = list(set(lista))\n\n return lista\n\n\nclass ParticipacaoEditForm(forms.ModelForm):\n\n parent_pk = forms.CharField(required=False) # widget=forms.HiddenInput())\n nome_parlamentar = forms.CharField(required=False, label='Parlamentar')\n\n class Meta:\n model = Participacao\n fields = ['nome_parlamentar', 'parlamentar', 'cargo', 'titular',\n 'data_designacao', 'data_desligamento',\n 'motivo_desligamento', 'observacao']\n widgets = {\n 'parlamentar': forms.HiddenInput(),\n }\n\n def __init__(self, user=None, **kwargs):\n super(ParticipacaoEditForm, self).__init__(**kwargs)\n self.initial['nome_parlamentar'] = Parlamentar.objects.get(\n id=self.initial['parlamentar']).nome_parlamentar\n self.fields['nome_parlamentar'].widget.attrs['disabled'] = 'disabled'\n\n\nclass ComissaoForm(forms.ModelForm):\n\n class Meta:\n model = Comissao\n fields = '__all__'\n\n def clean(self):\n super(ComissaoForm, self).clean()\n\n if not self.is_valid():\n return self.cleaned_data\n\n if self.cleaned_data['data_extincao']:\n if (self.cleaned_data['data_extincao'] <\n self.cleaned_data['data_criacao']):\n msg = _('Data de extin\u00e7\u00e3o n\u00e3o pode ser menor que a de cria\u00e7\u00e3o')\n raise ValidationError(msg)\n return self.cleaned_data\n\n @transaction.atomic\n def save(self, commit=True):\n comissao = super(ComissaoForm, self).save(commit)\n content_type = ContentType.objects.get_for_model(Comissao)\n object_id = comissao.pk\n tipo = TipoAutor.objects.get(descricao__icontains='Comiss')\n nome = comissao.sigla + ' - ' + comissao.nome\n Autor.objects.create(\n content_type=content_type,\n object_id=object_id,\n tipo=tipo,\n nome=nome\n )\n return comissao\n\n\nclass ReuniaoForm(ModelForm):\n\n comissao = forms.ModelChoiceField(queryset=Comissao.objects.all(),\n widget=forms.HiddenInput())\n\n class Meta:\n model = Reuniao\n exclude = ['cod_andamento_reuniao']\n\n def clean(self):\n super(ReuniaoForm, self).clean()\n\n if not self.is_valid():\n return self.cleaned_data\n\n if self.cleaned_data['hora_fim']:\n if (self.cleaned_data['hora_fim'] <\n self.cleaned_data['hora_inicio']):\n msg = _('A hora de t\u00e9rmino da reuni\u00e3o n\u00e3o pode ser menor que a de in\u00edcio')\n raise ValidationError(msg)\n return self.cleaned_data\n\nclass DocumentoAcessorioCreateForm(forms.ModelForm):\n\n parent_pk = forms.CharField(required=False) # widget=forms.HiddenInput())\n\n class Meta:\n model = DocumentoAcessorio\n exclude = ['reuniao']\n\n def __init__(self, user=None, **kwargs):\n super(DocumentoAcessorioCreateForm, self).__init__(**kwargs)\n\n if self.instance:\n reuniao = Reuniao.objects.get(id=self.initial['parent_pk'])\n comissao = reuniao.comissao\n comissao_pk = comissao.id\n documentos = reuniao.documentoacessorio_set.all()\n return self.create_documentoacessorio()\n\n\n def create_documentoacessorio(self):\n reuniao = Reuniao.objects.get(id=self.initial['parent_pk'])\n\n\nclass DocumentoAcessorioEditForm(forms.ModelForm):\n\n parent_pk = forms.CharField(required=False) # widget=forms.HiddenInput())\n\n class Meta:\n model = DocumentoAcessorio\n fields = ['nome', 'data', 'autor', 'ementa',\n 'indexacao', 'arquivo']\n\n def __init__(self, user=None, **kwargs):\n super(DocumentoAcessorioEditForm, self).__init__(**kwargs)\n\n", "path": "sapl/comissoes/forms.py"}]}
| 2,590 | 303 |
gh_patches_debug_4038
|
rasdani/github-patches
|
git_diff
|
streamlit__streamlit-6129
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Regression in v1.18.0 `st.metric`'s `help` tooltip position
### Checklist
- [X] I have searched the [existing issues](https://github.com/streamlit/streamlit/issues) for similar issues.
- [X] I added a very descriptive title to this issue.
- [X] I have provided sufficient information below to help reproduce this issue.
### Summary
[Reported](https://discuss.streamlit.io/t/version-1-18-0/37501/3?u=snehankekre) by @marduk2 on our forum. The `help` tooltip for `st.metric` has changed positions in v1.18.0 and appears under the metric label instead of to its right.
### Reproducible Code Example
```Python
import streamlit as st
st.title("'Help' tooltips in st.metric render in a weird position")
st.metric(
label="Example metric",
help="Something doesn't feel right...",
value=150.59,
delta="Very high",
)
```
### Steps To Reproduce
1. Run the app
### Expected Behavior
### Current Behavior
### Is this a regression?
- [X] Yes, this used to work in a previous version.
### Debug info
- Streamlit version: 1.18.0
- Python version: 3.9
- Operating System: macOS
- Browser: Chrome
- Virtual environment: NA
### Additional Information
_No response_
### Are you willing to submit a PR?
- [ ] Yes, I am willing to submit a PR!
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `e2e/scripts/st_metric.py`
Content:
```
1 # Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022)
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 import streamlit as st
16
17 col1, col2, col3 = st.columns(3)
18
19 with col1:
20 st.metric("User growth", 123, 123, "normal")
21 with col2:
22 st.metric("S&P 500", -4.56, -50)
23 with col3:
24 st.metric("Apples I've eaten", "23k", " -20", "off")
25
26 " "
27
28 col1, col2, col3 = st.columns(3)
29
30 with col1:
31 st.selectbox("Pick one", [])
32 with col2:
33 st.metric("Test 2", -4.56, 1.23, "inverse")
34 with col3:
35 st.slider("Pick another")
36
37
38 with col1:
39 st.metric("Test 3", -4.56, 1.23, label_visibility="visible")
40 with col2:
41 st.metric("Test 4", -4.56, 1.23, label_visibility="hidden")
42 with col3:
43 st.metric("Test 5", -4.56, 1.23, label_visibility="collapsed")
44
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/e2e/scripts/st_metric.py b/e2e/scripts/st_metric.py
--- a/e2e/scripts/st_metric.py
+++ b/e2e/scripts/st_metric.py
@@ -41,3 +41,13 @@
st.metric("Test 4", -4.56, 1.23, label_visibility="hidden")
with col3:
st.metric("Test 5", -4.56, 1.23, label_visibility="collapsed")
+
+col1, col2, col3, col4, col5, col6, col7, col8 = st.columns(8)
+
+with col1:
+ st.metric(
+ label="Example metric",
+ help="Something should feel right",
+ value=150.59,
+ delta="Very high",
+ )
|
{"golden_diff": "diff --git a/e2e/scripts/st_metric.py b/e2e/scripts/st_metric.py\n--- a/e2e/scripts/st_metric.py\n+++ b/e2e/scripts/st_metric.py\n@@ -41,3 +41,13 @@\n st.metric(\"Test 4\", -4.56, 1.23, label_visibility=\"hidden\")\n with col3:\n st.metric(\"Test 5\", -4.56, 1.23, label_visibility=\"collapsed\")\n+\n+col1, col2, col3, col4, col5, col6, col7, col8 = st.columns(8)\n+\n+with col1:\n+ st.metric(\n+ label=\"Example metric\",\n+ help=\"Something should feel right\",\n+ value=150.59,\n+ delta=\"Very high\",\n+ )\n", "issue": "Regression in v1.18.0 `st.metric`'s `help` tooltip position\n### Checklist\r\n\r\n- [X] I have searched the [existing issues](https://github.com/streamlit/streamlit/issues) for similar issues.\r\n- [X] I added a very descriptive title to this issue.\r\n- [X] I have provided sufficient information below to help reproduce this issue.\r\n\r\n### Summary\r\n\r\n[Reported](https://discuss.streamlit.io/t/version-1-18-0/37501/3?u=snehankekre) by @marduk2 on our forum. The `help` tooltip for `st.metric` has changed positions in v1.18.0 and appears under the metric label instead of to its right.\r\n\r\n### Reproducible Code Example\r\n\r\n```Python\r\nimport streamlit as st\r\n\r\nst.title(\"'Help' tooltips in st.metric render in a weird position\")\r\n\r\nst.metric(\r\n label=\"Example metric\",\r\n help=\"Something doesn't feel right...\",\r\n value=150.59,\r\n delta=\"Very high\",\r\n)\r\n```\r\n\r\n\r\n### Steps To Reproduce\r\n\r\n1. Run the app\r\n\r\n### Expected Behavior\r\n\r\n\r\n\r\n\r\n### Current Behavior\r\n\r\n\r\n\r\n\r\n### Is this a regression?\r\n\r\n- [X] Yes, this used to work in a previous version.\r\n\r\n### Debug info\r\n\r\n- Streamlit version: 1.18.0\r\n- Python version: 3.9\r\n- Operating System: macOS\r\n- Browser: Chrome\r\n- Virtual environment: NA\r\n\r\n\r\n### Additional Information\r\n\r\n_No response_\r\n\r\n### Are you willing to submit a PR?\r\n\r\n- [ ] Yes, I am willing to submit a PR!\n", "before_files": [{"content": "# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022)\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 streamlit as st\n\ncol1, col2, col3 = st.columns(3)\n\nwith col1:\n st.metric(\"User growth\", 123, 123, \"normal\")\nwith col2:\n st.metric(\"S&P 500\", -4.56, -50)\nwith col3:\n st.metric(\"Apples I've eaten\", \"23k\", \" -20\", \"off\")\n\n\" \"\n\ncol1, col2, col3 = st.columns(3)\n\nwith col1:\n st.selectbox(\"Pick one\", [])\nwith col2:\n st.metric(\"Test 2\", -4.56, 1.23, \"inverse\")\nwith col3:\n st.slider(\"Pick another\")\n\n\nwith col1:\n st.metric(\"Test 3\", -4.56, 1.23, label_visibility=\"visible\")\nwith col2:\n st.metric(\"Test 4\", -4.56, 1.23, label_visibility=\"hidden\")\nwith col3:\n st.metric(\"Test 5\", -4.56, 1.23, label_visibility=\"collapsed\")\n", "path": "e2e/scripts/st_metric.py"}], "after_files": [{"content": "# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022)\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 streamlit as st\n\ncol1, col2, col3 = st.columns(3)\n\nwith col1:\n st.metric(\"User growth\", 123, 123, \"normal\")\nwith col2:\n st.metric(\"S&P 500\", -4.56, -50)\nwith col3:\n st.metric(\"Apples I've eaten\", \"23k\", \" -20\", \"off\")\n\n\" \"\n\ncol1, col2, col3 = st.columns(3)\n\nwith col1:\n st.selectbox(\"Pick one\", [])\nwith col2:\n st.metric(\"Test 2\", -4.56, 1.23, \"inverse\")\nwith col3:\n st.slider(\"Pick another\")\n\n\nwith col1:\n st.metric(\"Test 3\", -4.56, 1.23, label_visibility=\"visible\")\nwith col2:\n st.metric(\"Test 4\", -4.56, 1.23, label_visibility=\"hidden\")\nwith col3:\n st.metric(\"Test 5\", -4.56, 1.23, label_visibility=\"collapsed\")\n\ncol1, col2, col3, col4, col5, col6, col7, col8 = st.columns(8)\n\nwith col1:\n st.metric(\n label=\"Example metric\",\n help=\"Something should feel right\",\n value=150.59,\n delta=\"Very high\",\n )\n", "path": "e2e/scripts/st_metric.py"}]}
| 1,220 | 186 |
gh_patches_debug_37087
|
rasdani/github-patches
|
git_diff
|
inventree__InvenTree-5632
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[BUG] Exchange rate provider is closed now
### Please verify that this bug has NOT been raised before.
- [X] I checked and didn't find a similar issue
### Describe the bug*
Our current default exchange rate provider is closed now - and the change was not smooth either. See https://github.com/Formicka/exchangerate.host/issues/236#issuecomment-1738539199
We need to:
1) Disable the CI checks for now
2) Implement an alternative
3) (Optional) Bring down ApiLayer once and for all before they close all APIs we need
### Steps to Reproduce
Look at any current [CI](https://github.com/inventree/InvenTree/actions/runs/6333198194/job/17202067465?pr=5582)
### Expected behaviour
Updating exchange rates
### Deployment Method
- [X] Docker
- [X] Bare metal
### Version Information
Every version>0.6.0 and a couble before are probably effected.
### Please verify if you can reproduce this bug on the demo site.
- [X] I can reproduce this bug on the demo site.
### Relevant log output
_No response_
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `InvenTree/InvenTree/exchange.py`
Content:
```
1 """Exchangerate backend to use `exchangerate.host` to get rates."""
2
3 import ssl
4 from urllib.error import URLError
5 from urllib.request import urlopen
6
7 from django.db.utils import OperationalError
8
9 import certifi
10 from djmoney.contrib.exchange.backends.base import SimpleExchangeBackend
11
12 from common.settings import currency_code_default, currency_codes
13
14
15 class InvenTreeExchange(SimpleExchangeBackend):
16 """Backend for automatically updating currency exchange rates.
17
18 Uses the `exchangerate.host` service API
19 """
20
21 name = "InvenTreeExchange"
22
23 def __init__(self):
24 """Set API url."""
25 self.url = "https://api.exchangerate.host/latest"
26
27 super().__init__()
28
29 def get_params(self):
30 """Placeholder to set API key. Currently not required by `exchangerate.host`."""
31 # No API key is required
32 return {
33 }
34
35 def get_response(self, **kwargs):
36 """Custom code to get response from server.
37
38 Note: Adds a 5-second timeout
39 """
40 url = self.get_url(**kwargs)
41
42 try:
43 context = ssl.create_default_context(cafile=certifi.where())
44 response = urlopen(url, timeout=5, context=context)
45 return response.read()
46 except Exception:
47 # Something has gone wrong, but we can just try again next time
48 # Raise a TypeError so the outer function can handle this
49 raise TypeError
50
51 def update_rates(self, base_currency=None):
52 """Set the requested currency codes and get rates."""
53 # Set default - see B008
54 if base_currency is None:
55 base_currency = currency_code_default()
56
57 symbols = ','.join(currency_codes())
58
59 try:
60 super().update_rates(base=base_currency, symbols=symbols)
61 # catch connection errors
62 except URLError:
63 print('Encountered connection error while updating')
64 except TypeError:
65 print('Exchange returned invalid response')
66 except OperationalError as e:
67 if 'SerializationFailure' in e.__cause__.__class__.__name__:
68 print('Serialization Failure while updating exchange rates')
69 # We are just going to swallow this exception because the
70 # exchange rates will be updated later by the scheduled task
71 else:
72 # Other operational errors probably are still show stoppers
73 # so reraise them so that the log contains the stacktrace
74 raise
75
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/InvenTree/InvenTree/exchange.py b/InvenTree/InvenTree/exchange.py
--- a/InvenTree/InvenTree/exchange.py
+++ b/InvenTree/InvenTree/exchange.py
@@ -1,12 +1,11 @@
-"""Exchangerate backend to use `exchangerate.host` to get rates."""
+"""Exchangerate backend to use `frankfurter.app` to get rates."""
-import ssl
+from decimal import Decimal
from urllib.error import URLError
-from urllib.request import urlopen
from django.db.utils import OperationalError
-import certifi
+import requests
from djmoney.contrib.exchange.backends.base import SimpleExchangeBackend
from common.settings import currency_code_default, currency_codes
@@ -15,19 +14,19 @@
class InvenTreeExchange(SimpleExchangeBackend):
"""Backend for automatically updating currency exchange rates.
- Uses the `exchangerate.host` service API
+ Uses the `frankfurter.app` service API
"""
name = "InvenTreeExchange"
def __init__(self):
"""Set API url."""
- self.url = "https://api.exchangerate.host/latest"
+ self.url = "https://api.frankfurter.app/latest"
super().__init__()
def get_params(self):
- """Placeholder to set API key. Currently not required by `exchangerate.host`."""
+ """Placeholder to set API key. Currently not required by `frankfurter.app`."""
# No API key is required
return {
}
@@ -40,14 +39,22 @@
url = self.get_url(**kwargs)
try:
- context = ssl.create_default_context(cafile=certifi.where())
- response = urlopen(url, timeout=5, context=context)
- return response.read()
+ response = requests.get(url=url, timeout=5)
+ return response.content
except Exception:
# Something has gone wrong, but we can just try again next time
# Raise a TypeError so the outer function can handle this
raise TypeError
+ def get_rates(self, **params):
+ """Intersect the requested currency codes with the available codes."""
+ rates = super().get_rates(**params)
+
+ # Add the base currency to the rates
+ rates[params["base_currency"]] = Decimal("1.0")
+
+ return rates
+
def update_rates(self, base_currency=None):
"""Set the requested currency codes and get rates."""
# Set default - see B008
|
{"golden_diff": "diff --git a/InvenTree/InvenTree/exchange.py b/InvenTree/InvenTree/exchange.py\n--- a/InvenTree/InvenTree/exchange.py\n+++ b/InvenTree/InvenTree/exchange.py\n@@ -1,12 +1,11 @@\n-\"\"\"Exchangerate backend to use `exchangerate.host` to get rates.\"\"\"\n+\"\"\"Exchangerate backend to use `frankfurter.app` to get rates.\"\"\"\n \n-import ssl\n+from decimal import Decimal\n from urllib.error import URLError\n-from urllib.request import urlopen\n \n from django.db.utils import OperationalError\n \n-import certifi\n+import requests\n from djmoney.contrib.exchange.backends.base import SimpleExchangeBackend\n \n from common.settings import currency_code_default, currency_codes\n@@ -15,19 +14,19 @@\n class InvenTreeExchange(SimpleExchangeBackend):\n \"\"\"Backend for automatically updating currency exchange rates.\n \n- Uses the `exchangerate.host` service API\n+ Uses the `frankfurter.app` service API\n \"\"\"\n \n name = \"InvenTreeExchange\"\n \n def __init__(self):\n \"\"\"Set API url.\"\"\"\n- self.url = \"https://api.exchangerate.host/latest\"\n+ self.url = \"https://api.frankfurter.app/latest\"\n \n super().__init__()\n \n def get_params(self):\n- \"\"\"Placeholder to set API key. Currently not required by `exchangerate.host`.\"\"\"\n+ \"\"\"Placeholder to set API key. Currently not required by `frankfurter.app`.\"\"\"\n # No API key is required\n return {\n }\n@@ -40,14 +39,22 @@\n url = self.get_url(**kwargs)\n \n try:\n- context = ssl.create_default_context(cafile=certifi.where())\n- response = urlopen(url, timeout=5, context=context)\n- return response.read()\n+ response = requests.get(url=url, timeout=5)\n+ return response.content\n except Exception:\n # Something has gone wrong, but we can just try again next time\n # Raise a TypeError so the outer function can handle this\n raise TypeError\n \n+ def get_rates(self, **params):\n+ \"\"\"Intersect the requested currency codes with the available codes.\"\"\"\n+ rates = super().get_rates(**params)\n+\n+ # Add the base currency to the rates\n+ rates[params[\"base_currency\"]] = Decimal(\"1.0\")\n+\n+ return rates\n+\n def update_rates(self, base_currency=None):\n \"\"\"Set the requested currency codes and get rates.\"\"\"\n # Set default - see B008\n", "issue": "[BUG] Exchange rate provider is closed now\n### Please verify that this bug has NOT been raised before.\n\n- [X] I checked and didn't find a similar issue\n\n### Describe the bug*\n\nOur current default exchange rate provider is closed now - and the change was not smooth either. See https://github.com/Formicka/exchangerate.host/issues/236#issuecomment-1738539199\r\n\r\nWe need to:\r\n1) Disable the CI checks for now\r\n2) Implement an alternative\r\n3) (Optional) Bring down ApiLayer once and for all before they close all APIs we need\n\n### Steps to Reproduce\n\nLook at any current [CI](https://github.com/inventree/InvenTree/actions/runs/6333198194/job/17202067465?pr=5582)\n\n### Expected behaviour\n\nUpdating exchange rates\n\n### Deployment Method\n\n- [X] Docker\n- [X] Bare metal\n\n### Version Information\n\nEvery version>0.6.0 and a couble before are probably effected.\n\n### Please verify if you can reproduce this bug on the demo site.\n\n- [X] I can reproduce this bug on the demo site.\n\n### Relevant log output\n\n_No response_\n", "before_files": [{"content": "\"\"\"Exchangerate backend to use `exchangerate.host` to get rates.\"\"\"\n\nimport ssl\nfrom urllib.error import URLError\nfrom urllib.request import urlopen\n\nfrom django.db.utils import OperationalError\n\nimport certifi\nfrom djmoney.contrib.exchange.backends.base import SimpleExchangeBackend\n\nfrom common.settings import currency_code_default, currency_codes\n\n\nclass InvenTreeExchange(SimpleExchangeBackend):\n \"\"\"Backend for automatically updating currency exchange rates.\n\n Uses the `exchangerate.host` service API\n \"\"\"\n\n name = \"InvenTreeExchange\"\n\n def __init__(self):\n \"\"\"Set API url.\"\"\"\n self.url = \"https://api.exchangerate.host/latest\"\n\n super().__init__()\n\n def get_params(self):\n \"\"\"Placeholder to set API key. Currently not required by `exchangerate.host`.\"\"\"\n # No API key is required\n return {\n }\n\n def get_response(self, **kwargs):\n \"\"\"Custom code to get response from server.\n\n Note: Adds a 5-second timeout\n \"\"\"\n url = self.get_url(**kwargs)\n\n try:\n context = ssl.create_default_context(cafile=certifi.where())\n response = urlopen(url, timeout=5, context=context)\n return response.read()\n except Exception:\n # Something has gone wrong, but we can just try again next time\n # Raise a TypeError so the outer function can handle this\n raise TypeError\n\n def update_rates(self, base_currency=None):\n \"\"\"Set the requested currency codes and get rates.\"\"\"\n # Set default - see B008\n if base_currency is None:\n base_currency = currency_code_default()\n\n symbols = ','.join(currency_codes())\n\n try:\n super().update_rates(base=base_currency, symbols=symbols)\n # catch connection errors\n except URLError:\n print('Encountered connection error while updating')\n except TypeError:\n print('Exchange returned invalid response')\n except OperationalError as e:\n if 'SerializationFailure' in e.__cause__.__class__.__name__:\n print('Serialization Failure while updating exchange rates')\n # We are just going to swallow this exception because the\n # exchange rates will be updated later by the scheduled task\n else:\n # Other operational errors probably are still show stoppers\n # so reraise them so that the log contains the stacktrace\n raise\n", "path": "InvenTree/InvenTree/exchange.py"}], "after_files": [{"content": "\"\"\"Exchangerate backend to use `frankfurter.app` to get rates.\"\"\"\n\nfrom decimal import Decimal\nfrom urllib.error import URLError\n\nfrom django.db.utils import OperationalError\n\nimport requests\nfrom djmoney.contrib.exchange.backends.base import SimpleExchangeBackend\n\nfrom common.settings import currency_code_default, currency_codes\n\n\nclass InvenTreeExchange(SimpleExchangeBackend):\n \"\"\"Backend for automatically updating currency exchange rates.\n\n Uses the `frankfurter.app` service API\n \"\"\"\n\n name = \"InvenTreeExchange\"\n\n def __init__(self):\n \"\"\"Set API url.\"\"\"\n self.url = \"https://api.frankfurter.app/latest\"\n\n super().__init__()\n\n def get_params(self):\n \"\"\"Placeholder to set API key. Currently not required by `frankfurter.app`.\"\"\"\n # No API key is required\n return {\n }\n\n def get_response(self, **kwargs):\n \"\"\"Custom code to get response from server.\n\n Note: Adds a 5-second timeout\n \"\"\"\n url = self.get_url(**kwargs)\n\n try:\n response = requests.get(url=url, timeout=5)\n return response.content\n except Exception:\n # Something has gone wrong, but we can just try again next time\n # Raise a TypeError so the outer function can handle this\n raise TypeError\n\n def get_rates(self, **params):\n \"\"\"Intersect the requested currency codes with the available codes.\"\"\"\n rates = super().get_rates(**params)\n\n # Add the base currency to the rates\n rates[params[\"base_currency\"]] = Decimal(\"1.0\")\n\n return rates\n\n def update_rates(self, base_currency=None):\n \"\"\"Set the requested currency codes and get rates.\"\"\"\n # Set default - see B008\n if base_currency is None:\n base_currency = currency_code_default()\n\n symbols = ','.join(currency_codes())\n\n try:\n super().update_rates(base=base_currency, symbols=symbols)\n # catch connection errors\n except URLError:\n print('Encountered connection error while updating')\n except TypeError:\n print('Exchange returned invalid response')\n except OperationalError as e:\n if 'SerializationFailure' in e.__cause__.__class__.__name__:\n print('Serialization Failure while updating exchange rates')\n # We are just going to swallow this exception because the\n # exchange rates will be updated later by the scheduled task\n else:\n # Other operational errors probably are still show stoppers\n # so reraise them so that the log contains the stacktrace\n raise\n", "path": "InvenTree/InvenTree/exchange.py"}]}
| 1,188 | 575 |
gh_patches_debug_31374
|
rasdani/github-patches
|
git_diff
|
pyjanitor-devs__pyjanitor-746
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[DOC] Update docs to have timeseries section
# Brief Description of Fix
<!-- Please describe the fix in terms of a "before" and "after". In other words, what's not so good about the current docs
page, and what you would like to see it become.
Example starter wording is provided. -->
Currently, the docs do not have a section for the timeseries module.
I would like to propose a change, such that now the docs will have details on the timerseries functions.
# Relevant Context
<!-- Please put here, in bullet points, links to the relevant docs page. A few starting template points are available
to get you started. -->
- [Link to documentation page](https://ericmjl.github.io/pyjanitor/reference/index.html)
- [Link to exact file to be edited](https://github.com/ericmjl/pyjanitor/blob/dev/docs/reference/index.rst)
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `janitor/timeseries.py`
Content:
```
1 """
2 Time series-specific data testing and cleaning functions.
3 """
4
5 import pandas as pd
6 import pandas_flavor as pf
7
8 from janitor import check
9
10
11 @pf.register_dataframe_method
12 def fill_missing_timestamps(
13 df: pd.DataFrame,
14 frequency: str,
15 first_time_stamp: pd.Timestamp = None,
16 last_time_stamp: pd.Timestamp = None,
17 ) -> pd.DataFrame:
18 """
19 Fill dataframe with missing timestamps based on a defined frequency.
20
21 If timestamps are missing,
22 this function will reindex the dataframe.
23 If timestamps are not missing,
24 then the function will return the dataframe unmodified.
25 Example usage:
26 .. code-block:: python
27
28 df = (
29 pd.DataFrame(...)
30 .fill_missing_timestamps(frequency="1H")
31 )
32
33 :param df: Dataframe which needs to be tested for missing timestamps
34 :param frequency: frequency i.e. sampling frequency of the data.
35 Acceptable frequency strings are available
36 `here <https://pandas.pydata.org/pandas-docs/stable/>`_
37 Check offset aliases under time series in user guide
38 :param first_time_stamp: timestamp expected to start from
39 Defaults to None.
40 If no input is provided assumes the minimum value in time_series
41 :param last_time_stamp: timestamp expected to end with.
42 Defaults to None.
43 If no input is provided, assumes the maximum value in time_series
44 :returns: dataframe that has a complete set of contiguous datetimes.
45 """
46 # Check all the inputs are the correct data type
47 check("frequency", frequency, [str])
48 check("first_time_stamp", first_time_stamp, [pd.Timestamp, type(None)])
49 check("last_time_stamp", last_time_stamp, [pd.Timestamp, type(None)])
50
51 if first_time_stamp is None:
52 first_time_stamp = df.index.min()
53 if last_time_stamp is None:
54 last_time_stamp = df.index.max()
55
56 # Generate expected timestamps
57 expected_timestamps = pd.date_range(
58 start=first_time_stamp, end=last_time_stamp, freq=frequency
59 )
60
61 return df.reindex(expected_timestamps)
62
63
64 def _get_missing_timestamps(
65 df: pd.DataFrame,
66 frequency: str,
67 first_time_stamp: pd.Timestamp = None,
68 last_time_stamp: pd.Timestamp = None,
69 ) -> pd.DataFrame:
70 """
71 Return the timestamps that are missing in a dataframe.
72
73 This function takes in a dataframe,
74 and checks its index against a dataframe
75 that contains the expected timestamps.
76 Here, we assume that the expected timestamps
77 are going to be of a larger size
78 than the timestamps available in the input dataframe ``df``.
79
80 If there are any missing timestamps in the input dataframe,
81 this function will return those missing timestamps
82 from the expected dataframe.
83 """
84 expected_df = df.fill_missing_timestamps(
85 frequency, first_time_stamp, last_time_stamp
86 )
87
88 missing_timestamps = expected_df.index.difference(df.index)
89
90 return expected_df.loc[missing_timestamps]
91
92
93 @pf.register_dataframe_method
94 def sort_timestamps_monotonically(
95 df: pd.DataFrame, direction: str = "increasing", strict: bool = False
96 ) -> pd.DataFrame:
97 """
98 Sort dataframe such that index is monotonic.
99
100 If timestamps are monotonic,
101 this function will return the dataframe unmodified.
102 If timestamps are not monotonic,
103 then the function will sort the dataframe.
104
105 Example usage:
106
107 .. code-block:: python
108
109 df = (
110 pd.DataFrame(...)
111 .sort_timestamps_monotonically(direction='increasing')
112 )
113
114 :param df: Dataframe which needs to be tested for monotonicity
115 :param direction: type of monotonicity desired.
116 Acceptable arguments are:
117 1. increasing
118 2. decreasing
119 :param strict: flag to enable/disable strict monotonicity.
120 If set to True,
121 will remove duplicates in the index,
122 by retaining first occurrence of value in index.
123 If set to False,
124 will not test for duplicates in the index.
125 Defaults to False.
126 :returns: Dataframe that has monotonically increasing
127 (or decreasing) timestamps.
128 """
129 # Check all the inputs are the correct data type
130 check("df", df, [pd.DataFrame])
131 check("direction", direction, [str])
132 check("strict", strict, [bool])
133
134 # Remove duplicates if requested
135 if strict:
136 df = df[~df.index.duplicated(keep="first")]
137
138 # Sort timestamps
139 if direction == "increasing":
140 df = df.sort_index()
141 else:
142 df = df.sort_index(ascending=False)
143
144 # Return the dataframe
145 return df
146
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/janitor/timeseries.py b/janitor/timeseries.py
--- a/janitor/timeseries.py
+++ b/janitor/timeseries.py
@@ -1,6 +1,4 @@
-"""
-Time series-specific data testing and cleaning functions.
-"""
+""" Time series-specific data cleaning functions. """
import pandas as pd
import pandas_flavor as pf
@@ -22,9 +20,28 @@
this function will reindex the dataframe.
If timestamps are not missing,
then the function will return the dataframe unmodified.
- Example usage:
+
+ Functional usage example:
+
+ .. code-block:: python
+
+ import pandas as pd
+ import janitor.timeseries
+
+ df = pd.DataFrame(...)
+
+ df = janitor.timeseries.fill_missing_timestamps(
+ df=df,
+ frequency="1H",
+ )
+
+ Method chaining example:
+
.. code-block:: python
+ import pandas as pd
+ import janitor.timeseries
+
df = (
pd.DataFrame(...)
.fill_missing_timestamps(frequency="1H")
@@ -102,13 +119,29 @@
If timestamps are not monotonic,
then the function will sort the dataframe.
- Example usage:
+ Functional usage example:
.. code-block:: python
+ import pandas as pd
+ import janitor.timeseries
+
+ df = pd.DataFrame(...)
+
+ df = janitor.timeseries.sort_timestamps_monotonically(
+ direction="increasing"
+ )
+
+ Method chaining example:
+
+ .. code-block:: python
+
+ import pandas as pd
+ import janitor.timeseries
+
df = (
pd.DataFrame(...)
- .sort_timestamps_monotonically(direction='increasing')
+ .sort_timestamps_monotonically(direction="increasing")
)
:param df: Dataframe which needs to be tested for monotonicity
|
{"golden_diff": "diff --git a/janitor/timeseries.py b/janitor/timeseries.py\n--- a/janitor/timeseries.py\n+++ b/janitor/timeseries.py\n@@ -1,6 +1,4 @@\n-\"\"\"\n-Time series-specific data testing and cleaning functions.\n-\"\"\"\n+\"\"\" Time series-specific data cleaning functions. \"\"\"\n \n import pandas as pd\n import pandas_flavor as pf\n@@ -22,9 +20,28 @@\n this function will reindex the dataframe.\n If timestamps are not missing,\n then the function will return the dataframe unmodified.\n- Example usage:\n+\n+ Functional usage example:\n+\n+ .. code-block:: python\n+\n+ import pandas as pd\n+ import janitor.timeseries\n+\n+ df = pd.DataFrame(...)\n+\n+ df = janitor.timeseries.fill_missing_timestamps(\n+ df=df,\n+ frequency=\"1H\",\n+ )\n+\n+ Method chaining example:\n+\n .. code-block:: python\n \n+ import pandas as pd\n+ import janitor.timeseries\n+\n df = (\n pd.DataFrame(...)\n .fill_missing_timestamps(frequency=\"1H\")\n@@ -102,13 +119,29 @@\n If timestamps are not monotonic,\n then the function will sort the dataframe.\n \n- Example usage:\n+ Functional usage example:\n \n .. code-block:: python\n \n+ import pandas as pd\n+ import janitor.timeseries\n+\n+ df = pd.DataFrame(...)\n+\n+ df = janitor.timeseries.sort_timestamps_monotonically(\n+ direction=\"increasing\"\n+ )\n+\n+ Method chaining example:\n+\n+ .. code-block:: python\n+\n+ import pandas as pd\n+ import janitor.timeseries\n+\n df = (\n pd.DataFrame(...)\n- .sort_timestamps_monotonically(direction='increasing')\n+ .sort_timestamps_monotonically(direction=\"increasing\")\n )\n \n :param df: Dataframe which needs to be tested for monotonicity\n", "issue": "[DOC] Update docs to have timeseries section\n# Brief Description of Fix\r\n\r\n<!-- Please describe the fix in terms of a \"before\" and \"after\". In other words, what's not so good about the current docs\r\npage, and what you would like to see it become.\r\n\r\nExample starter wording is provided. -->\r\n\r\nCurrently, the docs do not have a section for the timeseries module.\r\n\r\nI would like to propose a change, such that now the docs will have details on the timerseries functions.\r\n\r\n# Relevant Context\r\n\r\n<!-- Please put here, in bullet points, links to the relevant docs page. A few starting template points are available\r\nto get you started. -->\r\n\r\n- [Link to documentation page](https://ericmjl.github.io/pyjanitor/reference/index.html)\r\n- [Link to exact file to be edited](https://github.com/ericmjl/pyjanitor/blob/dev/docs/reference/index.rst)\r\n\n", "before_files": [{"content": "\"\"\"\nTime series-specific data testing and cleaning functions.\n\"\"\"\n\nimport pandas as pd\nimport pandas_flavor as pf\n\nfrom janitor import check\n\n\[email protected]_dataframe_method\ndef fill_missing_timestamps(\n df: pd.DataFrame,\n frequency: str,\n first_time_stamp: pd.Timestamp = None,\n last_time_stamp: pd.Timestamp = None,\n) -> pd.DataFrame:\n \"\"\"\n Fill dataframe with missing timestamps based on a defined frequency.\n\n If timestamps are missing,\n this function will reindex the dataframe.\n If timestamps are not missing,\n then the function will return the dataframe unmodified.\n Example usage:\n .. code-block:: python\n\n df = (\n pd.DataFrame(...)\n .fill_missing_timestamps(frequency=\"1H\")\n )\n\n :param df: Dataframe which needs to be tested for missing timestamps\n :param frequency: frequency i.e. sampling frequency of the data.\n Acceptable frequency strings are available\n `here <https://pandas.pydata.org/pandas-docs/stable/>`_\n Check offset aliases under time series in user guide\n :param first_time_stamp: timestamp expected to start from\n Defaults to None.\n If no input is provided assumes the minimum value in time_series\n :param last_time_stamp: timestamp expected to end with.\n Defaults to None.\n If no input is provided, assumes the maximum value in time_series\n :returns: dataframe that has a complete set of contiguous datetimes.\n \"\"\"\n # Check all the inputs are the correct data type\n check(\"frequency\", frequency, [str])\n check(\"first_time_stamp\", first_time_stamp, [pd.Timestamp, type(None)])\n check(\"last_time_stamp\", last_time_stamp, [pd.Timestamp, type(None)])\n\n if first_time_stamp is None:\n first_time_stamp = df.index.min()\n if last_time_stamp is None:\n last_time_stamp = df.index.max()\n\n # Generate expected timestamps\n expected_timestamps = pd.date_range(\n start=first_time_stamp, end=last_time_stamp, freq=frequency\n )\n\n return df.reindex(expected_timestamps)\n\n\ndef _get_missing_timestamps(\n df: pd.DataFrame,\n frequency: str,\n first_time_stamp: pd.Timestamp = None,\n last_time_stamp: pd.Timestamp = None,\n) -> pd.DataFrame:\n \"\"\"\n Return the timestamps that are missing in a dataframe.\n\n This function takes in a dataframe,\n and checks its index against a dataframe\n that contains the expected timestamps.\n Here, we assume that the expected timestamps\n are going to be of a larger size\n than the timestamps available in the input dataframe ``df``.\n\n If there are any missing timestamps in the input dataframe,\n this function will return those missing timestamps\n from the expected dataframe.\n \"\"\"\n expected_df = df.fill_missing_timestamps(\n frequency, first_time_stamp, last_time_stamp\n )\n\n missing_timestamps = expected_df.index.difference(df.index)\n\n return expected_df.loc[missing_timestamps]\n\n\[email protected]_dataframe_method\ndef sort_timestamps_monotonically(\n df: pd.DataFrame, direction: str = \"increasing\", strict: bool = False\n) -> pd.DataFrame:\n \"\"\"\n Sort dataframe such that index is monotonic.\n\n If timestamps are monotonic,\n this function will return the dataframe unmodified.\n If timestamps are not monotonic,\n then the function will sort the dataframe.\n\n Example usage:\n\n .. code-block:: python\n\n df = (\n pd.DataFrame(...)\n .sort_timestamps_monotonically(direction='increasing')\n )\n\n :param df: Dataframe which needs to be tested for monotonicity\n :param direction: type of monotonicity desired.\n Acceptable arguments are:\n 1. increasing\n 2. decreasing\n :param strict: flag to enable/disable strict monotonicity.\n If set to True,\n will remove duplicates in the index,\n by retaining first occurrence of value in index.\n If set to False,\n will not test for duplicates in the index.\n Defaults to False.\n :returns: Dataframe that has monotonically increasing\n (or decreasing) timestamps.\n \"\"\"\n # Check all the inputs are the correct data type\n check(\"df\", df, [pd.DataFrame])\n check(\"direction\", direction, [str])\n check(\"strict\", strict, [bool])\n\n # Remove duplicates if requested\n if strict:\n df = df[~df.index.duplicated(keep=\"first\")]\n\n # Sort timestamps\n if direction == \"increasing\":\n df = df.sort_index()\n else:\n df = df.sort_index(ascending=False)\n\n # Return the dataframe\n return df\n", "path": "janitor/timeseries.py"}], "after_files": [{"content": "\"\"\" Time series-specific data cleaning functions. \"\"\"\n\nimport pandas as pd\nimport pandas_flavor as pf\n\nfrom janitor import check\n\n\[email protected]_dataframe_method\ndef fill_missing_timestamps(\n df: pd.DataFrame,\n frequency: str,\n first_time_stamp: pd.Timestamp = None,\n last_time_stamp: pd.Timestamp = None,\n) -> pd.DataFrame:\n \"\"\"\n Fill dataframe with missing timestamps based on a defined frequency.\n\n If timestamps are missing,\n this function will reindex the dataframe.\n If timestamps are not missing,\n then the function will return the dataframe unmodified.\n\n Functional usage example:\n\n .. code-block:: python\n\n import pandas as pd\n import janitor.timeseries\n\n df = pd.DataFrame(...)\n\n df = janitor.timeseries.fill_missing_timestamps(\n df=df,\n frequency=\"1H\",\n )\n\n Method chaining example:\n\n .. code-block:: python\n\n import pandas as pd\n import janitor.timeseries\n\n df = (\n pd.DataFrame(...)\n .fill_missing_timestamps(frequency=\"1H\")\n )\n\n :param df: Dataframe which needs to be tested for missing timestamps\n :param frequency: frequency i.e. sampling frequency of the data.\n Acceptable frequency strings are available\n `here <https://pandas.pydata.org/pandas-docs/stable/>`_\n Check offset aliases under time series in user guide\n :param first_time_stamp: timestamp expected to start from\n Defaults to None.\n If no input is provided assumes the minimum value in time_series\n :param last_time_stamp: timestamp expected to end with.\n Defaults to None.\n If no input is provided, assumes the maximum value in time_series\n :returns: dataframe that has a complete set of contiguous datetimes.\n \"\"\"\n # Check all the inputs are the correct data type\n check(\"frequency\", frequency, [str])\n check(\"first_time_stamp\", first_time_stamp, [pd.Timestamp, type(None)])\n check(\"last_time_stamp\", last_time_stamp, [pd.Timestamp, type(None)])\n\n if first_time_stamp is None:\n first_time_stamp = df.index.min()\n if last_time_stamp is None:\n last_time_stamp = df.index.max()\n\n # Generate expected timestamps\n expected_timestamps = pd.date_range(\n start=first_time_stamp, end=last_time_stamp, freq=frequency\n )\n\n return df.reindex(expected_timestamps)\n\n\ndef _get_missing_timestamps(\n df: pd.DataFrame,\n frequency: str,\n first_time_stamp: pd.Timestamp = None,\n last_time_stamp: pd.Timestamp = None,\n) -> pd.DataFrame:\n \"\"\"\n Return the timestamps that are missing in a dataframe.\n\n This function takes in a dataframe,\n and checks its index against a dataframe\n that contains the expected timestamps.\n Here, we assume that the expected timestamps\n are going to be of a larger size\n than the timestamps available in the input dataframe ``df``.\n\n If there are any missing timestamps in the input dataframe,\n this function will return those missing timestamps\n from the expected dataframe.\n \"\"\"\n expected_df = df.fill_missing_timestamps(\n frequency, first_time_stamp, last_time_stamp\n )\n\n missing_timestamps = expected_df.index.difference(df.index)\n\n return expected_df.loc[missing_timestamps]\n\n\[email protected]_dataframe_method\ndef sort_timestamps_monotonically(\n df: pd.DataFrame, direction: str = \"increasing\", strict: bool = False\n) -> pd.DataFrame:\n \"\"\"\n Sort dataframe such that index is monotonic.\n\n If timestamps are monotonic,\n this function will return the dataframe unmodified.\n If timestamps are not monotonic,\n then the function will sort the dataframe.\n\n Functional usage example:\n\n .. code-block:: python\n\n import pandas as pd\n import janitor.timeseries\n\n df = pd.DataFrame(...)\n\n df = janitor.timeseries.sort_timestamps_monotonically(\n direction=\"increasing\"\n )\n\n Method chaining example:\n\n .. code-block:: python\n\n import pandas as pd\n import janitor.timeseries\n\n df = (\n pd.DataFrame(...)\n .sort_timestamps_monotonically(direction=\"increasing\")\n )\n\n :param df: Dataframe which needs to be tested for monotonicity\n :param direction: type of monotonicity desired.\n Acceptable arguments are:\n 1. increasing\n 2. decreasing\n :param strict: flag to enable/disable strict monotonicity.\n If set to True,\n will remove duplicates in the index,\n by retaining first occurrence of value in index.\n If set to False,\n will not test for duplicates in the index.\n Defaults to False.\n :returns: Dataframe that has monotonically increasing\n (or decreasing) timestamps.\n \"\"\"\n # Check all the inputs are the correct data type\n check(\"df\", df, [pd.DataFrame])\n check(\"direction\", direction, [str])\n check(\"strict\", strict, [bool])\n\n # Remove duplicates if requested\n if strict:\n df = df[~df.index.duplicated(keep=\"first\")]\n\n # Sort timestamps\n if direction == \"increasing\":\n df = df.sort_index()\n else:\n df = df.sort_index(ascending=False)\n\n # Return the dataframe\n return df\n", "path": "janitor/timeseries.py"}]}
| 1,796 | 442 |
gh_patches_debug_12316
|
rasdani/github-patches
|
git_diff
|
jupyterhub__zero-to-jupyterhub-k8s-1156
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
cost estimator fails to run
To reproduce:
- Launch the cost estimator on binder https://mybinder.org/v2/gh/jupyterhub/zero-to-jupyterhub-k8s/master?filepath=doc/ntbk/draw_function.ipynb
- Run the first cell
- Observe a traceback similar to the following:
```
---------------------------------------------------------------------------
AssertionError Traceback (most recent call last)
<ipython-input-1-de8d1e48d121> in <module>
----> 1 from z2jh import cost_display, disk, machines
2 machines
~/doc/ntbk/z2jh/__init__.py in <module>
1 """Helper functions to calculate cost."""
2
----> 3 from .cost import cost_display, disk
4 from .cost import machines_list as machines
~/doc/ntbk/z2jh/cost.py in <module>
39 thisrow.append(jj.text.strip())
40 rows.append(thisrow)
---> 41 df = pd.DataFrame(rows[:-1], columns=header)
42 all_dfs.append(df)
43
/srv/conda/lib/python3.6/site-packages/pandas/core/frame.py in __init__(self, data, index, columns, dtype, copy)
433 if is_named_tuple(data[0]) and columns is None:
434 columns = data[0]._fields
--> 435 arrays, columns = to_arrays(data, columns, dtype=dtype)
436 columns = ensure_index(columns)
437
/srv/conda/lib/python3.6/site-packages/pandas/core/internals/construction.py in to_arrays(data, columns, coerce_float, dtype)
402 if isinstance(data[0], (list, tuple)):
403 return _list_to_arrays(data, columns, coerce_float=coerce_float,
--> 404 dtype=dtype)
405 elif isinstance(data[0], compat.Mapping):
406 return _list_of_dict_to_arrays(data, columns,
/srv/conda/lib/python3.6/site-packages/pandas/core/internals/construction.py in _list_to_arrays(data, columns, coerce_float, dtype)
434 content = list(lib.to_object_array(data).T)
435 return _convert_object_array(content, columns, dtype=dtype,
--> 436 coerce_float=coerce_float)
437
438
/srv/conda/lib/python3.6/site-packages/pandas/core/internals/construction.py in _convert_object_array(content, columns, coerce_float, dtype)
490 raise AssertionError('{col:d} columns passed, passed data had '
491 '{con} columns'.format(col=len(columns),
--> 492 con=len(content)))
493
494 # provide soft conversion of object dtypes
AssertionError: 10 columns passed, passed data had 5 columns
```
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `doc/ntbk/z2jh/cost.py`
Content:
```
1 import numpy as np
2 from datetime import datetime as py_dtime
3 from datetime import timedelta
4 import pandas as pd
5 import requests
6 from bs4 import BeautifulSoup as bs4
7
8 from bqplot import LinearScale, Axis, Lines, Figure, DateScale
9 from bqplot.interacts import HandDraw
10 from ipywidgets import widgets
11 from IPython.display import display
12 import locale
13 import warnings
14 warnings.filterwarnings('ignore')
15 locale.setlocale(locale.LC_ALL, '')
16
17 # --- MACHINE COSTS ---
18 http = requests.get('https://cloud.google.com/compute/pricing')
19 http = bs4(http.text)
20
21 # Munge the cost data
22 all_dfs = []
23 for table in http.find_all('table'):
24 header = table.find_all('th')
25 header = [item.text for item in header]
26
27 data = table.find_all('tr')[1:]
28 rows = []
29 for ii in data:
30 thisrow = []
31 for jj in ii.find_all('td'):
32 if 'default' in jj.attrs.keys():
33 thisrow.append(jj.attrs['default'])
34 elif 'ore-hourly' in jj.attrs.keys():
35 thisrow.append(jj.attrs['ore-hourly'].strip('$'))
36 elif 'ore-monthly' in jj.attrs.keys():
37 thisrow.append(jj.attrs['ore-monthly'].strip('$'))
38 else:
39 thisrow.append(jj.text.strip())
40 rows.append(thisrow)
41 df = pd.DataFrame(rows[:-1], columns=header)
42 all_dfs.append(df)
43
44 # Pull out our reference dataframes
45 disk = [df for df in all_dfs if 'Price (per GB / month)' in df.columns][0]
46
47 machines_list = pd.concat([df for df in all_dfs if 'Machine type' in df.columns]).dropna()
48 machines_list = machines_list.drop('Preemptible price (USD)', axis=1)
49 machines_list = machines_list.rename(columns={'Price (USD)': 'Price (USD / hr)'})
50 active_machine = machines_list.iloc[0]
51
52 # Base costs, all per day
53 disk['Price (per GB / month)'] = disk['Price (per GB / month)'].astype(float)
54 cost_storage_hdd = disk[disk['Type'] == 'Standard provisioned space']['Price (per GB / month)'].values[0]
55 cost_storage_hdd /= 30. # To make it per day
56 cost_storage_ssd = disk[disk['Type'] == 'SSD provisioned space']['Price (per GB / month)'].values[0]
57 cost_storage_ssd /= 30. # To make it per day
58 storage_cost = {False: 0, 'ssd': cost_storage_ssd, 'hdd': cost_storage_hdd}
59
60 # --- WIDGET ---
61 date_start = py_dtime(2017, 1, 1, 0)
62 n_step_min = 2
63
64 def autoscale(y, window_minutes=30, user_buffer=10):
65 # Weights for the autoscaling
66 weights = np.logspace(0, 2, window_minutes)[::-1]
67 weights /= np.sum(weights)
68
69 y = np.hstack([np.zeros(window_minutes), y])
70 y_scaled = y.copy()
71 for ii in np.arange(window_minutes, len(y_scaled)):
72 window = y[ii:ii - window_minutes:-1]
73 window_mean = np.average(window, weights=weights)
74 y_scaled[ii] = window_mean + user_buffer
75 return y_scaled[window_minutes:]
76
77
78 def integrate_cost(machines, cost_per_day):
79 cost_per_minute = cost_per_day / (24. * 60. / n_step_min) # 24 hrs * 60 min / N minutes per step
80 cost = np.nansum([ii * cost_per_minute for ii in machines])
81 return cost
82
83 def calculate_machines_needed(users, mem_per_user, active_machine):
84 memory_per_machine = float(active_machine['Memory'].values[0].replace('GB', ''))
85 total_gigs_needed = [ii * mem_per_user for ii in users]
86 total_machines_needed = [int(np.ceil(ii / memory_per_machine)) for ii in total_gigs_needed]
87 return total_machines_needed
88
89 def create_date_range(n_days):
90 delta = timedelta(n_days)
91 date_stop = date_start + delta
92 date_range = pd.date_range(date_start, date_stop, freq='{}min'.format(n_step_min))
93 return date_stop, date_range
94
95
96 def cost_display(n_days=7):
97
98 users = widgets.IntText(value=8, description='Number of total users')
99 storage_per_user = widgets.IntText(value=10, description='Storage per user (GB)')
100 mem_per_user = widgets.IntText(value=2, description="RAM per user (GB)")
101 machines = widgets.Dropdown(description='Machine',
102 options=machines_list['Machine type'].values.tolist())
103 persistent = widgets.Dropdown(description="Persistent Storage?",
104 options={'HDD': 'hdd', 'SSD': 'ssd'},
105 value='hdd')
106 autoscaling = widgets.Checkbox(value=False, description='Autoscaling?')
107 text_avg_num_machine = widgets.Text(value='', description='Average # Machines:')
108 text_cost_machine = widgets.Text(value='', description='Machine Cost:')
109 text_cost_storage = widgets.Text(value='', description='Storage Cost:')
110 text_cost_total = widgets.Text(value='', description='Total Cost:')
111
112 hr = widgets.HTML(value="---")
113
114 # Define axes limits
115 y_max = 100.
116 date_stop, date_range = create_date_range(n_days)
117
118 # Create axes and extra variables for the viz
119 xs_hd = DateScale(min=date_start, max=date_stop, )
120 ys_hd = LinearScale(min=0., max=y_max)
121
122 # Shading for weekends
123 is_weekend = np.where([ii in [6, 7] for ii in date_range.dayofweek], 1, 0)
124 is_weekend = is_weekend * (float(y_max) + 50.)
125 is_weekend[is_weekend == 0] = -10
126 line_fill = Lines(x=date_range, y=is_weekend,
127 scales={'x': xs_hd, 'y': ys_hd}, colors=['black'],
128 fill_opacities=[.2], fill='bottom')
129
130 # Set up hand draw widget
131 line_hd = Lines(x=date_range, y=10 * np.ones(len(date_range)),
132 scales={'x': xs_hd, 'y': ys_hd}, colors=['#E46E2E'])
133 line_users = Lines(x=date_range, y=10 * np.ones(len(date_range)),
134 scales={'x': xs_hd, 'y': ys_hd}, colors=['#e5e5e5'])
135 line_autoscale = Lines(x=date_range, y=10 * np.ones(len(date_range)),
136 scales={'x': xs_hd, 'y': ys_hd}, colors=['#000000'])
137 handdraw = HandDraw(lines=line_hd)
138 xax = Axis(scale=xs_hd, label='Day', grid_lines='none',
139 tick_format='%b %d')
140 yax = Axis(scale=ys_hd, label='Numer of Users',
141 orientation='vertical', grid_lines='none')
142 # FIXME add `line_autoscale` when autoscale is enabled
143 fig = Figure(marks=[line_fill, line_hd, line_users],
144 axes=[xax, yax], interaction=handdraw)
145
146 def _update_cost(change):
147 # Pull values from the plot
148 max_users = max(handdraw.lines.y)
149 max_buffer = max_users * 1.05 # 5% buffer
150 line_users.y = [max_buffer] * len(handdraw.lines.y)
151 if max_users > users.value:
152 users.value = max_users
153
154 autoscaled_users = autoscale(handdraw.lines.y)
155 line_autoscale.y = autoscaled_users
156
157 # Calculate costs
158 active_machine = machines_list[machines_list['Machine type'] == machines.value]
159 machine_cost = active_machine['Price (USD / hr)'].values.astype(float) * 24 # To make it cost per day
160 users_for_cost = autoscaled_users if autoscaling.value is True else [max_buffer] * len(handdraw.lines.y)
161 num_machines = calculate_machines_needed(users_for_cost, mem_per_user.value, active_machine)
162 avg_num_machines = np.mean(num_machines)
163 cost_machine = integrate_cost(num_machines, machine_cost)
164 cost_storage = integrate_cost(num_machines, storage_cost[persistent.value] * storage_per_user.value)
165 cost_total = cost_machine + cost_storage
166
167 # Set the values
168 for iwidget, icost in [(text_cost_machine, cost_machine),
169 (text_cost_storage, cost_storage),
170 (text_cost_total, cost_total),
171 (text_avg_num_machine, avg_num_machines)]:
172 if iwidget is not text_avg_num_machine:
173 icost = locale.currency(icost, grouping=True)
174 else:
175 icost = '{:.2f}'.format(icost)
176 iwidget.value = icost
177
178 # Set the color
179 if autoscaling.value is True:
180 line_autoscale.colors = ['#000000']
181 line_users.colors = ['#e5e5e5']
182 else:
183 line_autoscale.colors = ['#e5e5e5']
184 line_users.colors = ['#000000']
185
186 line_hd.observe(_update_cost, names='y')
187 # autoscaling.observe(_update_cost) # FIXME Uncomment when we implement autoscaling
188 persistent.observe(_update_cost)
189 machines.observe(_update_cost)
190 storage_per_user.observe(_update_cost)
191 mem_per_user.observe(_update_cost)
192
193 # Show it
194 fig.title = 'Draw your usage pattern over time.'
195 # FIXME autoscaling when it's ready
196 display(users, machines, mem_per_user, storage_per_user, persistent, fig, hr,
197 text_cost_machine, text_avg_num_machine, text_cost_storage, text_cost_total)
198 return fig
199
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/doc/ntbk/z2jh/cost.py b/doc/ntbk/z2jh/cost.py
--- a/doc/ntbk/z2jh/cost.py
+++ b/doc/ntbk/z2jh/cost.py
@@ -15,16 +15,16 @@
locale.setlocale(locale.LC_ALL, '')
# --- MACHINE COSTS ---
-http = requests.get('https://cloud.google.com/compute/pricing')
-http = bs4(http.text)
+resp = requests.get('https://cloud.google.com/compute/pricing')
+html = bs4(resp.text)
# Munge the cost data
all_dfs = []
-for table in http.find_all('table'):
- header = table.find_all('th')
+for table in html.find_all('table'):
+ header = table.find('thead').find_all('th')
header = [item.text for item in header]
- data = table.find_all('tr')[1:]
+ data = table.find('tbody').find_all('tr')
rows = []
for ii in data:
thisrow = []
|
{"golden_diff": "diff --git a/doc/ntbk/z2jh/cost.py b/doc/ntbk/z2jh/cost.py\n--- a/doc/ntbk/z2jh/cost.py\n+++ b/doc/ntbk/z2jh/cost.py\n@@ -15,16 +15,16 @@\n locale.setlocale(locale.LC_ALL, '')\n \n # --- MACHINE COSTS ---\n-http = requests.get('https://cloud.google.com/compute/pricing')\n-http = bs4(http.text)\n+resp = requests.get('https://cloud.google.com/compute/pricing')\n+html = bs4(resp.text)\n \n # Munge the cost data\n all_dfs = []\n-for table in http.find_all('table'):\n- header = table.find_all('th')\n+for table in html.find_all('table'):\n+ header = table.find('thead').find_all('th')\n header = [item.text for item in header]\n \n- data = table.find_all('tr')[1:]\n+ data = table.find('tbody').find_all('tr')\n rows = []\n for ii in data:\n thisrow = []\n", "issue": "cost estimator fails to run\nTo reproduce:\r\n\r\n- Launch the cost estimator on binder https://mybinder.org/v2/gh/jupyterhub/zero-to-jupyterhub-k8s/master?filepath=doc/ntbk/draw_function.ipynb\r\n- Run the first cell\r\n- Observe a traceback similar to the following:\r\n\r\n```\r\n---------------------------------------------------------------------------\r\nAssertionError Traceback (most recent call last)\r\n<ipython-input-1-de8d1e48d121> in <module>\r\n----> 1 from z2jh import cost_display, disk, machines\r\n 2 machines\r\n\r\n~/doc/ntbk/z2jh/__init__.py in <module>\r\n 1 \"\"\"Helper functions to calculate cost.\"\"\"\r\n 2 \r\n----> 3 from .cost import cost_display, disk\r\n 4 from .cost import machines_list as machines\r\n\r\n~/doc/ntbk/z2jh/cost.py in <module>\r\n 39 thisrow.append(jj.text.strip())\r\n 40 rows.append(thisrow)\r\n---> 41 df = pd.DataFrame(rows[:-1], columns=header)\r\n 42 all_dfs.append(df)\r\n 43 \r\n\r\n/srv/conda/lib/python3.6/site-packages/pandas/core/frame.py in __init__(self, data, index, columns, dtype, copy)\r\n 433 if is_named_tuple(data[0]) and columns is None:\r\n 434 columns = data[0]._fields\r\n--> 435 arrays, columns = to_arrays(data, columns, dtype=dtype)\r\n 436 columns = ensure_index(columns)\r\n 437 \r\n\r\n/srv/conda/lib/python3.6/site-packages/pandas/core/internals/construction.py in to_arrays(data, columns, coerce_float, dtype)\r\n 402 if isinstance(data[0], (list, tuple)):\r\n 403 return _list_to_arrays(data, columns, coerce_float=coerce_float,\r\n--> 404 dtype=dtype)\r\n 405 elif isinstance(data[0], compat.Mapping):\r\n 406 return _list_of_dict_to_arrays(data, columns,\r\n\r\n/srv/conda/lib/python3.6/site-packages/pandas/core/internals/construction.py in _list_to_arrays(data, columns, coerce_float, dtype)\r\n 434 content = list(lib.to_object_array(data).T)\r\n 435 return _convert_object_array(content, columns, dtype=dtype,\r\n--> 436 coerce_float=coerce_float)\r\n 437 \r\n 438 \r\n\r\n/srv/conda/lib/python3.6/site-packages/pandas/core/internals/construction.py in _convert_object_array(content, columns, coerce_float, dtype)\r\n 490 raise AssertionError('{col:d} columns passed, passed data had '\r\n 491 '{con} columns'.format(col=len(columns),\r\n--> 492 con=len(content)))\r\n 493 \r\n 494 # provide soft conversion of object dtypes\r\n\r\nAssertionError: 10 columns passed, passed data had 5 columns\r\n```\n", "before_files": [{"content": "import numpy as np\nfrom datetime import datetime as py_dtime\nfrom datetime import timedelta\nimport pandas as pd\nimport requests\nfrom bs4 import BeautifulSoup as bs4\n\nfrom bqplot import LinearScale, Axis, Lines, Figure, DateScale\nfrom bqplot.interacts import HandDraw\nfrom ipywidgets import widgets\nfrom IPython.display import display\nimport locale\nimport warnings\nwarnings.filterwarnings('ignore')\nlocale.setlocale(locale.LC_ALL, '')\n\n# --- MACHINE COSTS ---\nhttp = requests.get('https://cloud.google.com/compute/pricing')\nhttp = bs4(http.text)\n\n# Munge the cost data\nall_dfs = []\nfor table in http.find_all('table'):\n header = table.find_all('th')\n header = [item.text for item in header]\n\n data = table.find_all('tr')[1:]\n rows = []\n for ii in data:\n thisrow = []\n for jj in ii.find_all('td'):\n if 'default' in jj.attrs.keys():\n thisrow.append(jj.attrs['default'])\n elif 'ore-hourly' in jj.attrs.keys():\n thisrow.append(jj.attrs['ore-hourly'].strip('$'))\n elif 'ore-monthly' in jj.attrs.keys():\n thisrow.append(jj.attrs['ore-monthly'].strip('$'))\n else:\n thisrow.append(jj.text.strip())\n rows.append(thisrow)\n df = pd.DataFrame(rows[:-1], columns=header)\n all_dfs.append(df)\n\n# Pull out our reference dataframes\ndisk = [df for df in all_dfs if 'Price (per GB / month)' in df.columns][0]\n\nmachines_list = pd.concat([df for df in all_dfs if 'Machine type' in df.columns]).dropna()\nmachines_list = machines_list.drop('Preemptible price (USD)', axis=1)\nmachines_list = machines_list.rename(columns={'Price (USD)': 'Price (USD / hr)'})\nactive_machine = machines_list.iloc[0]\n\n# Base costs, all per day\ndisk['Price (per GB / month)'] = disk['Price (per GB / month)'].astype(float)\ncost_storage_hdd = disk[disk['Type'] == 'Standard provisioned space']['Price (per GB / month)'].values[0]\ncost_storage_hdd /= 30. # To make it per day\ncost_storage_ssd = disk[disk['Type'] == 'SSD provisioned space']['Price (per GB / month)'].values[0]\ncost_storage_ssd /= 30. # To make it per day\nstorage_cost = {False: 0, 'ssd': cost_storage_ssd, 'hdd': cost_storage_hdd}\n\n# --- WIDGET ---\ndate_start = py_dtime(2017, 1, 1, 0)\nn_step_min = 2\n\ndef autoscale(y, window_minutes=30, user_buffer=10):\n # Weights for the autoscaling\n weights = np.logspace(0, 2, window_minutes)[::-1]\n weights /= np.sum(weights)\n\n y = np.hstack([np.zeros(window_minutes), y])\n y_scaled = y.copy()\n for ii in np.arange(window_minutes, len(y_scaled)):\n window = y[ii:ii - window_minutes:-1]\n window_mean = np.average(window, weights=weights)\n y_scaled[ii] = window_mean + user_buffer\n return y_scaled[window_minutes:]\n\n\ndef integrate_cost(machines, cost_per_day):\n cost_per_minute = cost_per_day / (24. * 60. / n_step_min) # 24 hrs * 60 min / N minutes per step\n cost = np.nansum([ii * cost_per_minute for ii in machines])\n return cost\n\ndef calculate_machines_needed(users, mem_per_user, active_machine):\n memory_per_machine = float(active_machine['Memory'].values[0].replace('GB', ''))\n total_gigs_needed = [ii * mem_per_user for ii in users]\n total_machines_needed = [int(np.ceil(ii / memory_per_machine)) for ii in total_gigs_needed]\n return total_machines_needed\n\ndef create_date_range(n_days):\n delta = timedelta(n_days)\n date_stop = date_start + delta\n date_range = pd.date_range(date_start, date_stop, freq='{}min'.format(n_step_min))\n return date_stop, date_range\n\n\ndef cost_display(n_days=7):\n\n users = widgets.IntText(value=8, description='Number of total users')\n storage_per_user = widgets.IntText(value=10, description='Storage per user (GB)')\n mem_per_user = widgets.IntText(value=2, description=\"RAM per user (GB)\")\n machines = widgets.Dropdown(description='Machine',\n options=machines_list['Machine type'].values.tolist())\n persistent = widgets.Dropdown(description=\"Persistent Storage?\",\n options={'HDD': 'hdd', 'SSD': 'ssd'},\n value='hdd')\n autoscaling = widgets.Checkbox(value=False, description='Autoscaling?')\n text_avg_num_machine = widgets.Text(value='', description='Average # Machines:')\n text_cost_machine = widgets.Text(value='', description='Machine Cost:')\n text_cost_storage = widgets.Text(value='', description='Storage Cost:')\n text_cost_total = widgets.Text(value='', description='Total Cost:')\n\n hr = widgets.HTML(value=\"---\")\n\n # Define axes limits\n y_max = 100.\n date_stop, date_range = create_date_range(n_days)\n\n # Create axes and extra variables for the viz\n xs_hd = DateScale(min=date_start, max=date_stop, )\n ys_hd = LinearScale(min=0., max=y_max)\n\n # Shading for weekends\n is_weekend = np.where([ii in [6, 7] for ii in date_range.dayofweek], 1, 0)\n is_weekend = is_weekend * (float(y_max) + 50.)\n is_weekend[is_weekend == 0] = -10\n line_fill = Lines(x=date_range, y=is_weekend,\n scales={'x': xs_hd, 'y': ys_hd}, colors=['black'],\n fill_opacities=[.2], fill='bottom')\n\n # Set up hand draw widget\n line_hd = Lines(x=date_range, y=10 * np.ones(len(date_range)),\n scales={'x': xs_hd, 'y': ys_hd}, colors=['#E46E2E'])\n line_users = Lines(x=date_range, y=10 * np.ones(len(date_range)),\n scales={'x': xs_hd, 'y': ys_hd}, colors=['#e5e5e5'])\n line_autoscale = Lines(x=date_range, y=10 * np.ones(len(date_range)),\n scales={'x': xs_hd, 'y': ys_hd}, colors=['#000000'])\n handdraw = HandDraw(lines=line_hd)\n xax = Axis(scale=xs_hd, label='Day', grid_lines='none',\n tick_format='%b %d')\n yax = Axis(scale=ys_hd, label='Numer of Users',\n orientation='vertical', grid_lines='none')\n # FIXME add `line_autoscale` when autoscale is enabled\n fig = Figure(marks=[line_fill, line_hd, line_users],\n axes=[xax, yax], interaction=handdraw)\n\n def _update_cost(change):\n # Pull values from the plot\n max_users = max(handdraw.lines.y)\n max_buffer = max_users * 1.05 # 5% buffer\n line_users.y = [max_buffer] * len(handdraw.lines.y)\n if max_users > users.value:\n users.value = max_users\n\n autoscaled_users = autoscale(handdraw.lines.y)\n line_autoscale.y = autoscaled_users\n\n # Calculate costs\n active_machine = machines_list[machines_list['Machine type'] == machines.value]\n machine_cost = active_machine['Price (USD / hr)'].values.astype(float) * 24 # To make it cost per day\n users_for_cost = autoscaled_users if autoscaling.value is True else [max_buffer] * len(handdraw.lines.y)\n num_machines = calculate_machines_needed(users_for_cost, mem_per_user.value, active_machine)\n avg_num_machines = np.mean(num_machines)\n cost_machine = integrate_cost(num_machines, machine_cost)\n cost_storage = integrate_cost(num_machines, storage_cost[persistent.value] * storage_per_user.value)\n cost_total = cost_machine + cost_storage\n\n # Set the values\n for iwidget, icost in [(text_cost_machine, cost_machine),\n (text_cost_storage, cost_storage),\n (text_cost_total, cost_total),\n (text_avg_num_machine, avg_num_machines)]:\n if iwidget is not text_avg_num_machine:\n icost = locale.currency(icost, grouping=True)\n else:\n icost = '{:.2f}'.format(icost)\n iwidget.value = icost\n\n # Set the color\n if autoscaling.value is True:\n line_autoscale.colors = ['#000000']\n line_users.colors = ['#e5e5e5']\n else:\n line_autoscale.colors = ['#e5e5e5']\n line_users.colors = ['#000000']\n\n line_hd.observe(_update_cost, names='y')\n # autoscaling.observe(_update_cost) # FIXME Uncomment when we implement autoscaling\n persistent.observe(_update_cost)\n machines.observe(_update_cost)\n storage_per_user.observe(_update_cost)\n mem_per_user.observe(_update_cost)\n\n # Show it\n fig.title = 'Draw your usage pattern over time.'\n # FIXME autoscaling when it's ready\n display(users, machines, mem_per_user, storage_per_user, persistent, fig, hr,\n text_cost_machine, text_avg_num_machine, text_cost_storage, text_cost_total)\n return fig\n", "path": "doc/ntbk/z2jh/cost.py"}], "after_files": [{"content": "import numpy as np\nfrom datetime import datetime as py_dtime\nfrom datetime import timedelta\nimport pandas as pd\nimport requests\nfrom bs4 import BeautifulSoup as bs4\n\nfrom bqplot import LinearScale, Axis, Lines, Figure, DateScale\nfrom bqplot.interacts import HandDraw\nfrom ipywidgets import widgets\nfrom IPython.display import display\nimport locale\nimport warnings\nwarnings.filterwarnings('ignore')\nlocale.setlocale(locale.LC_ALL, '')\n\n# --- MACHINE COSTS ---\nresp = requests.get('https://cloud.google.com/compute/pricing')\nhtml = bs4(resp.text)\n\n# Munge the cost data\nall_dfs = []\nfor table in html.find_all('table'):\n header = table.find('thead').find_all('th')\n header = [item.text for item in header]\n\n data = table.find('tbody').find_all('tr')\n rows = []\n for ii in data:\n thisrow = []\n for jj in ii.find_all('td'):\n if 'default' in jj.attrs.keys():\n thisrow.append(jj.attrs['default'])\n elif 'ore-hourly' in jj.attrs.keys():\n thisrow.append(jj.attrs['ore-hourly'].strip('$'))\n elif 'ore-monthly' in jj.attrs.keys():\n thisrow.append(jj.attrs['ore-monthly'].strip('$'))\n else:\n thisrow.append(jj.text.strip())\n rows.append(thisrow)\n df = pd.DataFrame(rows[:-1], columns=header)\n all_dfs.append(df)\n\n# Pull out our reference dataframes\ndisk = [df for df in all_dfs if 'Price (per GB / month)' in df.columns][0]\n\nmachines_list = pd.concat([df for df in all_dfs if 'Machine type' in df.columns]).dropna()\nmachines_list = machines_list.drop('Preemptible price (USD)', axis=1)\nmachines_list = machines_list.rename(columns={'Price (USD)': 'Price (USD / hr)'})\nactive_machine = machines_list.iloc[0]\n\n# Base costs, all per day\ndisk['Price (per GB / month)'] = disk['Price (per GB / month)'].astype(float)\ncost_storage_hdd = disk[disk['Type'] == 'Standard provisioned space']['Price (per GB / month)'].values[0]\ncost_storage_hdd /= 30. # To make it per day\ncost_storage_ssd = disk[disk['Type'] == 'SSD provisioned space']['Price (per GB / month)'].values[0]\ncost_storage_ssd /= 30. # To make it per day\nstorage_cost = {False: 0, 'ssd': cost_storage_ssd, 'hdd': cost_storage_hdd}\n\n# --- WIDGET ---\ndate_start = py_dtime(2017, 1, 1, 0)\nn_step_min = 2\n\ndef autoscale(y, window_minutes=30, user_buffer=10):\n # Weights for the autoscaling\n weights = np.logspace(0, 2, window_minutes)[::-1]\n weights /= np.sum(weights)\n\n y = np.hstack([np.zeros(window_minutes), y])\n y_scaled = y.copy()\n for ii in np.arange(window_minutes, len(y_scaled)):\n window = y[ii:ii - window_minutes:-1]\n window_mean = np.average(window, weights=weights)\n y_scaled[ii] = window_mean + user_buffer\n return y_scaled[window_minutes:]\n\n\ndef integrate_cost(machines, cost_per_day):\n cost_per_minute = cost_per_day / (24. * 60. / n_step_min) # 24 hrs * 60 min / N minutes per step\n cost = np.nansum([ii * cost_per_minute for ii in machines])\n return cost\n\ndef calculate_machines_needed(users, mem_per_user, active_machine):\n memory_per_machine = float(active_machine['Memory'].values[0].replace('GB', ''))\n total_gigs_needed = [ii * mem_per_user for ii in users]\n total_machines_needed = [int(np.ceil(ii / memory_per_machine)) for ii in total_gigs_needed]\n return total_machines_needed\n\ndef create_date_range(n_days):\n delta = timedelta(n_days)\n date_stop = date_start + delta\n date_range = pd.date_range(date_start, date_stop, freq='{}min'.format(n_step_min))\n return date_stop, date_range\n\n\ndef cost_display(n_days=7):\n\n users = widgets.IntText(value=8, description='Number of total users')\n storage_per_user = widgets.IntText(value=10, description='Storage per user (GB)')\n mem_per_user = widgets.IntText(value=2, description=\"RAM per user (GB)\")\n machines = widgets.Dropdown(description='Machine',\n options=machines_list['Machine type'].values.tolist())\n persistent = widgets.Dropdown(description=\"Persistent Storage?\",\n options={'HDD': 'hdd', 'SSD': 'ssd'},\n value='hdd')\n autoscaling = widgets.Checkbox(value=False, description='Autoscaling?')\n text_avg_num_machine = widgets.Text(value='', description='Average # Machines:')\n text_cost_machine = widgets.Text(value='', description='Machine Cost:')\n text_cost_storage = widgets.Text(value='', description='Storage Cost:')\n text_cost_total = widgets.Text(value='', description='Total Cost:')\n\n hr = widgets.HTML(value=\"---\")\n\n # Define axes limits\n y_max = 100.\n date_stop, date_range = create_date_range(n_days)\n\n # Create axes and extra variables for the viz\n xs_hd = DateScale(min=date_start, max=date_stop, )\n ys_hd = LinearScale(min=0., max=y_max)\n\n # Shading for weekends\n is_weekend = np.where([ii in [6, 7] for ii in date_range.dayofweek], 1, 0)\n is_weekend = is_weekend * (float(y_max) + 50.)\n is_weekend[is_weekend == 0] = -10\n line_fill = Lines(x=date_range, y=is_weekend,\n scales={'x': xs_hd, 'y': ys_hd}, colors=['black'],\n fill_opacities=[.2], fill='bottom')\n\n # Set up hand draw widget\n line_hd = Lines(x=date_range, y=10 * np.ones(len(date_range)),\n scales={'x': xs_hd, 'y': ys_hd}, colors=['#E46E2E'])\n line_users = Lines(x=date_range, y=10 * np.ones(len(date_range)),\n scales={'x': xs_hd, 'y': ys_hd}, colors=['#e5e5e5'])\n line_autoscale = Lines(x=date_range, y=10 * np.ones(len(date_range)),\n scales={'x': xs_hd, 'y': ys_hd}, colors=['#000000'])\n handdraw = HandDraw(lines=line_hd)\n xax = Axis(scale=xs_hd, label='Day', grid_lines='none',\n tick_format='%b %d')\n yax = Axis(scale=ys_hd, label='Numer of Users',\n orientation='vertical', grid_lines='none')\n # FIXME add `line_autoscale` when autoscale is enabled\n fig = Figure(marks=[line_fill, line_hd, line_users],\n axes=[xax, yax], interaction=handdraw)\n\n def _update_cost(change):\n # Pull values from the plot\n max_users = max(handdraw.lines.y)\n max_buffer = max_users * 1.05 # 5% buffer\n line_users.y = [max_buffer] * len(handdraw.lines.y)\n if max_users > users.value:\n users.value = max_users\n\n autoscaled_users = autoscale(handdraw.lines.y)\n line_autoscale.y = autoscaled_users\n\n # Calculate costs\n active_machine = machines_list[machines_list['Machine type'] == machines.value]\n machine_cost = active_machine['Price (USD / hr)'].values.astype(float) * 24 # To make it cost per day\n users_for_cost = autoscaled_users if autoscaling.value is True else [max_buffer] * len(handdraw.lines.y)\n num_machines = calculate_machines_needed(users_for_cost, mem_per_user.value, active_machine)\n avg_num_machines = np.mean(num_machines)\n cost_machine = integrate_cost(num_machines, machine_cost)\n cost_storage = integrate_cost(num_machines, storage_cost[persistent.value] * storage_per_user.value)\n cost_total = cost_machine + cost_storage\n\n # Set the values\n for iwidget, icost in [(text_cost_machine, cost_machine),\n (text_cost_storage, cost_storage),\n (text_cost_total, cost_total),\n (text_avg_num_machine, avg_num_machines)]:\n if iwidget is not text_avg_num_machine:\n icost = locale.currency(icost, grouping=True)\n else:\n icost = '{:.2f}'.format(icost)\n iwidget.value = icost\n\n # Set the color\n if autoscaling.value is True:\n line_autoscale.colors = ['#000000']\n line_users.colors = ['#e5e5e5']\n else:\n line_autoscale.colors = ['#e5e5e5']\n line_users.colors = ['#000000']\n\n line_hd.observe(_update_cost, names='y')\n # autoscaling.observe(_update_cost) # FIXME Uncomment when we implement autoscaling\n persistent.observe(_update_cost)\n machines.observe(_update_cost)\n storage_per_user.observe(_update_cost)\n mem_per_user.observe(_update_cost)\n\n # Show it\n fig.title = 'Draw your usage pattern over time.'\n # FIXME autoscaling when it's ready\n display(users, machines, mem_per_user, storage_per_user, persistent, fig, hr,\n text_cost_machine, text_avg_num_machine, text_cost_storage, text_cost_total)\n return fig\n", "path": "doc/ntbk/z2jh/cost.py"}]}
| 3,606 | 237 |
gh_patches_debug_9814
|
rasdani/github-patches
|
git_diff
|
facebookresearch__hydra-2613
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[Bug] The nevergrad sweeper is not properly handling quoted strings
# 🐛 Bug
## Description
The nevergrad sweeper does not properly handle quoted strings (this also manifests in other problems, e.g., with `null` values).
## Checklist
- [X] I checked on the latest version of Hydra
- [X] I created a minimal repro (See [this](https://stackoverflow.com/help/minimal-reproducible-example) for tips).
## To reproduce
** Minimal Code/Config snippet to reproduce **
```bash
python example/my_app.py -m hydra.sweeper.optim.budget=1 hydra.sweeper.optim.num_workers=1 +key="'a&b'"
```
** Stack trace/error message **
```
[2023-03-15 13:01:58,886][HYDRA] NevergradSweeper(optimizer=OnePlusOne, budget=1, num_workers=1) minimization
[2023-03-15 13:01:58,886][HYDRA] with parametrization Dict(+key=a&b,batch_size=Scalar{Cl(4,16,b),Int}[sigma=Scalar{exp=2.03}],db=Choice(choices=Tuple(mnist,cifar),indices=Array{(1,2),SoftmaxSampling}),dropout=Scalar{Cl(0,1,b)}[sigma=Scalar{exp=2.03}],lr=Log{exp=2.00}):{'db': 'mnist', 'lr': 0.020000000000000004, 'dropout': 0.5, 'batch_size': 10, '+key': 'a&b'}
[2023-03-15 13:01:58,888][HYDRA] Sweep output dir: multirun/2023-03-15/13-01-57
LexerNoViableAltException: +key=a&b
```
## Expected Behavior
It should work, passing the override `+key='a&b'` to the job being launched.
## System information
- **Hydra Version** : latest master
- **Python version** : Python 3.9
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `plugins/hydra_nevergrad_sweeper/hydra_plugins/hydra_nevergrad_sweeper/_impl.py`
Content:
```
1 # Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved
2 import logging
3 import math
4 from typing import (
5 Any,
6 Dict,
7 List,
8 MutableMapping,
9 MutableSequence,
10 Optional,
11 Tuple,
12 Union,
13 )
14
15 import nevergrad as ng
16 from hydra.core import utils
17 from hydra.core.override_parser.overrides_parser import OverridesParser
18 from hydra.core.override_parser.types import (
19 ChoiceSweep,
20 IntervalSweep,
21 Override,
22 Transformer,
23 )
24 from hydra.core.plugins import Plugins
25 from hydra.plugins.launcher import Launcher
26 from hydra.plugins.sweeper import Sweeper
27 from hydra.types import HydraContext, TaskFunction
28 from omegaconf import DictConfig, ListConfig, OmegaConf
29
30 from .config import OptimConf, ScalarConfigSpec
31
32 log = logging.getLogger(__name__)
33
34
35 def create_nevergrad_param_from_config(
36 config: Union[MutableSequence[Any], MutableMapping[str, Any]]
37 ) -> Any:
38 if isinstance(config, MutableSequence):
39 if isinstance(config, ListConfig):
40 config = OmegaConf.to_container(config, resolve=True) # type: ignore
41 return ng.p.Choice(config)
42 if isinstance(config, MutableMapping):
43 specs = ScalarConfigSpec(**config)
44 init = ["init", "lower", "upper"]
45 init_params = {x: getattr(specs, x) for x in init}
46 if not specs.log:
47 scalar = ng.p.Scalar(**init_params)
48 if specs.step is not None:
49 scalar.set_mutation(sigma=specs.step)
50 else:
51 if specs.step is not None:
52 init_params["exponent"] = specs.step
53 scalar = ng.p.Log(**init_params)
54 if specs.integer:
55 scalar.set_integer_casting()
56 return scalar
57 return config
58
59
60 def create_nevergrad_parameter_from_override(override: Override) -> Any:
61 val = override.value()
62 if not override.is_sweep_override():
63 return val
64 if override.is_choice_sweep():
65 assert isinstance(val, ChoiceSweep)
66 vals = [x for x in override.sweep_iterator(transformer=Transformer.encode)]
67 if "ordered" in val.tags:
68 return ng.p.TransitionChoice(vals)
69 else:
70 return ng.p.Choice(vals)
71 elif override.is_range_sweep():
72 vals = [x for x in override.sweep_iterator(transformer=Transformer.encode)]
73 return ng.p.Choice(vals)
74 elif override.is_interval_sweep():
75 assert isinstance(val, IntervalSweep)
76 if "log" in val.tags:
77 scalar = ng.p.Log(lower=val.start, upper=val.end)
78 else:
79 scalar = ng.p.Scalar(lower=val.start, upper=val.end) # type: ignore
80 if isinstance(val.start, int):
81 scalar.set_integer_casting()
82 return scalar
83
84
85 class NevergradSweeperImpl(Sweeper):
86 def __init__(
87 self,
88 optim: OptimConf,
89 parametrization: Optional[DictConfig],
90 ):
91 self.opt_config = optim
92 self.config: Optional[DictConfig] = None
93 self.launcher: Optional[Launcher] = None
94 self.hydra_context: Optional[HydraContext] = None
95 self.job_results = None
96 self.parametrization: Dict[str, Any] = {}
97 if parametrization is not None:
98 assert isinstance(parametrization, DictConfig)
99 self.parametrization = {
100 str(x): create_nevergrad_param_from_config(y)
101 for x, y in parametrization.items()
102 }
103 self.job_idx: Optional[int] = None
104
105 def setup(
106 self,
107 *,
108 hydra_context: HydraContext,
109 task_function: TaskFunction,
110 config: DictConfig,
111 ) -> None:
112 self.job_idx = 0
113 self.config = config
114 self.hydra_context = hydra_context
115 self.launcher = Plugins.instance().instantiate_launcher(
116 hydra_context=hydra_context, task_function=task_function, config=config
117 )
118
119 def sweep(self, arguments: List[str]) -> None:
120 assert self.config is not None
121 assert self.launcher is not None
122 assert self.job_idx is not None
123 direction = -1 if self.opt_config.maximize else 1
124 name = "maximization" if self.opt_config.maximize else "minimization"
125 # Override the parametrization from commandline
126 params = dict(self.parametrization)
127
128 parser = OverridesParser.create()
129 parsed = parser.parse_overrides(arguments)
130
131 for override in parsed:
132 params[
133 override.get_key_element()
134 ] = create_nevergrad_parameter_from_override(override)
135
136 parametrization = ng.p.Dict(**params)
137 parametrization.function.deterministic = not self.opt_config.noisy
138 parametrization.random_state.seed(self.opt_config.seed)
139 # log and build the optimizer
140 opt = self.opt_config.optimizer
141 remaining_budget = self.opt_config.budget
142 nw = self.opt_config.num_workers
143 log.info(
144 f"NevergradSweeper(optimizer={opt}, budget={remaining_budget}, "
145 f"num_workers={nw}) {name}"
146 )
147 log.info(f"with parametrization {parametrization}")
148 log.info(f"Sweep output dir: {self.config.hydra.sweep.dir}")
149 optimizer = ng.optimizers.registry[opt](parametrization, remaining_budget, nw)
150 # loop!
151 all_returns: List[Any] = []
152 best: Tuple[float, ng.p.Parameter] = (float("inf"), parametrization)
153 while remaining_budget > 0:
154 batch = min(nw, remaining_budget)
155 remaining_budget -= batch
156 candidates = [optimizer.ask() for _ in range(batch)]
157 overrides = list(
158 tuple(f"{x}={y}" for x, y in c.value.items()) for c in candidates
159 )
160 self.validate_batch_is_legal(overrides)
161 returns = self.launcher.launch(overrides, initial_job_idx=self.job_idx)
162 # would have been nice to avoid waiting for all jobs to finish
163 # aka batch size Vs steady state (launching a new job whenever one is done)
164 self.job_idx += len(returns)
165 # check job status and prepare losses
166 failures = 0
167 for cand, ret in zip(candidates, returns):
168 if ret.status == utils.JobStatus.COMPLETED:
169 rectified_loss = direction * ret.return_value
170 else:
171 rectified_loss = math.inf
172 failures += 1
173 try:
174 ret.return_value
175 except Exception as e:
176 log.warning(f"Returning infinity for failed experiment: {e}")
177 optimizer.tell(cand, rectified_loss)
178 if rectified_loss < best[0]:
179 best = (rectified_loss, cand)
180 # raise if too many failures
181 if failures / len(returns) > self.opt_config.max_failure_rate:
182 log.error(
183 f"Failed {failures} times out of {len(returns)} "
184 f"with max_failure_rate={self.opt_config.max_failure_rate}"
185 )
186 for ret in returns:
187 ret.return_value # delegate raising to JobReturn, with actual traceback
188 all_returns.extend(returns)
189 recom = optimizer.provide_recommendation()
190 results_to_serialize = {
191 "name": "nevergrad",
192 "best_evaluated_params": best[1].value,
193 "best_evaluated_result": direction * best[0],
194 }
195 OmegaConf.save(
196 OmegaConf.create(results_to_serialize),
197 f"{self.config.hydra.sweep.dir}/optimization_results.yaml",
198 )
199 log.info(
200 "Best parameters: %s", " ".join(f"{x}={y}" for x, y in recom.value.items())
201 )
202
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/plugins/hydra_nevergrad_sweeper/hydra_plugins/hydra_nevergrad_sweeper/_impl.py b/plugins/hydra_nevergrad_sweeper/hydra_plugins/hydra_nevergrad_sweeper/_impl.py
--- a/plugins/hydra_nevergrad_sweeper/hydra_plugins/hydra_nevergrad_sweeper/_impl.py
+++ b/plugins/hydra_nevergrad_sweeper/hydra_plugins/hydra_nevergrad_sweeper/_impl.py
@@ -60,7 +60,7 @@
def create_nevergrad_parameter_from_override(override: Override) -> Any:
val = override.value()
if not override.is_sweep_override():
- return val
+ return override.get_value_element_as_str()
if override.is_choice_sweep():
assert isinstance(val, ChoiceSweep)
vals = [x for x in override.sweep_iterator(transformer=Transformer.encode)]
|
{"golden_diff": "diff --git a/plugins/hydra_nevergrad_sweeper/hydra_plugins/hydra_nevergrad_sweeper/_impl.py b/plugins/hydra_nevergrad_sweeper/hydra_plugins/hydra_nevergrad_sweeper/_impl.py\n--- a/plugins/hydra_nevergrad_sweeper/hydra_plugins/hydra_nevergrad_sweeper/_impl.py\n+++ b/plugins/hydra_nevergrad_sweeper/hydra_plugins/hydra_nevergrad_sweeper/_impl.py\n@@ -60,7 +60,7 @@\n def create_nevergrad_parameter_from_override(override: Override) -> Any:\n val = override.value()\n if not override.is_sweep_override():\n- return val\n+ return override.get_value_element_as_str()\n if override.is_choice_sweep():\n assert isinstance(val, ChoiceSweep)\n vals = [x for x in override.sweep_iterator(transformer=Transformer.encode)]\n", "issue": "[Bug] The nevergrad sweeper is not properly handling quoted strings\n# \ud83d\udc1b Bug\r\n## Description\r\n\r\nThe nevergrad sweeper does not properly handle quoted strings (this also manifests in other problems, e.g., with `null` values).\r\n\r\n\r\n## Checklist\r\n- [X] I checked on the latest version of Hydra\r\n- [X] I created a minimal repro (See [this](https://stackoverflow.com/help/minimal-reproducible-example) for tips).\r\n\r\n## To reproduce\r\n\r\n** Minimal Code/Config snippet to reproduce **\r\n\r\n```bash\r\npython example/my_app.py -m hydra.sweeper.optim.budget=1 hydra.sweeper.optim.num_workers=1 +key=\"'a&b'\"\r\n```\r\n\r\n** Stack trace/error message **\r\n```\r\n[2023-03-15 13:01:58,886][HYDRA] NevergradSweeper(optimizer=OnePlusOne, budget=1, num_workers=1) minimization\r\n[2023-03-15 13:01:58,886][HYDRA] with parametrization Dict(+key=a&b,batch_size=Scalar{Cl(4,16,b),Int}[sigma=Scalar{exp=2.03}],db=Choice(choices=Tuple(mnist,cifar),indices=Array{(1,2),SoftmaxSampling}),dropout=Scalar{Cl(0,1,b)}[sigma=Scalar{exp=2.03}],lr=Log{exp=2.00}):{'db': 'mnist', 'lr': 0.020000000000000004, 'dropout': 0.5, 'batch_size': 10, '+key': 'a&b'}\r\n[2023-03-15 13:01:58,888][HYDRA] Sweep output dir: multirun/2023-03-15/13-01-57\r\nLexerNoViableAltException: +key=a&b\r\n```\r\n\r\n## Expected Behavior\r\nIt should work, passing the override `+key='a&b'` to the job being launched.\r\n\r\n## System information\r\n- **Hydra Version** : latest master\r\n- **Python version** : Python 3.9\n", "before_files": [{"content": "# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved\nimport logging\nimport math\nfrom typing import (\n Any,\n Dict,\n List,\n MutableMapping,\n MutableSequence,\n Optional,\n Tuple,\n Union,\n)\n\nimport nevergrad as ng\nfrom hydra.core import utils\nfrom hydra.core.override_parser.overrides_parser import OverridesParser\nfrom hydra.core.override_parser.types import (\n ChoiceSweep,\n IntervalSweep,\n Override,\n Transformer,\n)\nfrom hydra.core.plugins import Plugins\nfrom hydra.plugins.launcher import Launcher\nfrom hydra.plugins.sweeper import Sweeper\nfrom hydra.types import HydraContext, TaskFunction\nfrom omegaconf import DictConfig, ListConfig, OmegaConf\n\nfrom .config import OptimConf, ScalarConfigSpec\n\nlog = logging.getLogger(__name__)\n\n\ndef create_nevergrad_param_from_config(\n config: Union[MutableSequence[Any], MutableMapping[str, Any]]\n) -> Any:\n if isinstance(config, MutableSequence):\n if isinstance(config, ListConfig):\n config = OmegaConf.to_container(config, resolve=True) # type: ignore\n return ng.p.Choice(config)\n if isinstance(config, MutableMapping):\n specs = ScalarConfigSpec(**config)\n init = [\"init\", \"lower\", \"upper\"]\n init_params = {x: getattr(specs, x) for x in init}\n if not specs.log:\n scalar = ng.p.Scalar(**init_params)\n if specs.step is not None:\n scalar.set_mutation(sigma=specs.step)\n else:\n if specs.step is not None:\n init_params[\"exponent\"] = specs.step\n scalar = ng.p.Log(**init_params)\n if specs.integer:\n scalar.set_integer_casting()\n return scalar\n return config\n\n\ndef create_nevergrad_parameter_from_override(override: Override) -> Any:\n val = override.value()\n if not override.is_sweep_override():\n return val\n if override.is_choice_sweep():\n assert isinstance(val, ChoiceSweep)\n vals = [x for x in override.sweep_iterator(transformer=Transformer.encode)]\n if \"ordered\" in val.tags:\n return ng.p.TransitionChoice(vals)\n else:\n return ng.p.Choice(vals)\n elif override.is_range_sweep():\n vals = [x for x in override.sweep_iterator(transformer=Transformer.encode)]\n return ng.p.Choice(vals)\n elif override.is_interval_sweep():\n assert isinstance(val, IntervalSweep)\n if \"log\" in val.tags:\n scalar = ng.p.Log(lower=val.start, upper=val.end)\n else:\n scalar = ng.p.Scalar(lower=val.start, upper=val.end) # type: ignore\n if isinstance(val.start, int):\n scalar.set_integer_casting()\n return scalar\n\n\nclass NevergradSweeperImpl(Sweeper):\n def __init__(\n self,\n optim: OptimConf,\n parametrization: Optional[DictConfig],\n ):\n self.opt_config = optim\n self.config: Optional[DictConfig] = None\n self.launcher: Optional[Launcher] = None\n self.hydra_context: Optional[HydraContext] = None\n self.job_results = None\n self.parametrization: Dict[str, Any] = {}\n if parametrization is not None:\n assert isinstance(parametrization, DictConfig)\n self.parametrization = {\n str(x): create_nevergrad_param_from_config(y)\n for x, y in parametrization.items()\n }\n self.job_idx: Optional[int] = None\n\n def setup(\n self,\n *,\n hydra_context: HydraContext,\n task_function: TaskFunction,\n config: DictConfig,\n ) -> None:\n self.job_idx = 0\n self.config = config\n self.hydra_context = hydra_context\n self.launcher = Plugins.instance().instantiate_launcher(\n hydra_context=hydra_context, task_function=task_function, config=config\n )\n\n def sweep(self, arguments: List[str]) -> None:\n assert self.config is not None\n assert self.launcher is not None\n assert self.job_idx is not None\n direction = -1 if self.opt_config.maximize else 1\n name = \"maximization\" if self.opt_config.maximize else \"minimization\"\n # Override the parametrization from commandline\n params = dict(self.parametrization)\n\n parser = OverridesParser.create()\n parsed = parser.parse_overrides(arguments)\n\n for override in parsed:\n params[\n override.get_key_element()\n ] = create_nevergrad_parameter_from_override(override)\n\n parametrization = ng.p.Dict(**params)\n parametrization.function.deterministic = not self.opt_config.noisy\n parametrization.random_state.seed(self.opt_config.seed)\n # log and build the optimizer\n opt = self.opt_config.optimizer\n remaining_budget = self.opt_config.budget\n nw = self.opt_config.num_workers\n log.info(\n f\"NevergradSweeper(optimizer={opt}, budget={remaining_budget}, \"\n f\"num_workers={nw}) {name}\"\n )\n log.info(f\"with parametrization {parametrization}\")\n log.info(f\"Sweep output dir: {self.config.hydra.sweep.dir}\")\n optimizer = ng.optimizers.registry[opt](parametrization, remaining_budget, nw)\n # loop!\n all_returns: List[Any] = []\n best: Tuple[float, ng.p.Parameter] = (float(\"inf\"), parametrization)\n while remaining_budget > 0:\n batch = min(nw, remaining_budget)\n remaining_budget -= batch\n candidates = [optimizer.ask() for _ in range(batch)]\n overrides = list(\n tuple(f\"{x}={y}\" for x, y in c.value.items()) for c in candidates\n )\n self.validate_batch_is_legal(overrides)\n returns = self.launcher.launch(overrides, initial_job_idx=self.job_idx)\n # would have been nice to avoid waiting for all jobs to finish\n # aka batch size Vs steady state (launching a new job whenever one is done)\n self.job_idx += len(returns)\n # check job status and prepare losses\n failures = 0\n for cand, ret in zip(candidates, returns):\n if ret.status == utils.JobStatus.COMPLETED:\n rectified_loss = direction * ret.return_value\n else:\n rectified_loss = math.inf\n failures += 1\n try:\n ret.return_value\n except Exception as e:\n log.warning(f\"Returning infinity for failed experiment: {e}\")\n optimizer.tell(cand, rectified_loss)\n if rectified_loss < best[0]:\n best = (rectified_loss, cand)\n # raise if too many failures\n if failures / len(returns) > self.opt_config.max_failure_rate:\n log.error(\n f\"Failed {failures} times out of {len(returns)} \"\n f\"with max_failure_rate={self.opt_config.max_failure_rate}\"\n )\n for ret in returns:\n ret.return_value # delegate raising to JobReturn, with actual traceback\n all_returns.extend(returns)\n recom = optimizer.provide_recommendation()\n results_to_serialize = {\n \"name\": \"nevergrad\",\n \"best_evaluated_params\": best[1].value,\n \"best_evaluated_result\": direction * best[0],\n }\n OmegaConf.save(\n OmegaConf.create(results_to_serialize),\n f\"{self.config.hydra.sweep.dir}/optimization_results.yaml\",\n )\n log.info(\n \"Best parameters: %s\", \" \".join(f\"{x}={y}\" for x, y in recom.value.items())\n )\n", "path": "plugins/hydra_nevergrad_sweeper/hydra_plugins/hydra_nevergrad_sweeper/_impl.py"}], "after_files": [{"content": "# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved\nimport logging\nimport math\nfrom typing import (\n Any,\n Dict,\n List,\n MutableMapping,\n MutableSequence,\n Optional,\n Tuple,\n Union,\n)\n\nimport nevergrad as ng\nfrom hydra.core import utils\nfrom hydra.core.override_parser.overrides_parser import OverridesParser\nfrom hydra.core.override_parser.types import (\n ChoiceSweep,\n IntervalSweep,\n Override,\n Transformer,\n)\nfrom hydra.core.plugins import Plugins\nfrom hydra.plugins.launcher import Launcher\nfrom hydra.plugins.sweeper import Sweeper\nfrom hydra.types import HydraContext, TaskFunction\nfrom omegaconf import DictConfig, ListConfig, OmegaConf\n\nfrom .config import OptimConf, ScalarConfigSpec\n\nlog = logging.getLogger(__name__)\n\n\ndef create_nevergrad_param_from_config(\n config: Union[MutableSequence[Any], MutableMapping[str, Any]]\n) -> Any:\n if isinstance(config, MutableSequence):\n if isinstance(config, ListConfig):\n config = OmegaConf.to_container(config, resolve=True) # type: ignore\n return ng.p.Choice(config)\n if isinstance(config, MutableMapping):\n specs = ScalarConfigSpec(**config)\n init = [\"init\", \"lower\", \"upper\"]\n init_params = {x: getattr(specs, x) for x in init}\n if not specs.log:\n scalar = ng.p.Scalar(**init_params)\n if specs.step is not None:\n scalar.set_mutation(sigma=specs.step)\n else:\n if specs.step is not None:\n init_params[\"exponent\"] = specs.step\n scalar = ng.p.Log(**init_params)\n if specs.integer:\n scalar.set_integer_casting()\n return scalar\n return config\n\n\ndef create_nevergrad_parameter_from_override(override: Override) -> Any:\n val = override.value()\n if not override.is_sweep_override():\n return override.get_value_element_as_str()\n if override.is_choice_sweep():\n assert isinstance(val, ChoiceSweep)\n vals = [x for x in override.sweep_iterator(transformer=Transformer.encode)]\n if \"ordered\" in val.tags:\n return ng.p.TransitionChoice(vals)\n else:\n return ng.p.Choice(vals)\n elif override.is_range_sweep():\n vals = [x for x in override.sweep_iterator(transformer=Transformer.encode)]\n return ng.p.Choice(vals)\n elif override.is_interval_sweep():\n assert isinstance(val, IntervalSweep)\n if \"log\" in val.tags:\n scalar = ng.p.Log(lower=val.start, upper=val.end)\n else:\n scalar = ng.p.Scalar(lower=val.start, upper=val.end) # type: ignore\n if isinstance(val.start, int):\n scalar.set_integer_casting()\n return scalar\n\n\nclass NevergradSweeperImpl(Sweeper):\n def __init__(\n self,\n optim: OptimConf,\n parametrization: Optional[DictConfig],\n ):\n self.opt_config = optim\n self.config: Optional[DictConfig] = None\n self.launcher: Optional[Launcher] = None\n self.hydra_context: Optional[HydraContext] = None\n self.job_results = None\n self.parametrization: Dict[str, Any] = {}\n if parametrization is not None:\n assert isinstance(parametrization, DictConfig)\n self.parametrization = {\n str(x): create_nevergrad_param_from_config(y)\n for x, y in parametrization.items()\n }\n self.job_idx: Optional[int] = None\n\n def setup(\n self,\n *,\n hydra_context: HydraContext,\n task_function: TaskFunction,\n config: DictConfig,\n ) -> None:\n self.job_idx = 0\n self.config = config\n self.hydra_context = hydra_context\n self.launcher = Plugins.instance().instantiate_launcher(\n hydra_context=hydra_context, task_function=task_function, config=config\n )\n\n def sweep(self, arguments: List[str]) -> None:\n assert self.config is not None\n assert self.launcher is not None\n assert self.job_idx is not None\n direction = -1 if self.opt_config.maximize else 1\n name = \"maximization\" if self.opt_config.maximize else \"minimization\"\n # Override the parametrization from commandline\n params = dict(self.parametrization)\n\n parser = OverridesParser.create()\n parsed = parser.parse_overrides(arguments)\n\n for override in parsed:\n params[\n override.get_key_element()\n ] = create_nevergrad_parameter_from_override(override)\n\n parametrization = ng.p.Dict(**params)\n parametrization.function.deterministic = not self.opt_config.noisy\n parametrization.random_state.seed(self.opt_config.seed)\n # log and build the optimizer\n opt = self.opt_config.optimizer\n remaining_budget = self.opt_config.budget\n nw = self.opt_config.num_workers\n log.info(\n f\"NevergradSweeper(optimizer={opt}, budget={remaining_budget}, \"\n f\"num_workers={nw}) {name}\"\n )\n log.info(f\"with parametrization {parametrization}\")\n log.info(f\"Sweep output dir: {self.config.hydra.sweep.dir}\")\n optimizer = ng.optimizers.registry[opt](parametrization, remaining_budget, nw)\n # loop!\n all_returns: List[Any] = []\n best: Tuple[float, ng.p.Parameter] = (float(\"inf\"), parametrization)\n while remaining_budget > 0:\n batch = min(nw, remaining_budget)\n remaining_budget -= batch\n candidates = [optimizer.ask() for _ in range(batch)]\n overrides = list(\n tuple(f\"{x}={y}\" for x, y in c.value.items()) for c in candidates\n )\n self.validate_batch_is_legal(overrides)\n returns = self.launcher.launch(overrides, initial_job_idx=self.job_idx)\n # would have been nice to avoid waiting for all jobs to finish\n # aka batch size Vs steady state (launching a new job whenever one is done)\n self.job_idx += len(returns)\n # check job status and prepare losses\n failures = 0\n for cand, ret in zip(candidates, returns):\n if ret.status == utils.JobStatus.COMPLETED:\n rectified_loss = direction * ret.return_value\n else:\n rectified_loss = math.inf\n failures += 1\n try:\n ret.return_value\n except Exception as e:\n log.warning(f\"Returning infinity for failed experiment: {e}\")\n optimizer.tell(cand, rectified_loss)\n if rectified_loss < best[0]:\n best = (rectified_loss, cand)\n # raise if too many failures\n if failures / len(returns) > self.opt_config.max_failure_rate:\n log.error(\n f\"Failed {failures} times out of {len(returns)} \"\n f\"with max_failure_rate={self.opt_config.max_failure_rate}\"\n )\n for ret in returns:\n ret.return_value # delegate raising to JobReturn, with actual traceback\n all_returns.extend(returns)\n recom = optimizer.provide_recommendation()\n results_to_serialize = {\n \"name\": \"nevergrad\",\n \"best_evaluated_params\": best[1].value,\n \"best_evaluated_result\": direction * best[0],\n }\n OmegaConf.save(\n OmegaConf.create(results_to_serialize),\n f\"{self.config.hydra.sweep.dir}/optimization_results.yaml\",\n )\n log.info(\n \"Best parameters: %s\", \" \".join(f\"{x}={y}\" for x, y in recom.value.items())\n )\n", "path": "plugins/hydra_nevergrad_sweeper/hydra_plugins/hydra_nevergrad_sweeper/_impl.py"}]}
| 2,958 | 209 |
gh_patches_debug_4782
|
rasdani/github-patches
|
git_diff
|
ESMCI__cime-812
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Write NOC test using SystemTestsCompareTwo infrastructure
We want to convert the various system tests that compare two runs to use the SystemTestsCompareTwo infrastructure, where possible. I am opening separate issues for each such system test, so that we can check them off as we do this conversion.
Currently it looks like the NOC test is essentially just an SMS test - it looks like a place-holder waiting to be filled in.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `utils/python/CIME/SystemTests/noc.py`
Content:
```
1 """
2 CIME NOC? test This class inherits from SystemTestsCommon
3 """
4 from CIME.XML.standard_module_setup import *
5 from CIME.SystemTests.system_tests_common import SystemTestsCommon
6
7 logger = logging.getLogger(__name__)
8
9 class NOC(SystemTestsCommon):
10
11 def __init__(self, case):
12 """
13 initialize an object interface to the NOC system test
14 """
15 #expectedrunvars = ["CONTINUE_RUN", "REST_OPTION", "HIST_OPTION", "HIST_N"]
16 SystemTestsCommon.__init__(self, case)
17
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/utils/python/CIME/SystemTests/noc.py b/utils/python/CIME/SystemTests/noc.py
deleted file mode 100644
--- a/utils/python/CIME/SystemTests/noc.py
+++ /dev/null
@@ -1,16 +0,0 @@
-"""
-CIME NOC? test This class inherits from SystemTestsCommon
-"""
-from CIME.XML.standard_module_setup import *
-from CIME.SystemTests.system_tests_common import SystemTestsCommon
-
-logger = logging.getLogger(__name__)
-
-class NOC(SystemTestsCommon):
-
- def __init__(self, case):
- """
- initialize an object interface to the NOC system test
- """
- #expectedrunvars = ["CONTINUE_RUN", "REST_OPTION", "HIST_OPTION", "HIST_N"]
- SystemTestsCommon.__init__(self, case)
|
{"golden_diff": "diff --git a/utils/python/CIME/SystemTests/noc.py b/utils/python/CIME/SystemTests/noc.py\ndeleted file mode 100644\n--- a/utils/python/CIME/SystemTests/noc.py\n+++ /dev/null\n@@ -1,16 +0,0 @@\n-\"\"\"\n-CIME NOC? test This class inherits from SystemTestsCommon\n-\"\"\"\n-from CIME.XML.standard_module_setup import *\n-from CIME.SystemTests.system_tests_common import SystemTestsCommon\n-\n-logger = logging.getLogger(__name__)\n-\n-class NOC(SystemTestsCommon):\n-\n- def __init__(self, case):\n- \"\"\"\n- initialize an object interface to the NOC system test\n- \"\"\"\n- #expectedrunvars = [\"CONTINUE_RUN\", \"REST_OPTION\", \"HIST_OPTION\", \"HIST_N\"]\n- SystemTestsCommon.__init__(self, case)\n", "issue": "Write NOC test using SystemTestsCompareTwo infrastructure\nWe want to convert the various system tests that compare two runs to use the SystemTestsCompareTwo infrastructure, where possible. I am opening separate issues for each such system test, so that we can check them off as we do this conversion.\n\nCurrently it looks like the NOC test is essentially just an SMS test - it looks like a place-holder waiting to be filled in.\n", "before_files": [{"content": "\"\"\"\nCIME NOC? test This class inherits from SystemTestsCommon\n\"\"\"\nfrom CIME.XML.standard_module_setup import *\nfrom CIME.SystemTests.system_tests_common import SystemTestsCommon\n\nlogger = logging.getLogger(__name__)\n\nclass NOC(SystemTestsCommon):\n\n def __init__(self, case):\n \"\"\"\n initialize an object interface to the NOC system test\n \"\"\"\n #expectedrunvars = [\"CONTINUE_RUN\", \"REST_OPTION\", \"HIST_OPTION\", \"HIST_N\"]\n SystemTestsCommon.__init__(self, case)\n", "path": "utils/python/CIME/SystemTests/noc.py"}], "after_files": [{"content": null, "path": "utils/python/CIME/SystemTests/noc.py"}]}
| 491 | 189 |
gh_patches_debug_18510
|
rasdani/github-patches
|
git_diff
|
pypa__setuptools-4159
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
setuptools changes underscore to dash for package name
After I pip install cx_oracle, I use python -m pip show cx_oracle command and it shows the package name is cx-Oracle
After discussed with cx_Oracle's author, it shows setuptools changed the underscore to dash for the package name. Is that an issue for setuptools or is there any way to stop this auto-conversion? Thanks.
setup.cfg for cx_Oracle
[metadata]
name = cx_Oracle
PKG-INFO for cx_Oracle
Metadata-Version: 2.1
Name: cx-Oracle
setup.py used in cx_Oracel
# setup the extension
extension = setuptools.Extension(
name = "cx_Oracle",
include_dirs = includeDirs,
extra_compile_args = extraCompileArgs,
define_macros = [("CXO_BUILD_VERSION", BUILD_VERSION)],
extra_link_args = extraLinkArgs,
sources = sources + dpiSources,
depends = depends,
libraries = libraries,
library_dirs = libraryDirs)
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `setuptools/_normalization.py`
Content:
```
1 """
2 Helpers for normalization as expected in wheel/sdist/module file names
3 and core metadata
4 """
5 import re
6 from pathlib import Path
7 from typing import Union
8
9 from .extern import packaging
10
11 _Path = Union[str, Path]
12
13 # https://packaging.python.org/en/latest/specifications/core-metadata/#name
14 _VALID_NAME = re.compile(r"^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$", re.I)
15 _UNSAFE_NAME_CHARS = re.compile(r"[^A-Z0-9.]+", re.I)
16 _NON_ALPHANUMERIC = re.compile(r"[^A-Z0-9]+", re.I)
17 _PEP440_FALLBACK = re.compile(r"^v?(?P<safe>(?:[0-9]+!)?[0-9]+(?:\.[0-9]+)*)", re.I)
18
19
20 def safe_identifier(name: str) -> str:
21 """Make a string safe to be used as Python identifier.
22 >>> safe_identifier("12abc")
23 '_12abc'
24 >>> safe_identifier("__editable__.myns.pkg-78.9.3_local")
25 '__editable___myns_pkg_78_9_3_local'
26 """
27 safe = re.sub(r'\W|^(?=\d)', '_', name)
28 assert safe.isidentifier()
29 return safe
30
31
32 def safe_name(component: str) -> str:
33 """Escape a component used as a project name according to Core Metadata.
34 >>> safe_name("hello world")
35 'hello-world'
36 >>> safe_name("hello?world")
37 'hello-world'
38 """
39 # See pkg_resources.safe_name
40 return _UNSAFE_NAME_CHARS.sub("-", component)
41
42
43 def safe_version(version: str) -> str:
44 """Convert an arbitrary string into a valid version string.
45 Can still raise an ``InvalidVersion`` exception.
46 To avoid exceptions use ``best_effort_version``.
47 >>> safe_version("1988 12 25")
48 '1988.12.25'
49 >>> safe_version("v0.2.1")
50 '0.2.1'
51 >>> safe_version("v0.2?beta")
52 '0.2b0'
53 >>> safe_version("v0.2 beta")
54 '0.2b0'
55 >>> safe_version("ubuntu lts")
56 Traceback (most recent call last):
57 ...
58 setuptools.extern.packaging.version.InvalidVersion: Invalid version: 'ubuntu.lts'
59 """
60 v = version.replace(' ', '.')
61 try:
62 return str(packaging.version.Version(v))
63 except packaging.version.InvalidVersion:
64 attempt = _UNSAFE_NAME_CHARS.sub("-", v)
65 return str(packaging.version.Version(attempt))
66
67
68 def best_effort_version(version: str) -> str:
69 """Convert an arbitrary string into a version-like string.
70 Fallback when ``safe_version`` is not safe enough.
71 >>> best_effort_version("v0.2 beta")
72 '0.2b0'
73 >>> best_effort_version("ubuntu lts")
74 '0.dev0+sanitized.ubuntu.lts'
75 >>> best_effort_version("0.23ubuntu1")
76 '0.23.dev0+sanitized.ubuntu1'
77 >>> best_effort_version("0.23-")
78 '0.23.dev0+sanitized'
79 >>> best_effort_version("0.-_")
80 '0.dev0+sanitized'
81 >>> best_effort_version("42.+?1")
82 '42.dev0+sanitized.1'
83 """
84 # See pkg_resources._forgiving_version
85 try:
86 return safe_version(version)
87 except packaging.version.InvalidVersion:
88 v = version.replace(' ', '.')
89 match = _PEP440_FALLBACK.search(v)
90 if match:
91 safe = match["safe"]
92 rest = v[len(safe) :]
93 else:
94 safe = "0"
95 rest = version
96 safe_rest = _NON_ALPHANUMERIC.sub(".", rest).strip(".")
97 local = f"sanitized.{safe_rest}".strip(".")
98 return safe_version(f"{safe}.dev0+{local}")
99
100
101 def safe_extra(extra: str) -> str:
102 """Normalize extra name according to PEP 685
103 >>> safe_extra("_FrIeNdLy-._.-bArD")
104 'friendly-bard'
105 >>> safe_extra("FrIeNdLy-._.-bArD__._-")
106 'friendly-bard'
107 """
108 return _NON_ALPHANUMERIC.sub("-", extra).strip("-").lower()
109
110
111 def filename_component(value: str) -> str:
112 """Normalize each component of a filename (e.g. distribution/version part of wheel)
113 Note: ``value`` needs to be already normalized.
114 >>> filename_component("my-pkg")
115 'my_pkg'
116 """
117 return value.replace("-", "_").strip("_")
118
119
120 def safer_name(value: str) -> str:
121 """Like ``safe_name`` but can be used as filename component for wheel"""
122 # See bdist_wheel.safer_name
123 return filename_component(safe_name(value))
124
125
126 def safer_best_effort_version(value: str) -> str:
127 """Like ``best_effort_version`` but can be used as filename component for wheel"""
128 # See bdist_wheel.safer_verion
129 # TODO: Replace with only safe_version in the future (no need for best effort)
130 return filename_component(best_effort_version(value))
131
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/setuptools/_normalization.py b/setuptools/_normalization.py
--- a/setuptools/_normalization.py
+++ b/setuptools/_normalization.py
@@ -12,7 +12,7 @@
# https://packaging.python.org/en/latest/specifications/core-metadata/#name
_VALID_NAME = re.compile(r"^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$", re.I)
-_UNSAFE_NAME_CHARS = re.compile(r"[^A-Z0-9.]+", re.I)
+_UNSAFE_NAME_CHARS = re.compile(r"[^A-Z0-9._-]+", re.I)
_NON_ALPHANUMERIC = re.compile(r"[^A-Z0-9]+", re.I)
_PEP440_FALLBACK = re.compile(r"^v?(?P<safe>(?:[0-9]+!)?[0-9]+(?:\.[0-9]+)*)", re.I)
@@ -35,6 +35,8 @@
'hello-world'
>>> safe_name("hello?world")
'hello-world'
+ >>> safe_name("hello_world")
+ 'hello_world'
"""
# See pkg_resources.safe_name
return _UNSAFE_NAME_CHARS.sub("-", component)
|
{"golden_diff": "diff --git a/setuptools/_normalization.py b/setuptools/_normalization.py\n--- a/setuptools/_normalization.py\n+++ b/setuptools/_normalization.py\n@@ -12,7 +12,7 @@\n \n # https://packaging.python.org/en/latest/specifications/core-metadata/#name\n _VALID_NAME = re.compile(r\"^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$\", re.I)\n-_UNSAFE_NAME_CHARS = re.compile(r\"[^A-Z0-9.]+\", re.I)\n+_UNSAFE_NAME_CHARS = re.compile(r\"[^A-Z0-9._-]+\", re.I)\n _NON_ALPHANUMERIC = re.compile(r\"[^A-Z0-9]+\", re.I)\n _PEP440_FALLBACK = re.compile(r\"^v?(?P<safe>(?:[0-9]+!)?[0-9]+(?:\\.[0-9]+)*)\", re.I)\n \n@@ -35,6 +35,8 @@\n 'hello-world'\n >>> safe_name(\"hello?world\")\n 'hello-world'\n+ >>> safe_name(\"hello_world\")\n+ 'hello_world'\n \"\"\"\n # See pkg_resources.safe_name\n return _UNSAFE_NAME_CHARS.sub(\"-\", component)\n", "issue": "setuptools changes underscore to dash for package name\nAfter I pip install cx_oracle, I use python -m pip show cx_oracle command and it shows the package name is cx-Oracle\r\nAfter discussed with cx_Oracle's author, it shows setuptools changed the underscore to dash for the package name. Is that an issue for setuptools or is there any way to stop this auto-conversion? Thanks.\r\n\r\nsetup.cfg for cx_Oracle\r\n[metadata]\r\nname = cx_Oracle\r\n\r\nPKG-INFO for cx_Oracle\r\nMetadata-Version: 2.1\r\nName: cx-Oracle\r\n\r\nsetup.py used in cx_Oracel\r\n# setup the extension\r\nextension = setuptools.Extension(\r\n name = \"cx_Oracle\",\r\n include_dirs = includeDirs,\r\n extra_compile_args = extraCompileArgs,\r\n define_macros = [(\"CXO_BUILD_VERSION\", BUILD_VERSION)],\r\n extra_link_args = extraLinkArgs,\r\n sources = sources + dpiSources,\r\n depends = depends,\r\n libraries = libraries,\r\n library_dirs = libraryDirs)\n", "before_files": [{"content": "\"\"\"\nHelpers for normalization as expected in wheel/sdist/module file names\nand core metadata\n\"\"\"\nimport re\nfrom pathlib import Path\nfrom typing import Union\n\nfrom .extern import packaging\n\n_Path = Union[str, Path]\n\n# https://packaging.python.org/en/latest/specifications/core-metadata/#name\n_VALID_NAME = re.compile(r\"^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$\", re.I)\n_UNSAFE_NAME_CHARS = re.compile(r\"[^A-Z0-9.]+\", re.I)\n_NON_ALPHANUMERIC = re.compile(r\"[^A-Z0-9]+\", re.I)\n_PEP440_FALLBACK = re.compile(r\"^v?(?P<safe>(?:[0-9]+!)?[0-9]+(?:\\.[0-9]+)*)\", re.I)\n\n\ndef safe_identifier(name: str) -> str:\n \"\"\"Make a string safe to be used as Python identifier.\n >>> safe_identifier(\"12abc\")\n '_12abc'\n >>> safe_identifier(\"__editable__.myns.pkg-78.9.3_local\")\n '__editable___myns_pkg_78_9_3_local'\n \"\"\"\n safe = re.sub(r'\\W|^(?=\\d)', '_', name)\n assert safe.isidentifier()\n return safe\n\n\ndef safe_name(component: str) -> str:\n \"\"\"Escape a component used as a project name according to Core Metadata.\n >>> safe_name(\"hello world\")\n 'hello-world'\n >>> safe_name(\"hello?world\")\n 'hello-world'\n \"\"\"\n # See pkg_resources.safe_name\n return _UNSAFE_NAME_CHARS.sub(\"-\", component)\n\n\ndef safe_version(version: str) -> str:\n \"\"\"Convert an arbitrary string into a valid version string.\n Can still raise an ``InvalidVersion`` exception.\n To avoid exceptions use ``best_effort_version``.\n >>> safe_version(\"1988 12 25\")\n '1988.12.25'\n >>> safe_version(\"v0.2.1\")\n '0.2.1'\n >>> safe_version(\"v0.2?beta\")\n '0.2b0'\n >>> safe_version(\"v0.2 beta\")\n '0.2b0'\n >>> safe_version(\"ubuntu lts\")\n Traceback (most recent call last):\n ...\n setuptools.extern.packaging.version.InvalidVersion: Invalid version: 'ubuntu.lts'\n \"\"\"\n v = version.replace(' ', '.')\n try:\n return str(packaging.version.Version(v))\n except packaging.version.InvalidVersion:\n attempt = _UNSAFE_NAME_CHARS.sub(\"-\", v)\n return str(packaging.version.Version(attempt))\n\n\ndef best_effort_version(version: str) -> str:\n \"\"\"Convert an arbitrary string into a version-like string.\n Fallback when ``safe_version`` is not safe enough.\n >>> best_effort_version(\"v0.2 beta\")\n '0.2b0'\n >>> best_effort_version(\"ubuntu lts\")\n '0.dev0+sanitized.ubuntu.lts'\n >>> best_effort_version(\"0.23ubuntu1\")\n '0.23.dev0+sanitized.ubuntu1'\n >>> best_effort_version(\"0.23-\")\n '0.23.dev0+sanitized'\n >>> best_effort_version(\"0.-_\")\n '0.dev0+sanitized'\n >>> best_effort_version(\"42.+?1\")\n '42.dev0+sanitized.1'\n \"\"\"\n # See pkg_resources._forgiving_version\n try:\n return safe_version(version)\n except packaging.version.InvalidVersion:\n v = version.replace(' ', '.')\n match = _PEP440_FALLBACK.search(v)\n if match:\n safe = match[\"safe\"]\n rest = v[len(safe) :]\n else:\n safe = \"0\"\n rest = version\n safe_rest = _NON_ALPHANUMERIC.sub(\".\", rest).strip(\".\")\n local = f\"sanitized.{safe_rest}\".strip(\".\")\n return safe_version(f\"{safe}.dev0+{local}\")\n\n\ndef safe_extra(extra: str) -> str:\n \"\"\"Normalize extra name according to PEP 685\n >>> safe_extra(\"_FrIeNdLy-._.-bArD\")\n 'friendly-bard'\n >>> safe_extra(\"FrIeNdLy-._.-bArD__._-\")\n 'friendly-bard'\n \"\"\"\n return _NON_ALPHANUMERIC.sub(\"-\", extra).strip(\"-\").lower()\n\n\ndef filename_component(value: str) -> str:\n \"\"\"Normalize each component of a filename (e.g. distribution/version part of wheel)\n Note: ``value`` needs to be already normalized.\n >>> filename_component(\"my-pkg\")\n 'my_pkg'\n \"\"\"\n return value.replace(\"-\", \"_\").strip(\"_\")\n\n\ndef safer_name(value: str) -> str:\n \"\"\"Like ``safe_name`` but can be used as filename component for wheel\"\"\"\n # See bdist_wheel.safer_name\n return filename_component(safe_name(value))\n\n\ndef safer_best_effort_version(value: str) -> str:\n \"\"\"Like ``best_effort_version`` but can be used as filename component for wheel\"\"\"\n # See bdist_wheel.safer_verion\n # TODO: Replace with only safe_version in the future (no need for best effort)\n return filename_component(best_effort_version(value))\n", "path": "setuptools/_normalization.py"}], "after_files": [{"content": "\"\"\"\nHelpers for normalization as expected in wheel/sdist/module file names\nand core metadata\n\"\"\"\nimport re\nfrom pathlib import Path\nfrom typing import Union\n\nfrom .extern import packaging\n\n_Path = Union[str, Path]\n\n# https://packaging.python.org/en/latest/specifications/core-metadata/#name\n_VALID_NAME = re.compile(r\"^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$\", re.I)\n_UNSAFE_NAME_CHARS = re.compile(r\"[^A-Z0-9._-]+\", re.I)\n_NON_ALPHANUMERIC = re.compile(r\"[^A-Z0-9]+\", re.I)\n_PEP440_FALLBACK = re.compile(r\"^v?(?P<safe>(?:[0-9]+!)?[0-9]+(?:\\.[0-9]+)*)\", re.I)\n\n\ndef safe_identifier(name: str) -> str:\n \"\"\"Make a string safe to be used as Python identifier.\n >>> safe_identifier(\"12abc\")\n '_12abc'\n >>> safe_identifier(\"__editable__.myns.pkg-78.9.3_local\")\n '__editable___myns_pkg_78_9_3_local'\n \"\"\"\n safe = re.sub(r'\\W|^(?=\\d)', '_', name)\n assert safe.isidentifier()\n return safe\n\n\ndef safe_name(component: str) -> str:\n \"\"\"Escape a component used as a project name according to Core Metadata.\n >>> safe_name(\"hello world\")\n 'hello-world'\n >>> safe_name(\"hello?world\")\n 'hello-world'\n >>> safe_name(\"hello_world\")\n 'hello_world'\n \"\"\"\n # See pkg_resources.safe_name\n return _UNSAFE_NAME_CHARS.sub(\"-\", component)\n\n\ndef safe_version(version: str) -> str:\n \"\"\"Convert an arbitrary string into a valid version string.\n Can still raise an ``InvalidVersion`` exception.\n To avoid exceptions use ``best_effort_version``.\n >>> safe_version(\"1988 12 25\")\n '1988.12.25'\n >>> safe_version(\"v0.2.1\")\n '0.2.1'\n >>> safe_version(\"v0.2?beta\")\n '0.2b0'\n >>> safe_version(\"v0.2 beta\")\n '0.2b0'\n >>> safe_version(\"ubuntu lts\")\n Traceback (most recent call last):\n ...\n setuptools.extern.packaging.version.InvalidVersion: Invalid version: 'ubuntu.lts'\n \"\"\"\n v = version.replace(' ', '.')\n try:\n return str(packaging.version.Version(v))\n except packaging.version.InvalidVersion:\n attempt = _UNSAFE_NAME_CHARS.sub(\"-\", v)\n return str(packaging.version.Version(attempt))\n\n\ndef best_effort_version(version: str) -> str:\n \"\"\"Convert an arbitrary string into a version-like string.\n Fallback when ``safe_version`` is not safe enough.\n >>> best_effort_version(\"v0.2 beta\")\n '0.2b0'\n >>> best_effort_version(\"ubuntu lts\")\n '0.dev0+sanitized.ubuntu.lts'\n >>> best_effort_version(\"0.23ubuntu1\")\n '0.23.dev0+sanitized.ubuntu1'\n >>> best_effort_version(\"0.23-\")\n '0.23.dev0+sanitized'\n >>> best_effort_version(\"0.-_\")\n '0.dev0+sanitized'\n >>> best_effort_version(\"42.+?1\")\n '42.dev0+sanitized.1'\n \"\"\"\n # See pkg_resources._forgiving_version\n try:\n return safe_version(version)\n except packaging.version.InvalidVersion:\n v = version.replace(' ', '.')\n match = _PEP440_FALLBACK.search(v)\n if match:\n safe = match[\"safe\"]\n rest = v[len(safe) :]\n else:\n safe = \"0\"\n rest = version\n safe_rest = _NON_ALPHANUMERIC.sub(\".\", rest).strip(\".\")\n local = f\"sanitized.{safe_rest}\".strip(\".\")\n return safe_version(f\"{safe}.dev0+{local}\")\n\n\ndef safe_extra(extra: str) -> str:\n \"\"\"Normalize extra name according to PEP 685\n >>> safe_extra(\"_FrIeNdLy-._.-bArD\")\n 'friendly-bard'\n >>> safe_extra(\"FrIeNdLy-._.-bArD__._-\")\n 'friendly-bard'\n \"\"\"\n return _NON_ALPHANUMERIC.sub(\"-\", extra).strip(\"-\").lower()\n\n\ndef filename_component(value: str) -> str:\n \"\"\"Normalize each component of a filename (e.g. distribution/version part of wheel)\n Note: ``value`` needs to be already normalized.\n >>> filename_component(\"my-pkg\")\n 'my_pkg'\n \"\"\"\n return value.replace(\"-\", \"_\").strip(\"_\")\n\n\ndef safer_name(value: str) -> str:\n \"\"\"Like ``safe_name`` but can be used as filename component for wheel\"\"\"\n # See bdist_wheel.safer_name\n return filename_component(safe_name(value))\n\n\ndef safer_best_effort_version(value: str) -> str:\n \"\"\"Like ``best_effort_version`` but can be used as filename component for wheel\"\"\"\n # See bdist_wheel.safer_verion\n # TODO: Replace with only safe_version in the future (no need for best effort)\n return filename_component(best_effort_version(value))\n", "path": "setuptools/_normalization.py"}]}
| 1,958 | 287 |
gh_patches_debug_57601
|
rasdani/github-patches
|
git_diff
|
mdn__kuma-7119
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
T - Remove all non essential URLs from robots.txt
**Summary**
In the past we have added pages we didn't want to be indexed to robots.txt, but that means that Google can't crawl them to see that we don't want those pages to be indexed. We should only have pages in robots.txt that we don't want a robot to crawl (possibly due to performance issues).
**Steps To Reproduce (STR)**
1. Go to Search Console
2. go to Coverage > Valid with Warnings > Indexed, though blocked by robots.txt
3. Alternatively: https://developer.mozilla.org/robots.txt
**Actual behavior**
Google has a link to https://developer.mozilla.org/users/google/login/?next=/en-US/docs/MDN/About/Promote (for example), but that URL is blocked in robots.txt, so it can't follow the link to see that it redirects to a sign in page.
**Expected behavior**
Disallow: /*users/ should be removed from robots.txt so Google crawler can follow those urls.
**Additional context**
The reason to do this is so we can see actually problematic content show up in our search console reports, instead of this noise. Search console only shows up to 1000 pages as problematic, but there are currently more than 10k warnings, so we might be missing large issues.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `kuma/landing/views.py`
Content:
```
1 from django.conf import settings
2 from django.http import HttpResponse
3 from django.shortcuts import redirect, render
4 from django.views import static
5 from django.views.decorators.cache import never_cache
6 from django.views.generic import RedirectView
7
8 from kuma.core.decorators import ensure_wiki_domain, shared_cache_control
9 from kuma.core.utils import is_wiki
10 from kuma.feeder.models import Bundle
11 from kuma.feeder.sections import SECTION_HACKS
12 from kuma.search.models import Filter
13
14 from .utils import favicon_url
15
16
17 @shared_cache_control
18 def contribute_json(request):
19 return static.serve(request, "contribute.json", document_root=settings.ROOT)
20
21
22 @shared_cache_control
23 def home(request):
24 """Home page."""
25 context = {}
26 # Need for both wiki and react homepage
27 context["updates"] = list(Bundle.objects.recent_entries(SECTION_HACKS.updates)[:5])
28
29 # The default template name
30 template_name = "landing/react_homepage.html"
31 if is_wiki(request):
32 template_name = "landing/homepage.html"
33 context["default_filters"] = Filter.objects.default_filters()
34 return render(request, template_name, context)
35
36
37 @ensure_wiki_domain
38 @never_cache
39 def maintenance_mode(request):
40 if settings.MAINTENANCE_MODE:
41 return render(request, "landing/maintenance-mode.html")
42 else:
43 return redirect("home")
44
45
46 @ensure_wiki_domain
47 @shared_cache_control
48 def promote_buttons(request):
49 """Bug 646192: MDN affiliate buttons"""
50 return render(request, "landing/promote_buttons.html")
51
52
53 ROBOTS_ALL_ALLOWED_TXT = """\
54 User-agent: *
55 Sitemap: https://wiki.developer.mozilla.org/sitemap.xml
56
57 Disallow:
58 """
59
60 ROBOTS_ALLOWED_TXT = """\
61 User-agent: *
62 Sitemap: https://developer.mozilla.org/sitemap.xml
63
64 Disallow: /api/
65 Disallow: /*docs/get-documents
66 Disallow: /*docs/Experiment:*
67 Disallow: /*$children
68 Disallow: /*docs.json
69 Disallow: /*/files/
70 Disallow: /media
71 Disallow: /*profiles*/edit
72 Disallow: /*users/
73 """ + "\n".join(
74 "Disallow: /{locale}/search".format(locale=locale)
75 for locale in settings.ENABLED_LOCALES
76 )
77
78 ROBOTS_GO_AWAY_TXT = """\
79 User-Agent: *
80 Disallow: /
81 """
82
83
84 @shared_cache_control
85 def robots_txt(request):
86 """Serve robots.txt that allows or forbids robots."""
87 host = request.get_host()
88 if host in settings.ALLOW_ROBOTS_DOMAINS:
89 robots = ""
90 elif host in settings.ALLOW_ROBOTS_WEB_DOMAINS:
91 if host == settings.WIKI_HOST:
92 robots = ROBOTS_ALL_ALLOWED_TXT
93 else:
94 robots = ROBOTS_ALLOWED_TXT
95 else:
96 robots = ROBOTS_GO_AWAY_TXT
97 return HttpResponse(robots, content_type="text/plain")
98
99
100 class FaviconRedirect(RedirectView):
101 """Redirect to the favicon in the static img folder (bug 1402497)"""
102
103 def get_redirect_url(self, *args, **kwargs):
104 return favicon_url()
105
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/kuma/landing/views.py b/kuma/landing/views.py
--- a/kuma/landing/views.py
+++ b/kuma/landing/views.py
@@ -69,7 +69,6 @@
Disallow: /*/files/
Disallow: /media
Disallow: /*profiles*/edit
-Disallow: /*users/
""" + "\n".join(
"Disallow: /{locale}/search".format(locale=locale)
for locale in settings.ENABLED_LOCALES
|
{"golden_diff": "diff --git a/kuma/landing/views.py b/kuma/landing/views.py\n--- a/kuma/landing/views.py\n+++ b/kuma/landing/views.py\n@@ -69,7 +69,6 @@\n Disallow: /*/files/\n Disallow: /media\n Disallow: /*profiles*/edit\n-Disallow: /*users/\n \"\"\" + \"\\n\".join(\n \"Disallow: /{locale}/search\".format(locale=locale)\n for locale in settings.ENABLED_LOCALES\n", "issue": "T - Remove all non essential URLs from robots.txt\n**Summary**\r\nIn the past we have added pages we didn't want to be indexed to robots.txt, but that means that Google can't crawl them to see that we don't want those pages to be indexed. We should only have pages in robots.txt that we don't want a robot to crawl (possibly due to performance issues).\r\n\r\n\r\n**Steps To Reproduce (STR)**\r\n1. Go to Search Console\r\n2. go to Coverage > Valid with Warnings > Indexed, though blocked by robots.txt\r\n3. Alternatively: https://developer.mozilla.org/robots.txt\r\n\r\n\r\n**Actual behavior**\r\nGoogle has a link to https://developer.mozilla.org/users/google/login/?next=/en-US/docs/MDN/About/Promote (for example), but that URL is blocked in robots.txt, so it can't follow the link to see that it redirects to a sign in page.\r\n\r\n\r\n**Expected behavior**\r\nDisallow: /*users/ should be removed from robots.txt so Google crawler can follow those urls.\r\n\r\n\r\n**Additional context**\r\nThe reason to do this is so we can see actually problematic content show up in our search console reports, instead of this noise. Search console only shows up to 1000 pages as problematic, but there are currently more than 10k warnings, so we might be missing large issues.\r\n\n", "before_files": [{"content": "from django.conf import settings\nfrom django.http import HttpResponse\nfrom django.shortcuts import redirect, render\nfrom django.views import static\nfrom django.views.decorators.cache import never_cache\nfrom django.views.generic import RedirectView\n\nfrom kuma.core.decorators import ensure_wiki_domain, shared_cache_control\nfrom kuma.core.utils import is_wiki\nfrom kuma.feeder.models import Bundle\nfrom kuma.feeder.sections import SECTION_HACKS\nfrom kuma.search.models import Filter\n\nfrom .utils import favicon_url\n\n\n@shared_cache_control\ndef contribute_json(request):\n return static.serve(request, \"contribute.json\", document_root=settings.ROOT)\n\n\n@shared_cache_control\ndef home(request):\n \"\"\"Home page.\"\"\"\n context = {}\n # Need for both wiki and react homepage\n context[\"updates\"] = list(Bundle.objects.recent_entries(SECTION_HACKS.updates)[:5])\n\n # The default template name\n template_name = \"landing/react_homepage.html\"\n if is_wiki(request):\n template_name = \"landing/homepage.html\"\n context[\"default_filters\"] = Filter.objects.default_filters()\n return render(request, template_name, context)\n\n\n@ensure_wiki_domain\n@never_cache\ndef maintenance_mode(request):\n if settings.MAINTENANCE_MODE:\n return render(request, \"landing/maintenance-mode.html\")\n else:\n return redirect(\"home\")\n\n\n@ensure_wiki_domain\n@shared_cache_control\ndef promote_buttons(request):\n \"\"\"Bug 646192: MDN affiliate buttons\"\"\"\n return render(request, \"landing/promote_buttons.html\")\n\n\nROBOTS_ALL_ALLOWED_TXT = \"\"\"\\\nUser-agent: *\nSitemap: https://wiki.developer.mozilla.org/sitemap.xml\n\nDisallow:\n\"\"\"\n\nROBOTS_ALLOWED_TXT = \"\"\"\\\nUser-agent: *\nSitemap: https://developer.mozilla.org/sitemap.xml\n\nDisallow: /api/\nDisallow: /*docs/get-documents\nDisallow: /*docs/Experiment:*\nDisallow: /*$children\nDisallow: /*docs.json\nDisallow: /*/files/\nDisallow: /media\nDisallow: /*profiles*/edit\nDisallow: /*users/\n\"\"\" + \"\\n\".join(\n \"Disallow: /{locale}/search\".format(locale=locale)\n for locale in settings.ENABLED_LOCALES\n)\n\nROBOTS_GO_AWAY_TXT = \"\"\"\\\nUser-Agent: *\nDisallow: /\n\"\"\"\n\n\n@shared_cache_control\ndef robots_txt(request):\n \"\"\"Serve robots.txt that allows or forbids robots.\"\"\"\n host = request.get_host()\n if host in settings.ALLOW_ROBOTS_DOMAINS:\n robots = \"\"\n elif host in settings.ALLOW_ROBOTS_WEB_DOMAINS:\n if host == settings.WIKI_HOST:\n robots = ROBOTS_ALL_ALLOWED_TXT\n else:\n robots = ROBOTS_ALLOWED_TXT\n else:\n robots = ROBOTS_GO_AWAY_TXT\n return HttpResponse(robots, content_type=\"text/plain\")\n\n\nclass FaviconRedirect(RedirectView):\n \"\"\"Redirect to the favicon in the static img folder (bug 1402497)\"\"\"\n\n def get_redirect_url(self, *args, **kwargs):\n return favicon_url()\n", "path": "kuma/landing/views.py"}], "after_files": [{"content": "from django.conf import settings\nfrom django.http import HttpResponse\nfrom django.shortcuts import redirect, render\nfrom django.views import static\nfrom django.views.decorators.cache import never_cache\nfrom django.views.generic import RedirectView\n\nfrom kuma.core.decorators import ensure_wiki_domain, shared_cache_control\nfrom kuma.core.utils import is_wiki\nfrom kuma.feeder.models import Bundle\nfrom kuma.feeder.sections import SECTION_HACKS\nfrom kuma.search.models import Filter\n\nfrom .utils import favicon_url\n\n\n@shared_cache_control\ndef contribute_json(request):\n return static.serve(request, \"contribute.json\", document_root=settings.ROOT)\n\n\n@shared_cache_control\ndef home(request):\n \"\"\"Home page.\"\"\"\n context = {}\n # Need for both wiki and react homepage\n context[\"updates\"] = list(Bundle.objects.recent_entries(SECTION_HACKS.updates)[:5])\n\n # The default template name\n template_name = \"landing/react_homepage.html\"\n if is_wiki(request):\n template_name = \"landing/homepage.html\"\n context[\"default_filters\"] = Filter.objects.default_filters()\n return render(request, template_name, context)\n\n\n@ensure_wiki_domain\n@never_cache\ndef maintenance_mode(request):\n if settings.MAINTENANCE_MODE:\n return render(request, \"landing/maintenance-mode.html\")\n else:\n return redirect(\"home\")\n\n\n@ensure_wiki_domain\n@shared_cache_control\ndef promote_buttons(request):\n \"\"\"Bug 646192: MDN affiliate buttons\"\"\"\n return render(request, \"landing/promote_buttons.html\")\n\n\nROBOTS_ALL_ALLOWED_TXT = \"\"\"\\\nUser-agent: *\nSitemap: https://wiki.developer.mozilla.org/sitemap.xml\n\nDisallow:\n\"\"\"\n\nROBOTS_ALLOWED_TXT = \"\"\"\\\nUser-agent: *\nSitemap: https://developer.mozilla.org/sitemap.xml\n\nDisallow: /api/\nDisallow: /*docs/get-documents\nDisallow: /*docs/Experiment:*\nDisallow: /*$children\nDisallow: /*docs.json\nDisallow: /*/files/\nDisallow: /media\nDisallow: /*profiles*/edit\n\"\"\" + \"\\n\".join(\n \"Disallow: /{locale}/search\".format(locale=locale)\n for locale in settings.ENABLED_LOCALES\n)\n\nROBOTS_GO_AWAY_TXT = \"\"\"\\\nUser-Agent: *\nDisallow: /\n\"\"\"\n\n\n@shared_cache_control\ndef robots_txt(request):\n \"\"\"Serve robots.txt that allows or forbids robots.\"\"\"\n host = request.get_host()\n if host in settings.ALLOW_ROBOTS_DOMAINS:\n robots = \"\"\n elif host in settings.ALLOW_ROBOTS_WEB_DOMAINS:\n if host == settings.WIKI_HOST:\n robots = ROBOTS_ALL_ALLOWED_TXT\n else:\n robots = ROBOTS_ALLOWED_TXT\n else:\n robots = ROBOTS_GO_AWAY_TXT\n return HttpResponse(robots, content_type=\"text/plain\")\n\n\nclass FaviconRedirect(RedirectView):\n \"\"\"Redirect to the favicon in the static img folder (bug 1402497)\"\"\"\n\n def get_redirect_url(self, *args, **kwargs):\n return favicon_url()\n", "path": "kuma/landing/views.py"}]}
| 1,441 | 109 |
gh_patches_debug_8995
|
rasdani/github-patches
|
git_diff
|
iterative__dvc-4124
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Newlines after dvc metrics diff
I am working on printing `dvc metrics diff --show-md` into a markdown document, i.e....
`dvc metrics diff --show-md >> doc.md`
and if I don't manually follow this command with a newline:
`echo >> doc.md`
Then everything that follows in `doc.md` gets inserted into the table. Is there maybe a newline character missing from the metrics .md table?
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `dvc/utils/diff.py`
Content:
```
1 import json
2 from collections import defaultdict
3
4
5 def _parse(raw):
6 if raw is None or isinstance(raw, (dict, list, int, float)):
7 return raw
8
9 assert isinstance(raw, str)
10 try:
11 return json.loads(raw)
12 except json.JSONDecodeError:
13 return raw
14
15
16 def _diff_vals(old, new, with_unchanged):
17 if (
18 isinstance(new, list)
19 and isinstance(old, list)
20 and len(old) == len(new) == 1
21 ):
22 return _diff_vals(old[0], new[0], with_unchanged)
23
24 if not with_unchanged and old == new:
25 return {}
26
27 res = {"old": old, "new": new}
28 if isinstance(new, (int, float)) and isinstance(old, (int, float)):
29 res["diff"] = new - old
30 return res
31
32
33 def _flatten(d):
34 if not d:
35 return defaultdict(lambda: None)
36
37 if isinstance(d, dict):
38 from flatten_json import flatten as fltn
39
40 return defaultdict(lambda: None, fltn(d, "."))
41
42 return defaultdict(lambda: "unable to parse")
43
44
45 def _diff_dicts(old_dict, new_dict, with_unchanged):
46 new = _flatten(new_dict)
47 old = _flatten(old_dict)
48
49 res = defaultdict(dict)
50
51 xpaths = set(old.keys())
52 xpaths.update(set(new.keys()))
53 for xpath in xpaths:
54 old_val = old[xpath]
55 new_val = new[xpath]
56 val_diff = _diff_vals(old_val, new_val, with_unchanged)
57 if val_diff:
58 res[xpath] = val_diff
59 return dict(res)
60
61
62 def _diff(old_raw, new_raw, with_unchanged):
63 old = _parse(old_raw)
64 new = _parse(new_raw)
65
66 if isinstance(new, dict) or isinstance(old, dict):
67 return _diff_dicts(old, new, with_unchanged)
68
69 val_diff = _diff_vals(old, new, with_unchanged)
70 if val_diff:
71 return {"": val_diff}
72
73 return {}
74
75
76 def diff(old, new, with_unchanged=False):
77 paths = set(old.keys())
78 paths.update(set(new.keys()))
79
80 res = defaultdict(dict)
81 for path in paths:
82 path_diff = _diff(old.get(path), new.get(path), with_unchanged)
83 if path_diff:
84 res[path] = path_diff
85 return dict(res)
86
87
88 def table(header, rows, markdown=False):
89 from tabulate import tabulate
90
91 if not rows and not markdown:
92 return ""
93
94 return tabulate(
95 rows,
96 header,
97 tablefmt="github" if markdown else "plain",
98 disable_numparse=True,
99 # None will be shown as "" by default, overriding
100 missingval="None",
101 )
102
103
104 def format_dict(d):
105 ret = {}
106 for key, val in d.items():
107 if isinstance(val, dict):
108 new_val = format_dict(val)
109 elif isinstance(val, list):
110 new_val = str(val)
111 else:
112 new_val = val
113 ret[key] = new_val
114 return ret
115
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/dvc/utils/diff.py b/dvc/utils/diff.py
--- a/dvc/utils/diff.py
+++ b/dvc/utils/diff.py
@@ -91,7 +91,7 @@
if not rows and not markdown:
return ""
- return tabulate(
+ ret = tabulate(
rows,
header,
tablefmt="github" if markdown else "plain",
@@ -100,6 +100,12 @@
missingval="None",
)
+ if markdown:
+ # NOTE: md table is incomplete without the trailing newline
+ ret += "\n"
+
+ return ret
+
def format_dict(d):
ret = {}
|
{"golden_diff": "diff --git a/dvc/utils/diff.py b/dvc/utils/diff.py\n--- a/dvc/utils/diff.py\n+++ b/dvc/utils/diff.py\n@@ -91,7 +91,7 @@\n if not rows and not markdown:\n return \"\"\n \n- return tabulate(\n+ ret = tabulate(\n rows,\n header,\n tablefmt=\"github\" if markdown else \"plain\",\n@@ -100,6 +100,12 @@\n missingval=\"None\",\n )\n \n+ if markdown:\n+ # NOTE: md table is incomplete without the trailing newline\n+ ret += \"\\n\"\n+\n+ return ret\n+\n \n def format_dict(d):\n ret = {}\n", "issue": "Newlines after dvc metrics diff\nI am working on printing `dvc metrics diff --show-md` into a markdown document, i.e....\r\n\r\n`dvc metrics diff --show-md >> doc.md`\r\n\r\n and if I don't manually follow this command with a newline:\r\n`echo >> doc.md`\r\n\r\nThen everything that follows in `doc.md` gets inserted into the table. Is there maybe a newline character missing from the metrics .md table?\n", "before_files": [{"content": "import json\nfrom collections import defaultdict\n\n\ndef _parse(raw):\n if raw is None or isinstance(raw, (dict, list, int, float)):\n return raw\n\n assert isinstance(raw, str)\n try:\n return json.loads(raw)\n except json.JSONDecodeError:\n return raw\n\n\ndef _diff_vals(old, new, with_unchanged):\n if (\n isinstance(new, list)\n and isinstance(old, list)\n and len(old) == len(new) == 1\n ):\n return _diff_vals(old[0], new[0], with_unchanged)\n\n if not with_unchanged and old == new:\n return {}\n\n res = {\"old\": old, \"new\": new}\n if isinstance(new, (int, float)) and isinstance(old, (int, float)):\n res[\"diff\"] = new - old\n return res\n\n\ndef _flatten(d):\n if not d:\n return defaultdict(lambda: None)\n\n if isinstance(d, dict):\n from flatten_json import flatten as fltn\n\n return defaultdict(lambda: None, fltn(d, \".\"))\n\n return defaultdict(lambda: \"unable to parse\")\n\n\ndef _diff_dicts(old_dict, new_dict, with_unchanged):\n new = _flatten(new_dict)\n old = _flatten(old_dict)\n\n res = defaultdict(dict)\n\n xpaths = set(old.keys())\n xpaths.update(set(new.keys()))\n for xpath in xpaths:\n old_val = old[xpath]\n new_val = new[xpath]\n val_diff = _diff_vals(old_val, new_val, with_unchanged)\n if val_diff:\n res[xpath] = val_diff\n return dict(res)\n\n\ndef _diff(old_raw, new_raw, with_unchanged):\n old = _parse(old_raw)\n new = _parse(new_raw)\n\n if isinstance(new, dict) or isinstance(old, dict):\n return _diff_dicts(old, new, with_unchanged)\n\n val_diff = _diff_vals(old, new, with_unchanged)\n if val_diff:\n return {\"\": val_diff}\n\n return {}\n\n\ndef diff(old, new, with_unchanged=False):\n paths = set(old.keys())\n paths.update(set(new.keys()))\n\n res = defaultdict(dict)\n for path in paths:\n path_diff = _diff(old.get(path), new.get(path), with_unchanged)\n if path_diff:\n res[path] = path_diff\n return dict(res)\n\n\ndef table(header, rows, markdown=False):\n from tabulate import tabulate\n\n if not rows and not markdown:\n return \"\"\n\n return tabulate(\n rows,\n header,\n tablefmt=\"github\" if markdown else \"plain\",\n disable_numparse=True,\n # None will be shown as \"\" by default, overriding\n missingval=\"None\",\n )\n\n\ndef format_dict(d):\n ret = {}\n for key, val in d.items():\n if isinstance(val, dict):\n new_val = format_dict(val)\n elif isinstance(val, list):\n new_val = str(val)\n else:\n new_val = val\n ret[key] = new_val\n return ret\n", "path": "dvc/utils/diff.py"}], "after_files": [{"content": "import json\nfrom collections import defaultdict\n\n\ndef _parse(raw):\n if raw is None or isinstance(raw, (dict, list, int, float)):\n return raw\n\n assert isinstance(raw, str)\n try:\n return json.loads(raw)\n except json.JSONDecodeError:\n return raw\n\n\ndef _diff_vals(old, new, with_unchanged):\n if (\n isinstance(new, list)\n and isinstance(old, list)\n and len(old) == len(new) == 1\n ):\n return _diff_vals(old[0], new[0], with_unchanged)\n\n if not with_unchanged and old == new:\n return {}\n\n res = {\"old\": old, \"new\": new}\n if isinstance(new, (int, float)) and isinstance(old, (int, float)):\n res[\"diff\"] = new - old\n return res\n\n\ndef _flatten(d):\n if not d:\n return defaultdict(lambda: None)\n\n if isinstance(d, dict):\n from flatten_json import flatten as fltn\n\n return defaultdict(lambda: None, fltn(d, \".\"))\n\n return defaultdict(lambda: \"unable to parse\")\n\n\ndef _diff_dicts(old_dict, new_dict, with_unchanged):\n new = _flatten(new_dict)\n old = _flatten(old_dict)\n\n res = defaultdict(dict)\n\n xpaths = set(old.keys())\n xpaths.update(set(new.keys()))\n for xpath in xpaths:\n old_val = old[xpath]\n new_val = new[xpath]\n val_diff = _diff_vals(old_val, new_val, with_unchanged)\n if val_diff:\n res[xpath] = val_diff\n return dict(res)\n\n\ndef _diff(old_raw, new_raw, with_unchanged):\n old = _parse(old_raw)\n new = _parse(new_raw)\n\n if isinstance(new, dict) or isinstance(old, dict):\n return _diff_dicts(old, new, with_unchanged)\n\n val_diff = _diff_vals(old, new, with_unchanged)\n if val_diff:\n return {\"\": val_diff}\n\n return {}\n\n\ndef diff(old, new, with_unchanged=False):\n paths = set(old.keys())\n paths.update(set(new.keys()))\n\n res = defaultdict(dict)\n for path in paths:\n path_diff = _diff(old.get(path), new.get(path), with_unchanged)\n if path_diff:\n res[path] = path_diff\n return dict(res)\n\n\ndef table(header, rows, markdown=False):\n from tabulate import tabulate\n\n if not rows and not markdown:\n return \"\"\n\n ret = tabulate(\n rows,\n header,\n tablefmt=\"github\" if markdown else \"plain\",\n disable_numparse=True,\n # None will be shown as \"\" by default, overriding\n missingval=\"None\",\n )\n\n if markdown:\n # NOTE: md table is incomplete without the trailing newline\n ret += \"\\n\"\n\n return ret\n\n\ndef format_dict(d):\n ret = {}\n for key, val in d.items():\n if isinstance(val, dict):\n new_val = format_dict(val)\n elif isinstance(val, list):\n new_val = str(val)\n else:\n new_val = val\n ret[key] = new_val\n return ret\n", "path": "dvc/utils/diff.py"}]}
| 1,285 | 158 |
gh_patches_debug_40889
|
rasdani/github-patches
|
git_diff
|
beeware__toga-2439
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Modifying Tree Widget nodes before the Tree is Expanded/Drawn in macOS
### Describe the bug
If you attempt to append, insert, remove, or modify a child node used as a data source for the Tree widget, before it has expanded and displayed those nodes, an **AttributeError: 'Node' object has no attribute '_impl'** will be generated. It appears that the child nodes are being generated on demand and don't exist until they have been displayed. A work around is to manually expand the Tree before doing any modifications.
### Steps to reproduce
A minimum script to reproduce the error is shown below. If you comment out `tree.expand()` the error will be thrown.
```
import toga
def build(app):
tree = toga.Tree(headings=["Type", "Text", "Options", "ID"])
root_node = tree.data.append(dict(type="Root Node", text="", options="", ID="0"))
leaf_node = dict(type="Spelling", text="word", options="opt", id="0", root=False)
tree.expand()
#root_node.append(leaf_node)
root_node.insert(0, leaf_node)
return tree
def main():
return toga.App("Node Test App", "au.com.reefwing.node_test", startup=build)
if __name__ == "__main__":
main().main_loop()
```
### Expected behavior
It should be possible to modify the underlying Tree data model regardless of the state of the UI widget.
### Screenshots
_No response_
### Environment
- Operating System: macOS
- Python version: 3.11
- Software versions:
- Briefcase:
- Toga: 0.4.2
### Logs
```
File "/Users/dsuch/Documents/BeeWare/tests/node_test.py", line 14, in build
root_node.insert(0, leaf_node)
File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/toga/sources/tree_source.py", line 122, in insert
self._source.notify("insert", parent=self, index=index, item=node)
File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/toga/sources/base.py", line 84, in notify
method(**kwargs)
File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/toga_cocoa/widgets/tree.py", line 223, in insert
inParent=parent._impl if parent else None,
^^^^^^^^^^^^
AttributeError: 'Node' object has no attribute '_impl'
```
### Additional context
_No response_
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `cocoa/src/toga_cocoa/widgets/tree.py`
Content:
```
1 from rubicon.objc import SEL, at, objc_method, objc_property
2 from travertino.size import at_least
3
4 import toga
5 from toga_cocoa.libs import (
6 NSBezelBorder,
7 NSIndexSet,
8 NSOutlineView,
9 NSScrollView,
10 NSTableColumn,
11 NSTableViewAnimation,
12 NSTableViewColumnAutoresizingStyle,
13 )
14 from toga_cocoa.widgets.base import Widget
15 from toga_cocoa.widgets.internal.cells import TogaIconView
16 from toga_cocoa.widgets.internal.data import TogaData
17
18
19 class TogaTree(NSOutlineView):
20 interface = objc_property(object, weak=True)
21 impl = objc_property(object, weak=True)
22
23 # OutlineViewDataSource methods
24 @objc_method
25 def outlineView_child_ofItem_(self, tree, child: int, item):
26 # Get the object representing the row
27 if item is None:
28 node = self.interface.data[child]
29 else:
30 node = item.attrs["node"][child]
31
32 # Get the Cocoa implementation for the row. If an _impl
33 # doesn't exist, create a data object for it, and
34 # populate it with initial values for each column.
35 try:
36 node_impl = node._impl
37 except AttributeError:
38 node_impl = TogaData.alloc().init()
39 node_impl.attrs = {"node": node}
40 node._impl = node_impl
41
42 return node_impl
43
44 @objc_method
45 def outlineView_isItemExpandable_(self, tree, item) -> bool:
46 return item.attrs["node"].can_have_children()
47
48 @objc_method
49 def outlineView_numberOfChildrenOfItem_(self, tree, item) -> int:
50 if item is None:
51 # How many root elements are there?
52 # If we're starting up, the source may not exist yet.
53 if self.interface.data is not None:
54 return len(self.interface.data)
55 else:
56 return 0
57 else:
58 # How many children does this node have?
59 return len(item.attrs["node"])
60
61 @objc_method
62 def outlineView_viewForTableColumn_item_(self, tree, column, item):
63 col_identifier = str(column.identifier)
64
65 try:
66 value = getattr(item.attrs["node"], col_identifier)
67
68 # if the value is a widget itself, just draw the widget!
69 if isinstance(value, toga.Widget):
70 return value._impl.native
71
72 # Allow for an (icon, value) tuple as the simple case
73 # for encoding an icon in a table cell. Otherwise, look
74 # for an icon attribute.
75 elif isinstance(value, tuple):
76 icon, value = value
77 else:
78 try:
79 icon = value.icon
80 except AttributeError:
81 icon = None
82 except AttributeError:
83 # If the node doesn't have a property with the
84 # accessor name, assume an empty string value.
85 value = self.interface.missing_value
86 icon = None
87
88 # creates a NSTableCellView from interface-builder template (does not exist)
89 # or reuses an existing view which is currently not needed for painting
90 # returns None (nil) if both fails
91 identifier = at(f"CellView_{self.interface.id}")
92 tcv = self.makeViewWithIdentifier(identifier, owner=self)
93
94 if not tcv: # there is no existing view to reuse so create a new one
95 # tcv = TogaIconView.alloc().initWithFrame(CGRectMake(0, 0, column.width, 16))
96 tcv = TogaIconView.alloc().init()
97 tcv.identifier = identifier
98
99 # Prevent tcv from being deallocated prematurely when no Python references
100 # are left
101 tcv.retain()
102 tcv.autorelease()
103
104 tcv.setText(str(value))
105 if icon:
106 tcv.setImage(icon._impl.native)
107 else:
108 tcv.setImage(None)
109
110 return tcv
111
112 # 2023-06-29: Commented out this method because it appears to be a
113 # source of significant slowdown when the table has a lot of data
114 # (10k rows). AFAICT, it's only needed if we want custom row heights
115 # for each row. Since we don't currently support custom row heights,
116 # we're paying the cost for no benefit.
117 # @objc_method
118 # def outlineView_heightOfRowByItem_(self, tree, item) -> float:
119 # default_row_height = self.rowHeight
120
121 # if item is self:
122 # return default_row_height
123
124 # heights = [default_row_height]
125
126 # for column in self.tableColumns:
127 # value = getattr(
128 # item.attrs["node"], str(column.identifier), self.interface.missing_value
129 # )
130
131 # if isinstance(value, toga.Widget):
132 # # if the cell value is a widget, use its height
133 # heights.append(value._impl.native.intrinsicContentSize().height)
134
135 # return max(heights)
136
137 @objc_method
138 def outlineView_pasteboardWriterForItem_(
139 self, tree, item
140 ) -> None: # pragma: no cover
141 # this seems to be required to prevent issue 21562075 in AppKit
142 return None
143
144 # @objc_method
145 # def outlineView_sortDescriptorsDidChange_(self, tableView, oldDescriptors) -> None:
146 #
147 # for descriptor in self.sortDescriptors[::-1]:
148 # accessor = descriptor.key
149 # reverse = descriptor.ascending == 1
150 # key = self.interface._sort_keys[str(accessor)]
151 # try:
152 # self.interface.data.sort(str(accessor), reverse=reverse, key=key)
153 # except AttributeError:
154 # pass
155 # else:
156 # self.reloadData()
157
158 # OutlineViewDelegate methods
159 @objc_method
160 def outlineViewSelectionDidChange_(self, notification) -> None:
161 self.interface.on_select()
162
163 # target methods
164 @objc_method
165 def onDoubleClick_(self, sender) -> None:
166 node = self.itemAtRow(self.clickedRow).attrs["node"]
167 self.interface.on_activate(node=node)
168
169
170 class Tree(Widget):
171 def create(self):
172 # Create a tree view, and put it in a scroll view.
173 # The scroll view is the _impl, because it's the outer container.
174 self.native = NSScrollView.alloc().init()
175 self.native.hasVerticalScroller = True
176 self.native.hasHorizontalScroller = False
177 self.native.autohidesScrollers = False
178 self.native.borderType = NSBezelBorder
179
180 # Create the Tree widget
181 self.native_tree = TogaTree.alloc().init()
182 self.native_tree.interface = self.interface
183 self.native_tree.impl = self
184 self.native_tree.columnAutoresizingStyle = (
185 NSTableViewColumnAutoresizingStyle.Uniform
186 )
187 self.native_tree.usesAlternatingRowBackgroundColors = True
188 self.native_tree.allowsMultipleSelection = self.interface.multiple_select
189
190 # Create columns for the table
191 self.columns = []
192 if self.interface.headings:
193 for index, (heading, accessor) in enumerate(
194 zip(self.interface.headings, self.interface.accessors)
195 ):
196 self._insert_column(index, heading, accessor)
197 else:
198 self.native_tree.setHeaderView(None)
199 for index, accessor in enumerate(self.interface.accessors):
200 self._insert_column(index, None, accessor)
201
202 # Put the tree arrows in the first column.
203 self.native_tree.outlineTableColumn = self.columns[0]
204
205 self.native_tree.delegate = self.native_tree
206 self.native_tree.dataSource = self.native_tree
207 self.native_tree.target = self.native_tree
208 self.native_tree.doubleAction = SEL("onDoubleClick:")
209
210 # Embed the tree view in the scroll view
211 self.native.documentView = self.native_tree
212
213 # Add the layout constraints
214 self.add_constraints()
215
216 def change_source(self, source):
217 self.native_tree.reloadData()
218
219 def insert(self, parent, index, item):
220 index_set = NSIndexSet.indexSetWithIndex(index)
221 self.native_tree.insertItemsAtIndexes(
222 index_set,
223 inParent=parent._impl if parent else None,
224 withAnimation=NSTableViewAnimation.SlideDown.value,
225 )
226
227 def change(self, item):
228 self.native_tree.reloadItem(item._impl)
229
230 def remove(self, parent, index, item):
231 index = self.native_tree.childIndexForItem(item._impl)
232 index_set = NSIndexSet.indexSetWithIndex(index)
233 parent = self.native_tree.parentForItem(item._impl)
234 self.native_tree.removeItemsAtIndexes(
235 index_set,
236 inParent=parent,
237 withAnimation=NSTableViewAnimation.SlideUp.value,
238 )
239
240 def clear(self):
241 self.native_tree.reloadData()
242
243 def get_selection(self):
244 if self.interface.multiple_select:
245 selection = []
246
247 current_index = self.native_tree.selectedRowIndexes.firstIndex
248 for i in range(self.native_tree.selectedRowIndexes.count):
249 selection.append(
250 self.native_tree.itemAtRow(current_index).attrs["node"]
251 )
252 current_index = (
253 self.native_tree.selectedRowIndexes.indexGreaterThanIndex(
254 current_index
255 )
256 )
257
258 return selection
259 else:
260 index = self.native_tree.selectedRow
261 if index != -1:
262 return self.native_tree.itemAtRow(index).attrs["node"]
263 else:
264 return None
265
266 def expand_node(self, node):
267 self.native_tree.expandItem(node._impl, expandChildren=True)
268
269 def expand_all(self):
270 self.native_tree.expandItem(None, expandChildren=True)
271
272 def collapse_node(self, node):
273 self.native_tree.collapseItem(node._impl, collapseChildren=True)
274
275 def collapse_all(self):
276 self.native_tree.collapseItem(None, collapseChildren=True)
277
278 def _insert_column(self, index, heading, accessor):
279 column = NSTableColumn.alloc().initWithIdentifier(accessor)
280 column.minWidth = 16
281
282 self.columns.insert(index, column)
283 self.native_tree.addTableColumn(column)
284 if index != len(self.columns) - 1:
285 self.native_tree.moveColumn(len(self.columns) - 1, toColumn=index)
286
287 if heading is not None:
288 column.headerCell.stringValue = heading
289
290 def insert_column(self, index, heading, accessor):
291 self._insert_column(index, heading, accessor)
292 self.native_tree.sizeToFit()
293
294 def remove_column(self, index):
295 column = self.columns[index]
296 self.native_tree.removeTableColumn(column)
297
298 # delete column and identifier
299 self.columns.remove(column)
300 self.native_tree.sizeToFit()
301
302 def rehint(self):
303 self.interface.intrinsic.width = at_least(self.interface._MIN_WIDTH)
304 self.interface.intrinsic.height = at_least(self.interface._MIN_HEIGHT)
305
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/cocoa/src/toga_cocoa/widgets/tree.py b/cocoa/src/toga_cocoa/widgets/tree.py
--- a/cocoa/src/toga_cocoa/widgets/tree.py
+++ b/cocoa/src/toga_cocoa/widgets/tree.py
@@ -16,6 +16,15 @@
from toga_cocoa.widgets.internal.data import TogaData
+def node_impl(node):
+ try:
+ return node._impl
+ except AttributeError:
+ node._impl = TogaData.alloc().init()
+ node._impl.attrs = {"node": node}
+ return node._impl
+
+
class TogaTree(NSOutlineView):
interface = objc_property(object, weak=True)
impl = objc_property(object, weak=True)
@@ -32,14 +41,8 @@
# Get the Cocoa implementation for the row. If an _impl
# doesn't exist, create a data object for it, and
# populate it with initial values for each column.
- try:
- node_impl = node._impl
- except AttributeError:
- node_impl = TogaData.alloc().init()
- node_impl.attrs = {"node": node}
- node._impl = node_impl
- return node_impl
+ return node_impl(node)
@objc_method
def outlineView_isItemExpandable_(self, tree, item) -> bool:
@@ -220,22 +223,25 @@
index_set = NSIndexSet.indexSetWithIndex(index)
self.native_tree.insertItemsAtIndexes(
index_set,
- inParent=parent._impl if parent else None,
+ inParent=node_impl(parent) if parent else None,
withAnimation=NSTableViewAnimation.SlideDown.value,
)
def change(self, item):
- self.native_tree.reloadItem(item._impl)
+ self.native_tree.reloadItem(node_impl(item))
def remove(self, parent, index, item):
- index = self.native_tree.childIndexForItem(item._impl)
- index_set = NSIndexSet.indexSetWithIndex(index)
- parent = self.native_tree.parentForItem(item._impl)
- self.native_tree.removeItemsAtIndexes(
- index_set,
- inParent=parent,
- withAnimation=NSTableViewAnimation.SlideUp.value,
- )
+ try:
+ index = self.native_tree.childIndexForItem(item._impl)
+ index_set = NSIndexSet.indexSetWithIndex(index)
+ parent = self.native_tree.parentForItem(item._impl)
+ self.native_tree.removeItemsAtIndexes(
+ index_set,
+ inParent=parent,
+ withAnimation=NSTableViewAnimation.SlideUp.value,
+ )
+ except AttributeError:
+ pass
def clear(self):
self.native_tree.reloadData()
@@ -264,13 +270,13 @@
return None
def expand_node(self, node):
- self.native_tree.expandItem(node._impl, expandChildren=True)
+ self.native_tree.expandItem(node_impl(node), expandChildren=True)
def expand_all(self):
self.native_tree.expandItem(None, expandChildren=True)
def collapse_node(self, node):
- self.native_tree.collapseItem(node._impl, collapseChildren=True)
+ self.native_tree.collapseItem(node_impl(node), collapseChildren=True)
def collapse_all(self):
self.native_tree.collapseItem(None, collapseChildren=True)
|
{"golden_diff": "diff --git a/cocoa/src/toga_cocoa/widgets/tree.py b/cocoa/src/toga_cocoa/widgets/tree.py\n--- a/cocoa/src/toga_cocoa/widgets/tree.py\n+++ b/cocoa/src/toga_cocoa/widgets/tree.py\n@@ -16,6 +16,15 @@\n from toga_cocoa.widgets.internal.data import TogaData\n \n \n+def node_impl(node):\n+ try:\n+ return node._impl\n+ except AttributeError:\n+ node._impl = TogaData.alloc().init()\n+ node._impl.attrs = {\"node\": node}\n+ return node._impl\n+\n+\n class TogaTree(NSOutlineView):\n interface = objc_property(object, weak=True)\n impl = objc_property(object, weak=True)\n@@ -32,14 +41,8 @@\n # Get the Cocoa implementation for the row. If an _impl\n # doesn't exist, create a data object for it, and\n # populate it with initial values for each column.\n- try:\n- node_impl = node._impl\n- except AttributeError:\n- node_impl = TogaData.alloc().init()\n- node_impl.attrs = {\"node\": node}\n- node._impl = node_impl\n \n- return node_impl\n+ return node_impl(node)\n \n @objc_method\n def outlineView_isItemExpandable_(self, tree, item) -> bool:\n@@ -220,22 +223,25 @@\n index_set = NSIndexSet.indexSetWithIndex(index)\n self.native_tree.insertItemsAtIndexes(\n index_set,\n- inParent=parent._impl if parent else None,\n+ inParent=node_impl(parent) if parent else None,\n withAnimation=NSTableViewAnimation.SlideDown.value,\n )\n \n def change(self, item):\n- self.native_tree.reloadItem(item._impl)\n+ self.native_tree.reloadItem(node_impl(item))\n \n def remove(self, parent, index, item):\n- index = self.native_tree.childIndexForItem(item._impl)\n- index_set = NSIndexSet.indexSetWithIndex(index)\n- parent = self.native_tree.parentForItem(item._impl)\n- self.native_tree.removeItemsAtIndexes(\n- index_set,\n- inParent=parent,\n- withAnimation=NSTableViewAnimation.SlideUp.value,\n- )\n+ try:\n+ index = self.native_tree.childIndexForItem(item._impl)\n+ index_set = NSIndexSet.indexSetWithIndex(index)\n+ parent = self.native_tree.parentForItem(item._impl)\n+ self.native_tree.removeItemsAtIndexes(\n+ index_set,\n+ inParent=parent,\n+ withAnimation=NSTableViewAnimation.SlideUp.value,\n+ )\n+ except AttributeError:\n+ pass\n \n def clear(self):\n self.native_tree.reloadData()\n@@ -264,13 +270,13 @@\n return None\n \n def expand_node(self, node):\n- self.native_tree.expandItem(node._impl, expandChildren=True)\n+ self.native_tree.expandItem(node_impl(node), expandChildren=True)\n \n def expand_all(self):\n self.native_tree.expandItem(None, expandChildren=True)\n \n def collapse_node(self, node):\n- self.native_tree.collapseItem(node._impl, collapseChildren=True)\n+ self.native_tree.collapseItem(node_impl(node), collapseChildren=True)\n \n def collapse_all(self):\n self.native_tree.collapseItem(None, collapseChildren=True)\n", "issue": "Modifying Tree Widget nodes before the Tree is Expanded/Drawn in macOS\n### Describe the bug\n\nIf you attempt to append, insert, remove, or modify a child node used as a data source for the Tree widget, before it has expanded and displayed those nodes, an **AttributeError: 'Node' object has no attribute '_impl'** will be generated. It appears that the child nodes are being generated on demand and don't exist until they have been displayed. A work around is to manually expand the Tree before doing any modifications.\n\n### Steps to reproduce\n\nA minimum script to reproduce the error is shown below. If you comment out `tree.expand()` the error will be thrown.\r\n\r\n```\r\nimport toga\r\n\r\ndef build(app):\r\n tree = toga.Tree(headings=[\"Type\", \"Text\", \"Options\", \"ID\"])\r\n root_node = tree.data.append(dict(type=\"Root Node\", text=\"\", options=\"\", ID=\"0\"))\r\n leaf_node = dict(type=\"Spelling\", text=\"word\", options=\"opt\", id=\"0\", root=False)\r\n tree.expand()\r\n #root_node.append(leaf_node)\r\n root_node.insert(0, leaf_node)\r\n return tree\r\n\r\ndef main():\r\n return toga.App(\"Node Test App\", \"au.com.reefwing.node_test\", startup=build)\r\n\r\nif __name__ == \"__main__\":\r\n main().main_loop()\r\n```\n\n### Expected behavior\n\nIt should be possible to modify the underlying Tree data model regardless of the state of the UI widget.\n\n### Screenshots\n\n_No response_\n\n### Environment\n\n- Operating System: macOS\r\n- Python version: 3.11\r\n- Software versions:\r\n - Briefcase:\r\n - Toga: 0.4.2\r\n\n\n### Logs\n\n```\r\nFile \"/Users/dsuch/Documents/BeeWare/tests/node_test.py\", line 14, in build\r\n root_node.insert(0, leaf_node)\r\n File \"/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/toga/sources/tree_source.py\", line 122, in insert\r\n self._source.notify(\"insert\", parent=self, index=index, item=node)\r\n File \"/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/toga/sources/base.py\", line 84, in notify\r\n method(**kwargs)\r\n File \"/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/toga_cocoa/widgets/tree.py\", line 223, in insert\r\n inParent=parent._impl if parent else None,\r\n ^^^^^^^^^^^^\r\nAttributeError: 'Node' object has no attribute '_impl'\r\n```\r\n\n\n### Additional context\n\n_No response_\n", "before_files": [{"content": "from rubicon.objc import SEL, at, objc_method, objc_property\nfrom travertino.size import at_least\n\nimport toga\nfrom toga_cocoa.libs import (\n NSBezelBorder,\n NSIndexSet,\n NSOutlineView,\n NSScrollView,\n NSTableColumn,\n NSTableViewAnimation,\n NSTableViewColumnAutoresizingStyle,\n)\nfrom toga_cocoa.widgets.base import Widget\nfrom toga_cocoa.widgets.internal.cells import TogaIconView\nfrom toga_cocoa.widgets.internal.data import TogaData\n\n\nclass TogaTree(NSOutlineView):\n interface = objc_property(object, weak=True)\n impl = objc_property(object, weak=True)\n\n # OutlineViewDataSource methods\n @objc_method\n def outlineView_child_ofItem_(self, tree, child: int, item):\n # Get the object representing the row\n if item is None:\n node = self.interface.data[child]\n else:\n node = item.attrs[\"node\"][child]\n\n # Get the Cocoa implementation for the row. If an _impl\n # doesn't exist, create a data object for it, and\n # populate it with initial values for each column.\n try:\n node_impl = node._impl\n except AttributeError:\n node_impl = TogaData.alloc().init()\n node_impl.attrs = {\"node\": node}\n node._impl = node_impl\n\n return node_impl\n\n @objc_method\n def outlineView_isItemExpandable_(self, tree, item) -> bool:\n return item.attrs[\"node\"].can_have_children()\n\n @objc_method\n def outlineView_numberOfChildrenOfItem_(self, tree, item) -> int:\n if item is None:\n # How many root elements are there?\n # If we're starting up, the source may not exist yet.\n if self.interface.data is not None:\n return len(self.interface.data)\n else:\n return 0\n else:\n # How many children does this node have?\n return len(item.attrs[\"node\"])\n\n @objc_method\n def outlineView_viewForTableColumn_item_(self, tree, column, item):\n col_identifier = str(column.identifier)\n\n try:\n value = getattr(item.attrs[\"node\"], col_identifier)\n\n # if the value is a widget itself, just draw the widget!\n if isinstance(value, toga.Widget):\n return value._impl.native\n\n # Allow for an (icon, value) tuple as the simple case\n # for encoding an icon in a table cell. Otherwise, look\n # for an icon attribute.\n elif isinstance(value, tuple):\n icon, value = value\n else:\n try:\n icon = value.icon\n except AttributeError:\n icon = None\n except AttributeError:\n # If the node doesn't have a property with the\n # accessor name, assume an empty string value.\n value = self.interface.missing_value\n icon = None\n\n # creates a NSTableCellView from interface-builder template (does not exist)\n # or reuses an existing view which is currently not needed for painting\n # returns None (nil) if both fails\n identifier = at(f\"CellView_{self.interface.id}\")\n tcv = self.makeViewWithIdentifier(identifier, owner=self)\n\n if not tcv: # there is no existing view to reuse so create a new one\n # tcv = TogaIconView.alloc().initWithFrame(CGRectMake(0, 0, column.width, 16))\n tcv = TogaIconView.alloc().init()\n tcv.identifier = identifier\n\n # Prevent tcv from being deallocated prematurely when no Python references\n # are left\n tcv.retain()\n tcv.autorelease()\n\n tcv.setText(str(value))\n if icon:\n tcv.setImage(icon._impl.native)\n else:\n tcv.setImage(None)\n\n return tcv\n\n # 2023-06-29: Commented out this method because it appears to be a\n # source of significant slowdown when the table has a lot of data\n # (10k rows). AFAICT, it's only needed if we want custom row heights\n # for each row. Since we don't currently support custom row heights,\n # we're paying the cost for no benefit.\n # @objc_method\n # def outlineView_heightOfRowByItem_(self, tree, item) -> float:\n # default_row_height = self.rowHeight\n\n # if item is self:\n # return default_row_height\n\n # heights = [default_row_height]\n\n # for column in self.tableColumns:\n # value = getattr(\n # item.attrs[\"node\"], str(column.identifier), self.interface.missing_value\n # )\n\n # if isinstance(value, toga.Widget):\n # # if the cell value is a widget, use its height\n # heights.append(value._impl.native.intrinsicContentSize().height)\n\n # return max(heights)\n\n @objc_method\n def outlineView_pasteboardWriterForItem_(\n self, tree, item\n ) -> None: # pragma: no cover\n # this seems to be required to prevent issue 21562075 in AppKit\n return None\n\n # @objc_method\n # def outlineView_sortDescriptorsDidChange_(self, tableView, oldDescriptors) -> None:\n #\n # for descriptor in self.sortDescriptors[::-1]:\n # accessor = descriptor.key\n # reverse = descriptor.ascending == 1\n # key = self.interface._sort_keys[str(accessor)]\n # try:\n # self.interface.data.sort(str(accessor), reverse=reverse, key=key)\n # except AttributeError:\n # pass\n # else:\n # self.reloadData()\n\n # OutlineViewDelegate methods\n @objc_method\n def outlineViewSelectionDidChange_(self, notification) -> None:\n self.interface.on_select()\n\n # target methods\n @objc_method\n def onDoubleClick_(self, sender) -> None:\n node = self.itemAtRow(self.clickedRow).attrs[\"node\"]\n self.interface.on_activate(node=node)\n\n\nclass Tree(Widget):\n def create(self):\n # Create a tree view, and put it in a scroll view.\n # The scroll view is the _impl, because it's the outer container.\n self.native = NSScrollView.alloc().init()\n self.native.hasVerticalScroller = True\n self.native.hasHorizontalScroller = False\n self.native.autohidesScrollers = False\n self.native.borderType = NSBezelBorder\n\n # Create the Tree widget\n self.native_tree = TogaTree.alloc().init()\n self.native_tree.interface = self.interface\n self.native_tree.impl = self\n self.native_tree.columnAutoresizingStyle = (\n NSTableViewColumnAutoresizingStyle.Uniform\n )\n self.native_tree.usesAlternatingRowBackgroundColors = True\n self.native_tree.allowsMultipleSelection = self.interface.multiple_select\n\n # Create columns for the table\n self.columns = []\n if self.interface.headings:\n for index, (heading, accessor) in enumerate(\n zip(self.interface.headings, self.interface.accessors)\n ):\n self._insert_column(index, heading, accessor)\n else:\n self.native_tree.setHeaderView(None)\n for index, accessor in enumerate(self.interface.accessors):\n self._insert_column(index, None, accessor)\n\n # Put the tree arrows in the first column.\n self.native_tree.outlineTableColumn = self.columns[0]\n\n self.native_tree.delegate = self.native_tree\n self.native_tree.dataSource = self.native_tree\n self.native_tree.target = self.native_tree\n self.native_tree.doubleAction = SEL(\"onDoubleClick:\")\n\n # Embed the tree view in the scroll view\n self.native.documentView = self.native_tree\n\n # Add the layout constraints\n self.add_constraints()\n\n def change_source(self, source):\n self.native_tree.reloadData()\n\n def insert(self, parent, index, item):\n index_set = NSIndexSet.indexSetWithIndex(index)\n self.native_tree.insertItemsAtIndexes(\n index_set,\n inParent=parent._impl if parent else None,\n withAnimation=NSTableViewAnimation.SlideDown.value,\n )\n\n def change(self, item):\n self.native_tree.reloadItem(item._impl)\n\n def remove(self, parent, index, item):\n index = self.native_tree.childIndexForItem(item._impl)\n index_set = NSIndexSet.indexSetWithIndex(index)\n parent = self.native_tree.parentForItem(item._impl)\n self.native_tree.removeItemsAtIndexes(\n index_set,\n inParent=parent,\n withAnimation=NSTableViewAnimation.SlideUp.value,\n )\n\n def clear(self):\n self.native_tree.reloadData()\n\n def get_selection(self):\n if self.interface.multiple_select:\n selection = []\n\n current_index = self.native_tree.selectedRowIndexes.firstIndex\n for i in range(self.native_tree.selectedRowIndexes.count):\n selection.append(\n self.native_tree.itemAtRow(current_index).attrs[\"node\"]\n )\n current_index = (\n self.native_tree.selectedRowIndexes.indexGreaterThanIndex(\n current_index\n )\n )\n\n return selection\n else:\n index = self.native_tree.selectedRow\n if index != -1:\n return self.native_tree.itemAtRow(index).attrs[\"node\"]\n else:\n return None\n\n def expand_node(self, node):\n self.native_tree.expandItem(node._impl, expandChildren=True)\n\n def expand_all(self):\n self.native_tree.expandItem(None, expandChildren=True)\n\n def collapse_node(self, node):\n self.native_tree.collapseItem(node._impl, collapseChildren=True)\n\n def collapse_all(self):\n self.native_tree.collapseItem(None, collapseChildren=True)\n\n def _insert_column(self, index, heading, accessor):\n column = NSTableColumn.alloc().initWithIdentifier(accessor)\n column.minWidth = 16\n\n self.columns.insert(index, column)\n self.native_tree.addTableColumn(column)\n if index != len(self.columns) - 1:\n self.native_tree.moveColumn(len(self.columns) - 1, toColumn=index)\n\n if heading is not None:\n column.headerCell.stringValue = heading\n\n def insert_column(self, index, heading, accessor):\n self._insert_column(index, heading, accessor)\n self.native_tree.sizeToFit()\n\n def remove_column(self, index):\n column = self.columns[index]\n self.native_tree.removeTableColumn(column)\n\n # delete column and identifier\n self.columns.remove(column)\n self.native_tree.sizeToFit()\n\n def rehint(self):\n self.interface.intrinsic.width = at_least(self.interface._MIN_WIDTH)\n self.interface.intrinsic.height = at_least(self.interface._MIN_HEIGHT)\n", "path": "cocoa/src/toga_cocoa/widgets/tree.py"}], "after_files": [{"content": "from rubicon.objc import SEL, at, objc_method, objc_property\nfrom travertino.size import at_least\n\nimport toga\nfrom toga_cocoa.libs import (\n NSBezelBorder,\n NSIndexSet,\n NSOutlineView,\n NSScrollView,\n NSTableColumn,\n NSTableViewAnimation,\n NSTableViewColumnAutoresizingStyle,\n)\nfrom toga_cocoa.widgets.base import Widget\nfrom toga_cocoa.widgets.internal.cells import TogaIconView\nfrom toga_cocoa.widgets.internal.data import TogaData\n\n\ndef node_impl(node):\n try:\n return node._impl\n except AttributeError:\n node._impl = TogaData.alloc().init()\n node._impl.attrs = {\"node\": node}\n return node._impl\n\n\nclass TogaTree(NSOutlineView):\n interface = objc_property(object, weak=True)\n impl = objc_property(object, weak=True)\n\n # OutlineViewDataSource methods\n @objc_method\n def outlineView_child_ofItem_(self, tree, child: int, item):\n # Get the object representing the row\n if item is None:\n node = self.interface.data[child]\n else:\n node = item.attrs[\"node\"][child]\n\n # Get the Cocoa implementation for the row. If an _impl\n # doesn't exist, create a data object for it, and\n # populate it with initial values for each column.\n\n return node_impl(node)\n\n @objc_method\n def outlineView_isItemExpandable_(self, tree, item) -> bool:\n return item.attrs[\"node\"].can_have_children()\n\n @objc_method\n def outlineView_numberOfChildrenOfItem_(self, tree, item) -> int:\n if item is None:\n # How many root elements are there?\n # If we're starting up, the source may not exist yet.\n if self.interface.data is not None:\n return len(self.interface.data)\n else:\n return 0\n else:\n # How many children does this node have?\n return len(item.attrs[\"node\"])\n\n @objc_method\n def outlineView_viewForTableColumn_item_(self, tree, column, item):\n col_identifier = str(column.identifier)\n\n try:\n value = getattr(item.attrs[\"node\"], col_identifier)\n\n # if the value is a widget itself, just draw the widget!\n if isinstance(value, toga.Widget):\n return value._impl.native\n\n # Allow for an (icon, value) tuple as the simple case\n # for encoding an icon in a table cell. Otherwise, look\n # for an icon attribute.\n elif isinstance(value, tuple):\n icon, value = value\n else:\n try:\n icon = value.icon\n except AttributeError:\n icon = None\n except AttributeError:\n # If the node doesn't have a property with the\n # accessor name, assume an empty string value.\n value = self.interface.missing_value\n icon = None\n\n # creates a NSTableCellView from interface-builder template (does not exist)\n # or reuses an existing view which is currently not needed for painting\n # returns None (nil) if both fails\n identifier = at(f\"CellView_{self.interface.id}\")\n tcv = self.makeViewWithIdentifier(identifier, owner=self)\n\n if not tcv: # there is no existing view to reuse so create a new one\n # tcv = TogaIconView.alloc().initWithFrame(CGRectMake(0, 0, column.width, 16))\n tcv = TogaIconView.alloc().init()\n tcv.identifier = identifier\n\n # Prevent tcv from being deallocated prematurely when no Python references\n # are left\n tcv.retain()\n tcv.autorelease()\n\n tcv.setText(str(value))\n if icon:\n tcv.setImage(icon._impl.native)\n else:\n tcv.setImage(None)\n\n return tcv\n\n # 2023-06-29: Commented out this method because it appears to be a\n # source of significant slowdown when the table has a lot of data\n # (10k rows). AFAICT, it's only needed if we want custom row heights\n # for each row. Since we don't currently support custom row heights,\n # we're paying the cost for no benefit.\n # @objc_method\n # def outlineView_heightOfRowByItem_(self, tree, item) -> float:\n # default_row_height = self.rowHeight\n\n # if item is self:\n # return default_row_height\n\n # heights = [default_row_height]\n\n # for column in self.tableColumns:\n # value = getattr(\n # item.attrs[\"node\"], str(column.identifier), self.interface.missing_value\n # )\n\n # if isinstance(value, toga.Widget):\n # # if the cell value is a widget, use its height\n # heights.append(value._impl.native.intrinsicContentSize().height)\n\n # return max(heights)\n\n @objc_method\n def outlineView_pasteboardWriterForItem_(\n self, tree, item\n ) -> None: # pragma: no cover\n # this seems to be required to prevent issue 21562075 in AppKit\n return None\n\n # @objc_method\n # def outlineView_sortDescriptorsDidChange_(self, tableView, oldDescriptors) -> None:\n #\n # for descriptor in self.sortDescriptors[::-1]:\n # accessor = descriptor.key\n # reverse = descriptor.ascending == 1\n # key = self.interface._sort_keys[str(accessor)]\n # try:\n # self.interface.data.sort(str(accessor), reverse=reverse, key=key)\n # except AttributeError:\n # pass\n # else:\n # self.reloadData()\n\n # OutlineViewDelegate methods\n @objc_method\n def outlineViewSelectionDidChange_(self, notification) -> None:\n self.interface.on_select()\n\n # target methods\n @objc_method\n def onDoubleClick_(self, sender) -> None:\n node = self.itemAtRow(self.clickedRow).attrs[\"node\"]\n self.interface.on_activate(node=node)\n\n\nclass Tree(Widget):\n def create(self):\n # Create a tree view, and put it in a scroll view.\n # The scroll view is the _impl, because it's the outer container.\n self.native = NSScrollView.alloc().init()\n self.native.hasVerticalScroller = True\n self.native.hasHorizontalScroller = False\n self.native.autohidesScrollers = False\n self.native.borderType = NSBezelBorder\n\n # Create the Tree widget\n self.native_tree = TogaTree.alloc().init()\n self.native_tree.interface = self.interface\n self.native_tree.impl = self\n self.native_tree.columnAutoresizingStyle = (\n NSTableViewColumnAutoresizingStyle.Uniform\n )\n self.native_tree.usesAlternatingRowBackgroundColors = True\n self.native_tree.allowsMultipleSelection = self.interface.multiple_select\n\n # Create columns for the table\n self.columns = []\n if self.interface.headings:\n for index, (heading, accessor) in enumerate(\n zip(self.interface.headings, self.interface.accessors)\n ):\n self._insert_column(index, heading, accessor)\n else:\n self.native_tree.setHeaderView(None)\n for index, accessor in enumerate(self.interface.accessors):\n self._insert_column(index, None, accessor)\n\n # Put the tree arrows in the first column.\n self.native_tree.outlineTableColumn = self.columns[0]\n\n self.native_tree.delegate = self.native_tree\n self.native_tree.dataSource = self.native_tree\n self.native_tree.target = self.native_tree\n self.native_tree.doubleAction = SEL(\"onDoubleClick:\")\n\n # Embed the tree view in the scroll view\n self.native.documentView = self.native_tree\n\n # Add the layout constraints\n self.add_constraints()\n\n def change_source(self, source):\n self.native_tree.reloadData()\n\n def insert(self, parent, index, item):\n index_set = NSIndexSet.indexSetWithIndex(index)\n self.native_tree.insertItemsAtIndexes(\n index_set,\n inParent=node_impl(parent) if parent else None,\n withAnimation=NSTableViewAnimation.SlideDown.value,\n )\n\n def change(self, item):\n self.native_tree.reloadItem(node_impl(item))\n\n def remove(self, parent, index, item):\n try:\n index = self.native_tree.childIndexForItem(item._impl)\n index_set = NSIndexSet.indexSetWithIndex(index)\n parent = self.native_tree.parentForItem(item._impl)\n self.native_tree.removeItemsAtIndexes(\n index_set,\n inParent=parent,\n withAnimation=NSTableViewAnimation.SlideUp.value,\n )\n except AttributeError:\n pass\n\n def clear(self):\n self.native_tree.reloadData()\n\n def get_selection(self):\n if self.interface.multiple_select:\n selection = []\n\n current_index = self.native_tree.selectedRowIndexes.firstIndex\n for i in range(self.native_tree.selectedRowIndexes.count):\n selection.append(\n self.native_tree.itemAtRow(current_index).attrs[\"node\"]\n )\n current_index = (\n self.native_tree.selectedRowIndexes.indexGreaterThanIndex(\n current_index\n )\n )\n\n return selection\n else:\n index = self.native_tree.selectedRow\n if index != -1:\n return self.native_tree.itemAtRow(index).attrs[\"node\"]\n else:\n return None\n\n def expand_node(self, node):\n self.native_tree.expandItem(node_impl(node), expandChildren=True)\n\n def expand_all(self):\n self.native_tree.expandItem(None, expandChildren=True)\n\n def collapse_node(self, node):\n self.native_tree.collapseItem(node_impl(node), collapseChildren=True)\n\n def collapse_all(self):\n self.native_tree.collapseItem(None, collapseChildren=True)\n\n def _insert_column(self, index, heading, accessor):\n column = NSTableColumn.alloc().initWithIdentifier(accessor)\n column.minWidth = 16\n\n self.columns.insert(index, column)\n self.native_tree.addTableColumn(column)\n if index != len(self.columns) - 1:\n self.native_tree.moveColumn(len(self.columns) - 1, toColumn=index)\n\n if heading is not None:\n column.headerCell.stringValue = heading\n\n def insert_column(self, index, heading, accessor):\n self._insert_column(index, heading, accessor)\n self.native_tree.sizeToFit()\n\n def remove_column(self, index):\n column = self.columns[index]\n self.native_tree.removeTableColumn(column)\n\n # delete column and identifier\n self.columns.remove(column)\n self.native_tree.sizeToFit()\n\n def rehint(self):\n self.interface.intrinsic.width = at_least(self.interface._MIN_WIDTH)\n self.interface.intrinsic.height = at_least(self.interface._MIN_HEIGHT)\n", "path": "cocoa/src/toga_cocoa/widgets/tree.py"}]}
| 4,010 | 752 |
gh_patches_debug_9385
|
rasdani/github-patches
|
git_diff
|
crytic__slither-357
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
solc-version detector: Missing 0.5.11
`0.5.11` is incorrectly reported as an old version.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `slither/detectors/attributes/incorrect_solc.py`
Content:
```
1 """
2 Check if an incorrect version of solc is used
3 """
4
5 import re
6 from slither.detectors.abstract_detector import AbstractDetector, DetectorClassification
7 from slither.formatters.attributes.incorrect_solc import format
8
9 # group:
10 # 0: ^ > >= < <= (optional)
11 # 1: ' ' (optional)
12 # 2: version number
13 # 3: version number
14 # 4: version number
15 PATTERN = re.compile('(\^|>|>=|<|<=)?([ ]+)?(\d+)\.(\d+)\.(\d+)')
16
17 class IncorrectSolc(AbstractDetector):
18 """
19 Check if an old version of solc is used
20 """
21
22 ARGUMENT = 'solc-version'
23 HELP = 'Incorrect Solidity version (< 0.4.24 or complex pragma)'
24 IMPACT = DetectorClassification.INFORMATIONAL
25 CONFIDENCE = DetectorClassification.HIGH
26
27 WIKI = 'https://github.com/crytic/slither/wiki/Detector-Documentation#incorrect-versions-of-solidity'
28
29 WIKI_TITLE = 'Incorrect versions of Solidity'
30 WIKI_DESCRIPTION = '''
31 Solc frequently releases new compiler versions. Using an old version prevents access to new Solidity security checks.
32 We recommend avoiding complex pragma statement.'''
33 WIKI_RECOMMENDATION = '''
34 Use Solidity 0.4.25 or 0.5.3. Consider using the latest version of Solidity for testing the compilation, and a trusted version for deploying.'''
35
36 COMPLEX_PRAGMA_TXT = "is too complex"
37 OLD_VERSION_TXT = "allows old versions"
38 LESS_THAN_TXT = "uses lesser than"
39
40 TOO_RECENT_VERSION_TXT = "necessitates versions too recent to be trusted. Consider deploying with 0.5.3"
41 BUGGY_VERSION_TXT = "is known to contain severe issue (https://solidity.readthedocs.io/en/v0.5.8/bugs.html)"
42
43 # Indicates the allowed versions.
44 ALLOWED_VERSIONS = ["0.4.25", "0.4.26", "0.5.3"]
45 # Indicates the versions too recent.
46 TOO_RECENT_VERSIONS = ["0.5.4", "0.5.7", "0.5.8", "0.5.9", "0.5.10"]
47 # Indicates the versions that should not be used.
48 BUGGY_VERSIONS = ["0.4.22", "0.5.5", "0.5.6", "^0.4.22", "^0.5.5", "^0.5.6"]
49
50 def _check_version(self, version):
51 op = version[0]
52 if op and not op in ['>', '>=', '^']:
53 return self.LESS_THAN_TXT
54 version_number = '.'.join(version[2:])
55 if version_number not in self.ALLOWED_VERSIONS:
56 if version_number in self.TOO_RECENT_VERSIONS:
57 return self.TOO_RECENT_VERSION_TXT
58 return self.OLD_VERSION_TXT
59 return None
60
61 def _check_pragma(self, version):
62 if version in self.BUGGY_VERSIONS:
63 return self.BUGGY_VERSION_TXT
64 versions = PATTERN.findall(version)
65 if len(versions) == 1:
66 version = versions[0]
67 return self._check_version(version)
68 elif len(versions) == 2:
69 version_left = versions[0]
70 version_right = versions[1]
71 # Only allow two elements if the second one is
72 # <0.5.0 or <0.6.0
73 if version_right not in [('<', '', '0', '5', '0'), ('<', '', '0', '6', '0')]:
74 return self.COMPLEX_PRAGMA_TXT
75 return self._check_version(version_left)
76 else:
77 return self.COMPLEX_PRAGMA_TXT
78 def _detect(self):
79 """
80 Detects pragma statements that allow for outdated solc versions.
81 :return: Returns the relevant JSON data for the findings.
82 """
83 # Detect all version related pragmas and check if they are disallowed.
84 results = []
85 pragma = self.slither.pragma_directives
86 disallowed_pragmas = []
87 detected_version = False
88 for p in pragma:
89 # Skip any pragma directives which do not refer to version
90 if len(p.directive) < 1 or p.directive[0] != "solidity":
91 continue
92
93 # This is version, so we test if this is disallowed.
94 detected_version = True
95 reason = self._check_pragma(p.version)
96 if reason:
97 disallowed_pragmas.append((reason, p))
98
99 # If we found any disallowed pragmas, we output our findings.
100 if disallowed_pragmas:
101 for (reason, p) in disallowed_pragmas:
102 info = f"Pragma version \"{p.version}\" {reason} ({p.source_mapping_str})\n"
103
104 json = self.generate_json_result(info)
105 self.add_pragma_to_json(p, json)
106 results.append(json)
107
108 return results
109
110 @staticmethod
111 def _format(slither, result):
112 format(slither, result)
113
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/slither/detectors/attributes/incorrect_solc.py b/slither/detectors/attributes/incorrect_solc.py
--- a/slither/detectors/attributes/incorrect_solc.py
+++ b/slither/detectors/attributes/incorrect_solc.py
@@ -43,7 +43,7 @@
# Indicates the allowed versions.
ALLOWED_VERSIONS = ["0.4.25", "0.4.26", "0.5.3"]
# Indicates the versions too recent.
- TOO_RECENT_VERSIONS = ["0.5.4", "0.5.7", "0.5.8", "0.5.9", "0.5.10"]
+ TOO_RECENT_VERSIONS = ["0.5.4", "0.5.7", "0.5.8", "0.5.9", "0.5.10", "0.5.11"]
# Indicates the versions that should not be used.
BUGGY_VERSIONS = ["0.4.22", "0.5.5", "0.5.6", "^0.4.22", "^0.5.5", "^0.5.6"]
|
{"golden_diff": "diff --git a/slither/detectors/attributes/incorrect_solc.py b/slither/detectors/attributes/incorrect_solc.py\n--- a/slither/detectors/attributes/incorrect_solc.py\n+++ b/slither/detectors/attributes/incorrect_solc.py\n@@ -43,7 +43,7 @@\n # Indicates the allowed versions.\n ALLOWED_VERSIONS = [\"0.4.25\", \"0.4.26\", \"0.5.3\"]\n # Indicates the versions too recent.\n- TOO_RECENT_VERSIONS = [\"0.5.4\", \"0.5.7\", \"0.5.8\", \"0.5.9\", \"0.5.10\"]\n+ TOO_RECENT_VERSIONS = [\"0.5.4\", \"0.5.7\", \"0.5.8\", \"0.5.9\", \"0.5.10\", \"0.5.11\"]\n # Indicates the versions that should not be used.\n BUGGY_VERSIONS = [\"0.4.22\", \"0.5.5\", \"0.5.6\", \"^0.4.22\", \"^0.5.5\", \"^0.5.6\"]\n", "issue": "solc-version detector: Missing 0.5.11 \n`0.5.11` is incorrectly reported as an old version. \n", "before_files": [{"content": "\"\"\"\n Check if an incorrect version of solc is used\n\"\"\"\n\nimport re\nfrom slither.detectors.abstract_detector import AbstractDetector, DetectorClassification\nfrom slither.formatters.attributes.incorrect_solc import format\n\n# group:\n# 0: ^ > >= < <= (optional)\n# 1: ' ' (optional)\n# 2: version number\n# 3: version number\n# 4: version number\nPATTERN = re.compile('(\\^|>|>=|<|<=)?([ ]+)?(\\d+)\\.(\\d+)\\.(\\d+)')\n\nclass IncorrectSolc(AbstractDetector):\n \"\"\"\n Check if an old version of solc is used\n \"\"\"\n\n ARGUMENT = 'solc-version'\n HELP = 'Incorrect Solidity version (< 0.4.24 or complex pragma)'\n IMPACT = DetectorClassification.INFORMATIONAL\n CONFIDENCE = DetectorClassification.HIGH\n\n WIKI = 'https://github.com/crytic/slither/wiki/Detector-Documentation#incorrect-versions-of-solidity'\n\n WIKI_TITLE = 'Incorrect versions of Solidity'\n WIKI_DESCRIPTION = '''\nSolc frequently releases new compiler versions. Using an old version prevents access to new Solidity security checks.\nWe recommend avoiding complex pragma statement.'''\n WIKI_RECOMMENDATION = '''\nUse Solidity 0.4.25 or 0.5.3. Consider using the latest version of Solidity for testing the compilation, and a trusted version for deploying.'''\n\n COMPLEX_PRAGMA_TXT = \"is too complex\"\n OLD_VERSION_TXT = \"allows old versions\"\n LESS_THAN_TXT = \"uses lesser than\"\n\n TOO_RECENT_VERSION_TXT = \"necessitates versions too recent to be trusted. Consider deploying with 0.5.3\"\n BUGGY_VERSION_TXT = \"is known to contain severe issue (https://solidity.readthedocs.io/en/v0.5.8/bugs.html)\"\n\n # Indicates the allowed versions.\n ALLOWED_VERSIONS = [\"0.4.25\", \"0.4.26\", \"0.5.3\"]\n # Indicates the versions too recent.\n TOO_RECENT_VERSIONS = [\"0.5.4\", \"0.5.7\", \"0.5.8\", \"0.5.9\", \"0.5.10\"]\n # Indicates the versions that should not be used.\n BUGGY_VERSIONS = [\"0.4.22\", \"0.5.5\", \"0.5.6\", \"^0.4.22\", \"^0.5.5\", \"^0.5.6\"]\n\n def _check_version(self, version):\n op = version[0]\n if op and not op in ['>', '>=', '^']:\n return self.LESS_THAN_TXT\n version_number = '.'.join(version[2:])\n if version_number not in self.ALLOWED_VERSIONS:\n if version_number in self.TOO_RECENT_VERSIONS:\n return self.TOO_RECENT_VERSION_TXT\n return self.OLD_VERSION_TXT\n return None\n\n def _check_pragma(self, version):\n if version in self.BUGGY_VERSIONS:\n return self.BUGGY_VERSION_TXT\n versions = PATTERN.findall(version)\n if len(versions) == 1:\n version = versions[0]\n return self._check_version(version)\n elif len(versions) == 2:\n version_left = versions[0]\n version_right = versions[1]\n # Only allow two elements if the second one is\n # <0.5.0 or <0.6.0\n if version_right not in [('<', '', '0', '5', '0'), ('<', '', '0', '6', '0')]:\n return self.COMPLEX_PRAGMA_TXT\n return self._check_version(version_left)\n else:\n return self.COMPLEX_PRAGMA_TXT\n def _detect(self):\n \"\"\"\n Detects pragma statements that allow for outdated solc versions.\n :return: Returns the relevant JSON data for the findings.\n \"\"\"\n # Detect all version related pragmas and check if they are disallowed.\n results = []\n pragma = self.slither.pragma_directives\n disallowed_pragmas = []\n detected_version = False\n for p in pragma:\n # Skip any pragma directives which do not refer to version\n if len(p.directive) < 1 or p.directive[0] != \"solidity\":\n continue\n\n # This is version, so we test if this is disallowed.\n detected_version = True\n reason = self._check_pragma(p.version)\n if reason:\n disallowed_pragmas.append((reason, p))\n\n # If we found any disallowed pragmas, we output our findings.\n if disallowed_pragmas:\n for (reason, p) in disallowed_pragmas:\n info = f\"Pragma version \\\"{p.version}\\\" {reason} ({p.source_mapping_str})\\n\"\n\n json = self.generate_json_result(info)\n self.add_pragma_to_json(p, json)\n results.append(json)\n\n return results\n\n @staticmethod\n def _format(slither, result):\n format(slither, result)\n", "path": "slither/detectors/attributes/incorrect_solc.py"}], "after_files": [{"content": "\"\"\"\n Check if an incorrect version of solc is used\n\"\"\"\n\nimport re\nfrom slither.detectors.abstract_detector import AbstractDetector, DetectorClassification\nfrom slither.formatters.attributes.incorrect_solc import format\n\n# group:\n# 0: ^ > >= < <= (optional)\n# 1: ' ' (optional)\n# 2: version number\n# 3: version number\n# 4: version number\nPATTERN = re.compile('(\\^|>|>=|<|<=)?([ ]+)?(\\d+)\\.(\\d+)\\.(\\d+)')\n\nclass IncorrectSolc(AbstractDetector):\n \"\"\"\n Check if an old version of solc is used\n \"\"\"\n\n ARGUMENT = 'solc-version'\n HELP = 'Incorrect Solidity version (< 0.4.24 or complex pragma)'\n IMPACT = DetectorClassification.INFORMATIONAL\n CONFIDENCE = DetectorClassification.HIGH\n\n WIKI = 'https://github.com/crytic/slither/wiki/Detector-Documentation#incorrect-versions-of-solidity'\n\n WIKI_TITLE = 'Incorrect versions of Solidity'\n WIKI_DESCRIPTION = '''\nSolc frequently releases new compiler versions. Using an old version prevents access to new Solidity security checks.\nWe recommend avoiding complex pragma statement.'''\n WIKI_RECOMMENDATION = '''\nUse Solidity 0.4.25 or 0.5.3. Consider using the latest version of Solidity for testing the compilation, and a trusted version for deploying.'''\n\n COMPLEX_PRAGMA_TXT = \"is too complex\"\n OLD_VERSION_TXT = \"allows old versions\"\n LESS_THAN_TXT = \"uses lesser than\"\n\n TOO_RECENT_VERSION_TXT = \"necessitates versions too recent to be trusted. Consider deploying with 0.5.3\"\n BUGGY_VERSION_TXT = \"is known to contain severe issue (https://solidity.readthedocs.io/en/v0.5.8/bugs.html)\"\n\n # Indicates the allowed versions.\n ALLOWED_VERSIONS = [\"0.4.25\", \"0.4.26\", \"0.5.3\"]\n # Indicates the versions too recent.\n TOO_RECENT_VERSIONS = [\"0.5.4\", \"0.5.7\", \"0.5.8\", \"0.5.9\", \"0.5.10\", \"0.5.11\"]\n # Indicates the versions that should not be used.\n BUGGY_VERSIONS = [\"0.4.22\", \"0.5.5\", \"0.5.6\", \"^0.4.22\", \"^0.5.5\", \"^0.5.6\"]\n\n def _check_version(self, version):\n op = version[0]\n if op and not op in ['>', '>=', '^']:\n return self.LESS_THAN_TXT\n version_number = '.'.join(version[2:])\n if version_number not in self.ALLOWED_VERSIONS:\n if version_number in self.TOO_RECENT_VERSIONS:\n return self.TOO_RECENT_VERSION_TXT\n return self.OLD_VERSION_TXT\n return None\n\n def _check_pragma(self, version):\n if version in self.BUGGY_VERSIONS:\n return self.BUGGY_VERSION_TXT\n versions = PATTERN.findall(version)\n if len(versions) == 1:\n version = versions[0]\n return self._check_version(version)\n elif len(versions) == 2:\n version_left = versions[0]\n version_right = versions[1]\n # Only allow two elements if the second one is\n # <0.5.0 or <0.6.0\n if version_right not in [('<', '', '0', '5', '0'), ('<', '', '0', '6', '0')]:\n return self.COMPLEX_PRAGMA_TXT\n return self._check_version(version_left)\n else:\n return self.COMPLEX_PRAGMA_TXT\n def _detect(self):\n \"\"\"\n Detects pragma statements that allow for outdated solc versions.\n :return: Returns the relevant JSON data for the findings.\n \"\"\"\n # Detect all version related pragmas and check if they are disallowed.\n results = []\n pragma = self.slither.pragma_directives\n disallowed_pragmas = []\n detected_version = False\n for p in pragma:\n # Skip any pragma directives which do not refer to version\n if len(p.directive) < 1 or p.directive[0] != \"solidity\":\n continue\n\n # This is version, so we test if this is disallowed.\n detected_version = True\n reason = self._check_pragma(p.version)\n if reason:\n disallowed_pragmas.append((reason, p))\n\n # If we found any disallowed pragmas, we output our findings.\n if disallowed_pragmas:\n for (reason, p) in disallowed_pragmas:\n info = f\"Pragma version \\\"{p.version}\\\" {reason} ({p.source_mapping_str})\\n\"\n\n json = self.generate_json_result(info)\n self.add_pragma_to_json(p, json)\n results.append(json)\n\n return results\n\n @staticmethod\n def _format(slither, result):\n format(slither, result)\n", "path": "slither/detectors/attributes/incorrect_solc.py"}]}
| 1,665 | 273 |
gh_patches_debug_4979
|
rasdani/github-patches
|
git_diff
|
pymedusa__Medusa-4319
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
HeBits provider failed to find HD torrents
When using 'html5lib' HeBits provider failed to find HD torrents (720p) for me.
Switching to with BS4Parser(data, 'html.parser') as html: fix the issue for me.
Please consider to switch to html.parser or fixing html5lib search.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `medusa/providers/torrent/html/hebits.py`
Content:
```
1 # coding=utf-8
2
3 """Provider code for HeBits."""
4
5 from __future__ import unicode_literals
6
7 import logging
8 import re
9
10 from medusa import tv
11 from medusa.bs4_parser import BS4Parser
12 from medusa.helper.common import (
13 convert_size,
14 try_int,
15 )
16 from medusa.logger.adapters.style import BraceAdapter
17 from medusa.providers.torrent.torrent_provider import TorrentProvider
18
19 from requests.compat import urljoin
20 from requests.utils import dict_from_cookiejar
21
22 log = BraceAdapter(logging.getLogger(__name__))
23 log.logger.addHandler(logging.NullHandler())
24
25
26 class HeBitsProvider(TorrentProvider):
27 """HeBits Torrent provider."""
28
29 def __init__(self):
30 """Initialize the class."""
31 super(HeBitsProvider, self).__init__('HeBits')
32
33 # Credentials
34 self.username = None
35 self.password = None
36
37 # URLs
38 self.url = 'https://hebits.net'
39 self.urls = {
40 'login': urljoin(self.url, 'takeloginAjax.php'),
41 'search': urljoin(self.url, 'browse.php'),
42 }
43
44 # Proper Strings
45 self.proper_strings = ['PROPER', 'REPACK', 'REAL', 'RERIP']
46
47 # Miscellaneous Options
48 self.freeleech = False
49
50 # Torrent Stats
51 self.minseed = None
52 self.minleech = None
53
54 # Cache
55 self.cache = tv.Cache(self)
56
57 def search(self, search_strings, age=0, ep_obj=None, **kwargs):
58 """
59 Search a provider and parse the results.
60
61 :param search_strings: A dict with mode (key) and the search value (value)
62 :param age: Not used
63 :param ep_obj: Not used
64 :returns: A list of search results (structure)
65 """
66 results = []
67 if not self.login():
68 return results
69
70 # Search Params
71 # Israeli SD , English SD , Israeli HD , English HD
72 # 7 , 24 , 37 , 1
73 search_params = {
74 'c1': '1',
75 'c24': '1',
76 'c37': '1',
77 'c7': '1',
78 'search': '',
79 'cata': '0',
80 }
81 if self.freeleech:
82 search_params['free'] = 'on'
83
84 for mode in search_strings:
85 log.debug('Search mode: {0}', mode)
86
87 for search_string in search_strings[mode]:
88
89 if mode != 'RSS':
90 search_params['search'] = search_string
91 log.debug('Search string: {search}',
92 {'search': search_string})
93
94 response = self.session.get(self.urls['search'], params=search_params)
95 if not response or not response.text:
96 log.debug('No data returned from provider')
97 continue
98
99 results += self.parse(response.text, mode)
100
101 return results
102
103 def parse(self, data, mode):
104 """
105 Parse search results for items.
106
107 :param data: The raw response from a search
108 :param mode: The current mode used to search, e.g. RSS
109
110 :return: A list of items found
111 """
112 items = []
113
114 with BS4Parser(data, 'html5lib') as html:
115 torrent_table = html.find('div', class_='browse')
116 torrent_rows = torrent_table('div', class_=re.compile('^line')) if torrent_table else []
117
118 # Continue only if at least one release is found
119 if len(torrent_rows) < 1:
120 log.debug('Data returned from provider does not contain any torrents')
121 return items
122
123 for row in torrent_rows:
124 try:
125 heb_eng_title = row.find('div', class_='bTitle').find(href=re.compile('details\.php')).find('b').get_text()
126 if '/' in heb_eng_title:
127 title = heb_eng_title.split('/')[1].strip()
128 elif '\\' in heb_eng_title:
129 title = heb_eng_title.split('\\')[1].strip()
130 else:
131 continue
132
133 download_id = row.find('div', class_='bTitle').find(href=re.compile('download\.php'))['href']
134
135 if not all([title, download_id]):
136 continue
137
138 download_url = urljoin(self.url, download_id)
139
140 seeders = try_int(row.find('div', class_='bUping').get_text(strip=True))
141 leechers = try_int(row.find('div', class_='bDowning').get_text(strip=True))
142
143 # Filter unseeded torrent
144 if seeders < min(self.minseed, 1):
145 if mode != 'RSS':
146 log.debug("Discarding torrent because it doesn't meet the"
147 " minimum seeders: {0}. Seeders: {1}",
148 title, seeders)
149 continue
150
151 torrent_size = row.find('div', class_='bSize').get_text(strip=True)
152 size = convert_size(torrent_size[5:], sep='') or -1
153
154 pubdate_raw = row.find('div', class_=re.compile('bHow')).find_all('span')[1].next_sibling.strip()
155 pubdate = self.parse_pubdate(pubdate_raw)
156
157 item = {
158 'title': title,
159 'link': download_url,
160 'size': size,
161 'seeders': seeders,
162 'leechers': leechers,
163 'pubdate': pubdate,
164 }
165 if mode != 'RSS':
166 log.debug('Found result: {0} with {1} seeders and {2} leechers',
167 title, seeders, leechers)
168
169 items.append(item)
170 except (AttributeError, TypeError, KeyError, ValueError, IndexError):
171 log.exception('Failed parsing provider.')
172
173 return items
174
175 def login(self):
176 """Login method used for logging in before doing search and torrent downloads."""
177 cookies = dict_from_cookiejar(self.session.cookies)
178 if any(cookies.values()) and cookies.get('uid'):
179 return True
180
181 login_params = {
182 'username': self.username,
183 'password': self.password,
184 }
185
186 response = self.session.post(self.urls['login'], data=login_params)
187
188 if not response or not response.text:
189 log.warning('Unable to connect to provider')
190 return False
191
192 if response.text == 'OK':
193 return True
194 elif response.text == 'Banned':
195 log.warning('User {0} is banned from HeBits', self.username)
196 return False
197 elif response.text == 'MaxAttempts':
198 log.warning('Max number of login attempts exceeded - your IP is blocked')
199 return False
200 else:
201 log.warning('Invalid username or password. Check your settings')
202 return False
203
204
205 provider = HeBitsProvider()
206
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/medusa/providers/torrent/html/hebits.py b/medusa/providers/torrent/html/hebits.py
--- a/medusa/providers/torrent/html/hebits.py
+++ b/medusa/providers/torrent/html/hebits.py
@@ -111,7 +111,7 @@
"""
items = []
- with BS4Parser(data, 'html5lib') as html:
+ with BS4Parser(data, 'html.parser') as html:
torrent_table = html.find('div', class_='browse')
torrent_rows = torrent_table('div', class_=re.compile('^line')) if torrent_table else []
|
{"golden_diff": "diff --git a/medusa/providers/torrent/html/hebits.py b/medusa/providers/torrent/html/hebits.py\n--- a/medusa/providers/torrent/html/hebits.py\n+++ b/medusa/providers/torrent/html/hebits.py\n@@ -111,7 +111,7 @@\n \"\"\"\n items = []\n \n- with BS4Parser(data, 'html5lib') as html:\n+ with BS4Parser(data, 'html.parser') as html:\n torrent_table = html.find('div', class_='browse')\n torrent_rows = torrent_table('div', class_=re.compile('^line')) if torrent_table else []\n", "issue": "HeBits provider failed to find HD torrents\nWhen using 'html5lib' HeBits provider failed to find HD torrents (720p) for me.\r\nSwitching to with BS4Parser(data, 'html.parser') as html: fix the issue for me.\r\n\r\nPlease consider to switch to html.parser or fixing html5lib search.\r\n\r\n\n", "before_files": [{"content": "# coding=utf-8\n\n\"\"\"Provider code for HeBits.\"\"\"\n\nfrom __future__ import unicode_literals\n\nimport logging\nimport re\n\nfrom medusa import tv\nfrom medusa.bs4_parser import BS4Parser\nfrom medusa.helper.common import (\n convert_size,\n try_int,\n)\nfrom medusa.logger.adapters.style import BraceAdapter\nfrom medusa.providers.torrent.torrent_provider import TorrentProvider\n\nfrom requests.compat import urljoin\nfrom requests.utils import dict_from_cookiejar\n\nlog = BraceAdapter(logging.getLogger(__name__))\nlog.logger.addHandler(logging.NullHandler())\n\n\nclass HeBitsProvider(TorrentProvider):\n \"\"\"HeBits Torrent provider.\"\"\"\n\n def __init__(self):\n \"\"\"Initialize the class.\"\"\"\n super(HeBitsProvider, self).__init__('HeBits')\n\n # Credentials\n self.username = None\n self.password = None\n\n # URLs\n self.url = 'https://hebits.net'\n self.urls = {\n 'login': urljoin(self.url, 'takeloginAjax.php'),\n 'search': urljoin(self.url, 'browse.php'),\n }\n\n # Proper Strings\n self.proper_strings = ['PROPER', 'REPACK', 'REAL', 'RERIP']\n\n # Miscellaneous Options\n self.freeleech = False\n\n # Torrent Stats\n self.minseed = None\n self.minleech = None\n\n # Cache\n self.cache = tv.Cache(self)\n\n def search(self, search_strings, age=0, ep_obj=None, **kwargs):\n \"\"\"\n Search a provider and parse the results.\n\n :param search_strings: A dict with mode (key) and the search value (value)\n :param age: Not used\n :param ep_obj: Not used\n :returns: A list of search results (structure)\n \"\"\"\n results = []\n if not self.login():\n return results\n\n # Search Params\n # Israeli SD , English SD , Israeli HD , English HD\n # 7 , 24 , 37 , 1\n search_params = {\n 'c1': '1',\n 'c24': '1',\n 'c37': '1',\n 'c7': '1',\n 'search': '',\n 'cata': '0',\n }\n if self.freeleech:\n search_params['free'] = 'on'\n\n for mode in search_strings:\n log.debug('Search mode: {0}', mode)\n\n for search_string in search_strings[mode]:\n\n if mode != 'RSS':\n search_params['search'] = search_string\n log.debug('Search string: {search}',\n {'search': search_string})\n\n response = self.session.get(self.urls['search'], params=search_params)\n if not response or not response.text:\n log.debug('No data returned from provider')\n continue\n\n results += self.parse(response.text, mode)\n\n return results\n\n def parse(self, data, mode):\n \"\"\"\n Parse search results for items.\n\n :param data: The raw response from a search\n :param mode: The current mode used to search, e.g. RSS\n\n :return: A list of items found\n \"\"\"\n items = []\n\n with BS4Parser(data, 'html5lib') as html:\n torrent_table = html.find('div', class_='browse')\n torrent_rows = torrent_table('div', class_=re.compile('^line')) if torrent_table else []\n\n # Continue only if at least one release is found\n if len(torrent_rows) < 1:\n log.debug('Data returned from provider does not contain any torrents')\n return items\n\n for row in torrent_rows:\n try:\n heb_eng_title = row.find('div', class_='bTitle').find(href=re.compile('details\\.php')).find('b').get_text()\n if '/' in heb_eng_title:\n title = heb_eng_title.split('/')[1].strip()\n elif '\\\\' in heb_eng_title:\n title = heb_eng_title.split('\\\\')[1].strip()\n else:\n continue\n\n download_id = row.find('div', class_='bTitle').find(href=re.compile('download\\.php'))['href']\n\n if not all([title, download_id]):\n continue\n\n download_url = urljoin(self.url, download_id)\n\n seeders = try_int(row.find('div', class_='bUping').get_text(strip=True))\n leechers = try_int(row.find('div', class_='bDowning').get_text(strip=True))\n\n # Filter unseeded torrent\n if seeders < min(self.minseed, 1):\n if mode != 'RSS':\n log.debug(\"Discarding torrent because it doesn't meet the\"\n \" minimum seeders: {0}. Seeders: {1}\",\n title, seeders)\n continue\n\n torrent_size = row.find('div', class_='bSize').get_text(strip=True)\n size = convert_size(torrent_size[5:], sep='') or -1\n\n pubdate_raw = row.find('div', class_=re.compile('bHow')).find_all('span')[1].next_sibling.strip()\n pubdate = self.parse_pubdate(pubdate_raw)\n\n item = {\n 'title': title,\n 'link': download_url,\n 'size': size,\n 'seeders': seeders,\n 'leechers': leechers,\n 'pubdate': pubdate,\n }\n if mode != 'RSS':\n log.debug('Found result: {0} with {1} seeders and {2} leechers',\n title, seeders, leechers)\n\n items.append(item)\n except (AttributeError, TypeError, KeyError, ValueError, IndexError):\n log.exception('Failed parsing provider.')\n\n return items\n\n def login(self):\n \"\"\"Login method used for logging in before doing search and torrent downloads.\"\"\"\n cookies = dict_from_cookiejar(self.session.cookies)\n if any(cookies.values()) and cookies.get('uid'):\n return True\n\n login_params = {\n 'username': self.username,\n 'password': self.password,\n }\n\n response = self.session.post(self.urls['login'], data=login_params)\n\n if not response or not response.text:\n log.warning('Unable to connect to provider')\n return False\n\n if response.text == 'OK':\n return True\n elif response.text == 'Banned':\n log.warning('User {0} is banned from HeBits', self.username)\n return False\n elif response.text == 'MaxAttempts':\n log.warning('Max number of login attempts exceeded - your IP is blocked')\n return False\n else:\n log.warning('Invalid username or password. Check your settings')\n return False\n\n\nprovider = HeBitsProvider()\n", "path": "medusa/providers/torrent/html/hebits.py"}], "after_files": [{"content": "# coding=utf-8\n\n\"\"\"Provider code for HeBits.\"\"\"\n\nfrom __future__ import unicode_literals\n\nimport logging\nimport re\n\nfrom medusa import tv\nfrom medusa.bs4_parser import BS4Parser\nfrom medusa.helper.common import (\n convert_size,\n try_int,\n)\nfrom medusa.logger.adapters.style import BraceAdapter\nfrom medusa.providers.torrent.torrent_provider import TorrentProvider\n\nfrom requests.compat import urljoin\nfrom requests.utils import dict_from_cookiejar\n\nlog = BraceAdapter(logging.getLogger(__name__))\nlog.logger.addHandler(logging.NullHandler())\n\n\nclass HeBitsProvider(TorrentProvider):\n \"\"\"HeBits Torrent provider.\"\"\"\n\n def __init__(self):\n \"\"\"Initialize the class.\"\"\"\n super(HeBitsProvider, self).__init__('HeBits')\n\n # Credentials\n self.username = None\n self.password = None\n\n # URLs\n self.url = 'https://hebits.net'\n self.urls = {\n 'login': urljoin(self.url, 'takeloginAjax.php'),\n 'search': urljoin(self.url, 'browse.php'),\n }\n\n # Proper Strings\n self.proper_strings = ['PROPER', 'REPACK', 'REAL', 'RERIP']\n\n # Miscellaneous Options\n self.freeleech = False\n\n # Torrent Stats\n self.minseed = None\n self.minleech = None\n\n # Cache\n self.cache = tv.Cache(self)\n\n def search(self, search_strings, age=0, ep_obj=None, **kwargs):\n \"\"\"\n Search a provider and parse the results.\n\n :param search_strings: A dict with mode (key) and the search value (value)\n :param age: Not used\n :param ep_obj: Not used\n :returns: A list of search results (structure)\n \"\"\"\n results = []\n if not self.login():\n return results\n\n # Search Params\n # Israeli SD , English SD , Israeli HD , English HD\n # 7 , 24 , 37 , 1\n search_params = {\n 'c1': '1',\n 'c24': '1',\n 'c37': '1',\n 'c7': '1',\n 'search': '',\n 'cata': '0',\n }\n if self.freeleech:\n search_params['free'] = 'on'\n\n for mode in search_strings:\n log.debug('Search mode: {0}', mode)\n\n for search_string in search_strings[mode]:\n\n if mode != 'RSS':\n search_params['search'] = search_string\n log.debug('Search string: {search}',\n {'search': search_string})\n\n response = self.session.get(self.urls['search'], params=search_params)\n if not response or not response.text:\n log.debug('No data returned from provider')\n continue\n\n results += self.parse(response.text, mode)\n\n return results\n\n def parse(self, data, mode):\n \"\"\"\n Parse search results for items.\n\n :param data: The raw response from a search\n :param mode: The current mode used to search, e.g. RSS\n\n :return: A list of items found\n \"\"\"\n items = []\n\n with BS4Parser(data, 'html.parser') as html:\n torrent_table = html.find('div', class_='browse')\n torrent_rows = torrent_table('div', class_=re.compile('^line')) if torrent_table else []\n\n # Continue only if at least one release is found\n if len(torrent_rows) < 1:\n log.debug('Data returned from provider does not contain any torrents')\n return items\n\n for row in torrent_rows:\n try:\n heb_eng_title = row.find('div', class_='bTitle').find(href=re.compile('details\\.php')).find('b').get_text()\n if '/' in heb_eng_title:\n title = heb_eng_title.split('/')[1].strip()\n elif '\\\\' in heb_eng_title:\n title = heb_eng_title.split('\\\\')[1].strip()\n else:\n continue\n\n download_id = row.find('div', class_='bTitle').find(href=re.compile('download\\.php'))['href']\n\n if not all([title, download_id]):\n continue\n\n download_url = urljoin(self.url, download_id)\n\n seeders = try_int(row.find('div', class_='bUping').get_text(strip=True))\n leechers = try_int(row.find('div', class_='bDowning').get_text(strip=True))\n\n # Filter unseeded torrent\n if seeders < min(self.minseed, 1):\n if mode != 'RSS':\n log.debug(\"Discarding torrent because it doesn't meet the\"\n \" minimum seeders: {0}. Seeders: {1}\",\n title, seeders)\n continue\n\n torrent_size = row.find('div', class_='bSize').get_text(strip=True)\n size = convert_size(torrent_size[5:], sep='') or -1\n\n pubdate_raw = row.find('div', class_=re.compile('bHow')).find_all('span')[1].next_sibling.strip()\n pubdate = self.parse_pubdate(pubdate_raw)\n\n item = {\n 'title': title,\n 'link': download_url,\n 'size': size,\n 'seeders': seeders,\n 'leechers': leechers,\n 'pubdate': pubdate,\n }\n if mode != 'RSS':\n log.debug('Found result: {0} with {1} seeders and {2} leechers',\n title, seeders, leechers)\n\n items.append(item)\n except (AttributeError, TypeError, KeyError, ValueError, IndexError):\n log.exception('Failed parsing provider.')\n\n return items\n\n def login(self):\n \"\"\"Login method used for logging in before doing search and torrent downloads.\"\"\"\n cookies = dict_from_cookiejar(self.session.cookies)\n if any(cookies.values()) and cookies.get('uid'):\n return True\n\n login_params = {\n 'username': self.username,\n 'password': self.password,\n }\n\n response = self.session.post(self.urls['login'], data=login_params)\n\n if not response or not response.text:\n log.warning('Unable to connect to provider')\n return False\n\n if response.text == 'OK':\n return True\n elif response.text == 'Banned':\n log.warning('User {0} is banned from HeBits', self.username)\n return False\n elif response.text == 'MaxAttempts':\n log.warning('Max number of login attempts exceeded - your IP is blocked')\n return False\n else:\n log.warning('Invalid username or password. Check your settings')\n return False\n\n\nprovider = HeBitsProvider()\n", "path": "medusa/providers/torrent/html/hebits.py"}]}
| 2,314 | 138 |
gh_patches_debug_35258
|
rasdani/github-patches
|
git_diff
|
aws__aws-sam-cli-5504
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
fix: use StringIO instead of BytesIO with StreamWriter
Related to https://github.com/aws/aws-sam-cli/pull/5427
#### Which issue(s) does this change fix?
N/A
#### Why is this change necessary?
With recently changed the way to write into stream to fix some issues related to encoding (see PR above). That changed caused some issues with ECRUpload class, due to discrepancy of the `write` method between `BytesIO` vs `StringIO`. `BytesIO` instance accepts byte array where `StringIO` accepts string.
#### How does it address the issue?
This resolves issue by using `StringIO` stream instead of `BytesIO`. This PR also adds some typing for the inner `stream` instance of the `StreamWrapper` class to check for other usages in the code base.
#### What side effects does this change have?
Manually running `sam local` tests to validate the change.
#### Mandatory Checklist
**PRs will only be reviewed after checklist is complete**
- [ ] Add input/output [type hints](https://docs.python.org/3/library/typing.html) to new functions/methods
- [ ] Write design document if needed ([Do I need to write a design document?](https://github.com/aws/aws-sam-cli/blob/develop/DEVELOPMENT_GUIDE.md#design-document))
- [x] Write/update unit tests
- [ ] Write/update integration tests
- [ ] Write/update functional tests if needed
- [x] `make pr` passes
- [ ] `make update-reproducible-reqs` if dependencies were changed
- [ ] Write documentation
By submitting this pull request, I confirm that my contribution is made under the terms of the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `schema/schema.py`
Content:
```
1 """Handles JSON schema generation logic"""
2
3
4 import importlib
5 import json
6 from dataclasses import dataclass
7 from enum import Enum
8 from typing import Any, Dict, List, Optional
9
10 import click
11
12 from samcli.cli.command import _SAM_CLI_COMMAND_PACKAGES
13 from samcli.lib.config.samconfig import SamConfig
14
15
16 class SchemaKeys(Enum):
17 SCHEMA_FILE_NAME = "schema/samcli.json"
18 SCHEMA_DRAFT = "http://json-schema.org/draft-04/schema"
19 TITLE = "AWS SAM CLI samconfig schema"
20 ENVIRONMENT_REGEX = "^.+$"
21
22
23 @dataclass()
24 class SamCliParameterSchema:
25 """Representation of a parameter in the SAM CLI.
26
27 It includes relevant information for the JSON schema, such as name, data type,
28 and description, among others.
29 """
30
31 name: str
32 type: str
33 description: str = ""
34 default: Optional[Any] = None
35 choices: Optional[Any] = None
36
37 def to_schema(self) -> Dict[str, Any]:
38 """Return the JSON schema representation of the SAM CLI parameter."""
39 param = {}
40 param.update({"title": self.name, "type": self.type, "description": self.description})
41 if self.default:
42 param.update({"default": self.default})
43 if self.choices:
44 param.update({"enum": self.choices})
45 return param
46
47
48 @dataclass()
49 class SamCliCommandSchema:
50 """Representation of a command in the SAM CLI.
51
52 It includes relevant information for the JSON schema, such as name, a description of the
53 command, and a list of all available parameters.
54 """
55
56 name: str # Full command name, with underscores (i.e. remote_invoke, local_start_lambda)
57 description: str
58 parameters: List[SamCliParameterSchema]
59
60 def to_schema(self) -> dict:
61 """Return the JSON schema representation of the SAM CLI command."""
62 COMMANDS_TO_EXCLUDE = [ # TEMPORARY: for use only while generating piece-by-piece
63 "deploy",
64 "build",
65 "local",
66 "validate",
67 "package",
68 "init",
69 "delete",
70 "bootstrap",
71 "list",
72 "traces",
73 "sync",
74 "publish",
75 "pipeline",
76 "logs",
77 "remote",
78 ]
79 split_cmd_name = self.name.split("_")
80 formatted_cmd_name = " ".join(split_cmd_name)
81 exclude_params = split_cmd_name[0] in COMMANDS_TO_EXCLUDE
82 formatted_params_list = (
83 "* " + "\n* ".join([f"{param.name}:\n{param.description}" for param in self.parameters])
84 if not exclude_params
85 else ""
86 )
87 params_description = f"Available parameters for the {formatted_cmd_name} command:\n{formatted_params_list}"
88
89 return {
90 self.name: {
91 "title": f"{formatted_cmd_name.title()} command",
92 "description": self.description or "",
93 "properties": {
94 "parameters": {
95 "title": f"Parameters for the {formatted_cmd_name} command",
96 "description": params_description,
97 "type": "object",
98 "properties": {param.name: param.to_schema() for param in self.parameters}
99 if not exclude_params
100 else {},
101 },
102 },
103 "required": ["parameters"],
104 }
105 }
106
107
108 def clean_text(text: str) -> str:
109 """Clean up a string of text to be formatted for the JSON schema."""
110 if not text:
111 return ""
112 return text.replace("\b", "").strip("\n").strip()
113
114
115 def format_param(param: click.core.Option) -> SamCliParameterSchema:
116 """Format a click Option parameter to a SamCliParameter object.
117
118 A parameter object should contain the following information that will be
119 necessary for including in the JSON schema:
120 * name - The name of the parameter
121 * help - The parameter's description (may vary between commands)
122 * type - The data type accepted by the parameter
123 * type.choices - If there are only a certain number of options allowed,
124 a list of those allowed options
125 * default - The default option for that parameter
126 """
127 param_type = param.type.name.lower()
128 formatted_param_type = ""
129 # NOTE: Params do not have explicit "string" type; either "text" or "path".
130 # All choice options are from a set of strings.
131 if param_type in ["text", "path", "choice", "filename", "directory"]:
132 formatted_param_type = "string"
133 elif param_type == "list":
134 formatted_param_type = "array"
135 else:
136 formatted_param_type = param_type or "string"
137
138 formatted_param: SamCliParameterSchema = SamCliParameterSchema(
139 param.name or "", formatted_param_type, clean_text(param.help or "")
140 )
141
142 if param.default:
143 formatted_param.default = list(param.default) if isinstance(param.default, tuple) else param.default
144
145 if param.type.name == "choice" and isinstance(param.type, click.Choice):
146 formatted_param.choices = list(param.type.choices)
147
148 return formatted_param
149
150
151 def get_params_from_command(cli) -> List[SamCliParameterSchema]:
152 """Given a CLI object, return a list of all parameters in that CLI, formatted as SamCliParameterSchema objects."""
153 return [format_param(param) for param in cli.params if param.name and isinstance(param, click.core.Option)]
154
155
156 def retrieve_command_structure(package_name: str) -> List[SamCliCommandSchema]:
157 """Given a SAM CLI package name, retrieve its structure.
158
159 Such a structure is the list of all subcommands as `SamCliCommandSchema`, which includes
160 the command's name, description, and its parameters.
161
162 Parameters
163 ----------
164 package_name: str
165 The name of the command package to retrieve.
166
167 Returns
168 -------
169 List[SamCliCommandSchema]
170 A list of SamCliCommandSchema objects which represent either a command or a list of
171 subcommands within the package.
172 """
173 module = importlib.import_module(package_name)
174 command = []
175
176 if isinstance(module.cli, click.core.Group): # command has subcommands (e.g. local invoke)
177 for subcommand in module.cli.commands.values():
178 cmd_name = SamConfig.to_key([module.__name__.split(".")[-1], str(subcommand.name)])
179 command.append(
180 SamCliCommandSchema(
181 cmd_name,
182 clean_text(subcommand.help or subcommand.short_help or ""),
183 get_params_from_command(subcommand),
184 )
185 )
186 else:
187 cmd_name = SamConfig.to_key([module.__name__.split(".")[-1]])
188 command.append(
189 SamCliCommandSchema(
190 cmd_name,
191 clean_text(module.cli.help or module.cli.short_help or ""),
192 get_params_from_command(module.cli),
193 )
194 )
195 return command
196
197
198 def generate_schema() -> dict:
199 """Generate a JSON schema for all SAM CLI commands.
200
201 Returns
202 -------
203 dict
204 A dictionary representation of the JSON schema.
205 """
206 schema: dict = {}
207 commands: List[SamCliCommandSchema] = []
208
209 # Populate schema with relevant attributes
210 schema["$schema"] = SchemaKeys.SCHEMA_DRAFT.value
211 schema["title"] = SchemaKeys.TITLE.value
212 schema["type"] = "object"
213 schema["properties"] = {
214 # Version number required for samconfig files to be valid
215 "version": {"title": "Config version", "type": "number", "default": 0.1}
216 }
217 schema["required"] = ["version"]
218 schema["additionalProperties"] = False
219 # Iterate through packages for command and parameter information
220 for package_name in _SAM_CLI_COMMAND_PACKAGES:
221 commands.extend(retrieve_command_structure(package_name))
222 # Generate schema for each of the commands
223 schema["patternProperties"] = {SchemaKeys.ENVIRONMENT_REGEX.value: {"title": "Environment", "properties": {}}}
224 for command in commands:
225 schema["patternProperties"][SchemaKeys.ENVIRONMENT_REGEX.value]["properties"].update(command.to_schema())
226 return schema
227
228
229 def write_schema():
230 """Generate the SAM CLI JSON schema and write it to file."""
231 schema = generate_schema()
232 with open(SchemaKeys.SCHEMA_FILE_NAME.value, "w+", encoding="utf-8") as outfile:
233 json.dump(schema, outfile, indent=2)
234
235
236 if __name__ == "__main__":
237 write_schema()
238
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/schema/schema.py b/schema/schema.py
--- a/schema/schema.py
+++ b/schema/schema.py
@@ -32,14 +32,17 @@
type: str
description: str = ""
default: Optional[Any] = None
+ items: Optional[str] = None
choices: Optional[Any] = None
def to_schema(self) -> Dict[str, Any]:
"""Return the JSON schema representation of the SAM CLI parameter."""
- param = {}
+ param: Dict[str, Any] = {}
param.update({"title": self.name, "type": self.type, "description": self.description})
if self.default:
param.update({"default": self.default})
+ if self.items:
+ param.update({"items": {"type": self.items}})
if self.choices:
param.update({"enum": self.choices})
return param
@@ -136,7 +139,10 @@
formatted_param_type = param_type or "string"
formatted_param: SamCliParameterSchema = SamCliParameterSchema(
- param.name or "", formatted_param_type, clean_text(param.help or "")
+ param.name or "",
+ formatted_param_type,
+ clean_text(param.help or ""),
+ items="string" if formatted_param_type == "array" else None,
)
if param.default:
@@ -150,7 +156,15 @@
def get_params_from_command(cli) -> List[SamCliParameterSchema]:
"""Given a CLI object, return a list of all parameters in that CLI, formatted as SamCliParameterSchema objects."""
- return [format_param(param) for param in cli.params if param.name and isinstance(param, click.core.Option)]
+ params_to_exclude = [
+ "config_env", # shouldn't allow different environment from where the config is being read from
+ "config_file", # shouldn't allow reading another file within current file
+ ]
+ return [
+ format_param(param)
+ for param in cli.params
+ if param.name and isinstance(param, click.core.Option) and param.name not in params_to_exclude
+ ]
def retrieve_command_structure(package_name: str) -> List[SamCliCommandSchema]:
|
{"golden_diff": "diff --git a/schema/schema.py b/schema/schema.py\n--- a/schema/schema.py\n+++ b/schema/schema.py\n@@ -32,14 +32,17 @@\n type: str\n description: str = \"\"\n default: Optional[Any] = None\n+ items: Optional[str] = None\n choices: Optional[Any] = None\n \n def to_schema(self) -> Dict[str, Any]:\n \"\"\"Return the JSON schema representation of the SAM CLI parameter.\"\"\"\n- param = {}\n+ param: Dict[str, Any] = {}\n param.update({\"title\": self.name, \"type\": self.type, \"description\": self.description})\n if self.default:\n param.update({\"default\": self.default})\n+ if self.items:\n+ param.update({\"items\": {\"type\": self.items}})\n if self.choices:\n param.update({\"enum\": self.choices})\n return param\n@@ -136,7 +139,10 @@\n formatted_param_type = param_type or \"string\"\n \n formatted_param: SamCliParameterSchema = SamCliParameterSchema(\n- param.name or \"\", formatted_param_type, clean_text(param.help or \"\")\n+ param.name or \"\",\n+ formatted_param_type,\n+ clean_text(param.help or \"\"),\n+ items=\"string\" if formatted_param_type == \"array\" else None,\n )\n \n if param.default:\n@@ -150,7 +156,15 @@\n \n def get_params_from_command(cli) -> List[SamCliParameterSchema]:\n \"\"\"Given a CLI object, return a list of all parameters in that CLI, formatted as SamCliParameterSchema objects.\"\"\"\n- return [format_param(param) for param in cli.params if param.name and isinstance(param, click.core.Option)]\n+ params_to_exclude = [\n+ \"config_env\", # shouldn't allow different environment from where the config is being read from\n+ \"config_file\", # shouldn't allow reading another file within current file\n+ ]\n+ return [\n+ format_param(param)\n+ for param in cli.params\n+ if param.name and isinstance(param, click.core.Option) and param.name not in params_to_exclude\n+ ]\n \n \n def retrieve_command_structure(package_name: str) -> List[SamCliCommandSchema]:\n", "issue": "fix: use StringIO instead of BytesIO with StreamWriter\nRelated to https://github.com/aws/aws-sam-cli/pull/5427\r\n#### Which issue(s) does this change fix?\r\nN/A\r\n\r\n\r\n#### Why is this change necessary?\r\nWith recently changed the way to write into stream to fix some issues related to encoding (see PR above). That changed caused some issues with ECRUpload class, due to discrepancy of the `write` method between `BytesIO` vs `StringIO`. `BytesIO` instance accepts byte array where `StringIO` accepts string.\r\n\r\n#### How does it address the issue?\r\nThis resolves issue by using `StringIO` stream instead of `BytesIO`. This PR also adds some typing for the inner `stream` instance of the `StreamWrapper` class to check for other usages in the code base.\r\n\r\n\r\n#### What side effects does this change have?\r\nManually running `sam local` tests to validate the change.\r\n\r\n\r\n#### Mandatory Checklist\r\n**PRs will only be reviewed after checklist is complete**\r\n\r\n- [ ] Add input/output [type hints](https://docs.python.org/3/library/typing.html) to new functions/methods\r\n- [ ] Write design document if needed ([Do I need to write a design document?](https://github.com/aws/aws-sam-cli/blob/develop/DEVELOPMENT_GUIDE.md#design-document))\r\n- [x] Write/update unit tests\r\n- [ ] Write/update integration tests\r\n- [ ] Write/update functional tests if needed\r\n- [x] `make pr` passes\r\n- [ ] `make update-reproducible-reqs` if dependencies were changed\r\n- [ ] Write documentation\r\n\r\nBy submitting this pull request, I confirm that my contribution is made under the terms of the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).\r\n\n", "before_files": [{"content": "\"\"\"Handles JSON schema generation logic\"\"\"\n\n\nimport importlib\nimport json\nfrom dataclasses import dataclass\nfrom enum import Enum\nfrom typing import Any, Dict, List, Optional\n\nimport click\n\nfrom samcli.cli.command import _SAM_CLI_COMMAND_PACKAGES\nfrom samcli.lib.config.samconfig import SamConfig\n\n\nclass SchemaKeys(Enum):\n SCHEMA_FILE_NAME = \"schema/samcli.json\"\n SCHEMA_DRAFT = \"http://json-schema.org/draft-04/schema\"\n TITLE = \"AWS SAM CLI samconfig schema\"\n ENVIRONMENT_REGEX = \"^.+$\"\n\n\n@dataclass()\nclass SamCliParameterSchema:\n \"\"\"Representation of a parameter in the SAM CLI.\n\n It includes relevant information for the JSON schema, such as name, data type,\n and description, among others.\n \"\"\"\n\n name: str\n type: str\n description: str = \"\"\n default: Optional[Any] = None\n choices: Optional[Any] = None\n\n def to_schema(self) -> Dict[str, Any]:\n \"\"\"Return the JSON schema representation of the SAM CLI parameter.\"\"\"\n param = {}\n param.update({\"title\": self.name, \"type\": self.type, \"description\": self.description})\n if self.default:\n param.update({\"default\": self.default})\n if self.choices:\n param.update({\"enum\": self.choices})\n return param\n\n\n@dataclass()\nclass SamCliCommandSchema:\n \"\"\"Representation of a command in the SAM CLI.\n\n It includes relevant information for the JSON schema, such as name, a description of the\n command, and a list of all available parameters.\n \"\"\"\n\n name: str # Full command name, with underscores (i.e. remote_invoke, local_start_lambda)\n description: str\n parameters: List[SamCliParameterSchema]\n\n def to_schema(self) -> dict:\n \"\"\"Return the JSON schema representation of the SAM CLI command.\"\"\"\n COMMANDS_TO_EXCLUDE = [ # TEMPORARY: for use only while generating piece-by-piece\n \"deploy\",\n \"build\",\n \"local\",\n \"validate\",\n \"package\",\n \"init\",\n \"delete\",\n \"bootstrap\",\n \"list\",\n \"traces\",\n \"sync\",\n \"publish\",\n \"pipeline\",\n \"logs\",\n \"remote\",\n ]\n split_cmd_name = self.name.split(\"_\")\n formatted_cmd_name = \" \".join(split_cmd_name)\n exclude_params = split_cmd_name[0] in COMMANDS_TO_EXCLUDE\n formatted_params_list = (\n \"* \" + \"\\n* \".join([f\"{param.name}:\\n{param.description}\" for param in self.parameters])\n if not exclude_params\n else \"\"\n )\n params_description = f\"Available parameters for the {formatted_cmd_name} command:\\n{formatted_params_list}\"\n\n return {\n self.name: {\n \"title\": f\"{formatted_cmd_name.title()} command\",\n \"description\": self.description or \"\",\n \"properties\": {\n \"parameters\": {\n \"title\": f\"Parameters for the {formatted_cmd_name} command\",\n \"description\": params_description,\n \"type\": \"object\",\n \"properties\": {param.name: param.to_schema() for param in self.parameters}\n if not exclude_params\n else {},\n },\n },\n \"required\": [\"parameters\"],\n }\n }\n\n\ndef clean_text(text: str) -> str:\n \"\"\"Clean up a string of text to be formatted for the JSON schema.\"\"\"\n if not text:\n return \"\"\n return text.replace(\"\\b\", \"\").strip(\"\\n\").strip()\n\n\ndef format_param(param: click.core.Option) -> SamCliParameterSchema:\n \"\"\"Format a click Option parameter to a SamCliParameter object.\n\n A parameter object should contain the following information that will be\n necessary for including in the JSON schema:\n * name - The name of the parameter\n * help - The parameter's description (may vary between commands)\n * type - The data type accepted by the parameter\n * type.choices - If there are only a certain number of options allowed,\n a list of those allowed options\n * default - The default option for that parameter\n \"\"\"\n param_type = param.type.name.lower()\n formatted_param_type = \"\"\n # NOTE: Params do not have explicit \"string\" type; either \"text\" or \"path\".\n # All choice options are from a set of strings.\n if param_type in [\"text\", \"path\", \"choice\", \"filename\", \"directory\"]:\n formatted_param_type = \"string\"\n elif param_type == \"list\":\n formatted_param_type = \"array\"\n else:\n formatted_param_type = param_type or \"string\"\n\n formatted_param: SamCliParameterSchema = SamCliParameterSchema(\n param.name or \"\", formatted_param_type, clean_text(param.help or \"\")\n )\n\n if param.default:\n formatted_param.default = list(param.default) if isinstance(param.default, tuple) else param.default\n\n if param.type.name == \"choice\" and isinstance(param.type, click.Choice):\n formatted_param.choices = list(param.type.choices)\n\n return formatted_param\n\n\ndef get_params_from_command(cli) -> List[SamCliParameterSchema]:\n \"\"\"Given a CLI object, return a list of all parameters in that CLI, formatted as SamCliParameterSchema objects.\"\"\"\n return [format_param(param) for param in cli.params if param.name and isinstance(param, click.core.Option)]\n\n\ndef retrieve_command_structure(package_name: str) -> List[SamCliCommandSchema]:\n \"\"\"Given a SAM CLI package name, retrieve its structure.\n\n Such a structure is the list of all subcommands as `SamCliCommandSchema`, which includes\n the command's name, description, and its parameters.\n\n Parameters\n ----------\n package_name: str\n The name of the command package to retrieve.\n\n Returns\n -------\n List[SamCliCommandSchema]\n A list of SamCliCommandSchema objects which represent either a command or a list of\n subcommands within the package.\n \"\"\"\n module = importlib.import_module(package_name)\n command = []\n\n if isinstance(module.cli, click.core.Group): # command has subcommands (e.g. local invoke)\n for subcommand in module.cli.commands.values():\n cmd_name = SamConfig.to_key([module.__name__.split(\".\")[-1], str(subcommand.name)])\n command.append(\n SamCliCommandSchema(\n cmd_name,\n clean_text(subcommand.help or subcommand.short_help or \"\"),\n get_params_from_command(subcommand),\n )\n )\n else:\n cmd_name = SamConfig.to_key([module.__name__.split(\".\")[-1]])\n command.append(\n SamCliCommandSchema(\n cmd_name,\n clean_text(module.cli.help or module.cli.short_help or \"\"),\n get_params_from_command(module.cli),\n )\n )\n return command\n\n\ndef generate_schema() -> dict:\n \"\"\"Generate a JSON schema for all SAM CLI commands.\n\n Returns\n -------\n dict\n A dictionary representation of the JSON schema.\n \"\"\"\n schema: dict = {}\n commands: List[SamCliCommandSchema] = []\n\n # Populate schema with relevant attributes\n schema[\"$schema\"] = SchemaKeys.SCHEMA_DRAFT.value\n schema[\"title\"] = SchemaKeys.TITLE.value\n schema[\"type\"] = \"object\"\n schema[\"properties\"] = {\n # Version number required for samconfig files to be valid\n \"version\": {\"title\": \"Config version\", \"type\": \"number\", \"default\": 0.1}\n }\n schema[\"required\"] = [\"version\"]\n schema[\"additionalProperties\"] = False\n # Iterate through packages for command and parameter information\n for package_name in _SAM_CLI_COMMAND_PACKAGES:\n commands.extend(retrieve_command_structure(package_name))\n # Generate schema for each of the commands\n schema[\"patternProperties\"] = {SchemaKeys.ENVIRONMENT_REGEX.value: {\"title\": \"Environment\", \"properties\": {}}}\n for command in commands:\n schema[\"patternProperties\"][SchemaKeys.ENVIRONMENT_REGEX.value][\"properties\"].update(command.to_schema())\n return schema\n\n\ndef write_schema():\n \"\"\"Generate the SAM CLI JSON schema and write it to file.\"\"\"\n schema = generate_schema()\n with open(SchemaKeys.SCHEMA_FILE_NAME.value, \"w+\", encoding=\"utf-8\") as outfile:\n json.dump(schema, outfile, indent=2)\n\n\nif __name__ == \"__main__\":\n write_schema()\n", "path": "schema/schema.py"}], "after_files": [{"content": "\"\"\"Handles JSON schema generation logic\"\"\"\n\n\nimport importlib\nimport json\nfrom dataclasses import dataclass\nfrom enum import Enum\nfrom typing import Any, Dict, List, Optional\n\nimport click\n\nfrom samcli.cli.command import _SAM_CLI_COMMAND_PACKAGES\nfrom samcli.lib.config.samconfig import SamConfig\n\n\nclass SchemaKeys(Enum):\n SCHEMA_FILE_NAME = \"schema/samcli.json\"\n SCHEMA_DRAFT = \"http://json-schema.org/draft-04/schema\"\n TITLE = \"AWS SAM CLI samconfig schema\"\n ENVIRONMENT_REGEX = \"^.+$\"\n\n\n@dataclass()\nclass SamCliParameterSchema:\n \"\"\"Representation of a parameter in the SAM CLI.\n\n It includes relevant information for the JSON schema, such as name, data type,\n and description, among others.\n \"\"\"\n\n name: str\n type: str\n description: str = \"\"\n default: Optional[Any] = None\n items: Optional[str] = None\n choices: Optional[Any] = None\n\n def to_schema(self) -> Dict[str, Any]:\n \"\"\"Return the JSON schema representation of the SAM CLI parameter.\"\"\"\n param: Dict[str, Any] = {}\n param.update({\"title\": self.name, \"type\": self.type, \"description\": self.description})\n if self.default:\n param.update({\"default\": self.default})\n if self.items:\n param.update({\"items\": {\"type\": self.items}})\n if self.choices:\n param.update({\"enum\": self.choices})\n return param\n\n\n@dataclass()\nclass SamCliCommandSchema:\n \"\"\"Representation of a command in the SAM CLI.\n\n It includes relevant information for the JSON schema, such as name, a description of the\n command, and a list of all available parameters.\n \"\"\"\n\n name: str # Full command name, with underscores (i.e. remote_invoke, local_start_lambda)\n description: str\n parameters: List[SamCliParameterSchema]\n\n def to_schema(self) -> dict:\n \"\"\"Return the JSON schema representation of the SAM CLI command.\"\"\"\n COMMANDS_TO_EXCLUDE = [ # TEMPORARY: for use only while generating piece-by-piece\n \"deploy\",\n \"build\",\n \"local\",\n \"validate\",\n \"package\",\n \"init\",\n \"delete\",\n \"bootstrap\",\n \"list\",\n \"traces\",\n \"sync\",\n \"publish\",\n \"pipeline\",\n \"logs\",\n \"remote\",\n ]\n split_cmd_name = self.name.split(\"_\")\n formatted_cmd_name = \" \".join(split_cmd_name)\n exclude_params = split_cmd_name[0] in COMMANDS_TO_EXCLUDE\n formatted_params_list = (\n \"* \" + \"\\n* \".join([f\"{param.name}:\\n{param.description}\" for param in self.parameters])\n if not exclude_params\n else \"\"\n )\n params_description = f\"Available parameters for the {formatted_cmd_name} command:\\n{formatted_params_list}\"\n\n return {\n self.name: {\n \"title\": f\"{formatted_cmd_name.title()} command\",\n \"description\": self.description or \"\",\n \"properties\": {\n \"parameters\": {\n \"title\": f\"Parameters for the {formatted_cmd_name} command\",\n \"description\": params_description,\n \"type\": \"object\",\n \"properties\": {param.name: param.to_schema() for param in self.parameters}\n if not exclude_params\n else {},\n },\n },\n \"required\": [\"parameters\"],\n }\n }\n\n\ndef clean_text(text: str) -> str:\n \"\"\"Clean up a string of text to be formatted for the JSON schema.\"\"\"\n if not text:\n return \"\"\n return text.replace(\"\\b\", \"\").strip(\"\\n\").strip()\n\n\ndef format_param(param: click.core.Option) -> SamCliParameterSchema:\n \"\"\"Format a click Option parameter to a SamCliParameter object.\n\n A parameter object should contain the following information that will be\n necessary for including in the JSON schema:\n * name - The name of the parameter\n * help - The parameter's description (may vary between commands)\n * type - The data type accepted by the parameter\n * type.choices - If there are only a certain number of options allowed,\n a list of those allowed options\n * default - The default option for that parameter\n \"\"\"\n param_type = param.type.name.lower()\n formatted_param_type = \"\"\n # NOTE: Params do not have explicit \"string\" type; either \"text\" or \"path\".\n # All choice options are from a set of strings.\n if param_type in [\"text\", \"path\", \"choice\", \"filename\", \"directory\"]:\n formatted_param_type = \"string\"\n elif param_type == \"list\":\n formatted_param_type = \"array\"\n else:\n formatted_param_type = param_type or \"string\"\n\n formatted_param: SamCliParameterSchema = SamCliParameterSchema(\n param.name or \"\",\n formatted_param_type,\n clean_text(param.help or \"\"),\n items=\"string\" if formatted_param_type == \"array\" else None,\n )\n\n if param.default:\n formatted_param.default = list(param.default) if isinstance(param.default, tuple) else param.default\n\n if param.type.name == \"choice\" and isinstance(param.type, click.Choice):\n formatted_param.choices = list(param.type.choices)\n\n return formatted_param\n\n\ndef get_params_from_command(cli) -> List[SamCliParameterSchema]:\n \"\"\"Given a CLI object, return a list of all parameters in that CLI, formatted as SamCliParameterSchema objects.\"\"\"\n params_to_exclude = [\n \"config_env\", # shouldn't allow different environment from where the config is being read from\n \"config_file\", # shouldn't allow reading another file within current file\n ]\n return [\n format_param(param)\n for param in cli.params\n if param.name and isinstance(param, click.core.Option) and param.name not in params_to_exclude\n ]\n\n\ndef retrieve_command_structure(package_name: str) -> List[SamCliCommandSchema]:\n \"\"\"Given a SAM CLI package name, retrieve its structure.\n\n Such a structure is the list of all subcommands as `SamCliCommandSchema`, which includes\n the command's name, description, and its parameters.\n\n Parameters\n ----------\n package_name: str\n The name of the command package to retrieve.\n\n Returns\n -------\n List[SamCliCommandSchema]\n A list of SamCliCommandSchema objects which represent either a command or a list of\n subcommands within the package.\n \"\"\"\n module = importlib.import_module(package_name)\n command = []\n\n if isinstance(module.cli, click.core.Group): # command has subcommands (e.g. local invoke)\n for subcommand in module.cli.commands.values():\n cmd_name = SamConfig.to_key([module.__name__.split(\".\")[-1], str(subcommand.name)])\n command.append(\n SamCliCommandSchema(\n cmd_name,\n clean_text(subcommand.help or subcommand.short_help or \"\"),\n get_params_from_command(subcommand),\n )\n )\n else:\n cmd_name = SamConfig.to_key([module.__name__.split(\".\")[-1]])\n command.append(\n SamCliCommandSchema(\n cmd_name,\n clean_text(module.cli.help or module.cli.short_help or \"\"),\n get_params_from_command(module.cli),\n )\n )\n return command\n\n\ndef generate_schema() -> dict:\n \"\"\"Generate a JSON schema for all SAM CLI commands.\n\n Returns\n -------\n dict\n A dictionary representation of the JSON schema.\n \"\"\"\n schema: dict = {}\n commands: List[SamCliCommandSchema] = []\n\n # Populate schema with relevant attributes\n schema[\"$schema\"] = SchemaKeys.SCHEMA_DRAFT.value\n schema[\"title\"] = SchemaKeys.TITLE.value\n schema[\"type\"] = \"object\"\n schema[\"properties\"] = {\n # Version number required for samconfig files to be valid\n \"version\": {\"title\": \"Config version\", \"type\": \"number\", \"default\": 0.1}\n }\n schema[\"required\"] = [\"version\"]\n schema[\"additionalProperties\"] = False\n # Iterate through packages for command and parameter information\n for package_name in _SAM_CLI_COMMAND_PACKAGES:\n commands.extend(retrieve_command_structure(package_name))\n # Generate schema for each of the commands\n schema[\"patternProperties\"] = {SchemaKeys.ENVIRONMENT_REGEX.value: {\"title\": \"Environment\", \"properties\": {}}}\n for command in commands:\n schema[\"patternProperties\"][SchemaKeys.ENVIRONMENT_REGEX.value][\"properties\"].update(command.to_schema())\n return schema\n\n\ndef write_schema():\n \"\"\"Generate the SAM CLI JSON schema and write it to file.\"\"\"\n schema = generate_schema()\n with open(SchemaKeys.SCHEMA_FILE_NAME.value, \"w+\", encoding=\"utf-8\") as outfile:\n json.dump(schema, outfile, indent=2)\n\n\nif __name__ == \"__main__\":\n write_schema()\n", "path": "schema/schema.py"}]}
| 3,056 | 483 |
gh_patches_debug_24778
|
rasdani/github-patches
|
git_diff
|
lightly-ai__lightly-336
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
AL detection scorer fails for object detection
## Error
## Reproduction:
`np.partition([[1.]],-2, axis=1)` yields `ValueError: kth(=-1) out of bounds (1)`
## Possible cause of error:
https://github.com/lightly-ai/lightly/blob/b064ab7f077867ab1fe4ca1a3977090701856c26/lightly/active_learning/utils/object_detection_output.py#L1[…]27
tries to do a one-hot-encoding without knowing the number of classes. Thus if max(labels) is only 1, only one class is encoded and the probability vector only has a length of 1. Thus partitioning it into 2 fails.
## Possible Solutions:
### 1. Prevent the error cause
Create the class_probabilities vector correctly with a given number of classes.
### 2. Handle the error (MUST DO, We all agree on it)
In the ScorerClassification handle the case where there is only a single class
### 3. General solution
The class_probabilities do not make sense at all if the ObjectDetectionOutput is created from scores. Thus we could also not create the `class_probabilities` in this case and not compute any classification scores if the `class_probabilities` are unset.
Solution 1 and 3 are exclusive, solution 2 can be combined with the other solutions.
## How to work on this issue
- First write a unittest reproducing the error by using ClassificationScorer.calculate_scores()
- Next fix this unittest with solution 2.
- Do not work on Solution 3 yet (another issue)
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `lightly/active_learning/scorers/classification.py`
Content:
```
1 from typing import *
2
3 import numpy as np
4
5 from lightly.active_learning.scorers.scorer import Scorer
6
7
8 def _entropy(probs: np.ndarray, axis: int = 1) -> np.ndarray:
9 """Computes the entropy of a probability matrix over one array
10
11 Args:
12 probs:
13 A probability matrix of shape (N, M)
14 axis:
15 The axis the compute the probability over, the output does not have this axis anymore
16
17 Exammple:
18 if probs.shape = (N, C) and axis = 1 then entropies.shape = (N, )
19
20 Returns:
21 The entropy of the prediction vectors, shape: probs.shape, but without the specified axis
22 """
23 zeros = np.zeros_like(probs)
24 log_probs = np.log2(probs, out=zeros, where=probs > 0)
25 entropies = -1 * np.sum(probs * log_probs, axis=axis)
26 return entropies
27
28 def _margin_largest_secondlargest(probs: np.ndarray) -> np.ndarray:
29 """Computes the margin of a probability matrix
30
31 Args:
32 probs:
33 A probability matrix of shape (N, M)
34
35 Exammple:
36 if probs.shape = (N, C) then margins.shape = (N, )
37
38 Returns:
39 The margin of the prediction vectors
40 """
41 sorted_probs = np.partition(probs, -2, axis=1)
42 margins = sorted_probs[:, -1] - sorted_probs[:, -2]
43 return margins
44
45
46 class ScorerClassification(Scorer):
47 """Class to compute active learning scores from the model_output of a classification task.
48
49 Currently supports the following scorers:
50
51 The following three uncertainty scores are taken from
52 http://burrsettles.com/pub/settles.activelearning.pdf, Section 3.1, page 12f
53 and also explained in https://towardsdatascience.com/uncertainty-sampling-cheatsheet-ec57bc067c0b
54 They all have in common, that the score is highest if all classes have the
55 same confidence and are 0 if the model assigns 100% probability to a single class.
56 The differ in the number of class confidences they take into account.
57
58 `uncertainty_least_confidence`:
59 This score is 1 - the highest confidence prediction. It is high
60 when the confidence about the most probable class is low.
61
62 `uncertainty_margin`
63 This score is 1- the margin between the highest conficence
64 and second highest confidence prediction. It is high when the model
65 cannot decide between the two most probable classes.
66
67 `uncertainty_entropy`:
68 This scorer computes the entropy of the prediction. The confidences
69 for all classes are considered to compute the entropy of a sample.
70
71 Attributes:
72 model_output:
73 Predictions of shape N x C where N is the number of unlabeled samples
74 and C is the number of classes in the classification task. Must be
75 normalized such that the sum over each row is 1.
76 The order of the predictions must be the one specified by
77 ActiveLearningAgent.unlabeled_set.
78
79 Examples:
80 >>> # example with three unlabeled samples
81 >>> al_agent.unlabeled_set
82 >>> > ['img0.jpg', 'img1.jpg', 'img2.jpg']
83 >>> predictions = np.array(
84 >>> [
85 >>> [0.1, 0.9], # predictions for img0.jpg
86 >>> [0.3, 0.7], # predictions for img1.jpg
87 >>> [0.8, 0.2], # predictions for img2.jpg
88 >>> ]
89 >>> )
90 >>> np.sum(predictions, axis=1)
91 >>> > array([1., 1., 1.])
92 >>> scorer = ScorerClassification(predictions)
93
94 """
95 def __init__(self, model_output: Union[np.ndarray, List[List[float]]]):
96 if isinstance(model_output, List):
97 model_output = np.array(model_output)
98 super(ScorerClassification, self).__init__(model_output)
99
100 @classmethod
101 def score_names(cls) -> List[str]:
102 """Returns the names of the calculated active learning scores
103 """
104 score_names = list(cls(model_output=[[0.5, 0.5]]).calculate_scores().keys())
105 return score_names
106
107 def calculate_scores(self, normalize_to_0_1: bool = True) -> Dict[str, np.ndarray]:
108 """Calculates and returns the active learning scores.
109
110 Args:
111 normalize_to_0_1:
112 If this is true, each score is normalized to have a
113 theoretical minimum of 0 and a theoretical maximum of 1.
114
115 Returns:
116 A dictionary mapping from the score name (as string)
117 to the scores (as a single-dimensional numpy array).
118 """
119 if len(self.model_output) == 0:
120 return {score_name: [] for score_name in self.score_names()}
121
122 scores_with_names = [
123 self._get_scores_uncertainty_least_confidence(),
124 self._get_scores_uncertainty_margin(),
125 self._get_scores_uncertainty_entropy()
126 ]
127
128 scores = dict()
129 for score, score_name in scores_with_names:
130 score = np.nan_to_num(score)
131 scores[score_name] = score
132
133 if normalize_to_0_1:
134 scores = self.normalize_scores_0_1(scores)
135
136 return scores
137
138 def normalize_scores_0_1(self, scores: Dict[str, np.ndarray]) -> Dict[str, np.ndarray]:
139 num_classes = self.model_output.shape[1]
140 model_output_very_sure = np.zeros(shape=(1,num_classes))
141 model_output_very_sure[0, 0] = 1
142 model_output_very_unsure = np.ones_like(model_output_very_sure)/num_classes
143
144 scores_minimum = ScorerClassification(model_output_very_sure).calculate_scores(normalize_to_0_1=False)
145 scores_maximum = ScorerClassification(model_output_very_unsure).calculate_scores(normalize_to_0_1=False)
146
147 for score_name in scores.keys():
148 interp_xp = [float(scores_minimum[score_name]), float(scores_maximum[score_name])]
149 interp_fp = [0, 1]
150 scores[score_name] = np.interp(scores[score_name], interp_xp, interp_fp)
151
152 return scores
153
154 def _get_scores_uncertainty_least_confidence(self):
155 scores = 1 - np.max(self.model_output, axis=1)
156 return scores, "uncertainty_least_confidence"
157
158 def _get_scores_uncertainty_margin(self):
159 scores = 1 - _margin_largest_secondlargest(self.model_output)
160 return scores, "uncertainty_margin"
161
162 def _get_scores_uncertainty_entropy(self):
163 scores = _entropy(self.model_output, axis=1)
164 return scores, "uncertainty_entropy"
165
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/lightly/active_learning/scorers/classification.py b/lightly/active_learning/scorers/classification.py
--- a/lightly/active_learning/scorers/classification.py
+++ b/lightly/active_learning/scorers/classification.py
@@ -1,3 +1,4 @@
+import warnings
from typing import *
import numpy as np
@@ -93,9 +94,25 @@
"""
def __init__(self, model_output: Union[np.ndarray, List[List[float]]]):
- if isinstance(model_output, List):
+ if not isinstance(model_output, np.ndarray):
model_output = np.array(model_output)
- super(ScorerClassification, self).__init__(model_output)
+
+ validated_model_output = self.ensure_valid_model_output(model_output)
+
+ super(ScorerClassification, self).__init__(validated_model_output)
+
+ def ensure_valid_model_output(self, model_output: np.ndarray) -> np.ndarray:
+ if len(model_output) == 0:
+ return model_output
+ if len(model_output.shape) != 2:
+ raise ValueError("ScorerClassification model_output must be a 2-dimensional array")
+ if model_output.shape[1] == 0:
+ raise ValueError("ScorerClassification model_output must not have an empty dimension 1")
+ if model_output.shape[1] == 1:
+ # assuming a binary classification problem with
+ # the model_output denoting the probability of the first class
+ model_output = np.concatenate([model_output, 1-model_output], axis=1)
+ return model_output
@classmethod
def score_names(cls) -> List[str]:
|
{"golden_diff": "diff --git a/lightly/active_learning/scorers/classification.py b/lightly/active_learning/scorers/classification.py\n--- a/lightly/active_learning/scorers/classification.py\n+++ b/lightly/active_learning/scorers/classification.py\n@@ -1,3 +1,4 @@\n+import warnings\n from typing import *\n \n import numpy as np\n@@ -93,9 +94,25 @@\n \n \"\"\"\n def __init__(self, model_output: Union[np.ndarray, List[List[float]]]):\n- if isinstance(model_output, List):\n+ if not isinstance(model_output, np.ndarray):\n model_output = np.array(model_output)\n- super(ScorerClassification, self).__init__(model_output)\n+\n+ validated_model_output = self.ensure_valid_model_output(model_output)\n+\n+ super(ScorerClassification, self).__init__(validated_model_output)\n+\n+ def ensure_valid_model_output(self, model_output: np.ndarray) -> np.ndarray:\n+ if len(model_output) == 0:\n+ return model_output\n+ if len(model_output.shape) != 2:\n+ raise ValueError(\"ScorerClassification model_output must be a 2-dimensional array\")\n+ if model_output.shape[1] == 0:\n+ raise ValueError(\"ScorerClassification model_output must not have an empty dimension 1\")\n+ if model_output.shape[1] == 1:\n+ # assuming a binary classification problem with\n+ # the model_output denoting the probability of the first class\n+ model_output = np.concatenate([model_output, 1-model_output], axis=1)\n+ return model_output\n \n @classmethod\n def score_names(cls) -> List[str]:\n", "issue": "AL detection scorer fails for object detection\n## Error\r\n\r\n## Reproduction:\r\n`np.partition([[1.]],-2, axis=1)` yields `ValueError: kth(=-1) out of bounds (1)`\r\n## Possible cause of error:\r\nhttps://github.com/lightly-ai/lightly/blob/b064ab7f077867ab1fe4ca1a3977090701856c26/lightly/active_learning/utils/object_detection_output.py#L1[\u2026]27\r\ntries to do a one-hot-encoding without knowing the number of classes. Thus if max(labels) is only 1, only one class is encoded and the probability vector only has a length of 1. Thus partitioning it into 2 fails.\r\n\r\n## Possible Solutions:\r\n### 1. Prevent the error cause\r\nCreate the class_probabilities vector correctly with a given number of classes.\r\n### 2. Handle the error (MUST DO, We all agree on it)\r\nIn the ScorerClassification handle the case where there is only a single class\r\n### 3. General solution\r\nThe class_probabilities do not make sense at all if the ObjectDetectionOutput is created from scores. Thus we could also not create the `class_probabilities` in this case and not compute any classification scores if the `class_probabilities` are unset.\r\n\r\nSolution 1 and 3 are exclusive, solution 2 can be combined with the other solutions.\r\n\r\n## How to work on this issue\r\n- First write a unittest reproducing the error by using ClassificationScorer.calculate_scores()\r\n- Next fix this unittest with solution 2.\r\n- Do not work on Solution 3 yet (another issue)\n", "before_files": [{"content": "from typing import *\n\nimport numpy as np\n\nfrom lightly.active_learning.scorers.scorer import Scorer\n\n\ndef _entropy(probs: np.ndarray, axis: int = 1) -> np.ndarray:\n \"\"\"Computes the entropy of a probability matrix over one array\n\n Args:\n probs:\n A probability matrix of shape (N, M)\n axis:\n The axis the compute the probability over, the output does not have this axis anymore\n\n Exammple:\n if probs.shape = (N, C) and axis = 1 then entropies.shape = (N, )\n\n Returns:\n The entropy of the prediction vectors, shape: probs.shape, but without the specified axis\n \"\"\"\n zeros = np.zeros_like(probs)\n log_probs = np.log2(probs, out=zeros, where=probs > 0)\n entropies = -1 * np.sum(probs * log_probs, axis=axis)\n return entropies\n\ndef _margin_largest_secondlargest(probs: np.ndarray) -> np.ndarray:\n \"\"\"Computes the margin of a probability matrix\n\n Args:\n probs:\n A probability matrix of shape (N, M)\n\n Exammple:\n if probs.shape = (N, C) then margins.shape = (N, )\n\n Returns:\n The margin of the prediction vectors\n \"\"\"\n sorted_probs = np.partition(probs, -2, axis=1)\n margins = sorted_probs[:, -1] - sorted_probs[:, -2]\n return margins\n\n\nclass ScorerClassification(Scorer):\n \"\"\"Class to compute active learning scores from the model_output of a classification task.\n\n Currently supports the following scorers:\n\n The following three uncertainty scores are taken from\n http://burrsettles.com/pub/settles.activelearning.pdf, Section 3.1, page 12f\n and also explained in https://towardsdatascience.com/uncertainty-sampling-cheatsheet-ec57bc067c0b\n They all have in common, that the score is highest if all classes have the\n same confidence and are 0 if the model assigns 100% probability to a single class.\n The differ in the number of class confidences they take into account.\n\n `uncertainty_least_confidence`:\n This score is 1 - the highest confidence prediction. It is high\n when the confidence about the most probable class is low.\n\n `uncertainty_margin`\n This score is 1- the margin between the highest conficence\n and second highest confidence prediction. It is high when the model\n cannot decide between the two most probable classes.\n\n `uncertainty_entropy`:\n This scorer computes the entropy of the prediction. The confidences\n for all classes are considered to compute the entropy of a sample.\n\n Attributes:\n model_output:\n Predictions of shape N x C where N is the number of unlabeled samples\n and C is the number of classes in the classification task. Must be\n normalized such that the sum over each row is 1.\n The order of the predictions must be the one specified by\n ActiveLearningAgent.unlabeled_set.\n\n Examples:\n >>> # example with three unlabeled samples\n >>> al_agent.unlabeled_set\n >>> > ['img0.jpg', 'img1.jpg', 'img2.jpg']\n >>> predictions = np.array(\n >>> [\n >>> [0.1, 0.9], # predictions for img0.jpg\n >>> [0.3, 0.7], # predictions for img1.jpg\n >>> [0.8, 0.2], # predictions for img2.jpg\n >>> ] \n >>> )\n >>> np.sum(predictions, axis=1)\n >>> > array([1., 1., 1.])\n >>> scorer = ScorerClassification(predictions)\n\n \"\"\"\n def __init__(self, model_output: Union[np.ndarray, List[List[float]]]):\n if isinstance(model_output, List):\n model_output = np.array(model_output)\n super(ScorerClassification, self).__init__(model_output)\n\n @classmethod\n def score_names(cls) -> List[str]:\n \"\"\"Returns the names of the calculated active learning scores\n \"\"\"\n score_names = list(cls(model_output=[[0.5, 0.5]]).calculate_scores().keys())\n return score_names\n\n def calculate_scores(self, normalize_to_0_1: bool = True) -> Dict[str, np.ndarray]:\n \"\"\"Calculates and returns the active learning scores.\n\n Args:\n normalize_to_0_1:\n If this is true, each score is normalized to have a\n theoretical minimum of 0 and a theoretical maximum of 1.\n\n Returns:\n A dictionary mapping from the score name (as string)\n to the scores (as a single-dimensional numpy array).\n \"\"\"\n if len(self.model_output) == 0:\n return {score_name: [] for score_name in self.score_names()}\n\n scores_with_names = [\n self._get_scores_uncertainty_least_confidence(),\n self._get_scores_uncertainty_margin(),\n self._get_scores_uncertainty_entropy()\n ]\n\n scores = dict()\n for score, score_name in scores_with_names:\n score = np.nan_to_num(score)\n scores[score_name] = score\n\n if normalize_to_0_1:\n scores = self.normalize_scores_0_1(scores)\n\n return scores\n\n def normalize_scores_0_1(self, scores: Dict[str, np.ndarray]) -> Dict[str, np.ndarray]:\n num_classes = self.model_output.shape[1]\n model_output_very_sure = np.zeros(shape=(1,num_classes))\n model_output_very_sure[0, 0] = 1\n model_output_very_unsure = np.ones_like(model_output_very_sure)/num_classes\n\n scores_minimum = ScorerClassification(model_output_very_sure).calculate_scores(normalize_to_0_1=False)\n scores_maximum = ScorerClassification(model_output_very_unsure).calculate_scores(normalize_to_0_1=False)\n\n for score_name in scores.keys():\n interp_xp = [float(scores_minimum[score_name]), float(scores_maximum[score_name])]\n interp_fp = [0, 1]\n scores[score_name] = np.interp(scores[score_name], interp_xp, interp_fp)\n\n return scores\n\n def _get_scores_uncertainty_least_confidence(self):\n scores = 1 - np.max(self.model_output, axis=1)\n return scores, \"uncertainty_least_confidence\"\n\n def _get_scores_uncertainty_margin(self):\n scores = 1 - _margin_largest_secondlargest(self.model_output)\n return scores, \"uncertainty_margin\"\n\n def _get_scores_uncertainty_entropy(self):\n scores = _entropy(self.model_output, axis=1)\n return scores, \"uncertainty_entropy\"\n", "path": "lightly/active_learning/scorers/classification.py"}], "after_files": [{"content": "import warnings\nfrom typing import *\n\nimport numpy as np\n\nfrom lightly.active_learning.scorers.scorer import Scorer\n\n\ndef _entropy(probs: np.ndarray, axis: int = 1) -> np.ndarray:\n \"\"\"Computes the entropy of a probability matrix over one array\n\n Args:\n probs:\n A probability matrix of shape (N, M)\n axis:\n The axis the compute the probability over, the output does not have this axis anymore\n\n Exammple:\n if probs.shape = (N, C) and axis = 1 then entropies.shape = (N, )\n\n Returns:\n The entropy of the prediction vectors, shape: probs.shape, but without the specified axis\n \"\"\"\n zeros = np.zeros_like(probs)\n log_probs = np.log2(probs, out=zeros, where=probs > 0)\n entropies = -1 * np.sum(probs * log_probs, axis=axis)\n return entropies\n\ndef _margin_largest_secondlargest(probs: np.ndarray) -> np.ndarray:\n \"\"\"Computes the margin of a probability matrix\n\n Args:\n probs:\n A probability matrix of shape (N, M)\n\n Exammple:\n if probs.shape = (N, C) then margins.shape = (N, )\n\n Returns:\n The margin of the prediction vectors\n \"\"\"\n sorted_probs = np.partition(probs, -2, axis=1)\n margins = sorted_probs[:, -1] - sorted_probs[:, -2]\n return margins\n\n\nclass ScorerClassification(Scorer):\n \"\"\"Class to compute active learning scores from the model_output of a classification task.\n\n Currently supports the following scorers:\n\n The following three uncertainty scores are taken from\n http://burrsettles.com/pub/settles.activelearning.pdf, Section 3.1, page 12f\n and also explained in https://towardsdatascience.com/uncertainty-sampling-cheatsheet-ec57bc067c0b\n They all have in common, that the score is highest if all classes have the\n same confidence and are 0 if the model assigns 100% probability to a single class.\n The differ in the number of class confidences they take into account.\n\n `uncertainty_least_confidence`:\n This score is 1 - the highest confidence prediction. It is high\n when the confidence about the most probable class is low.\n\n `uncertainty_margin`\n This score is 1- the margin between the highest conficence\n and second highest confidence prediction. It is high when the model\n cannot decide between the two most probable classes.\n\n `uncertainty_entropy`:\n This scorer computes the entropy of the prediction. The confidences\n for all classes are considered to compute the entropy of a sample.\n\n Attributes:\n model_output:\n Predictions of shape N x C where N is the number of unlabeled samples\n and C is the number of classes in the classification task. Must be\n normalized such that the sum over each row is 1.\n The order of the predictions must be the one specified by\n ActiveLearningAgent.unlabeled_set.\n\n Examples:\n >>> # example with three unlabeled samples\n >>> al_agent.unlabeled_set\n >>> > ['img0.jpg', 'img1.jpg', 'img2.jpg']\n >>> predictions = np.array(\n >>> [\n >>> [0.1, 0.9], # predictions for img0.jpg\n >>> [0.3, 0.7], # predictions for img1.jpg\n >>> [0.8, 0.2], # predictions for img2.jpg\n >>> ] \n >>> )\n >>> np.sum(predictions, axis=1)\n >>> > array([1., 1., 1.])\n >>> scorer = ScorerClassification(predictions)\n\n \"\"\"\n def __init__(self, model_output: Union[np.ndarray, List[List[float]]]):\n if not isinstance(model_output, np.ndarray):\n model_output = np.array(model_output)\n\n validated_model_output = self.ensure_valid_model_output(model_output)\n\n super(ScorerClassification, self).__init__(validated_model_output)\n\n def ensure_valid_model_output(self, model_output: np.ndarray) -> np.ndarray:\n if len(model_output) == 0:\n return model_output\n if len(model_output.shape) != 2:\n raise ValueError(\"ScorerClassification model_output must be a 2-dimensional array\")\n if model_output.shape[1] == 0:\n raise ValueError(\"ScorerClassification model_output must not have an empty dimension 1\")\n if model_output.shape[1] == 1:\n # assuming a binary classification problem with\n # the model_output denoting the probability of the first class\n model_output = np.concatenate([model_output, 1-model_output], axis=1)\n return model_output\n\n @classmethod\n def score_names(cls) -> List[str]:\n \"\"\"Returns the names of the calculated active learning scores\n \"\"\"\n score_names = list(cls(model_output=[[0.5, 0.5]]).calculate_scores().keys())\n return score_names\n\n def calculate_scores(self, normalize_to_0_1: bool = True) -> Dict[str, np.ndarray]:\n \"\"\"Calculates and returns the active learning scores.\n\n Args:\n normalize_to_0_1:\n If this is true, each score is normalized to have a\n theoretical minimum of 0 and a theoretical maximum of 1.\n\n Returns:\n A dictionary mapping from the score name (as string)\n to the scores (as a single-dimensional numpy array).\n \"\"\"\n if len(self.model_output) == 0:\n return {score_name: [] for score_name in self.score_names()}\n\n scores_with_names = [\n self._get_scores_uncertainty_least_confidence(),\n self._get_scores_uncertainty_margin(),\n self._get_scores_uncertainty_entropy()\n ]\n\n scores = dict()\n for score, score_name in scores_with_names:\n score = np.nan_to_num(score)\n scores[score_name] = score\n\n if normalize_to_0_1:\n scores = self.normalize_scores_0_1(scores)\n\n return scores\n\n def normalize_scores_0_1(self, scores: Dict[str, np.ndarray]) -> Dict[str, np.ndarray]:\n num_classes = self.model_output.shape[1]\n model_output_very_sure = np.zeros(shape=(1,num_classes))\n model_output_very_sure[0, 0] = 1\n model_output_very_unsure = np.ones_like(model_output_very_sure)/num_classes\n\n scores_minimum = ScorerClassification(model_output_very_sure).calculate_scores(normalize_to_0_1=False)\n scores_maximum = ScorerClassification(model_output_very_unsure).calculate_scores(normalize_to_0_1=False)\n\n for score_name in scores.keys():\n interp_xp = [float(scores_minimum[score_name]), float(scores_maximum[score_name])]\n interp_fp = [0, 1]\n scores[score_name] = np.interp(scores[score_name], interp_xp, interp_fp)\n\n return scores\n\n def _get_scores_uncertainty_least_confidence(self):\n scores = 1 - np.max(self.model_output, axis=1)\n return scores, \"uncertainty_least_confidence\"\n\n def _get_scores_uncertainty_margin(self):\n scores = 1 - _margin_largest_secondlargest(self.model_output)\n return scores, \"uncertainty_margin\"\n\n def _get_scores_uncertainty_entropy(self):\n scores = _entropy(self.model_output, axis=1)\n return scores, \"uncertainty_entropy\"\n", "path": "lightly/active_learning/scorers/classification.py"}]}
| 2,577 | 368 |
gh_patches_debug_41517
|
rasdani/github-patches
|
git_diff
|
conan-io__conan-center-index-7894
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[package] gtest/1.11.0: CMakeDeps + Conan 1.42 uses incorrect names for CMake config file, namespace, and gtest component
### Package and Environment Details (include every applicable attribute)
* Package Name/Version: **gtest/3.1.0**
* Operating System+version: **Fedora Silverblue 35**
* Compiler+version: **GCC 11**
* Conan version: **conan 1.42.0**
* Python version: **Python 3.10.0**
### Conan profile (output of `conan profile show default` or `conan profile show <profile>` if custom profile is in use)
```
[settings]
os=Linux
arch=x86_64
compiler=gcc
compiler.version=11
compiler.libcxx=libstdc++11
compiler.cppstd=17
build_type=Debug
[options]
[conf]
[build_requires]
[env]
```
### Steps to reproduce (Include if Applicable)
Use the `CMakeToolchain` / `CMakeDeps` generator for a project and add `ms-gsl` as a `requires`.
In your `CMakeLists.txt` use `find_package(GTest)` and it will not be found during CMake's configure stage.
This is because the package is now named `gtest` instead, which is unexpected.
I don't think the component name for `libgtest` or the namespace for the CMake targets will be correct now either for the CMakeDeps generator.
### Logs (Include/Attach if Applicable)
<details><summary>Click to expand log</summary>
```
CMake Error at src/CMakeLists.txt:21 (add_executable):
Target "TestDriver" links to target "GTest::gtest_main" but the target was
not found. Perhaps a find_package() call is missing for an IMPORTED
target, or an ALIAS target is missing?
CMake Error at src/CMakeLists.txt:21 (add_executable):
Target "TestDriver" links to target "GTest::gtest_main" but the target was
not found. Perhaps a find_package() call is missing for an IMPORTED
target, or an ALIAS target is missing?
```
</details>
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `recipes/gtest/all/conanfile.py`
Content:
```
1 from conans import ConanFile, CMake, tools
2 from conans.errors import ConanInvalidConfiguration
3 import os
4 import functools
5
6 required_conan_version = ">=1.33.0"
7
8
9 class GTestConan(ConanFile):
10 name = "gtest"
11 description = "Google's C++ test framework"
12 url = "https://github.com/conan-io/conan-center-index"
13 homepage = "https://github.com/google/googletest"
14 license = "BSD-3-Clause"
15 topics = ("testing", "google-testing", "unit-test")
16 settings = "os", "arch", "compiler", "build_type"
17 options = {
18 "shared": [True, False],
19 "build_gmock": [True, False],
20 "fPIC": [True, False],
21 "no_main": [True, False],
22 "debug_postfix": "ANY",
23 "hide_symbols": [True, False],
24 }
25 default_options = {
26 "shared": False,
27 "build_gmock": True,
28 "fPIC": True,
29 "no_main": False,
30 "debug_postfix": "d",
31 "hide_symbols": False,
32 }
33
34 exports_sources = "CMakeLists.txt", "patches/*"
35 generators = "cmake"
36
37 @property
38 def _source_subfolder(self):
39 return "source_subfolder"
40
41 @property
42 def _build_subfolder(self):
43 return "build_subfolder"
44
45 @property
46 def _minimum_cpp_standard(self):
47 if self.version == "1.8.1":
48 return 98
49 else:
50 return 11
51
52 @property
53 def _minimum_compilers_version(self):
54 if self.version == "1.8.1":
55 return {
56 "Visual Studio": "14"
57 }
58 elif self.version == "1.10.0":
59 return {
60 "Visual Studio": "14",
61 "gcc": "4.8.1",
62 "clang": "3.3",
63 "apple-clang": "5.0"
64 }
65 else:
66 return {
67 "Visual Studio": "14",
68 "gcc": "5",
69 "clang": "5",
70 "apple-clang": "9.1"
71 }
72
73 def config_options(self):
74 if self.settings.os == "Windows":
75 del self.options.fPIC
76 if self.settings.build_type != "Debug":
77 del self.options.debug_postfix
78
79 def configure(self):
80 if self.options.shared:
81 del self.options.fPIC
82
83 def validate(self):
84 if self.settings.get_safe("compiler.cppstd"):
85 tools.check_min_cppstd(self, self._minimum_cpp_standard)
86 min_version = self._minimum_compilers_version.get(
87 str(self.settings.compiler))
88 if self.settings.compiler == "Visual Studio":
89 if self.options.shared and "MT" in self.settings.compiler.runtime:
90 raise ConanInvalidConfiguration("gtest:shared=True with compiler=\"Visual Studio\" is not compatible with compiler.runtime=MT/MTd")
91
92 def lazy_lt_semver(v1, v2):
93 lv1 = [int(v) for v in v1.split(".")]
94 lv2 = [int(v) for v in v2.split(".")]
95 min_length = min(len(lv1), len(lv2))
96 return lv1[:min_length] < lv2[:min_length]
97
98 if not min_version:
99 self.output.warn("{} recipe lacks information about {} compiler support.".format(
100 self.name, self.settings.compiler))
101 else:
102 if lazy_lt_semver(str(self.settings.compiler.version), min_version):
103 raise ConanInvalidConfiguration("{0} requires {1} {2}. The current compiler is {1} {3}.".format(
104 self.name, self.settings.compiler, min_version, self.settings.compiler.version))
105
106 def package_id(self):
107 del self.info.options.no_main
108
109 def source(self):
110 tools.get(**self.conan_data["sources"][self.version],
111 destination=self._source_subfolder, strip_root=True)
112
113 @functools.lru_cache(1)
114 def _configure_cmake(self):
115 cmake = CMake(self)
116 if self.settings.build_type == "Debug":
117 cmake.definitions["CUSTOM_DEBUG_POSTFIX"] = self.options.debug_postfix
118 if self.settings.compiler == "Visual Studio":
119 cmake.definitions["gtest_force_shared_crt"] = "MD" in self.settings.compiler.runtime
120 cmake.definitions["BUILD_GMOCK"] = self.options.build_gmock
121 if self.settings.os == "Windows" and self.settings.compiler == "gcc":
122 cmake.definitions["gtest_disable_pthreads"] = True
123 cmake.definitions["gtest_hide_internal_symbols"] = self.options.hide_symbols
124 cmake.configure(build_folder=self._build_subfolder)
125 return cmake
126
127 def build(self):
128 for patch in self.conan_data.get("patches", {}).get(self.version, []):
129 tools.patch(**patch)
130 cmake = self._configure_cmake()
131 cmake.build()
132
133 def package(self):
134 self.copy("LICENSE", dst="licenses", src=self._source_subfolder)
135 cmake = self._configure_cmake()
136 cmake.install()
137 tools.rmdir(os.path.join(self.package_folder, "lib", "pkgconfig"))
138 tools.rmdir(os.path.join(self.package_folder, "lib", "cmake"))
139 tools.remove_files_by_mask(os.path.join(self.package_folder, "lib"), "*.pdb")
140
141 @property
142 def _postfix(self):
143 return self.options.debug_postfix if self.settings.build_type == "Debug" else ""
144
145 def package_info(self):
146 self.cpp_info.names["cmake_find_package"] = "GTest"
147 self.cpp_info.names["cmake_find_package_multi"] = "GTest"
148 self.cpp_info.components["libgtest"].names["cmake_find_package"] = "gtest"
149 self.cpp_info.components["libgtest"].names["cmake_find_package_multi"] = "gtest"
150 self.cpp_info.components["libgtest"].names["pkg_config"] = "gtest"
151 self.cpp_info.components["libgtest"].libs = ["gtest{}".format(self._postfix)]
152 if self.settings.os == "Linux":
153 self.cpp_info.components["libgtest"].system_libs.append("pthread")
154
155 if self.settings.os == "Neutrino" and self.settings.os.version == "7.1":
156 self.cpp_info.components["libgtest"].system_libs.append("regex")
157
158 if self.options.shared:
159 self.cpp_info.components["libgtest"].defines.append("GTEST_LINKED_AS_SHARED_LIBRARY=1")
160
161 if self.version == "1.8.1":
162 if self.settings.compiler == "Visual Studio":
163 if tools.Version(self.settings.compiler.version) >= "15":
164 self.cpp_info.components["libgtest"].defines.append("GTEST_LANG_CXX11=1")
165 self.cpp_info.components["libgtest"].defines.append("GTEST_HAS_TR1_TUPLE=0")
166
167 if not self.options.no_main:
168 self.cpp_info.components["gtest_main"].libs = ["gtest_main{}".format(self._postfix)]
169 self.cpp_info.components["gtest_main"].requires = ["libgtest"]
170 self.cpp_info.components["gtest_main"].names["cmake_find_package"] = "gtest_main"
171 self.cpp_info.components["gtest_main"].names["cmake_find_package_multi"] = "gtest_main"
172 self.cpp_info.components["gtest_main"].names["pkg_config"] = "gtest_main"
173
174 if self.options.build_gmock:
175 self.cpp_info.components["gmock"].names["cmake_find_package"] = "gmock"
176 self.cpp_info.components["gmock"].names["cmake_find_package_multi"] = "gmock"
177 self.cpp_info.components["gmock"].names["pkg_config"] = "gmock"
178 self.cpp_info.components["gmock"].libs = ["gmock{}".format(self._postfix)]
179 self.cpp_info.components["gmock"].requires = ["libgtest"]
180 if not self.options.no_main:
181 self.cpp_info.components["gmock_main"].names["cmake_find_package"] = "gmock_main"
182 self.cpp_info.components["gmock_main"].names["cmake_find_package_multi"] = "gmock_main"
183 self.cpp_info.components["gmock_main"].names["pkg_config"] = "gmock_main"
184 self.cpp_info.components["gmock_main"].libs = ["gmock_main{}".format(self._postfix)]
185 self.cpp_info.components["gmock_main"].requires = ["gmock"]
186
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/recipes/gtest/all/conanfile.py b/recipes/gtest/all/conanfile.py
--- a/recipes/gtest/all/conanfile.py
+++ b/recipes/gtest/all/conanfile.py
@@ -3,7 +3,7 @@
import os
import functools
-required_conan_version = ">=1.33.0"
+required_conan_version = ">=1.36.0"
class GTestConan(ConanFile):
@@ -143,11 +143,10 @@
return self.options.debug_postfix if self.settings.build_type == "Debug" else ""
def package_info(self):
- self.cpp_info.names["cmake_find_package"] = "GTest"
- self.cpp_info.names["cmake_find_package_multi"] = "GTest"
- self.cpp_info.components["libgtest"].names["cmake_find_package"] = "gtest"
- self.cpp_info.components["libgtest"].names["cmake_find_package_multi"] = "gtest"
- self.cpp_info.components["libgtest"].names["pkg_config"] = "gtest"
+ self.cpp_info.set_property("cmake_file_name", "GTest")
+ self.cpp_info.set_property("cmake_target_name", "GTest")
+ self.cpp_info.components["libgtest"].set_property("cmake_target_name", "gtest")
+ self.cpp_info.components["libgtest"].set_property("pkg_config_name", "gtest")
self.cpp_info.components["libgtest"].libs = ["gtest{}".format(self._postfix)]
if self.settings.os == "Linux":
self.cpp_info.components["libgtest"].system_libs.append("pthread")
@@ -165,21 +164,18 @@
self.cpp_info.components["libgtest"].defines.append("GTEST_HAS_TR1_TUPLE=0")
if not self.options.no_main:
+ self.cpp_info.components["gtest_main"].set_property("cmake_target_name", "gtest_main")
+ self.cpp_info.components["gtest_main"].set_property("pkg_config_name", "gtest_main")
self.cpp_info.components["gtest_main"].libs = ["gtest_main{}".format(self._postfix)]
self.cpp_info.components["gtest_main"].requires = ["libgtest"]
- self.cpp_info.components["gtest_main"].names["cmake_find_package"] = "gtest_main"
- self.cpp_info.components["gtest_main"].names["cmake_find_package_multi"] = "gtest_main"
- self.cpp_info.components["gtest_main"].names["pkg_config"] = "gtest_main"
if self.options.build_gmock:
- self.cpp_info.components["gmock"].names["cmake_find_package"] = "gmock"
- self.cpp_info.components["gmock"].names["cmake_find_package_multi"] = "gmock"
- self.cpp_info.components["gmock"].names["pkg_config"] = "gmock"
+ self.cpp_info.components["gmock"].set_property("cmake_target_name", "gmock")
+ self.cpp_info.components["gmock"].set_property("pkg_config_name", "gmock")
self.cpp_info.components["gmock"].libs = ["gmock{}".format(self._postfix)]
self.cpp_info.components["gmock"].requires = ["libgtest"]
if not self.options.no_main:
- self.cpp_info.components["gmock_main"].names["cmake_find_package"] = "gmock_main"
- self.cpp_info.components["gmock_main"].names["cmake_find_package_multi"] = "gmock_main"
- self.cpp_info.components["gmock_main"].names["pkg_config"] = "gmock_main"
+ self.cpp_info.components["gmock_main"].set_property("cmake_target_name", "gmock_main")
+ self.cpp_info.components["gmock_main"].set_property("pkg_config_name", "gmock_main")
self.cpp_info.components["gmock_main"].libs = ["gmock_main{}".format(self._postfix)]
self.cpp_info.components["gmock_main"].requires = ["gmock"]
|
{"golden_diff": "diff --git a/recipes/gtest/all/conanfile.py b/recipes/gtest/all/conanfile.py\n--- a/recipes/gtest/all/conanfile.py\n+++ b/recipes/gtest/all/conanfile.py\n@@ -3,7 +3,7 @@\n import os\n import functools\n \n-required_conan_version = \">=1.33.0\"\n+required_conan_version = \">=1.36.0\"\n \n \n class GTestConan(ConanFile):\n@@ -143,11 +143,10 @@\n return self.options.debug_postfix if self.settings.build_type == \"Debug\" else \"\"\n \n def package_info(self):\n- self.cpp_info.names[\"cmake_find_package\"] = \"GTest\"\n- self.cpp_info.names[\"cmake_find_package_multi\"] = \"GTest\"\n- self.cpp_info.components[\"libgtest\"].names[\"cmake_find_package\"] = \"gtest\"\n- self.cpp_info.components[\"libgtest\"].names[\"cmake_find_package_multi\"] = \"gtest\"\n- self.cpp_info.components[\"libgtest\"].names[\"pkg_config\"] = \"gtest\"\n+ self.cpp_info.set_property(\"cmake_file_name\", \"GTest\")\n+ self.cpp_info.set_property(\"cmake_target_name\", \"GTest\")\n+ self.cpp_info.components[\"libgtest\"].set_property(\"cmake_target_name\", \"gtest\")\n+ self.cpp_info.components[\"libgtest\"].set_property(\"pkg_config_name\", \"gtest\")\n self.cpp_info.components[\"libgtest\"].libs = [\"gtest{}\".format(self._postfix)]\n if self.settings.os == \"Linux\":\n self.cpp_info.components[\"libgtest\"].system_libs.append(\"pthread\")\n@@ -165,21 +164,18 @@\n self.cpp_info.components[\"libgtest\"].defines.append(\"GTEST_HAS_TR1_TUPLE=0\")\n \n if not self.options.no_main:\n+ self.cpp_info.components[\"gtest_main\"].set_property(\"cmake_target_name\", \"gtest_main\")\n+ self.cpp_info.components[\"gtest_main\"].set_property(\"pkg_config_name\", \"gtest_main\")\n self.cpp_info.components[\"gtest_main\"].libs = [\"gtest_main{}\".format(self._postfix)]\n self.cpp_info.components[\"gtest_main\"].requires = [\"libgtest\"]\n- self.cpp_info.components[\"gtest_main\"].names[\"cmake_find_package\"] = \"gtest_main\"\n- self.cpp_info.components[\"gtest_main\"].names[\"cmake_find_package_multi\"] = \"gtest_main\"\n- self.cpp_info.components[\"gtest_main\"].names[\"pkg_config\"] = \"gtest_main\"\n \n if self.options.build_gmock:\n- self.cpp_info.components[\"gmock\"].names[\"cmake_find_package\"] = \"gmock\"\n- self.cpp_info.components[\"gmock\"].names[\"cmake_find_package_multi\"] = \"gmock\"\n- self.cpp_info.components[\"gmock\"].names[\"pkg_config\"] = \"gmock\"\n+ self.cpp_info.components[\"gmock\"].set_property(\"cmake_target_name\", \"gmock\")\n+ self.cpp_info.components[\"gmock\"].set_property(\"pkg_config_name\", \"gmock\")\n self.cpp_info.components[\"gmock\"].libs = [\"gmock{}\".format(self._postfix)]\n self.cpp_info.components[\"gmock\"].requires = [\"libgtest\"]\n if not self.options.no_main:\n- self.cpp_info.components[\"gmock_main\"].names[\"cmake_find_package\"] = \"gmock_main\"\n- self.cpp_info.components[\"gmock_main\"].names[\"cmake_find_package_multi\"] = \"gmock_main\"\n- self.cpp_info.components[\"gmock_main\"].names[\"pkg_config\"] = \"gmock_main\"\n+ self.cpp_info.components[\"gmock_main\"].set_property(\"cmake_target_name\", \"gmock_main\")\n+ self.cpp_info.components[\"gmock_main\"].set_property(\"pkg_config_name\", \"gmock_main\")\n self.cpp_info.components[\"gmock_main\"].libs = [\"gmock_main{}\".format(self._postfix)]\n self.cpp_info.components[\"gmock_main\"].requires = [\"gmock\"]\n", "issue": "[package] gtest/1.11.0: CMakeDeps + Conan 1.42 uses incorrect names for CMake config file, namespace, and gtest component\n### Package and Environment Details (include every applicable attribute)\r\n * Package Name/Version: **gtest/3.1.0**\r\n * Operating System+version: **Fedora Silverblue 35**\r\n * Compiler+version: **GCC 11**\r\n * Conan version: **conan 1.42.0**\r\n * Python version: **Python 3.10.0**\r\n\r\n\r\n### Conan profile (output of `conan profile show default` or `conan profile show <profile>` if custom profile is in use)\r\n```\r\n[settings]\r\nos=Linux\r\narch=x86_64\r\ncompiler=gcc\r\ncompiler.version=11\r\ncompiler.libcxx=libstdc++11\r\ncompiler.cppstd=17\r\nbuild_type=Debug\r\n[options]\r\n[conf]\r\n[build_requires]\r\n[env]\r\n```\r\n\r\n\r\n### Steps to reproduce (Include if Applicable)\r\n\r\nUse the `CMakeToolchain` / `CMakeDeps` generator for a project and add `ms-gsl` as a `requires`.\r\nIn your `CMakeLists.txt` use `find_package(GTest)` and it will not be found during CMake's configure stage.\r\nThis is because the package is now named `gtest` instead, which is unexpected.\r\nI don't think the component name for `libgtest` or the namespace for the CMake targets will be correct now either for the CMakeDeps generator.\r\n\r\n### Logs (Include/Attach if Applicable)\r\n<details><summary>Click to expand log</summary>\r\n\r\n```\r\nCMake Error at src/CMakeLists.txt:21 (add_executable):\r\n Target \"TestDriver\" links to target \"GTest::gtest_main\" but the target was\r\n not found. Perhaps a find_package() call is missing for an IMPORTED\r\n target, or an ALIAS target is missing?\r\nCMake Error at src/CMakeLists.txt:21 (add_executable):\r\n Target \"TestDriver\" links to target \"GTest::gtest_main\" but the target was\r\n not found. Perhaps a find_package() call is missing for an IMPORTED\r\n target, or an ALIAS target is missing?\r\n```\r\n\r\n</details>\r\n\n", "before_files": [{"content": "from conans import ConanFile, CMake, tools\nfrom conans.errors import ConanInvalidConfiguration\nimport os\nimport functools\n\nrequired_conan_version = \">=1.33.0\"\n\n\nclass GTestConan(ConanFile):\n name = \"gtest\"\n description = \"Google's C++ test framework\"\n url = \"https://github.com/conan-io/conan-center-index\"\n homepage = \"https://github.com/google/googletest\"\n license = \"BSD-3-Clause\"\n topics = (\"testing\", \"google-testing\", \"unit-test\")\n settings = \"os\", \"arch\", \"compiler\", \"build_type\"\n options = {\n \"shared\": [True, False],\n \"build_gmock\": [True, False],\n \"fPIC\": [True, False],\n \"no_main\": [True, False],\n \"debug_postfix\": \"ANY\",\n \"hide_symbols\": [True, False],\n }\n default_options = {\n \"shared\": False,\n \"build_gmock\": True,\n \"fPIC\": True,\n \"no_main\": False,\n \"debug_postfix\": \"d\",\n \"hide_symbols\": False,\n }\n\n exports_sources = \"CMakeLists.txt\", \"patches/*\"\n generators = \"cmake\"\n\n @property\n def _source_subfolder(self):\n return \"source_subfolder\"\n\n @property\n def _build_subfolder(self):\n return \"build_subfolder\"\n\n @property\n def _minimum_cpp_standard(self):\n if self.version == \"1.8.1\":\n return 98\n else:\n return 11\n\n @property\n def _minimum_compilers_version(self):\n if self.version == \"1.8.1\":\n return {\n \"Visual Studio\": \"14\"\n }\n elif self.version == \"1.10.0\":\n return {\n \"Visual Studio\": \"14\",\n \"gcc\": \"4.8.1\",\n \"clang\": \"3.3\",\n \"apple-clang\": \"5.0\"\n }\n else:\n return {\n \"Visual Studio\": \"14\",\n \"gcc\": \"5\",\n \"clang\": \"5\",\n \"apple-clang\": \"9.1\"\n }\n\n def config_options(self):\n if self.settings.os == \"Windows\":\n del self.options.fPIC\n if self.settings.build_type != \"Debug\":\n del self.options.debug_postfix\n\n def configure(self):\n if self.options.shared:\n del self.options.fPIC\n\n def validate(self):\n if self.settings.get_safe(\"compiler.cppstd\"):\n tools.check_min_cppstd(self, self._minimum_cpp_standard)\n min_version = self._minimum_compilers_version.get(\n str(self.settings.compiler))\n if self.settings.compiler == \"Visual Studio\":\n if self.options.shared and \"MT\" in self.settings.compiler.runtime:\n raise ConanInvalidConfiguration(\"gtest:shared=True with compiler=\\\"Visual Studio\\\" is not compatible with compiler.runtime=MT/MTd\")\n\n def lazy_lt_semver(v1, v2):\n lv1 = [int(v) for v in v1.split(\".\")]\n lv2 = [int(v) for v in v2.split(\".\")]\n min_length = min(len(lv1), len(lv2))\n return lv1[:min_length] < lv2[:min_length]\n\n if not min_version:\n self.output.warn(\"{} recipe lacks information about {} compiler support.\".format(\n self.name, self.settings.compiler))\n else:\n if lazy_lt_semver(str(self.settings.compiler.version), min_version):\n raise ConanInvalidConfiguration(\"{0} requires {1} {2}. The current compiler is {1} {3}.\".format(\n self.name, self.settings.compiler, min_version, self.settings.compiler.version))\n\n def package_id(self):\n del self.info.options.no_main\n\n def source(self):\n tools.get(**self.conan_data[\"sources\"][self.version],\n destination=self._source_subfolder, strip_root=True)\n\n @functools.lru_cache(1)\n def _configure_cmake(self):\n cmake = CMake(self)\n if self.settings.build_type == \"Debug\":\n cmake.definitions[\"CUSTOM_DEBUG_POSTFIX\"] = self.options.debug_postfix\n if self.settings.compiler == \"Visual Studio\":\n cmake.definitions[\"gtest_force_shared_crt\"] = \"MD\" in self.settings.compiler.runtime\n cmake.definitions[\"BUILD_GMOCK\"] = self.options.build_gmock\n if self.settings.os == \"Windows\" and self.settings.compiler == \"gcc\":\n cmake.definitions[\"gtest_disable_pthreads\"] = True\n cmake.definitions[\"gtest_hide_internal_symbols\"] = self.options.hide_symbols\n cmake.configure(build_folder=self._build_subfolder)\n return cmake\n\n def build(self):\n for patch in self.conan_data.get(\"patches\", {}).get(self.version, []):\n tools.patch(**patch)\n cmake = self._configure_cmake()\n cmake.build()\n\n def package(self):\n self.copy(\"LICENSE\", dst=\"licenses\", src=self._source_subfolder)\n cmake = self._configure_cmake()\n cmake.install()\n tools.rmdir(os.path.join(self.package_folder, \"lib\", \"pkgconfig\"))\n tools.rmdir(os.path.join(self.package_folder, \"lib\", \"cmake\"))\n tools.remove_files_by_mask(os.path.join(self.package_folder, \"lib\"), \"*.pdb\")\n\n @property\n def _postfix(self):\n return self.options.debug_postfix if self.settings.build_type == \"Debug\" else \"\"\n\n def package_info(self):\n self.cpp_info.names[\"cmake_find_package\"] = \"GTest\"\n self.cpp_info.names[\"cmake_find_package_multi\"] = \"GTest\"\n self.cpp_info.components[\"libgtest\"].names[\"cmake_find_package\"] = \"gtest\"\n self.cpp_info.components[\"libgtest\"].names[\"cmake_find_package_multi\"] = \"gtest\"\n self.cpp_info.components[\"libgtest\"].names[\"pkg_config\"] = \"gtest\"\n self.cpp_info.components[\"libgtest\"].libs = [\"gtest{}\".format(self._postfix)]\n if self.settings.os == \"Linux\":\n self.cpp_info.components[\"libgtest\"].system_libs.append(\"pthread\")\n\n if self.settings.os == \"Neutrino\" and self.settings.os.version == \"7.1\":\n self.cpp_info.components[\"libgtest\"].system_libs.append(\"regex\")\n\n if self.options.shared:\n self.cpp_info.components[\"libgtest\"].defines.append(\"GTEST_LINKED_AS_SHARED_LIBRARY=1\")\n\n if self.version == \"1.8.1\":\n if self.settings.compiler == \"Visual Studio\":\n if tools.Version(self.settings.compiler.version) >= \"15\":\n self.cpp_info.components[\"libgtest\"].defines.append(\"GTEST_LANG_CXX11=1\")\n self.cpp_info.components[\"libgtest\"].defines.append(\"GTEST_HAS_TR1_TUPLE=0\")\n\n if not self.options.no_main:\n self.cpp_info.components[\"gtest_main\"].libs = [\"gtest_main{}\".format(self._postfix)]\n self.cpp_info.components[\"gtest_main\"].requires = [\"libgtest\"]\n self.cpp_info.components[\"gtest_main\"].names[\"cmake_find_package\"] = \"gtest_main\"\n self.cpp_info.components[\"gtest_main\"].names[\"cmake_find_package_multi\"] = \"gtest_main\"\n self.cpp_info.components[\"gtest_main\"].names[\"pkg_config\"] = \"gtest_main\"\n\n if self.options.build_gmock:\n self.cpp_info.components[\"gmock\"].names[\"cmake_find_package\"] = \"gmock\"\n self.cpp_info.components[\"gmock\"].names[\"cmake_find_package_multi\"] = \"gmock\"\n self.cpp_info.components[\"gmock\"].names[\"pkg_config\"] = \"gmock\"\n self.cpp_info.components[\"gmock\"].libs = [\"gmock{}\".format(self._postfix)]\n self.cpp_info.components[\"gmock\"].requires = [\"libgtest\"]\n if not self.options.no_main:\n self.cpp_info.components[\"gmock_main\"].names[\"cmake_find_package\"] = \"gmock_main\"\n self.cpp_info.components[\"gmock_main\"].names[\"cmake_find_package_multi\"] = \"gmock_main\"\n self.cpp_info.components[\"gmock_main\"].names[\"pkg_config\"] = \"gmock_main\"\n self.cpp_info.components[\"gmock_main\"].libs = [\"gmock_main{}\".format(self._postfix)]\n self.cpp_info.components[\"gmock_main\"].requires = [\"gmock\"]\n", "path": "recipes/gtest/all/conanfile.py"}], "after_files": [{"content": "from conans import ConanFile, CMake, tools\nfrom conans.errors import ConanInvalidConfiguration\nimport os\nimport functools\n\nrequired_conan_version = \">=1.36.0\"\n\n\nclass GTestConan(ConanFile):\n name = \"gtest\"\n description = \"Google's C++ test framework\"\n url = \"https://github.com/conan-io/conan-center-index\"\n homepage = \"https://github.com/google/googletest\"\n license = \"BSD-3-Clause\"\n topics = (\"testing\", \"google-testing\", \"unit-test\")\n settings = \"os\", \"arch\", \"compiler\", \"build_type\"\n options = {\n \"shared\": [True, False],\n \"build_gmock\": [True, False],\n \"fPIC\": [True, False],\n \"no_main\": [True, False],\n \"debug_postfix\": \"ANY\",\n \"hide_symbols\": [True, False],\n }\n default_options = {\n \"shared\": False,\n \"build_gmock\": True,\n \"fPIC\": True,\n \"no_main\": False,\n \"debug_postfix\": \"d\",\n \"hide_symbols\": False,\n }\n\n exports_sources = \"CMakeLists.txt\", \"patches/*\"\n generators = \"cmake\"\n\n @property\n def _source_subfolder(self):\n return \"source_subfolder\"\n\n @property\n def _build_subfolder(self):\n return \"build_subfolder\"\n\n @property\n def _minimum_cpp_standard(self):\n if self.version == \"1.8.1\":\n return 98\n else:\n return 11\n\n @property\n def _minimum_compilers_version(self):\n if self.version == \"1.8.1\":\n return {\n \"Visual Studio\": \"14\"\n }\n elif self.version == \"1.10.0\":\n return {\n \"Visual Studio\": \"14\",\n \"gcc\": \"4.8.1\",\n \"clang\": \"3.3\",\n \"apple-clang\": \"5.0\"\n }\n else:\n return {\n \"Visual Studio\": \"14\",\n \"gcc\": \"5\",\n \"clang\": \"5\",\n \"apple-clang\": \"9.1\"\n }\n\n def config_options(self):\n if self.settings.os == \"Windows\":\n del self.options.fPIC\n if self.settings.build_type != \"Debug\":\n del self.options.debug_postfix\n\n def configure(self):\n if self.options.shared:\n del self.options.fPIC\n\n def validate(self):\n if self.settings.get_safe(\"compiler.cppstd\"):\n tools.check_min_cppstd(self, self._minimum_cpp_standard)\n min_version = self._minimum_compilers_version.get(\n str(self.settings.compiler))\n if self.settings.compiler == \"Visual Studio\":\n if self.options.shared and \"MT\" in self.settings.compiler.runtime:\n raise ConanInvalidConfiguration(\"gtest:shared=True with compiler=\\\"Visual Studio\\\" is not compatible with compiler.runtime=MT/MTd\")\n\n def lazy_lt_semver(v1, v2):\n lv1 = [int(v) for v in v1.split(\".\")]\n lv2 = [int(v) for v in v2.split(\".\")]\n min_length = min(len(lv1), len(lv2))\n return lv1[:min_length] < lv2[:min_length]\n\n if not min_version:\n self.output.warn(\"{} recipe lacks information about {} compiler support.\".format(\n self.name, self.settings.compiler))\n else:\n if lazy_lt_semver(str(self.settings.compiler.version), min_version):\n raise ConanInvalidConfiguration(\"{0} requires {1} {2}. The current compiler is {1} {3}.\".format(\n self.name, self.settings.compiler, min_version, self.settings.compiler.version))\n\n def package_id(self):\n del self.info.options.no_main\n\n def source(self):\n tools.get(**self.conan_data[\"sources\"][self.version],\n destination=self._source_subfolder, strip_root=True)\n\n @functools.lru_cache(1)\n def _configure_cmake(self):\n cmake = CMake(self)\n if self.settings.build_type == \"Debug\":\n cmake.definitions[\"CUSTOM_DEBUG_POSTFIX\"] = self.options.debug_postfix\n if self.settings.compiler == \"Visual Studio\":\n cmake.definitions[\"gtest_force_shared_crt\"] = \"MD\" in self.settings.compiler.runtime\n cmake.definitions[\"BUILD_GMOCK\"] = self.options.build_gmock\n if self.settings.os == \"Windows\" and self.settings.compiler == \"gcc\":\n cmake.definitions[\"gtest_disable_pthreads\"] = True\n cmake.definitions[\"gtest_hide_internal_symbols\"] = self.options.hide_symbols\n cmake.configure(build_folder=self._build_subfolder)\n return cmake\n\n def build(self):\n for patch in self.conan_data.get(\"patches\", {}).get(self.version, []):\n tools.patch(**patch)\n cmake = self._configure_cmake()\n cmake.build()\n\n def package(self):\n self.copy(\"LICENSE\", dst=\"licenses\", src=self._source_subfolder)\n cmake = self._configure_cmake()\n cmake.install()\n tools.rmdir(os.path.join(self.package_folder, \"lib\", \"pkgconfig\"))\n tools.rmdir(os.path.join(self.package_folder, \"lib\", \"cmake\"))\n tools.remove_files_by_mask(os.path.join(self.package_folder, \"lib\"), \"*.pdb\")\n\n @property\n def _postfix(self):\n return self.options.debug_postfix if self.settings.build_type == \"Debug\" else \"\"\n\n def package_info(self):\n self.cpp_info.set_property(\"cmake_file_name\", \"GTest\")\n self.cpp_info.set_property(\"cmake_target_name\", \"GTest\")\n self.cpp_info.components[\"libgtest\"].set_property(\"cmake_target_name\", \"gtest\")\n self.cpp_info.components[\"libgtest\"].set_property(\"pkg_config_name\", \"gtest\")\n self.cpp_info.components[\"libgtest\"].libs = [\"gtest{}\".format(self._postfix)]\n if self.settings.os == \"Linux\":\n self.cpp_info.components[\"libgtest\"].system_libs.append(\"pthread\")\n\n if self.settings.os == \"Neutrino\" and self.settings.os.version == \"7.1\":\n self.cpp_info.components[\"libgtest\"].system_libs.append(\"regex\")\n\n if self.options.shared:\n self.cpp_info.components[\"libgtest\"].defines.append(\"GTEST_LINKED_AS_SHARED_LIBRARY=1\")\n\n if self.version == \"1.8.1\":\n if self.settings.compiler == \"Visual Studio\":\n if tools.Version(self.settings.compiler.version) >= \"15\":\n self.cpp_info.components[\"libgtest\"].defines.append(\"GTEST_LANG_CXX11=1\")\n self.cpp_info.components[\"libgtest\"].defines.append(\"GTEST_HAS_TR1_TUPLE=0\")\n\n if not self.options.no_main:\n self.cpp_info.components[\"gtest_main\"].set_property(\"cmake_target_name\", \"gtest_main\")\n self.cpp_info.components[\"gtest_main\"].set_property(\"pkg_config_name\", \"gtest_main\")\n self.cpp_info.components[\"gtest_main\"].libs = [\"gtest_main{}\".format(self._postfix)]\n self.cpp_info.components[\"gtest_main\"].requires = [\"libgtest\"]\n\n if self.options.build_gmock:\n self.cpp_info.components[\"gmock\"].set_property(\"cmake_target_name\", \"gmock\")\n self.cpp_info.components[\"gmock\"].set_property(\"pkg_config_name\", \"gmock\")\n self.cpp_info.components[\"gmock\"].libs = [\"gmock{}\".format(self._postfix)]\n self.cpp_info.components[\"gmock\"].requires = [\"libgtest\"]\n if not self.options.no_main:\n self.cpp_info.components[\"gmock_main\"].set_property(\"cmake_target_name\", \"gmock_main\")\n self.cpp_info.components[\"gmock_main\"].set_property(\"pkg_config_name\", \"gmock_main\")\n self.cpp_info.components[\"gmock_main\"].libs = [\"gmock_main{}\".format(self._postfix)]\n self.cpp_info.components[\"gmock_main\"].requires = [\"gmock\"]\n", "path": "recipes/gtest/all/conanfile.py"}]}
| 3,041 | 867 |
gh_patches_debug_64425
|
rasdani/github-patches
|
git_diff
|
pwndbg__pwndbg-1908
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
crash in command start after running sstart
### Description
crash when running start after sstart
### Steps to reproduce
Gdb session history:
```
sstart
start
set exception-verbose on
start
bugreport --run-broweser
```
### My setup
```
Platform: Linux-6.2.0-26-generic-x86_64-with-glibc2.35
OS: Ubuntu 22.04.3 LTS
OS ABI: #26~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Thu Jul 13 16:27:29 UTC 2
Architecture: x86_64
Endian: little
Charset: utf-8
Width: 156
Height: 78
Gdb: 12.1
Python: 3.10.12 (main, Jun 11 2023, 05:26:28) [GCC 11.4.0]
Pwndbg: 2023.07.17 build: e959a47
Capstone: 5.0.1280
Unicorn: 2.0.1
This GDB was configured as follows:
configure --host=x86_64-linux-gnu --target=x86_64-linux-gnu
--with-auto-load-dir=$debugdir:$datadir/auto-load
--with-auto-load-safe-path=$debugdir:$datadir/auto-load
--with-expat
--with-gdb-datadir=/usr/share/gdb (relocatable)
--with-jit-reader-dir=/usr/lib/gdb (relocatable)
--without-libunwind-ia64
--with-lzma
--with-babeltrace
--with-intel-pt
--with-mpfr
--with-xxhash
--with-python=/usr (relocatable)
--with-python-libdir=/usr/lib (relocatable)
--with-debuginfod
--without-guile
--enable-source-highlight
--with-separate-debug-dir=/usr/lib/debug (relocatable)
--with-system-gdbinit=/etc/gdb/gdbinit
--with-system-gdbinit-dir=/etc/gdb/gdbinit.d
("Relocatable" means the directory can be moved with the GDB installation
tree, and GDB will still find it.)
```
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `pwndbg/gdblib/symbol.py`
Content:
```
1 """
2 Looking up addresses for function names / symbols, and
3 vice-versa.
4
5 Uses IDA when available if there isn't sufficient symbol
6 information available.
7 """
8 from __future__ import annotations
9
10 import re
11
12 import gdb
13
14 import pwndbg.gdblib.android
15 import pwndbg.gdblib.arch
16 import pwndbg.gdblib.elf
17 import pwndbg.gdblib.events
18 import pwndbg.gdblib.file
19 import pwndbg.gdblib.memory
20 import pwndbg.gdblib.qemu
21 import pwndbg.gdblib.remote
22 import pwndbg.gdblib.stack
23 import pwndbg.gdblib.vmmap
24 import pwndbg.ida
25 import pwndbg.lib.cache
26
27
28 def _get_debug_file_directory():
29 """
30 Retrieve the debug file directory path.
31
32 The debug file directory path ('show debug-file-directory') is a comma-
33 separated list of directories which GDB will look in to find the binaries
34 currently loaded.
35 """
36 result = gdb.execute("show debug-file-directory", to_string=True, from_tty=False)
37 expr = r'The directory where separate debug symbols are searched for is "(.*)".\n'
38
39 match = re.search(expr, result)
40
41 if match:
42 return match.group(1)
43 return ""
44
45
46 def _set_debug_file_directory(d) -> None:
47 gdb.execute(f"set debug-file-directory {d}", to_string=True, from_tty=False)
48
49
50 def _add_debug_file_directory(d) -> None:
51 current = _get_debug_file_directory()
52 if current:
53 _set_debug_file_directory(f"{current}:{d}")
54 else:
55 _set_debug_file_directory(d)
56
57
58 if "/usr/lib/debug" not in _get_debug_file_directory():
59 _add_debug_file_directory("/usr/lib/debug")
60
61
62 @pwndbg.lib.cache.cache_until("objfile")
63 def get(address: int, gdb_only=False) -> str:
64 """
65 Retrieve the name for the symbol located at `address` - either from GDB or from IDA sync
66 Passing `gdb_only=True`
67 """
68 # Note: we do not return "" on `address < pwndbg.gdblib.memory.MMAP_MIN_ADDR`
69 # because this may be used to find out the symbol name on PIE binaries that weren't started yet
70 # and then their symbol addresses can be found by GDB on their (non-rebased) offsets
71
72 # Fast path: GDB's `info symbol` returns 'Numeric constant too large' here
73 if address >= ((1 << 64) - 1):
74 return ""
75
76 # This sucks, but there's not a GDB API for this.
77 result = gdb.execute("info symbol %#x" % int(address), to_string=True, from_tty=False)
78
79 if not gdb_only and result.startswith("No symbol"):
80 address = int(address)
81 exe = pwndbg.gdblib.elf.exe()
82 if exe:
83 exe_map = pwndbg.gdblib.vmmap.find(exe.address)
84 if exe_map and address in exe_map:
85 res = pwndbg.ida.Name(address) or pwndbg.ida.GetFuncOffset(address)
86 return res or ""
87
88 # If there are newlines, which means that there are multiple symbols for the address
89 # then use the first one (see also #1610)
90 result = result[: result.index("\n")]
91
92 # See https://github.com/bminor/binutils-gdb/blob/d1702fea87aa62dff7de465464097dba63cc8c0f/gdb/printcmd.c#L1594-L1624
93 # The most often encountered formats looks like this:
94 # "main in section .text of /bin/bash"
95 # "main + 3 in section .text of /bin/bash"
96 # "system + 1 in section .text of /lib/x86_64-linux-gnu/libc.so.6"
97 # "No symbol matches system-1"
98 # But there are some others that we have to account for as well
99 if " in section " in result:
100 loc_string, _ = result.split(" in section ")
101 elif " in load address range of " in result:
102 loc_string, _ = result.split(" in load address range of ")
103 elif " overlay section " in result:
104 result, _ = result.split(" overlay section ")
105 loc_string, _ = result.split(" in ")
106 else:
107 loc_string = ""
108
109 # If there is 'main + 87' we want to replace it with 'main+87' etc.
110 return loc_string.replace(" + ", "+")
111
112
113 @pwndbg.lib.cache.cache_until("objfile")
114 def address(symbol: str) -> int:
115 """
116 Get the address for `symbol`
117 """
118 try:
119 symbol_obj = gdb.lookup_symbol(symbol)[0]
120 if symbol_obj:
121 return int(symbol_obj.value().address)
122 except gdb.error as e:
123 # Symbol lookup only throws exceptions on errors, not if it failed to
124 # lookup a symbol. We want to raise these errors so we can handle them
125 # properly, but there are some we haven't figured out how to fix yet, so
126 # we ignore those here
127 skipped_exceptions = []
128
129 # This is exception is being thrown by the Go typeinfo tests, we should
130 # investigate why this is happening and see if we can explicitly check
131 # for it with `gdb.selected_frame()`
132 skipped_exceptions.append("No frame selected")
133
134 # If we try to look up a TLS variable when there is no TLS, this
135 # exception occurs. Ideally we should come up with a way to check for
136 # this case before calling `gdb.lookup_symbol`
137 skipped_exceptions.append("Cannot find thread-local")
138
139 if all(x not in str(e) for x in skipped_exceptions):
140 raise e
141
142 try:
143 # Unfortunately, `gdb.lookup_symbol` does not seem to handle all
144 # symbols, so we need to fallback to using `gdb.parse_and_eval`. See
145 # https://sourceware.org/pipermail/gdb/2022-October/050362.html
146 # (We tried parsing the output of the `info address` before, but there were some issues. See #1628 and #1666)
147 if "\\" in symbol:
148 # Is it possible that happens? Probably not, but just in case
149 raise ValueError(f"Symbol {symbol!r} contains a backslash")
150 sanitized_symbol_name = symbol.replace("'", "\\'")
151 return int(gdb.parse_and_eval(f"&'{sanitized_symbol_name}'"))
152
153 except gdb.error:
154 return None
155
156
157 @pwndbg.lib.cache.cache_until("objfile", "thread")
158 def static_linkage_symbol_address(symbol: str) -> int:
159 """
160 Get the address for static linkage `symbol`
161 """
162
163 try:
164 symbol_obj = gdb.lookup_static_symbol(symbol)
165 return int(symbol_obj.value().address) if symbol_obj else None
166 except gdb.error:
167 return None
168
169
170 @pwndbg.lib.cache.cache_until("stop", "start")
171 def selected_frame_source_absolute_filename():
172 """
173 Retrieve the symbol table’s source absolute file name from the selected frame.
174
175 In case of missing symbol table or frame information, None is returned.
176 """
177 try:
178 frame = gdb.selected_frame()
179 except gdb.error:
180 return None
181
182 if not frame:
183 return None
184
185 sal = frame.find_sal()
186 if not sal:
187 return None
188
189 symtab = sal.symtab
190 if not symtab:
191 return None
192
193 return symtab.fullname()
194
195
196 def parse_and_eval(expression: str) -> gdb.Value | None:
197 """Error handling wrapper for GDBs parse_and_eval function"""
198 try:
199 return gdb.parse_and_eval(expression)
200 except gdb.error:
201 return None
202
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/pwndbg/gdblib/symbol.py b/pwndbg/gdblib/symbol.py
--- a/pwndbg/gdblib/symbol.py
+++ b/pwndbg/gdblib/symbol.py
@@ -136,6 +136,9 @@
# this case before calling `gdb.lookup_symbol`
skipped_exceptions.append("Cannot find thread-local")
+ # This reproduced on GDB 12.1 and caused #1878
+ skipped_exceptions.append("symbol requires a frame to compute its value")
+
if all(x not in str(e) for x in skipped_exceptions):
raise e
|
{"golden_diff": "diff --git a/pwndbg/gdblib/symbol.py b/pwndbg/gdblib/symbol.py\n--- a/pwndbg/gdblib/symbol.py\n+++ b/pwndbg/gdblib/symbol.py\n@@ -136,6 +136,9 @@\n # this case before calling `gdb.lookup_symbol`\n skipped_exceptions.append(\"Cannot find thread-local\")\n \n+ # This reproduced on GDB 12.1 and caused #1878\n+ skipped_exceptions.append(\"symbol requires a frame to compute its value\")\n+\n if all(x not in str(e) for x in skipped_exceptions):\n raise e\n", "issue": "crash in command start after running sstart\n### Description\r\n\r\ncrash when running start after sstart\r\n\r\n### Steps to reproduce\r\n\r\nGdb session history:\r\n```\r\nsstart\r\nstart\r\nset exception-verbose on\r\nstart\r\nbugreport --run-broweser\r\n```\r\n\r\n### My setup\r\n\r\n```\r\nPlatform: Linux-6.2.0-26-generic-x86_64-with-glibc2.35\r\nOS: Ubuntu 22.04.3 LTS\r\nOS ABI: #26~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Thu Jul 13 16:27:29 UTC 2\r\nArchitecture: x86_64\r\nEndian: little\r\nCharset: utf-8\r\nWidth: 156\r\nHeight: 78\r\nGdb: 12.1\r\nPython: 3.10.12 (main, Jun 11 2023, 05:26:28) [GCC 11.4.0]\r\nPwndbg: 2023.07.17 build: e959a47\r\nCapstone: 5.0.1280\r\nUnicorn: 2.0.1\r\nThis GDB was configured as follows:\r\n configure --host=x86_64-linux-gnu --target=x86_64-linux-gnu\r\n\t --with-auto-load-dir=$debugdir:$datadir/auto-load\r\n\t --with-auto-load-safe-path=$debugdir:$datadir/auto-load\r\n\t --with-expat\r\n\t --with-gdb-datadir=/usr/share/gdb (relocatable)\r\n\t --with-jit-reader-dir=/usr/lib/gdb (relocatable)\r\n\t --without-libunwind-ia64\r\n\t --with-lzma\r\n\t --with-babeltrace\r\n\t --with-intel-pt\r\n\t --with-mpfr\r\n\t --with-xxhash\r\n\t --with-python=/usr (relocatable)\r\n\t --with-python-libdir=/usr/lib (relocatable)\r\n\t --with-debuginfod\r\n\t --without-guile\r\n\t --enable-source-highlight\r\n\t --with-separate-debug-dir=/usr/lib/debug (relocatable)\r\n\t --with-system-gdbinit=/etc/gdb/gdbinit\r\n\t --with-system-gdbinit-dir=/etc/gdb/gdbinit.d\r\n\r\n(\"Relocatable\" means the directory can be moved with the GDB installation\r\ntree, and GDB will still find it.)\r\n\r\n```\r\n\r\n\r\n\n", "before_files": [{"content": "\"\"\"\nLooking up addresses for function names / symbols, and\nvice-versa.\n\nUses IDA when available if there isn't sufficient symbol\ninformation available.\n\"\"\"\nfrom __future__ import annotations\n\nimport re\n\nimport gdb\n\nimport pwndbg.gdblib.android\nimport pwndbg.gdblib.arch\nimport pwndbg.gdblib.elf\nimport pwndbg.gdblib.events\nimport pwndbg.gdblib.file\nimport pwndbg.gdblib.memory\nimport pwndbg.gdblib.qemu\nimport pwndbg.gdblib.remote\nimport pwndbg.gdblib.stack\nimport pwndbg.gdblib.vmmap\nimport pwndbg.ida\nimport pwndbg.lib.cache\n\n\ndef _get_debug_file_directory():\n \"\"\"\n Retrieve the debug file directory path.\n\n The debug file directory path ('show debug-file-directory') is a comma-\n separated list of directories which GDB will look in to find the binaries\n currently loaded.\n \"\"\"\n result = gdb.execute(\"show debug-file-directory\", to_string=True, from_tty=False)\n expr = r'The directory where separate debug symbols are searched for is \"(.*)\".\\n'\n\n match = re.search(expr, result)\n\n if match:\n return match.group(1)\n return \"\"\n\n\ndef _set_debug_file_directory(d) -> None:\n gdb.execute(f\"set debug-file-directory {d}\", to_string=True, from_tty=False)\n\n\ndef _add_debug_file_directory(d) -> None:\n current = _get_debug_file_directory()\n if current:\n _set_debug_file_directory(f\"{current}:{d}\")\n else:\n _set_debug_file_directory(d)\n\n\nif \"/usr/lib/debug\" not in _get_debug_file_directory():\n _add_debug_file_directory(\"/usr/lib/debug\")\n\n\[email protected]_until(\"objfile\")\ndef get(address: int, gdb_only=False) -> str:\n \"\"\"\n Retrieve the name for the symbol located at `address` - either from GDB or from IDA sync\n Passing `gdb_only=True`\n \"\"\"\n # Note: we do not return \"\" on `address < pwndbg.gdblib.memory.MMAP_MIN_ADDR`\n # because this may be used to find out the symbol name on PIE binaries that weren't started yet\n # and then their symbol addresses can be found by GDB on their (non-rebased) offsets\n\n # Fast path: GDB's `info symbol` returns 'Numeric constant too large' here\n if address >= ((1 << 64) - 1):\n return \"\"\n\n # This sucks, but there's not a GDB API for this.\n result = gdb.execute(\"info symbol %#x\" % int(address), to_string=True, from_tty=False)\n\n if not gdb_only and result.startswith(\"No symbol\"):\n address = int(address)\n exe = pwndbg.gdblib.elf.exe()\n if exe:\n exe_map = pwndbg.gdblib.vmmap.find(exe.address)\n if exe_map and address in exe_map:\n res = pwndbg.ida.Name(address) or pwndbg.ida.GetFuncOffset(address)\n return res or \"\"\n\n # If there are newlines, which means that there are multiple symbols for the address\n # then use the first one (see also #1610)\n result = result[: result.index(\"\\n\")]\n\n # See https://github.com/bminor/binutils-gdb/blob/d1702fea87aa62dff7de465464097dba63cc8c0f/gdb/printcmd.c#L1594-L1624\n # The most often encountered formats looks like this:\n # \"main in section .text of /bin/bash\"\n # \"main + 3 in section .text of /bin/bash\"\n # \"system + 1 in section .text of /lib/x86_64-linux-gnu/libc.so.6\"\n # \"No symbol matches system-1\"\n # But there are some others that we have to account for as well\n if \" in section \" in result:\n loc_string, _ = result.split(\" in section \")\n elif \" in load address range of \" in result:\n loc_string, _ = result.split(\" in load address range of \")\n elif \" overlay section \" in result:\n result, _ = result.split(\" overlay section \")\n loc_string, _ = result.split(\" in \")\n else:\n loc_string = \"\"\n\n # If there is 'main + 87' we want to replace it with 'main+87' etc.\n return loc_string.replace(\" + \", \"+\")\n\n\[email protected]_until(\"objfile\")\ndef address(symbol: str) -> int:\n \"\"\"\n Get the address for `symbol`\n \"\"\"\n try:\n symbol_obj = gdb.lookup_symbol(symbol)[0]\n if symbol_obj:\n return int(symbol_obj.value().address)\n except gdb.error as e:\n # Symbol lookup only throws exceptions on errors, not if it failed to\n # lookup a symbol. We want to raise these errors so we can handle them\n # properly, but there are some we haven't figured out how to fix yet, so\n # we ignore those here\n skipped_exceptions = []\n\n # This is exception is being thrown by the Go typeinfo tests, we should\n # investigate why this is happening and see if we can explicitly check\n # for it with `gdb.selected_frame()`\n skipped_exceptions.append(\"No frame selected\")\n\n # If we try to look up a TLS variable when there is no TLS, this\n # exception occurs. Ideally we should come up with a way to check for\n # this case before calling `gdb.lookup_symbol`\n skipped_exceptions.append(\"Cannot find thread-local\")\n\n if all(x not in str(e) for x in skipped_exceptions):\n raise e\n\n try:\n # Unfortunately, `gdb.lookup_symbol` does not seem to handle all\n # symbols, so we need to fallback to using `gdb.parse_and_eval`. See\n # https://sourceware.org/pipermail/gdb/2022-October/050362.html\n # (We tried parsing the output of the `info address` before, but there were some issues. See #1628 and #1666)\n if \"\\\\\" in symbol:\n # Is it possible that happens? Probably not, but just in case\n raise ValueError(f\"Symbol {symbol!r} contains a backslash\")\n sanitized_symbol_name = symbol.replace(\"'\", \"\\\\'\")\n return int(gdb.parse_and_eval(f\"&'{sanitized_symbol_name}'\"))\n\n except gdb.error:\n return None\n\n\[email protected]_until(\"objfile\", \"thread\")\ndef static_linkage_symbol_address(symbol: str) -> int:\n \"\"\"\n Get the address for static linkage `symbol`\n \"\"\"\n\n try:\n symbol_obj = gdb.lookup_static_symbol(symbol)\n return int(symbol_obj.value().address) if symbol_obj else None\n except gdb.error:\n return None\n\n\[email protected]_until(\"stop\", \"start\")\ndef selected_frame_source_absolute_filename():\n \"\"\"\n Retrieve the symbol table\u2019s source absolute file name from the selected frame.\n\n In case of missing symbol table or frame information, None is returned.\n \"\"\"\n try:\n frame = gdb.selected_frame()\n except gdb.error:\n return None\n\n if not frame:\n return None\n\n sal = frame.find_sal()\n if not sal:\n return None\n\n symtab = sal.symtab\n if not symtab:\n return None\n\n return symtab.fullname()\n\n\ndef parse_and_eval(expression: str) -> gdb.Value | None:\n \"\"\"Error handling wrapper for GDBs parse_and_eval function\"\"\"\n try:\n return gdb.parse_and_eval(expression)\n except gdb.error:\n return None\n", "path": "pwndbg/gdblib/symbol.py"}], "after_files": [{"content": "\"\"\"\nLooking up addresses for function names / symbols, and\nvice-versa.\n\nUses IDA when available if there isn't sufficient symbol\ninformation available.\n\"\"\"\nfrom __future__ import annotations\n\nimport re\n\nimport gdb\n\nimport pwndbg.gdblib.android\nimport pwndbg.gdblib.arch\nimport pwndbg.gdblib.elf\nimport pwndbg.gdblib.events\nimport pwndbg.gdblib.file\nimport pwndbg.gdblib.memory\nimport pwndbg.gdblib.qemu\nimport pwndbg.gdblib.remote\nimport pwndbg.gdblib.stack\nimport pwndbg.gdblib.vmmap\nimport pwndbg.ida\nimport pwndbg.lib.cache\n\n\ndef _get_debug_file_directory():\n \"\"\"\n Retrieve the debug file directory path.\n\n The debug file directory path ('show debug-file-directory') is a comma-\n separated list of directories which GDB will look in to find the binaries\n currently loaded.\n \"\"\"\n result = gdb.execute(\"show debug-file-directory\", to_string=True, from_tty=False)\n expr = r'The directory where separate debug symbols are searched for is \"(.*)\".\\n'\n\n match = re.search(expr, result)\n\n if match:\n return match.group(1)\n return \"\"\n\n\ndef _set_debug_file_directory(d) -> None:\n gdb.execute(f\"set debug-file-directory {d}\", to_string=True, from_tty=False)\n\n\ndef _add_debug_file_directory(d) -> None:\n current = _get_debug_file_directory()\n if current:\n _set_debug_file_directory(f\"{current}:{d}\")\n else:\n _set_debug_file_directory(d)\n\n\nif \"/usr/lib/debug\" not in _get_debug_file_directory():\n _add_debug_file_directory(\"/usr/lib/debug\")\n\n\[email protected]_until(\"objfile\")\ndef get(address: int, gdb_only=False) -> str:\n \"\"\"\n Retrieve the name for the symbol located at `address` - either from GDB or from IDA sync\n Passing `gdb_only=True`\n \"\"\"\n # Note: we do not return \"\" on `address < pwndbg.gdblib.memory.MMAP_MIN_ADDR`\n # because this may be used to find out the symbol name on PIE binaries that weren't started yet\n # and then their symbol addresses can be found by GDB on their (non-rebased) offsets\n\n # Fast path: GDB's `info symbol` returns 'Numeric constant too large' here\n if address >= ((1 << 64) - 1):\n return \"\"\n\n # This sucks, but there's not a GDB API for this.\n result = gdb.execute(\"info symbol %#x\" % int(address), to_string=True, from_tty=False)\n\n if not gdb_only and result.startswith(\"No symbol\"):\n address = int(address)\n exe = pwndbg.gdblib.elf.exe()\n if exe:\n exe_map = pwndbg.gdblib.vmmap.find(exe.address)\n if exe_map and address in exe_map:\n res = pwndbg.ida.Name(address) or pwndbg.ida.GetFuncOffset(address)\n return res or \"\"\n\n # If there are newlines, which means that there are multiple symbols for the address\n # then use the first one (see also #1610)\n result = result[: result.index(\"\\n\")]\n\n # See https://github.com/bminor/binutils-gdb/blob/d1702fea87aa62dff7de465464097dba63cc8c0f/gdb/printcmd.c#L1594-L1624\n # The most often encountered formats looks like this:\n # \"main in section .text of /bin/bash\"\n # \"main + 3 in section .text of /bin/bash\"\n # \"system + 1 in section .text of /lib/x86_64-linux-gnu/libc.so.6\"\n # \"No symbol matches system-1\"\n # But there are some others that we have to account for as well\n if \" in section \" in result:\n loc_string, _ = result.split(\" in section \")\n elif \" in load address range of \" in result:\n loc_string, _ = result.split(\" in load address range of \")\n elif \" overlay section \" in result:\n result, _ = result.split(\" overlay section \")\n loc_string, _ = result.split(\" in \")\n else:\n loc_string = \"\"\n\n # If there is 'main + 87' we want to replace it with 'main+87' etc.\n return loc_string.replace(\" + \", \"+\")\n\n\[email protected]_until(\"objfile\")\ndef address(symbol: str) -> int:\n \"\"\"\n Get the address for `symbol`\n \"\"\"\n try:\n symbol_obj = gdb.lookup_symbol(symbol)[0]\n if symbol_obj:\n return int(symbol_obj.value().address)\n except gdb.error as e:\n # Symbol lookup only throws exceptions on errors, not if it failed to\n # lookup a symbol. We want to raise these errors so we can handle them\n # properly, but there are some we haven't figured out how to fix yet, so\n # we ignore those here\n skipped_exceptions = []\n\n # This is exception is being thrown by the Go typeinfo tests, we should\n # investigate why this is happening and see if we can explicitly check\n # for it with `gdb.selected_frame()`\n skipped_exceptions.append(\"No frame selected\")\n\n # If we try to look up a TLS variable when there is no TLS, this\n # exception occurs. Ideally we should come up with a way to check for\n # this case before calling `gdb.lookup_symbol`\n skipped_exceptions.append(\"Cannot find thread-local\")\n\n # This reproduced on GDB 12.1 and caused #1878\n skipped_exceptions.append(\"symbol requires a frame to compute its value\")\n\n if all(x not in str(e) for x in skipped_exceptions):\n raise e\n\n try:\n # Unfortunately, `gdb.lookup_symbol` does not seem to handle all\n # symbols, so we need to fallback to using `gdb.parse_and_eval`. See\n # https://sourceware.org/pipermail/gdb/2022-October/050362.html\n # (We tried parsing the output of the `info address` before, but there were some issues. See #1628 and #1666)\n if \"\\\\\" in symbol:\n # Is it possible that happens? Probably not, but just in case\n raise ValueError(f\"Symbol {symbol!r} contains a backslash\")\n sanitized_symbol_name = symbol.replace(\"'\", \"\\\\'\")\n return int(gdb.parse_and_eval(f\"&'{sanitized_symbol_name}'\"))\n\n except gdb.error:\n return None\n\n\[email protected]_until(\"objfile\", \"thread\")\ndef static_linkage_symbol_address(symbol: str) -> int:\n \"\"\"\n Get the address for static linkage `symbol`\n \"\"\"\n\n try:\n symbol_obj = gdb.lookup_static_symbol(symbol)\n return int(symbol_obj.value().address) if symbol_obj else None\n except gdb.error:\n return None\n\n\[email protected]_until(\"stop\", \"start\")\ndef selected_frame_source_absolute_filename():\n \"\"\"\n Retrieve the symbol table\u2019s source absolute file name from the selected frame.\n\n In case of missing symbol table or frame information, None is returned.\n \"\"\"\n try:\n frame = gdb.selected_frame()\n except gdb.error:\n return None\n\n if not frame:\n return None\n\n sal = frame.find_sal()\n if not sal:\n return None\n\n symtab = sal.symtab\n if not symtab:\n return None\n\n return symtab.fullname()\n\n\ndef parse_and_eval(expression: str) -> gdb.Value | None:\n \"\"\"Error handling wrapper for GDBs parse_and_eval function\"\"\"\n try:\n return gdb.parse_and_eval(expression)\n except gdb.error:\n return None\n", "path": "pwndbg/gdblib/symbol.py"}]}
| 3,104 | 141 |
gh_patches_debug_38212
|
rasdani/github-patches
|
git_diff
|
pantsbuild__pants-6365
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
We should export a `pants_contrib_requirement` in the spirit of `pants_requirement`.
This makes plugin authors lives easier. The new macro should also support environment markers as outlined in #6358.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `src/python/pants/backend/python/register.py`
Content:
```
1 # coding=utf-8
2 # Copyright 2014 Pants project contributors (see CONTRIBUTORS.md).
3 # Licensed under the Apache License, Version 2.0 (see LICENSE).
4
5 from __future__ import absolute_import, division, print_function, unicode_literals
6
7 from pants.backend.python.pants_requirement import PantsRequirement
8 from pants.backend.python.python_artifact import PythonArtifact
9 from pants.backend.python.python_requirement import PythonRequirement
10 from pants.backend.python.python_requirements import PythonRequirements
11 from pants.backend.python.targets.python_app import PythonApp
12 from pants.backend.python.targets.python_binary import PythonBinary
13 from pants.backend.python.targets.python_distribution import PythonDistribution
14 from pants.backend.python.targets.python_library import PythonLibrary
15 from pants.backend.python.targets.python_requirement_library import PythonRequirementLibrary
16 from pants.backend.python.targets.python_tests import PythonTests
17 from pants.backend.python.tasks.build_local_python_distributions import \
18 BuildLocalPythonDistributions
19 from pants.backend.python.tasks.gather_sources import GatherSources
20 from pants.backend.python.tasks.isort_prep import IsortPrep
21 from pants.backend.python.tasks.isort_run import IsortRun
22 from pants.backend.python.tasks.local_python_distribution_artifact import \
23 LocalPythonDistributionArtifact
24 from pants.backend.python.tasks.pytest_prep import PytestPrep
25 from pants.backend.python.tasks.pytest_run import PytestRun
26 from pants.backend.python.tasks.python_binary_create import PythonBinaryCreate
27 from pants.backend.python.tasks.python_bundle import PythonBundle
28 from pants.backend.python.tasks.python_repl import PythonRepl
29 from pants.backend.python.tasks.python_run import PythonRun
30 from pants.backend.python.tasks.resolve_requirements import ResolveRequirements
31 from pants.backend.python.tasks.select_interpreter import SelectInterpreter
32 from pants.backend.python.tasks.setup_py import SetupPy
33 from pants.build_graph.build_file_aliases import BuildFileAliases
34 from pants.build_graph.resources import Resources
35 from pants.goal.task_registrar import TaskRegistrar as task
36
37
38 def build_file_aliases():
39 return BuildFileAliases(
40 targets={
41 PythonApp.alias(): PythonApp,
42 PythonBinary.alias(): PythonBinary,
43 PythonLibrary.alias(): PythonLibrary,
44 PythonTests.alias(): PythonTests,
45 PythonDistribution.alias(): PythonDistribution,
46 'python_requirement_library': PythonRequirementLibrary,
47 Resources.alias(): Resources,
48 },
49 objects={
50 'python_requirement': PythonRequirement,
51 'python_artifact': PythonArtifact,
52 'setup_py': PythonArtifact,
53 },
54 context_aware_object_factories={
55 'python_requirements': PythonRequirements,
56 'pants_requirement': PantsRequirement,
57 }
58 )
59
60
61 def register_goals():
62 task(name='interpreter', action=SelectInterpreter).install('pyprep')
63 task(name='build-local-dists', action=BuildLocalPythonDistributions).install('pyprep')
64 task(name='requirements', action=ResolveRequirements).install('pyprep')
65 task(name='sources', action=GatherSources).install('pyprep')
66 task(name='py', action=PythonRun).install('run')
67 task(name='pytest-prep', action=PytestPrep).install('test')
68 task(name='pytest', action=PytestRun).install('test')
69 task(name='py', action=PythonRepl).install('repl')
70 task(name='setup-py', action=SetupPy).install()
71 task(name='py', action=PythonBinaryCreate).install('binary')
72 task(name='py-wheels', action=LocalPythonDistributionArtifact).install('binary')
73 task(name='isort-prep', action=IsortPrep).install('fmt')
74 task(name='isort', action=IsortRun).install('fmt')
75 task(name='py', action=PythonBundle).install('bundle')
76
```
Path: `src/python/pants/backend/python/pants_requirement.py`
Content:
```
1 # coding=utf-8
2 # Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).
3 # Licensed under the Apache License, Version 2.0 (see LICENSE).
4
5 from __future__ import absolute_import, division, print_function, unicode_literals
6
7 import os
8 from builtins import object
9
10 from pants.backend.python.python_requirement import PythonRequirement
11 from pants.base.build_environment import pants_version
12
13
14 class PantsRequirement(object):
15 """Exports a `python_requirement_library` pointing at the active pants' corresponding sdist.
16
17 This requirement is useful for custom plugin authors who want to build and test their plugin with
18 pants itself. Using the resulting target as a dependency of their plugin target ensures the
19 dependency stays true to the surrounding repo's version of pants.
20
21 NB: The requirement generated is for official pants releases on pypi; so may not be appropriate
22 for use in a repo that tracks `pantsbuild/pants` or otherwise uses custom pants sdists.
23
24 :API: public
25 """
26
27 def __init__(self, parse_context):
28 self._parse_context = parse_context
29
30 def __call__(self, name=None):
31 """
32 :param string name: The name to use for the target, defaults to the parent dir name.
33 """
34 name = name or os.path.basename(self._parse_context.rel_path)
35
36 # TODO(John Sirois): Modify to constraint to >=3.5,<4 as part of
37 # https://github.com/pantsbuild/pants/issues/6062
38 env_marker = "python_version>='2.7' and python_version<'3'"
39
40 requirement = PythonRequirement(requirement="pantsbuild.pants=={version} ; {env_marker}"
41 .format(version=pants_version(), env_marker=env_marker))
42
43 self._parse_context.create_object('python_requirement_library',
44 name=name,
45 requirements=[requirement])
46
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/src/python/pants/backend/python/pants_requirement.py b/src/python/pants/backend/python/pants_requirement.py
--- a/src/python/pants/backend/python/pants_requirement.py
+++ b/src/python/pants/backend/python/pants_requirement.py
@@ -9,6 +9,9 @@
from pants.backend.python.python_requirement import PythonRequirement
from pants.base.build_environment import pants_version
+from pants.base.exceptions import TargetDefinitionException
+from pants.build_graph.address import Address
+from pants.util.meta import classproperty
class PantsRequirement(object):
@@ -24,21 +27,37 @@
:API: public
"""
+ @classproperty
+ def alias(self):
+ return 'pants_requirement'
+
def __init__(self, parse_context):
self._parse_context = parse_context
- def __call__(self, name=None):
+ def __call__(self, name=None, dist=None):
"""
- :param string name: The name to use for the target, defaults to the parent dir name.
+ :param string name: The name to use for the target, defaults to the dist name if specified and
+ otherwise the parent dir name.
+ :param string dist: The pants dist to create a requirement for. This must be a
+ 'pantsbuild.pants*' distribution; eg:
+ 'pantsbuild.pants.contrib.python.checks'.
"""
- name = name or os.path.basename(self._parse_context.rel_path)
+ name = name or dist or os.path.basename(self._parse_context.rel_path)
+ dist = dist or 'pantsbuild.pants'
+ if not (dist == 'pantsbuild.pants' or dist.startswith('pantsbuild.pants.')):
+ target = Address(spec_path=self._parse_context.rel_path, target_name=name)
+ raise TargetDefinitionException(target=target,
+ msg='The {} target only works for pantsbuild.pants '
+ 'distributions, given {}'.format(self.alias, dist))
# TODO(John Sirois): Modify to constraint to >=3.5,<4 as part of
# https://github.com/pantsbuild/pants/issues/6062
env_marker = "python_version>='2.7' and python_version<'3'"
- requirement = PythonRequirement(requirement="pantsbuild.pants=={version} ; {env_marker}"
- .format(version=pants_version(), env_marker=env_marker))
+ requirement = PythonRequirement(requirement="{key}=={version} ; {env_marker}"
+ .format(key=dist,
+ version=pants_version(),
+ env_marker=env_marker))
self._parse_context.create_object('python_requirement_library',
name=name,
diff --git a/src/python/pants/backend/python/register.py b/src/python/pants/backend/python/register.py
--- a/src/python/pants/backend/python/register.py
+++ b/src/python/pants/backend/python/register.py
@@ -53,7 +53,7 @@
},
context_aware_object_factories={
'python_requirements': PythonRequirements,
- 'pants_requirement': PantsRequirement,
+ PantsRequirement.alias: PantsRequirement,
}
)
|
{"golden_diff": "diff --git a/src/python/pants/backend/python/pants_requirement.py b/src/python/pants/backend/python/pants_requirement.py\n--- a/src/python/pants/backend/python/pants_requirement.py\n+++ b/src/python/pants/backend/python/pants_requirement.py\n@@ -9,6 +9,9 @@\n \n from pants.backend.python.python_requirement import PythonRequirement\n from pants.base.build_environment import pants_version\n+from pants.base.exceptions import TargetDefinitionException\n+from pants.build_graph.address import Address\n+from pants.util.meta import classproperty\n \n \n class PantsRequirement(object):\n@@ -24,21 +27,37 @@\n :API: public\n \"\"\"\n \n+ @classproperty\n+ def alias(self):\n+ return 'pants_requirement'\n+\n def __init__(self, parse_context):\n self._parse_context = parse_context\n \n- def __call__(self, name=None):\n+ def __call__(self, name=None, dist=None):\n \"\"\"\n- :param string name: The name to use for the target, defaults to the parent dir name.\n+ :param string name: The name to use for the target, defaults to the dist name if specified and\n+ otherwise the parent dir name.\n+ :param string dist: The pants dist to create a requirement for. This must be a\n+ 'pantsbuild.pants*' distribution; eg:\n+ 'pantsbuild.pants.contrib.python.checks'.\n \"\"\"\n- name = name or os.path.basename(self._parse_context.rel_path)\n+ name = name or dist or os.path.basename(self._parse_context.rel_path)\n+ dist = dist or 'pantsbuild.pants'\n+ if not (dist == 'pantsbuild.pants' or dist.startswith('pantsbuild.pants.')):\n+ target = Address(spec_path=self._parse_context.rel_path, target_name=name)\n+ raise TargetDefinitionException(target=target,\n+ msg='The {} target only works for pantsbuild.pants '\n+ 'distributions, given {}'.format(self.alias, dist))\n \n # TODO(John Sirois): Modify to constraint to >=3.5,<4 as part of\n # https://github.com/pantsbuild/pants/issues/6062\n env_marker = \"python_version>='2.7' and python_version<'3'\"\n \n- requirement = PythonRequirement(requirement=\"pantsbuild.pants=={version} ; {env_marker}\"\n- .format(version=pants_version(), env_marker=env_marker))\n+ requirement = PythonRequirement(requirement=\"{key}=={version} ; {env_marker}\"\n+ .format(key=dist,\n+ version=pants_version(),\n+ env_marker=env_marker))\n \n self._parse_context.create_object('python_requirement_library',\n name=name,\ndiff --git a/src/python/pants/backend/python/register.py b/src/python/pants/backend/python/register.py\n--- a/src/python/pants/backend/python/register.py\n+++ b/src/python/pants/backend/python/register.py\n@@ -53,7 +53,7 @@\n },\n context_aware_object_factories={\n 'python_requirements': PythonRequirements,\n- 'pants_requirement': PantsRequirement,\n+ PantsRequirement.alias: PantsRequirement,\n }\n )\n", "issue": "We should export a `pants_contrib_requirement` in the spirit of `pants_requirement`.\nThis makes plugin authors lives easier. The new macro should also support environment markers as outlined in #6358.\n", "before_files": [{"content": "# coding=utf-8\n# Copyright 2014 Pants project contributors (see CONTRIBUTORS.md).\n# Licensed under the Apache License, Version 2.0 (see LICENSE).\n\nfrom __future__ import absolute_import, division, print_function, unicode_literals\n\nfrom pants.backend.python.pants_requirement import PantsRequirement\nfrom pants.backend.python.python_artifact import PythonArtifact\nfrom pants.backend.python.python_requirement import PythonRequirement\nfrom pants.backend.python.python_requirements import PythonRequirements\nfrom pants.backend.python.targets.python_app import PythonApp\nfrom pants.backend.python.targets.python_binary import PythonBinary\nfrom pants.backend.python.targets.python_distribution import PythonDistribution\nfrom pants.backend.python.targets.python_library import PythonLibrary\nfrom pants.backend.python.targets.python_requirement_library import PythonRequirementLibrary\nfrom pants.backend.python.targets.python_tests import PythonTests\nfrom pants.backend.python.tasks.build_local_python_distributions import \\\n BuildLocalPythonDistributions\nfrom pants.backend.python.tasks.gather_sources import GatherSources\nfrom pants.backend.python.tasks.isort_prep import IsortPrep\nfrom pants.backend.python.tasks.isort_run import IsortRun\nfrom pants.backend.python.tasks.local_python_distribution_artifact import \\\n LocalPythonDistributionArtifact\nfrom pants.backend.python.tasks.pytest_prep import PytestPrep\nfrom pants.backend.python.tasks.pytest_run import PytestRun\nfrom pants.backend.python.tasks.python_binary_create import PythonBinaryCreate\nfrom pants.backend.python.tasks.python_bundle import PythonBundle\nfrom pants.backend.python.tasks.python_repl import PythonRepl\nfrom pants.backend.python.tasks.python_run import PythonRun\nfrom pants.backend.python.tasks.resolve_requirements import ResolveRequirements\nfrom pants.backend.python.tasks.select_interpreter import SelectInterpreter\nfrom pants.backend.python.tasks.setup_py import SetupPy\nfrom pants.build_graph.build_file_aliases import BuildFileAliases\nfrom pants.build_graph.resources import Resources\nfrom pants.goal.task_registrar import TaskRegistrar as task\n\n\ndef build_file_aliases():\n return BuildFileAliases(\n targets={\n PythonApp.alias(): PythonApp,\n PythonBinary.alias(): PythonBinary,\n PythonLibrary.alias(): PythonLibrary,\n PythonTests.alias(): PythonTests,\n PythonDistribution.alias(): PythonDistribution,\n 'python_requirement_library': PythonRequirementLibrary,\n Resources.alias(): Resources,\n },\n objects={\n 'python_requirement': PythonRequirement,\n 'python_artifact': PythonArtifact,\n 'setup_py': PythonArtifact,\n },\n context_aware_object_factories={\n 'python_requirements': PythonRequirements,\n 'pants_requirement': PantsRequirement,\n }\n )\n\n\ndef register_goals():\n task(name='interpreter', action=SelectInterpreter).install('pyprep')\n task(name='build-local-dists', action=BuildLocalPythonDistributions).install('pyprep')\n task(name='requirements', action=ResolveRequirements).install('pyprep')\n task(name='sources', action=GatherSources).install('pyprep')\n task(name='py', action=PythonRun).install('run')\n task(name='pytest-prep', action=PytestPrep).install('test')\n task(name='pytest', action=PytestRun).install('test')\n task(name='py', action=PythonRepl).install('repl')\n task(name='setup-py', action=SetupPy).install()\n task(name='py', action=PythonBinaryCreate).install('binary')\n task(name='py-wheels', action=LocalPythonDistributionArtifact).install('binary')\n task(name='isort-prep', action=IsortPrep).install('fmt')\n task(name='isort', action=IsortRun).install('fmt')\n task(name='py', action=PythonBundle).install('bundle')\n", "path": "src/python/pants/backend/python/register.py"}, {"content": "# coding=utf-8\n# Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).\n# Licensed under the Apache License, Version 2.0 (see LICENSE).\n\nfrom __future__ import absolute_import, division, print_function, unicode_literals\n\nimport os\nfrom builtins import object\n\nfrom pants.backend.python.python_requirement import PythonRequirement\nfrom pants.base.build_environment import pants_version\n\n\nclass PantsRequirement(object):\n \"\"\"Exports a `python_requirement_library` pointing at the active pants' corresponding sdist.\n\n This requirement is useful for custom plugin authors who want to build and test their plugin with\n pants itself. Using the resulting target as a dependency of their plugin target ensures the\n dependency stays true to the surrounding repo's version of pants.\n\n NB: The requirement generated is for official pants releases on pypi; so may not be appropriate\n for use in a repo that tracks `pantsbuild/pants` or otherwise uses custom pants sdists.\n\n :API: public\n \"\"\"\n\n def __init__(self, parse_context):\n self._parse_context = parse_context\n\n def __call__(self, name=None):\n \"\"\"\n :param string name: The name to use for the target, defaults to the parent dir name.\n \"\"\"\n name = name or os.path.basename(self._parse_context.rel_path)\n\n # TODO(John Sirois): Modify to constraint to >=3.5,<4 as part of\n # https://github.com/pantsbuild/pants/issues/6062\n env_marker = \"python_version>='2.7' and python_version<'3'\"\n\n requirement = PythonRequirement(requirement=\"pantsbuild.pants=={version} ; {env_marker}\"\n .format(version=pants_version(), env_marker=env_marker))\n\n self._parse_context.create_object('python_requirement_library',\n name=name,\n requirements=[requirement])\n", "path": "src/python/pants/backend/python/pants_requirement.py"}], "after_files": [{"content": "# coding=utf-8\n# Copyright 2014 Pants project contributors (see CONTRIBUTORS.md).\n# Licensed under the Apache License, Version 2.0 (see LICENSE).\n\nfrom __future__ import absolute_import, division, print_function, unicode_literals\n\nfrom pants.backend.python.pants_requirement import PantsRequirement\nfrom pants.backend.python.python_artifact import PythonArtifact\nfrom pants.backend.python.python_requirement import PythonRequirement\nfrom pants.backend.python.python_requirements import PythonRequirements\nfrom pants.backend.python.targets.python_app import PythonApp\nfrom pants.backend.python.targets.python_binary import PythonBinary\nfrom pants.backend.python.targets.python_distribution import PythonDistribution\nfrom pants.backend.python.targets.python_library import PythonLibrary\nfrom pants.backend.python.targets.python_requirement_library import PythonRequirementLibrary\nfrom pants.backend.python.targets.python_tests import PythonTests\nfrom pants.backend.python.tasks.build_local_python_distributions import \\\n BuildLocalPythonDistributions\nfrom pants.backend.python.tasks.gather_sources import GatherSources\nfrom pants.backend.python.tasks.isort_prep import IsortPrep\nfrom pants.backend.python.tasks.isort_run import IsortRun\nfrom pants.backend.python.tasks.local_python_distribution_artifact import \\\n LocalPythonDistributionArtifact\nfrom pants.backend.python.tasks.pytest_prep import PytestPrep\nfrom pants.backend.python.tasks.pytest_run import PytestRun\nfrom pants.backend.python.tasks.python_binary_create import PythonBinaryCreate\nfrom pants.backend.python.tasks.python_bundle import PythonBundle\nfrom pants.backend.python.tasks.python_repl import PythonRepl\nfrom pants.backend.python.tasks.python_run import PythonRun\nfrom pants.backend.python.tasks.resolve_requirements import ResolveRequirements\nfrom pants.backend.python.tasks.select_interpreter import SelectInterpreter\nfrom pants.backend.python.tasks.setup_py import SetupPy\nfrom pants.build_graph.build_file_aliases import BuildFileAliases\nfrom pants.build_graph.resources import Resources\nfrom pants.goal.task_registrar import TaskRegistrar as task\n\n\ndef build_file_aliases():\n return BuildFileAliases(\n targets={\n PythonApp.alias(): PythonApp,\n PythonBinary.alias(): PythonBinary,\n PythonLibrary.alias(): PythonLibrary,\n PythonTests.alias(): PythonTests,\n PythonDistribution.alias(): PythonDistribution,\n 'python_requirement_library': PythonRequirementLibrary,\n Resources.alias(): Resources,\n },\n objects={\n 'python_requirement': PythonRequirement,\n 'python_artifact': PythonArtifact,\n 'setup_py': PythonArtifact,\n },\n context_aware_object_factories={\n 'python_requirements': PythonRequirements,\n PantsRequirement.alias: PantsRequirement,\n }\n )\n\n\ndef register_goals():\n task(name='interpreter', action=SelectInterpreter).install('pyprep')\n task(name='build-local-dists', action=BuildLocalPythonDistributions).install('pyprep')\n task(name='requirements', action=ResolveRequirements).install('pyprep')\n task(name='sources', action=GatherSources).install('pyprep')\n task(name='py', action=PythonRun).install('run')\n task(name='pytest-prep', action=PytestPrep).install('test')\n task(name='pytest', action=PytestRun).install('test')\n task(name='py', action=PythonRepl).install('repl')\n task(name='setup-py', action=SetupPy).install()\n task(name='py', action=PythonBinaryCreate).install('binary')\n task(name='py-wheels', action=LocalPythonDistributionArtifact).install('binary')\n task(name='isort-prep', action=IsortPrep).install('fmt')\n task(name='isort', action=IsortRun).install('fmt')\n task(name='py', action=PythonBundle).install('bundle')\n", "path": "src/python/pants/backend/python/register.py"}, {"content": "# coding=utf-8\n# Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).\n# Licensed under the Apache License, Version 2.0 (see LICENSE).\n\nfrom __future__ import absolute_import, division, print_function, unicode_literals\n\nimport os\nfrom builtins import object\n\nfrom pants.backend.python.python_requirement import PythonRequirement\nfrom pants.base.build_environment import pants_version\nfrom pants.base.exceptions import TargetDefinitionException\nfrom pants.build_graph.address import Address\nfrom pants.util.meta import classproperty\n\n\nclass PantsRequirement(object):\n \"\"\"Exports a `python_requirement_library` pointing at the active pants' corresponding sdist.\n\n This requirement is useful for custom plugin authors who want to build and test their plugin with\n pants itself. Using the resulting target as a dependency of their plugin target ensures the\n dependency stays true to the surrounding repo's version of pants.\n\n NB: The requirement generated is for official pants releases on pypi; so may not be appropriate\n for use in a repo that tracks `pantsbuild/pants` or otherwise uses custom pants sdists.\n\n :API: public\n \"\"\"\n\n @classproperty\n def alias(self):\n return 'pants_requirement'\n\n def __init__(self, parse_context):\n self._parse_context = parse_context\n\n def __call__(self, name=None, dist=None):\n \"\"\"\n :param string name: The name to use for the target, defaults to the dist name if specified and\n otherwise the parent dir name.\n :param string dist: The pants dist to create a requirement for. This must be a\n 'pantsbuild.pants*' distribution; eg:\n 'pantsbuild.pants.contrib.python.checks'.\n \"\"\"\n name = name or dist or os.path.basename(self._parse_context.rel_path)\n dist = dist or 'pantsbuild.pants'\n if not (dist == 'pantsbuild.pants' or dist.startswith('pantsbuild.pants.')):\n target = Address(spec_path=self._parse_context.rel_path, target_name=name)\n raise TargetDefinitionException(target=target,\n msg='The {} target only works for pantsbuild.pants '\n 'distributions, given {}'.format(self.alias, dist))\n\n # TODO(John Sirois): Modify to constraint to >=3.5,<4 as part of\n # https://github.com/pantsbuild/pants/issues/6062\n env_marker = \"python_version>='2.7' and python_version<'3'\"\n\n requirement = PythonRequirement(requirement=\"{key}=={version} ; {env_marker}\"\n .format(key=dist,\n version=pants_version(),\n env_marker=env_marker))\n\n self._parse_context.create_object('python_requirement_library',\n name=name,\n requirements=[requirement])\n", "path": "src/python/pants/backend/python/pants_requirement.py"}]}
| 1,731 | 694 |
gh_patches_debug_22196
|
rasdani/github-patches
|
git_diff
|
Flexget__Flexget-3365
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Anilist plugin crashes when relations.yuna.moe is unreachable
```
2022-02-16 05:42:37 DEBUG utils.requests anime POSTing URL https://relations.yuna.moe/api/ids with args () and kwargs {'data': None, 'json': {'anilist': 114099}, 'timeout': 30}
2022-02-16 05:42:38 VERBOSE anilist anime Couldn't fetch additional IDs: 502 Server Error: Bad Gateway for url: https://relations.yuna.moe/api/ids
2022-02-16 05:42:38 CRITICAL task anime BUG: Unhandled error in plugin configure_series: local variable 'ids' referenced before assignment
(...)
UnboundLocalError: local variable 'ids' referenced before assignment
Traceback (most recent call last):
File "/usr/local/lib/python3.10/site-packages/flexget/task.py", line 547, in __run_plugin
result = method(*args, **kwargs)
File "/usr/local/lib/python3.10/site-packages/flexget/event.py", line 20, in __call__
return self.func(*args, **kwargs)
File "/usr/local/lib/python3.10/site-packages/flexget/components/series/configure_series.py", line 61, in on_task_prepare
for entry in result:
File "/usr/local/lib/python3.10/site-packages/flexget/utils/cached_input.py", line 231, in __iter__
for item in self.iterable:
File "/usr/local/lib/python3.10/site-packages/flexget/plugins/input/anilist.py", line 155, in on_task_input
if not ids or not isinstance(ids, dict):
UnboundLocalError: local variable 'ids' referenced before assignment
```
Anilist plugin crashes when relations.yuna.moe is unreachable
```
2022-02-16 05:42:37 DEBUG utils.requests anime POSTing URL https://relations.yuna.moe/api/ids with args () and kwargs {'data': None, 'json': {'anilist': 114099}, 'timeout': 30}
2022-02-16 05:42:38 VERBOSE anilist anime Couldn't fetch additional IDs: 502 Server Error: Bad Gateway for url: https://relations.yuna.moe/api/ids
2022-02-16 05:42:38 CRITICAL task anime BUG: Unhandled error in plugin configure_series: local variable 'ids' referenced before assignment
(...)
UnboundLocalError: local variable 'ids' referenced before assignment
Traceback (most recent call last):
File "/usr/local/lib/python3.10/site-packages/flexget/task.py", line 547, in __run_plugin
result = method(*args, **kwargs)
File "/usr/local/lib/python3.10/site-packages/flexget/event.py", line 20, in __call__
return self.func(*args, **kwargs)
File "/usr/local/lib/python3.10/site-packages/flexget/components/series/configure_series.py", line 61, in on_task_prepare
for entry in result:
File "/usr/local/lib/python3.10/site-packages/flexget/utils/cached_input.py", line 231, in __iter__
for item in self.iterable:
File "/usr/local/lib/python3.10/site-packages/flexget/plugins/input/anilist.py", line 155, in on_task_input
if not ids or not isinstance(ids, dict):
UnboundLocalError: local variable 'ids' referenced before assignment
```
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `flexget/plugins/input/anilist.py`
Content:
```
1 from datetime import datetime
2
3 from loguru import logger
4
5 from flexget import plugin
6 from flexget.config_schema import one_or_more
7 from flexget.entry import Entry
8 from flexget.event import event
9 from flexget.utils.cached_input import cached
10 from flexget.utils.requests import RequestException
11
12 logger = logger.bind(name='anilist')
13
14 LIST_STATUS = ['current', 'planning', 'completed', 'dropped', 'paused', 'repeating']
15
16 RELEASE_STATUS = ['finished', 'releasing', 'not_yet_released', 'cancelled', 'all']
17
18 ANIME_FORMAT = ['tv', 'tv_short', 'movie', 'special', 'ova', 'ona', 'all']
19
20 TRAILER_SOURCE = {
21 'youtube': 'https://www.youtube.com/embed/',
22 'dailymotion': 'https://www.dailymotion.com/embed/video/',
23 }
24
25
26 class AniList(object):
27 """ " Creates entries for series and movies from your AniList list
28
29 Syntax:
30 anilist:
31 username: <string>
32 status:
33 - <current|planning|completed|dropped|paused|repeating>
34 - <current|planning|completed|dropped|paused|repeating>
35 ...
36 release_status:
37 - <all|finished|releasing|not_yet_released|cancelled>
38 - <finished|releasing|not_yet_released|cancelled>
39 ...
40 format:
41 - <all|tv|tv_short|movie|special|ova|ona>
42 - <tv|tv_short|movie|special|ova|ona>
43 ...
44 list:
45 - <string>
46 - <string>
47 ...
48 """
49
50 schema = {
51 'oneOf': [
52 {'type': 'string'},
53 {
54 'type': 'object',
55 'properties': {
56 'username': {'type': 'string'},
57 'status': one_or_more(
58 {'type': 'string', 'enum': LIST_STATUS}, unique_items=True
59 ),
60 'release_status': one_or_more(
61 {'type': 'string', 'enum': RELEASE_STATUS}, unique_items=True
62 ),
63 'format': one_or_more(
64 {'type': 'string', 'enum': ANIME_FORMAT}, unique_items=True
65 ),
66 'list': one_or_more({'type': 'string'}),
67 },
68 'required': ['username'],
69 'additionalProperties': False,
70 },
71 ]
72 }
73
74 @cached('anilist', persist='2 hours')
75 def on_task_input(self, task, config):
76 if isinstance(config, str):
77 config = {'username': config}
78 selected_list_status = config.get('status', ['current', 'planning'])
79 selected_release_status = config.get('release_status', ['all'])
80 selected_formats = config.get('format', ['all'])
81 selected_list_name = config.get('list', [])
82
83 if not isinstance(selected_list_status, list):
84 selected_list_status = [selected_list_status]
85
86 if not isinstance(selected_release_status, list):
87 selected_release_status = [selected_release_status]
88
89 if not isinstance(selected_formats, list):
90 selected_formats = [selected_formats]
91
92 if not isinstance(selected_list_name, list):
93 selected_list_name = [selected_list_name]
94 selected_list_name = [i.lower() for i in selected_list_name]
95
96 logger.debug(f'Selected List Status: {selected_list_status}')
97 logger.debug(f'Selected Release Status: {selected_release_status}')
98 logger.debug(f'Selected Formats: {selected_formats}')
99
100 req_variables = {'user': config['username']}
101 req_chunk = 1
102 req_fields = (
103 'id, status, title{ romaji, english }, synonyms, siteUrl, idMal, format, episodes, '
104 'trailer{ site, id }, coverImage{ large }, bannerImage, genres, tags{ name }, '
105 'externalLinks{ site, url }, startDate{ year, month, day }, endDate{ year, month, day}'
106 )
107 while req_chunk:
108 req_query = (
109 f'query ($user: String){{ collection: MediaListCollection(userName: $user, '
110 f'type: ANIME, perChunk: 500, chunk: {req_chunk}, status_in: '
111 f'[{", ".join([s.upper() for s in selected_list_status])}]) {{ hasNextChunk, '
112 f'statuses: lists{{ status, name, list: entries{{ anime: media{{ {req_fields}'
113 f' }}}}}}}}}}'
114 )
115
116 try:
117 list_response = task.requests.post(
118 'https://graphql.anilist.co',
119 json={'query': req_query, 'variables': req_variables},
120 )
121 list_response = list_response.json()['data']
122 except RequestException as e:
123 logger.error(f'Error reading list: {e}')
124 break
125 except ValueError as e:
126 logger.error(f'Invalid JSON response: {e}')
127 break
128
129 logger.trace(f'JSON output: {list_response}')
130 for list_status in list_response.get('collection', {}).get('statuses', []):
131 if selected_list_name and (
132 list_status.get('name')
133 and list_status.get('name').lower() not in selected_list_name
134 ):
135 continue
136 for anime in list_status['list']:
137 anime = anime.get('anime')
138 has_selected_release_status = (
139 anime.get('status')
140 and anime.get('status').lower() in selected_release_status
141 ) or 'all' in selected_release_status
142 has_selected_type = (
143 anime.get('format') and anime.get('format').lower() in selected_formats
144 ) or 'all' in selected_formats
145
146 if has_selected_type and has_selected_release_status:
147 try:
148 ids = task.requests.post(
149 'https://relations.yuna.moe/api/ids',
150 json={'anilist': anime.get('id')},
151 ).json()
152 logger.debug(f'Additional IDs: {ids}')
153 except RequestException as e:
154 logger.verbose(f'Couldn\'t fetch additional IDs: {e}')
155 if not ids or not isinstance(ids, dict):
156 ids = {}
157
158 logger.debug(f'Anime Entry: {anime}')
159 entry = Entry()
160 entry['al_id'] = anime.get('id', ids.get('anilist'))
161 entry['anidb_id'] = ids.get('anidb')
162 entry['kitsu_id'] = ids.get('kitsu')
163 entry['mal_id'] = anime.get('idMal', ids.get('myanimelist'))
164 entry['al_banner'] = anime.get('bannerImage')
165 entry['al_cover'] = anime.get('coverImage', {}).get('large')
166 entry['al_date_end'] = (
167 datetime(
168 year=anime.get('endDate').get('year'),
169 month=(anime.get('endDate').get('month') or 1),
170 day=(anime.get('endDate').get('day') or 1),
171 )
172 if anime.get('endDate').get('year')
173 else None
174 )
175 entry['al_date_start'] = (
176 datetime(
177 year=anime.get('startDate').get('year'),
178 month=(anime.get('startDate').get('month') or 1),
179 day=(anime.get('startDate').get('day') or 1),
180 )
181 if anime.get('startDate').get('year')
182 else None
183 )
184 entry['al_episodes'] = anime.get('episodes')
185 entry['al_format'] = anime.get('format')
186 entry['al_genres'] = anime.get('genres')
187 entry['al_links'] = {
188 item['site']: item['url'] for item in anime.get('externalLinks')
189 }
190 entry['al_list'] = list_status.get('name')
191 entry['al_list_status'] = (
192 list_status['status'].capitalize()
193 if list_status.get('status')
194 else None
195 )
196 entry['al_release_status'] = (
197 anime['status'].capitalize() if anime.get('status') else None
198 )
199 entry['al_tags'] = [t.get('name') for t in anime.get('tags')]
200 entry['al_title'] = anime.get('title')
201 entry['al_trailer'] = (
202 TRAILER_SOURCE[anime.get('trailer', {}).get('site')]
203 + anime.get('trailer', {}).get('id')
204 if anime.get('trailer')
205 and anime.get('trailer').get('site') in TRAILER_SOURCE
206 else None
207 )
208 entry['alternate_name'] = anime.get('synonyms', [])
209 eng_title = anime.get('title', {}).get('english')
210 if (
211 eng_title
212 and eng_title.lower() != anime.get('title', {}).get('romaji').lower()
213 and eng_title not in entry['alternate_name']
214 ):
215 entry['alternate_name'].insert(0, eng_title)
216 entry['series_name'] = entry['al_title'].get('romaji') or entry[
217 'al_title'
218 ].get('english')
219 entry['title'] = entry['series_name']
220 entry['url'] = anime.get('siteUrl')
221 if entry.isvalid():
222 yield entry
223 req_chunk = req_chunk + 1 if list_response['collection']['hasNextChunk'] else False
224
225
226 @event('plugin.register')
227 def register_plugin():
228 plugin.register(AniList, 'anilist', api_ver=2)
229
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/flexget/plugins/input/anilist.py b/flexget/plugins/input/anilist.py
--- a/flexget/plugins/input/anilist.py
+++ b/flexget/plugins/input/anilist.py
@@ -144,6 +144,7 @@
) or 'all' in selected_formats
if has_selected_type and has_selected_release_status:
+ ids = {}
try:
ids = task.requests.post(
'https://relations.yuna.moe/api/ids',
@@ -152,7 +153,7 @@
logger.debug(f'Additional IDs: {ids}')
except RequestException as e:
logger.verbose(f'Couldn\'t fetch additional IDs: {e}')
- if not ids or not isinstance(ids, dict):
+ if not isinstance(ids, dict):
ids = {}
logger.debug(f'Anime Entry: {anime}')
|
{"golden_diff": "diff --git a/flexget/plugins/input/anilist.py b/flexget/plugins/input/anilist.py\n--- a/flexget/plugins/input/anilist.py\n+++ b/flexget/plugins/input/anilist.py\n@@ -144,6 +144,7 @@\n ) or 'all' in selected_formats\n \n if has_selected_type and has_selected_release_status:\n+ ids = {}\n try:\n ids = task.requests.post(\n 'https://relations.yuna.moe/api/ids',\n@@ -152,7 +153,7 @@\n logger.debug(f'Additional IDs: {ids}')\n except RequestException as e:\n logger.verbose(f'Couldn\\'t fetch additional IDs: {e}')\n- if not ids or not isinstance(ids, dict):\n+ if not isinstance(ids, dict):\n ids = {}\n \n logger.debug(f'Anime Entry: {anime}')\n", "issue": "Anilist plugin crashes when relations.yuna.moe is unreachable\n```\r\n2022-02-16 05:42:37 DEBUG utils.requests anime POSTing URL https://relations.yuna.moe/api/ids with args () and kwargs {'data': None, 'json': {'anilist': 114099}, 'timeout': 30}\r\n2022-02-16 05:42:38 VERBOSE anilist anime Couldn't fetch additional IDs: 502 Server Error: Bad Gateway for url: https://relations.yuna.moe/api/ids\r\n2022-02-16 05:42:38 CRITICAL task anime BUG: Unhandled error in plugin configure_series: local variable 'ids' referenced before assignment\r\n(...)\r\nUnboundLocalError: local variable 'ids' referenced before assignment\r\nTraceback (most recent call last):\r\n File \"/usr/local/lib/python3.10/site-packages/flexget/task.py\", line 547, in __run_plugin\r\n result = method(*args, **kwargs)\r\n File \"/usr/local/lib/python3.10/site-packages/flexget/event.py\", line 20, in __call__\r\n return self.func(*args, **kwargs)\r\n File \"/usr/local/lib/python3.10/site-packages/flexget/components/series/configure_series.py\", line 61, in on_task_prepare\r\n for entry in result:\r\n File \"/usr/local/lib/python3.10/site-packages/flexget/utils/cached_input.py\", line 231, in __iter__\r\n for item in self.iterable:\r\n File \"/usr/local/lib/python3.10/site-packages/flexget/plugins/input/anilist.py\", line 155, in on_task_input\r\n if not ids or not isinstance(ids, dict):\r\nUnboundLocalError: local variable 'ids' referenced before assignment\r\n```\nAnilist plugin crashes when relations.yuna.moe is unreachable\n```\r\n2022-02-16 05:42:37 DEBUG utils.requests anime POSTing URL https://relations.yuna.moe/api/ids with args () and kwargs {'data': None, 'json': {'anilist': 114099}, 'timeout': 30}\r\n2022-02-16 05:42:38 VERBOSE anilist anime Couldn't fetch additional IDs: 502 Server Error: Bad Gateway for url: https://relations.yuna.moe/api/ids\r\n2022-02-16 05:42:38 CRITICAL task anime BUG: Unhandled error in plugin configure_series: local variable 'ids' referenced before assignment\r\n(...)\r\nUnboundLocalError: local variable 'ids' referenced before assignment\r\nTraceback (most recent call last):\r\n File \"/usr/local/lib/python3.10/site-packages/flexget/task.py\", line 547, in __run_plugin\r\n result = method(*args, **kwargs)\r\n File \"/usr/local/lib/python3.10/site-packages/flexget/event.py\", line 20, in __call__\r\n return self.func(*args, **kwargs)\r\n File \"/usr/local/lib/python3.10/site-packages/flexget/components/series/configure_series.py\", line 61, in on_task_prepare\r\n for entry in result:\r\n File \"/usr/local/lib/python3.10/site-packages/flexget/utils/cached_input.py\", line 231, in __iter__\r\n for item in self.iterable:\r\n File \"/usr/local/lib/python3.10/site-packages/flexget/plugins/input/anilist.py\", line 155, in on_task_input\r\n if not ids or not isinstance(ids, dict):\r\nUnboundLocalError: local variable 'ids' referenced before assignment\r\n```\n", "before_files": [{"content": "from datetime import datetime\n\nfrom loguru import logger\n\nfrom flexget import plugin\nfrom flexget.config_schema import one_or_more\nfrom flexget.entry import Entry\nfrom flexget.event import event\nfrom flexget.utils.cached_input import cached\nfrom flexget.utils.requests import RequestException\n\nlogger = logger.bind(name='anilist')\n\nLIST_STATUS = ['current', 'planning', 'completed', 'dropped', 'paused', 'repeating']\n\nRELEASE_STATUS = ['finished', 'releasing', 'not_yet_released', 'cancelled', 'all']\n\nANIME_FORMAT = ['tv', 'tv_short', 'movie', 'special', 'ova', 'ona', 'all']\n\nTRAILER_SOURCE = {\n 'youtube': 'https://www.youtube.com/embed/',\n 'dailymotion': 'https://www.dailymotion.com/embed/video/',\n}\n\n\nclass AniList(object):\n \"\"\" \" Creates entries for series and movies from your AniList list\n\n Syntax:\n anilist:\n username: <string>\n status:\n - <current|planning|completed|dropped|paused|repeating>\n - <current|planning|completed|dropped|paused|repeating>\n ...\n release_status:\n - <all|finished|releasing|not_yet_released|cancelled>\n - <finished|releasing|not_yet_released|cancelled>\n ...\n format:\n - <all|tv|tv_short|movie|special|ova|ona>\n - <tv|tv_short|movie|special|ova|ona>\n ...\n list:\n - <string>\n - <string>\n ...\n \"\"\"\n\n schema = {\n 'oneOf': [\n {'type': 'string'},\n {\n 'type': 'object',\n 'properties': {\n 'username': {'type': 'string'},\n 'status': one_or_more(\n {'type': 'string', 'enum': LIST_STATUS}, unique_items=True\n ),\n 'release_status': one_or_more(\n {'type': 'string', 'enum': RELEASE_STATUS}, unique_items=True\n ),\n 'format': one_or_more(\n {'type': 'string', 'enum': ANIME_FORMAT}, unique_items=True\n ),\n 'list': one_or_more({'type': 'string'}),\n },\n 'required': ['username'],\n 'additionalProperties': False,\n },\n ]\n }\n\n @cached('anilist', persist='2 hours')\n def on_task_input(self, task, config):\n if isinstance(config, str):\n config = {'username': config}\n selected_list_status = config.get('status', ['current', 'planning'])\n selected_release_status = config.get('release_status', ['all'])\n selected_formats = config.get('format', ['all'])\n selected_list_name = config.get('list', [])\n\n if not isinstance(selected_list_status, list):\n selected_list_status = [selected_list_status]\n\n if not isinstance(selected_release_status, list):\n selected_release_status = [selected_release_status]\n\n if not isinstance(selected_formats, list):\n selected_formats = [selected_formats]\n\n if not isinstance(selected_list_name, list):\n selected_list_name = [selected_list_name]\n selected_list_name = [i.lower() for i in selected_list_name]\n\n logger.debug(f'Selected List Status: {selected_list_status}')\n logger.debug(f'Selected Release Status: {selected_release_status}')\n logger.debug(f'Selected Formats: {selected_formats}')\n\n req_variables = {'user': config['username']}\n req_chunk = 1\n req_fields = (\n 'id, status, title{ romaji, english }, synonyms, siteUrl, idMal, format, episodes, '\n 'trailer{ site, id }, coverImage{ large }, bannerImage, genres, tags{ name }, '\n 'externalLinks{ site, url }, startDate{ year, month, day }, endDate{ year, month, day}'\n )\n while req_chunk:\n req_query = (\n f'query ($user: String){{ collection: MediaListCollection(userName: $user, '\n f'type: ANIME, perChunk: 500, chunk: {req_chunk}, status_in: '\n f'[{\", \".join([s.upper() for s in selected_list_status])}]) {{ hasNextChunk, '\n f'statuses: lists{{ status, name, list: entries{{ anime: media{{ {req_fields}'\n f' }}}}}}}}}}'\n )\n\n try:\n list_response = task.requests.post(\n 'https://graphql.anilist.co',\n json={'query': req_query, 'variables': req_variables},\n )\n list_response = list_response.json()['data']\n except RequestException as e:\n logger.error(f'Error reading list: {e}')\n break\n except ValueError as e:\n logger.error(f'Invalid JSON response: {e}')\n break\n\n logger.trace(f'JSON output: {list_response}')\n for list_status in list_response.get('collection', {}).get('statuses', []):\n if selected_list_name and (\n list_status.get('name')\n and list_status.get('name').lower() not in selected_list_name\n ):\n continue\n for anime in list_status['list']:\n anime = anime.get('anime')\n has_selected_release_status = (\n anime.get('status')\n and anime.get('status').lower() in selected_release_status\n ) or 'all' in selected_release_status\n has_selected_type = (\n anime.get('format') and anime.get('format').lower() in selected_formats\n ) or 'all' in selected_formats\n\n if has_selected_type and has_selected_release_status:\n try:\n ids = task.requests.post(\n 'https://relations.yuna.moe/api/ids',\n json={'anilist': anime.get('id')},\n ).json()\n logger.debug(f'Additional IDs: {ids}')\n except RequestException as e:\n logger.verbose(f'Couldn\\'t fetch additional IDs: {e}')\n if not ids or not isinstance(ids, dict):\n ids = {}\n\n logger.debug(f'Anime Entry: {anime}')\n entry = Entry()\n entry['al_id'] = anime.get('id', ids.get('anilist'))\n entry['anidb_id'] = ids.get('anidb')\n entry['kitsu_id'] = ids.get('kitsu')\n entry['mal_id'] = anime.get('idMal', ids.get('myanimelist'))\n entry['al_banner'] = anime.get('bannerImage')\n entry['al_cover'] = anime.get('coverImage', {}).get('large')\n entry['al_date_end'] = (\n datetime(\n year=anime.get('endDate').get('year'),\n month=(anime.get('endDate').get('month') or 1),\n day=(anime.get('endDate').get('day') or 1),\n )\n if anime.get('endDate').get('year')\n else None\n )\n entry['al_date_start'] = (\n datetime(\n year=anime.get('startDate').get('year'),\n month=(anime.get('startDate').get('month') or 1),\n day=(anime.get('startDate').get('day') or 1),\n )\n if anime.get('startDate').get('year')\n else None\n )\n entry['al_episodes'] = anime.get('episodes')\n entry['al_format'] = anime.get('format')\n entry['al_genres'] = anime.get('genres')\n entry['al_links'] = {\n item['site']: item['url'] for item in anime.get('externalLinks')\n }\n entry['al_list'] = list_status.get('name')\n entry['al_list_status'] = (\n list_status['status'].capitalize()\n if list_status.get('status')\n else None\n )\n entry['al_release_status'] = (\n anime['status'].capitalize() if anime.get('status') else None\n )\n entry['al_tags'] = [t.get('name') for t in anime.get('tags')]\n entry['al_title'] = anime.get('title')\n entry['al_trailer'] = (\n TRAILER_SOURCE[anime.get('trailer', {}).get('site')]\n + anime.get('trailer', {}).get('id')\n if anime.get('trailer')\n and anime.get('trailer').get('site') in TRAILER_SOURCE\n else None\n )\n entry['alternate_name'] = anime.get('synonyms', [])\n eng_title = anime.get('title', {}).get('english')\n if (\n eng_title\n and eng_title.lower() != anime.get('title', {}).get('romaji').lower()\n and eng_title not in entry['alternate_name']\n ):\n entry['alternate_name'].insert(0, eng_title)\n entry['series_name'] = entry['al_title'].get('romaji') or entry[\n 'al_title'\n ].get('english')\n entry['title'] = entry['series_name']\n entry['url'] = anime.get('siteUrl')\n if entry.isvalid():\n yield entry\n req_chunk = req_chunk + 1 if list_response['collection']['hasNextChunk'] else False\n\n\n@event('plugin.register')\ndef register_plugin():\n plugin.register(AniList, 'anilist', api_ver=2)\n", "path": "flexget/plugins/input/anilist.py"}], "after_files": [{"content": "from datetime import datetime\n\nfrom loguru import logger\n\nfrom flexget import plugin\nfrom flexget.config_schema import one_or_more\nfrom flexget.entry import Entry\nfrom flexget.event import event\nfrom flexget.utils.cached_input import cached\nfrom flexget.utils.requests import RequestException\n\nlogger = logger.bind(name='anilist')\n\nLIST_STATUS = ['current', 'planning', 'completed', 'dropped', 'paused', 'repeating']\n\nRELEASE_STATUS = ['finished', 'releasing', 'not_yet_released', 'cancelled', 'all']\n\nANIME_FORMAT = ['tv', 'tv_short', 'movie', 'special', 'ova', 'ona', 'all']\n\nTRAILER_SOURCE = {\n 'youtube': 'https://www.youtube.com/embed/',\n 'dailymotion': 'https://www.dailymotion.com/embed/video/',\n}\n\n\nclass AniList(object):\n \"\"\" \" Creates entries for series and movies from your AniList list\n\n Syntax:\n anilist:\n username: <string>\n status:\n - <current|planning|completed|dropped|paused|repeating>\n - <current|planning|completed|dropped|paused|repeating>\n ...\n release_status:\n - <all|finished|releasing|not_yet_released|cancelled>\n - <finished|releasing|not_yet_released|cancelled>\n ...\n format:\n - <all|tv|tv_short|movie|special|ova|ona>\n - <tv|tv_short|movie|special|ova|ona>\n ...\n list:\n - <string>\n - <string>\n ...\n \"\"\"\n\n schema = {\n 'oneOf': [\n {'type': 'string'},\n {\n 'type': 'object',\n 'properties': {\n 'username': {'type': 'string'},\n 'status': one_or_more(\n {'type': 'string', 'enum': LIST_STATUS}, unique_items=True\n ),\n 'release_status': one_or_more(\n {'type': 'string', 'enum': RELEASE_STATUS}, unique_items=True\n ),\n 'format': one_or_more(\n {'type': 'string', 'enum': ANIME_FORMAT}, unique_items=True\n ),\n 'list': one_or_more({'type': 'string'}),\n },\n 'required': ['username'],\n 'additionalProperties': False,\n },\n ]\n }\n\n @cached('anilist', persist='2 hours')\n def on_task_input(self, task, config):\n if isinstance(config, str):\n config = {'username': config}\n selected_list_status = config.get('status', ['current', 'planning'])\n selected_release_status = config.get('release_status', ['all'])\n selected_formats = config.get('format', ['all'])\n selected_list_name = config.get('list', [])\n\n if not isinstance(selected_list_status, list):\n selected_list_status = [selected_list_status]\n\n if not isinstance(selected_release_status, list):\n selected_release_status = [selected_release_status]\n\n if not isinstance(selected_formats, list):\n selected_formats = [selected_formats]\n\n if not isinstance(selected_list_name, list):\n selected_list_name = [selected_list_name]\n selected_list_name = [i.lower() for i in selected_list_name]\n\n logger.debug(f'Selected List Status: {selected_list_status}')\n logger.debug(f'Selected Release Status: {selected_release_status}')\n logger.debug(f'Selected Formats: {selected_formats}')\n\n req_variables = {'user': config['username']}\n req_chunk = 1\n req_fields = (\n 'id, status, title{ romaji, english }, synonyms, siteUrl, idMal, format, episodes, '\n 'trailer{ site, id }, coverImage{ large }, bannerImage, genres, tags{ name }, '\n 'externalLinks{ site, url }, startDate{ year, month, day }, endDate{ year, month, day}'\n )\n while req_chunk:\n req_query = (\n f'query ($user: String){{ collection: MediaListCollection(userName: $user, '\n f'type: ANIME, perChunk: 500, chunk: {req_chunk}, status_in: '\n f'[{\", \".join([s.upper() for s in selected_list_status])}]) {{ hasNextChunk, '\n f'statuses: lists{{ status, name, list: entries{{ anime: media{{ {req_fields}'\n f' }}}}}}}}}}'\n )\n\n try:\n list_response = task.requests.post(\n 'https://graphql.anilist.co',\n json={'query': req_query, 'variables': req_variables},\n )\n list_response = list_response.json()['data']\n except RequestException as e:\n logger.error(f'Error reading list: {e}')\n break\n except ValueError as e:\n logger.error(f'Invalid JSON response: {e}')\n break\n\n logger.trace(f'JSON output: {list_response}')\n for list_status in list_response.get('collection', {}).get('statuses', []):\n if selected_list_name and (\n list_status.get('name')\n and list_status.get('name').lower() not in selected_list_name\n ):\n continue\n for anime in list_status['list']:\n anime = anime.get('anime')\n has_selected_release_status = (\n anime.get('status')\n and anime.get('status').lower() in selected_release_status\n ) or 'all' in selected_release_status\n has_selected_type = (\n anime.get('format') and anime.get('format').lower() in selected_formats\n ) or 'all' in selected_formats\n\n if has_selected_type and has_selected_release_status:\n ids = {}\n try:\n ids = task.requests.post(\n 'https://relations.yuna.moe/api/ids',\n json={'anilist': anime.get('id')},\n ).json()\n logger.debug(f'Additional IDs: {ids}')\n except RequestException as e:\n logger.verbose(f'Couldn\\'t fetch additional IDs: {e}')\n if not isinstance(ids, dict):\n ids = {}\n\n logger.debug(f'Anime Entry: {anime}')\n entry = Entry()\n entry['al_id'] = anime.get('id', ids.get('anilist'))\n entry['anidb_id'] = ids.get('anidb')\n entry['kitsu_id'] = ids.get('kitsu')\n entry['mal_id'] = anime.get('idMal', ids.get('myanimelist'))\n entry['al_banner'] = anime.get('bannerImage')\n entry['al_cover'] = anime.get('coverImage', {}).get('large')\n entry['al_date_end'] = (\n datetime(\n year=anime.get('endDate').get('year'),\n month=(anime.get('endDate').get('month') or 1),\n day=(anime.get('endDate').get('day') or 1),\n )\n if anime.get('endDate').get('year')\n else None\n )\n entry['al_date_start'] = (\n datetime(\n year=anime.get('startDate').get('year'),\n month=(anime.get('startDate').get('month') or 1),\n day=(anime.get('startDate').get('day') or 1),\n )\n if anime.get('startDate').get('year')\n else None\n )\n entry['al_episodes'] = anime.get('episodes')\n entry['al_format'] = anime.get('format')\n entry['al_genres'] = anime.get('genres')\n entry['al_links'] = {\n item['site']: item['url'] for item in anime.get('externalLinks')\n }\n entry['al_list'] = list_status.get('name')\n entry['al_list_status'] = (\n list_status['status'].capitalize()\n if list_status.get('status')\n else None\n )\n entry['al_release_status'] = (\n anime['status'].capitalize() if anime.get('status') else None\n )\n entry['al_tags'] = [t.get('name') for t in anime.get('tags')]\n entry['al_title'] = anime.get('title')\n entry['al_trailer'] = (\n TRAILER_SOURCE[anime.get('trailer', {}).get('site')]\n + anime.get('trailer', {}).get('id')\n if anime.get('trailer')\n and anime.get('trailer').get('site') in TRAILER_SOURCE\n else None\n )\n entry['alternate_name'] = anime.get('synonyms', [])\n eng_title = anime.get('title', {}).get('english')\n if (\n eng_title\n and eng_title.lower() != anime.get('title', {}).get('romaji').lower()\n and eng_title not in entry['alternate_name']\n ):\n entry['alternate_name'].insert(0, eng_title)\n entry['series_name'] = entry['al_title'].get('romaji') or entry[\n 'al_title'\n ].get('english')\n entry['title'] = entry['series_name']\n entry['url'] = anime.get('siteUrl')\n if entry.isvalid():\n yield entry\n req_chunk = req_chunk + 1 if list_response['collection']['hasNextChunk'] else False\n\n\n@event('plugin.register')\ndef register_plugin():\n plugin.register(AniList, 'anilist', api_ver=2)\n", "path": "flexget/plugins/input/anilist.py"}]}
| 3,728 | 195 |
gh_patches_debug_27215
|
rasdani/github-patches
|
git_diff
|
googleapis__google-cloud-python-4601
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Pub/Sub API lists the wrong (slightly incompatible) type for Message.attributes
When a subscriber receives a message, the API says it has an 'attributes' member that is a dict:
https://github.com/GoogleCloudPlatform/google-cloud-python/blob/11e310ab9f63f06252ff2b9ada201fd8c11ce06c/pubsub/google/cloud/pubsub_v1/subscriber/message.py#L36
However, it is not, in fact, a dict; it is a protobuf map. The behaviour is quite different, which the Python protobuf API documentation explains at some length:
https://developers.google.com/protocol-buffers/docs/reference/python-generated#map-fields
This is not a small difference... the semantic gap is substantial, because using the `.attributes` type in place of a dict breaks code like this:
```
message_rev = None
if some_condition:
try:
message_rev = int(message.attributes['revision'])
except KeyError:
message_rev = DEFAULT
```
In this case, instead of assigning the value `DEFAULT`, this code simply raises a new exception that doesn't happen with dicts (it's a ValueError, because the try-block will execute `int('')`). This is an incompatible, breaking change.
Again, this is a subtle, but important, API difference. At a minimum, it seems like the PubSub API docs should point to the Protobuf docs, instead of simply listing the incorrect type.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `pubsub/google/cloud/pubsub_v1/subscriber/message.py`
Content:
```
1 # Copyright 2017, Google LLC All rights reserved.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 from __future__ import absolute_import
16
17 import math
18 import time
19
20
21 class Message(object):
22 """A representation of a single Pub/Sub message.
23
24 The common way to interact with
25 :class:`~.pubsub_v1.subscriber.message.Message` objects is to receive
26 them in callbacks on subscriptions; most users should never have a need
27 to instantiate them by hand. (The exception to this is if you are
28 implementing a custom subclass to
29 :class:`~.pubsub_v1.subscriber._consumer.Consumer`.)
30
31 Attributes:
32 message_id (str): The message ID. In general, you should not need
33 to use this directly.
34 data (bytes): The data in the message. Note that this will be a
35 :class:`bytes`, not a text string.
36 attributes (dict): The attributes sent along with the message.
37 publish_time (datetime): The time that this message was originally
38 published.
39 """
40
41 def __init__(self, message, ack_id, request_queue):
42 """Construct the Message.
43
44 .. note::
45
46 This class should not be constructed directly; it is the
47 responsibility of :class:`BasePolicy` subclasses to do so.
48
49 Args:
50 message (~.pubsub_v1.types.PubsubMessage): The message received
51 from Pub/Sub.
52 ack_id (str): The ack_id received from Pub/Sub.
53 request_queue (queue.Queue): A queue provided by the policy that
54 can accept requests; the policy is responsible for handling
55 those requests.
56 """
57 self._message = message
58 self._ack_id = ack_id
59 self._request_queue = request_queue
60 self.message_id = message.message_id
61
62 # The instantiation time is the time that this message
63 # was received. Tracking this provides us a way to be smart about
64 # the default lease deadline.
65 self._received_timestamp = time.time()
66
67 # The policy should lease this message, telling PubSub that it has
68 # it until it is acked or otherwise dropped.
69 self.lease()
70
71 def __repr__(self):
72 # Get an abbreviated version of the data.
73 abbv_data = self._message.data
74 if len(abbv_data) > 50:
75 abbv_data = abbv_data[0:50] + b'...'
76
77 # Return a useful representation.
78 answer = 'Message {\n'
79 answer += ' data: {0!r}\n'.format(abbv_data)
80 answer += ' attributes: {0!r}\n'.format(self.attributes)
81 answer += '}'
82 return answer
83
84 @property
85 def attributes(self):
86 """Return the attributes of the underlying Pub/Sub Message.
87
88 Returns:
89 dict: The message's attributes.
90 """
91 return self._message.attributes
92
93 @property
94 def data(self):
95 """Return the data for the underlying Pub/Sub Message.
96
97 Returns:
98 bytes: The message data. This is always a bytestring; if you
99 want a text string, call :meth:`bytes.decode`.
100 """
101 return self._message.data
102
103 @property
104 def publish_time(self):
105 """Return the time that the message was originally published.
106
107 Returns:
108 datetime: The date and time that the message was published.
109 """
110 return self._message.publish_time
111
112 @property
113 def size(self):
114 """Return the size of the underlying message, in bytes."""
115 return self._message.ByteSize()
116
117 def ack(self):
118 """Acknowledge the given message.
119
120 Acknowledging a message in Pub/Sub means that you are done
121 with it, and it will not be delivered to this subscription again.
122 You should avoid acknowledging messages until you have
123 *finished* processing them, so that in the event of a failure,
124 you receive the message again.
125
126 .. warning::
127 Acks in Pub/Sub are best effort. You should always
128 ensure that your processing code is idempotent, as you may
129 receive any given message more than once.
130 """
131 time_to_ack = math.ceil(time.time() - self._received_timestamp)
132 self._request_queue.put(
133 (
134 'ack',
135 {
136 'ack_id': self._ack_id,
137 'byte_size': self.size,
138 'time_to_ack': time_to_ack,
139 },
140 ),
141 )
142
143 def drop(self):
144 """Release the message from lease management.
145
146 This informs the policy to no longer hold on to the lease for this
147 message. Pub/Sub will re-deliver the message if it is not acknowledged
148 before the existing lease expires.
149
150 .. warning::
151 For most use cases, the only reason to drop a message from
152 lease management is on :meth:`ack` or :meth:`nack`; these methods
153 both call this one. You probably do not want to call this method
154 directly.
155 """
156 self._request_queue.put(
157 (
158 'drop',
159 {
160 'ack_id': self._ack_id,
161 'byte_size': self.size,
162 },
163 ),
164 )
165
166 def lease(self):
167 """Inform the policy to lease this message continually.
168
169 .. note::
170 This method is called by the constructor, and you should never
171 need to call it manually.
172 """
173 self._request_queue.put(
174 (
175 'lease',
176 {
177 'ack_id': self._ack_id,
178 'byte_size': self.size,
179 },
180 ),
181 )
182
183 def modify_ack_deadline(self, seconds):
184 """Set the deadline for acknowledgement to the given value.
185
186 The default implementation handles this for you; you should not need
187 to manually deal with setting ack deadlines. The exception case is
188 if you are implementing your own custom subclass of
189 :class:`~.pubsub_v1.subcriber._consumer.Consumer`.
190
191 .. note::
192 This is not an extension; it *sets* the deadline to the given
193 number of seconds from right now. It is even possible to use this
194 method to make a deadline shorter.
195
196 Args:
197 seconds (int): The number of seconds to set the lease deadline
198 to. This should be between 0 and 600. Due to network latency,
199 values below 10 are advised against.
200 """
201 self._request_queue.put(
202 (
203 'modify_ack_deadline',
204 {
205 'ack_id': self._ack_id,
206 'seconds': seconds,
207 },
208 ),
209 )
210
211 def nack(self):
212 """Decline to acknowldge the given message.
213
214 This will cause the message to be re-delivered to the subscription.
215 """
216 self._request_queue.put(
217 (
218 'nack',
219 {
220 'ack_id': self._ack_id,
221 'byte_size': self.size,
222 },
223 ),
224 )
225
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/pubsub/google/cloud/pubsub_v1/subscriber/message.py b/pubsub/google/cloud/pubsub_v1/subscriber/message.py
--- a/pubsub/google/cloud/pubsub_v1/subscriber/message.py
+++ b/pubsub/google/cloud/pubsub_v1/subscriber/message.py
@@ -33,7 +33,8 @@
to use this directly.
data (bytes): The data in the message. Note that this will be a
:class:`bytes`, not a text string.
- attributes (dict): The attributes sent along with the message.
+ attributes (.ScalarMapContainer): The attributes sent along with the
+ message. See :attr:`attributes` for more information on this type.
publish_time (datetime): The time that this message was originally
published.
"""
@@ -85,8 +86,18 @@
def attributes(self):
"""Return the attributes of the underlying Pub/Sub Message.
+ .. warning::
+
+ A ``ScalarMapContainer`` behaves slightly differently than a
+ ``dict``. For a Pub / Sub message this is a ``string->string`` map.
+ When trying to access a value via ``map['key']``, if the key is
+ not in the map, then the default value for the string type will
+ be returned, which is an empty string. It may be more intuitive
+ to just cast the map to a ``dict`` or to one use ``map.get``.
+
Returns:
- dict: The message's attributes.
+ .ScalarMapContainer: The message's attributes. This is a
+ ``dict``-like object provided by ``google.protobuf``.
"""
return self._message.attributes
|
{"golden_diff": "diff --git a/pubsub/google/cloud/pubsub_v1/subscriber/message.py b/pubsub/google/cloud/pubsub_v1/subscriber/message.py\n--- a/pubsub/google/cloud/pubsub_v1/subscriber/message.py\n+++ b/pubsub/google/cloud/pubsub_v1/subscriber/message.py\n@@ -33,7 +33,8 @@\n to use this directly.\n data (bytes): The data in the message. Note that this will be a\n :class:`bytes`, not a text string.\n- attributes (dict): The attributes sent along with the message.\n+ attributes (.ScalarMapContainer): The attributes sent along with the\n+ message. See :attr:`attributes` for more information on this type.\n publish_time (datetime): The time that this message was originally\n published.\n \"\"\"\n@@ -85,8 +86,18 @@\n def attributes(self):\n \"\"\"Return the attributes of the underlying Pub/Sub Message.\n \n+ .. warning::\n+\n+ A ``ScalarMapContainer`` behaves slightly differently than a\n+ ``dict``. For a Pub / Sub message this is a ``string->string`` map.\n+ When trying to access a value via ``map['key']``, if the key is\n+ not in the map, then the default value for the string type will\n+ be returned, which is an empty string. It may be more intuitive\n+ to just cast the map to a ``dict`` or to one use ``map.get``.\n+\n Returns:\n- dict: The message's attributes.\n+ .ScalarMapContainer: The message's attributes. This is a\n+ ``dict``-like object provided by ``google.protobuf``.\n \"\"\"\n return self._message.attributes\n", "issue": "Pub/Sub API lists the wrong (slightly incompatible) type for Message.attributes\nWhen a subscriber receives a message, the API says it has an 'attributes' member that is a dict:\r\n\r\nhttps://github.com/GoogleCloudPlatform/google-cloud-python/blob/11e310ab9f63f06252ff2b9ada201fd8c11ce06c/pubsub/google/cloud/pubsub_v1/subscriber/message.py#L36\r\n\r\nHowever, it is not, in fact, a dict; it is a protobuf map. The behaviour is quite different, which the Python protobuf API documentation explains at some length:\r\n\r\nhttps://developers.google.com/protocol-buffers/docs/reference/python-generated#map-fields\r\n\r\nThis is not a small difference... the semantic gap is substantial, because using the `.attributes` type in place of a dict breaks code like this:\r\n\r\n```\r\nmessage_rev = None\r\nif some_condition:\r\n try:\r\n message_rev = int(message.attributes['revision'])\r\n except KeyError:\r\n message_rev = DEFAULT\r\n```\r\n\r\nIn this case, instead of assigning the value `DEFAULT`, this code simply raises a new exception that doesn't happen with dicts (it's a ValueError, because the try-block will execute `int('')`). This is an incompatible, breaking change.\r\n\r\nAgain, this is a subtle, but important, API difference. At a minimum, it seems like the PubSub API docs should point to the Protobuf docs, instead of simply listing the incorrect type.\n", "before_files": [{"content": "# Copyright 2017, Google LLC 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# 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\nfrom __future__ import absolute_import\n\nimport math\nimport time\n\n\nclass Message(object):\n \"\"\"A representation of a single Pub/Sub message.\n\n The common way to interact with\n :class:`~.pubsub_v1.subscriber.message.Message` objects is to receive\n them in callbacks on subscriptions; most users should never have a need\n to instantiate them by hand. (The exception to this is if you are\n implementing a custom subclass to\n :class:`~.pubsub_v1.subscriber._consumer.Consumer`.)\n\n Attributes:\n message_id (str): The message ID. In general, you should not need\n to use this directly.\n data (bytes): The data in the message. Note that this will be a\n :class:`bytes`, not a text string.\n attributes (dict): The attributes sent along with the message.\n publish_time (datetime): The time that this message was originally\n published.\n \"\"\"\n\n def __init__(self, message, ack_id, request_queue):\n \"\"\"Construct the Message.\n\n .. note::\n\n This class should not be constructed directly; it is the\n responsibility of :class:`BasePolicy` subclasses to do so.\n\n Args:\n message (~.pubsub_v1.types.PubsubMessage): The message received\n from Pub/Sub.\n ack_id (str): The ack_id received from Pub/Sub.\n request_queue (queue.Queue): A queue provided by the policy that\n can accept requests; the policy is responsible for handling\n those requests.\n \"\"\"\n self._message = message\n self._ack_id = ack_id\n self._request_queue = request_queue\n self.message_id = message.message_id\n\n # The instantiation time is the time that this message\n # was received. Tracking this provides us a way to be smart about\n # the default lease deadline.\n self._received_timestamp = time.time()\n\n # The policy should lease this message, telling PubSub that it has\n # it until it is acked or otherwise dropped.\n self.lease()\n\n def __repr__(self):\n # Get an abbreviated version of the data.\n abbv_data = self._message.data\n if len(abbv_data) > 50:\n abbv_data = abbv_data[0:50] + b'...'\n\n # Return a useful representation.\n answer = 'Message {\\n'\n answer += ' data: {0!r}\\n'.format(abbv_data)\n answer += ' attributes: {0!r}\\n'.format(self.attributes)\n answer += '}'\n return answer\n\n @property\n def attributes(self):\n \"\"\"Return the attributes of the underlying Pub/Sub Message.\n\n Returns:\n dict: The message's attributes.\n \"\"\"\n return self._message.attributes\n\n @property\n def data(self):\n \"\"\"Return the data for the underlying Pub/Sub Message.\n\n Returns:\n bytes: The message data. This is always a bytestring; if you\n want a text string, call :meth:`bytes.decode`.\n \"\"\"\n return self._message.data\n\n @property\n def publish_time(self):\n \"\"\"Return the time that the message was originally published.\n\n Returns:\n datetime: The date and time that the message was published.\n \"\"\"\n return self._message.publish_time\n\n @property\n def size(self):\n \"\"\"Return the size of the underlying message, in bytes.\"\"\"\n return self._message.ByteSize()\n\n def ack(self):\n \"\"\"Acknowledge the given message.\n\n Acknowledging a message in Pub/Sub means that you are done\n with it, and it will not be delivered to this subscription again.\n You should avoid acknowledging messages until you have\n *finished* processing them, so that in the event of a failure,\n you receive the message again.\n\n .. warning::\n Acks in Pub/Sub are best effort. You should always\n ensure that your processing code is idempotent, as you may\n receive any given message more than once.\n \"\"\"\n time_to_ack = math.ceil(time.time() - self._received_timestamp)\n self._request_queue.put(\n (\n 'ack',\n {\n 'ack_id': self._ack_id,\n 'byte_size': self.size,\n 'time_to_ack': time_to_ack,\n },\n ),\n )\n\n def drop(self):\n \"\"\"Release the message from lease management.\n\n This informs the policy to no longer hold on to the lease for this\n message. Pub/Sub will re-deliver the message if it is not acknowledged\n before the existing lease expires.\n\n .. warning::\n For most use cases, the only reason to drop a message from\n lease management is on :meth:`ack` or :meth:`nack`; these methods\n both call this one. You probably do not want to call this method\n directly.\n \"\"\"\n self._request_queue.put(\n (\n 'drop',\n {\n 'ack_id': self._ack_id,\n 'byte_size': self.size,\n },\n ),\n )\n\n def lease(self):\n \"\"\"Inform the policy to lease this message continually.\n\n .. note::\n This method is called by the constructor, and you should never\n need to call it manually.\n \"\"\"\n self._request_queue.put(\n (\n 'lease',\n {\n 'ack_id': self._ack_id,\n 'byte_size': self.size,\n },\n ),\n )\n\n def modify_ack_deadline(self, seconds):\n \"\"\"Set the deadline for acknowledgement to the given value.\n\n The default implementation handles this for you; you should not need\n to manually deal with setting ack deadlines. The exception case is\n if you are implementing your own custom subclass of\n :class:`~.pubsub_v1.subcriber._consumer.Consumer`.\n\n .. note::\n This is not an extension; it *sets* the deadline to the given\n number of seconds from right now. It is even possible to use this\n method to make a deadline shorter.\n\n Args:\n seconds (int): The number of seconds to set the lease deadline\n to. This should be between 0 and 600. Due to network latency,\n values below 10 are advised against.\n \"\"\"\n self._request_queue.put(\n (\n 'modify_ack_deadline',\n {\n 'ack_id': self._ack_id,\n 'seconds': seconds,\n },\n ),\n )\n\n def nack(self):\n \"\"\"Decline to acknowldge the given message.\n\n This will cause the message to be re-delivered to the subscription.\n \"\"\"\n self._request_queue.put(\n (\n 'nack',\n {\n 'ack_id': self._ack_id,\n 'byte_size': self.size,\n },\n ),\n )\n", "path": "pubsub/google/cloud/pubsub_v1/subscriber/message.py"}], "after_files": [{"content": "# Copyright 2017, Google LLC 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# 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\nfrom __future__ import absolute_import\n\nimport math\nimport time\n\n\nclass Message(object):\n \"\"\"A representation of a single Pub/Sub message.\n\n The common way to interact with\n :class:`~.pubsub_v1.subscriber.message.Message` objects is to receive\n them in callbacks on subscriptions; most users should never have a need\n to instantiate them by hand. (The exception to this is if you are\n implementing a custom subclass to\n :class:`~.pubsub_v1.subscriber._consumer.Consumer`.)\n\n Attributes:\n message_id (str): The message ID. In general, you should not need\n to use this directly.\n data (bytes): The data in the message. Note that this will be a\n :class:`bytes`, not a text string.\n attributes (.ScalarMapContainer): The attributes sent along with the\n message. See :attr:`attributes` for more information on this type.\n publish_time (datetime): The time that this message was originally\n published.\n \"\"\"\n\n def __init__(self, message, ack_id, request_queue):\n \"\"\"Construct the Message.\n\n .. note::\n\n This class should not be constructed directly; it is the\n responsibility of :class:`BasePolicy` subclasses to do so.\n\n Args:\n message (~.pubsub_v1.types.PubsubMessage): The message received\n from Pub/Sub.\n ack_id (str): The ack_id received from Pub/Sub.\n request_queue (queue.Queue): A queue provided by the policy that\n can accept requests; the policy is responsible for handling\n those requests.\n \"\"\"\n self._message = message\n self._ack_id = ack_id\n self._request_queue = request_queue\n self.message_id = message.message_id\n\n # The instantiation time is the time that this message\n # was received. Tracking this provides us a way to be smart about\n # the default lease deadline.\n self._received_timestamp = time.time()\n\n # The policy should lease this message, telling PubSub that it has\n # it until it is acked or otherwise dropped.\n self.lease()\n\n def __repr__(self):\n # Get an abbreviated version of the data.\n abbv_data = self._message.data\n if len(abbv_data) > 50:\n abbv_data = abbv_data[0:50] + b'...'\n\n # Return a useful representation.\n answer = 'Message {\\n'\n answer += ' data: {0!r}\\n'.format(abbv_data)\n answer += ' attributes: {0!r}\\n'.format(self.attributes)\n answer += '}'\n return answer\n\n @property\n def attributes(self):\n \"\"\"Return the attributes of the underlying Pub/Sub Message.\n\n .. warning::\n\n A ``ScalarMapContainer`` behaves slightly differently than a\n ``dict``. For a Pub / Sub message this is a ``string->string`` map.\n When trying to access a value via ``map['key']``, if the key is\n not in the map, then the default value for the string type will\n be returned, which is an empty string. It may be more intuitive\n to just cast the map to a ``dict`` or to one use ``map.get``.\n\n Returns:\n .ScalarMapContainer: The message's attributes. This is a\n ``dict``-like object provided by ``google.protobuf``.\n \"\"\"\n return self._message.attributes\n\n @property\n def data(self):\n \"\"\"Return the data for the underlying Pub/Sub Message.\n\n Returns:\n bytes: The message data. This is always a bytestring; if you\n want a text string, call :meth:`bytes.decode`.\n \"\"\"\n return self._message.data\n\n @property\n def publish_time(self):\n \"\"\"Return the time that the message was originally published.\n\n Returns:\n datetime: The date and time that the message was published.\n \"\"\"\n return self._message.publish_time\n\n @property\n def size(self):\n \"\"\"Return the size of the underlying message, in bytes.\"\"\"\n return self._message.ByteSize()\n\n def ack(self):\n \"\"\"Acknowledge the given message.\n\n Acknowledging a message in Pub/Sub means that you are done\n with it, and it will not be delivered to this subscription again.\n You should avoid acknowledging messages until you have\n *finished* processing them, so that in the event of a failure,\n you receive the message again.\n\n .. warning::\n Acks in Pub/Sub are best effort. You should always\n ensure that your processing code is idempotent, as you may\n receive any given message more than once.\n \"\"\"\n time_to_ack = math.ceil(time.time() - self._received_timestamp)\n self._request_queue.put(\n (\n 'ack',\n {\n 'ack_id': self._ack_id,\n 'byte_size': self.size,\n 'time_to_ack': time_to_ack,\n },\n ),\n )\n\n def drop(self):\n \"\"\"Release the message from lease management.\n\n This informs the policy to no longer hold on to the lease for this\n message. Pub/Sub will re-deliver the message if it is not acknowledged\n before the existing lease expires.\n\n .. warning::\n For most use cases, the only reason to drop a message from\n lease management is on :meth:`ack` or :meth:`nack`; these methods\n both call this one. You probably do not want to call this method\n directly.\n \"\"\"\n self._request_queue.put(\n (\n 'drop',\n {\n 'ack_id': self._ack_id,\n 'byte_size': self.size,\n },\n ),\n )\n\n def lease(self):\n \"\"\"Inform the policy to lease this message continually.\n\n .. note::\n This method is called by the constructor, and you should never\n need to call it manually.\n \"\"\"\n self._request_queue.put(\n (\n 'lease',\n {\n 'ack_id': self._ack_id,\n 'byte_size': self.size,\n },\n ),\n )\n\n def modify_ack_deadline(self, seconds):\n \"\"\"Set the deadline for acknowledgement to the given value.\n\n The default implementation handles this for you; you should not need\n to manually deal with setting ack deadlines. The exception case is\n if you are implementing your own custom subclass of\n :class:`~.pubsub_v1.subcriber._consumer.Consumer`.\n\n .. note::\n This is not an extension; it *sets* the deadline to the given\n number of seconds from right now. It is even possible to use this\n method to make a deadline shorter.\n\n Args:\n seconds (int): The number of seconds to set the lease deadline\n to. This should be between 0 and 600. Due to network latency,\n values below 10 are advised against.\n \"\"\"\n self._request_queue.put(\n (\n 'modify_ack_deadline',\n {\n 'ack_id': self._ack_id,\n 'seconds': seconds,\n },\n ),\n )\n\n def nack(self):\n \"\"\"Decline to acknowldge the given message.\n\n This will cause the message to be re-delivered to the subscription.\n \"\"\"\n self._request_queue.put(\n (\n 'nack',\n {\n 'ack_id': self._ack_id,\n 'byte_size': self.size,\n },\n ),\n )\n", "path": "pubsub/google/cloud/pubsub_v1/subscriber/message.py"}]}
| 2,757 | 373 |
gh_patches_debug_5361
|
rasdani/github-patches
|
git_diff
|
bookwyrm-social__bookwyrm-175
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
nginx configuration
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `fedireads/settings.py`
Content:
```
1 ''' fedireads settings and configuration '''
2 import os
3
4 from environs import Env
5
6 env = Env()
7
8 # celery
9 CELERY_BROKER = env('CELERY_BROKER')
10 CELERY_RESULT_BACKEND = env('CELERY_RESULT_BACKEND')
11 CELERY_ACCEPT_CONTENT = ['application/json']
12 CELERY_TASK_SERIALIZER = 'json'
13 CELERY_RESULT_SERIALIZER = 'json'
14
15 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
16 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
17
18 # Quick-start development settings - unsuitable for production
19 # See https://docs.djangoproject.com/en/2.0/howto/deployment/checklist/
20
21 # SECURITY WARNING: keep the secret key used in production secret!
22 SECRET_KEY = env('SECRET_KEY')
23
24 # SECURITY WARNING: don't run with debug turned on in production!
25 DEBUG = env.bool('DEBUG', True)
26
27 DOMAIN = env('DOMAIN')
28 ALLOWED_HOSTS = env.list('ALLOWED_HOSTS', ['*'])
29 OL_URL = env('OL_URL')
30
31 # Application definition
32
33 INSTALLED_APPS = [
34 'django.contrib.admin',
35 'django.contrib.auth',
36 'django.contrib.contenttypes',
37 'django.contrib.sessions',
38 'django.contrib.messages',
39 'django.contrib.staticfiles',
40 'django.contrib.humanize',
41 'fedireads',
42 'celery',
43 ]
44
45 MIDDLEWARE = [
46 'django.middleware.security.SecurityMiddleware',
47 'django.contrib.sessions.middleware.SessionMiddleware',
48 'django.middleware.common.CommonMiddleware',
49 'django.middleware.csrf.CsrfViewMiddleware',
50 'django.contrib.auth.middleware.AuthenticationMiddleware',
51 'django.contrib.messages.middleware.MessageMiddleware',
52 'django.middleware.clickjacking.XFrameOptionsMiddleware',
53 ]
54
55 ROOT_URLCONF = 'fedireads.urls'
56
57 TEMPLATES = [
58 {
59 'BACKEND': 'django.template.backends.django.DjangoTemplates',
60 'DIRS': ['templates'],
61 'APP_DIRS': True,
62 'OPTIONS': {
63 'context_processors': [
64 'django.template.context_processors.debug',
65 'django.template.context_processors.request',
66 'django.contrib.auth.context_processors.auth',
67 'django.contrib.messages.context_processors.messages',
68 ],
69 },
70 },
71 ]
72
73
74 WSGI_APPLICATION = 'fedireads.wsgi.application'
75
76
77 # Database
78 # https://docs.djangoproject.com/en/2.0/ref/settings/#databases
79
80 FEDIREADS_DATABASE_BACKEND = env('FEDIREADS_DATABASE_BACKEND', 'postgres')
81
82 FEDIREADS_DBS = {
83 'postgres': {
84 'ENGINE': 'django.db.backends.postgresql_psycopg2',
85 'NAME': env('POSTGRES_DB', 'fedireads'),
86 'USER': env('POSTGRES_USER', 'fedireads'),
87 'PASSWORD': env('POSTGRES_PASSWORD', 'fedireads'),
88 'HOST': env('POSTGRES_HOST', ''),
89 'PORT': 5432
90 },
91 'sqlite': {
92 'ENGINE': 'django.db.backends.sqlite3',
93 'NAME': os.path.join(BASE_DIR, 'fedireads.db')
94 }
95 }
96
97 DATABASES = {
98 'default': FEDIREADS_DBS[FEDIREADS_DATABASE_BACKEND]
99 }
100
101
102 LOGIN_URL = '/login/'
103 AUTH_USER_MODEL = 'fedireads.User'
104
105 # Password validation
106 # https://docs.djangoproject.com/en/2.0/ref/settings/#auth-password-validators
107
108 AUTH_PASSWORD_VALIDATORS = [
109 {
110 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
111 },
112 {
113 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
114 },
115 {
116 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
117 },
118 {
119 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
120 },
121 ]
122
123
124 # Internationalization
125 # https://docs.djangoproject.com/en/2.0/topics/i18n/
126
127 LANGUAGE_CODE = 'en-us'
128
129 TIME_ZONE = 'UTC'
130
131 USE_I18N = True
132
133 USE_L10N = True
134
135 USE_TZ = True
136
137
138 # Static files (CSS, JavaScript, Images)
139 # https://docs.djangoproject.com/en/2.0/howto/static-files/
140
141 STATIC_URL = '/static/'
142 MEDIA_URL = '/images/'
143 MEDIA_ROOT = os.path.join(BASE_DIR, env('MEDIA_ROOT', 'images/'))
144
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/fedireads/settings.py b/fedireads/settings.py
--- a/fedireads/settings.py
+++ b/fedireads/settings.py
@@ -138,6 +138,8 @@
# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/2.0/howto/static-files/
+PROJECT_DIR = os.path.dirname(os.path.abspath(__file__))
STATIC_URL = '/static/'
+STATIC_ROOT = os.path.join(BASE_DIR, env('STATIC_ROOT', 'static'))
MEDIA_URL = '/images/'
-MEDIA_ROOT = os.path.join(BASE_DIR, env('MEDIA_ROOT', 'images/'))
+MEDIA_ROOT = os.path.join(BASE_DIR, env('MEDIA_ROOT', 'images'))
|
{"golden_diff": "diff --git a/fedireads/settings.py b/fedireads/settings.py\n--- a/fedireads/settings.py\n+++ b/fedireads/settings.py\n@@ -138,6 +138,8 @@\n # Static files (CSS, JavaScript, Images)\n # https://docs.djangoproject.com/en/2.0/howto/static-files/\n \n+PROJECT_DIR = os.path.dirname(os.path.abspath(__file__))\n STATIC_URL = '/static/'\n+STATIC_ROOT = os.path.join(BASE_DIR, env('STATIC_ROOT', 'static'))\n MEDIA_URL = '/images/'\n-MEDIA_ROOT = os.path.join(BASE_DIR, env('MEDIA_ROOT', 'images/'))\n+MEDIA_ROOT = os.path.join(BASE_DIR, env('MEDIA_ROOT', 'images'))\n", "issue": "nginx configuration\n\n", "before_files": [{"content": "''' fedireads settings and configuration '''\nimport os\n\nfrom environs import Env\n\nenv = Env()\n\n# celery\nCELERY_BROKER = env('CELERY_BROKER')\nCELERY_RESULT_BACKEND = env('CELERY_RESULT_BACKEND')\nCELERY_ACCEPT_CONTENT = ['application/json']\nCELERY_TASK_SERIALIZER = 'json'\nCELERY_RESULT_SERIALIZER = 'json'\n\n# Build paths inside the project like this: os.path.join(BASE_DIR, ...)\nBASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\n\n# Quick-start development settings - unsuitable for production\n# See https://docs.djangoproject.com/en/2.0/howto/deployment/checklist/\n\n# SECURITY WARNING: keep the secret key used in production secret!\nSECRET_KEY = env('SECRET_KEY')\n\n# SECURITY WARNING: don't run with debug turned on in production!\nDEBUG = env.bool('DEBUG', True)\n\nDOMAIN = env('DOMAIN')\nALLOWED_HOSTS = env.list('ALLOWED_HOSTS', ['*'])\nOL_URL = env('OL_URL')\n\n# Application definition\n\nINSTALLED_APPS = [\n 'django.contrib.admin',\n 'django.contrib.auth',\n 'django.contrib.contenttypes',\n 'django.contrib.sessions',\n 'django.contrib.messages',\n 'django.contrib.staticfiles',\n 'django.contrib.humanize',\n 'fedireads',\n 'celery',\n]\n\nMIDDLEWARE = [\n 'django.middleware.security.SecurityMiddleware',\n 'django.contrib.sessions.middleware.SessionMiddleware',\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.clickjacking.XFrameOptionsMiddleware',\n]\n\nROOT_URLCONF = 'fedireads.urls'\n\nTEMPLATES = [\n {\n 'BACKEND': 'django.template.backends.django.DjangoTemplates',\n 'DIRS': ['templates'],\n 'APP_DIRS': True,\n 'OPTIONS': {\n 'context_processors': [\n 'django.template.context_processors.debug',\n 'django.template.context_processors.request',\n 'django.contrib.auth.context_processors.auth',\n 'django.contrib.messages.context_processors.messages',\n ],\n },\n },\n]\n\n\nWSGI_APPLICATION = 'fedireads.wsgi.application'\n\n\n# Database\n# https://docs.djangoproject.com/en/2.0/ref/settings/#databases\n\nFEDIREADS_DATABASE_BACKEND = env('FEDIREADS_DATABASE_BACKEND', 'postgres')\n\nFEDIREADS_DBS = {\n 'postgres': {\n 'ENGINE': 'django.db.backends.postgresql_psycopg2',\n 'NAME': env('POSTGRES_DB', 'fedireads'),\n 'USER': env('POSTGRES_USER', 'fedireads'),\n 'PASSWORD': env('POSTGRES_PASSWORD', 'fedireads'),\n 'HOST': env('POSTGRES_HOST', ''),\n 'PORT': 5432\n },\n 'sqlite': {\n 'ENGINE': 'django.db.backends.sqlite3',\n 'NAME': os.path.join(BASE_DIR, 'fedireads.db')\n }\n}\n\nDATABASES = {\n 'default': FEDIREADS_DBS[FEDIREADS_DATABASE_BACKEND]\n}\n\n\nLOGIN_URL = '/login/'\nAUTH_USER_MODEL = 'fedireads.User'\n\n# Password validation\n# https://docs.djangoproject.com/en/2.0/ref/settings/#auth-password-validators\n\nAUTH_PASSWORD_VALIDATORS = [\n {\n 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',\n },\n {\n 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',\n },\n {\n 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',\n },\n {\n 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',\n },\n]\n\n\n# Internationalization\n# https://docs.djangoproject.com/en/2.0/topics/i18n/\n\nLANGUAGE_CODE = 'en-us'\n\nTIME_ZONE = 'UTC'\n\nUSE_I18N = True\n\nUSE_L10N = True\n\nUSE_TZ = True\n\n\n# Static files (CSS, JavaScript, Images)\n# https://docs.djangoproject.com/en/2.0/howto/static-files/\n\nSTATIC_URL = '/static/'\nMEDIA_URL = '/images/'\nMEDIA_ROOT = os.path.join(BASE_DIR, env('MEDIA_ROOT', 'images/'))\n", "path": "fedireads/settings.py"}], "after_files": [{"content": "''' fedireads settings and configuration '''\nimport os\n\nfrom environs import Env\n\nenv = Env()\n\n# celery\nCELERY_BROKER = env('CELERY_BROKER')\nCELERY_RESULT_BACKEND = env('CELERY_RESULT_BACKEND')\nCELERY_ACCEPT_CONTENT = ['application/json']\nCELERY_TASK_SERIALIZER = 'json'\nCELERY_RESULT_SERIALIZER = 'json'\n\n# Build paths inside the project like this: os.path.join(BASE_DIR, ...)\nBASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\n\n# Quick-start development settings - unsuitable for production\n# See https://docs.djangoproject.com/en/2.0/howto/deployment/checklist/\n\n# SECURITY WARNING: keep the secret key used in production secret!\nSECRET_KEY = env('SECRET_KEY')\n\n# SECURITY WARNING: don't run with debug turned on in production!\nDEBUG = env.bool('DEBUG', True)\n\nDOMAIN = env('DOMAIN')\nALLOWED_HOSTS = env.list('ALLOWED_HOSTS', ['*'])\nOL_URL = env('OL_URL')\n\n# Application definition\n\nINSTALLED_APPS = [\n 'django.contrib.admin',\n 'django.contrib.auth',\n 'django.contrib.contenttypes',\n 'django.contrib.sessions',\n 'django.contrib.messages',\n 'django.contrib.staticfiles',\n 'django.contrib.humanize',\n 'fedireads',\n 'celery',\n]\n\nMIDDLEWARE = [\n 'django.middleware.security.SecurityMiddleware',\n 'django.contrib.sessions.middleware.SessionMiddleware',\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.clickjacking.XFrameOptionsMiddleware',\n]\n\nROOT_URLCONF = 'fedireads.urls'\n\nTEMPLATES = [\n {\n 'BACKEND': 'django.template.backends.django.DjangoTemplates',\n 'DIRS': ['templates'],\n 'APP_DIRS': True,\n 'OPTIONS': {\n 'context_processors': [\n 'django.template.context_processors.debug',\n 'django.template.context_processors.request',\n 'django.contrib.auth.context_processors.auth',\n 'django.contrib.messages.context_processors.messages',\n ],\n },\n },\n]\n\n\nWSGI_APPLICATION = 'fedireads.wsgi.application'\n\n\n# Database\n# https://docs.djangoproject.com/en/2.0/ref/settings/#databases\n\nFEDIREADS_DATABASE_BACKEND = env('FEDIREADS_DATABASE_BACKEND', 'postgres')\n\nFEDIREADS_DBS = {\n 'postgres': {\n 'ENGINE': 'django.db.backends.postgresql_psycopg2',\n 'NAME': env('POSTGRES_DB', 'fedireads'),\n 'USER': env('POSTGRES_USER', 'fedireads'),\n 'PASSWORD': env('POSTGRES_PASSWORD', 'fedireads'),\n 'HOST': env('POSTGRES_HOST', ''),\n 'PORT': 5432\n },\n 'sqlite': {\n 'ENGINE': 'django.db.backends.sqlite3',\n 'NAME': os.path.join(BASE_DIR, 'fedireads.db')\n }\n}\n\nDATABASES = {\n 'default': FEDIREADS_DBS[FEDIREADS_DATABASE_BACKEND]\n}\n\n\nLOGIN_URL = '/login/'\nAUTH_USER_MODEL = 'fedireads.User'\n\n# Password validation\n# https://docs.djangoproject.com/en/2.0/ref/settings/#auth-password-validators\n\nAUTH_PASSWORD_VALIDATORS = [\n {\n 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',\n },\n {\n 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',\n },\n {\n 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',\n },\n {\n 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',\n },\n]\n\n\n# Internationalization\n# https://docs.djangoproject.com/en/2.0/topics/i18n/\n\nLANGUAGE_CODE = 'en-us'\n\nTIME_ZONE = 'UTC'\n\nUSE_I18N = True\n\nUSE_L10N = True\n\nUSE_TZ = True\n\n\n# Static files (CSS, JavaScript, Images)\n# https://docs.djangoproject.com/en/2.0/howto/static-files/\n\nPROJECT_DIR = os.path.dirname(os.path.abspath(__file__))\nSTATIC_URL = '/static/'\nSTATIC_ROOT = os.path.join(BASE_DIR, env('STATIC_ROOT', 'static'))\nMEDIA_URL = '/images/'\nMEDIA_ROOT = os.path.join(BASE_DIR, env('MEDIA_ROOT', 'images'))\n", "path": "fedireads/settings.py"}]}
| 1,511 | 157 |
gh_patches_debug_614
|
rasdani/github-patches
|
git_diff
|
pex-tool__pex-1547
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Release 2.1.59
On the docket:
+ [x] Add knob for --venv site-packages symlinking. #1543
+ [x] Fix Pex to identify Python 3.10 interpreters. #1545
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `pex/version.py`
Content:
```
1 # Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).
2 # Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4 __version__ = "2.1.58"
5
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/pex/version.py b/pex/version.py
--- a/pex/version.py
+++ b/pex/version.py
@@ -1,4 +1,4 @@
# Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).
-__version__ = "2.1.58"
+__version__ = "2.1.59"
|
{"golden_diff": "diff --git a/pex/version.py b/pex/version.py\n--- a/pex/version.py\n+++ b/pex/version.py\n@@ -1,4 +1,4 @@\n # Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).\n # Licensed under the Apache License, Version 2.0 (see LICENSE).\n \n-__version__ = \"2.1.58\"\n+__version__ = \"2.1.59\"\n", "issue": "Release 2.1.59\nOn the docket:\r\n+ [x] Add knob for --venv site-packages symlinking. #1543\r\n+ [x] Fix Pex to identify Python 3.10 interpreters. #1545 \n", "before_files": [{"content": "# Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).\n# Licensed under the Apache License, Version 2.0 (see LICENSE).\n\n__version__ = \"2.1.58\"\n", "path": "pex/version.py"}], "after_files": [{"content": "# Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).\n# Licensed under the Apache License, Version 2.0 (see LICENSE).\n\n__version__ = \"2.1.59\"\n", "path": "pex/version.py"}]}
| 369 | 96 |
gh_patches_debug_38851
|
rasdani/github-patches
|
git_diff
|
awslabs__gluonts-1515
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Anomaly detection example is not working anymore
## Description
Probably due to code changes, the `anomaly_detecion.py` inside `examples` folder is not working
## To Reproduce
Here's the original code:
```python
if __name__ == "__main__":
dataset = get_dataset(dataset_name="electricity")
estimator = DeepAREstimator(
prediction_length=dataset.metadata.prediction_length,
freq=dataset.metadata.freq,
trainer=Trainer(
learning_rate=1e-3, epochs=50, num_batches_per_epoch=100
),
)
# instead of calling `train` method, we call `train_model` that returns more things including the training model
train_output = estimator.train_model(dataset.train)
# we construct a data_entry that contains 500 random windows
batch_size = 500
num_samples = 100
training_data_loader = TrainDataLoader(
dataset=dataset.train,
transform=train_output.transformation,
batch_size=batch_size,
num_batches_per_epoch=estimator.trainer.num_batches_per_epoch,
ctx=mx.cpu(),
)
for data_entry in islice(training_data_loader, 1):
pass
# we now call the train model to get the predicted distribution on each window
# this allows us to investigate where are the biggest anomalies
context_length = train_output.trained_net.context_length
prediction_length = train_output.trained_net.prediction_length
input_names = get_hybrid_forward_input_names(train_output.trained_net)
distr = train_output.trained_net.distribution(
*[data_entry[k] for k in input_names]
)
# gets all information into numpy array for further plotting
samples = distr.sample(num_samples).asnumpy()
percentiles = np.percentile(samples, axis=0, q=[10.0, 90.0])
target = mx.ndarray.concat(
data_entry["past_target"], data_entry["future_target"], dim=1
)
target = target[:, -(context_length + prediction_length) :]
nll = -distr.log_prob(target).asnumpy()
target = target.asnumpy()
mean = samples.mean(axis=0)
percentiles = np.percentile(samples, axis=0, q=[10.0, 90.0])
# NLL indices from largest to smallest
sorted_indices = np.argsort(nll.reshape(-1))[::-1]
# shows the series and times when the 20 largest NLL were observed
for k in sorted_indices[:20]:
i = k // nll.shape[1]
t = k % nll.shape[1]
time_index = pd.date_range(
pd.Timestamp(data_entry["forecast_start"][i]),
periods=context_length + prediction_length,
)
time_index -= context_length * time_index.freq
plt.figure(figsize=(10, 4))
plt.fill_between(
time_index,
percentiles[0, i],
percentiles[-1, i],
alpha=0.5,
label="80% CI predicted",
)
plt.plot(time_index, target[i], label="target")
plt.axvline(time_index[t], alpha=0.5, color="r")
plt.title(f"NLL: {nll[i, t]}")
plt.legend()
plt.show()
```
I made some changes when trying to run it.
More specifically:
I changed `training_data_loader` (as it now requires `stack_fn` ) to
```python
training_data_loader = TrainDataLoader(
dataset=dataset.train,
transform=train_output.transformation,
batch_size=batch_size,
num_batches_per_epoch=estimator.trainer.num_batches_per_epoch,
stack_fn=partial(batchify,ctx=estimator.trainer.ctx, dtype=estimator.dtype))
```
and added `type` to
```python
input_names = get_hybrid_forward_input_names(type(train_output.trained_net))
```
but I still get error in
```python
distr = train_output.trained_net.distribution(
*[data_entry[k] for k in input_names]
)
```
## Error message or code output
```
KeyError Traceback (most recent call last)
<ipython-input-6-dee0a4a5f14a> in <module>()
38
39 distr = train_output.trained_net.distribution(
---> 40 *[data_entry[k] for k in input_names]
41 )
42
<ipython-input-6-dee0a4a5f14a> in <listcomp>(.0)
38
39 distr = train_output.trained_net.distribution(
---> 40 *[data_entry[k] for k in input_names]
41 )
42
KeyError: 'past_time_feat'
```
Not all names inside `input_names = ['feat_static_cat',
'feat_static_real',
'past_time_feat',
'past_target',
'past_observed_values',
'past_is_pad',
'future_time_feat',
'future_target',
'future_observed_values']` are keys of `data_entry = dict_keys(['start', 'target', 'feat_static_cat', 'item_id', 'source', 'feat_static_real', 'observed_values', 'time_feat'])`
## Environment
- Operating system: Ubuntu
- Python version: 3.7.10
- GluonTS version: 0.7.3
- MXNet version: 1.6
How should I fix it?
Thanks!
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `examples/anomaly_detection.py`
Content:
```
1 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License").
4 # You may not use this file except in compliance with the License.
5 # A copy of the License is located at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # or in the "license" file accompanying this file. This file is distributed
10 # on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
11 # express or implied. See the License for the specific language governing
12 # permissions and limitations under the License.
13
14 """
15 This example shows how to do anomaly detection with DeepAR.
16 The model is first trained and then time-points with the largest negative log-likelihood are plotted.
17 """
18 import numpy as np
19 from itertools import islice
20 import mxnet as mx
21 import matplotlib.pyplot as plt
22 import pandas as pd
23 from pandas.plotting import register_matplotlib_converters
24
25 register_matplotlib_converters()
26
27 from gluonts.dataset.loader import TrainDataLoader
28 from gluonts.model.deepar import DeepAREstimator
29 from gluonts.mx.util import get_hybrid_forward_input_names
30 from gluonts.mx.trainer import Trainer
31 from gluonts.dataset.repository.datasets import get_dataset
32
33
34 if __name__ == "__main__":
35
36 dataset = get_dataset(dataset_name="electricity")
37
38 estimator = DeepAREstimator(
39 prediction_length=dataset.metadata.prediction_length,
40 freq=dataset.metadata.freq,
41 trainer=Trainer(
42 learning_rate=1e-3, epochs=50, num_batches_per_epoch=100
43 ),
44 )
45
46 # instead of calling `train` method, we call `train_model` that returns more things including the training model
47 train_output = estimator.train_model(dataset.train)
48
49 # we construct a data_entry that contains 500 random windows
50 batch_size = 500
51 num_samples = 100
52 training_data_loader = TrainDataLoader(
53 dataset=dataset.train,
54 transform=train_output.transformation,
55 batch_size=batch_size,
56 num_batches_per_epoch=estimator.trainer.num_batches_per_epoch,
57 ctx=mx.cpu(),
58 )
59
60 for data_entry in islice(training_data_loader, 1):
61 pass
62
63 # we now call the train model to get the predicted distribution on each window
64 # this allows us to investigate where are the biggest anomalies
65 context_length = train_output.trained_net.context_length
66 prediction_length = train_output.trained_net.prediction_length
67
68 input_names = get_hybrid_forward_input_names(train_output.trained_net)
69
70 distr = train_output.trained_net.distribution(
71 *[data_entry[k] for k in input_names]
72 )
73
74 # gets all information into numpy array for further plotting
75 samples = distr.sample(num_samples).asnumpy()
76 percentiles = np.percentile(samples, axis=0, q=[10.0, 90.0])
77 target = mx.ndarray.concat(
78 data_entry["past_target"], data_entry["future_target"], dim=1
79 )
80 target = target[:, -(context_length + prediction_length) :]
81 nll = -distr.log_prob(target).asnumpy()
82 target = target.asnumpy()
83 mean = samples.mean(axis=0)
84 percentiles = np.percentile(samples, axis=0, q=[10.0, 90.0])
85
86 # NLL indices from largest to smallest
87 sorted_indices = np.argsort(nll.reshape(-1))[::-1]
88
89 # shows the series and times when the 20 largest NLL were observed
90 for k in sorted_indices[:20]:
91 i = k // nll.shape[1]
92 t = k % nll.shape[1]
93
94 time_index = pd.date_range(
95 pd.Timestamp(data_entry["forecast_start"][i]),
96 periods=context_length + prediction_length,
97 )
98 time_index -= context_length * time_index.freq
99
100 plt.figure(figsize=(10, 4))
101 plt.fill_between(
102 time_index,
103 percentiles[0, i],
104 percentiles[-1, i],
105 alpha=0.5,
106 label="80% CI predicted",
107 )
108 plt.plot(time_index, target[i], label="target")
109 plt.axvline(time_index[t], alpha=0.5, color="r")
110 plt.title(f"NLL: {nll[i, t]}")
111 plt.legend()
112 plt.show()
113
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/examples/anomaly_detection.py b/examples/anomaly_detection.py
--- a/examples/anomaly_detection.py
+++ b/examples/anomaly_detection.py
@@ -17,6 +17,7 @@
"""
import numpy as np
from itertools import islice
+from functools import partial
import mxnet as mx
import matplotlib.pyplot as plt
import pandas as pd
@@ -28,6 +29,7 @@
from gluonts.model.deepar import DeepAREstimator
from gluonts.mx.util import get_hybrid_forward_input_names
from gluonts.mx.trainer import Trainer
+from gluonts.mx.batchify import batchify
from gluonts.dataset.repository.datasets import get_dataset
@@ -39,34 +41,38 @@
prediction_length=dataset.metadata.prediction_length,
freq=dataset.metadata.freq,
trainer=Trainer(
- learning_rate=1e-3, epochs=50, num_batches_per_epoch=100
+ learning_rate=1e-3, epochs=20, num_batches_per_epoch=100
),
)
# instead of calling `train` method, we call `train_model` that returns more things including the training model
train_output = estimator.train_model(dataset.train)
+ input_names = get_hybrid_forward_input_names(
+ type(train_output.trained_net)
+ )
+
# we construct a data_entry that contains 500 random windows
batch_size = 500
num_samples = 100
+ instance_splitter = estimator._create_instance_splitter("training")
training_data_loader = TrainDataLoader(
dataset=dataset.train,
- transform=train_output.transformation,
+ transform=train_output.transformation + instance_splitter,
batch_size=batch_size,
num_batches_per_epoch=estimator.trainer.num_batches_per_epoch,
- ctx=mx.cpu(),
+ stack_fn=partial(
+ batchify, ctx=estimator.trainer.ctx, dtype=estimator.dtype
+ ),
)
- for data_entry in islice(training_data_loader, 1):
- pass
+ data_entry = next(iter(training_data_loader))
# we now call the train model to get the predicted distribution on each window
# this allows us to investigate where are the biggest anomalies
context_length = train_output.trained_net.context_length
prediction_length = train_output.trained_net.prediction_length
- input_names = get_hybrid_forward_input_names(train_output.trained_net)
-
distr = train_output.trained_net.distribution(
*[data_entry[k] for k in input_names]
)
|
{"golden_diff": "diff --git a/examples/anomaly_detection.py b/examples/anomaly_detection.py\n--- a/examples/anomaly_detection.py\n+++ b/examples/anomaly_detection.py\n@@ -17,6 +17,7 @@\n \"\"\"\n import numpy as np\n from itertools import islice\n+from functools import partial\n import mxnet as mx\n import matplotlib.pyplot as plt\n import pandas as pd\n@@ -28,6 +29,7 @@\n from gluonts.model.deepar import DeepAREstimator\n from gluonts.mx.util import get_hybrid_forward_input_names\n from gluonts.mx.trainer import Trainer\n+from gluonts.mx.batchify import batchify\n from gluonts.dataset.repository.datasets import get_dataset\n \n \n@@ -39,34 +41,38 @@\n prediction_length=dataset.metadata.prediction_length,\n freq=dataset.metadata.freq,\n trainer=Trainer(\n- learning_rate=1e-3, epochs=50, num_batches_per_epoch=100\n+ learning_rate=1e-3, epochs=20, num_batches_per_epoch=100\n ),\n )\n \n # instead of calling `train` method, we call `train_model` that returns more things including the training model\n train_output = estimator.train_model(dataset.train)\n \n+ input_names = get_hybrid_forward_input_names(\n+ type(train_output.trained_net)\n+ )\n+\n # we construct a data_entry that contains 500 random windows\n batch_size = 500\n num_samples = 100\n+ instance_splitter = estimator._create_instance_splitter(\"training\")\n training_data_loader = TrainDataLoader(\n dataset=dataset.train,\n- transform=train_output.transformation,\n+ transform=train_output.transformation + instance_splitter,\n batch_size=batch_size,\n num_batches_per_epoch=estimator.trainer.num_batches_per_epoch,\n- ctx=mx.cpu(),\n+ stack_fn=partial(\n+ batchify, ctx=estimator.trainer.ctx, dtype=estimator.dtype\n+ ),\n )\n \n- for data_entry in islice(training_data_loader, 1):\n- pass\n+ data_entry = next(iter(training_data_loader))\n \n # we now call the train model to get the predicted distribution on each window\n # this allows us to investigate where are the biggest anomalies\n context_length = train_output.trained_net.context_length\n prediction_length = train_output.trained_net.prediction_length\n \n- input_names = get_hybrid_forward_input_names(train_output.trained_net)\n-\n distr = train_output.trained_net.distribution(\n *[data_entry[k] for k in input_names]\n )\n", "issue": "Anomaly detection example is not working anymore\n## Description\r\nProbably due to code changes, the `anomaly_detecion.py` inside `examples` folder is not working\r\n## To Reproduce\r\n\r\n\r\nHere's the original code:\r\n\r\n```python\r\nif __name__ == \"__main__\":\r\n\r\n dataset = get_dataset(dataset_name=\"electricity\")\r\n\r\n estimator = DeepAREstimator(\r\n prediction_length=dataset.metadata.prediction_length,\r\n freq=dataset.metadata.freq,\r\n trainer=Trainer(\r\n learning_rate=1e-3, epochs=50, num_batches_per_epoch=100\r\n ),\r\n )\r\n\r\n # instead of calling `train` method, we call `train_model` that returns more things including the training model\r\n train_output = estimator.train_model(dataset.train)\r\n\r\n # we construct a data_entry that contains 500 random windows\r\n batch_size = 500\r\n num_samples = 100\r\n training_data_loader = TrainDataLoader(\r\n dataset=dataset.train,\r\n transform=train_output.transformation,\r\n batch_size=batch_size,\r\n num_batches_per_epoch=estimator.trainer.num_batches_per_epoch,\r\n ctx=mx.cpu(),\r\n )\r\n\r\n for data_entry in islice(training_data_loader, 1):\r\n pass\r\n\r\n # we now call the train model to get the predicted distribution on each window\r\n # this allows us to investigate where are the biggest anomalies\r\n context_length = train_output.trained_net.context_length\r\n prediction_length = train_output.trained_net.prediction_length\r\n\r\n input_names = get_hybrid_forward_input_names(train_output.trained_net)\r\n\r\n distr = train_output.trained_net.distribution(\r\n *[data_entry[k] for k in input_names]\r\n )\r\n\r\n # gets all information into numpy array for further plotting\r\n samples = distr.sample(num_samples).asnumpy()\r\n percentiles = np.percentile(samples, axis=0, q=[10.0, 90.0])\r\n target = mx.ndarray.concat(\r\n data_entry[\"past_target\"], data_entry[\"future_target\"], dim=1\r\n )\r\n target = target[:, -(context_length + prediction_length) :]\r\n nll = -distr.log_prob(target).asnumpy()\r\n target = target.asnumpy()\r\n mean = samples.mean(axis=0)\r\n percentiles = np.percentile(samples, axis=0, q=[10.0, 90.0])\r\n\r\n # NLL indices from largest to smallest\r\n sorted_indices = np.argsort(nll.reshape(-1))[::-1]\r\n\r\n # shows the series and times when the 20 largest NLL were observed\r\n for k in sorted_indices[:20]:\r\n i = k // nll.shape[1]\r\n t = k % nll.shape[1]\r\n\r\n time_index = pd.date_range(\r\n pd.Timestamp(data_entry[\"forecast_start\"][i]),\r\n periods=context_length + prediction_length,\r\n )\r\n time_index -= context_length * time_index.freq\r\n\r\n plt.figure(figsize=(10, 4))\r\n plt.fill_between(\r\n time_index,\r\n percentiles[0, i],\r\n percentiles[-1, i],\r\n alpha=0.5,\r\n label=\"80% CI predicted\",\r\n )\r\n plt.plot(time_index, target[i], label=\"target\")\r\n plt.axvline(time_index[t], alpha=0.5, color=\"r\")\r\n plt.title(f\"NLL: {nll[i, t]}\")\r\n plt.legend()\r\n plt.show()\r\n```\r\n\r\n\r\n\r\n\r\nI made some changes when trying to run it.\r\nMore specifically:\r\n\r\nI changed `training_data_loader` (as it now requires `stack_fn` ) to \r\n\r\n```python\r\n training_data_loader = TrainDataLoader(\r\n dataset=dataset.train, \r\n transform=train_output.transformation, \r\n batch_size=batch_size,\r\n num_batches_per_epoch=estimator.trainer.num_batches_per_epoch,\r\n stack_fn=partial(batchify,ctx=estimator.trainer.ctx, dtype=estimator.dtype))\r\n```\r\n\r\nand added `type` to\r\n\r\n```python\r\ninput_names = get_hybrid_forward_input_names(type(train_output.trained_net))\r\n```\r\n\r\nbut I still get error in \r\n\r\n```python\r\ndistr = train_output.trained_net.distribution(\r\n *[data_entry[k] for k in input_names]\r\n)\r\n```\r\n## Error message or code output\r\n\r\n```\r\nKeyError Traceback (most recent call last)\r\n<ipython-input-6-dee0a4a5f14a> in <module>()\r\n 38 \r\n 39 distr = train_output.trained_net.distribution(\r\n---> 40 *[data_entry[k] for k in input_names]\r\n 41 )\r\n 42 \r\n\r\n<ipython-input-6-dee0a4a5f14a> in <listcomp>(.0)\r\n 38 \r\n 39 distr = train_output.trained_net.distribution(\r\n---> 40 *[data_entry[k] for k in input_names]\r\n 41 )\r\n 42 \r\n\r\nKeyError: 'past_time_feat'\r\n```\r\n\r\nNot all names inside `input_names = ['feat_static_cat',\r\n 'feat_static_real',\r\n 'past_time_feat',\r\n 'past_target',\r\n 'past_observed_values',\r\n 'past_is_pad',\r\n 'future_time_feat',\r\n 'future_target',\r\n 'future_observed_values']` are keys of `data_entry = dict_keys(['start', 'target', 'feat_static_cat', 'item_id', 'source', 'feat_static_real', 'observed_values', 'time_feat'])` \r\n\r\n\r\n## Environment\r\n- Operating system: Ubuntu\r\n- Python version: 3.7.10\r\n- GluonTS version: 0.7.3\r\n- MXNet version: 1.6\r\n\r\nHow should I fix it?\r\nThanks!\r\n\n", "before_files": [{"content": "# Copyright 2018 Amazon.com, Inc. or its affiliates. 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# A copy of the License is located at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# or in the \"license\" file accompanying this file. This file is distributed\n# on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either\n# express or implied. See the License for the specific language governing\n# permissions and limitations under the License.\n\n\"\"\"\nThis example shows how to do anomaly detection with DeepAR.\nThe model is first trained and then time-points with the largest negative log-likelihood are plotted.\n\"\"\"\nimport numpy as np\nfrom itertools import islice\nimport mxnet as mx\nimport matplotlib.pyplot as plt\nimport pandas as pd\nfrom pandas.plotting import register_matplotlib_converters\n\nregister_matplotlib_converters()\n\nfrom gluonts.dataset.loader import TrainDataLoader\nfrom gluonts.model.deepar import DeepAREstimator\nfrom gluonts.mx.util import get_hybrid_forward_input_names\nfrom gluonts.mx.trainer import Trainer\nfrom gluonts.dataset.repository.datasets import get_dataset\n\n\nif __name__ == \"__main__\":\n\n dataset = get_dataset(dataset_name=\"electricity\")\n\n estimator = DeepAREstimator(\n prediction_length=dataset.metadata.prediction_length,\n freq=dataset.metadata.freq,\n trainer=Trainer(\n learning_rate=1e-3, epochs=50, num_batches_per_epoch=100\n ),\n )\n\n # instead of calling `train` method, we call `train_model` that returns more things including the training model\n train_output = estimator.train_model(dataset.train)\n\n # we construct a data_entry that contains 500 random windows\n batch_size = 500\n num_samples = 100\n training_data_loader = TrainDataLoader(\n dataset=dataset.train,\n transform=train_output.transformation,\n batch_size=batch_size,\n num_batches_per_epoch=estimator.trainer.num_batches_per_epoch,\n ctx=mx.cpu(),\n )\n\n for data_entry in islice(training_data_loader, 1):\n pass\n\n # we now call the train model to get the predicted distribution on each window\n # this allows us to investigate where are the biggest anomalies\n context_length = train_output.trained_net.context_length\n prediction_length = train_output.trained_net.prediction_length\n\n input_names = get_hybrid_forward_input_names(train_output.trained_net)\n\n distr = train_output.trained_net.distribution(\n *[data_entry[k] for k in input_names]\n )\n\n # gets all information into numpy array for further plotting\n samples = distr.sample(num_samples).asnumpy()\n percentiles = np.percentile(samples, axis=0, q=[10.0, 90.0])\n target = mx.ndarray.concat(\n data_entry[\"past_target\"], data_entry[\"future_target\"], dim=1\n )\n target = target[:, -(context_length + prediction_length) :]\n nll = -distr.log_prob(target).asnumpy()\n target = target.asnumpy()\n mean = samples.mean(axis=0)\n percentiles = np.percentile(samples, axis=0, q=[10.0, 90.0])\n\n # NLL indices from largest to smallest\n sorted_indices = np.argsort(nll.reshape(-1))[::-1]\n\n # shows the series and times when the 20 largest NLL were observed\n for k in sorted_indices[:20]:\n i = k // nll.shape[1]\n t = k % nll.shape[1]\n\n time_index = pd.date_range(\n pd.Timestamp(data_entry[\"forecast_start\"][i]),\n periods=context_length + prediction_length,\n )\n time_index -= context_length * time_index.freq\n\n plt.figure(figsize=(10, 4))\n plt.fill_between(\n time_index,\n percentiles[0, i],\n percentiles[-1, i],\n alpha=0.5,\n label=\"80% CI predicted\",\n )\n plt.plot(time_index, target[i], label=\"target\")\n plt.axvline(time_index[t], alpha=0.5, color=\"r\")\n plt.title(f\"NLL: {nll[i, t]}\")\n plt.legend()\n plt.show()\n", "path": "examples/anomaly_detection.py"}], "after_files": [{"content": "# Copyright 2018 Amazon.com, Inc. or its affiliates. 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# A copy of the License is located at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# or in the \"license\" file accompanying this file. This file is distributed\n# on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either\n# express or implied. See the License for the specific language governing\n# permissions and limitations under the License.\n\n\"\"\"\nThis example shows how to do anomaly detection with DeepAR.\nThe model is first trained and then time-points with the largest negative log-likelihood are plotted.\n\"\"\"\nimport numpy as np\nfrom itertools import islice\nfrom functools import partial\nimport mxnet as mx\nimport matplotlib.pyplot as plt\nimport pandas as pd\nfrom pandas.plotting import register_matplotlib_converters\n\nregister_matplotlib_converters()\n\nfrom gluonts.dataset.loader import TrainDataLoader\nfrom gluonts.model.deepar import DeepAREstimator\nfrom gluonts.mx.util import get_hybrid_forward_input_names\nfrom gluonts.mx.trainer import Trainer\nfrom gluonts.mx.batchify import batchify\nfrom gluonts.dataset.repository.datasets import get_dataset\n\n\nif __name__ == \"__main__\":\n\n dataset = get_dataset(dataset_name=\"electricity\")\n\n estimator = DeepAREstimator(\n prediction_length=dataset.metadata.prediction_length,\n freq=dataset.metadata.freq,\n trainer=Trainer(\n learning_rate=1e-3, epochs=20, num_batches_per_epoch=100\n ),\n )\n\n # instead of calling `train` method, we call `train_model` that returns more things including the training model\n train_output = estimator.train_model(dataset.train)\n\n input_names = get_hybrid_forward_input_names(\n type(train_output.trained_net)\n )\n\n # we construct a data_entry that contains 500 random windows\n batch_size = 500\n num_samples = 100\n instance_splitter = estimator._create_instance_splitter(\"training\")\n training_data_loader = TrainDataLoader(\n dataset=dataset.train,\n transform=train_output.transformation + instance_splitter,\n batch_size=batch_size,\n num_batches_per_epoch=estimator.trainer.num_batches_per_epoch,\n stack_fn=partial(\n batchify, ctx=estimator.trainer.ctx, dtype=estimator.dtype\n ),\n )\n\n data_entry = next(iter(training_data_loader))\n\n # we now call the train model to get the predicted distribution on each window\n # this allows us to investigate where are the biggest anomalies\n context_length = train_output.trained_net.context_length\n prediction_length = train_output.trained_net.prediction_length\n\n distr = train_output.trained_net.distribution(\n *[data_entry[k] for k in input_names]\n )\n\n # gets all information into numpy array for further plotting\n samples = distr.sample(num_samples).asnumpy()\n percentiles = np.percentile(samples, axis=0, q=[10.0, 90.0])\n target = mx.ndarray.concat(\n data_entry[\"past_target\"], data_entry[\"future_target\"], dim=1\n )\n target = target[:, -(context_length + prediction_length) :]\n nll = -distr.log_prob(target).asnumpy()\n target = target.asnumpy()\n mean = samples.mean(axis=0)\n percentiles = np.percentile(samples, axis=0, q=[10.0, 90.0])\n\n # NLL indices from largest to smallest\n sorted_indices = np.argsort(nll.reshape(-1))[::-1]\n\n # shows the series and times when the 20 largest NLL were observed\n for k in sorted_indices[:20]:\n i = k // nll.shape[1]\n t = k % nll.shape[1]\n\n time_index = pd.date_range(\n pd.Timestamp(data_entry[\"forecast_start\"][i]),\n periods=context_length + prediction_length,\n )\n time_index -= context_length * time_index.freq\n\n plt.figure(figsize=(10, 4))\n plt.fill_between(\n time_index,\n percentiles[0, i],\n percentiles[-1, i],\n alpha=0.5,\n label=\"80% CI predicted\",\n )\n plt.plot(time_index, target[i], label=\"target\")\n plt.axvline(time_index[t], alpha=0.5, color=\"r\")\n plt.title(f\"NLL: {nll[i, t]}\")\n plt.legend()\n plt.show()\n", "path": "examples/anomaly_detection.py"}]}
| 2,687 | 576 |
gh_patches_debug_7913
|
rasdani/github-patches
|
git_diff
|
liqd__a4-opin-684
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Change sorting order on organization page
We currently sort projects on the organization pages from oldest to newest (date of creation). We should reverse the order, so that new projects are shown first.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `euth/organisations/views.py`
Content:
```
1 from django.views import generic
2
3 from . import models
4
5
6 class OrganisationDetailView(generic.DetailView):
7 model = models.Organisation
8
9 def visible_projects(self):
10 if self.request.user in self.object.initiators.all():
11 return self.object.project_set.all()
12 else:
13 return self.object.project_set.filter(is_draft=False)
14
15
16 class OrganisationListView(generic.ListView):
17 model = models.Organisation
18 paginate_by = 12
19
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/euth/organisations/views.py b/euth/organisations/views.py
--- a/euth/organisations/views.py
+++ b/euth/organisations/views.py
@@ -7,10 +7,11 @@
model = models.Organisation
def visible_projects(self):
+ projects = self.object.project_set.order_by('-created')
if self.request.user in self.object.initiators.all():
- return self.object.project_set.all()
+ return projects.all()
else:
- return self.object.project_set.filter(is_draft=False)
+ return projects.filter(is_draft=False)
class OrganisationListView(generic.ListView):
|
{"golden_diff": "diff --git a/euth/organisations/views.py b/euth/organisations/views.py\n--- a/euth/organisations/views.py\n+++ b/euth/organisations/views.py\n@@ -7,10 +7,11 @@\n model = models.Organisation\n \n def visible_projects(self):\n+ projects = self.object.project_set.order_by('-created')\n if self.request.user in self.object.initiators.all():\n- return self.object.project_set.all()\n+ return projects.all()\n else:\n- return self.object.project_set.filter(is_draft=False)\n+ return projects.filter(is_draft=False)\n \n \n class OrganisationListView(generic.ListView):\n", "issue": "Change sorting order on organization page\nWe currently sort projects on the organization pages from oldest to newest (date of creation). We should reverse the order, so that new projects are shown first.\n", "before_files": [{"content": "from django.views import generic\n\nfrom . import models\n\n\nclass OrganisationDetailView(generic.DetailView):\n model = models.Organisation\n\n def visible_projects(self):\n if self.request.user in self.object.initiators.all():\n return self.object.project_set.all()\n else:\n return self.object.project_set.filter(is_draft=False)\n\n\nclass OrganisationListView(generic.ListView):\n model = models.Organisation\n paginate_by = 12\n", "path": "euth/organisations/views.py"}], "after_files": [{"content": "from django.views import generic\n\nfrom . import models\n\n\nclass OrganisationDetailView(generic.DetailView):\n model = models.Organisation\n\n def visible_projects(self):\n projects = self.object.project_set.order_by('-created')\n if self.request.user in self.object.initiators.all():\n return projects.all()\n else:\n return projects.filter(is_draft=False)\n\n\nclass OrganisationListView(generic.ListView):\n model = models.Organisation\n paginate_by = 12\n", "path": "euth/organisations/views.py"}]}
| 424 | 138 |
gh_patches_debug_28631
|
rasdani/github-patches
|
git_diff
|
google__mobly-517
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
`logger._setup_test_logger` has unused param
The `filename` param is not used.
Let's remove it
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `mobly/logger.py`
Content:
```
1 # Copyright 2016 Google Inc.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 from __future__ import print_function
16
17 import datetime
18 import logging
19 import os
20 import re
21 import sys
22
23 from mobly import records
24 from mobly import utils
25
26 log_line_format = '%(asctime)s.%(msecs).03d %(levelname)s %(message)s'
27 # The micro seconds are added by the format string above,
28 # so the time format does not include ms.
29 log_line_time_format = '%m-%d %H:%M:%S'
30 log_line_timestamp_len = 18
31
32 logline_timestamp_re = re.compile('\d\d-\d\d \d\d:\d\d:\d\d.\d\d\d')
33
34
35 def _parse_logline_timestamp(t):
36 """Parses a logline timestamp into a tuple.
37
38 Args:
39 t: Timestamp in logline format.
40
41 Returns:
42 An iterable of date and time elements in the order of month, day, hour,
43 minute, second, microsecond.
44 """
45 date, time = t.split(' ')
46 month, day = date.split('-')
47 h, m, s = time.split(':')
48 s, ms = s.split('.')
49 return (month, day, h, m, s, ms)
50
51
52 def is_valid_logline_timestamp(timestamp):
53 if len(timestamp) == log_line_timestamp_len:
54 if logline_timestamp_re.match(timestamp):
55 return True
56 return False
57
58
59 def logline_timestamp_comparator(t1, t2):
60 """Comparator for timestamps in logline format.
61
62 Args:
63 t1: Timestamp in logline format.
64 t2: Timestamp in logline format.
65
66 Returns:
67 -1 if t1 < t2; 1 if t1 > t2; 0 if t1 == t2.
68 """
69 dt1 = _parse_logline_timestamp(t1)
70 dt2 = _parse_logline_timestamp(t2)
71 for u1, u2 in zip(dt1, dt2):
72 if u1 < u2:
73 return -1
74 elif u1 > u2:
75 return 1
76 return 0
77
78
79 def _get_timestamp(time_format, delta=None):
80 t = datetime.datetime.now()
81 if delta:
82 t = t + datetime.timedelta(seconds=delta)
83 return t.strftime(time_format)[:-3]
84
85
86 def epoch_to_log_line_timestamp(epoch_time, time_zone=None):
87 """Converts an epoch timestamp in ms to log line timestamp format, which
88 is readible for humans.
89
90 Args:
91 epoch_time: integer, an epoch timestamp in ms.
92 time_zone: instance of tzinfo, time zone information.
93 Using pytz rather than python 3.2 time_zone implementation for
94 python 2 compatibility reasons.
95
96 Returns:
97 A string that is the corresponding timestamp in log line timestamp
98 format.
99 """
100 s, ms = divmod(epoch_time, 1000)
101 d = datetime.datetime.fromtimestamp(s, tz=time_zone)
102 return d.strftime('%m-%d %H:%M:%S.') + str(ms)
103
104
105 def get_log_line_timestamp(delta=None):
106 """Returns a timestamp in the format used by log lines.
107
108 Default is current time. If a delta is set, the return value will be
109 the current time offset by delta seconds.
110
111 Args:
112 delta: Number of seconds to offset from current time; can be negative.
113
114 Returns:
115 A timestamp in log line format with an offset.
116 """
117 return _get_timestamp('%m-%d %H:%M:%S.%f', delta)
118
119
120 def get_log_file_timestamp(delta=None):
121 """Returns a timestamp in the format used for log file names.
122
123 Default is current time. If a delta is set, the return value will be
124 the current time offset by delta seconds.
125
126 Args:
127 delta: Number of seconds to offset from current time; can be negative.
128
129 Returns:
130 A timestamp in log filen name format with an offset.
131 """
132 return _get_timestamp('%m-%d-%Y_%H-%M-%S-%f', delta)
133
134
135 def _setup_test_logger(log_path, prefix=None, filename=None):
136 """Customizes the root logger for a test run.
137
138 The logger object has a stream handler and a file handler. The stream
139 handler logs INFO level to the terminal, the file handler logs DEBUG
140 level to files.
141
142 Args:
143 log_path: Location of the log file.
144 prefix: A prefix for each log line in terminal.
145 filename: Name of the log file. The default is the time the logger
146 is requested.
147 """
148 log = logging.getLogger()
149 kill_test_logger(log)
150 log.propagate = False
151 log.setLevel(logging.DEBUG)
152 # Log info to stream
153 terminal_format = log_line_format
154 if prefix:
155 terminal_format = '[%s] %s' % (prefix, log_line_format)
156 c_formatter = logging.Formatter(terminal_format, log_line_time_format)
157 ch = logging.StreamHandler(sys.stdout)
158 ch.setFormatter(c_formatter)
159 ch.setLevel(logging.INFO)
160 # Log everything to file
161 f_formatter = logging.Formatter(log_line_format, log_line_time_format)
162 # All the logs of this test class go into one directory
163 if filename is None:
164 filename = get_log_file_timestamp()
165 utils.create_dir(log_path)
166 # Write logger output to files
167 fh_info = logging.FileHandler(
168 os.path.join(log_path, records.OUTPUT_FILE_INFO_LOG))
169 fh_info.setFormatter(f_formatter)
170 fh_info.setLevel(logging.INFO)
171 fh_debug = logging.FileHandler(
172 os.path.join(log_path, records.OUTPUT_FILE_DEBUG_LOG))
173 fh_debug.setFormatter(f_formatter)
174 fh_debug.setLevel(logging.DEBUG)
175 log.addHandler(ch)
176 log.addHandler(fh_info)
177 log.addHandler(fh_debug)
178 log.log_path = log_path
179 logging.log_path = log_path
180
181
182 def kill_test_logger(logger):
183 """Cleans up a test logger object by removing all of its handlers.
184
185 Args:
186 logger: The logging object to clean up.
187 """
188 for h in list(logger.handlers):
189 logger.removeHandler(h)
190 if isinstance(h, logging.FileHandler):
191 h.close()
192
193
194 def create_latest_log_alias(actual_path):
195 """Creates a symlink to the latest test run logs.
196
197 Args:
198 actual_path: The source directory where the latest test run's logs are.
199 """
200 alias_path = os.path.join(os.path.dirname(actual_path), 'latest')
201 utils.create_alias(actual_path, alias_path)
202
203
204 def setup_test_logger(log_path, prefix=None, filename=None):
205 """Customizes the root logger for a test run.
206
207 Args:
208 log_path: Location of the report file.
209 prefix: A prefix for each log line in terminal.
210 filename: Name of the files. The default is the time the objects
211 are requested.
212 """
213 if filename is None:
214 filename = get_log_file_timestamp()
215 utils.create_dir(log_path)
216 _setup_test_logger(log_path, prefix, filename)
217 logging.info('Test output folder: "%s"', log_path)
218 create_latest_log_alias(log_path)
219
220
221 def normalize_log_line_timestamp(log_line_timestamp):
222 """Replace special characters in log line timestamp with normal characters.
223
224 Args:
225 log_line_timestamp: A string in the log line timestamp format. Obtained
226 with get_log_line_timestamp.
227
228 Returns:
229 A string representing the same time as input timestamp, but without
230 special characters.
231 """
232 norm_tp = log_line_timestamp.replace(' ', '_')
233 norm_tp = norm_tp.replace(':', '-')
234 return norm_tp
235
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/mobly/logger.py b/mobly/logger.py
--- a/mobly/logger.py
+++ b/mobly/logger.py
@@ -132,7 +132,7 @@
return _get_timestamp('%m-%d-%Y_%H-%M-%S-%f', delta)
-def _setup_test_logger(log_path, prefix=None, filename=None):
+def _setup_test_logger(log_path, prefix=None):
"""Customizes the root logger for a test run.
The logger object has a stream handler and a file handler. The stream
@@ -159,10 +159,6 @@
ch.setLevel(logging.INFO)
# Log everything to file
f_formatter = logging.Formatter(log_line_format, log_line_time_format)
- # All the logs of this test class go into one directory
- if filename is None:
- filename = get_log_file_timestamp()
- utils.create_dir(log_path)
# Write logger output to files
fh_info = logging.FileHandler(
os.path.join(log_path, records.OUTPUT_FILE_INFO_LOG))
@@ -210,10 +206,8 @@
filename: Name of the files. The default is the time the objects
are requested.
"""
- if filename is None:
- filename = get_log_file_timestamp()
utils.create_dir(log_path)
- _setup_test_logger(log_path, prefix, filename)
+ _setup_test_logger(log_path, prefix)
logging.info('Test output folder: "%s"', log_path)
create_latest_log_alias(log_path)
|
{"golden_diff": "diff --git a/mobly/logger.py b/mobly/logger.py\n--- a/mobly/logger.py\n+++ b/mobly/logger.py\n@@ -132,7 +132,7 @@\n return _get_timestamp('%m-%d-%Y_%H-%M-%S-%f', delta)\n \n \n-def _setup_test_logger(log_path, prefix=None, filename=None):\n+def _setup_test_logger(log_path, prefix=None):\n \"\"\"Customizes the root logger for a test run.\n \n The logger object has a stream handler and a file handler. The stream\n@@ -159,10 +159,6 @@\n ch.setLevel(logging.INFO)\n # Log everything to file\n f_formatter = logging.Formatter(log_line_format, log_line_time_format)\n- # All the logs of this test class go into one directory\n- if filename is None:\n- filename = get_log_file_timestamp()\n- utils.create_dir(log_path)\n # Write logger output to files\n fh_info = logging.FileHandler(\n os.path.join(log_path, records.OUTPUT_FILE_INFO_LOG))\n@@ -210,10 +206,8 @@\n filename: Name of the files. The default is the time the objects\n are requested.\n \"\"\"\n- if filename is None:\n- filename = get_log_file_timestamp()\n utils.create_dir(log_path)\n- _setup_test_logger(log_path, prefix, filename)\n+ _setup_test_logger(log_path, prefix)\n logging.info('Test output folder: \"%s\"', log_path)\n create_latest_log_alias(log_path)\n", "issue": "`logger._setup_test_logger` has unused param\nThe `filename` param is not used.\r\nLet's remove it\n", "before_files": [{"content": "# Copyright 2016 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\nfrom __future__ import print_function\n\nimport datetime\nimport logging\nimport os\nimport re\nimport sys\n\nfrom mobly import records\nfrom mobly import utils\n\nlog_line_format = '%(asctime)s.%(msecs).03d %(levelname)s %(message)s'\n# The micro seconds are added by the format string above,\n# so the time format does not include ms.\nlog_line_time_format = '%m-%d %H:%M:%S'\nlog_line_timestamp_len = 18\n\nlogline_timestamp_re = re.compile('\\d\\d-\\d\\d \\d\\d:\\d\\d:\\d\\d.\\d\\d\\d')\n\n\ndef _parse_logline_timestamp(t):\n \"\"\"Parses a logline timestamp into a tuple.\n\n Args:\n t: Timestamp in logline format.\n\n Returns:\n An iterable of date and time elements in the order of month, day, hour,\n minute, second, microsecond.\n \"\"\"\n date, time = t.split(' ')\n month, day = date.split('-')\n h, m, s = time.split(':')\n s, ms = s.split('.')\n return (month, day, h, m, s, ms)\n\n\ndef is_valid_logline_timestamp(timestamp):\n if len(timestamp) == log_line_timestamp_len:\n if logline_timestamp_re.match(timestamp):\n return True\n return False\n\n\ndef logline_timestamp_comparator(t1, t2):\n \"\"\"Comparator for timestamps in logline format.\n\n Args:\n t1: Timestamp in logline format.\n t2: Timestamp in logline format.\n\n Returns:\n -1 if t1 < t2; 1 if t1 > t2; 0 if t1 == t2.\n \"\"\"\n dt1 = _parse_logline_timestamp(t1)\n dt2 = _parse_logline_timestamp(t2)\n for u1, u2 in zip(dt1, dt2):\n if u1 < u2:\n return -1\n elif u1 > u2:\n return 1\n return 0\n\n\ndef _get_timestamp(time_format, delta=None):\n t = datetime.datetime.now()\n if delta:\n t = t + datetime.timedelta(seconds=delta)\n return t.strftime(time_format)[:-3]\n\n\ndef epoch_to_log_line_timestamp(epoch_time, time_zone=None):\n \"\"\"Converts an epoch timestamp in ms to log line timestamp format, which\n is readible for humans.\n\n Args:\n epoch_time: integer, an epoch timestamp in ms.\n time_zone: instance of tzinfo, time zone information.\n Using pytz rather than python 3.2 time_zone implementation for\n python 2 compatibility reasons.\n\n Returns:\n A string that is the corresponding timestamp in log line timestamp\n format.\n \"\"\"\n s, ms = divmod(epoch_time, 1000)\n d = datetime.datetime.fromtimestamp(s, tz=time_zone)\n return d.strftime('%m-%d %H:%M:%S.') + str(ms)\n\n\ndef get_log_line_timestamp(delta=None):\n \"\"\"Returns a timestamp in the format used by log lines.\n\n Default is current time. If a delta is set, the return value will be\n the current time offset by delta seconds.\n\n Args:\n delta: Number of seconds to offset from current time; can be negative.\n\n Returns:\n A timestamp in log line format with an offset.\n \"\"\"\n return _get_timestamp('%m-%d %H:%M:%S.%f', delta)\n\n\ndef get_log_file_timestamp(delta=None):\n \"\"\"Returns a timestamp in the format used for log file names.\n\n Default is current time. If a delta is set, the return value will be\n the current time offset by delta seconds.\n\n Args:\n delta: Number of seconds to offset from current time; can be negative.\n\n Returns:\n A timestamp in log filen name format with an offset.\n \"\"\"\n return _get_timestamp('%m-%d-%Y_%H-%M-%S-%f', delta)\n\n\ndef _setup_test_logger(log_path, prefix=None, filename=None):\n \"\"\"Customizes the root logger for a test run.\n\n The logger object has a stream handler and a file handler. The stream\n handler logs INFO level to the terminal, the file handler logs DEBUG\n level to files.\n\n Args:\n log_path: Location of the log file.\n prefix: A prefix for each log line in terminal.\n filename: Name of the log file. The default is the time the logger\n is requested.\n \"\"\"\n log = logging.getLogger()\n kill_test_logger(log)\n log.propagate = False\n log.setLevel(logging.DEBUG)\n # Log info to stream\n terminal_format = log_line_format\n if prefix:\n terminal_format = '[%s] %s' % (prefix, log_line_format)\n c_formatter = logging.Formatter(terminal_format, log_line_time_format)\n ch = logging.StreamHandler(sys.stdout)\n ch.setFormatter(c_formatter)\n ch.setLevel(logging.INFO)\n # Log everything to file\n f_formatter = logging.Formatter(log_line_format, log_line_time_format)\n # All the logs of this test class go into one directory\n if filename is None:\n filename = get_log_file_timestamp()\n utils.create_dir(log_path)\n # Write logger output to files\n fh_info = logging.FileHandler(\n os.path.join(log_path, records.OUTPUT_FILE_INFO_LOG))\n fh_info.setFormatter(f_formatter)\n fh_info.setLevel(logging.INFO)\n fh_debug = logging.FileHandler(\n os.path.join(log_path, records.OUTPUT_FILE_DEBUG_LOG))\n fh_debug.setFormatter(f_formatter)\n fh_debug.setLevel(logging.DEBUG)\n log.addHandler(ch)\n log.addHandler(fh_info)\n log.addHandler(fh_debug)\n log.log_path = log_path\n logging.log_path = log_path\n\n\ndef kill_test_logger(logger):\n \"\"\"Cleans up a test logger object by removing all of its handlers.\n\n Args:\n logger: The logging object to clean up.\n \"\"\"\n for h in list(logger.handlers):\n logger.removeHandler(h)\n if isinstance(h, logging.FileHandler):\n h.close()\n\n\ndef create_latest_log_alias(actual_path):\n \"\"\"Creates a symlink to the latest test run logs.\n\n Args:\n actual_path: The source directory where the latest test run's logs are.\n \"\"\"\n alias_path = os.path.join(os.path.dirname(actual_path), 'latest')\n utils.create_alias(actual_path, alias_path)\n\n\ndef setup_test_logger(log_path, prefix=None, filename=None):\n \"\"\"Customizes the root logger for a test run.\n\n Args:\n log_path: Location of the report file.\n prefix: A prefix for each log line in terminal.\n filename: Name of the files. The default is the time the objects\n are requested.\n \"\"\"\n if filename is None:\n filename = get_log_file_timestamp()\n utils.create_dir(log_path)\n _setup_test_logger(log_path, prefix, filename)\n logging.info('Test output folder: \"%s\"', log_path)\n create_latest_log_alias(log_path)\n\n\ndef normalize_log_line_timestamp(log_line_timestamp):\n \"\"\"Replace special characters in log line timestamp with normal characters.\n\n Args:\n log_line_timestamp: A string in the log line timestamp format. Obtained\n with get_log_line_timestamp.\n\n Returns:\n A string representing the same time as input timestamp, but without\n special characters.\n \"\"\"\n norm_tp = log_line_timestamp.replace(' ', '_')\n norm_tp = norm_tp.replace(':', '-')\n return norm_tp\n", "path": "mobly/logger.py"}], "after_files": [{"content": "# Copyright 2016 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\nfrom __future__ import print_function\n\nimport datetime\nimport logging\nimport os\nimport re\nimport sys\n\nfrom mobly import records\nfrom mobly import utils\n\nlog_line_format = '%(asctime)s.%(msecs).03d %(levelname)s %(message)s'\n# The micro seconds are added by the format string above,\n# so the time format does not include ms.\nlog_line_time_format = '%m-%d %H:%M:%S'\nlog_line_timestamp_len = 18\n\nlogline_timestamp_re = re.compile('\\d\\d-\\d\\d \\d\\d:\\d\\d:\\d\\d.\\d\\d\\d')\n\n\ndef _parse_logline_timestamp(t):\n \"\"\"Parses a logline timestamp into a tuple.\n\n Args:\n t: Timestamp in logline format.\n\n Returns:\n An iterable of date and time elements in the order of month, day, hour,\n minute, second, microsecond.\n \"\"\"\n date, time = t.split(' ')\n month, day = date.split('-')\n h, m, s = time.split(':')\n s, ms = s.split('.')\n return (month, day, h, m, s, ms)\n\n\ndef is_valid_logline_timestamp(timestamp):\n if len(timestamp) == log_line_timestamp_len:\n if logline_timestamp_re.match(timestamp):\n return True\n return False\n\n\ndef logline_timestamp_comparator(t1, t2):\n \"\"\"Comparator for timestamps in logline format.\n\n Args:\n t1: Timestamp in logline format.\n t2: Timestamp in logline format.\n\n Returns:\n -1 if t1 < t2; 1 if t1 > t2; 0 if t1 == t2.\n \"\"\"\n dt1 = _parse_logline_timestamp(t1)\n dt2 = _parse_logline_timestamp(t2)\n for u1, u2 in zip(dt1, dt2):\n if u1 < u2:\n return -1\n elif u1 > u2:\n return 1\n return 0\n\n\ndef _get_timestamp(time_format, delta=None):\n t = datetime.datetime.now()\n if delta:\n t = t + datetime.timedelta(seconds=delta)\n return t.strftime(time_format)[:-3]\n\n\ndef epoch_to_log_line_timestamp(epoch_time, time_zone=None):\n \"\"\"Converts an epoch timestamp in ms to log line timestamp format, which\n is readible for humans.\n\n Args:\n epoch_time: integer, an epoch timestamp in ms.\n time_zone: instance of tzinfo, time zone information.\n Using pytz rather than python 3.2 time_zone implementation for\n python 2 compatibility reasons.\n\n Returns:\n A string that is the corresponding timestamp in log line timestamp\n format.\n \"\"\"\n s, ms = divmod(epoch_time, 1000)\n d = datetime.datetime.fromtimestamp(s, tz=time_zone)\n return d.strftime('%m-%d %H:%M:%S.') + str(ms)\n\n\ndef get_log_line_timestamp(delta=None):\n \"\"\"Returns a timestamp in the format used by log lines.\n\n Default is current time. If a delta is set, the return value will be\n the current time offset by delta seconds.\n\n Args:\n delta: Number of seconds to offset from current time; can be negative.\n\n Returns:\n A timestamp in log line format with an offset.\n \"\"\"\n return _get_timestamp('%m-%d %H:%M:%S.%f', delta)\n\n\ndef get_log_file_timestamp(delta=None):\n \"\"\"Returns a timestamp in the format used for log file names.\n\n Default is current time. If a delta is set, the return value will be\n the current time offset by delta seconds.\n\n Args:\n delta: Number of seconds to offset from current time; can be negative.\n\n Returns:\n A timestamp in log filen name format with an offset.\n \"\"\"\n return _get_timestamp('%m-%d-%Y_%H-%M-%S-%f', delta)\n\n\ndef _setup_test_logger(log_path, prefix=None):\n \"\"\"Customizes the root logger for a test run.\n\n The logger object has a stream handler and a file handler. The stream\n handler logs INFO level to the terminal, the file handler logs DEBUG\n level to files.\n\n Args:\n log_path: Location of the log file.\n prefix: A prefix for each log line in terminal.\n filename: Name of the log file. The default is the time the logger\n is requested.\n \"\"\"\n log = logging.getLogger()\n kill_test_logger(log)\n log.propagate = False\n log.setLevel(logging.DEBUG)\n # Log info to stream\n terminal_format = log_line_format\n if prefix:\n terminal_format = '[%s] %s' % (prefix, log_line_format)\n c_formatter = logging.Formatter(terminal_format, log_line_time_format)\n ch = logging.StreamHandler(sys.stdout)\n ch.setFormatter(c_formatter)\n ch.setLevel(logging.INFO)\n # Log everything to file\n f_formatter = logging.Formatter(log_line_format, log_line_time_format)\n # Write logger output to files\n fh_info = logging.FileHandler(\n os.path.join(log_path, records.OUTPUT_FILE_INFO_LOG))\n fh_info.setFormatter(f_formatter)\n fh_info.setLevel(logging.INFO)\n fh_debug = logging.FileHandler(\n os.path.join(log_path, records.OUTPUT_FILE_DEBUG_LOG))\n fh_debug.setFormatter(f_formatter)\n fh_debug.setLevel(logging.DEBUG)\n log.addHandler(ch)\n log.addHandler(fh_info)\n log.addHandler(fh_debug)\n log.log_path = log_path\n logging.log_path = log_path\n\n\ndef kill_test_logger(logger):\n \"\"\"Cleans up a test logger object by removing all of its handlers.\n\n Args:\n logger: The logging object to clean up.\n \"\"\"\n for h in list(logger.handlers):\n logger.removeHandler(h)\n if isinstance(h, logging.FileHandler):\n h.close()\n\n\ndef create_latest_log_alias(actual_path):\n \"\"\"Creates a symlink to the latest test run logs.\n\n Args:\n actual_path: The source directory where the latest test run's logs are.\n \"\"\"\n alias_path = os.path.join(os.path.dirname(actual_path), 'latest')\n utils.create_alias(actual_path, alias_path)\n\n\ndef setup_test_logger(log_path, prefix=None, filename=None):\n \"\"\"Customizes the root logger for a test run.\n\n Args:\n log_path: Location of the report file.\n prefix: A prefix for each log line in terminal.\n filename: Name of the files. The default is the time the objects\n are requested.\n \"\"\"\n utils.create_dir(log_path)\n _setup_test_logger(log_path, prefix)\n logging.info('Test output folder: \"%s\"', log_path)\n create_latest_log_alias(log_path)\n\n\ndef normalize_log_line_timestamp(log_line_timestamp):\n \"\"\"Replace special characters in log line timestamp with normal characters.\n\n Args:\n log_line_timestamp: A string in the log line timestamp format. Obtained\n with get_log_line_timestamp.\n\n Returns:\n A string representing the same time as input timestamp, but without\n special characters.\n \"\"\"\n norm_tp = log_line_timestamp.replace(' ', '_')\n norm_tp = norm_tp.replace(':', '-')\n return norm_tp\n", "path": "mobly/logger.py"}]}
| 2,638 | 342 |
gh_patches_debug_4194
|
rasdani/github-patches
|
git_diff
|
cloud-custodian__cloud-custodian-5299
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
custodian validate failed with latest docker image
We are using cloudcustodian/c7n:latest, and getting errors below:
> 09:39:41 + custodian validate policy.yaml
> 09:39:41 Traceback (most recent call last):
> 09:39:41 File "/usr/local/bin/custodian", line 8, in <module>
> 09:39:41 sys.exit(main())
> 09:39:41 File "/usr/local/lib/python3.7/site-packages/c7n/cli.py", line 374, in main
> 09:39:41 command(config)
> 09:39:41 File "/usr/local/lib/python3.7/site-packages/c7n/commands.py", line 204, in validate
> 09:39:41 load_resources()
> 09:39:41 File "/usr/local/lib/python3.7/site-packages/c7n/resources/__init__.py", line 113, in load_resources
> 09:39:41 initialize_azure()
> 09:39:41 File "/usr/local/lib/python3.7/site-packages/c7n_azure/entry.py", line 21, in initialize_azure
> 09:39:41 import c7n_azure.policy
> 09:39:41 File "/usr/local/lib/python3.7/site-packages/c7n_azure/policy.py", line 28, in <module>
> 09:39:41 from c7n_azure.resources.arm import ArmResourceManager
> 09:39:41 File "/usr/local/lib/python3.7/site-packages/c7n_azure/resources/arm.py", line 24, in <module>
> 09:39:41 from c7n_azure.query import QueryResourceManager, QueryMeta, ChildResourceManager, TypeInfo, \
> 09:39:41 File "/usr/local/lib/python3.7/site-packages/c7n_azure/query.py", line 397, in <module>
> 09:39:41 resources.subscribe(QueryResourceManager.register_actions_and_filters)
> 09:39:41 TypeError: subscribe() missing 1 required positional argument: 'func'
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `setup.py`
Content:
```
1 import os
2 from io import open
3 from setuptools import setup, find_packages
4
5
6 def read(fname):
7 return open(os.path.join(os.path.dirname(__file__), fname), encoding='utf-8').read()
8
9
10 setup(
11 name="c7n",
12 use_scm_version={'write_to': 'c7n/version.py', 'fallback_version': '0.9.0-unreleased'},
13 setup_requires=['setuptools_scm'],
14 description="Cloud Custodian - Policy Rules Engine",
15 long_description=read('README.md'),
16 long_description_content_type='text/markdown',
17 classifiers=[
18 'Topic :: System :: Systems Administration',
19 'Topic :: System :: Distributed Computing',
20 'License :: OSI Approved :: Apache Software License',
21 'Programming Language :: Python :: 2.7',
22 'Programming Language :: Python :: 3.6',
23 'Programming Language :: Python :: 3.7',
24 'Programming Language :: Python :: 3.8',
25 ],
26 url="https://github.com/cloud-custodian/cloud-custodian",
27 license="Apache-2.0",
28 packages=find_packages(),
29 python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3, !=3.4, !=3.5, <4'",
30 entry_points={
31 'console_scripts': [
32 'custodian = c7n.cli:main']},
33 install_requires=[
34 "boto3>=1.9.228",
35 "botocore>=1.13.46",
36 "python-dateutil>=2.6,<3.0.0",
37 "PyYAML>=5.1",
38 "jsonschema",
39 "jsonpatch>=1.21",
40 "argcomplete",
41 "tabulate>=0.8.2",
42 "urllib3",
43 "certifi"
44 ],
45 extra_requires={
46 ":python_version<'3.3'": ["backports.functools-lru-cache"]
47 }
48 )
49
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/setup.py b/setup.py
--- a/setup.py
+++ b/setup.py
@@ -9,7 +9,7 @@
setup(
name="c7n",
- use_scm_version={'write_to': 'c7n/version.py', 'fallback_version': '0.9.0-unreleased'},
+ use_scm_version={'write_to': 'c7n/version.py', 'fallback_version': '0.9.0dev'},
setup_requires=['setuptools_scm'],
description="Cloud Custodian - Policy Rules Engine",
long_description=read('README.md'),
|
{"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -9,7 +9,7 @@\n \n setup(\n name=\"c7n\",\n- use_scm_version={'write_to': 'c7n/version.py', 'fallback_version': '0.9.0-unreleased'},\n+ use_scm_version={'write_to': 'c7n/version.py', 'fallback_version': '0.9.0dev'},\n setup_requires=['setuptools_scm'],\n description=\"Cloud Custodian - Policy Rules Engine\",\n long_description=read('README.md'),\n", "issue": "custodian validate failed with latest docker image\nWe are using cloudcustodian/c7n:latest, and getting errors below:\r\n\r\n> 09:39:41 + custodian validate policy.yaml\r\n> 09:39:41 Traceback (most recent call last):\r\n> 09:39:41 File \"/usr/local/bin/custodian\", line 8, in <module>\r\n> 09:39:41 sys.exit(main())\r\n> 09:39:41 File \"/usr/local/lib/python3.7/site-packages/c7n/cli.py\", line 374, in main\r\n> 09:39:41 command(config)\r\n> 09:39:41 File \"/usr/local/lib/python3.7/site-packages/c7n/commands.py\", line 204, in validate\r\n> 09:39:41 load_resources()\r\n> 09:39:41 File \"/usr/local/lib/python3.7/site-packages/c7n/resources/__init__.py\", line 113, in load_resources\r\n> 09:39:41 initialize_azure()\r\n> 09:39:41 File \"/usr/local/lib/python3.7/site-packages/c7n_azure/entry.py\", line 21, in initialize_azure\r\n> 09:39:41 import c7n_azure.policy\r\n> 09:39:41 File \"/usr/local/lib/python3.7/site-packages/c7n_azure/policy.py\", line 28, in <module>\r\n> 09:39:41 from c7n_azure.resources.arm import ArmResourceManager\r\n> 09:39:41 File \"/usr/local/lib/python3.7/site-packages/c7n_azure/resources/arm.py\", line 24, in <module>\r\n> 09:39:41 from c7n_azure.query import QueryResourceManager, QueryMeta, ChildResourceManager, TypeInfo, \\\r\n> 09:39:41 File \"/usr/local/lib/python3.7/site-packages/c7n_azure/query.py\", line 397, in <module>\r\n> 09:39:41 resources.subscribe(QueryResourceManager.register_actions_and_filters)\r\n> 09:39:41 TypeError: subscribe() missing 1 required positional argument: 'func'\n", "before_files": [{"content": "import os\nfrom io import open\nfrom setuptools import setup, find_packages\n\n\ndef read(fname):\n return open(os.path.join(os.path.dirname(__file__), fname), encoding='utf-8').read()\n\n\nsetup(\n name=\"c7n\",\n use_scm_version={'write_to': 'c7n/version.py', 'fallback_version': '0.9.0-unreleased'},\n setup_requires=['setuptools_scm'],\n description=\"Cloud Custodian - Policy Rules Engine\",\n long_description=read('README.md'),\n long_description_content_type='text/markdown',\n classifiers=[\n 'Topic :: System :: Systems Administration',\n 'Topic :: System :: Distributed Computing',\n 'License :: OSI Approved :: Apache Software License',\n 'Programming Language :: Python :: 2.7',\n 'Programming Language :: Python :: 3.6',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n ],\n url=\"https://github.com/cloud-custodian/cloud-custodian\",\n license=\"Apache-2.0\",\n packages=find_packages(),\n python_requires=\">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3, !=3.4, !=3.5, <4'\",\n entry_points={\n 'console_scripts': [\n 'custodian = c7n.cli:main']},\n install_requires=[\n \"boto3>=1.9.228\",\n \"botocore>=1.13.46\",\n \"python-dateutil>=2.6,<3.0.0\",\n \"PyYAML>=5.1\",\n \"jsonschema\",\n \"jsonpatch>=1.21\",\n \"argcomplete\",\n \"tabulate>=0.8.2\",\n \"urllib3\",\n \"certifi\"\n ],\n extra_requires={\n \":python_version<'3.3'\": [\"backports.functools-lru-cache\"]\n }\n)\n", "path": "setup.py"}], "after_files": [{"content": "import os\nfrom io import open\nfrom setuptools import setup, find_packages\n\n\ndef read(fname):\n return open(os.path.join(os.path.dirname(__file__), fname), encoding='utf-8').read()\n\n\nsetup(\n name=\"c7n\",\n use_scm_version={'write_to': 'c7n/version.py', 'fallback_version': '0.9.0dev'},\n setup_requires=['setuptools_scm'],\n description=\"Cloud Custodian - Policy Rules Engine\",\n long_description=read('README.md'),\n long_description_content_type='text/markdown',\n classifiers=[\n 'Topic :: System :: Systems Administration',\n 'Topic :: System :: Distributed Computing',\n 'License :: OSI Approved :: Apache Software License',\n 'Programming Language :: Python :: 2.7',\n 'Programming Language :: Python :: 3.6',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3.8',\n ],\n url=\"https://github.com/cloud-custodian/cloud-custodian\",\n license=\"Apache-2.0\",\n packages=find_packages(),\n python_requires=\">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3, !=3.4, !=3.5, <4'\",\n entry_points={\n 'console_scripts': [\n 'custodian = c7n.cli:main']},\n install_requires=[\n \"boto3>=1.9.228\",\n \"botocore>=1.13.46\",\n \"python-dateutil>=2.6,<3.0.0\",\n \"PyYAML>=5.1\",\n \"jsonschema\",\n \"jsonpatch>=1.21\",\n \"argcomplete\",\n \"tabulate>=0.8.2\",\n \"urllib3\",\n \"certifi\"\n ],\n extra_requires={\n \":python_version<'3.3'\": [\"backports.functools-lru-cache\"]\n }\n)\n", "path": "setup.py"}]}
| 1,313 | 127 |
gh_patches_debug_1162
|
rasdani/github-patches
|
git_diff
|
ibis-project__ibis-9088
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
docs: improvements to the home page
The Ibis project home page is better than it once was [citation needed], but
can use some improvements. In particular, it'd be great if we could have an
[interactive demo similar to
DuckDB's](https://shell.duckdb.org/#queries=v0,%20%20-Create-table-from-Parquet-file%0ACREATE-TABLE-train_services-AS%0A----FROM-'s3%3A%2F%2Fduckdb%20blobs%2Ftrain_services.parquet'~,%20%20-Get-the-top%203-busiest-train-stations%0ASELECT-station_name%2C-count(*)-AS-num_services%0AFROM-train_services%0AGROUP-BY-ALL%0AORDER-BY-num_services-DESC%0ALIMIT-3~).
This would required [PyArrow in
Pyodide](https://github.com/pyodide/pyodide/issues/2933) as the last blocker, I
think.
Regardless, we should ensure the landing page answers to a new/prospective user:
- What is Ibis?
- Why should I use Ibis?
- Confidence Ibis is a well-supported, production-ready library
Unfortunately, this may involve more HTML/CSS than I'm conformtable doing but
we'll figure something out.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `docs/backends_sankey.py`
Content:
```
1 from __future__ import annotations
2
3 import plotly.graph_objects as go
4
5
6 def to_greyish(hex_code, grey_value=128):
7 hex_code = hex_code.lstrip("#")
8 r, g, b = int(hex_code[0:2], 16), int(hex_code[2:4], 16), int(hex_code[4:6], 16)
9
10 new_r = (r + grey_value) // 2
11 new_g = (g + grey_value) // 2
12 new_b = (b + grey_value) // 2
13
14 new_hex_code = f"#{new_r:02x}{new_g:02x}{new_b:02x}"
15
16 return new_hex_code
17
18
19 category_colors = {
20 "Ibis API": "#7C65A0",
21 "SQL": "#6A9BC9",
22 "DataFrame": "#D58273",
23 }
24
25 backend_categories = {
26 list(category_colors.keys())[1]: [
27 "BigQuery",
28 "ClickHouse",
29 "DataFusion",
30 "Druid",
31 "DuckDB",
32 "Exasol",
33 "Flink",
34 "Impala",
35 "MSSQL",
36 "MySQL",
37 "Oracle",
38 "PostgreSQL",
39 "PySpark",
40 "RisingWave",
41 "Snowflake",
42 "SQLite",
43 "Trino",
44 ],
45 list(category_colors.keys())[2]: ["Dask", "pandas", "Polars"],
46 }
47
48 nodes, links = [], []
49 node_index = {}
50
51 nodes.append({"label": "Ibis API", "color": category_colors["Ibis API"]})
52 node_index["Ibis API"] = 0
53
54 idx = 1
55 for category, backends in backend_categories.items():
56 nodes.append({"label": category, "color": category_colors[category]})
57 node_index[category] = idx
58 links.append({"source": 0, "target": idx, "value": len(backends)})
59 idx += 1
60
61 for backend in backends:
62 if backend not in node_index:
63 nodes.append({"label": backend, "color": category_colors[category]})
64 node_index[backend] = idx
65 idx += 1
66 links.append(
67 {
68 "source": node_index[category],
69 "target": node_index[backend],
70 "value": 1,
71 }
72 )
73
74 fig = go.Figure(
75 data=[
76 go.Sankey(
77 node=dict(
78 pad=20,
79 thickness=20,
80 line=dict(color="grey", width=0.5),
81 label=[node["label"] for node in nodes],
82 color=[node["color"] for node in nodes],
83 ),
84 link=dict(
85 source=[link["source"] for link in links],
86 target=[link["target"] for link in links],
87 value=[link["value"] for link in links],
88 line=dict(color="grey", width=0.5),
89 color=[to_greyish(nodes[link["target"]]["color"]) for link in links],
90 ),
91 )
92 ],
93 )
94
95 fig.update_layout(
96 title_text="Ibis backend types",
97 font_size=24,
98 # font_family="Arial",
99 title_font_size=30,
100 margin=dict(l=30, r=30, t=80, b=30),
101 template="plotly_dark",
102 )
103
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/docs/backends_sankey.py b/docs/backends_sankey.py
--- a/docs/backends_sankey.py
+++ b/docs/backends_sankey.py
@@ -94,7 +94,7 @@
fig.update_layout(
title_text="Ibis backend types",
- font_size=24,
+ font_size=20,
# font_family="Arial",
title_font_size=30,
margin=dict(l=30, r=30, t=80, b=30),
|
{"golden_diff": "diff --git a/docs/backends_sankey.py b/docs/backends_sankey.py\n--- a/docs/backends_sankey.py\n+++ b/docs/backends_sankey.py\n@@ -94,7 +94,7 @@\n \n fig.update_layout(\n title_text=\"Ibis backend types\",\n- font_size=24,\n+ font_size=20,\n # font_family=\"Arial\",\n title_font_size=30,\n margin=dict(l=30, r=30, t=80, b=30),\n", "issue": "docs: improvements to the home page\nThe Ibis project home page is better than it once was [citation needed], but\ncan use some improvements. In particular, it'd be great if we could have an\n[interactive demo similar to\nDuckDB's](https://shell.duckdb.org/#queries=v0,%20%20-Create-table-from-Parquet-file%0ACREATE-TABLE-train_services-AS%0A----FROM-'s3%3A%2F%2Fduckdb%20blobs%2Ftrain_services.parquet'~,%20%20-Get-the-top%203-busiest-train-stations%0ASELECT-station_name%2C-count(*)-AS-num_services%0AFROM-train_services%0AGROUP-BY-ALL%0AORDER-BY-num_services-DESC%0ALIMIT-3~).\nThis would required [PyArrow in\nPyodide](https://github.com/pyodide/pyodide/issues/2933) as the last blocker, I\nthink.\n\nRegardless, we should ensure the landing page answers to a new/prospective user:\n\n- What is Ibis?\n- Why should I use Ibis?\n- Confidence Ibis is a well-supported, production-ready library\n\nUnfortunately, this may involve more HTML/CSS than I'm conformtable doing but\nwe'll figure something out.\n\n\n", "before_files": [{"content": "from __future__ import annotations\n\nimport plotly.graph_objects as go\n\n\ndef to_greyish(hex_code, grey_value=128):\n hex_code = hex_code.lstrip(\"#\")\n r, g, b = int(hex_code[0:2], 16), int(hex_code[2:4], 16), int(hex_code[4:6], 16)\n\n new_r = (r + grey_value) // 2\n new_g = (g + grey_value) // 2\n new_b = (b + grey_value) // 2\n\n new_hex_code = f\"#{new_r:02x}{new_g:02x}{new_b:02x}\"\n\n return new_hex_code\n\n\ncategory_colors = {\n \"Ibis API\": \"#7C65A0\",\n \"SQL\": \"#6A9BC9\",\n \"DataFrame\": \"#D58273\",\n}\n\nbackend_categories = {\n list(category_colors.keys())[1]: [\n \"BigQuery\",\n \"ClickHouse\",\n \"DataFusion\",\n \"Druid\",\n \"DuckDB\",\n \"Exasol\",\n \"Flink\",\n \"Impala\",\n \"MSSQL\",\n \"MySQL\",\n \"Oracle\",\n \"PostgreSQL\",\n \"PySpark\",\n \"RisingWave\",\n \"Snowflake\",\n \"SQLite\",\n \"Trino\",\n ],\n list(category_colors.keys())[2]: [\"Dask\", \"pandas\", \"Polars\"],\n}\n\nnodes, links = [], []\nnode_index = {}\n\nnodes.append({\"label\": \"Ibis API\", \"color\": category_colors[\"Ibis API\"]})\nnode_index[\"Ibis API\"] = 0\n\nidx = 1\nfor category, backends in backend_categories.items():\n nodes.append({\"label\": category, \"color\": category_colors[category]})\n node_index[category] = idx\n links.append({\"source\": 0, \"target\": idx, \"value\": len(backends)})\n idx += 1\n\n for backend in backends:\n if backend not in node_index:\n nodes.append({\"label\": backend, \"color\": category_colors[category]})\n node_index[backend] = idx\n idx += 1\n links.append(\n {\n \"source\": node_index[category],\n \"target\": node_index[backend],\n \"value\": 1,\n }\n )\n\nfig = go.Figure(\n data=[\n go.Sankey(\n node=dict(\n pad=20,\n thickness=20,\n line=dict(color=\"grey\", width=0.5),\n label=[node[\"label\"] for node in nodes],\n color=[node[\"color\"] for node in nodes],\n ),\n link=dict(\n source=[link[\"source\"] for link in links],\n target=[link[\"target\"] for link in links],\n value=[link[\"value\"] for link in links],\n line=dict(color=\"grey\", width=0.5),\n color=[to_greyish(nodes[link[\"target\"]][\"color\"]) for link in links],\n ),\n )\n ],\n)\n\nfig.update_layout(\n title_text=\"Ibis backend types\",\n font_size=24,\n # font_family=\"Arial\",\n title_font_size=30,\n margin=dict(l=30, r=30, t=80, b=30),\n template=\"plotly_dark\",\n)\n", "path": "docs/backends_sankey.py"}], "after_files": [{"content": "from __future__ import annotations\n\nimport plotly.graph_objects as go\n\n\ndef to_greyish(hex_code, grey_value=128):\n hex_code = hex_code.lstrip(\"#\")\n r, g, b = int(hex_code[0:2], 16), int(hex_code[2:4], 16), int(hex_code[4:6], 16)\n\n new_r = (r + grey_value) // 2\n new_g = (g + grey_value) // 2\n new_b = (b + grey_value) // 2\n\n new_hex_code = f\"#{new_r:02x}{new_g:02x}{new_b:02x}\"\n\n return new_hex_code\n\n\ncategory_colors = {\n \"Ibis API\": \"#7C65A0\",\n \"SQL\": \"#6A9BC9\",\n \"DataFrame\": \"#D58273\",\n}\n\nbackend_categories = {\n list(category_colors.keys())[1]: [\n \"BigQuery\",\n \"ClickHouse\",\n \"DataFusion\",\n \"Druid\",\n \"DuckDB\",\n \"Exasol\",\n \"Flink\",\n \"Impala\",\n \"MSSQL\",\n \"MySQL\",\n \"Oracle\",\n \"PostgreSQL\",\n \"PySpark\",\n \"RisingWave\",\n \"Snowflake\",\n \"SQLite\",\n \"Trino\",\n ],\n list(category_colors.keys())[2]: [\"Dask\", \"pandas\", \"Polars\"],\n}\n\nnodes, links = [], []\nnode_index = {}\n\nnodes.append({\"label\": \"Ibis API\", \"color\": category_colors[\"Ibis API\"]})\nnode_index[\"Ibis API\"] = 0\n\nidx = 1\nfor category, backends in backend_categories.items():\n nodes.append({\"label\": category, \"color\": category_colors[category]})\n node_index[category] = idx\n links.append({\"source\": 0, \"target\": idx, \"value\": len(backends)})\n idx += 1\n\n for backend in backends:\n if backend not in node_index:\n nodes.append({\"label\": backend, \"color\": category_colors[category]})\n node_index[backend] = idx\n idx += 1\n links.append(\n {\n \"source\": node_index[category],\n \"target\": node_index[backend],\n \"value\": 1,\n }\n )\n\nfig = go.Figure(\n data=[\n go.Sankey(\n node=dict(\n pad=20,\n thickness=20,\n line=dict(color=\"grey\", width=0.5),\n label=[node[\"label\"] for node in nodes],\n color=[node[\"color\"] for node in nodes],\n ),\n link=dict(\n source=[link[\"source\"] for link in links],\n target=[link[\"target\"] for link in links],\n value=[link[\"value\"] for link in links],\n line=dict(color=\"grey\", width=0.5),\n color=[to_greyish(nodes[link[\"target\"]][\"color\"]) for link in links],\n ),\n )\n ],\n)\n\nfig.update_layout(\n title_text=\"Ibis backend types\",\n font_size=20,\n # font_family=\"Arial\",\n title_font_size=30,\n margin=dict(l=30, r=30, t=80, b=30),\n template=\"plotly_dark\",\n)\n", "path": "docs/backends_sankey.py"}]}
| 1,507 | 116 |
gh_patches_debug_5948
|
rasdani/github-patches
|
git_diff
|
Lightning-AI__pytorch-lightning-1396
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
RuntimeError: Unimplemented backend XLA on TPU
## 🐛 Bug
`RuntimeError: Unimplemented backend XLA` raised for `self.batch_loss_value.append(loss)` line in `trainer/training_loop.py` file when running MNIST on TPU. I think it was introduced in 31b7148.
### To Reproduce
Steps to reproduce the behavior:
1. Go to [MNIST on TPUs](https://colab.research.google.com/drive/1-_LKx4HwAxl5M6xPJmqAAu444LTDQoa3)
2. Run all
3. Scroll down to trainer
4. See error
```
Traceback (most recent call last):
File "/usr/local/lib/python3.6/dist-packages/torch_xla/distributed/xla_multiprocessing.py", line 119, in _start_fn
fn(gindex, *args)
File "/usr/local/lib/python3.6/dist-packages/torch_xla/distributed/xla_multiprocessing.py", line 119, in _start_fn
fn(gindex, *args)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py", line 499, in tpu_train
self.run_pretrain_routine(model)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py", line 499, in tpu_train
self.run_pretrain_routine(model)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py", line 499, in tpu_train
self.run_pretrain_routine(model)
File "/usr/local/lib/python3.6/dist-packages/torch_xla/distributed/xla_multiprocessing.py", line 119, in _start_fn
fn(gindex, *args)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py", line 499, in tpu_train
self.run_pretrain_routine(model)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py", line 499, in tpu_train
self.run_pretrain_routine(model)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py", line 499, in tpu_train
self.run_pretrain_routine(model)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py", line 920, in run_pretrain_routine
self.train()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py", line 920, in run_pretrain_routine
self.train()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py", line 920, in run_pretrain_routine
self.train()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py", line 920, in run_pretrain_routine
self.train()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py", line 920, in run_pretrain_routine
self.train()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py", line 920, in run_pretrain_routine
self.train()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 356, in train
self.run_training_epoch()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 356, in train
self.run_training_epoch()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py", line 499, in tpu_train
self.run_pretrain_routine(model)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 356, in train
self.run_training_epoch()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 356, in train
self.run_training_epoch()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 356, in train
self.run_training_epoch()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 356, in train
self.run_training_epoch()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 425, in run_training_epoch
output = self.run_training_batch(batch, batch_idx)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 425, in run_training_epoch
output = self.run_training_batch(batch, batch_idx)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py", line 920, in run_pretrain_routine
self.train()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 425, in run_training_epoch
output = self.run_training_batch(batch, batch_idx)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 425, in run_training_epoch
output = self.run_training_batch(batch, batch_idx)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 425, in run_training_epoch
output = self.run_training_batch(batch, batch_idx)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 425, in run_training_epoch
output = self.run_training_batch(batch, batch_idx)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 582, in run_training_batch
self.batch_loss_value.append(loss)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 582, in run_training_batch
self.batch_loss_value.append(loss)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py", line 23, in append
if self.memory.type() != x.type():
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 356, in train
self.run_training_epoch()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 582, in run_training_batch
self.batch_loss_value.append(loss)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 582, in run_training_batch
self.batch_loss_value.append(loss)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 582, in run_training_batch
self.batch_loss_value.append(loss)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py", line 23, in append
if self.memory.type() != x.type():
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 582, in run_training_batch
self.batch_loss_value.append(loss)
Exception in device=TPU:5: Unimplemented backend XLA
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py", line 23, in append
if self.memory.type() != x.type():
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 425, in run_training_epoch
output = self.run_training_batch(batch, batch_idx)
RuntimeError: Unimplemented backend XLA
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py", line 23, in append
if self.memory.type() != x.type():
RuntimeError: Unimplemented backend XLA
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py", line 23, in append
if self.memory.type() != x.type():
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py", line 23, in append
if self.memory.type() != x.type():
RuntimeError: Unimplemented backend XLA
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 582, in run_training_batch
self.batch_loss_value.append(loss)
RuntimeError: Unimplemented backend XLA
Traceback (most recent call last):
RuntimeError: Unimplemented backend XLA
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py", line 23, in append
if self.memory.type() != x.type():
RuntimeError: Unimplemented backend XLA
File "/usr/local/lib/python3.6/dist-packages/torch_xla/distributed/xla_multiprocessing.py", line 119, in _start_fn
fn(gindex, *args)
RuntimeError: Unimplemented backend XLA
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py", line 499, in tpu_train
self.run_pretrain_routine(model)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py", line 920, in run_pretrain_routine
self.train()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 356, in train
self.run_training_epoch()
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 425, in run_training_epoch
output = self.run_training_batch(batch, batch_idx)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py", line 582, in run_training_batch
self.batch_loss_value.append(loss)
File "/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py", line 23, in append
if self.memory.type() != x.type():
RuntimeError: Unimplemented backend XLA
---------------------------------------------------------------------------
Exception Traceback (most recent call last)
<ipython-input-2-12f6e300d51d> in <module>()
6 # most basic trainer, uses good defaults
7 trainer = Trainer(num_tpu_cores=8)
----> 8 trainer.fit(model)
3 frames
/usr/local/lib/python3.6/dist-packages/torch/multiprocessing/spawn.py in join(self, timeout)
111 raise Exception(
112 "process %d terminated with exit code %d" %
--> 113 (error_index, exitcode)
114 )
115
Exception: process 4 terminated with exit code 17
```
### Environment
- PyTorch Version (e.g., 1.0): 1.6
- OS (e.g., Linux): Linux
- How you installed PyTorch (`conda`, `pip`, source): pip
- Build command you used (if compiling from source): -
- Python version: 3.6
- CUDA/cuDNN version: -
- GPU models and configuration: -
- Any other relevant information: TPU backend
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `pytorch_lightning/trainer/supporters.py`
Content:
```
1 import torch
2
3
4 class TensorRunningMean(object):
5 """
6 Tracks a running mean without graph references.
7 Round robbin for the mean
8
9 Examples:
10 >>> accum = TensorRunningMean(5)
11 >>> accum.last(), accum.mean()
12 (None, None)
13 >>> accum.append(torch.tensor(1.5))
14 >>> accum.last(), accum.mean()
15 (tensor(1.5000), tensor(1.5000))
16 >>> accum.append(torch.tensor(2.5))
17 >>> accum.last(), accum.mean()
18 (tensor(2.5000), tensor(2.))
19 >>> accum.reset()
20 >>> _= [accum.append(torch.tensor(i)) for i in range(13)]
21 >>> accum.last(), accum.mean()
22 (tensor(12.), tensor(10.))
23 """
24 def __init__(self, window_length: int):
25 self.window_length = window_length
26 self.memory = torch.Tensor(self.window_length)
27 self.current_idx: int = 0
28 self.last_idx: int = None
29 self.rotated: bool = False
30
31 def reset(self) -> None:
32 self = TensorRunningMean(self.window_length)
33
34 def last(self):
35 if self.last_idx is not None:
36 return self.memory[self.last_idx]
37
38 def append(self, x):
39 # map proper type for memory if they don't match
40 if self.memory.type() != x.type():
41 self.memory.type_as(x)
42
43 # store without grads
44 with torch.no_grad():
45 self.memory[self.current_idx] = x
46 self.last_idx = self.current_idx
47
48 # increase index
49 self.current_idx += 1
50
51 # reset index when hit limit of tensor
52 self.current_idx = self.current_idx % self.window_length
53 if self.current_idx == 0:
54 self.rotated = True
55
56 def mean(self):
57 if self.last_idx is not None:
58 return self.memory.mean() if self.rotated else self.memory[:self.current_idx].mean()
59
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/pytorch_lightning/trainer/supporters.py b/pytorch_lightning/trainer/supporters.py
--- a/pytorch_lightning/trainer/supporters.py
+++ b/pytorch_lightning/trainer/supporters.py
@@ -36,9 +36,9 @@
return self.memory[self.last_idx]
def append(self, x):
- # map proper type for memory if they don't match
- if self.memory.type() != x.type():
- self.memory.type_as(x)
+ # ensure same device and type
+ if self.memory.device != x.device or self.memory.type() != x.type():
+ x = x.to(self.memory)
# store without grads
with torch.no_grad():
|
{"golden_diff": "diff --git a/pytorch_lightning/trainer/supporters.py b/pytorch_lightning/trainer/supporters.py\n--- a/pytorch_lightning/trainer/supporters.py\n+++ b/pytorch_lightning/trainer/supporters.py\n@@ -36,9 +36,9 @@\n return self.memory[self.last_idx]\n \n def append(self, x):\n- # map proper type for memory if they don't match\n- if self.memory.type() != x.type():\n- self.memory.type_as(x)\n+ # ensure same device and type\n+ if self.memory.device != x.device or self.memory.type() != x.type():\n+ x = x.to(self.memory)\n \n # store without grads\n with torch.no_grad():\n", "issue": "RuntimeError: Unimplemented backend XLA on TPU\n## \ud83d\udc1b Bug\r\n\r\n`RuntimeError: Unimplemented backend XLA` raised for `self.batch_loss_value.append(loss)` line in `trainer/training_loop.py` file when running MNIST on TPU. I think it was introduced in 31b7148.\r\n\r\n### To Reproduce\r\n\r\nSteps to reproduce the behavior:\r\n\r\n1. Go to [MNIST on TPUs](https://colab.research.google.com/drive/1-_LKx4HwAxl5M6xPJmqAAu444LTDQoa3)\r\n2. Run all\r\n3. Scroll down to trainer\r\n4. See error\r\n\r\n```\r\nTraceback (most recent call last):\r\n File \"/usr/local/lib/python3.6/dist-packages/torch_xla/distributed/xla_multiprocessing.py\", line 119, in _start_fn\r\n fn(gindex, *args)\r\n File \"/usr/local/lib/python3.6/dist-packages/torch_xla/distributed/xla_multiprocessing.py\", line 119, in _start_fn\r\n fn(gindex, *args)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py\", line 499, in tpu_train\r\n self.run_pretrain_routine(model)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py\", line 499, in tpu_train\r\n self.run_pretrain_routine(model)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py\", line 499, in tpu_train\r\n self.run_pretrain_routine(model)\r\n File \"/usr/local/lib/python3.6/dist-packages/torch_xla/distributed/xla_multiprocessing.py\", line 119, in _start_fn\r\n fn(gindex, *args)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py\", line 499, in tpu_train\r\n self.run_pretrain_routine(model)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py\", line 499, in tpu_train\r\n self.run_pretrain_routine(model)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py\", line 499, in tpu_train\r\n self.run_pretrain_routine(model)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py\", line 920, in run_pretrain_routine\r\n self.train()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py\", line 920, in run_pretrain_routine\r\n self.train()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py\", line 920, in run_pretrain_routine\r\n self.train()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py\", line 920, in run_pretrain_routine\r\n self.train()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py\", line 920, in run_pretrain_routine\r\n self.train()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py\", line 920, in run_pretrain_routine\r\n self.train()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 356, in train\r\n self.run_training_epoch()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 356, in train\r\n self.run_training_epoch()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py\", line 499, in tpu_train\r\n self.run_pretrain_routine(model)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 356, in train\r\n self.run_training_epoch()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 356, in train\r\n self.run_training_epoch()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 356, in train\r\n self.run_training_epoch()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 356, in train\r\n self.run_training_epoch()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 425, in run_training_epoch\r\n output = self.run_training_batch(batch, batch_idx)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 425, in run_training_epoch\r\n output = self.run_training_batch(batch, batch_idx)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py\", line 920, in run_pretrain_routine\r\n self.train()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 425, in run_training_epoch\r\n output = self.run_training_batch(batch, batch_idx)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 425, in run_training_epoch\r\n output = self.run_training_batch(batch, batch_idx)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 425, in run_training_epoch\r\n output = self.run_training_batch(batch, batch_idx)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 425, in run_training_epoch\r\n output = self.run_training_batch(batch, batch_idx)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 582, in run_training_batch\r\n self.batch_loss_value.append(loss)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 582, in run_training_batch\r\n self.batch_loss_value.append(loss)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py\", line 23, in append\r\n if self.memory.type() != x.type():\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 356, in train\r\n self.run_training_epoch()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 582, in run_training_batch\r\n self.batch_loss_value.append(loss)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 582, in run_training_batch\r\n self.batch_loss_value.append(loss)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 582, in run_training_batch\r\n self.batch_loss_value.append(loss)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py\", line 23, in append\r\n if self.memory.type() != x.type():\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 582, in run_training_batch\r\n self.batch_loss_value.append(loss)\r\nException in device=TPU:5: Unimplemented backend XLA\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py\", line 23, in append\r\n if self.memory.type() != x.type():\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 425, in run_training_epoch\r\n output = self.run_training_batch(batch, batch_idx)\r\nRuntimeError: Unimplemented backend XLA\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py\", line 23, in append\r\n if self.memory.type() != x.type():\r\nRuntimeError: Unimplemented backend XLA\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py\", line 23, in append\r\n if self.memory.type() != x.type():\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py\", line 23, in append\r\n if self.memory.type() != x.type():\r\nRuntimeError: Unimplemented backend XLA\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 582, in run_training_batch\r\n self.batch_loss_value.append(loss)\r\nRuntimeError: Unimplemented backend XLA\r\nTraceback (most recent call last):\r\nRuntimeError: Unimplemented backend XLA\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py\", line 23, in append\r\n if self.memory.type() != x.type():\r\nRuntimeError: Unimplemented backend XLA\r\n File \"/usr/local/lib/python3.6/dist-packages/torch_xla/distributed/xla_multiprocessing.py\", line 119, in _start_fn\r\n fn(gindex, *args)\r\nRuntimeError: Unimplemented backend XLA\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/distrib_parts.py\", line 499, in tpu_train\r\n self.run_pretrain_routine(model)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/trainer.py\", line 920, in run_pretrain_routine\r\n self.train()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 356, in train\r\n self.run_training_epoch()\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 425, in run_training_epoch\r\n output = self.run_training_batch(batch, batch_idx)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/training_loop.py\", line 582, in run_training_batch\r\n self.batch_loss_value.append(loss)\r\n File \"/usr/local/lib/python3.6/dist-packages/pytorch_lightning/trainer/supporting_classes.py\", line 23, in append\r\n if self.memory.type() != x.type():\r\nRuntimeError: Unimplemented backend XLA\r\n---------------------------------------------------------------------------\r\nException Traceback (most recent call last)\r\n<ipython-input-2-12f6e300d51d> in <module>()\r\n 6 # most basic trainer, uses good defaults\r\n 7 trainer = Trainer(num_tpu_cores=8)\r\n----> 8 trainer.fit(model)\r\n\r\n3 frames\r\n/usr/local/lib/python3.6/dist-packages/torch/multiprocessing/spawn.py in join(self, timeout)\r\n 111 raise Exception(\r\n 112 \"process %d terminated with exit code %d\" %\r\n--> 113 (error_index, exitcode)\r\n 114 )\r\n 115 \r\n\r\nException: process 4 terminated with exit code 17\r\n```\r\n\r\n### Environment\r\n\r\n - PyTorch Version (e.g., 1.0): 1.6\r\n - OS (e.g., Linux): Linux\r\n - How you installed PyTorch (`conda`, `pip`, source): pip\r\n - Build command you used (if compiling from source): -\r\n - Python version: 3.6\r\n - CUDA/cuDNN version: -\r\n - GPU models and configuration: -\r\n - Any other relevant information: TPU backend\r\n\n", "before_files": [{"content": "import torch\n\n\nclass TensorRunningMean(object):\n \"\"\"\n Tracks a running mean without graph references.\n Round robbin for the mean\n\n Examples:\n >>> accum = TensorRunningMean(5)\n >>> accum.last(), accum.mean()\n (None, None)\n >>> accum.append(torch.tensor(1.5))\n >>> accum.last(), accum.mean()\n (tensor(1.5000), tensor(1.5000))\n >>> accum.append(torch.tensor(2.5))\n >>> accum.last(), accum.mean()\n (tensor(2.5000), tensor(2.))\n >>> accum.reset()\n >>> _= [accum.append(torch.tensor(i)) for i in range(13)]\n >>> accum.last(), accum.mean()\n (tensor(12.), tensor(10.))\n \"\"\"\n def __init__(self, window_length: int):\n self.window_length = window_length\n self.memory = torch.Tensor(self.window_length)\n self.current_idx: int = 0\n self.last_idx: int = None\n self.rotated: bool = False\n\n def reset(self) -> None:\n self = TensorRunningMean(self.window_length)\n\n def last(self):\n if self.last_idx is not None:\n return self.memory[self.last_idx]\n\n def append(self, x):\n # map proper type for memory if they don't match\n if self.memory.type() != x.type():\n self.memory.type_as(x)\n\n # store without grads\n with torch.no_grad():\n self.memory[self.current_idx] = x\n self.last_idx = self.current_idx\n\n # increase index\n self.current_idx += 1\n\n # reset index when hit limit of tensor\n self.current_idx = self.current_idx % self.window_length\n if self.current_idx == 0:\n self.rotated = True\n\n def mean(self):\n if self.last_idx is not None:\n return self.memory.mean() if self.rotated else self.memory[:self.current_idx].mean()\n", "path": "pytorch_lightning/trainer/supporters.py"}], "after_files": [{"content": "import torch\n\n\nclass TensorRunningMean(object):\n \"\"\"\n Tracks a running mean without graph references.\n Round robbin for the mean\n\n Examples:\n >>> accum = TensorRunningMean(5)\n >>> accum.last(), accum.mean()\n (None, None)\n >>> accum.append(torch.tensor(1.5))\n >>> accum.last(), accum.mean()\n (tensor(1.5000), tensor(1.5000))\n >>> accum.append(torch.tensor(2.5))\n >>> accum.last(), accum.mean()\n (tensor(2.5000), tensor(2.))\n >>> accum.reset()\n >>> _= [accum.append(torch.tensor(i)) for i in range(13)]\n >>> accum.last(), accum.mean()\n (tensor(12.), tensor(10.))\n \"\"\"\n def __init__(self, window_length: int):\n self.window_length = window_length\n self.memory = torch.Tensor(self.window_length)\n self.current_idx: int = 0\n self.last_idx: int = None\n self.rotated: bool = False\n\n def reset(self) -> None:\n self = TensorRunningMean(self.window_length)\n\n def last(self):\n if self.last_idx is not None:\n return self.memory[self.last_idx]\n\n def append(self, x):\n # ensure same device and type\n if self.memory.device != x.device or self.memory.type() != x.type():\n x = x.to(self.memory)\n\n # store without grads\n with torch.no_grad():\n self.memory[self.current_idx] = x\n self.last_idx = self.current_idx\n\n # increase index\n self.current_idx += 1\n\n # reset index when hit limit of tensor\n self.current_idx = self.current_idx % self.window_length\n if self.current_idx == 0:\n self.rotated = True\n\n def mean(self):\n if self.last_idx is not None:\n return self.memory.mean() if self.rotated else self.memory[:self.current_idx].mean()\n", "path": "pytorch_lightning/trainer/supporters.py"}]}
| 3,491 | 158 |
gh_patches_debug_29996
|
rasdani/github-patches
|
git_diff
|
mabel-dev__opteryx-1461
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
✨ support pyarrow's IPC format
### Thanks for stopping by to let us know something could be better!
**Is your feature request related to a problem? Please describe.** _A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]_
**Describe the solution you'd like** _A clear and concise description of what you want to happen._
**Describe alternatives you've considered** _A clear and concise description of any alternative solutions or features you've considered._
**Additional context** _Add any other context or screenshots about the feature request here._
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `opteryx/utils/file_decoders.py`
Content:
```
1 # Licensed under the Apache License, Version 2.0 (the "License");
2 # you may not use this file except in compliance with the License.
3 # You may obtain a copy of the License at
4 #
5 # http://www.apache.org/licenses/LICENSE-2.0
6 #
7 # Unless required by applicable law or agreed to in writing, software
8 # distributed under the License is distributed on an "AS IS" BASIS,
9 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 # See the License for the specific language governing permissions and
11 # limitations under the License.
12
13 """
14 Decode files from a raw binary format to a PyArrow Table.
15 """
16 import io
17 from enum import Enum
18 from typing import Callable
19 from typing import Dict
20 from typing import List
21 from typing import Tuple
22
23 import numpy
24 import pyarrow
25 from orso.tools import random_string
26
27 from opteryx.exceptions import UnsupportedFileTypeError
28 from opteryx.utils.arrow import post_read_projector
29
30
31 class ExtentionType(str, Enum):
32 """labels for the file extentions"""
33
34 DATA = "DATA"
35 CONTROL = "CONTROL"
36
37
38 def convert_arrow_schema_to_orso_schema(arrow_schema):
39 from orso.schema import FlatColumn
40 from orso.schema import RelationSchema
41
42 return RelationSchema(
43 name="arrow",
44 columns=[FlatColumn.from_arrow(field) for field in arrow_schema],
45 )
46
47
48 def get_decoder(dataset: str) -> Callable:
49 """helper routine to get the decoder for a given file"""
50 ext = dataset.split(".")[-1].lower()
51 if ext not in KNOWN_EXTENSIONS: # pragma: no cover
52 raise UnsupportedFileTypeError(f"Unsupported file type - {ext}")
53 file_decoder, file_type = KNOWN_EXTENSIONS[ext]
54 if file_type != ExtentionType.DATA: # pragma: no cover
55 raise UnsupportedFileTypeError(f"File is not a data file - {ext}")
56 return file_decoder
57
58
59 def do_nothing(buffer, projection=None, just_schema: bool = False): # pragma: no cover
60 """for when you need to look like you're doing something"""
61 return False
62
63
64 def filter_records(filter, table):
65 """
66 When we can't push predicates to the actual read, use this to filter records
67 just after the read.
68 """
69 # notes:
70 # at this point we've not renamed any columns, this may affect some filters
71 from opteryx.managers.expression import NodeType
72 from opteryx.managers.expression import evaluate
73 from opteryx.models import Node
74
75 if isinstance(filter, list) and filter:
76 filter_copy = [p for p in filter]
77 root = filter_copy.pop()
78
79 if root.left.node_type == NodeType.IDENTIFIER:
80 root.left.schema_column.identity = root.left.source_column
81 if root.right.node_type == NodeType.IDENTIFIER:
82 root.right.schema_column.identity = root.right.source_column
83
84 while filter_copy:
85 right = filter_copy.pop()
86 if right.left.node_type == NodeType.IDENTIFIER:
87 right.left.schema_column.identity = right.left.source_column
88 if right.right.node_type == NodeType.IDENTIFIER:
89 right.right.schema_column.identity = right.right.source_column
90 root = Node(
91 NodeType.AND, left=root, right=right, schema_column=Node(identity=random_string())
92 )
93 else:
94 root = filter
95
96 mask = evaluate(root, table)
97 return table.filter(mask)
98
99
100 def zstd_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):
101 """
102 Read zstandard compressed JSONL files
103 """
104 import zstandard
105
106 stream = io.BytesIO(buffer)
107
108 with zstandard.open(stream, "rb") as file:
109 return jsonl_decoder(
110 file, projection=projection, selection=selection, just_schema=just_schema
111 )
112
113
114 def parquet_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):
115 """
116 Read parquet formatted files.
117 """
118 from pyarrow import parquet
119
120 from opteryx.connectors.capabilities import PredicatePushable
121
122 # Convert the selection to DNF format if applicable
123 _select, selection = PredicatePushable.to_dnf(selection) if selection else (None, None)
124
125 stream = io.BytesIO(buffer)
126
127 if projection or just_schema:
128 # Open the parquet file only once
129 parquet_file = parquet.ParquetFile(stream)
130
131 # Return just the schema if that's all that's needed
132 if just_schema:
133 return convert_arrow_schema_to_orso_schema(parquet_file.schema_arrow)
134
135 # Special handling for projection of ["count_*"]
136 if projection == ["count_*"]:
137 return pyarrow.Table.from_pydict(
138 {"_": numpy.full(parquet_file.metadata.num_rows, True, dtype=numpy.bool_)}
139 )
140
141 # Projection processing
142 schema_columns_set = set(parquet_file.schema_arrow.names)
143 projection_names = {name for proj_col in projection for name in proj_col.all_names}
144 selected_columns = list(schema_columns_set.intersection(projection_names))
145
146 # If no columns are selected, set to None
147 if not selected_columns:
148 selected_columns = None
149 else:
150 selected_columns = None
151
152 # Read the parquet table with the optimized column list and selection filters
153 table = parquet.read_table(stream, columns=selected_columns, pre_buffer=False, filters=_select)
154 if selection:
155 table = filter_records(selection, table)
156 return table
157
158
159 def orc_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):
160 """
161 Read orc formatted files
162 """
163 import pyarrow.orc as orc
164
165 stream = io.BytesIO(buffer)
166 orc_file = orc.ORCFile(stream)
167
168 if just_schema:
169 orc_schema = orc_file.schema
170 return convert_arrow_schema_to_orso_schema(orc_schema)
171
172 table = orc_file.read()
173 if selection:
174 table = filter_records(selection, table)
175 if projection:
176 table = post_read_projector(table, projection)
177 return table
178
179
180 def jsonl_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):
181 import pyarrow.json
182
183 if isinstance(buffer, bytes):
184 stream = io.BytesIO(buffer)
185 else:
186 stream = buffer
187
188 table = pyarrow.json.read_json(stream)
189 schema = table.schema
190 if just_schema:
191 return convert_arrow_schema_to_orso_schema(schema)
192
193 if selection:
194 table = filter_records(selection, table)
195 if projection:
196 table = post_read_projector(table, projection)
197
198 return table
199
200
201 def csv_decoder(
202 buffer, projection: List = None, selection=None, delimiter: str = ",", just_schema: bool = False
203 ):
204 import pyarrow.csv
205 from pyarrow.csv import ParseOptions
206
207 stream = io.BytesIO(buffer)
208 parse_options = ParseOptions(delimiter=delimiter, newlines_in_values=True)
209 table = pyarrow.csv.read_csv(stream, parse_options=parse_options)
210 schema = table.schema
211 if just_schema:
212 return convert_arrow_schema_to_orso_schema(schema)
213
214 if selection:
215 table = filter_records(selection, table)
216 if projection:
217 table = post_read_projector(table, projection)
218
219 return table
220
221
222 def tsv_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):
223 return csv_decoder(
224 buffer=buffer,
225 projection=projection,
226 selection=selection,
227 delimiter="\t",
228 just_schema=just_schema,
229 )
230
231
232 def arrow_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):
233 import pyarrow.feather as pf
234
235 stream = io.BytesIO(buffer)
236 table = pf.read_table(stream)
237 schema = table.schema
238 if just_schema:
239 return convert_arrow_schema_to_orso_schema(schema)
240
241 if selection:
242 table = filter_records(selection, table)
243 if projection:
244 table = post_read_projector(table, projection)
245
246 return table
247
248
249 def avro_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):
250 """
251 AVRO isn't well supported, it is converted between table types which is
252 really slow
253 """
254 try:
255 from avro.datafile import DataFileReader
256 from avro.io import DatumReader
257 except ImportError: # pragma: no-cover
258 raise Exception("`avro` is missing, please install or include in your `requirements.txt`.")
259
260 stream = io.BytesIO(buffer)
261 reader = DataFileReader(stream, DatumReader())
262
263 table = pyarrow.Table.from_pylist(list(reader))
264 schema = table.schema
265 if just_schema:
266 return convert_arrow_schema_to_orso_schema(schema)
267
268 if selection:
269 table = filter_records(selection, table)
270 if projection:
271 table = post_read_projector(table, projection)
272
273 return table
274
275
276 # for types we know about, set up how we handle them
277 KNOWN_EXTENSIONS: Dict[str, Tuple[Callable, str]] = {
278 "avro": (avro_decoder, ExtentionType.DATA),
279 "complete": (do_nothing, ExtentionType.CONTROL),
280 "ignore": (do_nothing, ExtentionType.CONTROL),
281 "arrow": (arrow_decoder, ExtentionType.DATA), # feather
282 "csv": (csv_decoder, ExtentionType.DATA),
283 "jsonl": (jsonl_decoder, ExtentionType.DATA),
284 "orc": (orc_decoder, ExtentionType.DATA),
285 "parquet": (parquet_decoder, ExtentionType.DATA),
286 "tsv": (tsv_decoder, ExtentionType.DATA),
287 "zstd": (zstd_decoder, ExtentionType.DATA), # jsonl/zstd
288 }
289
290 VALID_EXTENSIONS = set(f".{ext}" for ext in KNOWN_EXTENSIONS.keys())
291 TUPLE_OF_VALID_EXTENSIONS = tuple(VALID_EXTENSIONS)
292 DATA_EXTENSIONS = set(
293 f".{ext}" for ext, conf in KNOWN_EXTENSIONS.items() if conf[1] == ExtentionType.DATA
294 )
295
```
Path: `opteryx/__version__.py`
Content:
```
1 __build__ = 312
2
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 """
16 Store the version here so:
17 1) we don't load dependencies by storing it in __init__.py
18 2) we can import it in setup.py for the same reason
19 """
20 from enum import Enum # isort: skip
21
22
23 class VersionStatus(Enum):
24 ALPHA = "alpha"
25 BETA = "beta"
26 RELEASE = "release"
27
28
29 _major = 0
30 _minor = 13
31 _revision = 4
32 _status = VersionStatus.ALPHA
33
34 __author__ = "@joocer"
35 __version__ = f"{_major}.{_minor}.{_revision}" + (
36 f"-{_status.value}.{__build__}" if _status != VersionStatus.RELEASE else ""
37 )
38
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/opteryx/__version__.py b/opteryx/__version__.py
--- a/opteryx/__version__.py
+++ b/opteryx/__version__.py
@@ -1,4 +1,4 @@
-__build__ = 312
+__build__ = 313
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
diff --git a/opteryx/utils/file_decoders.py b/opteryx/utils/file_decoders.py
--- a/opteryx/utils/file_decoders.py
+++ b/opteryx/utils/file_decoders.py
@@ -273,6 +273,32 @@
return table
+def ipc_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):
+ from itertools import chain
+
+ from pyarrow import ipc
+
+ stream = io.BytesIO(buffer)
+ reader = ipc.open_stream(stream)
+
+ batch_one = next(reader, None)
+ if batch_one is None:
+ return None
+
+ schema = batch_one.schema
+
+ if just_schema:
+ return convert_arrow_schema_to_orso_schema(schema)
+
+ table = pyarrow.Table.from_batches([batch for batch in chain([batch_one], reader)])
+ if selection:
+ table = filter_records(selection, table)
+ if projection:
+ table = post_read_projector(table, projection)
+
+ return table
+
+
# for types we know about, set up how we handle them
KNOWN_EXTENSIONS: Dict[str, Tuple[Callable, str]] = {
"avro": (avro_decoder, ExtentionType.DATA),
@@ -280,6 +306,7 @@
"ignore": (do_nothing, ExtentionType.CONTROL),
"arrow": (arrow_decoder, ExtentionType.DATA), # feather
"csv": (csv_decoder, ExtentionType.DATA),
+ "ipc": (ipc_decoder, ExtentionType.DATA),
"jsonl": (jsonl_decoder, ExtentionType.DATA),
"orc": (orc_decoder, ExtentionType.DATA),
"parquet": (parquet_decoder, ExtentionType.DATA),
|
{"golden_diff": "diff --git a/opteryx/__version__.py b/opteryx/__version__.py\n--- a/opteryx/__version__.py\n+++ b/opteryx/__version__.py\n@@ -1,4 +1,4 @@\n-__build__ = 312\n+__build__ = 313\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.\ndiff --git a/opteryx/utils/file_decoders.py b/opteryx/utils/file_decoders.py\n--- a/opteryx/utils/file_decoders.py\n+++ b/opteryx/utils/file_decoders.py\n@@ -273,6 +273,32 @@\n return table\n \n \n+def ipc_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n+ from itertools import chain\n+\n+ from pyarrow import ipc\n+\n+ stream = io.BytesIO(buffer)\n+ reader = ipc.open_stream(stream)\n+\n+ batch_one = next(reader, None)\n+ if batch_one is None:\n+ return None\n+\n+ schema = batch_one.schema\n+\n+ if just_schema:\n+ return convert_arrow_schema_to_orso_schema(schema)\n+\n+ table = pyarrow.Table.from_batches([batch for batch in chain([batch_one], reader)])\n+ if selection:\n+ table = filter_records(selection, table)\n+ if projection:\n+ table = post_read_projector(table, projection)\n+\n+ return table\n+\n+\n # for types we know about, set up how we handle them\n KNOWN_EXTENSIONS: Dict[str, Tuple[Callable, str]] = {\n \"avro\": (avro_decoder, ExtentionType.DATA),\n@@ -280,6 +306,7 @@\n \"ignore\": (do_nothing, ExtentionType.CONTROL),\n \"arrow\": (arrow_decoder, ExtentionType.DATA), # feather\n \"csv\": (csv_decoder, ExtentionType.DATA),\n+ \"ipc\": (ipc_decoder, ExtentionType.DATA),\n \"jsonl\": (jsonl_decoder, ExtentionType.DATA),\n \"orc\": (orc_decoder, ExtentionType.DATA),\n \"parquet\": (parquet_decoder, ExtentionType.DATA),\n", "issue": "\u2728 support pyarrow's IPC format\n### Thanks for stopping by to let us know something could be better!\r\n\r\n**Is your feature request related to a problem? Please describe.** _A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]_\r\n\r\n**Describe the solution you'd like** _A clear and concise description of what you want to happen._\r\n\r\n**Describe alternatives you've considered** _A clear and concise description of any alternative solutions or features you've considered._\r\n\r\n**Additional context** _Add any other context or screenshots about the feature request here._\r\n\n", "before_files": [{"content": "# 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\n\"\"\"\nDecode files from a raw binary format to a PyArrow Table.\n\"\"\"\nimport io\nfrom enum import Enum\nfrom typing import Callable\nfrom typing import Dict\nfrom typing import List\nfrom typing import Tuple\n\nimport numpy\nimport pyarrow\nfrom orso.tools import random_string\n\nfrom opteryx.exceptions import UnsupportedFileTypeError\nfrom opteryx.utils.arrow import post_read_projector\n\n\nclass ExtentionType(str, Enum):\n \"\"\"labels for the file extentions\"\"\"\n\n DATA = \"DATA\"\n CONTROL = \"CONTROL\"\n\n\ndef convert_arrow_schema_to_orso_schema(arrow_schema):\n from orso.schema import FlatColumn\n from orso.schema import RelationSchema\n\n return RelationSchema(\n name=\"arrow\",\n columns=[FlatColumn.from_arrow(field) for field in arrow_schema],\n )\n\n\ndef get_decoder(dataset: str) -> Callable:\n \"\"\"helper routine to get the decoder for a given file\"\"\"\n ext = dataset.split(\".\")[-1].lower()\n if ext not in KNOWN_EXTENSIONS: # pragma: no cover\n raise UnsupportedFileTypeError(f\"Unsupported file type - {ext}\")\n file_decoder, file_type = KNOWN_EXTENSIONS[ext]\n if file_type != ExtentionType.DATA: # pragma: no cover\n raise UnsupportedFileTypeError(f\"File is not a data file - {ext}\")\n return file_decoder\n\n\ndef do_nothing(buffer, projection=None, just_schema: bool = False): # pragma: no cover\n \"\"\"for when you need to look like you're doing something\"\"\"\n return False\n\n\ndef filter_records(filter, table):\n \"\"\"\n When we can't push predicates to the actual read, use this to filter records\n just after the read.\n \"\"\"\n # notes:\n # at this point we've not renamed any columns, this may affect some filters\n from opteryx.managers.expression import NodeType\n from opteryx.managers.expression import evaluate\n from opteryx.models import Node\n\n if isinstance(filter, list) and filter:\n filter_copy = [p for p in filter]\n root = filter_copy.pop()\n\n if root.left.node_type == NodeType.IDENTIFIER:\n root.left.schema_column.identity = root.left.source_column\n if root.right.node_type == NodeType.IDENTIFIER:\n root.right.schema_column.identity = root.right.source_column\n\n while filter_copy:\n right = filter_copy.pop()\n if right.left.node_type == NodeType.IDENTIFIER:\n right.left.schema_column.identity = right.left.source_column\n if right.right.node_type == NodeType.IDENTIFIER:\n right.right.schema_column.identity = right.right.source_column\n root = Node(\n NodeType.AND, left=root, right=right, schema_column=Node(identity=random_string())\n )\n else:\n root = filter\n\n mask = evaluate(root, table)\n return table.filter(mask)\n\n\ndef zstd_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n \"\"\"\n Read zstandard compressed JSONL files\n \"\"\"\n import zstandard\n\n stream = io.BytesIO(buffer)\n\n with zstandard.open(stream, \"rb\") as file:\n return jsonl_decoder(\n file, projection=projection, selection=selection, just_schema=just_schema\n )\n\n\ndef parquet_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n \"\"\"\n Read parquet formatted files.\n \"\"\"\n from pyarrow import parquet\n\n from opteryx.connectors.capabilities import PredicatePushable\n\n # Convert the selection to DNF format if applicable\n _select, selection = PredicatePushable.to_dnf(selection) if selection else (None, None)\n\n stream = io.BytesIO(buffer)\n\n if projection or just_schema:\n # Open the parquet file only once\n parquet_file = parquet.ParquetFile(stream)\n\n # Return just the schema if that's all that's needed\n if just_schema:\n return convert_arrow_schema_to_orso_schema(parquet_file.schema_arrow)\n\n # Special handling for projection of [\"count_*\"]\n if projection == [\"count_*\"]:\n return pyarrow.Table.from_pydict(\n {\"_\": numpy.full(parquet_file.metadata.num_rows, True, dtype=numpy.bool_)}\n )\n\n # Projection processing\n schema_columns_set = set(parquet_file.schema_arrow.names)\n projection_names = {name for proj_col in projection for name in proj_col.all_names}\n selected_columns = list(schema_columns_set.intersection(projection_names))\n\n # If no columns are selected, set to None\n if not selected_columns:\n selected_columns = None\n else:\n selected_columns = None\n\n # Read the parquet table with the optimized column list and selection filters\n table = parquet.read_table(stream, columns=selected_columns, pre_buffer=False, filters=_select)\n if selection:\n table = filter_records(selection, table)\n return table\n\n\ndef orc_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n \"\"\"\n Read orc formatted files\n \"\"\"\n import pyarrow.orc as orc\n\n stream = io.BytesIO(buffer)\n orc_file = orc.ORCFile(stream)\n\n if just_schema:\n orc_schema = orc_file.schema\n return convert_arrow_schema_to_orso_schema(orc_schema)\n\n table = orc_file.read()\n if selection:\n table = filter_records(selection, table)\n if projection:\n table = post_read_projector(table, projection)\n return table\n\n\ndef jsonl_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n import pyarrow.json\n\n if isinstance(buffer, bytes):\n stream = io.BytesIO(buffer)\n else:\n stream = buffer\n\n table = pyarrow.json.read_json(stream)\n schema = table.schema\n if just_schema:\n return convert_arrow_schema_to_orso_schema(schema)\n\n if selection:\n table = filter_records(selection, table)\n if projection:\n table = post_read_projector(table, projection)\n\n return table\n\n\ndef csv_decoder(\n buffer, projection: List = None, selection=None, delimiter: str = \",\", just_schema: bool = False\n):\n import pyarrow.csv\n from pyarrow.csv import ParseOptions\n\n stream = io.BytesIO(buffer)\n parse_options = ParseOptions(delimiter=delimiter, newlines_in_values=True)\n table = pyarrow.csv.read_csv(stream, parse_options=parse_options)\n schema = table.schema\n if just_schema:\n return convert_arrow_schema_to_orso_schema(schema)\n\n if selection:\n table = filter_records(selection, table)\n if projection:\n table = post_read_projector(table, projection)\n\n return table\n\n\ndef tsv_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n return csv_decoder(\n buffer=buffer,\n projection=projection,\n selection=selection,\n delimiter=\"\\t\",\n just_schema=just_schema,\n )\n\n\ndef arrow_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n import pyarrow.feather as pf\n\n stream = io.BytesIO(buffer)\n table = pf.read_table(stream)\n schema = table.schema\n if just_schema:\n return convert_arrow_schema_to_orso_schema(schema)\n\n if selection:\n table = filter_records(selection, table)\n if projection:\n table = post_read_projector(table, projection)\n\n return table\n\n\ndef avro_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n \"\"\"\n AVRO isn't well supported, it is converted between table types which is\n really slow\n \"\"\"\n try:\n from avro.datafile import DataFileReader\n from avro.io import DatumReader\n except ImportError: # pragma: no-cover\n raise Exception(\"`avro` is missing, please install or include in your `requirements.txt`.\")\n\n stream = io.BytesIO(buffer)\n reader = DataFileReader(stream, DatumReader())\n\n table = pyarrow.Table.from_pylist(list(reader))\n schema = table.schema\n if just_schema:\n return convert_arrow_schema_to_orso_schema(schema)\n\n if selection:\n table = filter_records(selection, table)\n if projection:\n table = post_read_projector(table, projection)\n\n return table\n\n\n# for types we know about, set up how we handle them\nKNOWN_EXTENSIONS: Dict[str, Tuple[Callable, str]] = {\n \"avro\": (avro_decoder, ExtentionType.DATA),\n \"complete\": (do_nothing, ExtentionType.CONTROL),\n \"ignore\": (do_nothing, ExtentionType.CONTROL),\n \"arrow\": (arrow_decoder, ExtentionType.DATA), # feather\n \"csv\": (csv_decoder, ExtentionType.DATA),\n \"jsonl\": (jsonl_decoder, ExtentionType.DATA),\n \"orc\": (orc_decoder, ExtentionType.DATA),\n \"parquet\": (parquet_decoder, ExtentionType.DATA),\n \"tsv\": (tsv_decoder, ExtentionType.DATA),\n \"zstd\": (zstd_decoder, ExtentionType.DATA), # jsonl/zstd\n}\n\nVALID_EXTENSIONS = set(f\".{ext}\" for ext in KNOWN_EXTENSIONS.keys())\nTUPLE_OF_VALID_EXTENSIONS = tuple(VALID_EXTENSIONS)\nDATA_EXTENSIONS = set(\n f\".{ext}\" for ext, conf in KNOWN_EXTENSIONS.items() if conf[1] == ExtentionType.DATA\n)\n", "path": "opteryx/utils/file_decoders.py"}, {"content": "__build__ = 312\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\n\"\"\"\nStore the version here so:\n1) we don't load dependencies by storing it in __init__.py\n2) we can import it in setup.py for the same reason\n\"\"\"\nfrom enum import Enum # isort: skip\n\n\nclass VersionStatus(Enum):\n ALPHA = \"alpha\"\n BETA = \"beta\"\n RELEASE = \"release\"\n\n\n_major = 0\n_minor = 13\n_revision = 4\n_status = VersionStatus.ALPHA\n\n__author__ = \"@joocer\"\n__version__ = f\"{_major}.{_minor}.{_revision}\" + (\n f\"-{_status.value}.{__build__}\" if _status != VersionStatus.RELEASE else \"\"\n)\n", "path": "opteryx/__version__.py"}], "after_files": [{"content": "# 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\n\"\"\"\nDecode files from a raw binary format to a PyArrow Table.\n\"\"\"\nimport io\nfrom enum import Enum\nfrom typing import Callable\nfrom typing import Dict\nfrom typing import List\nfrom typing import Tuple\n\nimport numpy\nimport pyarrow\nfrom orso.tools import random_string\n\nfrom opteryx.exceptions import UnsupportedFileTypeError\nfrom opteryx.utils.arrow import post_read_projector\n\n\nclass ExtentionType(str, Enum):\n \"\"\"labels for the file extentions\"\"\"\n\n DATA = \"DATA\"\n CONTROL = \"CONTROL\"\n\n\ndef convert_arrow_schema_to_orso_schema(arrow_schema):\n from orso.schema import FlatColumn\n from orso.schema import RelationSchema\n\n return RelationSchema(\n name=\"arrow\",\n columns=[FlatColumn.from_arrow(field) for field in arrow_schema],\n )\n\n\ndef get_decoder(dataset: str) -> Callable:\n \"\"\"helper routine to get the decoder for a given file\"\"\"\n ext = dataset.split(\".\")[-1].lower()\n if ext not in KNOWN_EXTENSIONS: # pragma: no cover\n raise UnsupportedFileTypeError(f\"Unsupported file type - {ext}\")\n file_decoder, file_type = KNOWN_EXTENSIONS[ext]\n if file_type != ExtentionType.DATA: # pragma: no cover\n raise UnsupportedFileTypeError(f\"File is not a data file - {ext}\")\n return file_decoder\n\n\ndef do_nothing(buffer, projection=None, just_schema: bool = False): # pragma: no cover\n \"\"\"for when you need to look like you're doing something\"\"\"\n return False\n\n\ndef filter_records(filter, table):\n \"\"\"\n When we can't push predicates to the actual read, use this to filter records\n just after the read.\n \"\"\"\n # notes:\n # at this point we've not renamed any columns, this may affect some filters\n from opteryx.managers.expression import NodeType\n from opteryx.managers.expression import evaluate\n from opteryx.models import Node\n\n if isinstance(filter, list) and filter:\n filter_copy = [p for p in filter]\n root = filter_copy.pop()\n\n if root.left.node_type == NodeType.IDENTIFIER:\n root.left.schema_column.identity = root.left.source_column\n if root.right.node_type == NodeType.IDENTIFIER:\n root.right.schema_column.identity = root.right.source_column\n\n while filter_copy:\n right = filter_copy.pop()\n if right.left.node_type == NodeType.IDENTIFIER:\n right.left.schema_column.identity = right.left.source_column\n if right.right.node_type == NodeType.IDENTIFIER:\n right.right.schema_column.identity = right.right.source_column\n root = Node(\n NodeType.AND, left=root, right=right, schema_column=Node(identity=random_string())\n )\n else:\n root = filter\n\n mask = evaluate(root, table)\n return table.filter(mask)\n\n\ndef zstd_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n \"\"\"\n Read zstandard compressed JSONL files\n \"\"\"\n import zstandard\n\n stream = io.BytesIO(buffer)\n\n with zstandard.open(stream, \"rb\") as file:\n return jsonl_decoder(\n file, projection=projection, selection=selection, just_schema=just_schema\n )\n\n\ndef parquet_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n \"\"\"\n Read parquet formatted files.\n \"\"\"\n from pyarrow import parquet\n\n from opteryx.connectors.capabilities import PredicatePushable\n\n # Convert the selection to DNF format if applicable\n _select, selection = PredicatePushable.to_dnf(selection) if selection else (None, None)\n\n stream = io.BytesIO(buffer)\n\n if projection or just_schema:\n # Open the parquet file only once\n parquet_file = parquet.ParquetFile(stream)\n\n # Return just the schema if that's all that's needed\n if just_schema:\n return convert_arrow_schema_to_orso_schema(parquet_file.schema_arrow)\n\n # Special handling for projection of [\"count_*\"]\n if projection == [\"count_*\"]:\n return pyarrow.Table.from_pydict(\n {\"_\": numpy.full(parquet_file.metadata.num_rows, True, dtype=numpy.bool_)}\n )\n\n # Projection processing\n schema_columns_set = set(parquet_file.schema_arrow.names)\n projection_names = {name for proj_col in projection for name in proj_col.all_names}\n selected_columns = list(schema_columns_set.intersection(projection_names))\n\n # If no columns are selected, set to None\n if not selected_columns:\n selected_columns = None\n else:\n selected_columns = None\n\n # Read the parquet table with the optimized column list and selection filters\n table = parquet.read_table(stream, columns=selected_columns, pre_buffer=False, filters=_select)\n if selection:\n table = filter_records(selection, table)\n return table\n\n\ndef orc_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n \"\"\"\n Read orc formatted files\n \"\"\"\n import pyarrow.orc as orc\n\n stream = io.BytesIO(buffer)\n orc_file = orc.ORCFile(stream)\n\n if just_schema:\n orc_schema = orc_file.schema\n return convert_arrow_schema_to_orso_schema(orc_schema)\n\n table = orc_file.read()\n if selection:\n table = filter_records(selection, table)\n if projection:\n table = post_read_projector(table, projection)\n return table\n\n\ndef jsonl_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n import pyarrow.json\n\n if isinstance(buffer, bytes):\n stream = io.BytesIO(buffer)\n else:\n stream = buffer\n\n table = pyarrow.json.read_json(stream)\n schema = table.schema\n if just_schema:\n return convert_arrow_schema_to_orso_schema(schema)\n\n if selection:\n table = filter_records(selection, table)\n if projection:\n table = post_read_projector(table, projection)\n\n return table\n\n\ndef csv_decoder(\n buffer, projection: List = None, selection=None, delimiter: str = \",\", just_schema: bool = False\n):\n import pyarrow.csv\n from pyarrow.csv import ParseOptions\n\n stream = io.BytesIO(buffer)\n parse_options = ParseOptions(delimiter=delimiter, newlines_in_values=True)\n table = pyarrow.csv.read_csv(stream, parse_options=parse_options)\n schema = table.schema\n if just_schema:\n return convert_arrow_schema_to_orso_schema(schema)\n\n if selection:\n table = filter_records(selection, table)\n if projection:\n table = post_read_projector(table, projection)\n\n return table\n\n\ndef tsv_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n return csv_decoder(\n buffer=buffer,\n projection=projection,\n selection=selection,\n delimiter=\"\\t\",\n just_schema=just_schema,\n )\n\n\ndef arrow_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n import pyarrow.feather as pf\n\n stream = io.BytesIO(buffer)\n table = pf.read_table(stream)\n schema = table.schema\n if just_schema:\n return convert_arrow_schema_to_orso_schema(schema)\n\n if selection:\n table = filter_records(selection, table)\n if projection:\n table = post_read_projector(table, projection)\n\n return table\n\n\ndef avro_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n \"\"\"\n AVRO isn't well supported, it is converted between table types which is\n really slow\n \"\"\"\n try:\n from avro.datafile import DataFileReader\n from avro.io import DatumReader\n except ImportError: # pragma: no-cover\n raise Exception(\"`avro` is missing, please install or include in your `requirements.txt`.\")\n\n stream = io.BytesIO(buffer)\n reader = DataFileReader(stream, DatumReader())\n\n table = pyarrow.Table.from_pylist(list(reader))\n schema = table.schema\n if just_schema:\n return convert_arrow_schema_to_orso_schema(schema)\n\n if selection:\n table = filter_records(selection, table)\n if projection:\n table = post_read_projector(table, projection)\n\n return table\n\n\ndef ipc_decoder(buffer, projection: List = None, selection=None, just_schema: bool = False):\n from itertools import chain\n\n from pyarrow import ipc\n\n stream = io.BytesIO(buffer)\n reader = ipc.open_stream(stream)\n\n batch_one = next(reader, None)\n if batch_one is None:\n return None\n\n schema = batch_one.schema\n\n if just_schema:\n return convert_arrow_schema_to_orso_schema(schema)\n\n table = pyarrow.Table.from_batches([batch for batch in chain([batch_one], reader)])\n if selection:\n table = filter_records(selection, table)\n if projection:\n table = post_read_projector(table, projection)\n\n return table\n\n\n# for types we know about, set up how we handle them\nKNOWN_EXTENSIONS: Dict[str, Tuple[Callable, str]] = {\n \"avro\": (avro_decoder, ExtentionType.DATA),\n \"complete\": (do_nothing, ExtentionType.CONTROL),\n \"ignore\": (do_nothing, ExtentionType.CONTROL),\n \"arrow\": (arrow_decoder, ExtentionType.DATA), # feather\n \"csv\": (csv_decoder, ExtentionType.DATA),\n \"ipc\": (ipc_decoder, ExtentionType.DATA),\n \"jsonl\": (jsonl_decoder, ExtentionType.DATA),\n \"orc\": (orc_decoder, ExtentionType.DATA),\n \"parquet\": (parquet_decoder, ExtentionType.DATA),\n \"tsv\": (tsv_decoder, ExtentionType.DATA),\n \"zstd\": (zstd_decoder, ExtentionType.DATA), # jsonl/zstd\n}\n\nVALID_EXTENSIONS = set(f\".{ext}\" for ext in KNOWN_EXTENSIONS.keys())\nTUPLE_OF_VALID_EXTENSIONS = tuple(VALID_EXTENSIONS)\nDATA_EXTENSIONS = set(\n f\".{ext}\" for ext, conf in KNOWN_EXTENSIONS.items() if conf[1] == ExtentionType.DATA\n)\n", "path": "opteryx/utils/file_decoders.py"}, {"content": "__build__ = 313\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\n\"\"\"\nStore the version here so:\n1) we don't load dependencies by storing it in __init__.py\n2) we can import it in setup.py for the same reason\n\"\"\"\nfrom enum import Enum # isort: skip\n\n\nclass VersionStatus(Enum):\n ALPHA = \"alpha\"\n BETA = \"beta\"\n RELEASE = \"release\"\n\n\n_major = 0\n_minor = 13\n_revision = 4\n_status = VersionStatus.ALPHA\n\n__author__ = \"@joocer\"\n__version__ = f\"{_major}.{_minor}.{_revision}\" + (\n f\"-{_status.value}.{__build__}\" if _status != VersionStatus.RELEASE else \"\"\n)\n", "path": "opteryx/__version__.py"}]}
| 3,715 | 496 |
gh_patches_debug_11377
|
rasdani/github-patches
|
git_diff
|
Kinto__kinto-496
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
flush_endpoint capability added if flush_enabled (fixes #496)
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `kinto/__init__.py`
Content:
```
1 import pkg_resources
2 import logging
3
4 import cliquet
5 from pyramid.config import Configurator
6 from pyramid.settings import asbool
7 from pyramid.security import Authenticated
8
9 from kinto.authorization import RouteFactory
10
11 # Module version, as defined in PEP-0396.
12 __version__ = pkg_resources.get_distribution(__package__).version
13
14 # Implemented HTTP API Version
15 HTTP_API_VERSION = '1.4'
16
17 # Main kinto logger
18 logger = logging.getLogger(__name__)
19
20
21 DEFAULT_SETTINGS = {
22 'retry_after_seconds': 3,
23 'cache_backend': 'cliquet.cache.memory',
24 'permission_backend': 'cliquet.permission.memory',
25 'storage_backend': 'cliquet.storage.memory',
26 'project_docs': 'https://kinto.readthedocs.org/',
27 'bucket_create_principals': Authenticated,
28 'multiauth.authorization_policy': (
29 'kinto.authorization.AuthorizationPolicy'),
30 'experimental_collection_schema_validation': 'False',
31 'http_api_version': HTTP_API_VERSION
32 }
33
34
35 def main(global_config, config=None, **settings):
36 if not config:
37 config = Configurator(settings=settings, root_factory=RouteFactory)
38
39 # Force project name, since it determines settings prefix.
40 config.add_settings({'cliquet.project_name': 'kinto'})
41
42 cliquet.initialize(config,
43 version=__version__,
44 default_settings=DEFAULT_SETTINGS)
45
46 settings = config.get_settings()
47
48 # In Kinto API 1.x, a default bucket is available.
49 # Force its inclusion if not specified in settings.
50 if 'kinto.plugins.default_bucket' not in settings['includes']:
51 config.include('kinto.plugins.default_bucket')
52
53 # Retro-compatibility with first Kinto clients.
54 config.registry.public_settings.add('cliquet.batch_max_requests')
55
56 # Expose capability
57 schema_enabled = asbool(
58 settings['experimental_collection_schema_validation']
59 )
60 if schema_enabled:
61 config.add_api_capability(
62 "schema",
63 description="Validates collection records with JSON schemas.",
64 url="http://kinto.readthedocs.org/en/latest/api/1.x/"
65 "collections.html#collection-json-schema")
66
67 # Scan Kinto views.
68 kwargs = {}
69 flush_enabled = asbool(settings.get('flush_endpoint_enabled'))
70 if not flush_enabled:
71 kwargs['ignore'] = 'kinto.views.flush'
72 config.scan("kinto.views", **kwargs)
73
74 app = config.make_wsgi_app()
75
76 # Install middleware (idempotent if disabled)
77 return cliquet.install_middlewares(app, settings)
78
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/kinto/__init__.py b/kinto/__init__.py
--- a/kinto/__init__.py
+++ b/kinto/__init__.py
@@ -67,7 +67,16 @@
# Scan Kinto views.
kwargs = {}
flush_enabled = asbool(settings.get('flush_endpoint_enabled'))
- if not flush_enabled:
+
+ if flush_enabled:
+ config.add_api_capability(
+ "flush_endpoint",
+ description="The __flush__ endpoint can be used to remove all "
+ "data from all backends.",
+ url="http://kinto.readthedocs.org/en/latest/configuration/"
+ "settings.html#activating-the-flush-endpoint"
+ )
+ else:
kwargs['ignore'] = 'kinto.views.flush'
config.scan("kinto.views", **kwargs)
|
{"golden_diff": "diff --git a/kinto/__init__.py b/kinto/__init__.py\n--- a/kinto/__init__.py\n+++ b/kinto/__init__.py\n@@ -67,7 +67,16 @@\n # Scan Kinto views.\n kwargs = {}\n flush_enabled = asbool(settings.get('flush_endpoint_enabled'))\n- if not flush_enabled:\n+\n+ if flush_enabled:\n+ config.add_api_capability(\n+ \"flush_endpoint\",\n+ description=\"The __flush__ endpoint can be used to remove all \"\n+ \"data from all backends.\",\n+ url=\"http://kinto.readthedocs.org/en/latest/configuration/\"\n+ \"settings.html#activating-the-flush-endpoint\"\n+ )\n+ else:\n kwargs['ignore'] = 'kinto.views.flush'\n config.scan(\"kinto.views\", **kwargs)\n", "issue": "flush_endpoint capability added if flush_enabled (fixes #496)\n\n", "before_files": [{"content": "import pkg_resources\nimport logging\n\nimport cliquet\nfrom pyramid.config import Configurator\nfrom pyramid.settings import asbool\nfrom pyramid.security import Authenticated\n\nfrom kinto.authorization import RouteFactory\n\n# Module version, as defined in PEP-0396.\n__version__ = pkg_resources.get_distribution(__package__).version\n\n# Implemented HTTP API Version\nHTTP_API_VERSION = '1.4'\n\n# Main kinto logger\nlogger = logging.getLogger(__name__)\n\n\nDEFAULT_SETTINGS = {\n 'retry_after_seconds': 3,\n 'cache_backend': 'cliquet.cache.memory',\n 'permission_backend': 'cliquet.permission.memory',\n 'storage_backend': 'cliquet.storage.memory',\n 'project_docs': 'https://kinto.readthedocs.org/',\n 'bucket_create_principals': Authenticated,\n 'multiauth.authorization_policy': (\n 'kinto.authorization.AuthorizationPolicy'),\n 'experimental_collection_schema_validation': 'False',\n 'http_api_version': HTTP_API_VERSION\n}\n\n\ndef main(global_config, config=None, **settings):\n if not config:\n config = Configurator(settings=settings, root_factory=RouteFactory)\n\n # Force project name, since it determines settings prefix.\n config.add_settings({'cliquet.project_name': 'kinto'})\n\n cliquet.initialize(config,\n version=__version__,\n default_settings=DEFAULT_SETTINGS)\n\n settings = config.get_settings()\n\n # In Kinto API 1.x, a default bucket is available.\n # Force its inclusion if not specified in settings.\n if 'kinto.plugins.default_bucket' not in settings['includes']:\n config.include('kinto.plugins.default_bucket')\n\n # Retro-compatibility with first Kinto clients.\n config.registry.public_settings.add('cliquet.batch_max_requests')\n\n # Expose capability\n schema_enabled = asbool(\n settings['experimental_collection_schema_validation']\n )\n if schema_enabled:\n config.add_api_capability(\n \"schema\",\n description=\"Validates collection records with JSON schemas.\",\n url=\"http://kinto.readthedocs.org/en/latest/api/1.x/\"\n \"collections.html#collection-json-schema\")\n\n # Scan Kinto views.\n kwargs = {}\n flush_enabled = asbool(settings.get('flush_endpoint_enabled'))\n if not flush_enabled:\n kwargs['ignore'] = 'kinto.views.flush'\n config.scan(\"kinto.views\", **kwargs)\n\n app = config.make_wsgi_app()\n\n # Install middleware (idempotent if disabled)\n return cliquet.install_middlewares(app, settings)\n", "path": "kinto/__init__.py"}], "after_files": [{"content": "import pkg_resources\nimport logging\n\nimport cliquet\nfrom pyramid.config import Configurator\nfrom pyramid.settings import asbool\nfrom pyramid.security import Authenticated\n\nfrom kinto.authorization import RouteFactory\n\n# Module version, as defined in PEP-0396.\n__version__ = pkg_resources.get_distribution(__package__).version\n\n# Implemented HTTP API Version\nHTTP_API_VERSION = '1.4'\n\n# Main kinto logger\nlogger = logging.getLogger(__name__)\n\n\nDEFAULT_SETTINGS = {\n 'retry_after_seconds': 3,\n 'cache_backend': 'cliquet.cache.memory',\n 'permission_backend': 'cliquet.permission.memory',\n 'storage_backend': 'cliquet.storage.memory',\n 'project_docs': 'https://kinto.readthedocs.org/',\n 'bucket_create_principals': Authenticated,\n 'multiauth.authorization_policy': (\n 'kinto.authorization.AuthorizationPolicy'),\n 'experimental_collection_schema_validation': 'False',\n 'http_api_version': HTTP_API_VERSION\n}\n\n\ndef main(global_config, config=None, **settings):\n if not config:\n config = Configurator(settings=settings, root_factory=RouteFactory)\n\n # Force project name, since it determines settings prefix.\n config.add_settings({'cliquet.project_name': 'kinto'})\n\n cliquet.initialize(config,\n version=__version__,\n default_settings=DEFAULT_SETTINGS)\n\n settings = config.get_settings()\n\n # In Kinto API 1.x, a default bucket is available.\n # Force its inclusion if not specified in settings.\n if 'kinto.plugins.default_bucket' not in settings['includes']:\n config.include('kinto.plugins.default_bucket')\n\n # Retro-compatibility with first Kinto clients.\n config.registry.public_settings.add('cliquet.batch_max_requests')\n\n # Expose capability\n schema_enabled = asbool(\n settings['experimental_collection_schema_validation']\n )\n if schema_enabled:\n config.add_api_capability(\n \"schema\",\n description=\"Validates collection records with JSON schemas.\",\n url=\"http://kinto.readthedocs.org/en/latest/api/1.x/\"\n \"collections.html#collection-json-schema\")\n\n # Scan Kinto views.\n kwargs = {}\n flush_enabled = asbool(settings.get('flush_endpoint_enabled'))\n\n if flush_enabled:\n config.add_api_capability(\n \"flush_endpoint\",\n description=\"The __flush__ endpoint can be used to remove all \"\n \"data from all backends.\",\n url=\"http://kinto.readthedocs.org/en/latest/configuration/\"\n \"settings.html#activating-the-flush-endpoint\"\n )\n else:\n kwargs['ignore'] = 'kinto.views.flush'\n config.scan(\"kinto.views\", **kwargs)\n\n app = config.make_wsgi_app()\n\n # Install middleware (idempotent if disabled)\n return cliquet.install_middlewares(app, settings)\n", "path": "kinto/__init__.py"}]}
| 968 | 185 |
gh_patches_debug_21857
|
rasdani/github-patches
|
git_diff
|
kserve__kserve-362
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Support insecure minio connections
/kind feature
For local deployments (e.g. with Kubeflow), TLS is not configured for minio. When trying to deploy a model stored there, kfserving issues SSLError messages.
```Caused by SSLError(SSLError(1, '[SSL: WRONG_VERSION_NUMBER] wrong version number (_ssl.c:1056)')```
This is due to a hard-coded setting in [storage.py](https://github.com/kubeflow/kfserving/blob/master/python/kfserving/kfserving/storage.py#L194), with no way to override it.
**Describe the solution you'd like**
It should be possible to allow insecure connections to minio, having secure connection as default. The user should be able to do this either by specifying an S3_ENDPOINT with http scheme or by using a flag explicitly.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `python/kfserving/kfserving/storage.py`
Content:
```
1 # Copyright 2019 kubeflow.org.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 import glob
16 import logging
17 import tempfile
18 import os
19 import re
20 from azure.common import AzureMissingResourceHttpError
21 from azure.storage.blob import BlockBlobService
22 from google.auth import exceptions
23 from google.cloud import storage
24 from minio import Minio
25
26 _GCS_PREFIX = "gs://"
27 _S3_PREFIX = "s3://"
28 _BLOB_RE = "https://(.+?).blob.core.windows.net/(.+)"
29 _LOCAL_PREFIX = "file://"
30
31
32 class Storage(object): # pylint: disable=too-few-public-methods
33 @staticmethod
34 def download(uri: str, out_dir: str = None) -> str:
35 logging.info("Copying contents of %s to local", uri)
36
37 is_local = False
38 if uri.startswith(_LOCAL_PREFIX) or os.path.exists(uri):
39 is_local = True
40
41 if out_dir is None:
42 if is_local:
43 # noop if out_dir is not set and the path is local
44 return Storage._download_local(uri)
45 out_dir = tempfile.mkdtemp()
46
47 if uri.startswith(_GCS_PREFIX):
48 Storage._download_gcs(uri, out_dir)
49 elif uri.startswith(_S3_PREFIX):
50 Storage._download_s3(uri, out_dir)
51 elif re.search(_BLOB_RE, uri):
52 Storage._download_blob(uri, out_dir)
53 elif is_local:
54 return Storage._download_local(uri, out_dir)
55 else:
56 raise Exception("Cannot recognize storage type for " + uri +
57 "\n'%s', '%s', and '%s' are the current available storage type." %
58 (_GCS_PREFIX, _S3_PREFIX, _LOCAL_PREFIX))
59
60 logging.info("Successfully copied %s to %s", uri, out_dir)
61 return out_dir
62
63 @staticmethod
64 def _download_s3(uri, temp_dir: str):
65 client = Storage._create_minio_client()
66 bucket_args = uri.replace(_S3_PREFIX, "", 1).split("/", 1)
67 bucket_name = bucket_args[0]
68 bucket_path = bucket_args[1] if len(bucket_args) > 1 else ""
69 objects = client.list_objects(bucket_name, prefix=bucket_path, recursive=True)
70 for obj in objects:
71 # Replace any prefix from the object key with temp_dir
72 subdir_object_key = obj.object_name.replace(bucket_path, "", 1).strip("/")
73 if subdir_object_key == "":
74 subdir_object_key = obj.object_name.split("/")[-1]
75 client.fget_object(bucket_name, obj.object_name,
76 os.path.join(temp_dir, subdir_object_key))
77
78 @staticmethod
79 def _download_gcs(uri, temp_dir: str):
80 try:
81 storage_client = storage.Client()
82 except exceptions.DefaultCredentialsError:
83 storage_client = storage.Client.create_anonymous_client()
84 bucket_args = uri.replace(_GCS_PREFIX, "", 1).split("/", 1)
85 bucket_name = bucket_args[0]
86 bucket_path = bucket_args[1] if len(bucket_args) > 1 else ""
87 bucket = storage_client.bucket(bucket_name)
88 prefix = bucket_path
89 if not prefix.endswith("/"):
90 prefix = prefix + "/"
91 blobs = bucket.list_blobs(prefix=prefix)
92 for blob in blobs:
93 # Replace any prefix from the object key with temp_dir
94 subdir_object_key = blob.name.replace(bucket_path, "", 1).strip("/")
95
96 # Create necessary subdirectory to store the object locally
97 if "/" in subdir_object_key:
98 local_object_dir = os.path.join(temp_dir, subdir_object_key.rsplit("/", 1)[0])
99 if not os.path.isdir(local_object_dir):
100 os.makedirs(local_object_dir, exist_ok=True)
101 if subdir_object_key.strip() != "":
102 dest_path = os.path.join(temp_dir, subdir_object_key)
103 logging.info("Downloading: %s", dest_path)
104 blob.download_to_filename(dest_path)
105
106 @staticmethod
107 def _download_blob(uri, out_dir: str): # pylint: disable=too-many-locals
108 match = re.search(_BLOB_RE, uri)
109 account_name = match.group(1)
110 storage_url = match.group(2)
111 container_name, prefix = storage_url.split("/", 1)
112
113 logging.info("Connecting to BLOB account: [%s], container: [%s], prefix: [%s]",
114 account_name,
115 container_name,
116 prefix)
117 try:
118 block_blob_service = BlockBlobService(account_name=account_name)
119 blobs = block_blob_service.list_blobs(container_name, prefix=prefix)
120 except AzureMissingResourceHttpError:
121 token = Storage._get_azure_storage_token()
122 if token is None:
123 logging.warning("Azure credentials not found, retrying anonymous access")
124 block_blob_service = BlockBlobService(account_name=account_name, token_credential=token)
125 blobs = block_blob_service.list_blobs(container_name, prefix=prefix)
126
127 for blob in blobs:
128 dest_path = os.path.join(out_dir, blob.name)
129 if "/" in blob.name:
130 head, tail = os.path.split(blob.name)
131 if prefix is not None:
132 head = head[len(prefix):]
133 if head.startswith('/'):
134 head = head[1:]
135 dir_path = os.path.join(out_dir, head)
136 dest_path = os.path.join(dir_path, tail)
137 if not os.path.isdir(dir_path):
138 os.makedirs(dir_path)
139
140 logging.info("Downloading: %s to %s", blob.name, dest_path)
141 block_blob_service.get_blob_to_path(container_name, blob.name, dest_path)
142
143 @staticmethod
144 def _get_azure_storage_token():
145 tenant_id = os.getenv("AZ_TENANT_ID", "")
146 client_id = os.getenv("AZ_CLIENT_ID", "")
147 client_secret = os.getenv("AZ_CLIENT_SECRET", "")
148 subscription_id = os.getenv("AZ_SUBSCRIPTION_ID", "")
149
150 if tenant_id == "" or client_id == "" or client_secret == "" or subscription_id == "":
151 return None
152
153 # note the SP must have "Storage Blob Data Owner" perms for this to work
154 import adal
155 from azure.storage.common import TokenCredential
156
157 authority_url = "https://login.microsoftonline.com/" + tenant_id
158
159 context = adal.AuthenticationContext(authority_url)
160
161 token = context.acquire_token_with_client_credentials(
162 "https://storage.azure.com/",
163 client_id,
164 client_secret)
165
166 token_credential = TokenCredential(token["accessToken"])
167
168 logging.info("Retrieved SP token credential for client_id: %s", client_id)
169
170 return token_credential
171
172 @staticmethod
173 def _download_local(uri, out_dir=None):
174 local_path = uri.replace(_LOCAL_PREFIX, "", 1)
175 if not os.path.exists(local_path):
176 raise Exception("Local path %s does not exist." % (uri))
177
178 if out_dir is None:
179 return local_path
180 elif not os.path.isdir(out_dir):
181 os.makedirs(out_dir)
182
183 if os.path.isdir(local_path):
184 local_path = os.path.join(local_path, "*")
185
186 for src in glob.glob(local_path):
187 _, tail = os.path.split(src)
188 dest_path = os.path.join(out_dir, tail)
189 logging.info("Linking: %s to %s", src, dest_path)
190 os.symlink(src, dest_path)
191 return out_dir
192
193 @staticmethod
194 def _create_minio_client():
195 # Remove possible http scheme for Minio
196 url = re.compile(r"https?://")
197 minioClient = Minio(url.sub("", os.getenv("S3_ENDPOINT", "")),
198 access_key=os.getenv("AWS_ACCESS_KEY_ID", ""),
199 secret_key=os.getenv("AWS_SECRET_ACCESS_KEY", ""),
200 secure=True)
201 return minioClient
202
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/python/kfserving/kfserving/storage.py b/python/kfserving/kfserving/storage.py
--- a/python/kfserving/kfserving/storage.py
+++ b/python/kfserving/kfserving/storage.py
@@ -17,6 +17,7 @@
import tempfile
import os
import re
+from urllib.parse import urlparse
from azure.common import AzureMissingResourceHttpError
from azure.storage.blob import BlockBlobService
from google.auth import exceptions
@@ -193,9 +194,9 @@
@staticmethod
def _create_minio_client():
# Remove possible http scheme for Minio
- url = re.compile(r"https?://")
- minioClient = Minio(url.sub("", os.getenv("S3_ENDPOINT", "")),
- access_key=os.getenv("AWS_ACCESS_KEY_ID", ""),
- secret_key=os.getenv("AWS_SECRET_ACCESS_KEY", ""),
- secure=True)
- return minioClient
+ url = urlparse(os.getenv("AWS_ENDPOINT_URL", ""))
+ use_ssl = url.scheme == 'https' if url.scheme else bool(os.getenv("S3_USE_HTTPS", "true"))
+ return Minio(url.netloc,
+ access_key=os.getenv("AWS_ACCESS_KEY_ID", ""),
+ secret_key=os.getenv("AWS_SECRET_ACCESS_KEY", ""),
+ secure=use_ssl)
|
{"golden_diff": "diff --git a/python/kfserving/kfserving/storage.py b/python/kfserving/kfserving/storage.py\n--- a/python/kfserving/kfserving/storage.py\n+++ b/python/kfserving/kfserving/storage.py\n@@ -17,6 +17,7 @@\n import tempfile\n import os\n import re\n+from urllib.parse import urlparse\n from azure.common import AzureMissingResourceHttpError\n from azure.storage.blob import BlockBlobService\n from google.auth import exceptions\n@@ -193,9 +194,9 @@\n @staticmethod\n def _create_minio_client():\n # Remove possible http scheme for Minio\n- url = re.compile(r\"https?://\")\n- minioClient = Minio(url.sub(\"\", os.getenv(\"S3_ENDPOINT\", \"\")),\n- access_key=os.getenv(\"AWS_ACCESS_KEY_ID\", \"\"),\n- secret_key=os.getenv(\"AWS_SECRET_ACCESS_KEY\", \"\"),\n- secure=True)\n- return minioClient\n+ url = urlparse(os.getenv(\"AWS_ENDPOINT_URL\", \"\"))\n+ use_ssl = url.scheme == 'https' if url.scheme else bool(os.getenv(\"S3_USE_HTTPS\", \"true\"))\n+ return Minio(url.netloc,\n+ access_key=os.getenv(\"AWS_ACCESS_KEY_ID\", \"\"),\n+ secret_key=os.getenv(\"AWS_SECRET_ACCESS_KEY\", \"\"),\n+ secure=use_ssl)\n", "issue": "Support insecure minio connections\n/kind feature\r\nFor local deployments (e.g. with Kubeflow), TLS is not configured for minio. When trying to deploy a model stored there, kfserving issues SSLError messages.\r\n\r\n```Caused by SSLError(SSLError(1, '[SSL: WRONG_VERSION_NUMBER] wrong version number (_ssl.c:1056)')```\r\n\r\nThis is due to a hard-coded setting in [storage.py](https://github.com/kubeflow/kfserving/blob/master/python/kfserving/kfserving/storage.py#L194), with no way to override it.\r\n\r\n**Describe the solution you'd like**\r\nIt should be possible to allow insecure connections to minio, having secure connection as default. The user should be able to do this either by specifying an S3_ENDPOINT with http scheme or by using a flag explicitly.\r\n\n", "before_files": [{"content": "# Copyright 2019 kubeflow.org.\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 glob\nimport logging\nimport tempfile\nimport os\nimport re\nfrom azure.common import AzureMissingResourceHttpError\nfrom azure.storage.blob import BlockBlobService\nfrom google.auth import exceptions\nfrom google.cloud import storage\nfrom minio import Minio\n\n_GCS_PREFIX = \"gs://\"\n_S3_PREFIX = \"s3://\"\n_BLOB_RE = \"https://(.+?).blob.core.windows.net/(.+)\"\n_LOCAL_PREFIX = \"file://\"\n\n\nclass Storage(object): # pylint: disable=too-few-public-methods\n @staticmethod\n def download(uri: str, out_dir: str = None) -> str:\n logging.info(\"Copying contents of %s to local\", uri)\n\n is_local = False\n if uri.startswith(_LOCAL_PREFIX) or os.path.exists(uri):\n is_local = True\n\n if out_dir is None:\n if is_local:\n # noop if out_dir is not set and the path is local\n return Storage._download_local(uri)\n out_dir = tempfile.mkdtemp()\n\n if uri.startswith(_GCS_PREFIX):\n Storage._download_gcs(uri, out_dir)\n elif uri.startswith(_S3_PREFIX):\n Storage._download_s3(uri, out_dir)\n elif re.search(_BLOB_RE, uri):\n Storage._download_blob(uri, out_dir)\n elif is_local:\n return Storage._download_local(uri, out_dir)\n else:\n raise Exception(\"Cannot recognize storage type for \" + uri +\n \"\\n'%s', '%s', and '%s' are the current available storage type.\" %\n (_GCS_PREFIX, _S3_PREFIX, _LOCAL_PREFIX))\n\n logging.info(\"Successfully copied %s to %s\", uri, out_dir)\n return out_dir\n\n @staticmethod\n def _download_s3(uri, temp_dir: str):\n client = Storage._create_minio_client()\n bucket_args = uri.replace(_S3_PREFIX, \"\", 1).split(\"/\", 1)\n bucket_name = bucket_args[0]\n bucket_path = bucket_args[1] if len(bucket_args) > 1 else \"\"\n objects = client.list_objects(bucket_name, prefix=bucket_path, recursive=True)\n for obj in objects:\n # Replace any prefix from the object key with temp_dir\n subdir_object_key = obj.object_name.replace(bucket_path, \"\", 1).strip(\"/\")\n if subdir_object_key == \"\":\n subdir_object_key = obj.object_name.split(\"/\")[-1]\n client.fget_object(bucket_name, obj.object_name,\n os.path.join(temp_dir, subdir_object_key))\n\n @staticmethod\n def _download_gcs(uri, temp_dir: str):\n try:\n storage_client = storage.Client()\n except exceptions.DefaultCredentialsError:\n storage_client = storage.Client.create_anonymous_client()\n bucket_args = uri.replace(_GCS_PREFIX, \"\", 1).split(\"/\", 1)\n bucket_name = bucket_args[0]\n bucket_path = bucket_args[1] if len(bucket_args) > 1 else \"\"\n bucket = storage_client.bucket(bucket_name)\n prefix = bucket_path\n if not prefix.endswith(\"/\"):\n prefix = prefix + \"/\"\n blobs = bucket.list_blobs(prefix=prefix)\n for blob in blobs:\n # Replace any prefix from the object key with temp_dir\n subdir_object_key = blob.name.replace(bucket_path, \"\", 1).strip(\"/\")\n\n # Create necessary subdirectory to store the object locally\n if \"/\" in subdir_object_key:\n local_object_dir = os.path.join(temp_dir, subdir_object_key.rsplit(\"/\", 1)[0])\n if not os.path.isdir(local_object_dir):\n os.makedirs(local_object_dir, exist_ok=True)\n if subdir_object_key.strip() != \"\":\n dest_path = os.path.join(temp_dir, subdir_object_key)\n logging.info(\"Downloading: %s\", dest_path)\n blob.download_to_filename(dest_path)\n\n @staticmethod\n def _download_blob(uri, out_dir: str): # pylint: disable=too-many-locals\n match = re.search(_BLOB_RE, uri)\n account_name = match.group(1)\n storage_url = match.group(2)\n container_name, prefix = storage_url.split(\"/\", 1)\n\n logging.info(\"Connecting to BLOB account: [%s], container: [%s], prefix: [%s]\",\n account_name,\n container_name,\n prefix)\n try:\n block_blob_service = BlockBlobService(account_name=account_name)\n blobs = block_blob_service.list_blobs(container_name, prefix=prefix)\n except AzureMissingResourceHttpError:\n token = Storage._get_azure_storage_token()\n if token is None:\n logging.warning(\"Azure credentials not found, retrying anonymous access\")\n block_blob_service = BlockBlobService(account_name=account_name, token_credential=token)\n blobs = block_blob_service.list_blobs(container_name, prefix=prefix)\n\n for blob in blobs:\n dest_path = os.path.join(out_dir, blob.name)\n if \"/\" in blob.name:\n head, tail = os.path.split(blob.name)\n if prefix is not None:\n head = head[len(prefix):]\n if head.startswith('/'):\n head = head[1:]\n dir_path = os.path.join(out_dir, head)\n dest_path = os.path.join(dir_path, tail)\n if not os.path.isdir(dir_path):\n os.makedirs(dir_path)\n\n logging.info(\"Downloading: %s to %s\", blob.name, dest_path)\n block_blob_service.get_blob_to_path(container_name, blob.name, dest_path)\n\n @staticmethod\n def _get_azure_storage_token():\n tenant_id = os.getenv(\"AZ_TENANT_ID\", \"\")\n client_id = os.getenv(\"AZ_CLIENT_ID\", \"\")\n client_secret = os.getenv(\"AZ_CLIENT_SECRET\", \"\")\n subscription_id = os.getenv(\"AZ_SUBSCRIPTION_ID\", \"\")\n\n if tenant_id == \"\" or client_id == \"\" or client_secret == \"\" or subscription_id == \"\":\n return None\n\n # note the SP must have \"Storage Blob Data Owner\" perms for this to work\n import adal\n from azure.storage.common import TokenCredential\n\n authority_url = \"https://login.microsoftonline.com/\" + tenant_id\n\n context = adal.AuthenticationContext(authority_url)\n\n token = context.acquire_token_with_client_credentials(\n \"https://storage.azure.com/\",\n client_id,\n client_secret)\n\n token_credential = TokenCredential(token[\"accessToken\"])\n\n logging.info(\"Retrieved SP token credential for client_id: %s\", client_id)\n\n return token_credential\n\n @staticmethod\n def _download_local(uri, out_dir=None):\n local_path = uri.replace(_LOCAL_PREFIX, \"\", 1)\n if not os.path.exists(local_path):\n raise Exception(\"Local path %s does not exist.\" % (uri))\n\n if out_dir is None:\n return local_path\n elif not os.path.isdir(out_dir):\n os.makedirs(out_dir)\n\n if os.path.isdir(local_path):\n local_path = os.path.join(local_path, \"*\")\n\n for src in glob.glob(local_path):\n _, tail = os.path.split(src)\n dest_path = os.path.join(out_dir, tail)\n logging.info(\"Linking: %s to %s\", src, dest_path)\n os.symlink(src, dest_path)\n return out_dir\n\n @staticmethod\n def _create_minio_client():\n # Remove possible http scheme for Minio\n url = re.compile(r\"https?://\")\n minioClient = Minio(url.sub(\"\", os.getenv(\"S3_ENDPOINT\", \"\")),\n access_key=os.getenv(\"AWS_ACCESS_KEY_ID\", \"\"),\n secret_key=os.getenv(\"AWS_SECRET_ACCESS_KEY\", \"\"),\n secure=True)\n return minioClient\n", "path": "python/kfserving/kfserving/storage.py"}], "after_files": [{"content": "# Copyright 2019 kubeflow.org.\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 glob\nimport logging\nimport tempfile\nimport os\nimport re\nfrom urllib.parse import urlparse\nfrom azure.common import AzureMissingResourceHttpError\nfrom azure.storage.blob import BlockBlobService\nfrom google.auth import exceptions\nfrom google.cloud import storage\nfrom minio import Minio\n\n_GCS_PREFIX = \"gs://\"\n_S3_PREFIX = \"s3://\"\n_BLOB_RE = \"https://(.+?).blob.core.windows.net/(.+)\"\n_LOCAL_PREFIX = \"file://\"\n\n\nclass Storage(object): # pylint: disable=too-few-public-methods\n @staticmethod\n def download(uri: str, out_dir: str = None) -> str:\n logging.info(\"Copying contents of %s to local\", uri)\n\n is_local = False\n if uri.startswith(_LOCAL_PREFIX) or os.path.exists(uri):\n is_local = True\n\n if out_dir is None:\n if is_local:\n # noop if out_dir is not set and the path is local\n return Storage._download_local(uri)\n out_dir = tempfile.mkdtemp()\n\n if uri.startswith(_GCS_PREFIX):\n Storage._download_gcs(uri, out_dir)\n elif uri.startswith(_S3_PREFIX):\n Storage._download_s3(uri, out_dir)\n elif re.search(_BLOB_RE, uri):\n Storage._download_blob(uri, out_dir)\n elif is_local:\n return Storage._download_local(uri, out_dir)\n else:\n raise Exception(\"Cannot recognize storage type for \" + uri +\n \"\\n'%s', '%s', and '%s' are the current available storage type.\" %\n (_GCS_PREFIX, _S3_PREFIX, _LOCAL_PREFIX))\n\n logging.info(\"Successfully copied %s to %s\", uri, out_dir)\n return out_dir\n\n @staticmethod\n def _download_s3(uri, temp_dir: str):\n client = Storage._create_minio_client()\n bucket_args = uri.replace(_S3_PREFIX, \"\", 1).split(\"/\", 1)\n bucket_name = bucket_args[0]\n bucket_path = bucket_args[1] if len(bucket_args) > 1 else \"\"\n objects = client.list_objects(bucket_name, prefix=bucket_path, recursive=True)\n for obj in objects:\n # Replace any prefix from the object key with temp_dir\n subdir_object_key = obj.object_name.replace(bucket_path, \"\", 1).strip(\"/\")\n if subdir_object_key == \"\":\n subdir_object_key = obj.object_name.split(\"/\")[-1]\n client.fget_object(bucket_name, obj.object_name,\n os.path.join(temp_dir, subdir_object_key))\n\n @staticmethod\n def _download_gcs(uri, temp_dir: str):\n try:\n storage_client = storage.Client()\n except exceptions.DefaultCredentialsError:\n storage_client = storage.Client.create_anonymous_client()\n bucket_args = uri.replace(_GCS_PREFIX, \"\", 1).split(\"/\", 1)\n bucket_name = bucket_args[0]\n bucket_path = bucket_args[1] if len(bucket_args) > 1 else \"\"\n bucket = storage_client.bucket(bucket_name)\n prefix = bucket_path\n if not prefix.endswith(\"/\"):\n prefix = prefix + \"/\"\n blobs = bucket.list_blobs(prefix=prefix)\n for blob in blobs:\n # Replace any prefix from the object key with temp_dir\n subdir_object_key = blob.name.replace(bucket_path, \"\", 1).strip(\"/\")\n\n # Create necessary subdirectory to store the object locally\n if \"/\" in subdir_object_key:\n local_object_dir = os.path.join(temp_dir, subdir_object_key.rsplit(\"/\", 1)[0])\n if not os.path.isdir(local_object_dir):\n os.makedirs(local_object_dir, exist_ok=True)\n if subdir_object_key.strip() != \"\":\n dest_path = os.path.join(temp_dir, subdir_object_key)\n logging.info(\"Downloading: %s\", dest_path)\n blob.download_to_filename(dest_path)\n\n @staticmethod\n def _download_blob(uri, out_dir: str): # pylint: disable=too-many-locals\n match = re.search(_BLOB_RE, uri)\n account_name = match.group(1)\n storage_url = match.group(2)\n container_name, prefix = storage_url.split(\"/\", 1)\n\n logging.info(\"Connecting to BLOB account: [%s], container: [%s], prefix: [%s]\",\n account_name,\n container_name,\n prefix)\n try:\n block_blob_service = BlockBlobService(account_name=account_name)\n blobs = block_blob_service.list_blobs(container_name, prefix=prefix)\n except AzureMissingResourceHttpError:\n token = Storage._get_azure_storage_token()\n if token is None:\n logging.warning(\"Azure credentials not found, retrying anonymous access\")\n block_blob_service = BlockBlobService(account_name=account_name, token_credential=token)\n blobs = block_blob_service.list_blobs(container_name, prefix=prefix)\n\n for blob in blobs:\n dest_path = os.path.join(out_dir, blob.name)\n if \"/\" in blob.name:\n head, tail = os.path.split(blob.name)\n if prefix is not None:\n head = head[len(prefix):]\n if head.startswith('/'):\n head = head[1:]\n dir_path = os.path.join(out_dir, head)\n dest_path = os.path.join(dir_path, tail)\n if not os.path.isdir(dir_path):\n os.makedirs(dir_path)\n\n logging.info(\"Downloading: %s to %s\", blob.name, dest_path)\n block_blob_service.get_blob_to_path(container_name, blob.name, dest_path)\n\n @staticmethod\n def _get_azure_storage_token():\n tenant_id = os.getenv(\"AZ_TENANT_ID\", \"\")\n client_id = os.getenv(\"AZ_CLIENT_ID\", \"\")\n client_secret = os.getenv(\"AZ_CLIENT_SECRET\", \"\")\n subscription_id = os.getenv(\"AZ_SUBSCRIPTION_ID\", \"\")\n\n if tenant_id == \"\" or client_id == \"\" or client_secret == \"\" or subscription_id == \"\":\n return None\n\n # note the SP must have \"Storage Blob Data Owner\" perms for this to work\n import adal\n from azure.storage.common import TokenCredential\n\n authority_url = \"https://login.microsoftonline.com/\" + tenant_id\n\n context = adal.AuthenticationContext(authority_url)\n\n token = context.acquire_token_with_client_credentials(\n \"https://storage.azure.com/\",\n client_id,\n client_secret)\n\n token_credential = TokenCredential(token[\"accessToken\"])\n\n logging.info(\"Retrieved SP token credential for client_id: %s\", client_id)\n\n return token_credential\n\n @staticmethod\n def _download_local(uri, out_dir=None):\n local_path = uri.replace(_LOCAL_PREFIX, \"\", 1)\n if not os.path.exists(local_path):\n raise Exception(\"Local path %s does not exist.\" % (uri))\n\n if out_dir is None:\n return local_path\n elif not os.path.isdir(out_dir):\n os.makedirs(out_dir)\n\n if os.path.isdir(local_path):\n local_path = os.path.join(local_path, \"*\")\n\n for src in glob.glob(local_path):\n _, tail = os.path.split(src)\n dest_path = os.path.join(out_dir, tail)\n logging.info(\"Linking: %s to %s\", src, dest_path)\n os.symlink(src, dest_path)\n return out_dir\n\n @staticmethod\n def _create_minio_client():\n # Remove possible http scheme for Minio\n url = urlparse(os.getenv(\"AWS_ENDPOINT_URL\", \"\"))\n use_ssl = url.scheme == 'https' if url.scheme else bool(os.getenv(\"S3_USE_HTTPS\", \"true\"))\n return Minio(url.netloc,\n access_key=os.getenv(\"AWS_ACCESS_KEY_ID\", \"\"),\n secret_key=os.getenv(\"AWS_SECRET_ACCESS_KEY\", \"\"),\n secure=use_ssl)\n", "path": "python/kfserving/kfserving/storage.py"}]}
| 2,729 | 289 |
gh_patches_debug_62204
|
rasdani/github-patches
|
git_diff
|
arviz-devs__arviz-1192
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Import fails when run using a Bokeh server
**Description of bug**
The import of `arviz` errors when running with a [Bokeh server](https://docs.bokeh.org/en/latest/docs/user_guide/server.html).
The resulting error is:
```
output_notebook.__doc__ += "\n\n" + _copy_docstring("bokeh.plotting", "output_notebook") Traceback (most recent call last):
File "/Users/golmschenk/Code/ramjet/venv/lib/python3.7/site-packages/bokeh/application/handlers/code_runner.py", line 197, in run
exec(self._code, module.__dict__)
File "/Users/golmschenk/Code/ramjet/minimal_example/main.py", line 1, in <module>
import arviz
File "/Users/golmschenk/Code/ramjet/venv/lib/python3.7/site-packages/arviz/__init__.py", line 31, in <module>
from .plots import backends
File "/Users/golmschenk/Code/ramjet/venv/lib/python3.7/site-packages/arviz/plots/backends/__init__.py", line 195, in <module>
output_notebook.__doc__ += "\n\n" + _copy_docstring("bokeh.plotting", "output_notebook")
TypeError: can only concatenate str (not "NoneType") to str
```
**To Reproduce**
1. Have `bokeh` and `arviz` installed.
2. Create a Python file which only contains `import arviz`.
3. From the terminal, run `bokeh serve <file_name>.py`.
4. Open the localhost server link in a browser.
**Expected behavior**
`arviz` should be imported without error.
**Additional context**
`arviz` appears to be setting a docstring based off `_copy_docstring("bokeh.plotting", "output_notebook")`, however, in this context, `_copy_docstring("bokeh.plotting", "output_notebook")` is `None`.
Package versions:
```
arviz==0.7.0
bokeh==2.0.1
```
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `arviz/plots/backends/__init__.py`
Content:
```
1 # pylint: disable=no-member,invalid-name,redefined-outer-name
2 """ArviZ plotting backends."""
3 import re
4 import numpy as np
5 from pandas import DataFrame
6
7 from ...rcparams import rcParams
8
9
10 def to_cds(
11 data,
12 var_names=None,
13 groups=None,
14 dimensions=None,
15 group_info=True,
16 var_name_format=None,
17 index_origin=None,
18 ):
19 """Transform data to ColumnDataSource (CDS) compatible with Bokeh.
20
21 Uses `_ARVIZ_GROUP_` and `_ARVIZ_CDS_SELECTION_`to separate var_name
22 from group and dimensions in CDS columns.
23
24 Parameters
25 ----------
26 data : obj
27 Any object that can be converted to an az.InferenceData object
28 Refer to documentation of az.convert_to_inference_data for details
29 var_names : str or list of str, optional
30 Variables to be processed, if None all variables are processed.
31 groups : str or list of str, optional
32 Select groups for CDS. Default groups are {"posterior_groups", "prior_groups",
33 "posterior_groups_warmup"}
34 - posterior_groups: posterior, posterior_predictive, sample_stats
35 - prior_groups: prior, prior_predictive, sample_stats_prior
36 - posterior_groups_warmup: warmup_posterior, warmup_posterior_predictive,
37 warmup_sample_stats
38 ignore_groups : str or list of str, optional
39 Ignore specific groups from CDS.
40 dimension : str, or list of str, optional
41 Select dimensions along to slice the data. By default uses ("chain", "draw").
42 group_info : bool
43 Add group info for `var_name_format`
44 var_name_format : str or tuple of tuple of string, optional
45 Select column name format for non-scalar input.
46 Predefined options are {"brackets", "underscore", "cds"}
47 "brackets":
48 - add_group_info == False: theta[0,0]
49 - add_group_info == True: theta_posterior[0,0]
50 "underscore":
51 - add_group_info == False: theta_0_0
52 - add_group_info == True: theta_posterior_0_0_
53 "cds":
54 - add_group_info == False: theta_ARVIZ_CDS_SELECTION_0_0
55 - add_group_info == True: theta_ARVIZ_GROUP_posterior__ARVIZ_CDS_SELECTION_0_0
56 tuple:
57 Structure:
58 tuple: (dim_info, group_info)
59 dim_info: (str: `.join` separator,
60 str: dim_separator_start,
61 str: dim_separator_end)
62 group_info: (str: group separator start, str: group separator end)
63 Example: ((",", "[", "]"), ("_", ""))
64 - add_group_info == False: theta[0,0]
65 - add_group_info == True: theta_posterior[0,0]
66 index_origin : int, optional
67 Start parameter indices from `index_origin`. Either 0 or 1.
68
69 Returns
70 -------
71 bokeh.models.ColumnDataSource object
72 """
73 from ...utils import flatten_inference_data_to_dict
74
75 if var_name_format is None:
76 var_name_format = "cds"
77
78 cds_dict = flatten_inference_data_to_dict(
79 data=data,
80 var_names=var_names,
81 groups=groups,
82 dimensions=dimensions,
83 group_info=group_info,
84 index_origin=index_origin,
85 var_name_format=var_name_format,
86 )
87 cds_data = ColumnDataSource(DataFrame.from_dict(cds_dict, orient="columns"))
88 return cds_data
89
90
91 def output_notebook(*args, **kwargs):
92 """Wrap bokeh.plotting.output_notebook."""
93 import bokeh.plotting as bkp
94
95 return bkp.output_notebook(*args, **kwargs)
96
97
98 def output_file(*args, **kwargs):
99 """Wrap bokeh.plotting.output_file."""
100 import bokeh.plotting as bkp
101
102 return bkp.output_file(*args, **kwargs)
103
104
105 def ColumnDataSource(*args, **kwargs):
106 """Wrap bokeh.models.ColumnDataSource."""
107 from bokeh.models import ColumnDataSource
108
109 return ColumnDataSource(*args, **kwargs)
110
111
112 def create_layout(ax, force_layout=False):
113 """Transform bokeh array of figures to layout."""
114 ax = np.atleast_2d(ax)
115 subplot_order = rcParams["plot.bokeh.layout.order"]
116 if force_layout:
117 from bokeh.layouts import gridplot as layout
118
119 ax = ax.tolist()
120 layout_args = {
121 "sizing_mode": rcParams["plot.bokeh.layout.sizing_mode"],
122 "toolbar_location": rcParams["plot.bokeh.layout.toolbar_location"],
123 }
124 elif any(item in subplot_order for item in ("row", "column")):
125 # check number of rows
126 match = re.match(r"(\d*)(row|column)", subplot_order)
127 n = int(match.group(1)) if match.group(1) is not None else 1
128 subplot_order = match.group(2)
129 # set up 1D list of axes
130 ax = [item for item in ax.ravel().tolist() if item is not None]
131 layout_args = {"sizing_mode": rcParams["plot.bokeh.layout.sizing_mode"]}
132 if subplot_order == "row" and n == 1:
133 from bokeh.layouts import row as layout
134 elif subplot_order == "column" and n == 1:
135 from bokeh.layouts import column as layout
136 else:
137 from bokeh.layouts import layout
138
139 if n != 1:
140 ax = np.array(ax + [None for _ in range(int(np.ceil(len(ax) / n)) - len(ax))])
141 if subplot_order == "row":
142 ax = ax.reshape(n, -1)
143 else:
144 ax = ax.reshape(-1, n)
145 ax = ax.tolist()
146 else:
147 if subplot_order in ("square", "square_trimmed"):
148 ax = [item for item in ax.ravel().tolist() if item is not None]
149 n = int(np.ceil(len(ax) ** 0.5))
150 ax = ax + [None for _ in range(n ** 2 - len(ax))]
151 ax = np.array(ax).reshape(n, n)
152 ax = ax.tolist()
153 if (subplot_order == "square_trimmed") and any(
154 all(item is None for item in row) for row in ax
155 ):
156 from bokeh.layouts import layout
157
158 ax = [row for row in ax if not all(item is None for item in row)]
159 layout_args = {"sizing_mode": rcParams["plot.bokeh.layout.sizing_mode"]}
160 else:
161 from bokeh.layouts import gridplot as layout
162
163 layout_args = {
164 "sizing_mode": rcParams["plot.bokeh.layout.sizing_mode"],
165 "toolbar_location": rcParams["plot.bokeh.layout.toolbar_location"],
166 }
167 # ignore "fixed" sizing_mode without explicit width and height
168 if layout_args.get("sizing_mode", "") == "fixed":
169 layout_args.pop("sizing_mode")
170 return layout(ax, **layout_args)
171
172
173 def show_layout(ax, show=True, force_layout=False):
174 """Create a layout and call bokeh show."""
175 if show is None:
176 show = rcParams["plot.bokeh.show"]
177 if show:
178 import bokeh.plotting as bkp
179
180 layout = create_layout(ax, force_layout=force_layout)
181 bkp.show(layout)
182
183
184 def _copy_docstring(lib, function):
185 """Extract docstring from function."""
186 import importlib
187
188 try:
189 module = importlib.import_module(lib)
190 func = getattr(module, function)
191 doc = func.__doc__
192 except ImportError:
193 doc = "Failed to import function {} from {}".format(function, lib)
194
195 return doc
196
197
198 output_notebook.__doc__ += "\n\n" + _copy_docstring("bokeh.plotting", "output_notebook")
199 output_file.__doc__ += "\n\n" + _copy_docstring("bokeh.plotting", "output_file")
200 ColumnDataSource.__doc__ += "\n\n" + _copy_docstring("bokeh.models", "ColumnDataSource")
201
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/arviz/plots/backends/__init__.py b/arviz/plots/backends/__init__.py
--- a/arviz/plots/backends/__init__.py
+++ b/arviz/plots/backends/__init__.py
@@ -192,6 +192,8 @@
except ImportError:
doc = "Failed to import function {} from {}".format(function, lib)
+ if not isinstance(doc, str):
+ doc = ""
return doc
|
{"golden_diff": "diff --git a/arviz/plots/backends/__init__.py b/arviz/plots/backends/__init__.py\n--- a/arviz/plots/backends/__init__.py\n+++ b/arviz/plots/backends/__init__.py\n@@ -192,6 +192,8 @@\n except ImportError:\n doc = \"Failed to import function {} from {}\".format(function, lib)\n \n+ if not isinstance(doc, str):\n+ doc = \"\"\n return doc\n", "issue": "Import fails when run using a Bokeh server\n**Description of bug**\r\nThe import of `arviz` errors when running with a [Bokeh server](https://docs.bokeh.org/en/latest/docs/user_guide/server.html).\r\n\r\nThe resulting error is:\r\n```\r\noutput_notebook.__doc__ += \"\\n\\n\" + _copy_docstring(\"bokeh.plotting\", \"output_notebook\") Traceback (most recent call last):\r\n File \"/Users/golmschenk/Code/ramjet/venv/lib/python3.7/site-packages/bokeh/application/handlers/code_runner.py\", line 197, in run\r\n exec(self._code, module.__dict__)\r\n File \"/Users/golmschenk/Code/ramjet/minimal_example/main.py\", line 1, in <module>\r\n import arviz\r\n File \"/Users/golmschenk/Code/ramjet/venv/lib/python3.7/site-packages/arviz/__init__.py\", line 31, in <module>\r\n from .plots import backends\r\n File \"/Users/golmschenk/Code/ramjet/venv/lib/python3.7/site-packages/arviz/plots/backends/__init__.py\", line 195, in <module>\r\n output_notebook.__doc__ += \"\\n\\n\" + _copy_docstring(\"bokeh.plotting\", \"output_notebook\")\r\nTypeError: can only concatenate str (not \"NoneType\") to str\r\n```\r\n\r\n\r\n**To Reproduce**\r\n\r\n1. Have `bokeh` and `arviz` installed.\r\n2. Create a Python file which only contains `import arviz`.\r\n3. From the terminal, run `bokeh serve <file_name>.py`.\r\n4. Open the localhost server link in a browser.\r\n\r\n**Expected behavior**\r\n`arviz` should be imported without error.\r\n\r\n**Additional context**\r\n`arviz` appears to be setting a docstring based off `_copy_docstring(\"bokeh.plotting\", \"output_notebook\")`, however, in this context, `_copy_docstring(\"bokeh.plotting\", \"output_notebook\")` is `None`.\r\n\r\nPackage versions:\r\n```\r\narviz==0.7.0\r\nbokeh==2.0.1\r\n```\r\n\n", "before_files": [{"content": "# pylint: disable=no-member,invalid-name,redefined-outer-name\n\"\"\"ArviZ plotting backends.\"\"\"\nimport re\nimport numpy as np\nfrom pandas import DataFrame\n\nfrom ...rcparams import rcParams\n\n\ndef to_cds(\n data,\n var_names=None,\n groups=None,\n dimensions=None,\n group_info=True,\n var_name_format=None,\n index_origin=None,\n):\n \"\"\"Transform data to ColumnDataSource (CDS) compatible with Bokeh.\n\n Uses `_ARVIZ_GROUP_` and `_ARVIZ_CDS_SELECTION_`to separate var_name\n from group and dimensions in CDS columns.\n\n Parameters\n ----------\n data : obj\n Any object that can be converted to an az.InferenceData object\n Refer to documentation of az.convert_to_inference_data for details\n var_names : str or list of str, optional\n Variables to be processed, if None all variables are processed.\n groups : str or list of str, optional\n Select groups for CDS. Default groups are {\"posterior_groups\", \"prior_groups\",\n \"posterior_groups_warmup\"}\n - posterior_groups: posterior, posterior_predictive, sample_stats\n - prior_groups: prior, prior_predictive, sample_stats_prior\n - posterior_groups_warmup: warmup_posterior, warmup_posterior_predictive,\n warmup_sample_stats\n ignore_groups : str or list of str, optional\n Ignore specific groups from CDS.\n dimension : str, or list of str, optional\n Select dimensions along to slice the data. By default uses (\"chain\", \"draw\").\n group_info : bool\n Add group info for `var_name_format`\n var_name_format : str or tuple of tuple of string, optional\n Select column name format for non-scalar input.\n Predefined options are {\"brackets\", \"underscore\", \"cds\"}\n \"brackets\":\n - add_group_info == False: theta[0,0]\n - add_group_info == True: theta_posterior[0,0]\n \"underscore\":\n - add_group_info == False: theta_0_0\n - add_group_info == True: theta_posterior_0_0_\n \"cds\":\n - add_group_info == False: theta_ARVIZ_CDS_SELECTION_0_0\n - add_group_info == True: theta_ARVIZ_GROUP_posterior__ARVIZ_CDS_SELECTION_0_0\n tuple:\n Structure:\n tuple: (dim_info, group_info)\n dim_info: (str: `.join` separator,\n str: dim_separator_start,\n str: dim_separator_end)\n group_info: (str: group separator start, str: group separator end)\n Example: ((\",\", \"[\", \"]\"), (\"_\", \"\"))\n - add_group_info == False: theta[0,0]\n - add_group_info == True: theta_posterior[0,0]\n index_origin : int, optional\n Start parameter indices from `index_origin`. Either 0 or 1.\n\n Returns\n -------\n bokeh.models.ColumnDataSource object\n \"\"\"\n from ...utils import flatten_inference_data_to_dict\n\n if var_name_format is None:\n var_name_format = \"cds\"\n\n cds_dict = flatten_inference_data_to_dict(\n data=data,\n var_names=var_names,\n groups=groups,\n dimensions=dimensions,\n group_info=group_info,\n index_origin=index_origin,\n var_name_format=var_name_format,\n )\n cds_data = ColumnDataSource(DataFrame.from_dict(cds_dict, orient=\"columns\"))\n return cds_data\n\n\ndef output_notebook(*args, **kwargs):\n \"\"\"Wrap bokeh.plotting.output_notebook.\"\"\"\n import bokeh.plotting as bkp\n\n return bkp.output_notebook(*args, **kwargs)\n\n\ndef output_file(*args, **kwargs):\n \"\"\"Wrap bokeh.plotting.output_file.\"\"\"\n import bokeh.plotting as bkp\n\n return bkp.output_file(*args, **kwargs)\n\n\ndef ColumnDataSource(*args, **kwargs):\n \"\"\"Wrap bokeh.models.ColumnDataSource.\"\"\"\n from bokeh.models import ColumnDataSource\n\n return ColumnDataSource(*args, **kwargs)\n\n\ndef create_layout(ax, force_layout=False):\n \"\"\"Transform bokeh array of figures to layout.\"\"\"\n ax = np.atleast_2d(ax)\n subplot_order = rcParams[\"plot.bokeh.layout.order\"]\n if force_layout:\n from bokeh.layouts import gridplot as layout\n\n ax = ax.tolist()\n layout_args = {\n \"sizing_mode\": rcParams[\"plot.bokeh.layout.sizing_mode\"],\n \"toolbar_location\": rcParams[\"plot.bokeh.layout.toolbar_location\"],\n }\n elif any(item in subplot_order for item in (\"row\", \"column\")):\n # check number of rows\n match = re.match(r\"(\\d*)(row|column)\", subplot_order)\n n = int(match.group(1)) if match.group(1) is not None else 1\n subplot_order = match.group(2)\n # set up 1D list of axes\n ax = [item for item in ax.ravel().tolist() if item is not None]\n layout_args = {\"sizing_mode\": rcParams[\"plot.bokeh.layout.sizing_mode\"]}\n if subplot_order == \"row\" and n == 1:\n from bokeh.layouts import row as layout\n elif subplot_order == \"column\" and n == 1:\n from bokeh.layouts import column as layout\n else:\n from bokeh.layouts import layout\n\n if n != 1:\n ax = np.array(ax + [None for _ in range(int(np.ceil(len(ax) / n)) - len(ax))])\n if subplot_order == \"row\":\n ax = ax.reshape(n, -1)\n else:\n ax = ax.reshape(-1, n)\n ax = ax.tolist()\n else:\n if subplot_order in (\"square\", \"square_trimmed\"):\n ax = [item for item in ax.ravel().tolist() if item is not None]\n n = int(np.ceil(len(ax) ** 0.5))\n ax = ax + [None for _ in range(n ** 2 - len(ax))]\n ax = np.array(ax).reshape(n, n)\n ax = ax.tolist()\n if (subplot_order == \"square_trimmed\") and any(\n all(item is None for item in row) for row in ax\n ):\n from bokeh.layouts import layout\n\n ax = [row for row in ax if not all(item is None for item in row)]\n layout_args = {\"sizing_mode\": rcParams[\"plot.bokeh.layout.sizing_mode\"]}\n else:\n from bokeh.layouts import gridplot as layout\n\n layout_args = {\n \"sizing_mode\": rcParams[\"plot.bokeh.layout.sizing_mode\"],\n \"toolbar_location\": rcParams[\"plot.bokeh.layout.toolbar_location\"],\n }\n # ignore \"fixed\" sizing_mode without explicit width and height\n if layout_args.get(\"sizing_mode\", \"\") == \"fixed\":\n layout_args.pop(\"sizing_mode\")\n return layout(ax, **layout_args)\n\n\ndef show_layout(ax, show=True, force_layout=False):\n \"\"\"Create a layout and call bokeh show.\"\"\"\n if show is None:\n show = rcParams[\"plot.bokeh.show\"]\n if show:\n import bokeh.plotting as bkp\n\n layout = create_layout(ax, force_layout=force_layout)\n bkp.show(layout)\n\n\ndef _copy_docstring(lib, function):\n \"\"\"Extract docstring from function.\"\"\"\n import importlib\n\n try:\n module = importlib.import_module(lib)\n func = getattr(module, function)\n doc = func.__doc__\n except ImportError:\n doc = \"Failed to import function {} from {}\".format(function, lib)\n\n return doc\n\n\noutput_notebook.__doc__ += \"\\n\\n\" + _copy_docstring(\"bokeh.plotting\", \"output_notebook\")\noutput_file.__doc__ += \"\\n\\n\" + _copy_docstring(\"bokeh.plotting\", \"output_file\")\nColumnDataSource.__doc__ += \"\\n\\n\" + _copy_docstring(\"bokeh.models\", \"ColumnDataSource\")\n", "path": "arviz/plots/backends/__init__.py"}], "after_files": [{"content": "# pylint: disable=no-member,invalid-name,redefined-outer-name\n\"\"\"ArviZ plotting backends.\"\"\"\nimport re\nimport numpy as np\nfrom pandas import DataFrame\n\nfrom ...rcparams import rcParams\n\n\ndef to_cds(\n data,\n var_names=None,\n groups=None,\n dimensions=None,\n group_info=True,\n var_name_format=None,\n index_origin=None,\n):\n \"\"\"Transform data to ColumnDataSource (CDS) compatible with Bokeh.\n\n Uses `_ARVIZ_GROUP_` and `_ARVIZ_CDS_SELECTION_`to separate var_name\n from group and dimensions in CDS columns.\n\n Parameters\n ----------\n data : obj\n Any object that can be converted to an az.InferenceData object\n Refer to documentation of az.convert_to_inference_data for details\n var_names : str or list of str, optional\n Variables to be processed, if None all variables are processed.\n groups : str or list of str, optional\n Select groups for CDS. Default groups are {\"posterior_groups\", \"prior_groups\",\n \"posterior_groups_warmup\"}\n - posterior_groups: posterior, posterior_predictive, sample_stats\n - prior_groups: prior, prior_predictive, sample_stats_prior\n - posterior_groups_warmup: warmup_posterior, warmup_posterior_predictive,\n warmup_sample_stats\n ignore_groups : str or list of str, optional\n Ignore specific groups from CDS.\n dimension : str, or list of str, optional\n Select dimensions along to slice the data. By default uses (\"chain\", \"draw\").\n group_info : bool\n Add group info for `var_name_format`\n var_name_format : str or tuple of tuple of string, optional\n Select column name format for non-scalar input.\n Predefined options are {\"brackets\", \"underscore\", \"cds\"}\n \"brackets\":\n - add_group_info == False: theta[0,0]\n - add_group_info == True: theta_posterior[0,0]\n \"underscore\":\n - add_group_info == False: theta_0_0\n - add_group_info == True: theta_posterior_0_0_\n \"cds\":\n - add_group_info == False: theta_ARVIZ_CDS_SELECTION_0_0\n - add_group_info == True: theta_ARVIZ_GROUP_posterior__ARVIZ_CDS_SELECTION_0_0\n tuple:\n Structure:\n tuple: (dim_info, group_info)\n dim_info: (str: `.join` separator,\n str: dim_separator_start,\n str: dim_separator_end)\n group_info: (str: group separator start, str: group separator end)\n Example: ((\",\", \"[\", \"]\"), (\"_\", \"\"))\n - add_group_info == False: theta[0,0]\n - add_group_info == True: theta_posterior[0,0]\n index_origin : int, optional\n Start parameter indices from `index_origin`. Either 0 or 1.\n\n Returns\n -------\n bokeh.models.ColumnDataSource object\n \"\"\"\n from ...utils import flatten_inference_data_to_dict\n\n if var_name_format is None:\n var_name_format = \"cds\"\n\n cds_dict = flatten_inference_data_to_dict(\n data=data,\n var_names=var_names,\n groups=groups,\n dimensions=dimensions,\n group_info=group_info,\n index_origin=index_origin,\n var_name_format=var_name_format,\n )\n cds_data = ColumnDataSource(DataFrame.from_dict(cds_dict, orient=\"columns\"))\n return cds_data\n\n\ndef output_notebook(*args, **kwargs):\n \"\"\"Wrap bokeh.plotting.output_notebook.\"\"\"\n import bokeh.plotting as bkp\n\n return bkp.output_notebook(*args, **kwargs)\n\n\ndef output_file(*args, **kwargs):\n \"\"\"Wrap bokeh.plotting.output_file.\"\"\"\n import bokeh.plotting as bkp\n\n return bkp.output_file(*args, **kwargs)\n\n\ndef ColumnDataSource(*args, **kwargs):\n \"\"\"Wrap bokeh.models.ColumnDataSource.\"\"\"\n from bokeh.models import ColumnDataSource\n\n return ColumnDataSource(*args, **kwargs)\n\n\ndef create_layout(ax, force_layout=False):\n \"\"\"Transform bokeh array of figures to layout.\"\"\"\n ax = np.atleast_2d(ax)\n subplot_order = rcParams[\"plot.bokeh.layout.order\"]\n if force_layout:\n from bokeh.layouts import gridplot as layout\n\n ax = ax.tolist()\n layout_args = {\n \"sizing_mode\": rcParams[\"plot.bokeh.layout.sizing_mode\"],\n \"toolbar_location\": rcParams[\"plot.bokeh.layout.toolbar_location\"],\n }\n elif any(item in subplot_order for item in (\"row\", \"column\")):\n # check number of rows\n match = re.match(r\"(\\d*)(row|column)\", subplot_order)\n n = int(match.group(1)) if match.group(1) is not None else 1\n subplot_order = match.group(2)\n # set up 1D list of axes\n ax = [item for item in ax.ravel().tolist() if item is not None]\n layout_args = {\"sizing_mode\": rcParams[\"plot.bokeh.layout.sizing_mode\"]}\n if subplot_order == \"row\" and n == 1:\n from bokeh.layouts import row as layout\n elif subplot_order == \"column\" and n == 1:\n from bokeh.layouts import column as layout\n else:\n from bokeh.layouts import layout\n\n if n != 1:\n ax = np.array(ax + [None for _ in range(int(np.ceil(len(ax) / n)) - len(ax))])\n if subplot_order == \"row\":\n ax = ax.reshape(n, -1)\n else:\n ax = ax.reshape(-1, n)\n ax = ax.tolist()\n else:\n if subplot_order in (\"square\", \"square_trimmed\"):\n ax = [item for item in ax.ravel().tolist() if item is not None]\n n = int(np.ceil(len(ax) ** 0.5))\n ax = ax + [None for _ in range(n ** 2 - len(ax))]\n ax = np.array(ax).reshape(n, n)\n ax = ax.tolist()\n if (subplot_order == \"square_trimmed\") and any(\n all(item is None for item in row) for row in ax\n ):\n from bokeh.layouts import layout\n\n ax = [row for row in ax if not all(item is None for item in row)]\n layout_args = {\"sizing_mode\": rcParams[\"plot.bokeh.layout.sizing_mode\"]}\n else:\n from bokeh.layouts import gridplot as layout\n\n layout_args = {\n \"sizing_mode\": rcParams[\"plot.bokeh.layout.sizing_mode\"],\n \"toolbar_location\": rcParams[\"plot.bokeh.layout.toolbar_location\"],\n }\n # ignore \"fixed\" sizing_mode without explicit width and height\n if layout_args.get(\"sizing_mode\", \"\") == \"fixed\":\n layout_args.pop(\"sizing_mode\")\n return layout(ax, **layout_args)\n\n\ndef show_layout(ax, show=True, force_layout=False):\n \"\"\"Create a layout and call bokeh show.\"\"\"\n if show is None:\n show = rcParams[\"plot.bokeh.show\"]\n if show:\n import bokeh.plotting as bkp\n\n layout = create_layout(ax, force_layout=force_layout)\n bkp.show(layout)\n\n\ndef _copy_docstring(lib, function):\n \"\"\"Extract docstring from function.\"\"\"\n import importlib\n\n try:\n module = importlib.import_module(lib)\n func = getattr(module, function)\n doc = func.__doc__\n except ImportError:\n doc = \"Failed to import function {} from {}\".format(function, lib)\n\n if not isinstance(doc, str):\n doc = \"\"\n return doc\n\n\noutput_notebook.__doc__ += \"\\n\\n\" + _copy_docstring(\"bokeh.plotting\", \"output_notebook\")\noutput_file.__doc__ += \"\\n\\n\" + _copy_docstring(\"bokeh.plotting\", \"output_file\")\nColumnDataSource.__doc__ += \"\\n\\n\" + _copy_docstring(\"bokeh.models\", \"ColumnDataSource\")\n", "path": "arviz/plots/backends/__init__.py"}]}
| 3,004 | 105 |
gh_patches_debug_16061
|
rasdani/github-patches
|
git_diff
|
instadeepai__Mava-495
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[BUG][Jax] Default executor flattens observations
### Describe the bug
The default executor flattens observations which is undesirable for environments which can benefit from spatial knowledge.
### To Reproduce
`observation = executor.store.observation.observation.reshape((1, -1))` <- inside `action_selection.py`
### Expected behavior
It was expected that observations would be fed to neural networks unedited.
### Possible Solution
`observation = utils.add_batch_dim(executor.store.observation.observation)`
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `mava/components/jax/executing/action_selection.py`
Content:
```
1 # python3
2 # Copyright 2021 InstaDeep Ltd. All rights reserved.
3 #
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
7 #
8 # http://www.apache.org/licenses/LICENSE-2.0
9 #
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
15
16 """Execution components for system builders"""
17
18 from dataclasses import dataclass
19
20 import jax
21
22 from mava.components.jax import Component
23 from mava.core_jax import SystemExecutor
24
25
26 @dataclass
27 class ExecutorSelectActionProcessConfig:
28 pass
29
30
31 class FeedforwardExecutorSelectAction(Component):
32 def __init__(
33 self,
34 config: ExecutorSelectActionProcessConfig = ExecutorSelectActionProcessConfig(),
35 ):
36 """_summary_
37
38 Args:
39 config : _description_.
40 """
41 self.config = config
42
43 # Select actions
44 def on_execution_select_actions(self, executor: SystemExecutor) -> None:
45 """Summary"""
46 executor.store.actions_info = {}
47 executor.store.policies_info = {}
48 for agent, observation in executor.store.observations.items():
49 action_info, policy_info = executor.select_action(agent, observation)
50 executor.store.actions_info[agent] = action_info
51 executor.store.policies_info[agent] = policy_info
52
53 # Select action
54 def on_execution_select_action_compute(self, executor: SystemExecutor) -> None:
55 """Summary"""
56
57 agent = executor.store.agent
58 network = executor.store.networks["networks"][
59 executor.store.agent_net_keys[agent]
60 ]
61
62 observation = executor.store.observation.observation.reshape((1, -1))
63 rng_key, executor.store.key = jax.random.split(executor.store.key)
64
65 # TODO (dries): We are currently using jit in the networks per agent.
66 # We can also try jit over all the agents in a for loop. This would
67 # allow the jit function to save us even more time.
68 executor.store.action_info, executor.store.policy_info = network.get_action(
69 observation, rng_key
70 )
71
72 @staticmethod
73 def name() -> str:
74 """_summary_"""
75 return "action_selector"
76
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/mava/components/jax/executing/action_selection.py b/mava/components/jax/executing/action_selection.py
--- a/mava/components/jax/executing/action_selection.py
+++ b/mava/components/jax/executing/action_selection.py
@@ -18,6 +18,7 @@
from dataclasses import dataclass
import jax
+from acme.jax import utils
from mava.components.jax import Component
from mava.core_jax import SystemExecutor
@@ -59,7 +60,7 @@
executor.store.agent_net_keys[agent]
]
- observation = executor.store.observation.observation.reshape((1, -1))
+ observation = utils.add_batch_dim(executor.store.observation.observation)
rng_key, executor.store.key = jax.random.split(executor.store.key)
# TODO (dries): We are currently using jit in the networks per agent.
|
{"golden_diff": "diff --git a/mava/components/jax/executing/action_selection.py b/mava/components/jax/executing/action_selection.py\n--- a/mava/components/jax/executing/action_selection.py\n+++ b/mava/components/jax/executing/action_selection.py\n@@ -18,6 +18,7 @@\n from dataclasses import dataclass\n \n import jax\n+from acme.jax import utils\n \n from mava.components.jax import Component\n from mava.core_jax import SystemExecutor\n@@ -59,7 +60,7 @@\n executor.store.agent_net_keys[agent]\n ]\n \n- observation = executor.store.observation.observation.reshape((1, -1))\n+ observation = utils.add_batch_dim(executor.store.observation.observation)\n rng_key, executor.store.key = jax.random.split(executor.store.key)\n \n # TODO (dries): We are currently using jit in the networks per agent.\n", "issue": "[BUG][Jax] Default executor flattens observations\n### Describe the bug\r\nThe default executor flattens observations which is undesirable for environments which can benefit from spatial knowledge.\r\n\r\n### To Reproduce\r\n`observation = executor.store.observation.observation.reshape((1, -1))` <- inside `action_selection.py`\r\n\r\n### Expected behavior\r\nIt was expected that observations would be fed to neural networks unedited.\r\n\r\n### Possible Solution\r\n`observation = utils.add_batch_dim(executor.store.observation.observation)`\r\n\n", "before_files": [{"content": "# python3\n# Copyright 2021 InstaDeep Ltd. 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# 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\n\"\"\"Execution components for system builders\"\"\"\n\nfrom dataclasses import dataclass\n\nimport jax\n\nfrom mava.components.jax import Component\nfrom mava.core_jax import SystemExecutor\n\n\n@dataclass\nclass ExecutorSelectActionProcessConfig:\n pass\n\n\nclass FeedforwardExecutorSelectAction(Component):\n def __init__(\n self,\n config: ExecutorSelectActionProcessConfig = ExecutorSelectActionProcessConfig(),\n ):\n \"\"\"_summary_\n\n Args:\n config : _description_.\n \"\"\"\n self.config = config\n\n # Select actions\n def on_execution_select_actions(self, executor: SystemExecutor) -> None:\n \"\"\"Summary\"\"\"\n executor.store.actions_info = {}\n executor.store.policies_info = {}\n for agent, observation in executor.store.observations.items():\n action_info, policy_info = executor.select_action(agent, observation)\n executor.store.actions_info[agent] = action_info\n executor.store.policies_info[agent] = policy_info\n\n # Select action\n def on_execution_select_action_compute(self, executor: SystemExecutor) -> None:\n \"\"\"Summary\"\"\"\n\n agent = executor.store.agent\n network = executor.store.networks[\"networks\"][\n executor.store.agent_net_keys[agent]\n ]\n\n observation = executor.store.observation.observation.reshape((1, -1))\n rng_key, executor.store.key = jax.random.split(executor.store.key)\n\n # TODO (dries): We are currently using jit in the networks per agent.\n # We can also try jit over all the agents in a for loop. This would\n # allow the jit function to save us even more time.\n executor.store.action_info, executor.store.policy_info = network.get_action(\n observation, rng_key\n )\n\n @staticmethod\n def name() -> str:\n \"\"\"_summary_\"\"\"\n return \"action_selector\"\n", "path": "mava/components/jax/executing/action_selection.py"}], "after_files": [{"content": "# python3\n# Copyright 2021 InstaDeep Ltd. 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# 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\n\"\"\"Execution components for system builders\"\"\"\n\nfrom dataclasses import dataclass\n\nimport jax\nfrom acme.jax import utils\n\nfrom mava.components.jax import Component\nfrom mava.core_jax import SystemExecutor\n\n\n@dataclass\nclass ExecutorSelectActionProcessConfig:\n pass\n\n\nclass FeedforwardExecutorSelectAction(Component):\n def __init__(\n self,\n config: ExecutorSelectActionProcessConfig = ExecutorSelectActionProcessConfig(),\n ):\n \"\"\"_summary_\n\n Args:\n config : _description_.\n \"\"\"\n self.config = config\n\n # Select actions\n def on_execution_select_actions(self, executor: SystemExecutor) -> None:\n \"\"\"Summary\"\"\"\n executor.store.actions_info = {}\n executor.store.policies_info = {}\n for agent, observation in executor.store.observations.items():\n action_info, policy_info = executor.select_action(agent, observation)\n executor.store.actions_info[agent] = action_info\n executor.store.policies_info[agent] = policy_info\n\n # Select action\n def on_execution_select_action_compute(self, executor: SystemExecutor) -> None:\n \"\"\"Summary\"\"\"\n\n agent = executor.store.agent\n network = executor.store.networks[\"networks\"][\n executor.store.agent_net_keys[agent]\n ]\n\n observation = utils.add_batch_dim(executor.store.observation.observation)\n rng_key, executor.store.key = jax.random.split(executor.store.key)\n\n # TODO (dries): We are currently using jit in the networks per agent.\n # We can also try jit over all the agents in a for loop. This would\n # allow the jit function to save us even more time.\n executor.store.action_info, executor.store.policy_info = network.get_action(\n observation, rng_key\n )\n\n @staticmethod\n def name() -> str:\n \"\"\"_summary_\"\"\"\n return \"action_selector\"\n", "path": "mava/components/jax/executing/action_selection.py"}]}
| 1,049 | 196 |
gh_patches_debug_19780
|
rasdani/github-patches
|
git_diff
|
numba__numba-5808
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
No error for jit(nopython=True, forceobj=True)
- [ x] I am using the latest released version of Numba (most recent is visible in
the change log (https://github.com/numba/numba/blob/master/CHANGE_LOG).
- [ x] I have included below a minimal working reproducer (if you are unsure how
to write one see http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports).
When using the `jit` decorator with both `nopython=True` and `forceobj=True` no error is reported, despite these flags probably being mutually exclusive.
```python
import numba
@numba.jit(nopython=True, forceobj=True)
def f():
pass
f()
```
The prior example runs without complaints. If the `njit` decorator is used instead, appropriate warnings are thrown.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `numba/core/decorators.py`
Content:
```
1 """
2 Define @jit and related decorators.
3 """
4
5
6 import sys
7 import warnings
8 import inspect
9 import logging
10
11 from numba.core.errors import DeprecationError, NumbaDeprecationWarning
12 from numba.stencils.stencil import stencil
13 from numba.core import config, sigutils, registry
14
15
16 _logger = logging.getLogger(__name__)
17
18
19 # -----------------------------------------------------------------------------
20 # Decorators
21
22 _msg_deprecated_signature_arg = ("Deprecated keyword argument `{0}`. "
23 "Signatures should be passed as the first "
24 "positional argument.")
25
26 def jit(signature_or_function=None, locals={}, target='cpu', cache=False,
27 pipeline_class=None, boundscheck=False, **options):
28 """
29 This decorator is used to compile a Python function into native code.
30
31 Args
32 -----
33 signature_or_function:
34 The (optional) signature or list of signatures to be compiled.
35 If not passed, required signatures will be compiled when the
36 decorated function is called, depending on the argument values.
37 As a convenience, you can directly pass the function to be compiled
38 instead.
39
40 locals: dict
41 Mapping of local variable names to Numba types. Used to override the
42 types deduced by Numba's type inference engine.
43
44 target: str
45 Specifies the target platform to compile for. Valid targets are cpu,
46 gpu, npyufunc, and cuda. Defaults to cpu.
47
48 pipeline_class: type numba.compiler.CompilerBase
49 The compiler pipeline type for customizing the compilation stages.
50
51 options:
52 For a cpu target, valid options are:
53 nopython: bool
54 Set to True to disable the use of PyObjects and Python API
55 calls. The default behavior is to allow the use of PyObjects
56 and Python API. Default value is False.
57
58 forceobj: bool
59 Set to True to force the use of PyObjects for every value.
60 Default value is False.
61
62 looplift: bool
63 Set to True to enable jitting loops in nopython mode while
64 leaving surrounding code in object mode. This allows functions
65 to allocate NumPy arrays and use Python objects, while the
66 tight loops in the function can still be compiled in nopython
67 mode. Any arrays that the tight loop uses should be created
68 before the loop is entered. Default value is True.
69
70 error_model: str
71 The error-model affects divide-by-zero behavior.
72 Valid values are 'python' and 'numpy'. The 'python' model
73 raises exception. The 'numpy' model sets the result to
74 *+/-inf* or *nan*. Default value is 'python'.
75
76 inline: str or callable
77 The inline option will determine whether a function is inlined
78 at into its caller if called. String options are 'never'
79 (default) which will never inline, and 'always', which will
80 always inline. If a callable is provided it will be called with
81 the call expression node that is requesting inlining, the
82 caller's IR and callee's IR as arguments, it is expected to
83 return Truthy as to whether to inline.
84 NOTE: This inlining is performed at the Numba IR level and is in
85 no way related to LLVM inlining.
86
87 boundscheck: bool
88 Set to True to enable bounds checking for array indices. Out
89 of bounds accesses will raise IndexError. The default is to
90 not do bounds checking. If bounds checking is disabled, out of
91 bounds accesses can produce garbage results or segfaults.
92 However, enabling bounds checking will slow down typical
93 functions, so it is recommended to only use this flag for
94 debugging. You can also set the NUMBA_BOUNDSCHECK environment
95 variable to 0 or 1 to globally override this flag.
96
97 Returns
98 --------
99 A callable usable as a compiled function. Actual compiling will be
100 done lazily if no explicit signatures are passed.
101
102 Examples
103 --------
104 The function can be used in the following ways:
105
106 1) jit(signatures, target='cpu', **targetoptions) -> jit(function)
107
108 Equivalent to:
109
110 d = dispatcher(function, targetoptions)
111 for signature in signatures:
112 d.compile(signature)
113
114 Create a dispatcher object for a python function. Then, compile
115 the function with the given signature(s).
116
117 Example:
118
119 @jit("int32(int32, int32)")
120 def foo(x, y):
121 return x + y
122
123 @jit(["int32(int32, int32)", "float32(float32, float32)"])
124 def bar(x, y):
125 return x + y
126
127 2) jit(function, target='cpu', **targetoptions) -> dispatcher
128
129 Create a dispatcher function object that specializes at call site.
130
131 Examples:
132
133 @jit
134 def foo(x, y):
135 return x + y
136
137 @jit(target='cpu', nopython=True)
138 def bar(x, y):
139 return x + y
140
141 """
142 if 'argtypes' in options:
143 raise DeprecationError(_msg_deprecated_signature_arg.format('argtypes'))
144 if 'restype' in options:
145 raise DeprecationError(_msg_deprecated_signature_arg.format('restype'))
146
147 options['boundscheck'] = boundscheck
148
149 # Handle signature
150 if signature_or_function is None:
151 # No signature, no function
152 pyfunc = None
153 sigs = None
154 elif isinstance(signature_or_function, list):
155 # A list of signatures is passed
156 pyfunc = None
157 sigs = signature_or_function
158 elif sigutils.is_signature(signature_or_function):
159 # A single signature is passed
160 pyfunc = None
161 sigs = [signature_or_function]
162 else:
163 # A function is passed
164 pyfunc = signature_or_function
165 sigs = None
166
167 dispatcher_args = {}
168 if pipeline_class is not None:
169 dispatcher_args['pipeline_class'] = pipeline_class
170 wrapper = _jit(sigs, locals=locals, target=target, cache=cache,
171 targetoptions=options, **dispatcher_args)
172 if pyfunc is not None:
173 return wrapper(pyfunc)
174 else:
175 return wrapper
176
177
178 def _jit(sigs, locals, target, cache, targetoptions, **dispatcher_args):
179 dispatcher = registry.dispatcher_registry[target]
180
181 def wrapper(func):
182 if config.ENABLE_CUDASIM and target == 'cuda':
183 from numba import cuda
184 return cuda.jit(func)
185 if config.DISABLE_JIT and not target == 'npyufunc':
186 return func
187 disp = dispatcher(py_func=func, locals=locals,
188 targetoptions=targetoptions,
189 **dispatcher_args)
190 if cache:
191 disp.enable_caching()
192 if sigs is not None:
193 # Register the Dispatcher to the type inference mechanism,
194 # even though the decorator hasn't returned yet.
195 from numba.core import typeinfer
196 with typeinfer.register_dispatcher(disp):
197 for sig in sigs:
198 disp.compile(sig)
199 disp.disable_compile()
200 return disp
201
202 return wrapper
203
204
205 def generated_jit(function=None, target='cpu', cache=False,
206 pipeline_class=None, **options):
207 """
208 This decorator allows flexible type-based compilation
209 of a jitted function. It works as `@jit`, except that the decorated
210 function is called at compile-time with the *types* of the arguments
211 and should return an implementation function for those types.
212 """
213 dispatcher_args = {}
214 if pipeline_class is not None:
215 dispatcher_args['pipeline_class'] = pipeline_class
216 wrapper = _jit(sigs=None, locals={}, target=target, cache=cache,
217 targetoptions=options, impl_kind='generated',
218 **dispatcher_args)
219 if function is not None:
220 return wrapper(function)
221 else:
222 return wrapper
223
224
225 def njit(*args, **kws):
226 """
227 Equivalent to jit(nopython=True)
228
229 See documentation for jit function/decorator for full description.
230 """
231 if 'nopython' in kws:
232 warnings.warn('nopython is set for njit and is ignored', RuntimeWarning)
233 if 'forceobj' in kws:
234 warnings.warn('forceobj is set for njit and is ignored', RuntimeWarning)
235 kws.update({'nopython': True})
236 return jit(*args, **kws)
237
238
239 def cfunc(sig, locals={}, cache=False, **options):
240 """
241 This decorator is used to compile a Python function into a C callback
242 usable with foreign C libraries.
243
244 Usage::
245 @cfunc("float64(float64, float64)", nopython=True, cache=True)
246 def add(a, b):
247 return a + b
248
249 """
250 sig = sigutils.normalize_signature(sig)
251
252 def wrapper(func):
253 from numba.core.ccallback import CFunc
254 res = CFunc(func, sig, locals=locals, options=options)
255 if cache:
256 res.enable_caching()
257 res.compile()
258 return res
259
260 return wrapper
261
262
263 def jit_module(**kwargs):
264 """ Automatically ``jit``-wraps functions defined in a Python module
265
266 Note that ``jit_module`` should only be called at the end of the module to
267 be jitted. In addition, only functions which are defined in the module
268 ``jit_module`` is called from are considered for automatic jit-wrapping.
269 See the Numba documentation for more information about what can/cannot be
270 jitted.
271
272 :param kwargs: Keyword arguments to pass to ``jit`` such as ``nopython``
273 or ``error_model``.
274
275 """
276 # Get the module jit_module is being called from
277 frame = inspect.stack()[1]
278 module = inspect.getmodule(frame[0])
279 # Replace functions in module with jit-wrapped versions
280 for name, obj in module.__dict__.items():
281 if inspect.isfunction(obj) and inspect.getmodule(obj) == module:
282 _logger.debug("Auto decorating function {} from module {} with jit "
283 "and options: {}".format(obj, module.__name__, kwargs))
284 module.__dict__[name] = jit(obj, **kwargs)
285
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/numba/core/decorators.py b/numba/core/decorators.py
--- a/numba/core/decorators.py
+++ b/numba/core/decorators.py
@@ -143,6 +143,8 @@
raise DeprecationError(_msg_deprecated_signature_arg.format('argtypes'))
if 'restype' in options:
raise DeprecationError(_msg_deprecated_signature_arg.format('restype'))
+ if options.get('nopython', False) and options.get('forceobj', False):
+ raise ValueError("Only one of 'nopython' or 'forceobj' can be True.")
options['boundscheck'] = boundscheck
@@ -232,6 +234,7 @@
warnings.warn('nopython is set for njit and is ignored', RuntimeWarning)
if 'forceobj' in kws:
warnings.warn('forceobj is set for njit and is ignored', RuntimeWarning)
+ del kws['forceobj']
kws.update({'nopython': True})
return jit(*args, **kws)
|
{"golden_diff": "diff --git a/numba/core/decorators.py b/numba/core/decorators.py\n--- a/numba/core/decorators.py\n+++ b/numba/core/decorators.py\n@@ -143,6 +143,8 @@\n raise DeprecationError(_msg_deprecated_signature_arg.format('argtypes'))\n if 'restype' in options:\n raise DeprecationError(_msg_deprecated_signature_arg.format('restype'))\n+ if options.get('nopython', False) and options.get('forceobj', False):\n+ raise ValueError(\"Only one of 'nopython' or 'forceobj' can be True.\")\n \n options['boundscheck'] = boundscheck\n \n@@ -232,6 +234,7 @@\n warnings.warn('nopython is set for njit and is ignored', RuntimeWarning)\n if 'forceobj' in kws:\n warnings.warn('forceobj is set for njit and is ignored', RuntimeWarning)\n+ del kws['forceobj']\n kws.update({'nopython': True})\n return jit(*args, **kws)\n", "issue": "No error for jit(nopython=True, forceobj=True)\n- [ x] I am using the latest released version of Numba (most recent is visible in\r\n the change log (https://github.com/numba/numba/blob/master/CHANGE_LOG).\r\n- [ x] I have included below a minimal working reproducer (if you are unsure how\r\n to write one see http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports).\r\n\r\nWhen using the `jit` decorator with both `nopython=True` and `forceobj=True` no error is reported, despite these flags probably being mutually exclusive.\r\n```python\r\nimport numba\r\n\r\[email protected](nopython=True, forceobj=True)\r\ndef f():\r\n pass\r\n\r\nf()\r\n```\r\nThe prior example runs without complaints. If the `njit` decorator is used instead, appropriate warnings are thrown.\n", "before_files": [{"content": "\"\"\"\nDefine @jit and related decorators.\n\"\"\"\n\n\nimport sys\nimport warnings\nimport inspect\nimport logging\n\nfrom numba.core.errors import DeprecationError, NumbaDeprecationWarning\nfrom numba.stencils.stencil import stencil\nfrom numba.core import config, sigutils, registry\n\n\n_logger = logging.getLogger(__name__)\n\n\n# -----------------------------------------------------------------------------\n# Decorators\n\n_msg_deprecated_signature_arg = (\"Deprecated keyword argument `{0}`. \"\n \"Signatures should be passed as the first \"\n \"positional argument.\")\n\ndef jit(signature_or_function=None, locals={}, target='cpu', cache=False,\n pipeline_class=None, boundscheck=False, **options):\n \"\"\"\n This decorator is used to compile a Python function into native code.\n\n Args\n -----\n signature_or_function:\n The (optional) signature or list of signatures to be compiled.\n If not passed, required signatures will be compiled when the\n decorated function is called, depending on the argument values.\n As a convenience, you can directly pass the function to be compiled\n instead.\n\n locals: dict\n Mapping of local variable names to Numba types. Used to override the\n types deduced by Numba's type inference engine.\n\n target: str\n Specifies the target platform to compile for. Valid targets are cpu,\n gpu, npyufunc, and cuda. Defaults to cpu.\n\n pipeline_class: type numba.compiler.CompilerBase\n The compiler pipeline type for customizing the compilation stages.\n\n options:\n For a cpu target, valid options are:\n nopython: bool\n Set to True to disable the use of PyObjects and Python API\n calls. The default behavior is to allow the use of PyObjects\n and Python API. Default value is False.\n\n forceobj: bool\n Set to True to force the use of PyObjects for every value.\n Default value is False.\n\n looplift: bool\n Set to True to enable jitting loops in nopython mode while\n leaving surrounding code in object mode. This allows functions\n to allocate NumPy arrays and use Python objects, while the\n tight loops in the function can still be compiled in nopython\n mode. Any arrays that the tight loop uses should be created\n before the loop is entered. Default value is True.\n\n error_model: str\n The error-model affects divide-by-zero behavior.\n Valid values are 'python' and 'numpy'. The 'python' model\n raises exception. The 'numpy' model sets the result to\n *+/-inf* or *nan*. Default value is 'python'.\n\n inline: str or callable\n The inline option will determine whether a function is inlined\n at into its caller if called. String options are 'never'\n (default) which will never inline, and 'always', which will\n always inline. If a callable is provided it will be called with\n the call expression node that is requesting inlining, the\n caller's IR and callee's IR as arguments, it is expected to\n return Truthy as to whether to inline.\n NOTE: This inlining is performed at the Numba IR level and is in\n no way related to LLVM inlining.\n\n boundscheck: bool\n Set to True to enable bounds checking for array indices. Out\n of bounds accesses will raise IndexError. The default is to\n not do bounds checking. If bounds checking is disabled, out of\n bounds accesses can produce garbage results or segfaults.\n However, enabling bounds checking will slow down typical\n functions, so it is recommended to only use this flag for\n debugging. You can also set the NUMBA_BOUNDSCHECK environment\n variable to 0 or 1 to globally override this flag.\n\n Returns\n --------\n A callable usable as a compiled function. Actual compiling will be\n done lazily if no explicit signatures are passed.\n\n Examples\n --------\n The function can be used in the following ways:\n\n 1) jit(signatures, target='cpu', **targetoptions) -> jit(function)\n\n Equivalent to:\n\n d = dispatcher(function, targetoptions)\n for signature in signatures:\n d.compile(signature)\n\n Create a dispatcher object for a python function. Then, compile\n the function with the given signature(s).\n\n Example:\n\n @jit(\"int32(int32, int32)\")\n def foo(x, y):\n return x + y\n\n @jit([\"int32(int32, int32)\", \"float32(float32, float32)\"])\n def bar(x, y):\n return x + y\n\n 2) jit(function, target='cpu', **targetoptions) -> dispatcher\n\n Create a dispatcher function object that specializes at call site.\n\n Examples:\n\n @jit\n def foo(x, y):\n return x + y\n\n @jit(target='cpu', nopython=True)\n def bar(x, y):\n return x + y\n\n \"\"\"\n if 'argtypes' in options:\n raise DeprecationError(_msg_deprecated_signature_arg.format('argtypes'))\n if 'restype' in options:\n raise DeprecationError(_msg_deprecated_signature_arg.format('restype'))\n\n options['boundscheck'] = boundscheck\n\n # Handle signature\n if signature_or_function is None:\n # No signature, no function\n pyfunc = None\n sigs = None\n elif isinstance(signature_or_function, list):\n # A list of signatures is passed\n pyfunc = None\n sigs = signature_or_function\n elif sigutils.is_signature(signature_or_function):\n # A single signature is passed\n pyfunc = None\n sigs = [signature_or_function]\n else:\n # A function is passed\n pyfunc = signature_or_function\n sigs = None\n\n dispatcher_args = {}\n if pipeline_class is not None:\n dispatcher_args['pipeline_class'] = pipeline_class\n wrapper = _jit(sigs, locals=locals, target=target, cache=cache,\n targetoptions=options, **dispatcher_args)\n if pyfunc is not None:\n return wrapper(pyfunc)\n else:\n return wrapper\n\n\ndef _jit(sigs, locals, target, cache, targetoptions, **dispatcher_args):\n dispatcher = registry.dispatcher_registry[target]\n\n def wrapper(func):\n if config.ENABLE_CUDASIM and target == 'cuda':\n from numba import cuda\n return cuda.jit(func)\n if config.DISABLE_JIT and not target == 'npyufunc':\n return func\n disp = dispatcher(py_func=func, locals=locals,\n targetoptions=targetoptions,\n **dispatcher_args)\n if cache:\n disp.enable_caching()\n if sigs is not None:\n # Register the Dispatcher to the type inference mechanism,\n # even though the decorator hasn't returned yet.\n from numba.core import typeinfer\n with typeinfer.register_dispatcher(disp):\n for sig in sigs:\n disp.compile(sig)\n disp.disable_compile()\n return disp\n\n return wrapper\n\n\ndef generated_jit(function=None, target='cpu', cache=False,\n pipeline_class=None, **options):\n \"\"\"\n This decorator allows flexible type-based compilation\n of a jitted function. It works as `@jit`, except that the decorated\n function is called at compile-time with the *types* of the arguments\n and should return an implementation function for those types.\n \"\"\"\n dispatcher_args = {}\n if pipeline_class is not None:\n dispatcher_args['pipeline_class'] = pipeline_class\n wrapper = _jit(sigs=None, locals={}, target=target, cache=cache,\n targetoptions=options, impl_kind='generated',\n **dispatcher_args)\n if function is not None:\n return wrapper(function)\n else:\n return wrapper\n\n\ndef njit(*args, **kws):\n \"\"\"\n Equivalent to jit(nopython=True)\n\n See documentation for jit function/decorator for full description.\n \"\"\"\n if 'nopython' in kws:\n warnings.warn('nopython is set for njit and is ignored', RuntimeWarning)\n if 'forceobj' in kws:\n warnings.warn('forceobj is set for njit and is ignored', RuntimeWarning)\n kws.update({'nopython': True})\n return jit(*args, **kws)\n\n\ndef cfunc(sig, locals={}, cache=False, **options):\n \"\"\"\n This decorator is used to compile a Python function into a C callback\n usable with foreign C libraries.\n\n Usage::\n @cfunc(\"float64(float64, float64)\", nopython=True, cache=True)\n def add(a, b):\n return a + b\n\n \"\"\"\n sig = sigutils.normalize_signature(sig)\n\n def wrapper(func):\n from numba.core.ccallback import CFunc\n res = CFunc(func, sig, locals=locals, options=options)\n if cache:\n res.enable_caching()\n res.compile()\n return res\n\n return wrapper\n\n\ndef jit_module(**kwargs):\n \"\"\" Automatically ``jit``-wraps functions defined in a Python module\n\n Note that ``jit_module`` should only be called at the end of the module to\n be jitted. In addition, only functions which are defined in the module\n ``jit_module`` is called from are considered for automatic jit-wrapping.\n See the Numba documentation for more information about what can/cannot be\n jitted.\n\n :param kwargs: Keyword arguments to pass to ``jit`` such as ``nopython``\n or ``error_model``.\n\n \"\"\"\n # Get the module jit_module is being called from\n frame = inspect.stack()[1]\n module = inspect.getmodule(frame[0])\n # Replace functions in module with jit-wrapped versions\n for name, obj in module.__dict__.items():\n if inspect.isfunction(obj) and inspect.getmodule(obj) == module:\n _logger.debug(\"Auto decorating function {} from module {} with jit \"\n \"and options: {}\".format(obj, module.__name__, kwargs))\n module.__dict__[name] = jit(obj, **kwargs)\n", "path": "numba/core/decorators.py"}], "after_files": [{"content": "\"\"\"\nDefine @jit and related decorators.\n\"\"\"\n\n\nimport sys\nimport warnings\nimport inspect\nimport logging\n\nfrom numba.core.errors import DeprecationError, NumbaDeprecationWarning\nfrom numba.stencils.stencil import stencil\nfrom numba.core import config, sigutils, registry\n\n\n_logger = logging.getLogger(__name__)\n\n\n# -----------------------------------------------------------------------------\n# Decorators\n\n_msg_deprecated_signature_arg = (\"Deprecated keyword argument `{0}`. \"\n \"Signatures should be passed as the first \"\n \"positional argument.\")\n\ndef jit(signature_or_function=None, locals={}, target='cpu', cache=False,\n pipeline_class=None, boundscheck=False, **options):\n \"\"\"\n This decorator is used to compile a Python function into native code.\n\n Args\n -----\n signature_or_function:\n The (optional) signature or list of signatures to be compiled.\n If not passed, required signatures will be compiled when the\n decorated function is called, depending on the argument values.\n As a convenience, you can directly pass the function to be compiled\n instead.\n\n locals: dict\n Mapping of local variable names to Numba types. Used to override the\n types deduced by Numba's type inference engine.\n\n target: str\n Specifies the target platform to compile for. Valid targets are cpu,\n gpu, npyufunc, and cuda. Defaults to cpu.\n\n pipeline_class: type numba.compiler.CompilerBase\n The compiler pipeline type for customizing the compilation stages.\n\n options:\n For a cpu target, valid options are:\n nopython: bool\n Set to True to disable the use of PyObjects and Python API\n calls. The default behavior is to allow the use of PyObjects\n and Python API. Default value is False.\n\n forceobj: bool\n Set to True to force the use of PyObjects for every value.\n Default value is False.\n\n looplift: bool\n Set to True to enable jitting loops in nopython mode while\n leaving surrounding code in object mode. This allows functions\n to allocate NumPy arrays and use Python objects, while the\n tight loops in the function can still be compiled in nopython\n mode. Any arrays that the tight loop uses should be created\n before the loop is entered. Default value is True.\n\n error_model: str\n The error-model affects divide-by-zero behavior.\n Valid values are 'python' and 'numpy'. The 'python' model\n raises exception. The 'numpy' model sets the result to\n *+/-inf* or *nan*. Default value is 'python'.\n\n inline: str or callable\n The inline option will determine whether a function is inlined\n at into its caller if called. String options are 'never'\n (default) which will never inline, and 'always', which will\n always inline. If a callable is provided it will be called with\n the call expression node that is requesting inlining, the\n caller's IR and callee's IR as arguments, it is expected to\n return Truthy as to whether to inline.\n NOTE: This inlining is performed at the Numba IR level and is in\n no way related to LLVM inlining.\n\n boundscheck: bool\n Set to True to enable bounds checking for array indices. Out\n of bounds accesses will raise IndexError. The default is to\n not do bounds checking. If bounds checking is disabled, out of\n bounds accesses can produce garbage results or segfaults.\n However, enabling bounds checking will slow down typical\n functions, so it is recommended to only use this flag for\n debugging. You can also set the NUMBA_BOUNDSCHECK environment\n variable to 0 or 1 to globally override this flag.\n\n Returns\n --------\n A callable usable as a compiled function. Actual compiling will be\n done lazily if no explicit signatures are passed.\n\n Examples\n --------\n The function can be used in the following ways:\n\n 1) jit(signatures, target='cpu', **targetoptions) -> jit(function)\n\n Equivalent to:\n\n d = dispatcher(function, targetoptions)\n for signature in signatures:\n d.compile(signature)\n\n Create a dispatcher object for a python function. Then, compile\n the function with the given signature(s).\n\n Example:\n\n @jit(\"int32(int32, int32)\")\n def foo(x, y):\n return x + y\n\n @jit([\"int32(int32, int32)\", \"float32(float32, float32)\"])\n def bar(x, y):\n return x + y\n\n 2) jit(function, target='cpu', **targetoptions) -> dispatcher\n\n Create a dispatcher function object that specializes at call site.\n\n Examples:\n\n @jit\n def foo(x, y):\n return x + y\n\n @jit(target='cpu', nopython=True)\n def bar(x, y):\n return x + y\n\n \"\"\"\n if 'argtypes' in options:\n raise DeprecationError(_msg_deprecated_signature_arg.format('argtypes'))\n if 'restype' in options:\n raise DeprecationError(_msg_deprecated_signature_arg.format('restype'))\n if options.get('nopython', False) and options.get('forceobj', False):\n raise ValueError(\"Only one of 'nopython' or 'forceobj' can be True.\")\n\n options['boundscheck'] = boundscheck\n\n # Handle signature\n if signature_or_function is None:\n # No signature, no function\n pyfunc = None\n sigs = None\n elif isinstance(signature_or_function, list):\n # A list of signatures is passed\n pyfunc = None\n sigs = signature_or_function\n elif sigutils.is_signature(signature_or_function):\n # A single signature is passed\n pyfunc = None\n sigs = [signature_or_function]\n else:\n # A function is passed\n pyfunc = signature_or_function\n sigs = None\n\n dispatcher_args = {}\n if pipeline_class is not None:\n dispatcher_args['pipeline_class'] = pipeline_class\n wrapper = _jit(sigs, locals=locals, target=target, cache=cache,\n targetoptions=options, **dispatcher_args)\n if pyfunc is not None:\n return wrapper(pyfunc)\n else:\n return wrapper\n\n\ndef _jit(sigs, locals, target, cache, targetoptions, **dispatcher_args):\n dispatcher = registry.dispatcher_registry[target]\n\n def wrapper(func):\n if config.ENABLE_CUDASIM and target == 'cuda':\n from numba import cuda\n return cuda.jit(func)\n if config.DISABLE_JIT and not target == 'npyufunc':\n return func\n disp = dispatcher(py_func=func, locals=locals,\n targetoptions=targetoptions,\n **dispatcher_args)\n if cache:\n disp.enable_caching()\n if sigs is not None:\n # Register the Dispatcher to the type inference mechanism,\n # even though the decorator hasn't returned yet.\n from numba.core import typeinfer\n with typeinfer.register_dispatcher(disp):\n for sig in sigs:\n disp.compile(sig)\n disp.disable_compile()\n return disp\n\n return wrapper\n\n\ndef generated_jit(function=None, target='cpu', cache=False,\n pipeline_class=None, **options):\n \"\"\"\n This decorator allows flexible type-based compilation\n of a jitted function. It works as `@jit`, except that the decorated\n function is called at compile-time with the *types* of the arguments\n and should return an implementation function for those types.\n \"\"\"\n dispatcher_args = {}\n if pipeline_class is not None:\n dispatcher_args['pipeline_class'] = pipeline_class\n wrapper = _jit(sigs=None, locals={}, target=target, cache=cache,\n targetoptions=options, impl_kind='generated',\n **dispatcher_args)\n if function is not None:\n return wrapper(function)\n else:\n return wrapper\n\n\ndef njit(*args, **kws):\n \"\"\"\n Equivalent to jit(nopython=True)\n\n See documentation for jit function/decorator for full description.\n \"\"\"\n if 'nopython' in kws:\n warnings.warn('nopython is set for njit and is ignored', RuntimeWarning)\n if 'forceobj' in kws:\n warnings.warn('forceobj is set for njit and is ignored', RuntimeWarning)\n del kws['forceobj']\n kws.update({'nopython': True})\n return jit(*args, **kws)\n\n\ndef cfunc(sig, locals={}, cache=False, **options):\n \"\"\"\n This decorator is used to compile a Python function into a C callback\n usable with foreign C libraries.\n\n Usage::\n @cfunc(\"float64(float64, float64)\", nopython=True, cache=True)\n def add(a, b):\n return a + b\n\n \"\"\"\n sig = sigutils.normalize_signature(sig)\n\n def wrapper(func):\n from numba.core.ccallback import CFunc\n res = CFunc(func, sig, locals=locals, options=options)\n if cache:\n res.enable_caching()\n res.compile()\n return res\n\n return wrapper\n\n\ndef jit_module(**kwargs):\n \"\"\" Automatically ``jit``-wraps functions defined in a Python module\n\n Note that ``jit_module`` should only be called at the end of the module to\n be jitted. In addition, only functions which are defined in the module\n ``jit_module`` is called from are considered for automatic jit-wrapping.\n See the Numba documentation for more information about what can/cannot be\n jitted.\n\n :param kwargs: Keyword arguments to pass to ``jit`` such as ``nopython``\n or ``error_model``.\n\n \"\"\"\n # Get the module jit_module is being called from\n frame = inspect.stack()[1]\n module = inspect.getmodule(frame[0])\n # Replace functions in module with jit-wrapped versions\n for name, obj in module.__dict__.items():\n if inspect.isfunction(obj) and inspect.getmodule(obj) == module:\n _logger.debug(\"Auto decorating function {} from module {} with jit \"\n \"and options: {}\".format(obj, module.__name__, kwargs))\n module.__dict__[name] = jit(obj, **kwargs)\n", "path": "numba/core/decorators.py"}]}
| 3,417 | 246 |
gh_patches_debug_21173
|
rasdani/github-patches
|
git_diff
|
pypa__pip-10288
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Add flag to force pip to always fetch password from keyring
**What's the problem this feature will solve?**
I am trying to fetch modules from a private server. In order to avoid storing this password in filesystem or environment, I have added it to keyring instead. I have also set `https://[email protected]` as global.index-url in my pip.conf.
Based upon the verbose logs from `pip install`, it seems that pip will first do the request without a password, get a 401, and then fetch the password from keyring.
**Describe the solution you'd like**
There should be a way to force pip to always fetch the password from keyring in the first place. This would prevent it from spamming the server with unauthenticated requests.
**Alternative Solutions**
I don't want to put the password in plaintext in my pip.conf or environment variables, so I'm not aware of any alternative solution.
**Additional context**
n/a
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `src/pip/_internal/network/auth.py`
Content:
```
1 """Network Authentication Helpers
2
3 Contains interface (MultiDomainBasicAuth) and associated glue code for
4 providing credentials in the context of network requests.
5 """
6
7 import urllib.parse
8 from typing import Any, Dict, List, Optional, Tuple
9
10 from pip._vendor.requests.auth import AuthBase, HTTPBasicAuth
11 from pip._vendor.requests.models import Request, Response
12 from pip._vendor.requests.utils import get_netrc_auth
13
14 from pip._internal.utils.logging import getLogger
15 from pip._internal.utils.misc import (
16 ask,
17 ask_input,
18 ask_password,
19 remove_auth_from_url,
20 split_auth_netloc_from_url,
21 )
22 from pip._internal.vcs.versioncontrol import AuthInfo
23
24 logger = getLogger(__name__)
25
26 Credentials = Tuple[str, str, str]
27
28 try:
29 import keyring
30 except ImportError:
31 keyring = None # type: ignore[assignment]
32 except Exception as exc:
33 logger.warning(
34 "Keyring is skipped due to an exception: %s",
35 str(exc),
36 )
37 keyring = None # type: ignore[assignment]
38
39
40 def get_keyring_auth(url: Optional[str], username: Optional[str]) -> Optional[AuthInfo]:
41 """Return the tuple auth for a given url from keyring."""
42 global keyring
43 if not url or not keyring:
44 return None
45
46 try:
47 try:
48 get_credential = keyring.get_credential
49 except AttributeError:
50 pass
51 else:
52 logger.debug("Getting credentials from keyring for %s", url)
53 cred = get_credential(url, username)
54 if cred is not None:
55 return cred.username, cred.password
56 return None
57
58 if username:
59 logger.debug("Getting password from keyring for %s", url)
60 password = keyring.get_password(url, username)
61 if password:
62 return username, password
63
64 except Exception as exc:
65 logger.warning(
66 "Keyring is skipped due to an exception: %s",
67 str(exc),
68 )
69 keyring = None # type: ignore[assignment]
70 return None
71
72
73 class MultiDomainBasicAuth(AuthBase):
74 def __init__(
75 self, prompting: bool = True, index_urls: Optional[List[str]] = None
76 ) -> None:
77 self.prompting = prompting
78 self.index_urls = index_urls
79 self.passwords: Dict[str, AuthInfo] = {}
80 # When the user is prompted to enter credentials and keyring is
81 # available, we will offer to save them. If the user accepts,
82 # this value is set to the credentials they entered. After the
83 # request authenticates, the caller should call
84 # ``save_credentials`` to save these.
85 self._credentials_to_save: Optional[Credentials] = None
86
87 def _get_index_url(self, url: str) -> Optional[str]:
88 """Return the original index URL matching the requested URL.
89
90 Cached or dynamically generated credentials may work against
91 the original index URL rather than just the netloc.
92
93 The provided url should have had its username and password
94 removed already. If the original index url had credentials then
95 they will be included in the return value.
96
97 Returns None if no matching index was found, or if --no-index
98 was specified by the user.
99 """
100 if not url or not self.index_urls:
101 return None
102
103 for u in self.index_urls:
104 prefix = remove_auth_from_url(u).rstrip("/") + "/"
105 if url.startswith(prefix):
106 return u
107 return None
108
109 def _get_new_credentials(
110 self,
111 original_url: str,
112 allow_netrc: bool = True,
113 allow_keyring: bool = False,
114 ) -> AuthInfo:
115 """Find and return credentials for the specified URL."""
116 # Split the credentials and netloc from the url.
117 url, netloc, url_user_password = split_auth_netloc_from_url(
118 original_url,
119 )
120
121 # Start with the credentials embedded in the url
122 username, password = url_user_password
123 if username is not None and password is not None:
124 logger.debug("Found credentials in url for %s", netloc)
125 return url_user_password
126
127 # Find a matching index url for this request
128 index_url = self._get_index_url(url)
129 if index_url:
130 # Split the credentials from the url.
131 index_info = split_auth_netloc_from_url(index_url)
132 if index_info:
133 index_url, _, index_url_user_password = index_info
134 logger.debug("Found index url %s", index_url)
135
136 # If an index URL was found, try its embedded credentials
137 if index_url and index_url_user_password[0] is not None:
138 username, password = index_url_user_password
139 if username is not None and password is not None:
140 logger.debug("Found credentials in index url for %s", netloc)
141 return index_url_user_password
142
143 # Get creds from netrc if we still don't have them
144 if allow_netrc:
145 netrc_auth = get_netrc_auth(original_url)
146 if netrc_auth:
147 logger.debug("Found credentials in netrc for %s", netloc)
148 return netrc_auth
149
150 # If we don't have a password and keyring is available, use it.
151 if allow_keyring:
152 # The index url is more specific than the netloc, so try it first
153 # fmt: off
154 kr_auth = (
155 get_keyring_auth(index_url, username) or
156 get_keyring_auth(netloc, username)
157 )
158 # fmt: on
159 if kr_auth:
160 logger.debug("Found credentials in keyring for %s", netloc)
161 return kr_auth
162
163 return username, password
164
165 def _get_url_and_credentials(
166 self, original_url: str
167 ) -> Tuple[str, Optional[str], Optional[str]]:
168 """Return the credentials to use for the provided URL.
169
170 If allowed, netrc and keyring may be used to obtain the
171 correct credentials.
172
173 Returns (url_without_credentials, username, password). Note
174 that even if the original URL contains credentials, this
175 function may return a different username and password.
176 """
177 url, netloc, _ = split_auth_netloc_from_url(original_url)
178
179 # Try to get credentials from original url
180 username, password = self._get_new_credentials(original_url)
181
182 # If credentials not found, use any stored credentials for this netloc
183 if username is None and password is None:
184 username, password = self.passwords.get(netloc, (None, None))
185
186 if username is not None or password is not None:
187 # Convert the username and password if they're None, so that
188 # this netloc will show up as "cached" in the conditional above.
189 # Further, HTTPBasicAuth doesn't accept None, so it makes sense to
190 # cache the value that is going to be used.
191 username = username or ""
192 password = password or ""
193
194 # Store any acquired credentials.
195 self.passwords[netloc] = (username, password)
196
197 assert (
198 # Credentials were found
199 (username is not None and password is not None)
200 # Credentials were not found
201 or (username is None and password is None)
202 ), f"Could not load credentials from url: {original_url}"
203
204 return url, username, password
205
206 def __call__(self, req: Request) -> Request:
207 # Get credentials for this request
208 url, username, password = self._get_url_and_credentials(req.url)
209
210 # Set the url of the request to the url without any credentials
211 req.url = url
212
213 if username is not None and password is not None:
214 # Send the basic auth with this request
215 req = HTTPBasicAuth(username, password)(req)
216
217 # Attach a hook to handle 401 responses
218 req.register_hook("response", self.handle_401)
219
220 return req
221
222 # Factored out to allow for easy patching in tests
223 def _prompt_for_password(
224 self, netloc: str
225 ) -> Tuple[Optional[str], Optional[str], bool]:
226 username = ask_input(f"User for {netloc}: ")
227 if not username:
228 return None, None, False
229 auth = get_keyring_auth(netloc, username)
230 if auth and auth[0] is not None and auth[1] is not None:
231 return auth[0], auth[1], False
232 password = ask_password("Password: ")
233 return username, password, True
234
235 # Factored out to allow for easy patching in tests
236 def _should_save_password_to_keyring(self) -> bool:
237 if not keyring:
238 return False
239 return ask("Save credentials to keyring [y/N]: ", ["y", "n"]) == "y"
240
241 def handle_401(self, resp: Response, **kwargs: Any) -> Response:
242 # We only care about 401 responses, anything else we want to just
243 # pass through the actual response
244 if resp.status_code != 401:
245 return resp
246
247 # We are not able to prompt the user so simply return the response
248 if not self.prompting:
249 return resp
250
251 parsed = urllib.parse.urlparse(resp.url)
252
253 # Query the keyring for credentials:
254 username, password = self._get_new_credentials(
255 resp.url,
256 allow_netrc=False,
257 allow_keyring=True,
258 )
259
260 # Prompt the user for a new username and password
261 save = False
262 if not username and not password:
263 username, password, save = self._prompt_for_password(parsed.netloc)
264
265 # Store the new username and password to use for future requests
266 self._credentials_to_save = None
267 if username is not None and password is not None:
268 self.passwords[parsed.netloc] = (username, password)
269
270 # Prompt to save the password to keyring
271 if save and self._should_save_password_to_keyring():
272 self._credentials_to_save = (parsed.netloc, username, password)
273
274 # Consume content and release the original connection to allow our new
275 # request to reuse the same one.
276 resp.content
277 resp.raw.release_conn()
278
279 # Add our new username and password to the request
280 req = HTTPBasicAuth(username or "", password or "")(resp.request)
281 req.register_hook("response", self.warn_on_401)
282
283 # On successful request, save the credentials that were used to
284 # keyring. (Note that if the user responded "no" above, this member
285 # is not set and nothing will be saved.)
286 if self._credentials_to_save:
287 req.register_hook("response", self.save_credentials)
288
289 # Send our new request
290 new_resp = resp.connection.send(req, **kwargs)
291 new_resp.history.append(resp)
292
293 return new_resp
294
295 def warn_on_401(self, resp: Response, **kwargs: Any) -> None:
296 """Response callback to warn about incorrect credentials."""
297 if resp.status_code == 401:
298 logger.warning(
299 "401 Error, Credentials not correct for %s",
300 resp.request.url,
301 )
302
303 def save_credentials(self, resp: Response, **kwargs: Any) -> None:
304 """Response callback to save credentials on success."""
305 assert keyring is not None, "should never reach here without keyring"
306 if not keyring:
307 return
308
309 creds = self._credentials_to_save
310 self._credentials_to_save = None
311 if creds and resp.status_code < 400:
312 try:
313 logger.info("Saving credentials to keyring")
314 keyring.set_password(*creds)
315 except Exception:
316 logger.exception("Failed to save credentials")
317
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/src/pip/_internal/network/auth.py b/src/pip/_internal/network/auth.py
--- a/src/pip/_internal/network/auth.py
+++ b/src/pip/_internal/network/auth.py
@@ -179,9 +179,16 @@
# Try to get credentials from original url
username, password = self._get_new_credentials(original_url)
- # If credentials not found, use any stored credentials for this netloc
- if username is None and password is None:
- username, password = self.passwords.get(netloc, (None, None))
+ # If credentials not found, use any stored credentials for this netloc.
+ # Do this if either the username or the password is missing.
+ # This accounts for the situation in which the user has specified
+ # the username in the index url, but the password comes from keyring.
+ if (username is None or password is None) and netloc in self.passwords:
+ un, pw = self.passwords[netloc]
+ # It is possible that the cached credentials are for a different username,
+ # in which case the cache should be ignored.
+ if username is None or username == un:
+ username, password = un, pw
if username is not None or password is not None:
# Convert the username and password if they're None, so that
|
{"golden_diff": "diff --git a/src/pip/_internal/network/auth.py b/src/pip/_internal/network/auth.py\n--- a/src/pip/_internal/network/auth.py\n+++ b/src/pip/_internal/network/auth.py\n@@ -179,9 +179,16 @@\n # Try to get credentials from original url\n username, password = self._get_new_credentials(original_url)\n \n- # If credentials not found, use any stored credentials for this netloc\n- if username is None and password is None:\n- username, password = self.passwords.get(netloc, (None, None))\n+ # If credentials not found, use any stored credentials for this netloc.\n+ # Do this if either the username or the password is missing.\n+ # This accounts for the situation in which the user has specified\n+ # the username in the index url, but the password comes from keyring.\n+ if (username is None or password is None) and netloc in self.passwords:\n+ un, pw = self.passwords[netloc]\n+ # It is possible that the cached credentials are for a different username,\n+ # in which case the cache should be ignored.\n+ if username is None or username == un:\n+ username, password = un, pw\n \n if username is not None or password is not None:\n # Convert the username and password if they're None, so that\n", "issue": "Add flag to force pip to always fetch password from keyring\n**What's the problem this feature will solve?**\r\n\r\nI am trying to fetch modules from a private server. In order to avoid storing this password in filesystem or environment, I have added it to keyring instead. I have also set `https://[email protected]` as global.index-url in my pip.conf.\r\n\r\nBased upon the verbose logs from `pip install`, it seems that pip will first do the request without a password, get a 401, and then fetch the password from keyring.\r\n\r\n**Describe the solution you'd like**\r\n\r\nThere should be a way to force pip to always fetch the password from keyring in the first place. This would prevent it from spamming the server with unauthenticated requests.\r\n\r\n**Alternative Solutions**\r\n\r\nI don't want to put the password in plaintext in my pip.conf or environment variables, so I'm not aware of any alternative solution.\r\n\r\n**Additional context**\r\n\r\nn/a\r\n\n", "before_files": [{"content": "\"\"\"Network Authentication Helpers\n\nContains interface (MultiDomainBasicAuth) and associated glue code for\nproviding credentials in the context of network requests.\n\"\"\"\n\nimport urllib.parse\nfrom typing import Any, Dict, List, Optional, Tuple\n\nfrom pip._vendor.requests.auth import AuthBase, HTTPBasicAuth\nfrom pip._vendor.requests.models import Request, Response\nfrom pip._vendor.requests.utils import get_netrc_auth\n\nfrom pip._internal.utils.logging import getLogger\nfrom pip._internal.utils.misc import (\n ask,\n ask_input,\n ask_password,\n remove_auth_from_url,\n split_auth_netloc_from_url,\n)\nfrom pip._internal.vcs.versioncontrol import AuthInfo\n\nlogger = getLogger(__name__)\n\nCredentials = Tuple[str, str, str]\n\ntry:\n import keyring\nexcept ImportError:\n keyring = None # type: ignore[assignment]\nexcept Exception as exc:\n logger.warning(\n \"Keyring is skipped due to an exception: %s\",\n str(exc),\n )\n keyring = None # type: ignore[assignment]\n\n\ndef get_keyring_auth(url: Optional[str], username: Optional[str]) -> Optional[AuthInfo]:\n \"\"\"Return the tuple auth for a given url from keyring.\"\"\"\n global keyring\n if not url or not keyring:\n return None\n\n try:\n try:\n get_credential = keyring.get_credential\n except AttributeError:\n pass\n else:\n logger.debug(\"Getting credentials from keyring for %s\", url)\n cred = get_credential(url, username)\n if cred is not None:\n return cred.username, cred.password\n return None\n\n if username:\n logger.debug(\"Getting password from keyring for %s\", url)\n password = keyring.get_password(url, username)\n if password:\n return username, password\n\n except Exception as exc:\n logger.warning(\n \"Keyring is skipped due to an exception: %s\",\n str(exc),\n )\n keyring = None # type: ignore[assignment]\n return None\n\n\nclass MultiDomainBasicAuth(AuthBase):\n def __init__(\n self, prompting: bool = True, index_urls: Optional[List[str]] = None\n ) -> None:\n self.prompting = prompting\n self.index_urls = index_urls\n self.passwords: Dict[str, AuthInfo] = {}\n # When the user is prompted to enter credentials and keyring is\n # available, we will offer to save them. If the user accepts,\n # this value is set to the credentials they entered. After the\n # request authenticates, the caller should call\n # ``save_credentials`` to save these.\n self._credentials_to_save: Optional[Credentials] = None\n\n def _get_index_url(self, url: str) -> Optional[str]:\n \"\"\"Return the original index URL matching the requested URL.\n\n Cached or dynamically generated credentials may work against\n the original index URL rather than just the netloc.\n\n The provided url should have had its username and password\n removed already. If the original index url had credentials then\n they will be included in the return value.\n\n Returns None if no matching index was found, or if --no-index\n was specified by the user.\n \"\"\"\n if not url or not self.index_urls:\n return None\n\n for u in self.index_urls:\n prefix = remove_auth_from_url(u).rstrip(\"/\") + \"/\"\n if url.startswith(prefix):\n return u\n return None\n\n def _get_new_credentials(\n self,\n original_url: str,\n allow_netrc: bool = True,\n allow_keyring: bool = False,\n ) -> AuthInfo:\n \"\"\"Find and return credentials for the specified URL.\"\"\"\n # Split the credentials and netloc from the url.\n url, netloc, url_user_password = split_auth_netloc_from_url(\n original_url,\n )\n\n # Start with the credentials embedded in the url\n username, password = url_user_password\n if username is not None and password is not None:\n logger.debug(\"Found credentials in url for %s\", netloc)\n return url_user_password\n\n # Find a matching index url for this request\n index_url = self._get_index_url(url)\n if index_url:\n # Split the credentials from the url.\n index_info = split_auth_netloc_from_url(index_url)\n if index_info:\n index_url, _, index_url_user_password = index_info\n logger.debug(\"Found index url %s\", index_url)\n\n # If an index URL was found, try its embedded credentials\n if index_url and index_url_user_password[0] is not None:\n username, password = index_url_user_password\n if username is not None and password is not None:\n logger.debug(\"Found credentials in index url for %s\", netloc)\n return index_url_user_password\n\n # Get creds from netrc if we still don't have them\n if allow_netrc:\n netrc_auth = get_netrc_auth(original_url)\n if netrc_auth:\n logger.debug(\"Found credentials in netrc for %s\", netloc)\n return netrc_auth\n\n # If we don't have a password and keyring is available, use it.\n if allow_keyring:\n # The index url is more specific than the netloc, so try it first\n # fmt: off\n kr_auth = (\n get_keyring_auth(index_url, username) or\n get_keyring_auth(netloc, username)\n )\n # fmt: on\n if kr_auth:\n logger.debug(\"Found credentials in keyring for %s\", netloc)\n return kr_auth\n\n return username, password\n\n def _get_url_and_credentials(\n self, original_url: str\n ) -> Tuple[str, Optional[str], Optional[str]]:\n \"\"\"Return the credentials to use for the provided URL.\n\n If allowed, netrc and keyring may be used to obtain the\n correct credentials.\n\n Returns (url_without_credentials, username, password). Note\n that even if the original URL contains credentials, this\n function may return a different username and password.\n \"\"\"\n url, netloc, _ = split_auth_netloc_from_url(original_url)\n\n # Try to get credentials from original url\n username, password = self._get_new_credentials(original_url)\n\n # If credentials not found, use any stored credentials for this netloc\n if username is None and password is None:\n username, password = self.passwords.get(netloc, (None, None))\n\n if username is not None or password is not None:\n # Convert the username and password if they're None, so that\n # this netloc will show up as \"cached\" in the conditional above.\n # Further, HTTPBasicAuth doesn't accept None, so it makes sense to\n # cache the value that is going to be used.\n username = username or \"\"\n password = password or \"\"\n\n # Store any acquired credentials.\n self.passwords[netloc] = (username, password)\n\n assert (\n # Credentials were found\n (username is not None and password is not None)\n # Credentials were not found\n or (username is None and password is None)\n ), f\"Could not load credentials from url: {original_url}\"\n\n return url, username, password\n\n def __call__(self, req: Request) -> Request:\n # Get credentials for this request\n url, username, password = self._get_url_and_credentials(req.url)\n\n # Set the url of the request to the url without any credentials\n req.url = url\n\n if username is not None and password is not None:\n # Send the basic auth with this request\n req = HTTPBasicAuth(username, password)(req)\n\n # Attach a hook to handle 401 responses\n req.register_hook(\"response\", self.handle_401)\n\n return req\n\n # Factored out to allow for easy patching in tests\n def _prompt_for_password(\n self, netloc: str\n ) -> Tuple[Optional[str], Optional[str], bool]:\n username = ask_input(f\"User for {netloc}: \")\n if not username:\n return None, None, False\n auth = get_keyring_auth(netloc, username)\n if auth and auth[0] is not None and auth[1] is not None:\n return auth[0], auth[1], False\n password = ask_password(\"Password: \")\n return username, password, True\n\n # Factored out to allow for easy patching in tests\n def _should_save_password_to_keyring(self) -> bool:\n if not keyring:\n return False\n return ask(\"Save credentials to keyring [y/N]: \", [\"y\", \"n\"]) == \"y\"\n\n def handle_401(self, resp: Response, **kwargs: Any) -> Response:\n # We only care about 401 responses, anything else we want to just\n # pass through the actual response\n if resp.status_code != 401:\n return resp\n\n # We are not able to prompt the user so simply return the response\n if not self.prompting:\n return resp\n\n parsed = urllib.parse.urlparse(resp.url)\n\n # Query the keyring for credentials:\n username, password = self._get_new_credentials(\n resp.url,\n allow_netrc=False,\n allow_keyring=True,\n )\n\n # Prompt the user for a new username and password\n save = False\n if not username and not password:\n username, password, save = self._prompt_for_password(parsed.netloc)\n\n # Store the new username and password to use for future requests\n self._credentials_to_save = None\n if username is not None and password is not None:\n self.passwords[parsed.netloc] = (username, password)\n\n # Prompt to save the password to keyring\n if save and self._should_save_password_to_keyring():\n self._credentials_to_save = (parsed.netloc, username, password)\n\n # Consume content and release the original connection to allow our new\n # request to reuse the same one.\n resp.content\n resp.raw.release_conn()\n\n # Add our new username and password to the request\n req = HTTPBasicAuth(username or \"\", password or \"\")(resp.request)\n req.register_hook(\"response\", self.warn_on_401)\n\n # On successful request, save the credentials that were used to\n # keyring. (Note that if the user responded \"no\" above, this member\n # is not set and nothing will be saved.)\n if self._credentials_to_save:\n req.register_hook(\"response\", self.save_credentials)\n\n # Send our new request\n new_resp = resp.connection.send(req, **kwargs)\n new_resp.history.append(resp)\n\n return new_resp\n\n def warn_on_401(self, resp: Response, **kwargs: Any) -> None:\n \"\"\"Response callback to warn about incorrect credentials.\"\"\"\n if resp.status_code == 401:\n logger.warning(\n \"401 Error, Credentials not correct for %s\",\n resp.request.url,\n )\n\n def save_credentials(self, resp: Response, **kwargs: Any) -> None:\n \"\"\"Response callback to save credentials on success.\"\"\"\n assert keyring is not None, \"should never reach here without keyring\"\n if not keyring:\n return\n\n creds = self._credentials_to_save\n self._credentials_to_save = None\n if creds and resp.status_code < 400:\n try:\n logger.info(\"Saving credentials to keyring\")\n keyring.set_password(*creds)\n except Exception:\n logger.exception(\"Failed to save credentials\")\n", "path": "src/pip/_internal/network/auth.py"}], "after_files": [{"content": "\"\"\"Network Authentication Helpers\n\nContains interface (MultiDomainBasicAuth) and associated glue code for\nproviding credentials in the context of network requests.\n\"\"\"\n\nimport urllib.parse\nfrom typing import Any, Dict, List, Optional, Tuple\n\nfrom pip._vendor.requests.auth import AuthBase, HTTPBasicAuth\nfrom pip._vendor.requests.models import Request, Response\nfrom pip._vendor.requests.utils import get_netrc_auth\n\nfrom pip._internal.utils.logging import getLogger\nfrom pip._internal.utils.misc import (\n ask,\n ask_input,\n ask_password,\n remove_auth_from_url,\n split_auth_netloc_from_url,\n)\nfrom pip._internal.vcs.versioncontrol import AuthInfo\n\nlogger = getLogger(__name__)\n\nCredentials = Tuple[str, str, str]\n\ntry:\n import keyring\nexcept ImportError:\n keyring = None # type: ignore[assignment]\nexcept Exception as exc:\n logger.warning(\n \"Keyring is skipped due to an exception: %s\",\n str(exc),\n )\n keyring = None # type: ignore[assignment]\n\n\ndef get_keyring_auth(url: Optional[str], username: Optional[str]) -> Optional[AuthInfo]:\n \"\"\"Return the tuple auth for a given url from keyring.\"\"\"\n global keyring\n if not url or not keyring:\n return None\n\n try:\n try:\n get_credential = keyring.get_credential\n except AttributeError:\n pass\n else:\n logger.debug(\"Getting credentials from keyring for %s\", url)\n cred = get_credential(url, username)\n if cred is not None:\n return cred.username, cred.password\n return None\n\n if username:\n logger.debug(\"Getting password from keyring for %s\", url)\n password = keyring.get_password(url, username)\n if password:\n return username, password\n\n except Exception as exc:\n logger.warning(\n \"Keyring is skipped due to an exception: %s\",\n str(exc),\n )\n keyring = None # type: ignore[assignment]\n return None\n\n\nclass MultiDomainBasicAuth(AuthBase):\n def __init__(\n self, prompting: bool = True, index_urls: Optional[List[str]] = None\n ) -> None:\n self.prompting = prompting\n self.index_urls = index_urls\n self.passwords: Dict[str, AuthInfo] = {}\n # When the user is prompted to enter credentials and keyring is\n # available, we will offer to save them. If the user accepts,\n # this value is set to the credentials they entered. After the\n # request authenticates, the caller should call\n # ``save_credentials`` to save these.\n self._credentials_to_save: Optional[Credentials] = None\n\n def _get_index_url(self, url: str) -> Optional[str]:\n \"\"\"Return the original index URL matching the requested URL.\n\n Cached or dynamically generated credentials may work against\n the original index URL rather than just the netloc.\n\n The provided url should have had its username and password\n removed already. If the original index url had credentials then\n they will be included in the return value.\n\n Returns None if no matching index was found, or if --no-index\n was specified by the user.\n \"\"\"\n if not url or not self.index_urls:\n return None\n\n for u in self.index_urls:\n prefix = remove_auth_from_url(u).rstrip(\"/\") + \"/\"\n if url.startswith(prefix):\n return u\n return None\n\n def _get_new_credentials(\n self,\n original_url: str,\n allow_netrc: bool = True,\n allow_keyring: bool = False,\n ) -> AuthInfo:\n \"\"\"Find and return credentials for the specified URL.\"\"\"\n # Split the credentials and netloc from the url.\n url, netloc, url_user_password = split_auth_netloc_from_url(\n original_url,\n )\n\n # Start with the credentials embedded in the url\n username, password = url_user_password\n if username is not None and password is not None:\n logger.debug(\"Found credentials in url for %s\", netloc)\n return url_user_password\n\n # Find a matching index url for this request\n index_url = self._get_index_url(url)\n if index_url:\n # Split the credentials from the url.\n index_info = split_auth_netloc_from_url(index_url)\n if index_info:\n index_url, _, index_url_user_password = index_info\n logger.debug(\"Found index url %s\", index_url)\n\n # If an index URL was found, try its embedded credentials\n if index_url and index_url_user_password[0] is not None:\n username, password = index_url_user_password\n if username is not None and password is not None:\n logger.debug(\"Found credentials in index url for %s\", netloc)\n return index_url_user_password\n\n # Get creds from netrc if we still don't have them\n if allow_netrc:\n netrc_auth = get_netrc_auth(original_url)\n if netrc_auth:\n logger.debug(\"Found credentials in netrc for %s\", netloc)\n return netrc_auth\n\n # If we don't have a password and keyring is available, use it.\n if allow_keyring:\n # The index url is more specific than the netloc, so try it first\n # fmt: off\n kr_auth = (\n get_keyring_auth(index_url, username) or\n get_keyring_auth(netloc, username)\n )\n # fmt: on\n if kr_auth:\n logger.debug(\"Found credentials in keyring for %s\", netloc)\n return kr_auth\n\n return username, password\n\n def _get_url_and_credentials(\n self, original_url: str\n ) -> Tuple[str, Optional[str], Optional[str]]:\n \"\"\"Return the credentials to use for the provided URL.\n\n If allowed, netrc and keyring may be used to obtain the\n correct credentials.\n\n Returns (url_without_credentials, username, password). Note\n that even if the original URL contains credentials, this\n function may return a different username and password.\n \"\"\"\n url, netloc, _ = split_auth_netloc_from_url(original_url)\n\n # Try to get credentials from original url\n username, password = self._get_new_credentials(original_url)\n\n # If credentials not found, use any stored credentials for this netloc.\n # Do this if either the username or the password is missing.\n # This accounts for the situation in which the user has specified\n # the username in the index url, but the password comes from keyring.\n if (username is None or password is None) and netloc in self.passwords:\n un, pw = self.passwords[netloc]\n # It is possible that the cached credentials are for a different username,\n # in which case the cache should be ignored.\n if username is None or username == un:\n username, password = un, pw\n\n if username is not None or password is not None:\n # Convert the username and password if they're None, so that\n # this netloc will show up as \"cached\" in the conditional above.\n # Further, HTTPBasicAuth doesn't accept None, so it makes sense to\n # cache the value that is going to be used.\n username = username or \"\"\n password = password or \"\"\n\n # Store any acquired credentials.\n self.passwords[netloc] = (username, password)\n\n assert (\n # Credentials were found\n (username is not None and password is not None)\n # Credentials were not found\n or (username is None and password is None)\n ), f\"Could not load credentials from url: {original_url}\"\n\n return url, username, password\n\n def __call__(self, req: Request) -> Request:\n # Get credentials for this request\n url, username, password = self._get_url_and_credentials(req.url)\n\n # Set the url of the request to the url without any credentials\n req.url = url\n\n if username is not None and password is not None:\n # Send the basic auth with this request\n req = HTTPBasicAuth(username, password)(req)\n\n # Attach a hook to handle 401 responses\n req.register_hook(\"response\", self.handle_401)\n\n return req\n\n # Factored out to allow for easy patching in tests\n def _prompt_for_password(\n self, netloc: str\n ) -> Tuple[Optional[str], Optional[str], bool]:\n username = ask_input(f\"User for {netloc}: \")\n if not username:\n return None, None, False\n auth = get_keyring_auth(netloc, username)\n if auth and auth[0] is not None and auth[1] is not None:\n return auth[0], auth[1], False\n password = ask_password(\"Password: \")\n return username, password, True\n\n # Factored out to allow for easy patching in tests\n def _should_save_password_to_keyring(self) -> bool:\n if not keyring:\n return False\n return ask(\"Save credentials to keyring [y/N]: \", [\"y\", \"n\"]) == \"y\"\n\n def handle_401(self, resp: Response, **kwargs: Any) -> Response:\n # We only care about 401 responses, anything else we want to just\n # pass through the actual response\n if resp.status_code != 401:\n return resp\n\n # We are not able to prompt the user so simply return the response\n if not self.prompting:\n return resp\n\n parsed = urllib.parse.urlparse(resp.url)\n\n # Query the keyring for credentials:\n username, password = self._get_new_credentials(\n resp.url,\n allow_netrc=False,\n allow_keyring=True,\n )\n\n # Prompt the user for a new username and password\n save = False\n if not username and not password:\n username, password, save = self._prompt_for_password(parsed.netloc)\n\n # Store the new username and password to use for future requests\n self._credentials_to_save = None\n if username is not None and password is not None:\n self.passwords[parsed.netloc] = (username, password)\n\n # Prompt to save the password to keyring\n if save and self._should_save_password_to_keyring():\n self._credentials_to_save = (parsed.netloc, username, password)\n\n # Consume content and release the original connection to allow our new\n # request to reuse the same one.\n resp.content\n resp.raw.release_conn()\n\n # Add our new username and password to the request\n req = HTTPBasicAuth(username or \"\", password or \"\")(resp.request)\n req.register_hook(\"response\", self.warn_on_401)\n\n # On successful request, save the credentials that were used to\n # keyring. (Note that if the user responded \"no\" above, this member\n # is not set and nothing will be saved.)\n if self._credentials_to_save:\n req.register_hook(\"response\", self.save_credentials)\n\n # Send our new request\n new_resp = resp.connection.send(req, **kwargs)\n new_resp.history.append(resp)\n\n return new_resp\n\n def warn_on_401(self, resp: Response, **kwargs: Any) -> None:\n \"\"\"Response callback to warn about incorrect credentials.\"\"\"\n if resp.status_code == 401:\n logger.warning(\n \"401 Error, Credentials not correct for %s\",\n resp.request.url,\n )\n\n def save_credentials(self, resp: Response, **kwargs: Any) -> None:\n \"\"\"Response callback to save credentials on success.\"\"\"\n assert keyring is not None, \"should never reach here without keyring\"\n if not keyring:\n return\n\n creds = self._credentials_to_save\n self._credentials_to_save = None\n if creds and resp.status_code < 400:\n try:\n logger.info(\"Saving credentials to keyring\")\n keyring.set_password(*creds)\n except Exception:\n logger.exception(\"Failed to save credentials\")\n", "path": "src/pip/_internal/network/auth.py"}]}
| 3,866 | 303 |
gh_patches_debug_13482
|
rasdani/github-patches
|
git_diff
|
joke2k__faker-863
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
uuid4 should return UUID instead of str
__Context__: I'm using faker in combination with [FactoryBoy](https://github.com/FactoryBoy/factory_boy) to test [Django](https://www.djangoproject.com/) models. I have this test to make sure some data dict generated from model data is JSON-serializable. The test passed, but not the code in production. (`Object of type UUID is not JSON serializable`).
Now, of course the fix to the offending code is simple:
``` diff
- data['uuid'] = model.uuid
+ data['uuid'] = str(model.uuid)
```
but the problem is two-fold:
1. __The fact that `uuid4` returns `str` is confusing__. I didn't pay attention and couldn't test properly.
2. __There is no provider for actual `UUID` objects__. I can understand if some people want strings that are in fact uuid representations, after all that's [how AutoFixture generates strings](https://github.com/AutoFixture/AutoFixture/wiki/Cheat-Sheet#completely-autogenerated-string) (Autofixture does approximately the same job as faker, but for C#). But there should be a provider for true `UUID`s as well.
### Steps to reproduce
1. Call `fake.uuid4()`
### Expected behavior
`fake.uuid4()` should return an `UUID` object
### Actual behavior
`fake.uuid4()` returns a `str`
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `faker/providers/misc/__init__.py`
Content:
```
1 # coding=utf-8
2
3 from __future__ import unicode_literals
4 import hashlib
5 import string
6 import uuid
7 import sys
8
9 from .. import BaseProvider
10
11
12 class Provider(BaseProvider):
13 # Locales supported by Linux Mint from `/usr/share/i18n/SUPPORTED`
14 language_locale_codes = {
15 'aa': ('DJ', 'ER', 'ET'), 'af': ('ZA',), 'ak': ('GH',), 'am': ('ET',),
16 'an': ('ES',), 'apn': ('IN',),
17 'ar': ('AE', 'BH', 'DJ', 'DZ', 'EG', 'EH', 'ER', 'IL', 'IN',
18 'IQ', 'JO', 'KM', 'KW', 'LB', 'LY', 'MA', 'MR', 'OM',
19 'PS', 'QA', 'SA', 'SD', 'SO', 'SS', 'SY', 'TD', 'TN',
20 'YE'),
21 'as': ('IN',), 'ast': ('ES',), 'ayc': ('PE',), 'az': ('AZ', 'IN'),
22 'be': ('BY',), 'bem': ('ZM',), 'ber': ('DZ', 'MA'), 'bg': ('BG',),
23 'bhb': ('IN',), 'bho': ('IN',), 'bn': ('BD', 'IN'), 'bo': ('CN', 'IN'),
24 'br': ('FR',), 'brx': ('IN',), 'bs': ('BA',), 'byn': ('ER',),
25 'ca': ('AD', 'ES', 'FR', 'IT'), 'ce': ('RU',), 'ckb': ('IQ',),
26 'cmn': ('TW',), 'crh': ('UA',), 'cs': ('CZ',), 'csb': ('PL',),
27 'cv': ('RU',), 'cy': ('GB',), 'da': ('DK',),
28 'de': ('AT', 'BE', 'CH', 'DE', 'LI', 'LU'), 'doi': ('IN',),
29 'dv': ('MV',), 'dz': ('BT',), 'el': ('GR', 'CY'),
30 'en': ('AG', 'AU', 'BW', 'CA', 'DK', 'GB', 'HK', 'IE', 'IN', 'NG',
31 'NZ', 'PH', 'SG', 'US', 'ZA', 'ZM', 'ZW'),
32 'eo': ('US',),
33 'es': ('AR', 'BO', 'CL', 'CO', 'CR', 'CU', 'DO', 'EC', 'ES', 'GT',
34 'HN', 'MX', 'NI', 'PA', 'PE', 'PR', 'PY', 'SV', 'US', 'UY', 'VE',
35 ), 'et': ('EE',), 'eu': ('ES', 'FR'), 'fa': ('IR',),
36 'ff': ('SN',), 'fi': ('FI',), 'fil': ('PH',), 'fo': ('FO',),
37 'fr': ('CA', 'CH', 'FR', 'LU'), 'fur': ('IT',), 'fy': ('NL', 'DE'),
38 'ga': ('IE',), 'gd': ('GB',), 'gez': ('ER', 'ET'), 'gl': ('ES',),
39 'gu': ('IN',), 'gv': ('GB',), 'ha': ('NG',), 'hak': ('TW',),
40 'he': ('IL',), 'hi': ('IN',), 'hne': ('IN',), 'hr': ('HR',),
41 'hsb': ('DE',), 'ht': ('HT',), 'hu': ('HU',), 'hy': ('AM',),
42 'ia': ('FR',), 'id': ('ID',), 'ig': ('NG',), 'ik': ('CA',),
43 'is': ('IS',), 'it': ('CH', 'IT'), 'iu': ('CA',), 'iw': ('IL',),
44 'ja': ('JP',), 'ka': ('GE',), 'kk': ('KZ',), 'kl': ('GL',),
45 'km': ('KH',), 'kn': ('IN',), 'ko': ('KR',), 'kok': ('IN',),
46 'ks': ('IN',), 'ku': ('TR',), 'kw': ('GB',), 'ky': ('KG',),
47 'lb': ('LU',), 'lg': ('UG',), 'li': ('BE', 'NL'), 'lij': ('IT',),
48 'ln': ('CD',), 'lo': ('LA',), 'lt': ('LT',), 'lv': ('LV',),
49 'lzh': ('TW',), 'mag': ('IN',), 'mai': ('IN',), 'mg': ('MG',),
50 'mhr': ('RU',), 'mi': ('NZ',), 'mk': ('MK',), 'ml': ('IN',),
51 'mn': ('MN',), 'mni': ('IN',), 'mr': ('IN',), 'ms': ('MY',),
52 'mt': ('MT',), 'my': ('MM',), 'nan': ('TW',), 'nb': ('NO',),
53 'nds': ('DE', 'NL'), 'ne': ('NP',), 'nhn': ('MX',),
54 'niu': ('NU', 'NZ'), 'nl': ('AW', 'BE', 'NL'), 'nn': ('NO',),
55 'nr': ('ZA',), 'nso': ('ZA',), 'oc': ('FR',), 'om': ('ET', 'KE'),
56 'or': ('IN',), 'os': ('RU',), 'pa': ('IN', 'PK'),
57 'pap': ('AN', 'AW', 'CW'), 'pl': ('PL',), 'ps': ('AF',),
58 'pt': ('BR', 'PT'), 'quz': ('PE',), 'raj': ('IN',), 'ro': ('RO',),
59 'ru': ('RU', 'UA'), 'rw': ('RW',), 'sa': ('IN',), 'sat': ('IN',),
60 'sc': ('IT',), 'sd': ('IN', 'PK'), 'se': ('NO',), 'shs': ('CA',),
61 'si': ('LK',), 'sid': ('ET',), 'sk': ('SK',), 'sl': ('SI',),
62 'so': ('DJ', 'ET', 'KE', 'SO'), 'sq': ('AL', 'ML'), 'sr': ('ME', 'RS'),
63 'ss': ('ZA',), 'st': ('ZA',), 'sv': ('FI', 'SE'), 'sw': ('KE', 'TZ'),
64 'szl': ('PL',), 'ta': ('IN', 'LK'), 'tcy': ('IN',), 'te': ('IN',),
65 'tg': ('TJ',), 'th': ('TH',), 'the': ('NP',), 'ti': ('ER', 'ET'),
66 'tig': ('ER',), 'tk': ('TM',), 'tl': ('PH',), 'tn': ('ZA',),
67 'tr': ('CY', 'TR'), 'ts': ('ZA',), 'tt': ('RU',), 'ug': ('CN',),
68 'uk': ('UA',), 'unm': ('US',), 'ur': ('IN', 'PK'), 'uz': ('UZ',),
69 've': ('ZA',), 'vi': ('VN',), 'wa': ('BE',), 'wae': ('CH',),
70 'wal': ('ET',), 'wo': ('SN',), 'xh': ('ZA',), 'yi': ('US',),
71 'yo': ('NG',), 'yue': ('HK',), 'zh': ('CN', 'HK', 'SG', 'TW'),
72 'zu': ('ZA',),
73 }
74
75 def boolean(self, chance_of_getting_true=50):
76 return self.generator.random.randint(1, 100) <= chance_of_getting_true
77
78 def null_boolean(self):
79 return {
80 0: None,
81 1: True,
82 -1: False,
83 }[self.generator.random.randint(-1, 1)]
84
85 def binary(self, length=(1 * 1024 * 1024)):
86 """ Returns random binary blob.
87
88 Default blob size is 1 Mb.
89 """
90 blob = [self.generator.random.randrange(256) for _ in range(length)]
91 return bytes(blob) if sys.version_info[0] >= 3 else bytearray(blob)
92
93 def md5(self, raw_output=False):
94 """
95 Calculates the md5 hash of a given string
96 :example 'cfcd208495d565ef66e7dff9f98764da'
97 """
98 res = hashlib.md5(str(self.generator.random.random()).encode('utf-8'))
99 if raw_output:
100 return res.digest()
101 return res.hexdigest()
102
103 def sha1(self, raw_output=False):
104 """
105 Calculates the sha1 hash of a given string
106 :example 'b5d86317c2a144cd04d0d7c03b2b02666fafadf2'
107 """
108 res = hashlib.sha1(str(self.generator.random.random()).encode('utf-8'))
109 if raw_output:
110 return res.digest()
111 return res.hexdigest()
112
113 def sha256(self, raw_output=False):
114 """
115 Calculates the sha256 hash of a given string
116 :example '85086017559ccc40638fcde2fecaf295e0de7ca51b7517b6aebeaaf75b4d4654'
117 """
118 res = hashlib.sha256(
119 str(self.generator.random.random()).encode('utf-8'))
120 if raw_output:
121 return res.digest()
122 return res.hexdigest()
123
124 def locale(self):
125 language_code = self.language_code()
126 return language_code + '_' + self.random_element(
127 Provider.language_locale_codes[language_code],
128 )
129
130 def language_code(self):
131 return self.random_element(Provider.language_locale_codes.keys())
132
133 def uuid4(self):
134 """
135 Generates a random UUID4 string.
136 """
137 # Based on http://stackoverflow.com/q/41186818
138 return str(uuid.UUID(int=self.generator.random.getrandbits(128)))
139
140 def password(
141 self,
142 length=10,
143 special_chars=True,
144 digits=True,
145 upper_case=True,
146 lower_case=True):
147 """
148 Generates a random password.
149 @param length: Integer. Length of a password
150 @param special_chars: Boolean. Whether to use special characters !@#$%^&*()_+
151 @param digits: Boolean. Whether to use digits
152 @param upper_case: Boolean. Whether to use upper letters
153 @param lower_case: Boolean. Whether to use lower letters
154 @return: String. Random password
155 """
156 choices = ""
157 required_tokens = []
158 if special_chars:
159 required_tokens.append(
160 self.generator.random.choice("!@#$%^&*()_+"))
161 choices += "!@#$%^&*()_+"
162 if digits:
163 required_tokens.append(self.generator.random.choice(string.digits))
164 choices += string.digits
165 if upper_case:
166 required_tokens.append(
167 self.generator.random.choice(string.ascii_uppercase))
168 choices += string.ascii_uppercase
169 if lower_case:
170 required_tokens.append(
171 self.generator.random.choice(string.ascii_lowercase))
172 choices += string.ascii_lowercase
173
174 assert len(
175 required_tokens) <= length, "Required length is shorter than required characters"
176
177 # Generate a first version of the password
178 chars = self.random_choices(choices, length=length)
179
180 # Pick some unique locations
181 random_indexes = set()
182 while len(random_indexes) < len(required_tokens):
183 random_indexes.add(
184 self.generator.random.randint(0, len(chars) - 1))
185
186 # Replace them with the required characters
187 for i, index in enumerate(random_indexes):
188 chars[index] = required_tokens[i]
189
190 return ''.join(chars)
191
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/faker/providers/misc/__init__.py b/faker/providers/misc/__init__.py
--- a/faker/providers/misc/__init__.py
+++ b/faker/providers/misc/__init__.py
@@ -130,12 +130,14 @@
def language_code(self):
return self.random_element(Provider.language_locale_codes.keys())
- def uuid4(self):
+ def uuid4(self, cast_to=str):
"""
Generates a random UUID4 string.
+ :param cast_to: Specify what type the UUID should be cast to. Default is `str`
+ :type cast_to: callable
"""
# Based on http://stackoverflow.com/q/41186818
- return str(uuid.UUID(int=self.generator.random.getrandbits(128)))
+ return cast_to(uuid.UUID(int=self.generator.random.getrandbits(128), version=4))
def password(
self,
|
{"golden_diff": "diff --git a/faker/providers/misc/__init__.py b/faker/providers/misc/__init__.py\n--- a/faker/providers/misc/__init__.py\n+++ b/faker/providers/misc/__init__.py\n@@ -130,12 +130,14 @@\n def language_code(self):\n return self.random_element(Provider.language_locale_codes.keys())\n \n- def uuid4(self):\n+ def uuid4(self, cast_to=str):\n \"\"\"\n Generates a random UUID4 string.\n+ :param cast_to: Specify what type the UUID should be cast to. Default is `str`\n+ :type cast_to: callable\n \"\"\"\n # Based on http://stackoverflow.com/q/41186818\n- return str(uuid.UUID(int=self.generator.random.getrandbits(128)))\n+ return cast_to(uuid.UUID(int=self.generator.random.getrandbits(128), version=4))\n \n def password(\n self,\n", "issue": "uuid4 should return UUID instead of str\n__Context__: I'm using faker in combination with [FactoryBoy](https://github.com/FactoryBoy/factory_boy) to test [Django](https://www.djangoproject.com/) models. I have this test to make sure some data dict generated from model data is JSON-serializable. The test passed, but not the code in production. (`Object of type UUID is not JSON serializable`).\r\n\r\nNow, of course the fix to the offending code is simple:\r\n\r\n``` diff\r\n- data['uuid'] = model.uuid\r\n+ data['uuid'] = str(model.uuid)\r\n```\r\n\r\nbut the problem is two-fold:\r\n\r\n1. __The fact that `uuid4` returns `str` is confusing__. I didn't pay attention and couldn't test properly.\r\n2. __There is no provider for actual `UUID` objects__. I can understand if some people want strings that are in fact uuid representations, after all that's [how AutoFixture generates strings](https://github.com/AutoFixture/AutoFixture/wiki/Cheat-Sheet#completely-autogenerated-string) (Autofixture does approximately the same job as faker, but for C#). But there should be a provider for true `UUID`s as well.\r\n\r\n### Steps to reproduce\r\n\r\n1. Call `fake.uuid4()`\r\n\r\n### Expected behavior\r\n\r\n`fake.uuid4()` should return an `UUID` object\r\n\r\n### Actual behavior\r\n\r\n`fake.uuid4()` returns a `str`\r\n\n", "before_files": [{"content": "# coding=utf-8\n\nfrom __future__ import unicode_literals\nimport hashlib\nimport string\nimport uuid\nimport sys\n\nfrom .. import BaseProvider\n\n\nclass Provider(BaseProvider):\n # Locales supported by Linux Mint from `/usr/share/i18n/SUPPORTED`\n language_locale_codes = {\n 'aa': ('DJ', 'ER', 'ET'), 'af': ('ZA',), 'ak': ('GH',), 'am': ('ET',),\n 'an': ('ES',), 'apn': ('IN',),\n 'ar': ('AE', 'BH', 'DJ', 'DZ', 'EG', 'EH', 'ER', 'IL', 'IN',\n 'IQ', 'JO', 'KM', 'KW', 'LB', 'LY', 'MA', 'MR', 'OM',\n 'PS', 'QA', 'SA', 'SD', 'SO', 'SS', 'SY', 'TD', 'TN',\n 'YE'),\n 'as': ('IN',), 'ast': ('ES',), 'ayc': ('PE',), 'az': ('AZ', 'IN'),\n 'be': ('BY',), 'bem': ('ZM',), 'ber': ('DZ', 'MA'), 'bg': ('BG',),\n 'bhb': ('IN',), 'bho': ('IN',), 'bn': ('BD', 'IN'), 'bo': ('CN', 'IN'),\n 'br': ('FR',), 'brx': ('IN',), 'bs': ('BA',), 'byn': ('ER',),\n 'ca': ('AD', 'ES', 'FR', 'IT'), 'ce': ('RU',), 'ckb': ('IQ',),\n 'cmn': ('TW',), 'crh': ('UA',), 'cs': ('CZ',), 'csb': ('PL',),\n 'cv': ('RU',), 'cy': ('GB',), 'da': ('DK',),\n 'de': ('AT', 'BE', 'CH', 'DE', 'LI', 'LU'), 'doi': ('IN',),\n 'dv': ('MV',), 'dz': ('BT',), 'el': ('GR', 'CY'),\n 'en': ('AG', 'AU', 'BW', 'CA', 'DK', 'GB', 'HK', 'IE', 'IN', 'NG',\n 'NZ', 'PH', 'SG', 'US', 'ZA', 'ZM', 'ZW'),\n 'eo': ('US',),\n 'es': ('AR', 'BO', 'CL', 'CO', 'CR', 'CU', 'DO', 'EC', 'ES', 'GT',\n 'HN', 'MX', 'NI', 'PA', 'PE', 'PR', 'PY', 'SV', 'US', 'UY', 'VE',\n ), 'et': ('EE',), 'eu': ('ES', 'FR'), 'fa': ('IR',),\n 'ff': ('SN',), 'fi': ('FI',), 'fil': ('PH',), 'fo': ('FO',),\n 'fr': ('CA', 'CH', 'FR', 'LU'), 'fur': ('IT',), 'fy': ('NL', 'DE'),\n 'ga': ('IE',), 'gd': ('GB',), 'gez': ('ER', 'ET'), 'gl': ('ES',),\n 'gu': ('IN',), 'gv': ('GB',), 'ha': ('NG',), 'hak': ('TW',),\n 'he': ('IL',), 'hi': ('IN',), 'hne': ('IN',), 'hr': ('HR',),\n 'hsb': ('DE',), 'ht': ('HT',), 'hu': ('HU',), 'hy': ('AM',),\n 'ia': ('FR',), 'id': ('ID',), 'ig': ('NG',), 'ik': ('CA',),\n 'is': ('IS',), 'it': ('CH', 'IT'), 'iu': ('CA',), 'iw': ('IL',),\n 'ja': ('JP',), 'ka': ('GE',), 'kk': ('KZ',), 'kl': ('GL',),\n 'km': ('KH',), 'kn': ('IN',), 'ko': ('KR',), 'kok': ('IN',),\n 'ks': ('IN',), 'ku': ('TR',), 'kw': ('GB',), 'ky': ('KG',),\n 'lb': ('LU',), 'lg': ('UG',), 'li': ('BE', 'NL'), 'lij': ('IT',),\n 'ln': ('CD',), 'lo': ('LA',), 'lt': ('LT',), 'lv': ('LV',),\n 'lzh': ('TW',), 'mag': ('IN',), 'mai': ('IN',), 'mg': ('MG',),\n 'mhr': ('RU',), 'mi': ('NZ',), 'mk': ('MK',), 'ml': ('IN',),\n 'mn': ('MN',), 'mni': ('IN',), 'mr': ('IN',), 'ms': ('MY',),\n 'mt': ('MT',), 'my': ('MM',), 'nan': ('TW',), 'nb': ('NO',),\n 'nds': ('DE', 'NL'), 'ne': ('NP',), 'nhn': ('MX',),\n 'niu': ('NU', 'NZ'), 'nl': ('AW', 'BE', 'NL'), 'nn': ('NO',),\n 'nr': ('ZA',), 'nso': ('ZA',), 'oc': ('FR',), 'om': ('ET', 'KE'),\n 'or': ('IN',), 'os': ('RU',), 'pa': ('IN', 'PK'),\n 'pap': ('AN', 'AW', 'CW'), 'pl': ('PL',), 'ps': ('AF',),\n 'pt': ('BR', 'PT'), 'quz': ('PE',), 'raj': ('IN',), 'ro': ('RO',),\n 'ru': ('RU', 'UA'), 'rw': ('RW',), 'sa': ('IN',), 'sat': ('IN',),\n 'sc': ('IT',), 'sd': ('IN', 'PK'), 'se': ('NO',), 'shs': ('CA',),\n 'si': ('LK',), 'sid': ('ET',), 'sk': ('SK',), 'sl': ('SI',),\n 'so': ('DJ', 'ET', 'KE', 'SO'), 'sq': ('AL', 'ML'), 'sr': ('ME', 'RS'),\n 'ss': ('ZA',), 'st': ('ZA',), 'sv': ('FI', 'SE'), 'sw': ('KE', 'TZ'),\n 'szl': ('PL',), 'ta': ('IN', 'LK'), 'tcy': ('IN',), 'te': ('IN',),\n 'tg': ('TJ',), 'th': ('TH',), 'the': ('NP',), 'ti': ('ER', 'ET'),\n 'tig': ('ER',), 'tk': ('TM',), 'tl': ('PH',), 'tn': ('ZA',),\n 'tr': ('CY', 'TR'), 'ts': ('ZA',), 'tt': ('RU',), 'ug': ('CN',),\n 'uk': ('UA',), 'unm': ('US',), 'ur': ('IN', 'PK'), 'uz': ('UZ',),\n 've': ('ZA',), 'vi': ('VN',), 'wa': ('BE',), 'wae': ('CH',),\n 'wal': ('ET',), 'wo': ('SN',), 'xh': ('ZA',), 'yi': ('US',),\n 'yo': ('NG',), 'yue': ('HK',), 'zh': ('CN', 'HK', 'SG', 'TW'),\n 'zu': ('ZA',),\n }\n\n def boolean(self, chance_of_getting_true=50):\n return self.generator.random.randint(1, 100) <= chance_of_getting_true\n\n def null_boolean(self):\n return {\n 0: None,\n 1: True,\n -1: False,\n }[self.generator.random.randint(-1, 1)]\n\n def binary(self, length=(1 * 1024 * 1024)):\n \"\"\" Returns random binary blob.\n\n Default blob size is 1 Mb.\n \"\"\"\n blob = [self.generator.random.randrange(256) for _ in range(length)]\n return bytes(blob) if sys.version_info[0] >= 3 else bytearray(blob)\n\n def md5(self, raw_output=False):\n \"\"\"\n Calculates the md5 hash of a given string\n :example 'cfcd208495d565ef66e7dff9f98764da'\n \"\"\"\n res = hashlib.md5(str(self.generator.random.random()).encode('utf-8'))\n if raw_output:\n return res.digest()\n return res.hexdigest()\n\n def sha1(self, raw_output=False):\n \"\"\"\n Calculates the sha1 hash of a given string\n :example 'b5d86317c2a144cd04d0d7c03b2b02666fafadf2'\n \"\"\"\n res = hashlib.sha1(str(self.generator.random.random()).encode('utf-8'))\n if raw_output:\n return res.digest()\n return res.hexdigest()\n\n def sha256(self, raw_output=False):\n \"\"\"\n Calculates the sha256 hash of a given string\n :example '85086017559ccc40638fcde2fecaf295e0de7ca51b7517b6aebeaaf75b4d4654'\n \"\"\"\n res = hashlib.sha256(\n str(self.generator.random.random()).encode('utf-8'))\n if raw_output:\n return res.digest()\n return res.hexdigest()\n\n def locale(self):\n language_code = self.language_code()\n return language_code + '_' + self.random_element(\n Provider.language_locale_codes[language_code],\n )\n\n def language_code(self):\n return self.random_element(Provider.language_locale_codes.keys())\n\n def uuid4(self):\n \"\"\"\n Generates a random UUID4 string.\n \"\"\"\n # Based on http://stackoverflow.com/q/41186818\n return str(uuid.UUID(int=self.generator.random.getrandbits(128)))\n\n def password(\n self,\n length=10,\n special_chars=True,\n digits=True,\n upper_case=True,\n lower_case=True):\n \"\"\"\n Generates a random password.\n @param length: Integer. Length of a password\n @param special_chars: Boolean. Whether to use special characters !@#$%^&*()_+\n @param digits: Boolean. Whether to use digits\n @param upper_case: Boolean. Whether to use upper letters\n @param lower_case: Boolean. Whether to use lower letters\n @return: String. Random password\n \"\"\"\n choices = \"\"\n required_tokens = []\n if special_chars:\n required_tokens.append(\n self.generator.random.choice(\"!@#$%^&*()_+\"))\n choices += \"!@#$%^&*()_+\"\n if digits:\n required_tokens.append(self.generator.random.choice(string.digits))\n choices += string.digits\n if upper_case:\n required_tokens.append(\n self.generator.random.choice(string.ascii_uppercase))\n choices += string.ascii_uppercase\n if lower_case:\n required_tokens.append(\n self.generator.random.choice(string.ascii_lowercase))\n choices += string.ascii_lowercase\n\n assert len(\n required_tokens) <= length, \"Required length is shorter than required characters\"\n\n # Generate a first version of the password\n chars = self.random_choices(choices, length=length)\n\n # Pick some unique locations\n random_indexes = set()\n while len(random_indexes) < len(required_tokens):\n random_indexes.add(\n self.generator.random.randint(0, len(chars) - 1))\n\n # Replace them with the required characters\n for i, index in enumerate(random_indexes):\n chars[index] = required_tokens[i]\n\n return ''.join(chars)\n", "path": "faker/providers/misc/__init__.py"}], "after_files": [{"content": "# coding=utf-8\n\nfrom __future__ import unicode_literals\nimport hashlib\nimport string\nimport uuid\nimport sys\n\nfrom .. import BaseProvider\n\n\nclass Provider(BaseProvider):\n # Locales supported by Linux Mint from `/usr/share/i18n/SUPPORTED`\n language_locale_codes = {\n 'aa': ('DJ', 'ER', 'ET'), 'af': ('ZA',), 'ak': ('GH',), 'am': ('ET',),\n 'an': ('ES',), 'apn': ('IN',),\n 'ar': ('AE', 'BH', 'DJ', 'DZ', 'EG', 'EH', 'ER', 'IL', 'IN',\n 'IQ', 'JO', 'KM', 'KW', 'LB', 'LY', 'MA', 'MR', 'OM',\n 'PS', 'QA', 'SA', 'SD', 'SO', 'SS', 'SY', 'TD', 'TN',\n 'YE'),\n 'as': ('IN',), 'ast': ('ES',), 'ayc': ('PE',), 'az': ('AZ', 'IN'),\n 'be': ('BY',), 'bem': ('ZM',), 'ber': ('DZ', 'MA'), 'bg': ('BG',),\n 'bhb': ('IN',), 'bho': ('IN',), 'bn': ('BD', 'IN'), 'bo': ('CN', 'IN'),\n 'br': ('FR',), 'brx': ('IN',), 'bs': ('BA',), 'byn': ('ER',),\n 'ca': ('AD', 'ES', 'FR', 'IT'), 'ce': ('RU',), 'ckb': ('IQ',),\n 'cmn': ('TW',), 'crh': ('UA',), 'cs': ('CZ',), 'csb': ('PL',),\n 'cv': ('RU',), 'cy': ('GB',), 'da': ('DK',),\n 'de': ('AT', 'BE', 'CH', 'DE', 'LI', 'LU'), 'doi': ('IN',),\n 'dv': ('MV',), 'dz': ('BT',), 'el': ('GR', 'CY'),\n 'en': ('AG', 'AU', 'BW', 'CA', 'DK', 'GB', 'HK', 'IE', 'IN', 'NG',\n 'NZ', 'PH', 'SG', 'US', 'ZA', 'ZM', 'ZW'),\n 'eo': ('US',),\n 'es': ('AR', 'BO', 'CL', 'CO', 'CR', 'CU', 'DO', 'EC', 'ES', 'GT',\n 'HN', 'MX', 'NI', 'PA', 'PE', 'PR', 'PY', 'SV', 'US', 'UY', 'VE',\n ), 'et': ('EE',), 'eu': ('ES', 'FR'), 'fa': ('IR',),\n 'ff': ('SN',), 'fi': ('FI',), 'fil': ('PH',), 'fo': ('FO',),\n 'fr': ('CA', 'CH', 'FR', 'LU'), 'fur': ('IT',), 'fy': ('NL', 'DE'),\n 'ga': ('IE',), 'gd': ('GB',), 'gez': ('ER', 'ET'), 'gl': ('ES',),\n 'gu': ('IN',), 'gv': ('GB',), 'ha': ('NG',), 'hak': ('TW',),\n 'he': ('IL',), 'hi': ('IN',), 'hne': ('IN',), 'hr': ('HR',),\n 'hsb': ('DE',), 'ht': ('HT',), 'hu': ('HU',), 'hy': ('AM',),\n 'ia': ('FR',), 'id': ('ID',), 'ig': ('NG',), 'ik': ('CA',),\n 'is': ('IS',), 'it': ('CH', 'IT'), 'iu': ('CA',), 'iw': ('IL',),\n 'ja': ('JP',), 'ka': ('GE',), 'kk': ('KZ',), 'kl': ('GL',),\n 'km': ('KH',), 'kn': ('IN',), 'ko': ('KR',), 'kok': ('IN',),\n 'ks': ('IN',), 'ku': ('TR',), 'kw': ('GB',), 'ky': ('KG',),\n 'lb': ('LU',), 'lg': ('UG',), 'li': ('BE', 'NL'), 'lij': ('IT',),\n 'ln': ('CD',), 'lo': ('LA',), 'lt': ('LT',), 'lv': ('LV',),\n 'lzh': ('TW',), 'mag': ('IN',), 'mai': ('IN',), 'mg': ('MG',),\n 'mhr': ('RU',), 'mi': ('NZ',), 'mk': ('MK',), 'ml': ('IN',),\n 'mn': ('MN',), 'mni': ('IN',), 'mr': ('IN',), 'ms': ('MY',),\n 'mt': ('MT',), 'my': ('MM',), 'nan': ('TW',), 'nb': ('NO',),\n 'nds': ('DE', 'NL'), 'ne': ('NP',), 'nhn': ('MX',),\n 'niu': ('NU', 'NZ'), 'nl': ('AW', 'BE', 'NL'), 'nn': ('NO',),\n 'nr': ('ZA',), 'nso': ('ZA',), 'oc': ('FR',), 'om': ('ET', 'KE'),\n 'or': ('IN',), 'os': ('RU',), 'pa': ('IN', 'PK'),\n 'pap': ('AN', 'AW', 'CW'), 'pl': ('PL',), 'ps': ('AF',),\n 'pt': ('BR', 'PT'), 'quz': ('PE',), 'raj': ('IN',), 'ro': ('RO',),\n 'ru': ('RU', 'UA'), 'rw': ('RW',), 'sa': ('IN',), 'sat': ('IN',),\n 'sc': ('IT',), 'sd': ('IN', 'PK'), 'se': ('NO',), 'shs': ('CA',),\n 'si': ('LK',), 'sid': ('ET',), 'sk': ('SK',), 'sl': ('SI',),\n 'so': ('DJ', 'ET', 'KE', 'SO'), 'sq': ('AL', 'ML'), 'sr': ('ME', 'RS'),\n 'ss': ('ZA',), 'st': ('ZA',), 'sv': ('FI', 'SE'), 'sw': ('KE', 'TZ'),\n 'szl': ('PL',), 'ta': ('IN', 'LK'), 'tcy': ('IN',), 'te': ('IN',),\n 'tg': ('TJ',), 'th': ('TH',), 'the': ('NP',), 'ti': ('ER', 'ET'),\n 'tig': ('ER',), 'tk': ('TM',), 'tl': ('PH',), 'tn': ('ZA',),\n 'tr': ('CY', 'TR'), 'ts': ('ZA',), 'tt': ('RU',), 'ug': ('CN',),\n 'uk': ('UA',), 'unm': ('US',), 'ur': ('IN', 'PK'), 'uz': ('UZ',),\n 've': ('ZA',), 'vi': ('VN',), 'wa': ('BE',), 'wae': ('CH',),\n 'wal': ('ET',), 'wo': ('SN',), 'xh': ('ZA',), 'yi': ('US',),\n 'yo': ('NG',), 'yue': ('HK',), 'zh': ('CN', 'HK', 'SG', 'TW'),\n 'zu': ('ZA',),\n }\n\n def boolean(self, chance_of_getting_true=50):\n return self.generator.random.randint(1, 100) <= chance_of_getting_true\n\n def null_boolean(self):\n return {\n 0: None,\n 1: True,\n -1: False,\n }[self.generator.random.randint(-1, 1)]\n\n def binary(self, length=(1 * 1024 * 1024)):\n \"\"\" Returns random binary blob.\n\n Default blob size is 1 Mb.\n \"\"\"\n blob = [self.generator.random.randrange(256) for _ in range(length)]\n return bytes(blob) if sys.version_info[0] >= 3 else bytearray(blob)\n\n def md5(self, raw_output=False):\n \"\"\"\n Calculates the md5 hash of a given string\n :example 'cfcd208495d565ef66e7dff9f98764da'\n \"\"\"\n res = hashlib.md5(str(self.generator.random.random()).encode('utf-8'))\n if raw_output:\n return res.digest()\n return res.hexdigest()\n\n def sha1(self, raw_output=False):\n \"\"\"\n Calculates the sha1 hash of a given string\n :example 'b5d86317c2a144cd04d0d7c03b2b02666fafadf2'\n \"\"\"\n res = hashlib.sha1(str(self.generator.random.random()).encode('utf-8'))\n if raw_output:\n return res.digest()\n return res.hexdigest()\n\n def sha256(self, raw_output=False):\n \"\"\"\n Calculates the sha256 hash of a given string\n :example '85086017559ccc40638fcde2fecaf295e0de7ca51b7517b6aebeaaf75b4d4654'\n \"\"\"\n res = hashlib.sha256(\n str(self.generator.random.random()).encode('utf-8'))\n if raw_output:\n return res.digest()\n return res.hexdigest()\n\n def locale(self):\n language_code = self.language_code()\n return language_code + '_' + self.random_element(\n Provider.language_locale_codes[language_code],\n )\n\n def language_code(self):\n return self.random_element(Provider.language_locale_codes.keys())\n\n def uuid4(self, cast_to=str):\n \"\"\"\n Generates a random UUID4 string.\n :param cast_to: Specify what type the UUID should be cast to. Default is `str`\n :type cast_to: callable\n \"\"\"\n # Based on http://stackoverflow.com/q/41186818\n return cast_to(uuid.UUID(int=self.generator.random.getrandbits(128), version=4))\n\n def password(\n self,\n length=10,\n special_chars=True,\n digits=True,\n upper_case=True,\n lower_case=True):\n \"\"\"\n Generates a random password.\n @param length: Integer. Length of a password\n @param special_chars: Boolean. Whether to use special characters !@#$%^&*()_+\n @param digits: Boolean. Whether to use digits\n @param upper_case: Boolean. Whether to use upper letters\n @param lower_case: Boolean. Whether to use lower letters\n @return: String. Random password\n \"\"\"\n choices = \"\"\n required_tokens = []\n if special_chars:\n required_tokens.append(\n self.generator.random.choice(\"!@#$%^&*()_+\"))\n choices += \"!@#$%^&*()_+\"\n if digits:\n required_tokens.append(self.generator.random.choice(string.digits))\n choices += string.digits\n if upper_case:\n required_tokens.append(\n self.generator.random.choice(string.ascii_uppercase))\n choices += string.ascii_uppercase\n if lower_case:\n required_tokens.append(\n self.generator.random.choice(string.ascii_lowercase))\n choices += string.ascii_lowercase\n\n assert len(\n required_tokens) <= length, \"Required length is shorter than required characters\"\n\n # Generate a first version of the password\n chars = self.random_choices(choices, length=length)\n\n # Pick some unique locations\n random_indexes = set()\n while len(random_indexes) < len(required_tokens):\n random_indexes.add(\n self.generator.random.randint(0, len(chars) - 1))\n\n # Replace them with the required characters\n for i, index in enumerate(random_indexes):\n chars[index] = required_tokens[i]\n\n return ''.join(chars)\n", "path": "faker/providers/misc/__init__.py"}]}
| 3,722 | 208 |
gh_patches_debug_17560
|
rasdani/github-patches
|
git_diff
|
getsentry__sentry-python-2260
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Arq integration ignores functions and cron jobs passed as keyword arguments
### How do you use Sentry?
Sentry Saas (sentry.io)
### Version
1.29.2
### Steps to Reproduce
`arq` allows you to pass the functions as a keyword argument, not just defining on the `WorkerSettings` class.
```python
async def my_coroutine(state):
pass
arq.run_worker(object(), functions=[my_coroutine])
```
### Expected Result
Unhandled errors in `my_coroutine` should be sent to sentry
### Actual Result
Errors are not sent to Sentry
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `sentry_sdk/integrations/arq.py`
Content:
```
1 from __future__ import absolute_import
2
3 import sys
4
5 from sentry_sdk._compat import reraise
6 from sentry_sdk._types import TYPE_CHECKING
7 from sentry_sdk import Hub
8 from sentry_sdk.consts import OP
9 from sentry_sdk.hub import _should_send_default_pii
10 from sentry_sdk.integrations import DidNotEnable, Integration
11 from sentry_sdk.integrations.logging import ignore_logger
12 from sentry_sdk.tracing import Transaction, TRANSACTION_SOURCE_TASK
13 from sentry_sdk.utils import (
14 capture_internal_exceptions,
15 event_from_exception,
16 SENSITIVE_DATA_SUBSTITUTE,
17 parse_version,
18 )
19
20 try:
21 import arq.worker
22 from arq.version import VERSION as ARQ_VERSION
23 from arq.connections import ArqRedis
24 from arq.worker import JobExecutionFailed, Retry, RetryJob, Worker
25 except ImportError:
26 raise DidNotEnable("Arq is not installed")
27
28 if TYPE_CHECKING:
29 from typing import Any, Dict, Optional, Union
30
31 from sentry_sdk._types import EventProcessor, Event, ExcInfo, Hint
32
33 from arq.cron import CronJob
34 from arq.jobs import Job
35 from arq.typing import WorkerCoroutine
36 from arq.worker import Function
37
38 ARQ_CONTROL_FLOW_EXCEPTIONS = (JobExecutionFailed, Retry, RetryJob)
39
40
41 class ArqIntegration(Integration):
42 identifier = "arq"
43
44 @staticmethod
45 def setup_once():
46 # type: () -> None
47
48 try:
49 if isinstance(ARQ_VERSION, str):
50 version = parse_version(ARQ_VERSION)
51 else:
52 version = ARQ_VERSION.version[:2]
53
54 except (TypeError, ValueError):
55 version = None
56
57 if version is None:
58 raise DidNotEnable("Unparsable arq version: {}".format(ARQ_VERSION))
59
60 if version < (0, 23):
61 raise DidNotEnable("arq 0.23 or newer required.")
62
63 patch_enqueue_job()
64 patch_run_job()
65 patch_create_worker()
66
67 ignore_logger("arq.worker")
68
69
70 def patch_enqueue_job():
71 # type: () -> None
72 old_enqueue_job = ArqRedis.enqueue_job
73
74 async def _sentry_enqueue_job(self, function, *args, **kwargs):
75 # type: (ArqRedis, str, *Any, **Any) -> Optional[Job]
76 hub = Hub.current
77
78 if hub.get_integration(ArqIntegration) is None:
79 return await old_enqueue_job(self, function, *args, **kwargs)
80
81 with hub.start_span(op=OP.QUEUE_SUBMIT_ARQ, description=function):
82 return await old_enqueue_job(self, function, *args, **kwargs)
83
84 ArqRedis.enqueue_job = _sentry_enqueue_job
85
86
87 def patch_run_job():
88 # type: () -> None
89 old_run_job = Worker.run_job
90
91 async def _sentry_run_job(self, job_id, score):
92 # type: (Worker, str, int) -> None
93 hub = Hub(Hub.current)
94
95 if hub.get_integration(ArqIntegration) is None:
96 return await old_run_job(self, job_id, score)
97
98 with hub.push_scope() as scope:
99 scope._name = "arq"
100 scope.clear_breadcrumbs()
101
102 transaction = Transaction(
103 name="unknown arq task",
104 status="ok",
105 op=OP.QUEUE_TASK_ARQ,
106 source=TRANSACTION_SOURCE_TASK,
107 )
108
109 with hub.start_transaction(transaction):
110 return await old_run_job(self, job_id, score)
111
112 Worker.run_job = _sentry_run_job
113
114
115 def _capture_exception(exc_info):
116 # type: (ExcInfo) -> None
117 hub = Hub.current
118
119 if hub.scope.transaction is not None:
120 if exc_info[0] in ARQ_CONTROL_FLOW_EXCEPTIONS:
121 hub.scope.transaction.set_status("aborted")
122 return
123
124 hub.scope.transaction.set_status("internal_error")
125
126 event, hint = event_from_exception(
127 exc_info,
128 client_options=hub.client.options if hub.client else None,
129 mechanism={"type": ArqIntegration.identifier, "handled": False},
130 )
131 hub.capture_event(event, hint=hint)
132
133
134 def _make_event_processor(ctx, *args, **kwargs):
135 # type: (Dict[Any, Any], *Any, **Any) -> EventProcessor
136 def event_processor(event, hint):
137 # type: (Event, Hint) -> Optional[Event]
138
139 hub = Hub.current
140
141 with capture_internal_exceptions():
142 if hub.scope.transaction is not None:
143 hub.scope.transaction.name = ctx["job_name"]
144 event["transaction"] = ctx["job_name"]
145
146 tags = event.setdefault("tags", {})
147 tags["arq_task_id"] = ctx["job_id"]
148 tags["arq_task_retry"] = ctx["job_try"] > 1
149 extra = event.setdefault("extra", {})
150 extra["arq-job"] = {
151 "task": ctx["job_name"],
152 "args": args
153 if _should_send_default_pii()
154 else SENSITIVE_DATA_SUBSTITUTE,
155 "kwargs": kwargs
156 if _should_send_default_pii()
157 else SENSITIVE_DATA_SUBSTITUTE,
158 "retry": ctx["job_try"],
159 }
160
161 return event
162
163 return event_processor
164
165
166 def _wrap_coroutine(name, coroutine):
167 # type: (str, WorkerCoroutine) -> WorkerCoroutine
168 async def _sentry_coroutine(ctx, *args, **kwargs):
169 # type: (Dict[Any, Any], *Any, **Any) -> Any
170 hub = Hub.current
171 if hub.get_integration(ArqIntegration) is None:
172 return await coroutine(*args, **kwargs)
173
174 hub.scope.add_event_processor(
175 _make_event_processor({**ctx, "job_name": name}, *args, **kwargs)
176 )
177
178 try:
179 result = await coroutine(ctx, *args, **kwargs)
180 except Exception:
181 exc_info = sys.exc_info()
182 _capture_exception(exc_info)
183 reraise(*exc_info)
184
185 return result
186
187 return _sentry_coroutine
188
189
190 def patch_create_worker():
191 # type: () -> None
192 old_create_worker = arq.worker.create_worker
193
194 def _sentry_create_worker(*args, **kwargs):
195 # type: (*Any, **Any) -> Worker
196 hub = Hub.current
197
198 if hub.get_integration(ArqIntegration) is None:
199 return old_create_worker(*args, **kwargs)
200
201 settings_cls = args[0]
202
203 functions = settings_cls.functions
204 cron_jobs = settings_cls.cron_jobs
205
206 settings_cls.functions = [_get_arq_function(func) for func in functions]
207 settings_cls.cron_jobs = [_get_arq_cron_job(cron_job) for cron_job in cron_jobs]
208
209 return old_create_worker(*args, **kwargs)
210
211 arq.worker.create_worker = _sentry_create_worker
212
213
214 def _get_arq_function(func):
215 # type: (Union[str, Function, WorkerCoroutine]) -> Function
216 arq_func = arq.worker.func(func)
217 arq_func.coroutine = _wrap_coroutine(arq_func.name, arq_func.coroutine)
218
219 return arq_func
220
221
222 def _get_arq_cron_job(cron_job):
223 # type: (CronJob) -> CronJob
224 cron_job.coroutine = _wrap_coroutine(cron_job.name, cron_job.coroutine)
225
226 return cron_job
227
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/sentry_sdk/integrations/arq.py b/sentry_sdk/integrations/arq.py
--- a/sentry_sdk/integrations/arq.py
+++ b/sentry_sdk/integrations/arq.py
@@ -200,11 +200,23 @@
settings_cls = args[0]
- functions = settings_cls.functions
- cron_jobs = settings_cls.cron_jobs
-
- settings_cls.functions = [_get_arq_function(func) for func in functions]
- settings_cls.cron_jobs = [_get_arq_cron_job(cron_job) for cron_job in cron_jobs]
+ if hasattr(settings_cls, "functions"):
+ settings_cls.functions = [
+ _get_arq_function(func) for func in settings_cls.functions
+ ]
+ if hasattr(settings_cls, "cron_jobs"):
+ settings_cls.cron_jobs = [
+ _get_arq_cron_job(cron_job) for cron_job in settings_cls.cron_jobs
+ ]
+
+ if "functions" in kwargs:
+ kwargs["functions"] = [
+ _get_arq_function(func) for func in kwargs["functions"]
+ ]
+ if "cron_jobs" in kwargs:
+ kwargs["cron_jobs"] = [
+ _get_arq_cron_job(cron_job) for cron_job in kwargs["cron_jobs"]
+ ]
return old_create_worker(*args, **kwargs)
|
{"golden_diff": "diff --git a/sentry_sdk/integrations/arq.py b/sentry_sdk/integrations/arq.py\n--- a/sentry_sdk/integrations/arq.py\n+++ b/sentry_sdk/integrations/arq.py\n@@ -200,11 +200,23 @@\n \n settings_cls = args[0]\n \n- functions = settings_cls.functions\n- cron_jobs = settings_cls.cron_jobs\n-\n- settings_cls.functions = [_get_arq_function(func) for func in functions]\n- settings_cls.cron_jobs = [_get_arq_cron_job(cron_job) for cron_job in cron_jobs]\n+ if hasattr(settings_cls, \"functions\"):\n+ settings_cls.functions = [\n+ _get_arq_function(func) for func in settings_cls.functions\n+ ]\n+ if hasattr(settings_cls, \"cron_jobs\"):\n+ settings_cls.cron_jobs = [\n+ _get_arq_cron_job(cron_job) for cron_job in settings_cls.cron_jobs\n+ ]\n+\n+ if \"functions\" in kwargs:\n+ kwargs[\"functions\"] = [\n+ _get_arq_function(func) for func in kwargs[\"functions\"]\n+ ]\n+ if \"cron_jobs\" in kwargs:\n+ kwargs[\"cron_jobs\"] = [\n+ _get_arq_cron_job(cron_job) for cron_job in kwargs[\"cron_jobs\"]\n+ ]\n \n return old_create_worker(*args, **kwargs)\n", "issue": "Arq integration ignores functions and cron jobs passed as keyword arguments\n### How do you use Sentry?\n\nSentry Saas (sentry.io)\n\n### Version\n\n1.29.2\n\n### Steps to Reproduce\n\n`arq` allows you to pass the functions as a keyword argument, not just defining on the `WorkerSettings` class.\r\n\r\n```python\r\nasync def my_coroutine(state):\r\n pass\r\n\r\narq.run_worker(object(), functions=[my_coroutine])\r\n```\n\n### Expected Result\n\nUnhandled errors in `my_coroutine` should be sent to sentry\n\n### Actual Result\n\nErrors are not sent to Sentry\n", "before_files": [{"content": "from __future__ import absolute_import\n\nimport sys\n\nfrom sentry_sdk._compat import reraise\nfrom sentry_sdk._types import TYPE_CHECKING\nfrom sentry_sdk import Hub\nfrom sentry_sdk.consts import OP\nfrom sentry_sdk.hub import _should_send_default_pii\nfrom sentry_sdk.integrations import DidNotEnable, Integration\nfrom sentry_sdk.integrations.logging import ignore_logger\nfrom sentry_sdk.tracing import Transaction, TRANSACTION_SOURCE_TASK\nfrom sentry_sdk.utils import (\n capture_internal_exceptions,\n event_from_exception,\n SENSITIVE_DATA_SUBSTITUTE,\n parse_version,\n)\n\ntry:\n import arq.worker\n from arq.version import VERSION as ARQ_VERSION\n from arq.connections import ArqRedis\n from arq.worker import JobExecutionFailed, Retry, RetryJob, Worker\nexcept ImportError:\n raise DidNotEnable(\"Arq is not installed\")\n\nif TYPE_CHECKING:\n from typing import Any, Dict, Optional, Union\n\n from sentry_sdk._types import EventProcessor, Event, ExcInfo, Hint\n\n from arq.cron import CronJob\n from arq.jobs import Job\n from arq.typing import WorkerCoroutine\n from arq.worker import Function\n\nARQ_CONTROL_FLOW_EXCEPTIONS = (JobExecutionFailed, Retry, RetryJob)\n\n\nclass ArqIntegration(Integration):\n identifier = \"arq\"\n\n @staticmethod\n def setup_once():\n # type: () -> None\n\n try:\n if isinstance(ARQ_VERSION, str):\n version = parse_version(ARQ_VERSION)\n else:\n version = ARQ_VERSION.version[:2]\n\n except (TypeError, ValueError):\n version = None\n\n if version is None:\n raise DidNotEnable(\"Unparsable arq version: {}\".format(ARQ_VERSION))\n\n if version < (0, 23):\n raise DidNotEnable(\"arq 0.23 or newer required.\")\n\n patch_enqueue_job()\n patch_run_job()\n patch_create_worker()\n\n ignore_logger(\"arq.worker\")\n\n\ndef patch_enqueue_job():\n # type: () -> None\n old_enqueue_job = ArqRedis.enqueue_job\n\n async def _sentry_enqueue_job(self, function, *args, **kwargs):\n # type: (ArqRedis, str, *Any, **Any) -> Optional[Job]\n hub = Hub.current\n\n if hub.get_integration(ArqIntegration) is None:\n return await old_enqueue_job(self, function, *args, **kwargs)\n\n with hub.start_span(op=OP.QUEUE_SUBMIT_ARQ, description=function):\n return await old_enqueue_job(self, function, *args, **kwargs)\n\n ArqRedis.enqueue_job = _sentry_enqueue_job\n\n\ndef patch_run_job():\n # type: () -> None\n old_run_job = Worker.run_job\n\n async def _sentry_run_job(self, job_id, score):\n # type: (Worker, str, int) -> None\n hub = Hub(Hub.current)\n\n if hub.get_integration(ArqIntegration) is None:\n return await old_run_job(self, job_id, score)\n\n with hub.push_scope() as scope:\n scope._name = \"arq\"\n scope.clear_breadcrumbs()\n\n transaction = Transaction(\n name=\"unknown arq task\",\n status=\"ok\",\n op=OP.QUEUE_TASK_ARQ,\n source=TRANSACTION_SOURCE_TASK,\n )\n\n with hub.start_transaction(transaction):\n return await old_run_job(self, job_id, score)\n\n Worker.run_job = _sentry_run_job\n\n\ndef _capture_exception(exc_info):\n # type: (ExcInfo) -> None\n hub = Hub.current\n\n if hub.scope.transaction is not None:\n if exc_info[0] in ARQ_CONTROL_FLOW_EXCEPTIONS:\n hub.scope.transaction.set_status(\"aborted\")\n return\n\n hub.scope.transaction.set_status(\"internal_error\")\n\n event, hint = event_from_exception(\n exc_info,\n client_options=hub.client.options if hub.client else None,\n mechanism={\"type\": ArqIntegration.identifier, \"handled\": False},\n )\n hub.capture_event(event, hint=hint)\n\n\ndef _make_event_processor(ctx, *args, **kwargs):\n # type: (Dict[Any, Any], *Any, **Any) -> EventProcessor\n def event_processor(event, hint):\n # type: (Event, Hint) -> Optional[Event]\n\n hub = Hub.current\n\n with capture_internal_exceptions():\n if hub.scope.transaction is not None:\n hub.scope.transaction.name = ctx[\"job_name\"]\n event[\"transaction\"] = ctx[\"job_name\"]\n\n tags = event.setdefault(\"tags\", {})\n tags[\"arq_task_id\"] = ctx[\"job_id\"]\n tags[\"arq_task_retry\"] = ctx[\"job_try\"] > 1\n extra = event.setdefault(\"extra\", {})\n extra[\"arq-job\"] = {\n \"task\": ctx[\"job_name\"],\n \"args\": args\n if _should_send_default_pii()\n else SENSITIVE_DATA_SUBSTITUTE,\n \"kwargs\": kwargs\n if _should_send_default_pii()\n else SENSITIVE_DATA_SUBSTITUTE,\n \"retry\": ctx[\"job_try\"],\n }\n\n return event\n\n return event_processor\n\n\ndef _wrap_coroutine(name, coroutine):\n # type: (str, WorkerCoroutine) -> WorkerCoroutine\n async def _sentry_coroutine(ctx, *args, **kwargs):\n # type: (Dict[Any, Any], *Any, **Any) -> Any\n hub = Hub.current\n if hub.get_integration(ArqIntegration) is None:\n return await coroutine(*args, **kwargs)\n\n hub.scope.add_event_processor(\n _make_event_processor({**ctx, \"job_name\": name}, *args, **kwargs)\n )\n\n try:\n result = await coroutine(ctx, *args, **kwargs)\n except Exception:\n exc_info = sys.exc_info()\n _capture_exception(exc_info)\n reraise(*exc_info)\n\n return result\n\n return _sentry_coroutine\n\n\ndef patch_create_worker():\n # type: () -> None\n old_create_worker = arq.worker.create_worker\n\n def _sentry_create_worker(*args, **kwargs):\n # type: (*Any, **Any) -> Worker\n hub = Hub.current\n\n if hub.get_integration(ArqIntegration) is None:\n return old_create_worker(*args, **kwargs)\n\n settings_cls = args[0]\n\n functions = settings_cls.functions\n cron_jobs = settings_cls.cron_jobs\n\n settings_cls.functions = [_get_arq_function(func) for func in functions]\n settings_cls.cron_jobs = [_get_arq_cron_job(cron_job) for cron_job in cron_jobs]\n\n return old_create_worker(*args, **kwargs)\n\n arq.worker.create_worker = _sentry_create_worker\n\n\ndef _get_arq_function(func):\n # type: (Union[str, Function, WorkerCoroutine]) -> Function\n arq_func = arq.worker.func(func)\n arq_func.coroutine = _wrap_coroutine(arq_func.name, arq_func.coroutine)\n\n return arq_func\n\n\ndef _get_arq_cron_job(cron_job):\n # type: (CronJob) -> CronJob\n cron_job.coroutine = _wrap_coroutine(cron_job.name, cron_job.coroutine)\n\n return cron_job\n", "path": "sentry_sdk/integrations/arq.py"}], "after_files": [{"content": "from __future__ import absolute_import\n\nimport sys\n\nfrom sentry_sdk._compat import reraise\nfrom sentry_sdk._types import TYPE_CHECKING\nfrom sentry_sdk import Hub\nfrom sentry_sdk.consts import OP\nfrom sentry_sdk.hub import _should_send_default_pii\nfrom sentry_sdk.integrations import DidNotEnable, Integration\nfrom sentry_sdk.integrations.logging import ignore_logger\nfrom sentry_sdk.tracing import Transaction, TRANSACTION_SOURCE_TASK\nfrom sentry_sdk.utils import (\n capture_internal_exceptions,\n event_from_exception,\n SENSITIVE_DATA_SUBSTITUTE,\n parse_version,\n)\n\ntry:\n import arq.worker\n from arq.version import VERSION as ARQ_VERSION\n from arq.connections import ArqRedis\n from arq.worker import JobExecutionFailed, Retry, RetryJob, Worker\nexcept ImportError:\n raise DidNotEnable(\"Arq is not installed\")\n\nif TYPE_CHECKING:\n from typing import Any, Dict, Optional, Union\n\n from sentry_sdk._types import EventProcessor, Event, ExcInfo, Hint\n\n from arq.cron import CronJob\n from arq.jobs import Job\n from arq.typing import WorkerCoroutine\n from arq.worker import Function\n\nARQ_CONTROL_FLOW_EXCEPTIONS = (JobExecutionFailed, Retry, RetryJob)\n\n\nclass ArqIntegration(Integration):\n identifier = \"arq\"\n\n @staticmethod\n def setup_once():\n # type: () -> None\n\n try:\n if isinstance(ARQ_VERSION, str):\n version = parse_version(ARQ_VERSION)\n else:\n version = ARQ_VERSION.version[:2]\n\n except (TypeError, ValueError):\n version = None\n\n if version is None:\n raise DidNotEnable(\"Unparsable arq version: {}\".format(ARQ_VERSION))\n\n if version < (0, 23):\n raise DidNotEnable(\"arq 0.23 or newer required.\")\n\n patch_enqueue_job()\n patch_run_job()\n patch_create_worker()\n\n ignore_logger(\"arq.worker\")\n\n\ndef patch_enqueue_job():\n # type: () -> None\n old_enqueue_job = ArqRedis.enqueue_job\n\n async def _sentry_enqueue_job(self, function, *args, **kwargs):\n # type: (ArqRedis, str, *Any, **Any) -> Optional[Job]\n hub = Hub.current\n\n if hub.get_integration(ArqIntegration) is None:\n return await old_enqueue_job(self, function, *args, **kwargs)\n\n with hub.start_span(op=OP.QUEUE_SUBMIT_ARQ, description=function):\n return await old_enqueue_job(self, function, *args, **kwargs)\n\n ArqRedis.enqueue_job = _sentry_enqueue_job\n\n\ndef patch_run_job():\n # type: () -> None\n old_run_job = Worker.run_job\n\n async def _sentry_run_job(self, job_id, score):\n # type: (Worker, str, int) -> None\n hub = Hub(Hub.current)\n\n if hub.get_integration(ArqIntegration) is None:\n return await old_run_job(self, job_id, score)\n\n with hub.push_scope() as scope:\n scope._name = \"arq\"\n scope.clear_breadcrumbs()\n\n transaction = Transaction(\n name=\"unknown arq task\",\n status=\"ok\",\n op=OP.QUEUE_TASK_ARQ,\n source=TRANSACTION_SOURCE_TASK,\n )\n\n with hub.start_transaction(transaction):\n return await old_run_job(self, job_id, score)\n\n Worker.run_job = _sentry_run_job\n\n\ndef _capture_exception(exc_info):\n # type: (ExcInfo) -> None\n hub = Hub.current\n\n if hub.scope.transaction is not None:\n if exc_info[0] in ARQ_CONTROL_FLOW_EXCEPTIONS:\n hub.scope.transaction.set_status(\"aborted\")\n return\n\n hub.scope.transaction.set_status(\"internal_error\")\n\n event, hint = event_from_exception(\n exc_info,\n client_options=hub.client.options if hub.client else None,\n mechanism={\"type\": ArqIntegration.identifier, \"handled\": False},\n )\n hub.capture_event(event, hint=hint)\n\n\ndef _make_event_processor(ctx, *args, **kwargs):\n # type: (Dict[Any, Any], *Any, **Any) -> EventProcessor\n def event_processor(event, hint):\n # type: (Event, Hint) -> Optional[Event]\n\n hub = Hub.current\n\n with capture_internal_exceptions():\n if hub.scope.transaction is not None:\n hub.scope.transaction.name = ctx[\"job_name\"]\n event[\"transaction\"] = ctx[\"job_name\"]\n\n tags = event.setdefault(\"tags\", {})\n tags[\"arq_task_id\"] = ctx[\"job_id\"]\n tags[\"arq_task_retry\"] = ctx[\"job_try\"] > 1\n extra = event.setdefault(\"extra\", {})\n extra[\"arq-job\"] = {\n \"task\": ctx[\"job_name\"],\n \"args\": args\n if _should_send_default_pii()\n else SENSITIVE_DATA_SUBSTITUTE,\n \"kwargs\": kwargs\n if _should_send_default_pii()\n else SENSITIVE_DATA_SUBSTITUTE,\n \"retry\": ctx[\"job_try\"],\n }\n\n return event\n\n return event_processor\n\n\ndef _wrap_coroutine(name, coroutine):\n # type: (str, WorkerCoroutine) -> WorkerCoroutine\n async def _sentry_coroutine(ctx, *args, **kwargs):\n # type: (Dict[Any, Any], *Any, **Any) -> Any\n hub = Hub.current\n if hub.get_integration(ArqIntegration) is None:\n return await coroutine(*args, **kwargs)\n\n hub.scope.add_event_processor(\n _make_event_processor({**ctx, \"job_name\": name}, *args, **kwargs)\n )\n\n try:\n result = await coroutine(ctx, *args, **kwargs)\n except Exception:\n exc_info = sys.exc_info()\n _capture_exception(exc_info)\n reraise(*exc_info)\n\n return result\n\n return _sentry_coroutine\n\n\ndef patch_create_worker():\n # type: () -> None\n old_create_worker = arq.worker.create_worker\n\n def _sentry_create_worker(*args, **kwargs):\n # type: (*Any, **Any) -> Worker\n hub = Hub.current\n\n if hub.get_integration(ArqIntegration) is None:\n return old_create_worker(*args, **kwargs)\n\n settings_cls = args[0]\n\n if hasattr(settings_cls, \"functions\"):\n settings_cls.functions = [\n _get_arq_function(func) for func in settings_cls.functions\n ]\n if hasattr(settings_cls, \"cron_jobs\"):\n settings_cls.cron_jobs = [\n _get_arq_cron_job(cron_job) for cron_job in settings_cls.cron_jobs\n ]\n\n if \"functions\" in kwargs:\n kwargs[\"functions\"] = [\n _get_arq_function(func) for func in kwargs[\"functions\"]\n ]\n if \"cron_jobs\" in kwargs:\n kwargs[\"cron_jobs\"] = [\n _get_arq_cron_job(cron_job) for cron_job in kwargs[\"cron_jobs\"]\n ]\n\n return old_create_worker(*args, **kwargs)\n\n arq.worker.create_worker = _sentry_create_worker\n\n\ndef _get_arq_function(func):\n # type: (Union[str, Function, WorkerCoroutine]) -> Function\n arq_func = arq.worker.func(func)\n arq_func.coroutine = _wrap_coroutine(arq_func.name, arq_func.coroutine)\n\n return arq_func\n\n\ndef _get_arq_cron_job(cron_job):\n # type: (CronJob) -> CronJob\n cron_job.coroutine = _wrap_coroutine(cron_job.name, cron_job.coroutine)\n\n return cron_job\n", "path": "sentry_sdk/integrations/arq.py"}]}
| 2,599 | 313 |
gh_patches_debug_3813
|
rasdani/github-patches
|
git_diff
|
MongoEngine__mongoengine-1875
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
raise StopIteration in generators is deprecated
```
...
/Users/Vic/projects/brain2/brain/utils/user_progress.py:686: DeprecationWarning: generator 'QuerySet._iter_results' raised StopIteration
for action in actions:
/Users/Vic/projects/brain2/brain/utils/user_course_state.py:317: DeprecationWarning: generator 'QuerySet._iter_results' raised StopIteration
PlayedTask(
/Users/Vic/projects/brain2/venv/lib/python3.6/site-packages/mongoengine/dereference.py:33: DeprecationWarning: generator 'QuerySet._iter_results' raised StopIteration
...
```
https://stackoverflow.com/questions/14183803/in-pythons-generators-what-is-the-difference-between-raise-stopiteration-and
https://github.com/MongoEngine/mongoengine/blob/5bdd35464b89dd2def1dcb0464e244322f1bc757/mongoengine/queryset/queryset.py#L95
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `mongoengine/queryset/queryset.py`
Content:
```
1 import six
2
3 from mongoengine.errors import OperationError
4 from mongoengine.queryset.base import (BaseQuerySet, CASCADE, DENY, DO_NOTHING,
5 NULLIFY, PULL)
6
7 __all__ = ('QuerySet', 'QuerySetNoCache', 'DO_NOTHING', 'NULLIFY', 'CASCADE',
8 'DENY', 'PULL')
9
10 # The maximum number of items to display in a QuerySet.__repr__
11 REPR_OUTPUT_SIZE = 20
12 ITER_CHUNK_SIZE = 100
13
14
15 class QuerySet(BaseQuerySet):
16 """The default queryset, that builds queries and handles a set of results
17 returned from a query.
18
19 Wraps a MongoDB cursor, providing :class:`~mongoengine.Document` objects as
20 the results.
21 """
22
23 _has_more = True
24 _len = None
25 _result_cache = None
26
27 def __iter__(self):
28 """Iteration utilises a results cache which iterates the cursor
29 in batches of ``ITER_CHUNK_SIZE``.
30
31 If ``self._has_more`` the cursor hasn't been exhausted so cache then
32 batch. Otherwise iterate the result_cache.
33 """
34 self._iter = True
35
36 if self._has_more:
37 return self._iter_results()
38
39 # iterating over the cache.
40 return iter(self._result_cache)
41
42 def __len__(self):
43 """Since __len__ is called quite frequently (for example, as part of
44 list(qs)), we populate the result cache and cache the length.
45 """
46 if self._len is not None:
47 return self._len
48
49 # Populate the result cache with *all* of the docs in the cursor
50 if self._has_more:
51 list(self._iter_results())
52
53 # Cache the length of the complete result cache and return it
54 self._len = len(self._result_cache)
55 return self._len
56
57 def __repr__(self):
58 """Provide a string representation of the QuerySet"""
59 if self._iter:
60 return '.. queryset mid-iteration ..'
61
62 self._populate_cache()
63 data = self._result_cache[:REPR_OUTPUT_SIZE + 1]
64 if len(data) > REPR_OUTPUT_SIZE:
65 data[-1] = '...(remaining elements truncated)...'
66 return repr(data)
67
68 def _iter_results(self):
69 """A generator for iterating over the result cache.
70
71 Also populates the cache if there are more possible results to
72 yield. Raises StopIteration when there are no more results.
73 """
74 if self._result_cache is None:
75 self._result_cache = []
76
77 pos = 0
78 while True:
79
80 # For all positions lower than the length of the current result
81 # cache, serve the docs straight from the cache w/o hitting the
82 # database.
83 # XXX it's VERY important to compute the len within the `while`
84 # condition because the result cache might expand mid-iteration
85 # (e.g. if we call len(qs) inside a loop that iterates over the
86 # queryset). Fortunately len(list) is O(1) in Python, so this
87 # doesn't cause performance issues.
88 while pos < len(self._result_cache):
89 yield self._result_cache[pos]
90 pos += 1
91
92 # Raise StopIteration if we already established there were no more
93 # docs in the db cursor.
94 if not self._has_more:
95 return
96
97 # Otherwise, populate more of the cache and repeat.
98 if len(self._result_cache) <= pos:
99 self._populate_cache()
100
101 def _populate_cache(self):
102 """
103 Populates the result cache with ``ITER_CHUNK_SIZE`` more entries
104 (until the cursor is exhausted).
105 """
106 if self._result_cache is None:
107 self._result_cache = []
108
109 # Skip populating the cache if we already established there are no
110 # more docs to pull from the database.
111 if not self._has_more:
112 return
113
114 # Pull in ITER_CHUNK_SIZE docs from the database and store them in
115 # the result cache.
116 try:
117 for _ in six.moves.range(ITER_CHUNK_SIZE):
118 self._result_cache.append(self.next())
119 except StopIteration:
120 # Getting this exception means there are no more docs in the
121 # db cursor. Set _has_more to False so that we can use that
122 # information in other places.
123 self._has_more = False
124
125 def count(self, with_limit_and_skip=False):
126 """Count the selected elements in the query.
127
128 :param with_limit_and_skip (optional): take any :meth:`limit` or
129 :meth:`skip` that has been applied to this cursor into account when
130 getting the count
131 """
132 if with_limit_and_skip is False:
133 return super(QuerySet, self).count(with_limit_and_skip)
134
135 if self._len is None:
136 self._len = super(QuerySet, self).count(with_limit_and_skip)
137
138 return self._len
139
140 def no_cache(self):
141 """Convert to a non-caching queryset
142
143 .. versionadded:: 0.8.3 Convert to non caching queryset
144 """
145 if self._result_cache is not None:
146 raise OperationError('QuerySet already cached')
147
148 return self._clone_into(QuerySetNoCache(self._document,
149 self._collection))
150
151
152 class QuerySetNoCache(BaseQuerySet):
153 """A non caching QuerySet"""
154
155 def cache(self):
156 """Convert to a caching queryset
157
158 .. versionadded:: 0.8.3 Convert to caching queryset
159 """
160 return self._clone_into(QuerySet(self._document, self._collection))
161
162 def __repr__(self):
163 """Provides the string representation of the QuerySet
164
165 .. versionchanged:: 0.6.13 Now doesnt modify the cursor
166 """
167 if self._iter:
168 return '.. queryset mid-iteration ..'
169
170 data = []
171 for _ in six.moves.range(REPR_OUTPUT_SIZE + 1):
172 try:
173 data.append(self.next())
174 except StopIteration:
175 break
176
177 if len(data) > REPR_OUTPUT_SIZE:
178 data[-1] = '...(remaining elements truncated)...'
179
180 self.rewind()
181 return repr(data)
182
183 def __iter__(self):
184 queryset = self
185 if queryset._iter:
186 queryset = self.clone()
187 queryset.rewind()
188 return queryset
189
190
191 class QuerySetNoDeRef(QuerySet):
192 """Special no_dereference QuerySet"""
193
194 def __dereference(items, max_depth=1, instance=None, name=None):
195 return items
196
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/mongoengine/queryset/queryset.py b/mongoengine/queryset/queryset.py
--- a/mongoengine/queryset/queryset.py
+++ b/mongoengine/queryset/queryset.py
@@ -89,7 +89,7 @@
yield self._result_cache[pos]
pos += 1
- # Raise StopIteration if we already established there were no more
+ # return if we already established there were no more
# docs in the db cursor.
if not self._has_more:
return
|
{"golden_diff": "diff --git a/mongoengine/queryset/queryset.py b/mongoengine/queryset/queryset.py\n--- a/mongoengine/queryset/queryset.py\n+++ b/mongoengine/queryset/queryset.py\n@@ -89,7 +89,7 @@\n yield self._result_cache[pos]\n pos += 1\n \n- # Raise StopIteration if we already established there were no more\n+ # return if we already established there were no more\n # docs in the db cursor.\n if not self._has_more:\n return\n", "issue": "raise StopIteration in generators is deprecated\n```\r\n...\r\n/Users/Vic/projects/brain2/brain/utils/user_progress.py:686: DeprecationWarning: generator 'QuerySet._iter_results' raised StopIteration\r\n for action in actions:\r\n/Users/Vic/projects/brain2/brain/utils/user_course_state.py:317: DeprecationWarning: generator 'QuerySet._iter_results' raised StopIteration\r\n PlayedTask(\r\n/Users/Vic/projects/brain2/venv/lib/python3.6/site-packages/mongoengine/dereference.py:33: DeprecationWarning: generator 'QuerySet._iter_results' raised StopIteration\r\n...\r\n```\r\nhttps://stackoverflow.com/questions/14183803/in-pythons-generators-what-is-the-difference-between-raise-stopiteration-and\r\n\r\nhttps://github.com/MongoEngine/mongoengine/blob/5bdd35464b89dd2def1dcb0464e244322f1bc757/mongoengine/queryset/queryset.py#L95\n", "before_files": [{"content": "import six\n\nfrom mongoengine.errors import OperationError\nfrom mongoengine.queryset.base import (BaseQuerySet, CASCADE, DENY, DO_NOTHING,\n NULLIFY, PULL)\n\n__all__ = ('QuerySet', 'QuerySetNoCache', 'DO_NOTHING', 'NULLIFY', 'CASCADE',\n 'DENY', 'PULL')\n\n# The maximum number of items to display in a QuerySet.__repr__\nREPR_OUTPUT_SIZE = 20\nITER_CHUNK_SIZE = 100\n\n\nclass QuerySet(BaseQuerySet):\n \"\"\"The default queryset, that builds queries and handles a set of results\n returned from a query.\n\n Wraps a MongoDB cursor, providing :class:`~mongoengine.Document` objects as\n the results.\n \"\"\"\n\n _has_more = True\n _len = None\n _result_cache = None\n\n def __iter__(self):\n \"\"\"Iteration utilises a results cache which iterates the cursor\n in batches of ``ITER_CHUNK_SIZE``.\n\n If ``self._has_more`` the cursor hasn't been exhausted so cache then\n batch. Otherwise iterate the result_cache.\n \"\"\"\n self._iter = True\n\n if self._has_more:\n return self._iter_results()\n\n # iterating over the cache.\n return iter(self._result_cache)\n\n def __len__(self):\n \"\"\"Since __len__ is called quite frequently (for example, as part of\n list(qs)), we populate the result cache and cache the length.\n \"\"\"\n if self._len is not None:\n return self._len\n\n # Populate the result cache with *all* of the docs in the cursor\n if self._has_more:\n list(self._iter_results())\n\n # Cache the length of the complete result cache and return it\n self._len = len(self._result_cache)\n return self._len\n\n def __repr__(self):\n \"\"\"Provide a string representation of the QuerySet\"\"\"\n if self._iter:\n return '.. queryset mid-iteration ..'\n\n self._populate_cache()\n data = self._result_cache[:REPR_OUTPUT_SIZE + 1]\n if len(data) > REPR_OUTPUT_SIZE:\n data[-1] = '...(remaining elements truncated)...'\n return repr(data)\n\n def _iter_results(self):\n \"\"\"A generator for iterating over the result cache.\n\n Also populates the cache if there are more possible results to\n yield. Raises StopIteration when there are no more results.\n \"\"\"\n if self._result_cache is None:\n self._result_cache = []\n\n pos = 0\n while True:\n\n # For all positions lower than the length of the current result\n # cache, serve the docs straight from the cache w/o hitting the\n # database.\n # XXX it's VERY important to compute the len within the `while`\n # condition because the result cache might expand mid-iteration\n # (e.g. if we call len(qs) inside a loop that iterates over the\n # queryset). Fortunately len(list) is O(1) in Python, so this\n # doesn't cause performance issues.\n while pos < len(self._result_cache):\n yield self._result_cache[pos]\n pos += 1\n\n # Raise StopIteration if we already established there were no more\n # docs in the db cursor.\n if not self._has_more:\n return\n\n # Otherwise, populate more of the cache and repeat.\n if len(self._result_cache) <= pos:\n self._populate_cache()\n\n def _populate_cache(self):\n \"\"\"\n Populates the result cache with ``ITER_CHUNK_SIZE`` more entries\n (until the cursor is exhausted).\n \"\"\"\n if self._result_cache is None:\n self._result_cache = []\n\n # Skip populating the cache if we already established there are no\n # more docs to pull from the database.\n if not self._has_more:\n return\n\n # Pull in ITER_CHUNK_SIZE docs from the database and store them in\n # the result cache.\n try:\n for _ in six.moves.range(ITER_CHUNK_SIZE):\n self._result_cache.append(self.next())\n except StopIteration:\n # Getting this exception means there are no more docs in the\n # db cursor. Set _has_more to False so that we can use that\n # information in other places.\n self._has_more = False\n\n def count(self, with_limit_and_skip=False):\n \"\"\"Count the selected elements in the query.\n\n :param with_limit_and_skip (optional): take any :meth:`limit` or\n :meth:`skip` that has been applied to this cursor into account when\n getting the count\n \"\"\"\n if with_limit_and_skip is False:\n return super(QuerySet, self).count(with_limit_and_skip)\n\n if self._len is None:\n self._len = super(QuerySet, self).count(with_limit_and_skip)\n\n return self._len\n\n def no_cache(self):\n \"\"\"Convert to a non-caching queryset\n\n .. versionadded:: 0.8.3 Convert to non caching queryset\n \"\"\"\n if self._result_cache is not None:\n raise OperationError('QuerySet already cached')\n\n return self._clone_into(QuerySetNoCache(self._document,\n self._collection))\n\n\nclass QuerySetNoCache(BaseQuerySet):\n \"\"\"A non caching QuerySet\"\"\"\n\n def cache(self):\n \"\"\"Convert to a caching queryset\n\n .. versionadded:: 0.8.3 Convert to caching queryset\n \"\"\"\n return self._clone_into(QuerySet(self._document, self._collection))\n\n def __repr__(self):\n \"\"\"Provides the string representation of the QuerySet\n\n .. versionchanged:: 0.6.13 Now doesnt modify the cursor\n \"\"\"\n if self._iter:\n return '.. queryset mid-iteration ..'\n\n data = []\n for _ in six.moves.range(REPR_OUTPUT_SIZE + 1):\n try:\n data.append(self.next())\n except StopIteration:\n break\n\n if len(data) > REPR_OUTPUT_SIZE:\n data[-1] = '...(remaining elements truncated)...'\n\n self.rewind()\n return repr(data)\n\n def __iter__(self):\n queryset = self\n if queryset._iter:\n queryset = self.clone()\n queryset.rewind()\n return queryset\n\n\nclass QuerySetNoDeRef(QuerySet):\n \"\"\"Special no_dereference QuerySet\"\"\"\n\n def __dereference(items, max_depth=1, instance=None, name=None):\n return items\n", "path": "mongoengine/queryset/queryset.py"}], "after_files": [{"content": "import six\n\nfrom mongoengine.errors import OperationError\nfrom mongoengine.queryset.base import (BaseQuerySet, CASCADE, DENY, DO_NOTHING,\n NULLIFY, PULL)\n\n__all__ = ('QuerySet', 'QuerySetNoCache', 'DO_NOTHING', 'NULLIFY', 'CASCADE',\n 'DENY', 'PULL')\n\n# The maximum number of items to display in a QuerySet.__repr__\nREPR_OUTPUT_SIZE = 20\nITER_CHUNK_SIZE = 100\n\n\nclass QuerySet(BaseQuerySet):\n \"\"\"The default queryset, that builds queries and handles a set of results\n returned from a query.\n\n Wraps a MongoDB cursor, providing :class:`~mongoengine.Document` objects as\n the results.\n \"\"\"\n\n _has_more = True\n _len = None\n _result_cache = None\n\n def __iter__(self):\n \"\"\"Iteration utilises a results cache which iterates the cursor\n in batches of ``ITER_CHUNK_SIZE``.\n\n If ``self._has_more`` the cursor hasn't been exhausted so cache then\n batch. Otherwise iterate the result_cache.\n \"\"\"\n self._iter = True\n\n if self._has_more:\n return self._iter_results()\n\n # iterating over the cache.\n return iter(self._result_cache)\n\n def __len__(self):\n \"\"\"Since __len__ is called quite frequently (for example, as part of\n list(qs)), we populate the result cache and cache the length.\n \"\"\"\n if self._len is not None:\n return self._len\n\n # Populate the result cache with *all* of the docs in the cursor\n if self._has_more:\n list(self._iter_results())\n\n # Cache the length of the complete result cache and return it\n self._len = len(self._result_cache)\n return self._len\n\n def __repr__(self):\n \"\"\"Provide a string representation of the QuerySet\"\"\"\n if self._iter:\n return '.. queryset mid-iteration ..'\n\n self._populate_cache()\n data = self._result_cache[:REPR_OUTPUT_SIZE + 1]\n if len(data) > REPR_OUTPUT_SIZE:\n data[-1] = '...(remaining elements truncated)...'\n return repr(data)\n\n def _iter_results(self):\n \"\"\"A generator for iterating over the result cache.\n\n Also populates the cache if there are more possible results to\n yield. Raises StopIteration when there are no more results.\n \"\"\"\n if self._result_cache is None:\n self._result_cache = []\n\n pos = 0\n while True:\n\n # For all positions lower than the length of the current result\n # cache, serve the docs straight from the cache w/o hitting the\n # database.\n # XXX it's VERY important to compute the len within the `while`\n # condition because the result cache might expand mid-iteration\n # (e.g. if we call len(qs) inside a loop that iterates over the\n # queryset). Fortunately len(list) is O(1) in Python, so this\n # doesn't cause performance issues.\n while pos < len(self._result_cache):\n yield self._result_cache[pos]\n pos += 1\n\n # return if we already established there were no more\n # docs in the db cursor.\n if not self._has_more:\n return\n\n # Otherwise, populate more of the cache and repeat.\n if len(self._result_cache) <= pos:\n self._populate_cache()\n\n def _populate_cache(self):\n \"\"\"\n Populates the result cache with ``ITER_CHUNK_SIZE`` more entries\n (until the cursor is exhausted).\n \"\"\"\n if self._result_cache is None:\n self._result_cache = []\n\n # Skip populating the cache if we already established there are no\n # more docs to pull from the database.\n if not self._has_more:\n return\n\n # Pull in ITER_CHUNK_SIZE docs from the database and store them in\n # the result cache.\n try:\n for _ in six.moves.range(ITER_CHUNK_SIZE):\n self._result_cache.append(self.next())\n except StopIteration:\n # Getting this exception means there are no more docs in the\n # db cursor. Set _has_more to False so that we can use that\n # information in other places.\n self._has_more = False\n\n def count(self, with_limit_and_skip=False):\n \"\"\"Count the selected elements in the query.\n\n :param with_limit_and_skip (optional): take any :meth:`limit` or\n :meth:`skip` that has been applied to this cursor into account when\n getting the count\n \"\"\"\n if with_limit_and_skip is False:\n return super(QuerySet, self).count(with_limit_and_skip)\n\n if self._len is None:\n self._len = super(QuerySet, self).count(with_limit_and_skip)\n\n return self._len\n\n def no_cache(self):\n \"\"\"Convert to a non-caching queryset\n\n .. versionadded:: 0.8.3 Convert to non caching queryset\n \"\"\"\n if self._result_cache is not None:\n raise OperationError('QuerySet already cached')\n\n return self._clone_into(QuerySetNoCache(self._document,\n self._collection))\n\n\nclass QuerySetNoCache(BaseQuerySet):\n \"\"\"A non caching QuerySet\"\"\"\n\n def cache(self):\n \"\"\"Convert to a caching queryset\n\n .. versionadded:: 0.8.3 Convert to caching queryset\n \"\"\"\n return self._clone_into(QuerySet(self._document, self._collection))\n\n def __repr__(self):\n \"\"\"Provides the string representation of the QuerySet\n\n .. versionchanged:: 0.6.13 Now doesnt modify the cursor\n \"\"\"\n if self._iter:\n return '.. queryset mid-iteration ..'\n\n data = []\n for _ in six.moves.range(REPR_OUTPUT_SIZE + 1):\n try:\n data.append(self.next())\n except StopIteration:\n break\n\n if len(data) > REPR_OUTPUT_SIZE:\n data[-1] = '...(remaining elements truncated)...'\n\n self.rewind()\n return repr(data)\n\n def __iter__(self):\n queryset = self\n if queryset._iter:\n queryset = self.clone()\n queryset.rewind()\n return queryset\n\n\nclass QuerySetNoDeRef(QuerySet):\n \"\"\"Special no_dereference QuerySet\"\"\"\n\n def __dereference(items, max_depth=1, instance=None, name=None):\n return items\n", "path": "mongoengine/queryset/queryset.py"}]}
| 2,405 | 117 |
gh_patches_debug_59434
|
rasdani/github-patches
|
git_diff
|
kubeflow__pipelines-4187
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
allow output artifact store configuration (vs hard coded)
it seems like the output artifacts are always stored in a specific minio service, port, namespace, bucket, secrets, etc (`minio-service.kubeflow:9000`).
see: https://github.com/kubeflow/pipelines/blob/f40a22a3f4a8e06d20cf3e3f425b5058d5c87e0b/sdk/python/kfp/compiler/_op_to_template.py#L148
it would be great to make it flexible, e.g. allow using S3, or change namespace or bucket names.
i suggest making it configurable, i can do such PR if we agree its needed.
flexible pipeline service (host) path in client SDK
when creating an SDK `Client()` the path to `ml-pipeline` API service is loaded from a hard coded value (`ml-pipeline.kubeflow.svc.cluster.local:8888`) which indicate a specific k8s namespace. it can be valuable to load that default value from an env variable, i.e. changing the line in `_client.py` from:
`config.host = host if host else Client.IN_CLUSTER_DNS_NAME`
to:
`config.host = host or os.environ.get('ML_PIPELINE_DNS_NAME',Client.IN_CLUSTER_DNS_NAME)`
also note that when a user provide the `host` parameter, the ipython output points to the API server and not to the UI service (see the logic in `_get_url_prefix()`), it seems like a potential bug
if its acceptable i can submit a PR for the line change above
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `samples/core/loop_parallelism/loop_parallelism.py`
Content:
```
1 # Copyright 2020 Google LLC
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 import kfp.dsl as dsl
16 import kfp
17
18
19 @kfp.components.create_component_from_func
20 def print_op(s: str):
21 print(s)
22
23 @dsl.pipeline(name='my-pipeline')
24 def pipeline2(my_pipe_param=10):
25 loop_args = [{'A_a': 1, 'B_b': 2}, {'A_a': 10, 'B_b': 20}]
26 with dsl.ParallelFor(loop_args, parallelism=1) as item:
27 print_op(item)
28 print_op(item.A_a)
29 print_op(item.B_b)
30
31
32 if __name__ == '__main__':
33 kfp.compiler.Compiler().compile(pipeline, __file__ + '.yaml')
34
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/samples/core/loop_parallelism/loop_parallelism.py b/samples/core/loop_parallelism/loop_parallelism.py
--- a/samples/core/loop_parallelism/loop_parallelism.py
+++ b/samples/core/loop_parallelism/loop_parallelism.py
@@ -21,9 +21,9 @@
print(s)
@dsl.pipeline(name='my-pipeline')
-def pipeline2(my_pipe_param=10):
+def pipeline():
loop_args = [{'A_a': 1, 'B_b': 2}, {'A_a': 10, 'B_b': 20}]
- with dsl.ParallelFor(loop_args, parallelism=1) as item:
+ with dsl.ParallelFor(loop_args, parallelism=10) as item:
print_op(item)
print_op(item.A_a)
print_op(item.B_b)
|
{"golden_diff": "diff --git a/samples/core/loop_parallelism/loop_parallelism.py b/samples/core/loop_parallelism/loop_parallelism.py\n--- a/samples/core/loop_parallelism/loop_parallelism.py\n+++ b/samples/core/loop_parallelism/loop_parallelism.py\n@@ -21,9 +21,9 @@\n print(s)\n \n @dsl.pipeline(name='my-pipeline')\n-def pipeline2(my_pipe_param=10):\n+def pipeline():\n loop_args = [{'A_a': 1, 'B_b': 2}, {'A_a': 10, 'B_b': 20}]\n- with dsl.ParallelFor(loop_args, parallelism=1) as item:\n+ with dsl.ParallelFor(loop_args, parallelism=10) as item:\n print_op(item)\n print_op(item.A_a)\n print_op(item.B_b)\n", "issue": "allow output artifact store configuration (vs hard coded)\nit seems like the output artifacts are always stored in a specific minio service, port, namespace, bucket, secrets, etc (`minio-service.kubeflow:9000`). \r\n\r\nsee: https://github.com/kubeflow/pipelines/blob/f40a22a3f4a8e06d20cf3e3f425b5058d5c87e0b/sdk/python/kfp/compiler/_op_to_template.py#L148\r\n\r\nit would be great to make it flexible, e.g. allow using S3, or change namespace or bucket names.\r\ni suggest making it configurable, i can do such PR if we agree its needed. \nflexible pipeline service (host) path in client SDK \nwhen creating an SDK `Client()` the path to `ml-pipeline` API service is loaded from a hard coded value (`ml-pipeline.kubeflow.svc.cluster.local:8888`) which indicate a specific k8s namespace. it can be valuable to load that default value from an env variable, i.e. changing the line in `_client.py` from:\r\n\r\n`config.host = host if host else Client.IN_CLUSTER_DNS_NAME`\r\n\r\nto:\r\n\r\n`config.host = host or os.environ.get('ML_PIPELINE_DNS_NAME',Client.IN_CLUSTER_DNS_NAME)`\r\n\r\nalso note that when a user provide the `host` parameter, the ipython output points to the API server and not to the UI service (see the logic in `_get_url_prefix()`), it seems like a potential bug\r\n\r\nif its acceptable i can submit a PR for the line change above\r\n \n", "before_files": [{"content": "# Copyright 2020 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 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 kfp.dsl as dsl\nimport kfp\n\n\[email protected]_component_from_func\ndef print_op(s: str):\n print(s)\n\[email protected](name='my-pipeline')\ndef pipeline2(my_pipe_param=10):\n loop_args = [{'A_a': 1, 'B_b': 2}, {'A_a': 10, 'B_b': 20}]\n with dsl.ParallelFor(loop_args, parallelism=1) as item:\n print_op(item)\n print_op(item.A_a)\n print_op(item.B_b)\n\n\nif __name__ == '__main__':\n kfp.compiler.Compiler().compile(pipeline, __file__ + '.yaml')\n", "path": "samples/core/loop_parallelism/loop_parallelism.py"}], "after_files": [{"content": "# Copyright 2020 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 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 kfp.dsl as dsl\nimport kfp\n\n\[email protected]_component_from_func\ndef print_op(s: str):\n print(s)\n\[email protected](name='my-pipeline')\ndef pipeline():\n loop_args = [{'A_a': 1, 'B_b': 2}, {'A_a': 10, 'B_b': 20}]\n with dsl.ParallelFor(loop_args, parallelism=10) as item:\n print_op(item)\n print_op(item.A_a)\n print_op(item.B_b)\n\n\nif __name__ == '__main__':\n kfp.compiler.Compiler().compile(pipeline, __file__ + '.yaml')\n", "path": "samples/core/loop_parallelism/loop_parallelism.py"}]}
| 960 | 192 |
gh_patches_debug_23191
|
rasdani/github-patches
|
git_diff
|
searx__searx-195
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Google engine : latency caused by redirection
The current implementation of the google engine has a little issue : there is a redirection for each request, but not for everyone.
It's depend of the geoip : https://support.google.com/websearch/answer/873?hl=en
If you look at the response time of the different searx instance, some time the google time is slow compare to the other engine, I guess this is this issue.
One way to avoid this is to set the PREF cookie (set but http://www.google.com/ncr ). Of course there is an unique ID. On solution is to initialize the cookie at start of the searx instance :
``` python
pref_cookie = ''
def get_google_pref_cookie():
global pref_cookie
if pref_cookie == '':
resp = get('https://www.google.com/ncr', allow_redirects=False)
pref_cookie = resp.cookies["PREF"]
return pref_cookie
```
and set the cookie in the request method :
``` python
params['cookies']['PREF'] = get_google_pref_cookie()
```
The cookie is global to the searx instance, so in my opinion there is no privacy issue.
Of course, if there searx instance is behind a router and share a public IP with other machine, the request are more "tagged", but isn't already the case since there is not all the normal header that a browser send ?
Another solution is to revert to the previous solution that api.google.com, but the results are different from the "browser" version (see #92)
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `searx/engines/google.py`
Content:
```
1 # Google (Web)
2 #
3 # @website https://www.google.com
4 # @provide-api yes (https://developers.google.com/custom-search/)
5 #
6 # @using-api no
7 # @results HTML
8 # @stable no (HTML can change)
9 # @parse url, title, content, suggestion
10
11 from urllib import urlencode
12 from urlparse import urlparse, parse_qsl
13 from lxml import html
14 from searx.engines.xpath import extract_text, extract_url
15
16 # engine dependent config
17 categories = ['general']
18 paging = True
19 language_support = True
20
21 # search-url
22 google_hostname = 'www.google.com'
23 search_path = '/search'
24 redirect_path = '/url'
25 images_path = '/images'
26 search_url = ('https://' +
27 google_hostname +
28 search_path +
29 '?{query}&start={offset}&gbv=1')
30
31 # specific xpath variables
32 results_xpath = '//li[@class="g"]'
33 url_xpath = './/h3/a/@href'
34 title_xpath = './/h3'
35 content_xpath = './/span[@class="st"]'
36 suggestion_xpath = '//p[@class="_Bmc"]'
37
38 images_xpath = './/div/a'
39 image_url_xpath = './@href'
40 image_img_src_xpath = './img/@src'
41
42
43 # remove google-specific tracking-url
44 def parse_url(url_string):
45 parsed_url = urlparse(url_string)
46 if (parsed_url.netloc in [google_hostname, '']
47 and parsed_url.path == redirect_path):
48 query = dict(parse_qsl(parsed_url.query))
49 return query['q']
50 else:
51 return url_string
52
53
54 # do search-request
55 def request(query, params):
56 offset = (params['pageno'] - 1) * 10
57
58 if params['language'] == 'all':
59 language = 'en'
60 else:
61 language = params['language'].replace('_', '-').lower()
62
63 params['url'] = search_url.format(offset=offset,
64 query=urlencode({'q': query}))
65
66 params['headers']['Accept-Language'] = language
67
68 return params
69
70
71 # get response from search-request
72 def response(resp):
73 results = []
74
75 dom = html.fromstring(resp.text)
76
77 # parse results
78 for result in dom.xpath(results_xpath):
79 title = extract_text(result.xpath(title_xpath)[0])
80 try:
81 url = parse_url(extract_url(result.xpath(url_xpath), search_url))
82 parsed_url = urlparse(url)
83 if (parsed_url.netloc == google_hostname
84 and parsed_url.path == search_path):
85 # remove the link to google news
86 continue
87
88 # images result
89 if (parsed_url.netloc == google_hostname
90 and parsed_url.path == images_path):
91 # only thumbnail image provided,
92 # so skipping image results
93 # results = results + parse_images(result)
94 pass
95 else:
96 # normal result
97 content = extract_text(result.xpath(content_xpath)[0])
98 # append result
99 results.append({'url': url,
100 'title': title,
101 'content': content})
102 except:
103 continue
104
105 # parse suggestion
106 for suggestion in dom.xpath(suggestion_xpath):
107 # append suggestion
108 results.append({'suggestion': extract_text(suggestion)})
109
110 # return results
111 return results
112
113
114 def parse_images(result):
115 results = []
116 for image in result.xpath(images_xpath):
117 url = parse_url(extract_text(image.xpath(image_url_xpath)[0]))
118 img_src = extract_text(image.xpath(image_img_src_xpath)[0])
119
120 # append result
121 results.append({'url': url,
122 'title': '',
123 'content': '',
124 'img_src': img_src,
125 'template': 'images.html'})
126
127 return results
128
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/searx/engines/google.py b/searx/engines/google.py
--- a/searx/engines/google.py
+++ b/searx/engines/google.py
@@ -11,6 +11,7 @@
from urllib import urlencode
from urlparse import urlparse, parse_qsl
from lxml import html
+from searx.poolrequests import get
from searx.engines.xpath import extract_text, extract_url
# engine dependent config
@@ -39,6 +40,17 @@
image_url_xpath = './@href'
image_img_src_xpath = './img/@src'
+pref_cookie = ''
+
+
+# see https://support.google.com/websearch/answer/873?hl=en
+def get_google_pref_cookie():
+ global pref_cookie
+ if pref_cookie == '':
+ resp = get('https://www.google.com/ncr', allow_redirects=False)
+ pref_cookie = resp.cookies["PREF"]
+ return pref_cookie
+
# remove google-specific tracking-url
def parse_url(url_string):
@@ -64,6 +76,7 @@
query=urlencode({'q': query}))
params['headers']['Accept-Language'] = language
+ params['cookies']['PREF'] = get_google_pref_cookie()
return params
|
{"golden_diff": "diff --git a/searx/engines/google.py b/searx/engines/google.py\n--- a/searx/engines/google.py\n+++ b/searx/engines/google.py\n@@ -11,6 +11,7 @@\n from urllib import urlencode\n from urlparse import urlparse, parse_qsl\n from lxml import html\n+from searx.poolrequests import get\n from searx.engines.xpath import extract_text, extract_url\n \n # engine dependent config\n@@ -39,6 +40,17 @@\n image_url_xpath = './@href'\n image_img_src_xpath = './img/@src'\n \n+pref_cookie = ''\n+\n+\n+# see https://support.google.com/websearch/answer/873?hl=en\n+def get_google_pref_cookie():\n+ global pref_cookie\n+ if pref_cookie == '':\n+ resp = get('https://www.google.com/ncr', allow_redirects=False)\n+ pref_cookie = resp.cookies[\"PREF\"]\n+ return pref_cookie\n+\n \n # remove google-specific tracking-url\n def parse_url(url_string):\n@@ -64,6 +76,7 @@\n query=urlencode({'q': query}))\n \n params['headers']['Accept-Language'] = language\n+ params['cookies']['PREF'] = get_google_pref_cookie()\n \n return params\n", "issue": "Google engine : latency caused by redirection\nThe current implementation of the google engine has a little issue : there is a redirection for each request, but not for everyone.\nIt's depend of the geoip : https://support.google.com/websearch/answer/873?hl=en\n\nIf you look at the response time of the different searx instance, some time the google time is slow compare to the other engine, I guess this is this issue.\n\nOne way to avoid this is to set the PREF cookie (set but http://www.google.com/ncr ). Of course there is an unique ID. On solution is to initialize the cookie at start of the searx instance : \n\n``` python\npref_cookie = ''\n\ndef get_google_pref_cookie():\n global pref_cookie\n if pref_cookie == '':\n resp = get('https://www.google.com/ncr', allow_redirects=False)\n pref_cookie = resp.cookies[\"PREF\"]\n return pref_cookie\n```\n\nand set the cookie in the request method : \n\n``` python\n params['cookies']['PREF'] = get_google_pref_cookie()\n```\n\nThe cookie is global to the searx instance, so in my opinion there is no privacy issue.\n\nOf course, if there searx instance is behind a router and share a public IP with other machine, the request are more \"tagged\", but isn't already the case since there is not all the normal header that a browser send ?\n\nAnother solution is to revert to the previous solution that api.google.com, but the results are different from the \"browser\" version (see #92)\n\n", "before_files": [{"content": "# Google (Web)\n#\n# @website https://www.google.com\n# @provide-api yes (https://developers.google.com/custom-search/)\n#\n# @using-api no\n# @results HTML\n# @stable no (HTML can change)\n# @parse url, title, content, suggestion\n\nfrom urllib import urlencode\nfrom urlparse import urlparse, parse_qsl\nfrom lxml import html\nfrom searx.engines.xpath import extract_text, extract_url\n\n# engine dependent config\ncategories = ['general']\npaging = True\nlanguage_support = True\n\n# search-url\ngoogle_hostname = 'www.google.com'\nsearch_path = '/search'\nredirect_path = '/url'\nimages_path = '/images'\nsearch_url = ('https://' +\n google_hostname +\n search_path +\n '?{query}&start={offset}&gbv=1')\n\n# specific xpath variables\nresults_xpath = '//li[@class=\"g\"]'\nurl_xpath = './/h3/a/@href'\ntitle_xpath = './/h3'\ncontent_xpath = './/span[@class=\"st\"]'\nsuggestion_xpath = '//p[@class=\"_Bmc\"]'\n\nimages_xpath = './/div/a'\nimage_url_xpath = './@href'\nimage_img_src_xpath = './img/@src'\n\n\n# remove google-specific tracking-url\ndef parse_url(url_string):\n parsed_url = urlparse(url_string)\n if (parsed_url.netloc in [google_hostname, '']\n and parsed_url.path == redirect_path):\n query = dict(parse_qsl(parsed_url.query))\n return query['q']\n else:\n return url_string\n\n\n# do search-request\ndef request(query, params):\n offset = (params['pageno'] - 1) * 10\n\n if params['language'] == 'all':\n language = 'en'\n else:\n language = params['language'].replace('_', '-').lower()\n\n params['url'] = search_url.format(offset=offset,\n query=urlencode({'q': query}))\n\n params['headers']['Accept-Language'] = language\n\n return params\n\n\n# get response from search-request\ndef response(resp):\n results = []\n\n dom = html.fromstring(resp.text)\n\n # parse results\n for result in dom.xpath(results_xpath):\n title = extract_text(result.xpath(title_xpath)[0])\n try:\n url = parse_url(extract_url(result.xpath(url_xpath), search_url))\n parsed_url = urlparse(url)\n if (parsed_url.netloc == google_hostname\n and parsed_url.path == search_path):\n # remove the link to google news\n continue\n\n # images result\n if (parsed_url.netloc == google_hostname\n and parsed_url.path == images_path):\n # only thumbnail image provided,\n # so skipping image results\n # results = results + parse_images(result)\n pass\n else:\n # normal result\n content = extract_text(result.xpath(content_xpath)[0])\n # append result\n results.append({'url': url,\n 'title': title,\n 'content': content})\n except:\n continue\n\n # parse suggestion\n for suggestion in dom.xpath(suggestion_xpath):\n # append suggestion\n results.append({'suggestion': extract_text(suggestion)})\n\n # return results\n return results\n\n\ndef parse_images(result):\n results = []\n for image in result.xpath(images_xpath):\n url = parse_url(extract_text(image.xpath(image_url_xpath)[0]))\n img_src = extract_text(image.xpath(image_img_src_xpath)[0])\n\n # append result\n results.append({'url': url,\n 'title': '',\n 'content': '',\n 'img_src': img_src,\n 'template': 'images.html'})\n\n return results\n", "path": "searx/engines/google.py"}], "after_files": [{"content": "# Google (Web)\n#\n# @website https://www.google.com\n# @provide-api yes (https://developers.google.com/custom-search/)\n#\n# @using-api no\n# @results HTML\n# @stable no (HTML can change)\n# @parse url, title, content, suggestion\n\nfrom urllib import urlencode\nfrom urlparse import urlparse, parse_qsl\nfrom lxml import html\nfrom searx.poolrequests import get\nfrom searx.engines.xpath import extract_text, extract_url\n\n# engine dependent config\ncategories = ['general']\npaging = True\nlanguage_support = True\n\n# search-url\ngoogle_hostname = 'www.google.com'\nsearch_path = '/search'\nredirect_path = '/url'\nimages_path = '/images'\nsearch_url = ('https://' +\n google_hostname +\n search_path +\n '?{query}&start={offset}&gbv=1')\n\n# specific xpath variables\nresults_xpath = '//li[@class=\"g\"]'\nurl_xpath = './/h3/a/@href'\ntitle_xpath = './/h3'\ncontent_xpath = './/span[@class=\"st\"]'\nsuggestion_xpath = '//p[@class=\"_Bmc\"]'\n\nimages_xpath = './/div/a'\nimage_url_xpath = './@href'\nimage_img_src_xpath = './img/@src'\n\npref_cookie = ''\n\n\n# see https://support.google.com/websearch/answer/873?hl=en\ndef get_google_pref_cookie():\n global pref_cookie\n if pref_cookie == '':\n resp = get('https://www.google.com/ncr', allow_redirects=False)\n pref_cookie = resp.cookies[\"PREF\"]\n return pref_cookie\n\n\n# remove google-specific tracking-url\ndef parse_url(url_string):\n parsed_url = urlparse(url_string)\n if (parsed_url.netloc in [google_hostname, '']\n and parsed_url.path == redirect_path):\n query = dict(parse_qsl(parsed_url.query))\n return query['q']\n else:\n return url_string\n\n\n# do search-request\ndef request(query, params):\n offset = (params['pageno'] - 1) * 10\n\n if params['language'] == 'all':\n language = 'en'\n else:\n language = params['language'].replace('_', '-').lower()\n\n params['url'] = search_url.format(offset=offset,\n query=urlencode({'q': query}))\n\n params['headers']['Accept-Language'] = language\n params['cookies']['PREF'] = get_google_pref_cookie()\n\n return params\n\n\n# get response from search-request\ndef response(resp):\n results = []\n\n dom = html.fromstring(resp.text)\n\n # parse results\n for result in dom.xpath(results_xpath):\n title = extract_text(result.xpath(title_xpath)[0])\n try:\n url = parse_url(extract_url(result.xpath(url_xpath), search_url))\n parsed_url = urlparse(url)\n if (parsed_url.netloc == google_hostname\n and parsed_url.path == search_path):\n # remove the link to google news\n continue\n\n # images result\n if (parsed_url.netloc == google_hostname\n and parsed_url.path == images_path):\n # only thumbnail image provided,\n # so skipping image results\n # results = results + parse_images(result)\n pass\n else:\n # normal result\n content = extract_text(result.xpath(content_xpath)[0])\n # append result\n results.append({'url': url,\n 'title': title,\n 'content': content})\n except:\n continue\n\n # parse suggestion\n for suggestion in dom.xpath(suggestion_xpath):\n # append suggestion\n results.append({'suggestion': extract_text(suggestion)})\n\n # return results\n return results\n\n\ndef parse_images(result):\n results = []\n for image in result.xpath(images_xpath):\n url = parse_url(extract_text(image.xpath(image_url_xpath)[0]))\n img_src = extract_text(image.xpath(image_img_src_xpath)[0])\n\n # append result\n results.append({'url': url,\n 'title': '',\n 'content': '',\n 'img_src': img_src,\n 'template': 'images.html'})\n\n return results\n", "path": "searx/engines/google.py"}]}
| 1,667 | 287 |
gh_patches_debug_1678
|
rasdani/github-patches
|
git_diff
|
keras-team__keras-1158
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
problem with K.common._FLOATX
I tried to run:
```
a = K.random_normal((100, 200))
```
and I got the error:
```
/home/eders/python/Theano/theano/sandbox/rng_mrg.pyc in get_substream_rstates(self, n_streams, dtype, inc_rstate)
1167
1168 """
-> 1169 assert isinstance(dtype, str)
1170 assert n_streams < 2**72
1171 assert n_streams > 0
AssertionError:
```
I tried to print K.common._FLOATX to see what was going on and it is `u'float32'`. That little `u` upfront is making theano crash. I believe that when reading the type from json it was not converted to the right type of string. Anybody else had that problem? I'll check the code to see if I can fix it.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `keras/backend/common.py`
Content:
```
1 import numpy as np
2
3 # the type of float to use throughout the session.
4 _FLOATX = 'float32'
5 _EPSILON = 10e-8
6
7
8 def epsilon():
9 return _EPSILON
10
11
12 def set_epsilon(e):
13 global _EPSILON
14 _EPSILON = e
15
16
17 def floatx():
18 return _FLOATX
19
20
21 def set_floatx(floatx):
22 global _FLOATX
23 if floatx not in {'float32', 'float64'}:
24 raise Exception('Unknown floatx type: ' + str(floatx))
25 _FLOATX = floatx
26
27
28 def cast_to_floatx(x):
29 '''Cast a Numpy array to floatx.
30 '''
31 return np.asarray(x, dtype=_FLOATX)
32
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/keras/backend/common.py b/keras/backend/common.py
--- a/keras/backend/common.py
+++ b/keras/backend/common.py
@@ -22,6 +22,8 @@
global _FLOATX
if floatx not in {'float32', 'float64'}:
raise Exception('Unknown floatx type: ' + str(floatx))
+ if isinstance(floatx, unicode):
+ floatx = floatx.encode('ascii')
_FLOATX = floatx
|
{"golden_diff": "diff --git a/keras/backend/common.py b/keras/backend/common.py\n--- a/keras/backend/common.py\n+++ b/keras/backend/common.py\n@@ -22,6 +22,8 @@\n global _FLOATX\n if floatx not in {'float32', 'float64'}:\n raise Exception('Unknown floatx type: ' + str(floatx))\n+ if isinstance(floatx, unicode):\n+ floatx = floatx.encode('ascii')\n _FLOATX = floatx\n", "issue": "problem with K.common._FLOATX\nI tried to run:\n\n```\na = K.random_normal((100, 200))\n```\n\nand I got the error:\n\n```\n/home/eders/python/Theano/theano/sandbox/rng_mrg.pyc in get_substream_rstates(self, n_streams, dtype, inc_rstate)\n 1167 \n 1168 \"\"\"\n-> 1169 assert isinstance(dtype, str)\n 1170 assert n_streams < 2**72\n 1171 assert n_streams > 0\n\nAssertionError:\n```\n\nI tried to print K.common._FLOATX to see what was going on and it is `u'float32'`. That little `u` upfront is making theano crash. I believe that when reading the type from json it was not converted to the right type of string. Anybody else had that problem? I'll check the code to see if I can fix it.\n\n", "before_files": [{"content": "import numpy as np\n\n# the type of float to use throughout the session.\n_FLOATX = 'float32'\n_EPSILON = 10e-8\n\n\ndef epsilon():\n return _EPSILON\n\n\ndef set_epsilon(e):\n global _EPSILON\n _EPSILON = e\n\n\ndef floatx():\n return _FLOATX\n\n\ndef set_floatx(floatx):\n global _FLOATX\n if floatx not in {'float32', 'float64'}:\n raise Exception('Unknown floatx type: ' + str(floatx))\n _FLOATX = floatx\n\n\ndef cast_to_floatx(x):\n '''Cast a Numpy array to floatx.\n '''\n return np.asarray(x, dtype=_FLOATX)\n", "path": "keras/backend/common.py"}], "after_files": [{"content": "import numpy as np\n\n# the type of float to use throughout the session.\n_FLOATX = 'float32'\n_EPSILON = 10e-8\n\n\ndef epsilon():\n return _EPSILON\n\n\ndef set_epsilon(e):\n global _EPSILON\n _EPSILON = e\n\n\ndef floatx():\n return _FLOATX\n\n\ndef set_floatx(floatx):\n global _FLOATX\n if floatx not in {'float32', 'float64'}:\n raise Exception('Unknown floatx type: ' + str(floatx))\n if isinstance(floatx, unicode):\n floatx = floatx.encode('ascii')\n _FLOATX = floatx\n\n\ndef cast_to_floatx(x):\n '''Cast a Numpy array to floatx.\n '''\n return np.asarray(x, dtype=_FLOATX)\n", "path": "keras/backend/common.py"}]}
| 697 | 114 |
gh_patches_debug_38037
|
rasdani/github-patches
|
git_diff
|
bokeh__bokeh-6225
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
allow users to specify explicit tick labels
`FixedTicker` allows users to specify fixed tick locations, but also need to allow users to specify explicit tick labels
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `sphinx/source/docs/user_guide/examples/styling_fixed_ticker.py`
Content:
```
1 from bokeh.plotting import figure, output_file, show
2 from bokeh.models import FixedTicker
3
4 output_file("axes.html")
5
6 p = figure(plot_width=400, plot_height=400)
7 p.circle([1,2,3,4,5], [2,5,8,2,7], size=10)
8
9 p.xaxis[0].ticker=FixedTicker(ticks=[2, 3.5, 4])
10
11 show(p)
12
```
Path: `bokeh/models/axes.py`
Content:
```
1 ''' Guide renderers for various kinds of axes that can be added to
2 Bokeh plots
3
4 '''
5 from __future__ import absolute_import
6
7 from ..core.has_props import abstract
8 from ..core.properties import Auto, Datetime, Either, Enum, Float, Include, Instance, Int, Override, String, Tuple
9 from ..core.property_mixins import LineProps, TextProps
10
11 from .formatters import BasicTickFormatter, CategoricalTickFormatter, DatetimeTickFormatter, LogTickFormatter, TickFormatter
12 from .renderers import GuideRenderer
13 from .tickers import Ticker, BasicTicker, LogTicker, CategoricalTicker, DatetimeTicker
14
15 @abstract
16 class Axis(GuideRenderer):
17 ''' A base class that defines common properties for all axis types.
18
19 '''
20
21 bounds = Either(Auto, Tuple(Float, Float), Tuple(Datetime, Datetime), help="""
22 Bounds for the rendered axis. If unset, the axis will span the
23 entire plot in the given dimension.
24 """)
25
26 x_range_name = String('default', help="""
27 A particular (named) x-range to use for computing screen
28 locations when rendering an axis on the plot. If unset, use the
29 default x-range.
30 """)
31
32 y_range_name = String('default', help="""
33 A particular (named) y-range to use for computing screen
34 locations when rendering an axis on the plot. If unset, use the
35 default y-range.
36 """)
37
38 ticker = Instance(Ticker, help="""
39 A Ticker to use for computing locations of axis components.
40 """)
41
42 formatter = Instance(TickFormatter, help="""
43 A TickFormatter to use for formatting the visual appearance
44 of ticks.
45 """)
46
47 axis_label = String(default='', help="""
48 A text label for the axis, displayed parallel to the axis rule.
49
50 .. note::
51 LaTeX notation is not currently supported; please see
52 :bokeh-issue:`647` to track progress or contribute.
53
54 """)
55
56 axis_label_standoff = Int(default=5, help="""
57 The distance in pixels that the axis labels should be offset
58 from the tick labels.
59 """)
60
61 axis_label_props = Include(TextProps, help="""
62 The %s of the axis label.
63 """)
64
65 axis_label_text_font_size = Override(default={'value': "10pt"})
66
67 axis_label_text_font_style = Override(default="italic")
68
69 major_label_standoff = Int(default=5, help="""
70 The distance in pixels that the major tick labels should be
71 offset from the associated ticks.
72 """)
73
74 major_label_orientation = Either(Enum("horizontal", "vertical"), Float, help="""
75 What direction the major label text should be oriented. If a
76 number is supplied, the angle of the text is measured from horizontal.
77 """)
78
79 major_label_props = Include(TextProps, help="""
80 The %s of the major tick labels.
81 """)
82
83 major_label_text_align = Override(default="center")
84
85 major_label_text_baseline = Override(default="alphabetic")
86
87 major_label_text_font_size = Override(default={'value': "8pt"})
88
89 axis_props = Include(LineProps, help="""
90 The %s of the axis line.
91 """)
92
93 major_tick_props = Include(LineProps, help="""
94 The %s of the major ticks.
95 """)
96
97 major_tick_in = Int(default=2, help="""
98 The distance in pixels that major ticks should extend into the
99 main plot area.
100 """)
101
102 major_tick_out = Int(default=6, help="""
103 The distance in pixels that major ticks should extend out of the
104 main plot area.
105 """)
106
107 minor_tick_props = Include(LineProps, help="""
108 The %s of the minor ticks.
109 """)
110
111 minor_tick_in = Int(default=0, help="""
112 The distance in pixels that minor ticks should extend into the
113 main plot area.
114 """)
115
116 minor_tick_out = Int(default=4, help="""
117 The distance in pixels that major ticks should extend out of the
118 main plot area.
119 """)
120
121 @abstract
122 class ContinuousAxis(Axis):
123 ''' A base class for all numeric, non-categorical axes types.
124
125 '''
126 pass
127
128 class LinearAxis(ContinuousAxis):
129 ''' An axis that picks nice numbers for tick locations on a
130 linear scale. Configured with a ``BasicTickFormatter`` by default.
131
132 '''
133 ticker = Override(default=lambda: BasicTicker())
134
135 formatter = Override(default=lambda: BasicTickFormatter())
136
137 class LogAxis(ContinuousAxis):
138 ''' An axis that picks nice numbers for tick locations on a
139 log scale. Configured with a ``LogTickFormatter`` by default.
140
141 '''
142 ticker = Override(default=lambda: LogTicker())
143
144 formatter = Override(default=lambda: LogTickFormatter())
145
146 class CategoricalAxis(Axis):
147 ''' An axis that picks evenly spaced tick locations for a
148 collection of categories/factors.
149
150 '''
151 ticker = Override(default=lambda: CategoricalTicker())
152
153 formatter = Override(default=lambda: CategoricalTickFormatter())
154
155 class DatetimeAxis(LinearAxis):
156 ''' An LinearAxis that picks nice numbers for tick locations on
157 a datetime scale. Configured with a ``DatetimeTickFormatter`` by
158 default.
159
160 '''
161
162 ticker = Override(default=lambda: DatetimeTicker())
163
164 formatter = Override(default=lambda: DatetimeTickFormatter())
165
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/bokeh/models/axes.py b/bokeh/models/axes.py
--- a/bokeh/models/axes.py
+++ b/bokeh/models/axes.py
@@ -5,12 +5,12 @@
from __future__ import absolute_import
from ..core.has_props import abstract
-from ..core.properties import Auto, Datetime, Either, Enum, Float, Include, Instance, Int, Override, String, Tuple
+from ..core.properties import Auto, Datetime, Dict, Either, Enum, Float, Include, Instance, Int, Override, Seq, String, Tuple
from ..core.property_mixins import LineProps, TextProps
from .formatters import BasicTickFormatter, CategoricalTickFormatter, DatetimeTickFormatter, LogTickFormatter, TickFormatter
from .renderers import GuideRenderer
-from .tickers import Ticker, BasicTicker, LogTicker, CategoricalTicker, DatetimeTicker
+from .tickers import Ticker, BasicTicker, LogTicker, CategoricalTicker, DatetimeTicker, FixedTicker
@abstract
class Axis(GuideRenderer):
@@ -37,7 +37,29 @@
ticker = Instance(Ticker, help="""
A Ticker to use for computing locations of axis components.
- """)
+
+ The property may also be passed a sequence of floating point numbers as
+ a shorthand for creating and configuring a ``FixedTicker``, e.g. the
+ following code
+
+ .. code-block:: python
+
+ from bokeh.plotting import figure
+
+ p = figure()
+ p.xaxis.ticker = [10, 20, 37.4]
+
+ is equivalent to:
+
+ .. code-block:: python
+
+ from bokeh.plotting import figure
+ from bokeh.models.tickers import FixedTicker
+
+ p = figure()
+ p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
+
+ """).accepts(Seq(Float), lambda ticks: FixedTicker(ticks=ticks))
formatter = Instance(TickFormatter, help="""
A TickFormatter to use for formatting the visual appearance
@@ -76,6 +98,11 @@
number is supplied, the angle of the text is measured from horizontal.
""")
+ major_label_overrides = Dict(Either(Float, String), String, default={}, help="""
+ Provide explicit tick label values for specific tick locations that
+ override normal formatting.
+ """)
+
major_label_props = Include(TextProps, help="""
The %s of the major tick labels.
""")
diff --git a/sphinx/source/docs/user_guide/examples/styling_fixed_ticker.py b/sphinx/source/docs/user_guide/examples/styling_fixed_ticker.py
--- a/sphinx/source/docs/user_guide/examples/styling_fixed_ticker.py
+++ b/sphinx/source/docs/user_guide/examples/styling_fixed_ticker.py
@@ -1,11 +1,10 @@
from bokeh.plotting import figure, output_file, show
-from bokeh.models import FixedTicker
-output_file("axes.html")
+output_file("fixed_ticks.html")
p = figure(plot_width=400, plot_height=400)
p.circle([1,2,3,4,5], [2,5,8,2,7], size=10)
-p.xaxis[0].ticker=FixedTicker(ticks=[2, 3.5, 4])
+p.xaxis.ticker = [2, 3.5, 4]
show(p)
|
{"golden_diff": "diff --git a/bokeh/models/axes.py b/bokeh/models/axes.py\n--- a/bokeh/models/axes.py\n+++ b/bokeh/models/axes.py\n@@ -5,12 +5,12 @@\n from __future__ import absolute_import\n \n from ..core.has_props import abstract\n-from ..core.properties import Auto, Datetime, Either, Enum, Float, Include, Instance, Int, Override, String, Tuple\n+from ..core.properties import Auto, Datetime, Dict, Either, Enum, Float, Include, Instance, Int, Override, Seq, String, Tuple\n from ..core.property_mixins import LineProps, TextProps\n \n from .formatters import BasicTickFormatter, CategoricalTickFormatter, DatetimeTickFormatter, LogTickFormatter, TickFormatter\n from .renderers import GuideRenderer\n-from .tickers import Ticker, BasicTicker, LogTicker, CategoricalTicker, DatetimeTicker\n+from .tickers import Ticker, BasicTicker, LogTicker, CategoricalTicker, DatetimeTicker, FixedTicker\n \n @abstract\n class Axis(GuideRenderer):\n@@ -37,7 +37,29 @@\n \n ticker = Instance(Ticker, help=\"\"\"\n A Ticker to use for computing locations of axis components.\n- \"\"\")\n+\n+ The property may also be passed a sequence of floating point numbers as\n+ a shorthand for creating and configuring a ``FixedTicker``, e.g. the\n+ following code\n+\n+ .. code-block:: python\n+\n+ from bokeh.plotting import figure\n+\n+ p = figure()\n+ p.xaxis.ticker = [10, 20, 37.4]\n+\n+ is equivalent to:\n+\n+ .. code-block:: python\n+\n+ from bokeh.plotting import figure\n+ from bokeh.models.tickers import FixedTicker\n+\n+ p = figure()\n+ p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])\n+\n+ \"\"\").accepts(Seq(Float), lambda ticks: FixedTicker(ticks=ticks))\n \n formatter = Instance(TickFormatter, help=\"\"\"\n A TickFormatter to use for formatting the visual appearance\n@@ -76,6 +98,11 @@\n number is supplied, the angle of the text is measured from horizontal.\n \"\"\")\n \n+ major_label_overrides = Dict(Either(Float, String), String, default={}, help=\"\"\"\n+ Provide explicit tick label values for specific tick locations that\n+ override normal formatting.\n+ \"\"\")\n+\n major_label_props = Include(TextProps, help=\"\"\"\n The %s of the major tick labels.\n \"\"\")\ndiff --git a/sphinx/source/docs/user_guide/examples/styling_fixed_ticker.py b/sphinx/source/docs/user_guide/examples/styling_fixed_ticker.py\n--- a/sphinx/source/docs/user_guide/examples/styling_fixed_ticker.py\n+++ b/sphinx/source/docs/user_guide/examples/styling_fixed_ticker.py\n@@ -1,11 +1,10 @@\n from bokeh.plotting import figure, output_file, show\n-from bokeh.models import FixedTicker\n \n-output_file(\"axes.html\")\n+output_file(\"fixed_ticks.html\")\n \n p = figure(plot_width=400, plot_height=400)\n p.circle([1,2,3,4,5], [2,5,8,2,7], size=10)\n \n-p.xaxis[0].ticker=FixedTicker(ticks=[2, 3.5, 4])\n+p.xaxis.ticker = [2, 3.5, 4]\n \n show(p)\n", "issue": "allow users to specify explicit tick labels\n`FixedTicker` allows users to specify fixed tick locations, but also need to allow users to specify explicit tick labels\n\n", "before_files": [{"content": "from bokeh.plotting import figure, output_file, show\nfrom bokeh.models import FixedTicker\n\noutput_file(\"axes.html\")\n\np = figure(plot_width=400, plot_height=400)\np.circle([1,2,3,4,5], [2,5,8,2,7], size=10)\n\np.xaxis[0].ticker=FixedTicker(ticks=[2, 3.5, 4])\n\nshow(p)\n", "path": "sphinx/source/docs/user_guide/examples/styling_fixed_ticker.py"}, {"content": "''' Guide renderers for various kinds of axes that can be added to\nBokeh plots\n\n'''\nfrom __future__ import absolute_import\n\nfrom ..core.has_props import abstract\nfrom ..core.properties import Auto, Datetime, Either, Enum, Float, Include, Instance, Int, Override, String, Tuple\nfrom ..core.property_mixins import LineProps, TextProps\n\nfrom .formatters import BasicTickFormatter, CategoricalTickFormatter, DatetimeTickFormatter, LogTickFormatter, TickFormatter\nfrom .renderers import GuideRenderer\nfrom .tickers import Ticker, BasicTicker, LogTicker, CategoricalTicker, DatetimeTicker\n\n@abstract\nclass Axis(GuideRenderer):\n ''' A base class that defines common properties for all axis types.\n\n '''\n\n bounds = Either(Auto, Tuple(Float, Float), Tuple(Datetime, Datetime), help=\"\"\"\n Bounds for the rendered axis. If unset, the axis will span the\n entire plot in the given dimension.\n \"\"\")\n\n x_range_name = String('default', help=\"\"\"\n A particular (named) x-range to use for computing screen\n locations when rendering an axis on the plot. If unset, use the\n default x-range.\n \"\"\")\n\n y_range_name = String('default', help=\"\"\"\n A particular (named) y-range to use for computing screen\n locations when rendering an axis on the plot. If unset, use the\n default y-range.\n \"\"\")\n\n ticker = Instance(Ticker, help=\"\"\"\n A Ticker to use for computing locations of axis components.\n \"\"\")\n\n formatter = Instance(TickFormatter, help=\"\"\"\n A TickFormatter to use for formatting the visual appearance\n of ticks.\n \"\"\")\n\n axis_label = String(default='', help=\"\"\"\n A text label for the axis, displayed parallel to the axis rule.\n\n .. note::\n LaTeX notation is not currently supported; please see\n :bokeh-issue:`647` to track progress or contribute.\n\n \"\"\")\n\n axis_label_standoff = Int(default=5, help=\"\"\"\n The distance in pixels that the axis labels should be offset\n from the tick labels.\n \"\"\")\n\n axis_label_props = Include(TextProps, help=\"\"\"\n The %s of the axis label.\n \"\"\")\n\n axis_label_text_font_size = Override(default={'value': \"10pt\"})\n\n axis_label_text_font_style = Override(default=\"italic\")\n\n major_label_standoff = Int(default=5, help=\"\"\"\n The distance in pixels that the major tick labels should be\n offset from the associated ticks.\n \"\"\")\n\n major_label_orientation = Either(Enum(\"horizontal\", \"vertical\"), Float, help=\"\"\"\n What direction the major label text should be oriented. If a\n number is supplied, the angle of the text is measured from horizontal.\n \"\"\")\n\n major_label_props = Include(TextProps, help=\"\"\"\n The %s of the major tick labels.\n \"\"\")\n\n major_label_text_align = Override(default=\"center\")\n\n major_label_text_baseline = Override(default=\"alphabetic\")\n\n major_label_text_font_size = Override(default={'value': \"8pt\"})\n\n axis_props = Include(LineProps, help=\"\"\"\n The %s of the axis line.\n \"\"\")\n\n major_tick_props = Include(LineProps, help=\"\"\"\n The %s of the major ticks.\n \"\"\")\n\n major_tick_in = Int(default=2, help=\"\"\"\n The distance in pixels that major ticks should extend into the\n main plot area.\n \"\"\")\n\n major_tick_out = Int(default=6, help=\"\"\"\n The distance in pixels that major ticks should extend out of the\n main plot area.\n \"\"\")\n\n minor_tick_props = Include(LineProps, help=\"\"\"\n The %s of the minor ticks.\n \"\"\")\n\n minor_tick_in = Int(default=0, help=\"\"\"\n The distance in pixels that minor ticks should extend into the\n main plot area.\n \"\"\")\n\n minor_tick_out = Int(default=4, help=\"\"\"\n The distance in pixels that major ticks should extend out of the\n main plot area.\n \"\"\")\n\n@abstract\nclass ContinuousAxis(Axis):\n ''' A base class for all numeric, non-categorical axes types.\n\n '''\n pass\n\nclass LinearAxis(ContinuousAxis):\n ''' An axis that picks nice numbers for tick locations on a\n linear scale. Configured with a ``BasicTickFormatter`` by default.\n\n '''\n ticker = Override(default=lambda: BasicTicker())\n\n formatter = Override(default=lambda: BasicTickFormatter())\n\nclass LogAxis(ContinuousAxis):\n ''' An axis that picks nice numbers for tick locations on a\n log scale. Configured with a ``LogTickFormatter`` by default.\n\n '''\n ticker = Override(default=lambda: LogTicker())\n\n formatter = Override(default=lambda: LogTickFormatter())\n\nclass CategoricalAxis(Axis):\n ''' An axis that picks evenly spaced tick locations for a\n collection of categories/factors.\n\n '''\n ticker = Override(default=lambda: CategoricalTicker())\n\n formatter = Override(default=lambda: CategoricalTickFormatter())\n\nclass DatetimeAxis(LinearAxis):\n ''' An LinearAxis that picks nice numbers for tick locations on\n a datetime scale. Configured with a ``DatetimeTickFormatter`` by\n default.\n\n '''\n\n ticker = Override(default=lambda: DatetimeTicker())\n\n formatter = Override(default=lambda: DatetimeTickFormatter())\n", "path": "bokeh/models/axes.py"}], "after_files": [{"content": "from bokeh.plotting import figure, output_file, show\n\noutput_file(\"fixed_ticks.html\")\n\np = figure(plot_width=400, plot_height=400)\np.circle([1,2,3,4,5], [2,5,8,2,7], size=10)\n\np.xaxis.ticker = [2, 3.5, 4]\n\nshow(p)\n", "path": "sphinx/source/docs/user_guide/examples/styling_fixed_ticker.py"}, {"content": "''' Guide renderers for various kinds of axes that can be added to\nBokeh plots\n\n'''\nfrom __future__ import absolute_import\n\nfrom ..core.has_props import abstract\nfrom ..core.properties import Auto, Datetime, Dict, Either, Enum, Float, Include, Instance, Int, Override, Seq, String, Tuple\nfrom ..core.property_mixins import LineProps, TextProps\n\nfrom .formatters import BasicTickFormatter, CategoricalTickFormatter, DatetimeTickFormatter, LogTickFormatter, TickFormatter\nfrom .renderers import GuideRenderer\nfrom .tickers import Ticker, BasicTicker, LogTicker, CategoricalTicker, DatetimeTicker, FixedTicker\n\n@abstract\nclass Axis(GuideRenderer):\n ''' A base class that defines common properties for all axis types.\n\n '''\n\n bounds = Either(Auto, Tuple(Float, Float), Tuple(Datetime, Datetime), help=\"\"\"\n Bounds for the rendered axis. If unset, the axis will span the\n entire plot in the given dimension.\n \"\"\")\n\n x_range_name = String('default', help=\"\"\"\n A particular (named) x-range to use for computing screen\n locations when rendering an axis on the plot. If unset, use the\n default x-range.\n \"\"\")\n\n y_range_name = String('default', help=\"\"\"\n A particular (named) y-range to use for computing screen\n locations when rendering an axis on the plot. If unset, use the\n default y-range.\n \"\"\")\n\n ticker = Instance(Ticker, help=\"\"\"\n A Ticker to use for computing locations of axis components.\n\n The property may also be passed a sequence of floating point numbers as\n a shorthand for creating and configuring a ``FixedTicker``, e.g. the\n following code\n\n .. code-block:: python\n\n from bokeh.plotting import figure\n\n p = figure()\n p.xaxis.ticker = [10, 20, 37.4]\n\n is equivalent to:\n\n .. code-block:: python\n\n from bokeh.plotting import figure\n from bokeh.models.tickers import FixedTicker\n\n p = figure()\n p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])\n\n \"\"\").accepts(Seq(Float), lambda ticks: FixedTicker(ticks=ticks))\n\n formatter = Instance(TickFormatter, help=\"\"\"\n A TickFormatter to use for formatting the visual appearance\n of ticks.\n \"\"\")\n\n axis_label = String(default='', help=\"\"\"\n A text label for the axis, displayed parallel to the axis rule.\n\n .. note::\n LaTeX notation is not currently supported; please see\n :bokeh-issue:`647` to track progress or contribute.\n\n \"\"\")\n\n axis_label_standoff = Int(default=5, help=\"\"\"\n The distance in pixels that the axis labels should be offset\n from the tick labels.\n \"\"\")\n\n axis_label_props = Include(TextProps, help=\"\"\"\n The %s of the axis label.\n \"\"\")\n\n axis_label_text_font_size = Override(default={'value': \"10pt\"})\n\n axis_label_text_font_style = Override(default=\"italic\")\n\n major_label_standoff = Int(default=5, help=\"\"\"\n The distance in pixels that the major tick labels should be\n offset from the associated ticks.\n \"\"\")\n\n major_label_orientation = Either(Enum(\"horizontal\", \"vertical\"), Float, help=\"\"\"\n What direction the major label text should be oriented. If a\n number is supplied, the angle of the text is measured from horizontal.\n \"\"\")\n\n major_label_overrides = Dict(Either(Float, String), String, default={}, help=\"\"\"\n Provide explicit tick label values for specific tick locations that\n override normal formatting.\n \"\"\")\n\n major_label_props = Include(TextProps, help=\"\"\"\n The %s of the major tick labels.\n \"\"\")\n\n major_label_text_align = Override(default=\"center\")\n\n major_label_text_baseline = Override(default=\"alphabetic\")\n\n major_label_text_font_size = Override(default={'value': \"8pt\"})\n\n axis_props = Include(LineProps, help=\"\"\"\n The %s of the axis line.\n \"\"\")\n\n major_tick_props = Include(LineProps, help=\"\"\"\n The %s of the major ticks.\n \"\"\")\n\n major_tick_in = Int(default=2, help=\"\"\"\n The distance in pixels that major ticks should extend into the\n main plot area.\n \"\"\")\n\n major_tick_out = Int(default=6, help=\"\"\"\n The distance in pixels that major ticks should extend out of the\n main plot area.\n \"\"\")\n\n minor_tick_props = Include(LineProps, help=\"\"\"\n The %s of the minor ticks.\n \"\"\")\n\n minor_tick_in = Int(default=0, help=\"\"\"\n The distance in pixels that minor ticks should extend into the\n main plot area.\n \"\"\")\n\n minor_tick_out = Int(default=4, help=\"\"\"\n The distance in pixels that major ticks should extend out of the\n main plot area.\n \"\"\")\n\n@abstract\nclass ContinuousAxis(Axis):\n ''' A base class for all numeric, non-categorical axes types.\n\n '''\n pass\n\nclass LinearAxis(ContinuousAxis):\n ''' An axis that picks nice numbers for tick locations on a\n linear scale. Configured with a ``BasicTickFormatter`` by default.\n\n '''\n ticker = Override(default=lambda: BasicTicker())\n\n formatter = Override(default=lambda: BasicTickFormatter())\n\nclass LogAxis(ContinuousAxis):\n ''' An axis that picks nice numbers for tick locations on a\n log scale. Configured with a ``LogTickFormatter`` by default.\n\n '''\n ticker = Override(default=lambda: LogTicker())\n\n formatter = Override(default=lambda: LogTickFormatter())\n\nclass CategoricalAxis(Axis):\n ''' An axis that picks evenly spaced tick locations for a\n collection of categories/factors.\n\n '''\n ticker = Override(default=lambda: CategoricalTicker())\n\n formatter = Override(default=lambda: CategoricalTickFormatter())\n\nclass DatetimeAxis(LinearAxis):\n ''' An LinearAxis that picks nice numbers for tick locations on\n a datetime scale. Configured with a ``DatetimeTickFormatter`` by\n default.\n\n '''\n\n ticker = Override(default=lambda: DatetimeTicker())\n\n formatter = Override(default=lambda: DatetimeTickFormatter())\n", "path": "bokeh/models/axes.py"}]}
| 2,003 | 780 |
gh_patches_debug_38760
|
rasdani/github-patches
|
git_diff
|
pyqtgraph__pyqtgraph-2536
|
We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
`pen` parameter fires `sigValueChanged` without setting value
This line should be `setValue` rather than emitting `sigValueChanged`:
https://github.com/pyqtgraph/pyqtgraph/blob/8be2d6a88edc1e26b1f6f85c47a72c400db9a28b/pyqtgraph/parametertree/parameterTypes/pen.py#L52
In all other parameters, the signal doesn't fire until after the value is set.
`pen` parameter fires `sigValueChanged` without setting value
This line should be `setValue` rather than emitting `sigValueChanged`:
https://github.com/pyqtgraph/pyqtgraph/blob/8be2d6a88edc1e26b1f6f85c47a72c400db9a28b/pyqtgraph/parametertree/parameterTypes/pen.py#L52
In all other parameters, the signal doesn't fire until after the value is set.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `pyqtgraph/parametertree/parameterTypes/pen.py`
Content:
```
1 import re
2 from contextlib import ExitStack
3
4 from . import GroupParameterItem
5 from .basetypes import GroupParameter, Parameter, ParameterItem
6 from .qtenum import QtEnumParameter
7 from ... import functions as fn
8 from ...Qt import QtCore
9 from ...SignalProxy import SignalProxy
10 from ...widgets.PenPreviewLabel import PenPreviewLabel
11
12 class PenParameterItem(GroupParameterItem):
13 def __init__(self, param, depth):
14 super().__init__(param, depth)
15 self.penLabel = PenPreviewLabel(param)
16
17 def treeWidgetChanged(self):
18 ParameterItem.treeWidgetChanged(self)
19 tw = self.treeWidget()
20 if tw is None:
21 return
22 tw.setItemWidget(self, 1, self.penLabel
23 )
24
25 class PenParameter(GroupParameter):
26 """
27 Controls the appearance of a QPen value.
28
29 When `saveState` is called, the value is encoded as (color, width, style, capStyle, joinStyle, cosmetic)
30
31 ============== ========================================================
32 **Options:**
33 color pen color, can be any argument accepted by :func:`~pyqtgraph.mkColor` (defaults to black)
34 width integer width >= 0 (defaults to 1)
35 style String version of QPenStyle enum, i.e. 'SolidLine' (default), 'DashLine', etc.
36 capStyle String version of QPenCapStyle enum, i.e. 'SquareCap' (default), 'RoundCap', etc.
37 joinStyle String version of QPenJoinStyle enum, i.e. 'BevelJoin' (default), 'RoundJoin', etc.
38 cosmetic Boolean, whether or not the pen is cosmetic (defaults to True)
39 ============== ========================================================
40 """
41 itemClass = PenParameterItem
42
43 def __init__(self, **opts):
44 self.pen = fn.mkPen(**opts)
45 children = self._makeChildren(self.pen)
46 if 'children' in opts:
47 raise KeyError('Cannot set "children" argument in Pen Parameter opts')
48 super().__init__(**opts, children=list(children))
49 self.valChangingProxy = SignalProxy(self.sigValueChanging, delay=1.0, slot=self._childrenFinishedChanging)
50
51 def _childrenFinishedChanging(self, paramAndValue):
52 self.sigValueChanged.emit(*paramAndValue)
53
54 def saveState(self, filter=None):
55 state = super().saveState(filter)
56 opts = state.pop('children')
57 state['value'] = tuple(o['value'] for o in opts.values())
58 return state
59
60 def restoreState(self, state, recursive=True, addChildren=True, removeChildren=True, blockSignals=True):
61 return super().restoreState(state, recursive=False, addChildren=False, removeChildren=False, blockSignals=blockSignals)
62
63 def _interpretValue(self, v):
64 return self.mkPen(v)
65
66 def setValue(self, value, blockSignal=None):
67 if not fn.eq(value, self.pen):
68 value = self.mkPen(value)
69 self.updateFromPen(self, value)
70 return super().setValue(self.pen, blockSignal)
71
72 def applyOptsToPen(self, **opts):
73 # Transform opts into a value for the current pen
74 paramNames = set(opts).intersection(self.names)
75 # Value should be overridden by opts
76 with self.treeChangeBlocker():
77 if 'value' in opts:
78 pen = self.mkPen(opts.pop('value'))
79 if not fn.eq(pen, self.pen):
80 self.updateFromPen(self, pen)
81 penOpts = {}
82 for kk in paramNames:
83 penOpts[kk] = opts[kk]
84 self[kk] = opts[kk]
85 return penOpts
86
87 def setOpts(self, **opts):
88 # Transform opts into a value
89 penOpts = self.applyOptsToPen(**opts)
90 if penOpts:
91 self.setValue(self.pen)
92 return super().setOpts(**opts)
93
94 def mkPen(self, *args, **kwargs):
95 """Thin wrapper around fn.mkPen which accepts the serialized state from saveState"""
96 if len(args) == 1 and isinstance(args[0], tuple) and len(args[0]) == len(self.childs):
97 opts = dict(zip(self.names, args[0]))
98 self.applyOptsToPen(**opts)
99 args = (self.pen,)
100 kwargs = {}
101 return fn.mkPen(*args, **kwargs)
102
103 def _makeChildren(self, boundPen=None):
104 cs = QtCore.Qt.PenCapStyle
105 js = QtCore.Qt.PenJoinStyle
106 ps = QtCore.Qt.PenStyle
107 param = Parameter.create(
108 name='Params', type='group', children=[
109 dict(name='color', type='color', value='k'),
110 dict(name='width', value=1, type='int', limits=[0, None]),
111 QtEnumParameter(ps, name='style', value='SolidLine'),
112 QtEnumParameter(cs, name='capStyle'),
113 QtEnumParameter(js, name='joinStyle'),
114 dict(name='cosmetic', type='bool', value=True)
115 ]
116 )
117
118 optsPen = boundPen or fn.mkPen()
119 for p in param:
120 name = p.name()
121 # Qt naming scheme uses isXXX for booleans
122 if isinstance(p.value(), bool):
123 attrName = f'is{name.title()}'
124 else:
125 attrName = name
126 default = getattr(optsPen, attrName)()
127 replace = r'\1 \2'
128 name = re.sub(r'(\w)([A-Z])', replace, name)
129 name = name.title().strip()
130 p.setOpts(title=name, default=default)
131
132 def penPropertyWrapper(propertySetter):
133 def tiePenPropToParam(_, value):
134 propertySetter(value)
135 self.sigValueChanging.emit(self, self.pen)
136
137 return tiePenPropToParam
138
139 if boundPen is not None:
140 self.updateFromPen(param, boundPen)
141 for p in param:
142 setter, setName = self._setterForParam(p.name(), boundPen, returnName=True)
143 # Instead, set the parameter which will signal the old setter
144 setattr(boundPen, setName, p.setValue)
145 newSetter = penPropertyWrapper(setter)
146 # Edge case: color picker uses a dialog with user interaction, so wait until full change there
147 if p.type() != 'color':
148 p.sigValueChanging.connect(newSetter)
149 # Force children to emulate self's value instead of being part of a tree like normal
150 p.sigValueChanged.disconnect(p._emitValueChanged)
151 # Some widgets (e.g. checkbox, combobox) don't emit 'changing' signals, so tie to 'changed' as well
152 p.sigValueChanged.connect(newSetter)
153
154 return param
155
156 @staticmethod
157 def _setterForParam(paramName, obj, returnName=False):
158 formatted = paramName[0].upper() + paramName[1:]
159 setter = getattr(obj, f'set{formatted}')
160 if returnName:
161 return setter, formatted
162 return setter
163
164 @staticmethod
165 def updateFromPen(param, pen):
166 """
167 Applies settings from a pen to either a Parameter or dict. The Parameter or dict must already
168 be populated with the relevant keys that can be found in `PenSelectorDialog.mkParam`.
169 """
170 stack = ExitStack()
171 if isinstance(param, Parameter):
172 names = param.names
173 # Block changes until all are finalized
174 stack.enter_context(param.treeChangeBlocker())
175 else:
176 names = param
177 for opt in names:
178 # Booleans have different naming convention
179 if isinstance(param[opt], bool):
180 attrName = f'is{opt.title()}'
181 else:
182 attrName = opt
183 param[opt] = getattr(pen, attrName)()
184 stack.close()
185
```
--- END FILES ---
Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.
Here is an example:
```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
if __name__ == "__main__":
- asyncio.run(run_async_server("."), debug=True)
+ asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
if __name__ == "__main__":
- server = run_sync_server(".")
+ server = run_sync_server()
server.shutdown()
```
|
diff --git a/pyqtgraph/parametertree/parameterTypes/pen.py b/pyqtgraph/parametertree/parameterTypes/pen.py
--- a/pyqtgraph/parametertree/parameterTypes/pen.py
+++ b/pyqtgraph/parametertree/parameterTypes/pen.py
@@ -1,26 +1,52 @@
import re
from contextlib import ExitStack
-from . import GroupParameterItem
+from . import GroupParameterItem, WidgetParameterItem
from .basetypes import GroupParameter, Parameter, ParameterItem
from .qtenum import QtEnumParameter
from ... import functions as fn
-from ...Qt import QtCore
+from ...Qt import QtCore, QtWidgets
from ...SignalProxy import SignalProxy
from ...widgets.PenPreviewLabel import PenPreviewLabel
class PenParameterItem(GroupParameterItem):
def __init__(self, param, depth):
+ self.defaultBtn = self.makeDefaultButton()
super().__init__(param, depth)
+ self.itemWidget = QtWidgets.QWidget()
+ layout = QtWidgets.QHBoxLayout()
+ layout.setContentsMargins(0, 0, 0, 0)
+ layout.setSpacing(2)
+
self.penLabel = PenPreviewLabel(param)
+ for child in self.penLabel, self.defaultBtn:
+ layout.addWidget(child)
+ self.itemWidget.setLayout(layout)
+
+ def optsChanged(self, param, opts):
+ if "enabled" in opts or "readonly" in opts:
+ self.updateDefaultBtn()
def treeWidgetChanged(self):
ParameterItem.treeWidgetChanged(self)
tw = self.treeWidget()
if tw is None:
return
- tw.setItemWidget(self, 1, self.penLabel
- )
+ tw.setItemWidget(self, 1, self.itemWidget)
+
+ defaultClicked = WidgetParameterItem.defaultClicked
+ makeDefaultButton = WidgetParameterItem.makeDefaultButton
+
+ def valueChanged(self, param, val):
+ self.updateDefaultBtn()
+
+ def updateDefaultBtn(self):
+ self.defaultBtn.setEnabled(
+ not self.param.valueIsDefault()
+ and self.param.opts["enabled"]
+ and self.param.writable()
+ )
+
class PenParameter(GroupParameter):
"""
@@ -49,7 +75,21 @@
self.valChangingProxy = SignalProxy(self.sigValueChanging, delay=1.0, slot=self._childrenFinishedChanging)
def _childrenFinishedChanging(self, paramAndValue):
- self.sigValueChanged.emit(*paramAndValue)
+ self.setValue(self.pen)
+
+ def setDefault(self, val):
+ pen = self._interpretValue(val)
+ with self.treeChangeBlocker():
+ # Block changes until all are finalized
+ for opt in self.names:
+ # Booleans have different naming convention
+ if isinstance(self[opt], bool):
+ attrName = f'is{opt.title()}'
+ else:
+ attrName = opt
+ self.child(opt).setDefault(getattr(pen, attrName)())
+ out = super().setDefault(val)
+ return out
def saveState(self, filter=None):
state = super().saveState(filter)
|
{"golden_diff": "diff --git a/pyqtgraph/parametertree/parameterTypes/pen.py b/pyqtgraph/parametertree/parameterTypes/pen.py\n--- a/pyqtgraph/parametertree/parameterTypes/pen.py\n+++ b/pyqtgraph/parametertree/parameterTypes/pen.py\n@@ -1,26 +1,52 @@\n import re\n from contextlib import ExitStack\n \n-from . import GroupParameterItem\n+from . import GroupParameterItem, WidgetParameterItem\n from .basetypes import GroupParameter, Parameter, ParameterItem\n from .qtenum import QtEnumParameter\n from ... import functions as fn\n-from ...Qt import QtCore\n+from ...Qt import QtCore, QtWidgets\n from ...SignalProxy import SignalProxy\n from ...widgets.PenPreviewLabel import PenPreviewLabel\n \n class PenParameterItem(GroupParameterItem):\n def __init__(self, param, depth):\n+ self.defaultBtn = self.makeDefaultButton()\n super().__init__(param, depth)\n+ self.itemWidget = QtWidgets.QWidget()\n+ layout = QtWidgets.QHBoxLayout()\n+ layout.setContentsMargins(0, 0, 0, 0)\n+ layout.setSpacing(2)\n+\n self.penLabel = PenPreviewLabel(param)\n+ for child in self.penLabel, self.defaultBtn:\n+ layout.addWidget(child)\n+ self.itemWidget.setLayout(layout)\n+\n+ def optsChanged(self, param, opts):\n+ if \"enabled\" in opts or \"readonly\" in opts:\n+ self.updateDefaultBtn()\n \n def treeWidgetChanged(self):\n ParameterItem.treeWidgetChanged(self)\n tw = self.treeWidget()\n if tw is None:\n return\n- tw.setItemWidget(self, 1, self.penLabel\n- )\n+ tw.setItemWidget(self, 1, self.itemWidget)\n+\n+ defaultClicked = WidgetParameterItem.defaultClicked\n+ makeDefaultButton = WidgetParameterItem.makeDefaultButton\n+\n+ def valueChanged(self, param, val):\n+ self.updateDefaultBtn()\n+\n+ def updateDefaultBtn(self):\n+ self.defaultBtn.setEnabled(\n+ not self.param.valueIsDefault()\n+ and self.param.opts[\"enabled\"]\n+ and self.param.writable()\n+ )\n+\n \n class PenParameter(GroupParameter):\n \"\"\"\n@@ -49,7 +75,21 @@\n self.valChangingProxy = SignalProxy(self.sigValueChanging, delay=1.0, slot=self._childrenFinishedChanging)\n \n def _childrenFinishedChanging(self, paramAndValue):\n- self.sigValueChanged.emit(*paramAndValue)\n+ self.setValue(self.pen)\n+\n+ def setDefault(self, val):\n+ pen = self._interpretValue(val)\n+ with self.treeChangeBlocker():\n+ # Block changes until all are finalized\n+ for opt in self.names:\n+ # Booleans have different naming convention\n+ if isinstance(self[opt], bool):\n+ attrName = f'is{opt.title()}'\n+ else:\n+ attrName = opt\n+ self.child(opt).setDefault(getattr(pen, attrName)())\n+ out = super().setDefault(val)\n+ return out\n \n def saveState(self, filter=None):\n state = super().saveState(filter)\n", "issue": "`pen` parameter fires `sigValueChanged` without setting value\nThis line should be `setValue` rather than emitting `sigValueChanged`:\r\nhttps://github.com/pyqtgraph/pyqtgraph/blob/8be2d6a88edc1e26b1f6f85c47a72c400db9a28b/pyqtgraph/parametertree/parameterTypes/pen.py#L52\r\n\r\nIn all other parameters, the signal doesn't fire until after the value is set.\n`pen` parameter fires `sigValueChanged` without setting value\nThis line should be `setValue` rather than emitting `sigValueChanged`:\r\nhttps://github.com/pyqtgraph/pyqtgraph/blob/8be2d6a88edc1e26b1f6f85c47a72c400db9a28b/pyqtgraph/parametertree/parameterTypes/pen.py#L52\r\n\r\nIn all other parameters, the signal doesn't fire until after the value is set.\n", "before_files": [{"content": "import re\nfrom contextlib import ExitStack\n\nfrom . import GroupParameterItem\nfrom .basetypes import GroupParameter, Parameter, ParameterItem\nfrom .qtenum import QtEnumParameter\nfrom ... import functions as fn\nfrom ...Qt import QtCore\nfrom ...SignalProxy import SignalProxy\nfrom ...widgets.PenPreviewLabel import PenPreviewLabel\n\nclass PenParameterItem(GroupParameterItem):\n def __init__(self, param, depth):\n super().__init__(param, depth)\n self.penLabel = PenPreviewLabel(param)\n\n def treeWidgetChanged(self):\n ParameterItem.treeWidgetChanged(self)\n tw = self.treeWidget()\n if tw is None:\n return\n tw.setItemWidget(self, 1, self.penLabel\n )\n\nclass PenParameter(GroupParameter):\n \"\"\"\n Controls the appearance of a QPen value.\n\n When `saveState` is called, the value is encoded as (color, width, style, capStyle, joinStyle, cosmetic)\n\n ============== ========================================================\n **Options:**\n color pen color, can be any argument accepted by :func:`~pyqtgraph.mkColor` (defaults to black)\n width integer width >= 0 (defaults to 1)\n style String version of QPenStyle enum, i.e. 'SolidLine' (default), 'DashLine', etc.\n capStyle String version of QPenCapStyle enum, i.e. 'SquareCap' (default), 'RoundCap', etc.\n joinStyle String version of QPenJoinStyle enum, i.e. 'BevelJoin' (default), 'RoundJoin', etc.\n cosmetic Boolean, whether or not the pen is cosmetic (defaults to True)\n ============== ========================================================\n \"\"\"\n itemClass = PenParameterItem\n\n def __init__(self, **opts):\n self.pen = fn.mkPen(**opts)\n children = self._makeChildren(self.pen)\n if 'children' in opts:\n raise KeyError('Cannot set \"children\" argument in Pen Parameter opts')\n super().__init__(**opts, children=list(children))\n self.valChangingProxy = SignalProxy(self.sigValueChanging, delay=1.0, slot=self._childrenFinishedChanging)\n\n def _childrenFinishedChanging(self, paramAndValue):\n self.sigValueChanged.emit(*paramAndValue)\n\n def saveState(self, filter=None):\n state = super().saveState(filter)\n opts = state.pop('children')\n state['value'] = tuple(o['value'] for o in opts.values())\n return state\n\n def restoreState(self, state, recursive=True, addChildren=True, removeChildren=True, blockSignals=True):\n return super().restoreState(state, recursive=False, addChildren=False, removeChildren=False, blockSignals=blockSignals)\n\n def _interpretValue(self, v):\n return self.mkPen(v)\n\n def setValue(self, value, blockSignal=None):\n if not fn.eq(value, self.pen):\n value = self.mkPen(value)\n self.updateFromPen(self, value)\n return super().setValue(self.pen, blockSignal)\n\n def applyOptsToPen(self, **opts):\n # Transform opts into a value for the current pen\n paramNames = set(opts).intersection(self.names)\n # Value should be overridden by opts\n with self.treeChangeBlocker():\n if 'value' in opts:\n pen = self.mkPen(opts.pop('value'))\n if not fn.eq(pen, self.pen):\n self.updateFromPen(self, pen)\n penOpts = {}\n for kk in paramNames:\n penOpts[kk] = opts[kk]\n self[kk] = opts[kk]\n return penOpts\n\n def setOpts(self, **opts):\n # Transform opts into a value\n penOpts = self.applyOptsToPen(**opts)\n if penOpts:\n self.setValue(self.pen)\n return super().setOpts(**opts)\n\n def mkPen(self, *args, **kwargs):\n \"\"\"Thin wrapper around fn.mkPen which accepts the serialized state from saveState\"\"\"\n if len(args) == 1 and isinstance(args[0], tuple) and len(args[0]) == len(self.childs):\n opts = dict(zip(self.names, args[0]))\n self.applyOptsToPen(**opts)\n args = (self.pen,)\n kwargs = {}\n return fn.mkPen(*args, **kwargs)\n\n def _makeChildren(self, boundPen=None):\n cs = QtCore.Qt.PenCapStyle\n js = QtCore.Qt.PenJoinStyle\n ps = QtCore.Qt.PenStyle\n param = Parameter.create(\n name='Params', type='group', children=[\n dict(name='color', type='color', value='k'),\n dict(name='width', value=1, type='int', limits=[0, None]),\n QtEnumParameter(ps, name='style', value='SolidLine'),\n QtEnumParameter(cs, name='capStyle'),\n QtEnumParameter(js, name='joinStyle'),\n dict(name='cosmetic', type='bool', value=True)\n ]\n )\n\n optsPen = boundPen or fn.mkPen()\n for p in param:\n name = p.name()\n # Qt naming scheme uses isXXX for booleans\n if isinstance(p.value(), bool):\n attrName = f'is{name.title()}'\n else:\n attrName = name\n default = getattr(optsPen, attrName)()\n replace = r'\\1 \\2'\n name = re.sub(r'(\\w)([A-Z])', replace, name)\n name = name.title().strip()\n p.setOpts(title=name, default=default)\n\n def penPropertyWrapper(propertySetter):\n def tiePenPropToParam(_, value):\n propertySetter(value)\n self.sigValueChanging.emit(self, self.pen)\n\n return tiePenPropToParam\n\n if boundPen is not None:\n self.updateFromPen(param, boundPen)\n for p in param:\n setter, setName = self._setterForParam(p.name(), boundPen, returnName=True)\n # Instead, set the parameter which will signal the old setter\n setattr(boundPen, setName, p.setValue)\n newSetter = penPropertyWrapper(setter)\n # Edge case: color picker uses a dialog with user interaction, so wait until full change there\n if p.type() != 'color':\n p.sigValueChanging.connect(newSetter)\n # Force children to emulate self's value instead of being part of a tree like normal\n p.sigValueChanged.disconnect(p._emitValueChanged)\n # Some widgets (e.g. checkbox, combobox) don't emit 'changing' signals, so tie to 'changed' as well\n p.sigValueChanged.connect(newSetter)\n\n return param\n\n @staticmethod\n def _setterForParam(paramName, obj, returnName=False):\n formatted = paramName[0].upper() + paramName[1:]\n setter = getattr(obj, f'set{formatted}')\n if returnName:\n return setter, formatted\n return setter\n\n @staticmethod\n def updateFromPen(param, pen):\n \"\"\"\n Applies settings from a pen to either a Parameter or dict. The Parameter or dict must already\n be populated with the relevant keys that can be found in `PenSelectorDialog.mkParam`.\n \"\"\"\n stack = ExitStack()\n if isinstance(param, Parameter):\n names = param.names\n # Block changes until all are finalized\n stack.enter_context(param.treeChangeBlocker())\n else:\n names = param\n for opt in names:\n # Booleans have different naming convention\n if isinstance(param[opt], bool):\n attrName = f'is{opt.title()}'\n else:\n attrName = opt\n param[opt] = getattr(pen, attrName)()\n stack.close()\n", "path": "pyqtgraph/parametertree/parameterTypes/pen.py"}], "after_files": [{"content": "import re\nfrom contextlib import ExitStack\n\nfrom . import GroupParameterItem, WidgetParameterItem\nfrom .basetypes import GroupParameter, Parameter, ParameterItem\nfrom .qtenum import QtEnumParameter\nfrom ... import functions as fn\nfrom ...Qt import QtCore, QtWidgets\nfrom ...SignalProxy import SignalProxy\nfrom ...widgets.PenPreviewLabel import PenPreviewLabel\n\nclass PenParameterItem(GroupParameterItem):\n def __init__(self, param, depth):\n self.defaultBtn = self.makeDefaultButton()\n super().__init__(param, depth)\n self.itemWidget = QtWidgets.QWidget()\n layout = QtWidgets.QHBoxLayout()\n layout.setContentsMargins(0, 0, 0, 0)\n layout.setSpacing(2)\n\n self.penLabel = PenPreviewLabel(param)\n for child in self.penLabel, self.defaultBtn:\n layout.addWidget(child)\n self.itemWidget.setLayout(layout)\n\n def optsChanged(self, param, opts):\n if \"enabled\" in opts or \"readonly\" in opts:\n self.updateDefaultBtn()\n\n def treeWidgetChanged(self):\n ParameterItem.treeWidgetChanged(self)\n tw = self.treeWidget()\n if tw is None:\n return\n tw.setItemWidget(self, 1, self.itemWidget)\n\n defaultClicked = WidgetParameterItem.defaultClicked\n makeDefaultButton = WidgetParameterItem.makeDefaultButton\n\n def valueChanged(self, param, val):\n self.updateDefaultBtn()\n\n def updateDefaultBtn(self):\n self.defaultBtn.setEnabled(\n not self.param.valueIsDefault()\n and self.param.opts[\"enabled\"]\n and self.param.writable()\n )\n\n\nclass PenParameter(GroupParameter):\n \"\"\"\n Controls the appearance of a QPen value.\n\n When `saveState` is called, the value is encoded as (color, width, style, capStyle, joinStyle, cosmetic)\n\n ============== ========================================================\n **Options:**\n color pen color, can be any argument accepted by :func:`~pyqtgraph.mkColor` (defaults to black)\n width integer width >= 0 (defaults to 1)\n style String version of QPenStyle enum, i.e. 'SolidLine' (default), 'DashLine', etc.\n capStyle String version of QPenCapStyle enum, i.e. 'SquareCap' (default), 'RoundCap', etc.\n joinStyle String version of QPenJoinStyle enum, i.e. 'BevelJoin' (default), 'RoundJoin', etc.\n cosmetic Boolean, whether or not the pen is cosmetic (defaults to True)\n ============== ========================================================\n \"\"\"\n itemClass = PenParameterItem\n\n def __init__(self, **opts):\n self.pen = fn.mkPen(**opts)\n children = self._makeChildren(self.pen)\n if 'children' in opts:\n raise KeyError('Cannot set \"children\" argument in Pen Parameter opts')\n super().__init__(**opts, children=list(children))\n self.valChangingProxy = SignalProxy(self.sigValueChanging, delay=1.0, slot=self._childrenFinishedChanging)\n\n def _childrenFinishedChanging(self, paramAndValue):\n self.setValue(self.pen)\n\n def setDefault(self, val):\n pen = self._interpretValue(val)\n with self.treeChangeBlocker():\n # Block changes until all are finalized\n for opt in self.names:\n # Booleans have different naming convention\n if isinstance(self[opt], bool):\n attrName = f'is{opt.title()}'\n else:\n attrName = opt\n self.child(opt).setDefault(getattr(pen, attrName)())\n out = super().setDefault(val)\n return out\n\n def saveState(self, filter=None):\n state = super().saveState(filter)\n opts = state.pop('children')\n state['value'] = tuple(o['value'] for o in opts.values())\n return state\n\n def restoreState(self, state, recursive=True, addChildren=True, removeChildren=True, blockSignals=True):\n return super().restoreState(state, recursive=False, addChildren=False, removeChildren=False, blockSignals=blockSignals)\n\n def _interpretValue(self, v):\n return self.mkPen(v)\n\n def setValue(self, value, blockSignal=None):\n if not fn.eq(value, self.pen):\n value = self.mkPen(value)\n self.updateFromPen(self, value)\n return super().setValue(self.pen, blockSignal)\n\n def applyOptsToPen(self, **opts):\n # Transform opts into a value for the current pen\n paramNames = set(opts).intersection(self.names)\n # Value should be overridden by opts\n with self.treeChangeBlocker():\n if 'value' in opts:\n pen = self.mkPen(opts.pop('value'))\n if not fn.eq(pen, self.pen):\n self.updateFromPen(self, pen)\n penOpts = {}\n for kk in paramNames:\n penOpts[kk] = opts[kk]\n self[kk] = opts[kk]\n return penOpts\n\n def setOpts(self, **opts):\n # Transform opts into a value\n penOpts = self.applyOptsToPen(**opts)\n if penOpts:\n self.setValue(self.pen)\n return super().setOpts(**opts)\n\n def mkPen(self, *args, **kwargs):\n \"\"\"Thin wrapper around fn.mkPen which accepts the serialized state from saveState\"\"\"\n if len(args) == 1 and isinstance(args[0], tuple) and len(args[0]) == len(self.childs):\n opts = dict(zip(self.names, args[0]))\n self.applyOptsToPen(**opts)\n args = (self.pen,)\n kwargs = {}\n return fn.mkPen(*args, **kwargs)\n\n def _makeChildren(self, boundPen=None):\n cs = QtCore.Qt.PenCapStyle\n js = QtCore.Qt.PenJoinStyle\n ps = QtCore.Qt.PenStyle\n param = Parameter.create(\n name='Params', type='group', children=[\n dict(name='color', type='color', value='k'),\n dict(name='width', value=1, type='int', limits=[0, None]),\n QtEnumParameter(ps, name='style', value='SolidLine'),\n QtEnumParameter(cs, name='capStyle'),\n QtEnumParameter(js, name='joinStyle'),\n dict(name='cosmetic', type='bool', value=True)\n ]\n )\n\n optsPen = boundPen or fn.mkPen()\n for p in param:\n name = p.name()\n # Qt naming scheme uses isXXX for booleans\n if isinstance(p.value(), bool):\n attrName = f'is{name.title()}'\n else:\n attrName = name\n default = getattr(optsPen, attrName)()\n replace = r'\\1 \\2'\n name = re.sub(r'(\\w)([A-Z])', replace, name)\n name = name.title().strip()\n p.setOpts(title=name, default=default)\n\n def penPropertyWrapper(propertySetter):\n def tiePenPropToParam(_, value):\n propertySetter(value)\n self.sigValueChanging.emit(self, self.pen)\n\n return tiePenPropToParam\n\n if boundPen is not None:\n self.updateFromPen(param, boundPen)\n for p in param:\n setter, setName = self._setterForParam(p.name(), boundPen, returnName=True)\n # Instead, set the parameter which will signal the old setter\n setattr(boundPen, setName, p.setValue)\n newSetter = penPropertyWrapper(setter)\n # Edge case: color picker uses a dialog with user interaction, so wait until full change there\n if p.type() != 'color':\n p.sigValueChanging.connect(newSetter)\n # Force children to emulate self's value instead of being part of a tree like normal\n p.sigValueChanged.disconnect(p._emitValueChanged)\n # Some widgets (e.g. checkbox, combobox) don't emit 'changing' signals, so tie to 'changed' as well\n p.sigValueChanged.connect(newSetter)\n\n return param\n\n @staticmethod\n def _setterForParam(paramName, obj, returnName=False):\n formatted = paramName[0].upper() + paramName[1:]\n setter = getattr(obj, f'set{formatted}')\n if returnName:\n return setter, formatted\n return setter\n\n @staticmethod\n def updateFromPen(param, pen):\n \"\"\"\n Applies settings from a pen to either a Parameter or dict. The Parameter or dict must already\n be populated with the relevant keys that can be found in `PenSelectorDialog.mkParam`.\n \"\"\"\n stack = ExitStack()\n if isinstance(param, Parameter):\n names = param.names\n # Block changes until all are finalized\n stack.enter_context(param.treeChangeBlocker())\n else:\n names = param\n for opt in names:\n # Booleans have different naming convention\n if isinstance(param[opt], bool):\n attrName = f'is{opt.title()}'\n else:\n attrName = opt\n param[opt] = getattr(pen, attrName)()\n stack.close()\n", "path": "pyqtgraph/parametertree/parameterTypes/pen.py"}]}
| 2,607 | 700 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.