problem_id
stringlengths 18
21
| source
stringclasses 1
value | task_type
stringclasses 1
value | in_source_id
stringlengths 13
54
| prompt
stringlengths 1.28k
64.2k
| golden_diff
stringlengths 166
811
| verification_info
stringlengths 604
118k
|
|---|---|---|---|---|---|---|
gh_patches_debug_200 | rasdani/github-patches | git_diff | DjangoGirls__djangogirls-153 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Error when there is more than one form for a 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: `applications/views.py`
Content:
```
1 import csv
2 from django.shortcuts import render, redirect, get_object_or_404
3 from django.http import Http404, JsonResponse, HttpResponse
4 from django.views.decorators.csrf import csrf_exempt
5 from django.contrib import messages
6 from django.template.defaultfilters import striptags
7
8 from core.utils import get_event_page
9 from core.models import EventPageMenu
10 from .decorators import organiser_only
11 from .models import Application, Form, Score, Question, Email
12 from .forms import ApplicationForm, ScoreForm, EmailForm
13 from .utils import get_applications_for_page, get_organiser_menu, random_application
14
15
16 def apply(request, city):
17 page = get_event_page(city, request.user.is_authenticated(), False)
18 if not page:
19 raise Http404
20 elif type(page) == tuple:
21 return render(
22 request, "event_not_live.html",
23 {'city': page[0], 'past': page[1]}
24 )
25
26 try:
27 form_obj = Form.objects.get(page=page)
28 except Form.DoesNotExist:
29 return redirect('core:event', city)
30
31 organiser = request.user in page.event.team.all() or request.user.is_superuser
32
33 if not organiser and not form_obj.application_open:
34 return redirect('core:event', city)
35
36 menu = EventPageMenu.objects.filter(page=page)
37
38 form = ApplicationForm(
39 request.POST or None, questions=form_obj.question_set.all()
40 )
41
42 if form.is_valid():
43 form.save(form=form_obj)
44 messages.success(request, "Yay! Your application has been saved. You'll hear from us soon!")
45
46 return render(request, 'apply.html', {
47 'page': page,
48 'menu': menu,
49 'form_obj': form_obj,
50 })
51
52 number_of_email_questions = Question.objects.filter(question_type='email', form=form_obj).count()
53
54 return render(request, 'apply.html', {
55 'page': page,
56 'menu': menu,
57 'form_obj': form_obj,
58 'form': form,
59 'number_of_email_questions': number_of_email_questions,
60 })
61
62
63 @organiser_only
64 def applications(request, city):
65 """
66 Display a list of applications for this city.
67 If 'state' get parameter is passed, filter the list.
68 If 'order' get parameter is passed, order the list.
69 e.g /applications/?state=accepted&state=rejected
70 """
71 state = request.GET.getlist('state', None)
72 rsvp_status = request.GET.getlist('rsvp_status', None)
73 page = get_event_page(city, request.user.is_authenticated(), False)
74 order = request.GET.get('order', None)
75 try:
76 applications = get_applications_for_page(page, state, rsvp_status, order)
77 except:
78 return redirect('core:event', city=city)
79
80 return render(request, 'applications.html', {
81 'page': page,
82 'applications': applications,
83 'all_applications_count': Application.objects.filter(form__page=page).count(),
84 'order': order,
85 'menu': get_organiser_menu(city),
86 })
87
88
89 @organiser_only
90 def applications_csv(request, city):
91 """
92 Download a csv of applications for this city.
93 """
94 page = get_event_page(city, request.user.is_authenticated(), False)
95 try:
96 applications = get_applications_for_page(page, None, None, None)
97 except:
98 return redirect('core:event', city=city)
99
100 response = HttpResponse(content_type='text/csv')
101 response['Content-Disposition'] = u'attachment; filename="{}.csv"'.format(city)
102 writer = csv.writer(response)
103 csv_header = ["Application Number", "Application State", "RSVP Status", "Average Score"]
104 questions = page.form_set.first().question_set.values_list('title', flat=True)
105 csv_header.extend(map(striptags, questions))
106 writer.writerow(csv_header)
107 for app in applications:
108 score = app.average_score if app.is_scored_by_user(request.user) else '(hidden)'
109 app_info = [app.number, app.state, app.rsvp_status, score]
110 app_info.extend(app.answer_set.values_list('answer', flat=True))
111 writer.writerow(app_info)
112 return response
113
114
115 @organiser_only
116 def application_detail(request, city, app_id):
117 """
118 Display the details of a single application.
119 """
120 application = Application.objects.get(pk=app_id)
121 try:
122 score = Score.objects.get(
123 user=request.user, application=application)
124 except Score.DoesNotExist:
125 score = None
126 score_form = ScoreForm(instance=score)
127 page = get_event_page(city, request.user.is_authenticated(), False)
128 all_scores = Score.objects.filter(application=application)
129
130 if request.POST:
131 # Handle score submission.
132 score_form = ScoreForm(request.POST, instance=score)
133 if score_form.is_valid():
134 score = score_form.save(commit=False)
135 score.user = request.user
136 score.application = application
137 score.save()
138
139 if request.POST.get('random'):
140 # Go to a new random application.
141 new_app = random_application(request, page, application)
142 if new_app:
143 return redirect(
144 'applications:application_detail', city, new_app.id)
145 return redirect('applications:applications', city)
146
147 return render(request, 'application_detail.html', {
148 'page': page,
149 'application': application,
150 'form': application.form,
151 'scores': all_scores,
152 'user_score': score,
153 'score_form': score_form,
154 'menu': get_organiser_menu(city),
155 })
156
157
158 @organiser_only
159 def communication(request, city):
160 """
161 Send emails to applicants and attendees
162 """
163 page = get_event_page(city, request.user.is_authenticated(), False)
164
165 emails = Email.objects.filter(form__page=page).order_by('-created')
166
167 return render(request, 'communication.html', {
168 'page': page,
169 'menu': get_organiser_menu(city),
170 'emails': emails,
171 })
172
173
174 @organiser_only
175 def compose_email(request, city, email_id=None):
176 """
177 Create new email or update email to applicants and attendees
178 """
179 page = get_event_page(city, request.user.is_authenticated(), False)
180 form_obj = get_object_or_404(Form, page=page)
181 emailmsg = None if not email_id else get_object_or_404(Email, form__page=page, id=email_id)
182
183 form = EmailForm(request.POST or None, instance=emailmsg, initial={
184 'author': request.user, 'form': form_obj
185 })
186 if form.is_valid() and request.method == 'POST':
187 obj = form.save(commit=False)
188 obj.author = request.user
189 obj.form = form_obj
190 obj.save()
191 if request.POST.get('send'):
192 obj.send()
193 return redirect('applications:communication', city)
194
195 return render(request, 'compose_email.html', {
196 'page': page,
197 'menu': get_organiser_menu(city),
198 'form': form,
199 'email': emailmsg,
200 })
201
202
203 @organiser_only
204 @csrf_exempt
205 def change_state(request, city):
206 """
207 Change the state of Applicaction(s). Use it like this:
208 e.g /applications/?state=accepted&application=1&application=2&application=3
209 """
210 state = request.POST.get('state', None)
211 applications = request.POST.getlist('application', None)
212 page = get_event_page(city, request.user.is_authenticated(), False)
213
214 if not state or not applications:
215 return JsonResponse({'error': 'Missing parameters'})
216
217 applications = Application.objects.filter(id__in=applications, form__page=page)
218 applications.update(state=state)
219
220 ids = applications.values_list('id', flat=True)
221 ids = [str(id) for id in ids]
222
223 return JsonResponse({'message': 'Applications have been updated', 'updated': ids})
224
225
226 @organiser_only
227 @csrf_exempt
228 def change_rsvp(request, city):
229 """
230 Change the rsvp_status of Applicaction(s). Use it like this:
231 e.g /applications/?rsvp=yes&application=1&application=2&application=3
232 """
233 rsvp_status = request.POST.get('rsvp_status', None)
234 applications = request.POST.getlist('application', None)
235 page = get_event_page(city, request.user.is_authenticated(), False)
236
237 if not rsvp_status or not applications:
238 return JsonResponse({'error': 'Missing parameters'})
239
240 applications = Application.objects.filter(id__in=applications, form__page=page)
241 applications.update(rsvp_status=rsvp_status)
242
243 ids = applications.values_list('id', flat=True)
244 ids = [str(id) for id in ids]
245
246 return JsonResponse({'message': 'Applications have been updated', 'updated': ids})
247
248
249 def rsvp(request, city, code):
250 page = get_event_page(city, request.user.is_authenticated(), False)
251 if not page:
252 raise Http404
253 elif type(page) == tuple:
254 return render(
255 request, "event_not_live.html",
256 {'city': page[0], 'past': page[1]}
257 )
258
259 application, rsvp = Application.get_by_rsvp_code(code, page)
260 if not application:
261 return redirect('/{}/'.format(page.url))
262
263 application.rsvp_status = rsvp
264 application.save()
265
266 if rsvp == 'yes':
267 message = "Your answer has been saved, your participation in the workshop has been confirmed! We can't wait to meet you. We will be in touch with details soon."
268 else:
269 message = "Your answer has been saved, thanks for letting us know. Your spot will be assigned to another person on the waiting list."
270 messages.success(request, message)
271
272 menu = EventPageMenu.objects.filter(page=page)
273
274 return render(request, 'apply.html', {
275 'page': page,
276 'menu': menu,
277 })
278
```
--- 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/applications/views.py b/applications/views.py
--- a/applications/views.py
+++ b/applications/views.py
@@ -24,7 +24,7 @@
)
try:
- form_obj = Form.objects.get(page=page)
+ form_obj = Form.objects.filter(page=page).first()
except Form.DoesNotExist:
return redirect('core:event', city)
| {"golden_diff": "diff --git a/applications/views.py b/applications/views.py\n--- a/applications/views.py\n+++ b/applications/views.py\n@@ -24,7 +24,7 @@\n )\n \n try:\n- form_obj = Form.objects.get(page=page)\n+ form_obj = Form.objects.filter(page=page).first()\n except Form.DoesNotExist:\n return redirect('core:event', city)\n", "issue": "Error when there is more than one form for a page\n\n\n", "before_files": [{"content": "import csv\nfrom django.shortcuts import render, redirect, get_object_or_404\nfrom django.http import Http404, JsonResponse, HttpResponse\nfrom django.views.decorators.csrf import csrf_exempt\nfrom django.contrib import messages\nfrom django.template.defaultfilters import striptags\n\nfrom core.utils import get_event_page\nfrom core.models import EventPageMenu\nfrom .decorators import organiser_only\nfrom .models import Application, Form, Score, Question, Email\nfrom .forms import ApplicationForm, ScoreForm, EmailForm\nfrom .utils import get_applications_for_page, get_organiser_menu, random_application\n\n\ndef apply(request, city):\n page = get_event_page(city, request.user.is_authenticated(), False)\n if not page:\n raise Http404\n elif type(page) == tuple:\n return render(\n request, \"event_not_live.html\",\n {'city': page[0], 'past': page[1]}\n )\n\n try:\n form_obj = Form.objects.get(page=page)\n except Form.DoesNotExist:\n return redirect('core:event', city)\n\n organiser = request.user in page.event.team.all() or request.user.is_superuser\n\n if not organiser and not form_obj.application_open:\n return redirect('core:event', city)\n\n menu = EventPageMenu.objects.filter(page=page)\n\n form = ApplicationForm(\n request.POST or None, questions=form_obj.question_set.all()\n )\n\n if form.is_valid():\n form.save(form=form_obj)\n messages.success(request, \"Yay! Your application has been saved. You'll hear from us soon!\")\n\n return render(request, 'apply.html', {\n 'page': page,\n 'menu': menu,\n 'form_obj': form_obj,\n })\n\n number_of_email_questions = Question.objects.filter(question_type='email', form=form_obj).count()\n\n return render(request, 'apply.html', {\n 'page': page,\n 'menu': menu,\n 'form_obj': form_obj,\n 'form': form,\n 'number_of_email_questions': number_of_email_questions,\n })\n\n\n@organiser_only\ndef applications(request, city):\n \"\"\"\n Display a list of applications for this city.\n If 'state' get parameter is passed, filter the list.\n If 'order' get parameter is passed, order the list.\n e.g /applications/?state=accepted&state=rejected\n \"\"\"\n state = request.GET.getlist('state', None)\n rsvp_status = request.GET.getlist('rsvp_status', None)\n page = get_event_page(city, request.user.is_authenticated(), False)\n order = request.GET.get('order', None)\n try:\n applications = get_applications_for_page(page, state, rsvp_status, order)\n except:\n return redirect('core:event', city=city)\n\n return render(request, 'applications.html', {\n 'page': page,\n 'applications': applications,\n 'all_applications_count': Application.objects.filter(form__page=page).count(),\n 'order': order,\n 'menu': get_organiser_menu(city),\n })\n\n\n@organiser_only\ndef applications_csv(request, city):\n \"\"\"\n Download a csv of applications for this city.\n \"\"\"\n page = get_event_page(city, request.user.is_authenticated(), False)\n try:\n applications = get_applications_for_page(page, None, None, None)\n except:\n return redirect('core:event', city=city)\n\n response = HttpResponse(content_type='text/csv')\n response['Content-Disposition'] = u'attachment; filename=\"{}.csv\"'.format(city)\n writer = csv.writer(response)\n csv_header = [\"Application Number\", \"Application State\", \"RSVP Status\", \"Average Score\"]\n questions = page.form_set.first().question_set.values_list('title', flat=True)\n csv_header.extend(map(striptags, questions))\n writer.writerow(csv_header)\n for app in applications:\n score = app.average_score if app.is_scored_by_user(request.user) else '(hidden)'\n app_info = [app.number, app.state, app.rsvp_status, score]\n app_info.extend(app.answer_set.values_list('answer', flat=True))\n writer.writerow(app_info)\n return response\n\n\n@organiser_only\ndef application_detail(request, city, app_id):\n \"\"\"\n Display the details of a single application.\n \"\"\"\n application = Application.objects.get(pk=app_id)\n try:\n score = Score.objects.get(\n user=request.user, application=application)\n except Score.DoesNotExist:\n score = None\n score_form = ScoreForm(instance=score)\n page = get_event_page(city, request.user.is_authenticated(), False)\n all_scores = Score.objects.filter(application=application)\n\n if request.POST:\n # Handle score submission.\n score_form = ScoreForm(request.POST, instance=score)\n if score_form.is_valid():\n score = score_form.save(commit=False)\n score.user = request.user\n score.application = application\n score.save()\n\n if request.POST.get('random'):\n # Go to a new random application.\n new_app = random_application(request, page, application)\n if new_app:\n return redirect(\n 'applications:application_detail', city, new_app.id)\n return redirect('applications:applications', city)\n\n return render(request, 'application_detail.html', {\n 'page': page,\n 'application': application,\n 'form': application.form,\n 'scores': all_scores,\n 'user_score': score,\n 'score_form': score_form,\n 'menu': get_organiser_menu(city),\n })\n\n\n@organiser_only\ndef communication(request, city):\n \"\"\"\n Send emails to applicants and attendees\n \"\"\"\n page = get_event_page(city, request.user.is_authenticated(), False)\n\n emails = Email.objects.filter(form__page=page).order_by('-created')\n\n return render(request, 'communication.html', {\n 'page': page,\n 'menu': get_organiser_menu(city),\n 'emails': emails,\n })\n\n\n@organiser_only\ndef compose_email(request, city, email_id=None):\n \"\"\"\n Create new email or update email to applicants and attendees\n \"\"\"\n page = get_event_page(city, request.user.is_authenticated(), False)\n form_obj = get_object_or_404(Form, page=page)\n emailmsg = None if not email_id else get_object_or_404(Email, form__page=page, id=email_id)\n\n form = EmailForm(request.POST or None, instance=emailmsg, initial={\n 'author': request.user, 'form': form_obj\n })\n if form.is_valid() and request.method == 'POST':\n obj = form.save(commit=False)\n obj.author = request.user\n obj.form = form_obj\n obj.save()\n if request.POST.get('send'):\n obj.send()\n return redirect('applications:communication', city)\n\n return render(request, 'compose_email.html', {\n 'page': page,\n 'menu': get_organiser_menu(city),\n 'form': form,\n 'email': emailmsg,\n })\n\n\n@organiser_only\n@csrf_exempt\ndef change_state(request, city):\n \"\"\"\n Change the state of Applicaction(s). Use it like this:\n e.g /applications/?state=accepted&application=1&application=2&application=3\n \"\"\"\n state = request.POST.get('state', None)\n applications = request.POST.getlist('application', None)\n page = get_event_page(city, request.user.is_authenticated(), False)\n\n if not state or not applications:\n return JsonResponse({'error': 'Missing parameters'})\n\n applications = Application.objects.filter(id__in=applications, form__page=page)\n applications.update(state=state)\n\n ids = applications.values_list('id', flat=True)\n ids = [str(id) for id in ids]\n\n return JsonResponse({'message': 'Applications have been updated', 'updated': ids})\n\n\n@organiser_only\n@csrf_exempt\ndef change_rsvp(request, city):\n \"\"\"\n Change the rsvp_status of Applicaction(s). Use it like this:\n e.g /applications/?rsvp=yes&application=1&application=2&application=3\n \"\"\"\n rsvp_status = request.POST.get('rsvp_status', None)\n applications = request.POST.getlist('application', None)\n page = get_event_page(city, request.user.is_authenticated(), False)\n\n if not rsvp_status or not applications:\n return JsonResponse({'error': 'Missing parameters'})\n\n applications = Application.objects.filter(id__in=applications, form__page=page)\n applications.update(rsvp_status=rsvp_status)\n\n ids = applications.values_list('id', flat=True)\n ids = [str(id) for id in ids]\n\n return JsonResponse({'message': 'Applications have been updated', 'updated': ids})\n\n\ndef rsvp(request, city, code):\n page = get_event_page(city, request.user.is_authenticated(), False)\n if not page:\n raise Http404\n elif type(page) == tuple:\n return render(\n request, \"event_not_live.html\",\n {'city': page[0], 'past': page[1]}\n )\n\n application, rsvp = Application.get_by_rsvp_code(code, page)\n if not application:\n return redirect('/{}/'.format(page.url))\n\n application.rsvp_status = rsvp\n application.save()\n\n if rsvp == 'yes':\n message = \"Your answer has been saved, your participation in the workshop has been confirmed! We can't wait to meet you. We will be in touch with details soon.\"\n else:\n message = \"Your answer has been saved, thanks for letting us know. Your spot will be assigned to another person on the waiting list.\"\n messages.success(request, message)\n\n menu = EventPageMenu.objects.filter(page=page)\n\n return render(request, 'apply.html', {\n 'page': page,\n 'menu': menu,\n })\n", "path": "applications/views.py"}], "after_files": [{"content": "import csv\nfrom django.shortcuts import render, redirect, get_object_or_404\nfrom django.http import Http404, JsonResponse, HttpResponse\nfrom django.views.decorators.csrf import csrf_exempt\nfrom django.contrib import messages\nfrom django.template.defaultfilters import striptags\n\nfrom core.utils import get_event_page\nfrom core.models import EventPageMenu\nfrom .decorators import organiser_only\nfrom .models import Application, Form, Score, Question, Email\nfrom .forms import ApplicationForm, ScoreForm, EmailForm\nfrom .utils import get_applications_for_page, get_organiser_menu, random_application\n\n\ndef apply(request, city):\n page = get_event_page(city, request.user.is_authenticated(), False)\n if not page:\n raise Http404\n elif type(page) == tuple:\n return render(\n request, \"event_not_live.html\",\n {'city': page[0], 'past': page[1]}\n )\n\n try:\n form_obj = Form.objects.filter(page=page).first()\n except Form.DoesNotExist:\n return redirect('core:event', city)\n\n organiser = request.user in page.event.team.all() or request.user.is_superuser\n\n if not organiser and not form_obj.application_open:\n return redirect('core:event', city)\n\n menu = EventPageMenu.objects.filter(page=page)\n\n form = ApplicationForm(\n request.POST or None, questions=form_obj.question_set.all()\n )\n\n if form.is_valid():\n form.save(form=form_obj)\n messages.success(request, \"Yay! Your application has been saved. You'll hear from us soon!\")\n\n return render(request, 'apply.html', {\n 'page': page,\n 'menu': menu,\n 'form_obj': form_obj,\n })\n\n number_of_email_questions = Question.objects.filter(question_type='email', form=form_obj).count()\n\n return render(request, 'apply.html', {\n 'page': page,\n 'menu': menu,\n 'form_obj': form_obj,\n 'form': form,\n 'number_of_email_questions': number_of_email_questions,\n })\n\n\n@organiser_only\ndef applications(request, city):\n \"\"\"\n Display a list of applications for this city.\n If 'state' get parameter is passed, filter the list.\n If 'order' get parameter is passed, order the list.\n e.g /applications/?state=accepted&state=rejected\n \"\"\"\n state = request.GET.getlist('state', None)\n rsvp_status = request.GET.getlist('rsvp_status', None)\n page = get_event_page(city, request.user.is_authenticated(), False)\n order = request.GET.get('order', None)\n try:\n applications = get_applications_for_page(page, state, rsvp_status, order)\n except:\n return redirect('core:event', city=city)\n\n return render(request, 'applications.html', {\n 'page': page,\n 'applications': applications,\n 'all_applications_count': Application.objects.filter(form__page=page).count(),\n 'order': order,\n 'menu': get_organiser_menu(city),\n })\n\n\n@organiser_only\ndef applications_csv(request, city):\n \"\"\"\n Download a csv of applications for this city.\n \"\"\"\n page = get_event_page(city, request.user.is_authenticated(), False)\n try:\n applications = get_applications_for_page(page, None, None, None)\n except:\n return redirect('core:event', city=city)\n\n response = HttpResponse(content_type='text/csv')\n response['Content-Disposition'] = u'attachment; filename=\"{}.csv\"'.format(city)\n writer = csv.writer(response)\n csv_header = [\"Application Number\", \"Application State\", \"RSVP Status\", \"Average Score\"]\n questions = page.form_set.first().question_set.values_list('title', flat=True)\n csv_header.extend(map(striptags, questions))\n writer.writerow(csv_header)\n for app in applications:\n score = app.average_score if app.is_scored_by_user(request.user) else '(hidden)'\n app_info = [app.number, app.state, app.rsvp_status, score]\n app_info.extend(app.answer_set.values_list('answer', flat=True))\n writer.writerow(app_info)\n return response\n\n\n@organiser_only\ndef application_detail(request, city, app_id):\n \"\"\"\n Display the details of a single application.\n \"\"\"\n application = Application.objects.get(pk=app_id)\n try:\n score = Score.objects.get(\n user=request.user, application=application)\n except Score.DoesNotExist:\n score = None\n score_form = ScoreForm(instance=score)\n page = get_event_page(city, request.user.is_authenticated(), False)\n all_scores = Score.objects.filter(application=application)\n\n if request.POST:\n # Handle score submission.\n score_form = ScoreForm(request.POST, instance=score)\n if score_form.is_valid():\n score = score_form.save(commit=False)\n score.user = request.user\n score.application = application\n score.save()\n\n if request.POST.get('random'):\n # Go to a new random application.\n new_app = random_application(request, page, application)\n if new_app:\n return redirect(\n 'applications:application_detail', city, new_app.id)\n return redirect('applications:applications', city)\n\n return render(request, 'application_detail.html', {\n 'page': page,\n 'application': application,\n 'form': application.form,\n 'scores': all_scores,\n 'user_score': score,\n 'score_form': score_form,\n 'menu': get_organiser_menu(city),\n })\n\n\n@organiser_only\ndef communication(request, city):\n \"\"\"\n Send emails to applicants and attendees\n \"\"\"\n page = get_event_page(city, request.user.is_authenticated(), False)\n\n emails = Email.objects.filter(form__page=page).order_by('-created')\n\n return render(request, 'communication.html', {\n 'page': page,\n 'menu': get_organiser_menu(city),\n 'emails': emails,\n })\n\n\n@organiser_only\ndef compose_email(request, city, email_id=None):\n \"\"\"\n Create new email or update email to applicants and attendees\n \"\"\"\n page = get_event_page(city, request.user.is_authenticated(), False)\n form_obj = get_object_or_404(Form, page=page)\n emailmsg = None if not email_id else get_object_or_404(Email, form__page=page, id=email_id)\n\n form = EmailForm(request.POST or None, instance=emailmsg, initial={\n 'author': request.user, 'form': form_obj\n })\n if form.is_valid() and request.method == 'POST':\n obj = form.save(commit=False)\n obj.author = request.user\n obj.form = form_obj\n obj.save()\n if request.POST.get('send'):\n obj.send()\n return redirect('applications:communication', city)\n\n return render(request, 'compose_email.html', {\n 'page': page,\n 'menu': get_organiser_menu(city),\n 'form': form,\n 'email': emailmsg,\n })\n\n\n@organiser_only\n@csrf_exempt\ndef change_state(request, city):\n \"\"\"\n Change the state of Applicaction(s). Use it like this:\n e.g /applications/?state=accepted&application=1&application=2&application=3\n \"\"\"\n state = request.POST.get('state', None)\n applications = request.POST.getlist('application', None)\n page = get_event_page(city, request.user.is_authenticated(), False)\n\n if not state or not applications:\n return JsonResponse({'error': 'Missing parameters'})\n\n applications = Application.objects.filter(id__in=applications, form__page=page)\n applications.update(state=state)\n\n ids = applications.values_list('id', flat=True)\n ids = [str(id) for id in ids]\n\n return JsonResponse({'message': 'Applications have been updated', 'updated': ids})\n\n\n@organiser_only\n@csrf_exempt\ndef change_rsvp(request, city):\n \"\"\"\n Change the rsvp_status of Applicaction(s). Use it like this:\n e.g /applications/?rsvp=yes&application=1&application=2&application=3\n \"\"\"\n rsvp_status = request.POST.get('rsvp_status', None)\n applications = request.POST.getlist('application', None)\n page = get_event_page(city, request.user.is_authenticated(), False)\n\n if not rsvp_status or not applications:\n return JsonResponse({'error': 'Missing parameters'})\n\n applications = Application.objects.filter(id__in=applications, form__page=page)\n applications.update(rsvp_status=rsvp_status)\n\n ids = applications.values_list('id', flat=True)\n ids = [str(id) for id in ids]\n\n return JsonResponse({'message': 'Applications have been updated', 'updated': ids})\n\n\ndef rsvp(request, city, code):\n page = get_event_page(city, request.user.is_authenticated(), False)\n if not page:\n raise Http404\n elif type(page) == tuple:\n return render(\n request, \"event_not_live.html\",\n {'city': page[0], 'past': page[1]}\n )\n\n application, rsvp = Application.get_by_rsvp_code(code, page)\n if not application:\n return redirect('/{}/'.format(page.url))\n\n application.rsvp_status = rsvp\n application.save()\n\n if rsvp == 'yes':\n message = \"Your answer has been saved, your participation in the workshop has been confirmed! We can't wait to meet you. We will be in touch with details soon.\"\n else:\n message = \"Your answer has been saved, thanks for letting us know. Your spot will be assigned to another person on the waiting list.\"\n messages.success(request, message)\n\n menu = EventPageMenu.objects.filter(page=page)\n\n return render(request, 'apply.html', {\n 'page': page,\n 'menu': menu,\n })\n", "path": "applications/views.py"}]} |
gh_patches_debug_201 | rasdani/github-patches | git_diff | django-json-api__django-rest-framework-json-api-937 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Release needed for Django 3.2 Update
Hello,
I see that there was a change to allow Django 3.2, but no new release has happened. This is preventing us from upgrading, could we get a new version released?
Thank you!
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `rest_framework_json_api/__init__.py`
Content:
```
1 # -*- coding: utf-8 -*-
2
3 __title__ = "djangorestframework-jsonapi"
4 __version__ = "4.1.0"
5 __author__ = ""
6 __license__ = "BSD"
7 __copyright__ = ""
8
9 # Version synonym
10 VERSION = __version__
11
```
--- 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/rest_framework_json_api/__init__.py b/rest_framework_json_api/__init__.py
--- a/rest_framework_json_api/__init__.py
+++ b/rest_framework_json_api/__init__.py
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
__title__ = "djangorestframework-jsonapi"
-__version__ = "4.1.0"
+__version__ = "4.2.0"
__author__ = ""
__license__ = "BSD"
__copyright__ = ""
| {"golden_diff": "diff --git a/rest_framework_json_api/__init__.py b/rest_framework_json_api/__init__.py\n--- a/rest_framework_json_api/__init__.py\n+++ b/rest_framework_json_api/__init__.py\n@@ -1,7 +1,7 @@\n # -*- coding: utf-8 -*-\n \n __title__ = \"djangorestframework-jsonapi\"\n-__version__ = \"4.1.0\"\n+__version__ = \"4.2.0\"\n __author__ = \"\"\n __license__ = \"BSD\"\n __copyright__ = \"\"\n", "issue": "Release needed for Django 3.2 Update\nHello,\r\n\r\nI see that there was a change to allow Django 3.2, but no new release has happened. This is preventing us from upgrading, could we get a new version released?\r\n\r\nThank you!\n", "before_files": [{"content": "# -*- coding: utf-8 -*-\n\n__title__ = \"djangorestframework-jsonapi\"\n__version__ = \"4.1.0\"\n__author__ = \"\"\n__license__ = \"BSD\"\n__copyright__ = \"\"\n\n# Version synonym\nVERSION = __version__\n", "path": "rest_framework_json_api/__init__.py"}], "after_files": [{"content": "# -*- coding: utf-8 -*-\n\n__title__ = \"djangorestframework-jsonapi\"\n__version__ = \"4.2.0\"\n__author__ = \"\"\n__license__ = \"BSD\"\n__copyright__ = \"\"\n\n# Version synonym\nVERSION = __version__\n", "path": "rest_framework_json_api/__init__.py"}]} |
gh_patches_debug_202 | rasdani/github-patches | git_diff | django-json-api__django-rest-framework-json-api-383 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
release 2.3.0?
It's in the changelog but it hasn't been released. Would you mind cutting a release for pypi? In particular the `Added nested included serializer support for remapped relations` is something we need.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `rest_framework_json_api/__init__.py`
Content:
```
1 # -*- coding: utf-8 -*-
2
3 __title__ = 'djangorestframework-jsonapi'
4 __version__ = '2.2.0'
5 __author__ = ''
6 __license__ = 'MIT'
7 __copyright__ = ''
8
9 # Version synonym
10 VERSION = __version__
11
```
--- 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/rest_framework_json_api/__init__.py b/rest_framework_json_api/__init__.py
--- a/rest_framework_json_api/__init__.py
+++ b/rest_framework_json_api/__init__.py
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
__title__ = 'djangorestframework-jsonapi'
-__version__ = '2.2.0'
+__version__ = '2.3.0'
__author__ = ''
__license__ = 'MIT'
__copyright__ = ''
| {"golden_diff": "diff --git a/rest_framework_json_api/__init__.py b/rest_framework_json_api/__init__.py\n--- a/rest_framework_json_api/__init__.py\n+++ b/rest_framework_json_api/__init__.py\n@@ -1,7 +1,7 @@\n # -*- coding: utf-8 -*-\n \n __title__ = 'djangorestframework-jsonapi'\n-__version__ = '2.2.0'\n+__version__ = '2.3.0'\n __author__ = ''\n __license__ = 'MIT'\n __copyright__ = ''\n", "issue": "release 2.3.0?\nIt's in the changelog but it hasn't been released. Would you mind cutting a release for pypi? In particular the `Added nested included serializer support for remapped relations` is something we need.\n", "before_files": [{"content": "# -*- coding: utf-8 -*-\n\n__title__ = 'djangorestframework-jsonapi'\n__version__ = '2.2.0'\n__author__ = ''\n__license__ = 'MIT'\n__copyright__ = ''\n\n# Version synonym\nVERSION = __version__\n", "path": "rest_framework_json_api/__init__.py"}], "after_files": [{"content": "# -*- coding: utf-8 -*-\n\n__title__ = 'djangorestframework-jsonapi'\n__version__ = '2.3.0'\n__author__ = ''\n__license__ = 'MIT'\n__copyright__ = ''\n\n# Version synonym\nVERSION = __version__\n", "path": "rest_framework_json_api/__init__.py"}]} |
gh_patches_debug_203 | rasdani/github-patches | git_diff | netket__netket-817 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
AbstractVariationalDriver.py bug in updating step_count
I think this error can be fixed either by writing a setter function for the `@property step_count` in the same way that `@optimizer.setter` exists in the same file.
Otherwise, maybe this can be fixed by changing ` self.step_count = 0` to ` self._step_count = 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: `netket/driver/abstract_variational_driver.py`
Content:
```
1 # Copyright 2021 The NetKet Authors - 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 abc
16 import numbers
17 from functools import partial
18
19 from tqdm import tqdm
20
21 import jax
22 from jax.tree_util import tree_map
23
24 from netket.logging import JsonLog
25 from netket.utils import mpi
26
27
28 def _to_iterable(maybe_iterable):
29 """
30 _to_iterable(maybe_iterable)
31
32 Ensure the result is iterable. If the input is not iterable, it is wrapped into a tuple.
33 """
34 if hasattr(maybe_iterable, "__iter__"):
35 surely_iterable = maybe_iterable
36 else:
37 surely_iterable = (maybe_iterable,)
38
39 return surely_iterable
40
41
42 # Note: to implement a new Driver (see also _vmc.py for an example)
43 # If you want to inherit the nice interface of AbstractMCDriver, you should
44 # subclass it, defining the following methods:
45 # - Either _forward_and_backward or individually _forward, _backward, that should
46 # compute the loss function and the gradient. If the driver is minimizing or
47 # maximising some loss function, this quantity should be assigned to self._stats
48 # in order to monitor it.
49 # - _estimate_stats should return the MC estimate of a single operator
50 # - reset should reset the driver (usually the sampler).
51 # - info should return a string with an overview of the driver.
52 # - The __init__ method shouldbe called with the machine and the optimizer. If this
53 # driver is minimising a loss function and you want it's name to show up automatically
54 # in the progress bar/ouput files you should pass the optional keyword argument
55 # minimized_quantity_name.
56 class AbstractVariationalDriver(abc.ABC):
57 """Abstract base class for NetKet Variational Monte Carlo drivers"""
58
59 def __init__(self, variational_state, optimizer, minimized_quantity_name=""):
60 self._mynode = mpi.node_number
61 self._mpi_nodes = mpi.n_nodes
62 self._loss_stats = None
63 self._loss_name = minimized_quantity_name
64 self._step_count = 0
65
66 self._variational_state = variational_state
67 self.optimizer = optimizer
68
69 def _forward_and_backward(self):
70 """
71 Performs the forward and backward pass at the same time.
72 Concrete drivers should either override this method, or override individually
73 _forward and _backward.
74
75 Returns:
76 the update for the weights.
77 """
78 self._forward()
79 dp = self._backward()
80 return dp
81
82 def _forward(self):
83 """
84 Performs the forward pass, computing the loss function.
85 Concrete should either implement _forward and _backward or the joint method
86 _forward_and_backward.
87 """
88 raise NotImplementedError()
89
90 def _backward(self):
91 """
92 Performs the backward pass, computing the update for the parameters.
93 Concrete should either implement _forward and _backward or the joint method
94 _forward_and_backward.
95 """
96 raise NotImplementedError()
97
98 def _estimate_stats(self, observable):
99 """
100 Returns the MCMC statistics for the expectation value of an observable.
101 Must be implemented by super-classes of AbstractVMC.
102
103 :param observable: A quantum operator (netket observable)
104 :return:
105 """
106 return self.state.expect(observable)
107
108 def reset(self):
109 """
110 Resets the driver.
111 Concrete drivers should also call super().reset() to ensure that the step
112 count is set to 0.
113 """
114 self.state.reset()
115 self.step_count = 0
116 pass
117
118 @abc.abstractmethod
119 def info(self, depth=0):
120 """
121 Returns an info string used to print information to screen about this driver.
122 """
123 pass
124
125 @property
126 def state(self):
127 """
128 Returns the machine that is optimized by this driver.
129 """
130 return self._variational_state
131
132 @property
133 def optimizer(self):
134 """
135 The optimizer used to update the parameters at every iteration.
136 """
137 return self._optimizer
138
139 @optimizer.setter
140 def optimizer(self, optimizer):
141 self._optimizer = optimizer
142 self._optimizer_state = optimizer.init(self.state.parameters)
143
144 @property
145 def step_count(self):
146 """
147 Returns a monotonic integer labelling all the steps performed by this driver.
148 This can be used, for example, to identify the line in a log file.
149 """
150 return self._step_count
151
152 def iter(self, n_steps: int, step: int = 1):
153 """
154 Returns a generator which advances the VMC optimization, yielding
155 after every `step_size` steps.
156
157 Args:
158 n_iter: The total number of steps to perform.
159 step_size: The number of internal steps the simulation
160 is advanced every turn.
161
162 Yields:
163 int: The current step.
164 """
165 for _ in range(0, n_steps, step):
166 for i in range(0, step):
167 dp = self._forward_and_backward()
168 if i == 0:
169 yield self.step_count
170
171 self._step_count += 1
172 self.update_parameters(dp)
173
174 def advance(self, steps: int = 1):
175 """
176 Performs `steps` optimization steps.
177
178 steps: (Default=1) number of steps
179 """
180 for _ in self.iter(steps):
181 pass
182
183 def run(
184 self,
185 n_iter,
186 out=None,
187 obs=None,
188 show_progress=True,
189 save_params_every=50, # for default logger
190 write_every=50, # for default logger
191 step_size=1, # for default logger
192 callback=lambda *x: True,
193 ):
194 """
195 Executes the Monte Carlo Variational optimization, updating the weights of the network
196 stored in this driver for `n_iter` steps and dumping values of the observables `obs`
197 in the output `logger`. If no logger is specified, creates a json file at `out`,
198 overwriting files with the same prefix.
199
200 By default uses :ref:`netket.logging.JsonLog`. To know about the output format
201 check it's documentation. The logger object is also returned at the end of this function
202 so that you can inspect the results without reading the json output.
203
204 Args:
205 n_iter: the total number of iterations
206 out: A logger object, or an iterable of loggers, to be used to store simulation log and data.
207 If this argument is a string, it will be used as output prefix for the standard JSON logger.
208 obs: An iterable containing all observables that should be computed
209 save_params_every: Every how many steps the parameters of the network should be
210 serialized to disk (ignored if logger is provided)
211 write_every: Every how many steps the json data should be flushed to disk (ignored if
212 logger is provided)
213 step_size: Every how many steps should observables be logged to disk (default=1)
214 show_progress: If true displays a progress bar (default=True)
215 callback: Callable or list of callable callback functions to stop training given a condition
216 """
217
218 if not isinstance(n_iter, numbers.Number):
219 raise ValueError(
220 "n_iter, the first positional argument to `run`, must be a number!"
221 )
222
223 if obs is None:
224 obs = {}
225
226 if out is None:
227 out = tuple()
228 print(
229 "No output specified (out=[apath|nk.logging.JsonLogger(...)])."
230 "Running the optimization but not saving the output."
231 )
232
233 # Log only non-root nodes
234 if self._mynode == 0:
235 # if out is a path, create an overwriting Json Log for output
236 if isinstance(out, str):
237 loggers = (JsonLog(out, "w", save_params_every, write_every),)
238 else:
239 loggers = _to_iterable(out)
240 else:
241 loggers = tuple()
242 show_progress = False
243
244 callbacks = _to_iterable(callback)
245 callback_stop = False
246
247 with tqdm(total=n_iter, disable=not show_progress) as pbar:
248 old_step = self.step_count
249 first_step = True
250
251 for step in self.iter(n_iter, step_size):
252
253 log_data = self.estimate(obs)
254
255 # if the cost-function is defined then report it in the progress bar
256 if self._loss_stats is not None:
257 pbar.set_postfix_str(self._loss_name + "=" + str(self._loss_stats))
258 log_data[self._loss_name] = self._loss_stats
259
260 # Execute callbacks before loggers because they can append to log_data
261 for callback in callbacks:
262 if not callback(step, log_data, self):
263 callback_stop = True
264
265 for logger in loggers:
266 logger(self.step_count, log_data, self.state)
267
268 if len(callbacks) > 0:
269 if mpi.mpi_any(callback_stop):
270 break
271
272 # Reset the timing of tqdm after the first step, to ignore compilation time
273 if first_step:
274 first_step = False
275 pbar.unpause()
276
277 # Update the progress bar
278 pbar.update(self.step_count - old_step)
279 old_step = self.step_count
280
281 # Final update so that it shows up filled.
282 pbar.update(self.step_count - old_step)
283
284 # flush at the end of the evolution so that final values are saved to
285 # file
286 for logger in loggers:
287 logger.flush(self.state)
288
289 return loggers
290
291 def estimate(self, observables):
292 """
293 Return MCMC statistics for the expectation value of observables in the
294 current state of the driver.
295
296 Args:
297 observables: A pytree of operators for which statistics should be computed.
298
299 Returns:
300 A pytree of the same structure as the input, containing MCMC statistics
301 for the corresponding operators as leaves.
302 """
303 return tree_map(self._estimate_stats, observables)
304
305 def update_parameters(self, dp):
306 """
307 Updates the parameters of the machine using the optimizer in this driver
308
309 Args:
310 dp: the pytree containing the updates to the parameters
311 """
312 self._optimizer_state, self.state.parameters = apply_gradient(
313 self._optimizer.update, self._optimizer_state, dp, self.state.parameters
314 )
315
316
317 @partial(jax.jit, static_argnums=0)
318 def apply_gradient(optimizer_fun, optimizer_state, dp, params):
319 import optax
320
321 updates, new_optimizer_state = optimizer_fun(dp, optimizer_state, params)
322
323 new_params = optax.apply_updates(params, updates)
324 return new_optimizer_state, new_params
325
```
--- 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/netket/driver/abstract_variational_driver.py b/netket/driver/abstract_variational_driver.py
--- a/netket/driver/abstract_variational_driver.py
+++ b/netket/driver/abstract_variational_driver.py
@@ -112,7 +112,7 @@
count is set to 0.
"""
self.state.reset()
- self.step_count = 0
+ self._step_count = 0
pass
@abc.abstractmethod
| {"golden_diff": "diff --git a/netket/driver/abstract_variational_driver.py b/netket/driver/abstract_variational_driver.py\n--- a/netket/driver/abstract_variational_driver.py\n+++ b/netket/driver/abstract_variational_driver.py\n@@ -112,7 +112,7 @@\n count is set to 0.\n \"\"\"\n self.state.reset()\n- self.step_count = 0\n+ self._step_count = 0\n pass\n \n @abc.abstractmethod\n", "issue": "AbstractVariationalDriver.py bug in updating step_count\n\r\n\r\nI think this error can be fixed either by writing a setter function for the `@property step_count` in the same way that `@optimizer.setter` exists in the same file. \r\n\r\nOtherwise, maybe this can be fixed by changing ` self.step_count = 0` to ` self._step_count = 0`.\r\n\r\n\r\n\n", "before_files": [{"content": "# Copyright 2021 The NetKet Authors - All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# 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 abc\nimport numbers\nfrom functools import partial\n\nfrom tqdm import tqdm\n\nimport jax\nfrom jax.tree_util import tree_map\n\nfrom netket.logging import JsonLog\nfrom netket.utils import mpi\n\n\ndef _to_iterable(maybe_iterable):\n \"\"\"\n _to_iterable(maybe_iterable)\n\n Ensure the result is iterable. If the input is not iterable, it is wrapped into a tuple.\n \"\"\"\n if hasattr(maybe_iterable, \"__iter__\"):\n surely_iterable = maybe_iterable\n else:\n surely_iterable = (maybe_iterable,)\n\n return surely_iterable\n\n\n# Note: to implement a new Driver (see also _vmc.py for an example)\n# If you want to inherit the nice interface of AbstractMCDriver, you should\n# subclass it, defining the following methods:\n# - Either _forward_and_backward or individually _forward, _backward, that should\n# compute the loss function and the gradient. If the driver is minimizing or\n# maximising some loss function, this quantity should be assigned to self._stats\n# in order to monitor it.\n# - _estimate_stats should return the MC estimate of a single operator\n# - reset should reset the driver (usually the sampler).\n# - info should return a string with an overview of the driver.\n# - The __init__ method shouldbe called with the machine and the optimizer. If this\n# driver is minimising a loss function and you want it's name to show up automatically\n# in the progress bar/ouput files you should pass the optional keyword argument\n# minimized_quantity_name.\nclass AbstractVariationalDriver(abc.ABC):\n \"\"\"Abstract base class for NetKet Variational Monte Carlo drivers\"\"\"\n\n def __init__(self, variational_state, optimizer, minimized_quantity_name=\"\"):\n self._mynode = mpi.node_number\n self._mpi_nodes = mpi.n_nodes\n self._loss_stats = None\n self._loss_name = minimized_quantity_name\n self._step_count = 0\n\n self._variational_state = variational_state\n self.optimizer = optimizer\n\n def _forward_and_backward(self):\n \"\"\"\n Performs the forward and backward pass at the same time.\n Concrete drivers should either override this method, or override individually\n _forward and _backward.\n\n Returns:\n the update for the weights.\n \"\"\"\n self._forward()\n dp = self._backward()\n return dp\n\n def _forward(self):\n \"\"\"\n Performs the forward pass, computing the loss function.\n Concrete should either implement _forward and _backward or the joint method\n _forward_and_backward.\n \"\"\"\n raise NotImplementedError()\n\n def _backward(self):\n \"\"\"\n Performs the backward pass, computing the update for the parameters.\n Concrete should either implement _forward and _backward or the joint method\n _forward_and_backward.\n \"\"\"\n raise NotImplementedError()\n\n def _estimate_stats(self, observable):\n \"\"\"\n Returns the MCMC statistics for the expectation value of an observable.\n Must be implemented by super-classes of AbstractVMC.\n\n :param observable: A quantum operator (netket observable)\n :return:\n \"\"\"\n return self.state.expect(observable)\n\n def reset(self):\n \"\"\"\n Resets the driver.\n Concrete drivers should also call super().reset() to ensure that the step\n count is set to 0.\n \"\"\"\n self.state.reset()\n self.step_count = 0\n pass\n\n @abc.abstractmethod\n def info(self, depth=0):\n \"\"\"\n Returns an info string used to print information to screen about this driver.\n \"\"\"\n pass\n\n @property\n def state(self):\n \"\"\"\n Returns the machine that is optimized by this driver.\n \"\"\"\n return self._variational_state\n\n @property\n def optimizer(self):\n \"\"\"\n The optimizer used to update the parameters at every iteration.\n \"\"\"\n return self._optimizer\n\n @optimizer.setter\n def optimizer(self, optimizer):\n self._optimizer = optimizer\n self._optimizer_state = optimizer.init(self.state.parameters)\n\n @property\n def step_count(self):\n \"\"\"\n Returns a monotonic integer labelling all the steps performed by this driver.\n This can be used, for example, to identify the line in a log file.\n \"\"\"\n return self._step_count\n\n def iter(self, n_steps: int, step: int = 1):\n \"\"\"\n Returns a generator which advances the VMC optimization, yielding\n after every `step_size` steps.\n\n Args:\n n_iter: The total number of steps to perform.\n step_size: The number of internal steps the simulation\n is advanced every turn.\n\n Yields:\n int: The current step.\n \"\"\"\n for _ in range(0, n_steps, step):\n for i in range(0, step):\n dp = self._forward_and_backward()\n if i == 0:\n yield self.step_count\n\n self._step_count += 1\n self.update_parameters(dp)\n\n def advance(self, steps: int = 1):\n \"\"\"\n Performs `steps` optimization steps.\n\n steps: (Default=1) number of steps\n \"\"\"\n for _ in self.iter(steps):\n pass\n\n def run(\n self,\n n_iter,\n out=None,\n obs=None,\n show_progress=True,\n save_params_every=50, # for default logger\n write_every=50, # for default logger\n step_size=1, # for default logger\n callback=lambda *x: True,\n ):\n \"\"\"\n Executes the Monte Carlo Variational optimization, updating the weights of the network\n stored in this driver for `n_iter` steps and dumping values of the observables `obs`\n in the output `logger`. If no logger is specified, creates a json file at `out`,\n overwriting files with the same prefix.\n\n By default uses :ref:`netket.logging.JsonLog`. To know about the output format\n check it's documentation. The logger object is also returned at the end of this function\n so that you can inspect the results without reading the json output.\n\n Args:\n n_iter: the total number of iterations\n out: A logger object, or an iterable of loggers, to be used to store simulation log and data.\n If this argument is a string, it will be used as output prefix for the standard JSON logger.\n obs: An iterable containing all observables that should be computed\n save_params_every: Every how many steps the parameters of the network should be\n serialized to disk (ignored if logger is provided)\n write_every: Every how many steps the json data should be flushed to disk (ignored if\n logger is provided)\n step_size: Every how many steps should observables be logged to disk (default=1)\n show_progress: If true displays a progress bar (default=True)\n callback: Callable or list of callable callback functions to stop training given a condition\n \"\"\"\n\n if not isinstance(n_iter, numbers.Number):\n raise ValueError(\n \"n_iter, the first positional argument to `run`, must be a number!\"\n )\n\n if obs is None:\n obs = {}\n\n if out is None:\n out = tuple()\n print(\n \"No output specified (out=[apath|nk.logging.JsonLogger(...)]).\"\n \"Running the optimization but not saving the output.\"\n )\n\n # Log only non-root nodes\n if self._mynode == 0:\n # if out is a path, create an overwriting Json Log for output\n if isinstance(out, str):\n loggers = (JsonLog(out, \"w\", save_params_every, write_every),)\n else:\n loggers = _to_iterable(out)\n else:\n loggers = tuple()\n show_progress = False\n\n callbacks = _to_iterable(callback)\n callback_stop = False\n\n with tqdm(total=n_iter, disable=not show_progress) as pbar:\n old_step = self.step_count\n first_step = True\n\n for step in self.iter(n_iter, step_size):\n\n log_data = self.estimate(obs)\n\n # if the cost-function is defined then report it in the progress bar\n if self._loss_stats is not None:\n pbar.set_postfix_str(self._loss_name + \"=\" + str(self._loss_stats))\n log_data[self._loss_name] = self._loss_stats\n\n # Execute callbacks before loggers because they can append to log_data\n for callback in callbacks:\n if not callback(step, log_data, self):\n callback_stop = True\n\n for logger in loggers:\n logger(self.step_count, log_data, self.state)\n\n if len(callbacks) > 0:\n if mpi.mpi_any(callback_stop):\n break\n\n # Reset the timing of tqdm after the first step, to ignore compilation time\n if first_step:\n first_step = False\n pbar.unpause()\n\n # Update the progress bar\n pbar.update(self.step_count - old_step)\n old_step = self.step_count\n\n # Final update so that it shows up filled.\n pbar.update(self.step_count - old_step)\n\n # flush at the end of the evolution so that final values are saved to\n # file\n for logger in loggers:\n logger.flush(self.state)\n\n return loggers\n\n def estimate(self, observables):\n \"\"\"\n Return MCMC statistics for the expectation value of observables in the\n current state of the driver.\n\n Args:\n observables: A pytree of operators for which statistics should be computed.\n\n Returns:\n A pytree of the same structure as the input, containing MCMC statistics\n for the corresponding operators as leaves.\n \"\"\"\n return tree_map(self._estimate_stats, observables)\n\n def update_parameters(self, dp):\n \"\"\"\n Updates the parameters of the machine using the optimizer in this driver\n\n Args:\n dp: the pytree containing the updates to the parameters\n \"\"\"\n self._optimizer_state, self.state.parameters = apply_gradient(\n self._optimizer.update, self._optimizer_state, dp, self.state.parameters\n )\n\n\n@partial(jax.jit, static_argnums=0)\ndef apply_gradient(optimizer_fun, optimizer_state, dp, params):\n import optax\n\n updates, new_optimizer_state = optimizer_fun(dp, optimizer_state, params)\n\n new_params = optax.apply_updates(params, updates)\n return new_optimizer_state, new_params\n", "path": "netket/driver/abstract_variational_driver.py"}], "after_files": [{"content": "# Copyright 2021 The NetKet Authors - All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# 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 abc\nimport numbers\nfrom functools import partial\n\nfrom tqdm import tqdm\n\nimport jax\nfrom jax.tree_util import tree_map\n\nfrom netket.logging import JsonLog\nfrom netket.utils import mpi\n\n\ndef _to_iterable(maybe_iterable):\n \"\"\"\n _to_iterable(maybe_iterable)\n\n Ensure the result is iterable. If the input is not iterable, it is wrapped into a tuple.\n \"\"\"\n if hasattr(maybe_iterable, \"__iter__\"):\n surely_iterable = maybe_iterable\n else:\n surely_iterable = (maybe_iterable,)\n\n return surely_iterable\n\n\n# Note: to implement a new Driver (see also _vmc.py for an example)\n# If you want to inherit the nice interface of AbstractMCDriver, you should\n# subclass it, defining the following methods:\n# - Either _forward_and_backward or individually _forward, _backward, that should\n# compute the loss function and the gradient. If the driver is minimizing or\n# maximising some loss function, this quantity should be assigned to self._stats\n# in order to monitor it.\n# - _estimate_stats should return the MC estimate of a single operator\n# - reset should reset the driver (usually the sampler).\n# - info should return a string with an overview of the driver.\n# - The __init__ method shouldbe called with the machine and the optimizer. If this\n# driver is minimising a loss function and you want it's name to show up automatically\n# in the progress bar/ouput files you should pass the optional keyword argument\n# minimized_quantity_name.\nclass AbstractVariationalDriver(abc.ABC):\n \"\"\"Abstract base class for NetKet Variational Monte Carlo drivers\"\"\"\n\n def __init__(self, variational_state, optimizer, minimized_quantity_name=\"\"):\n self._mynode = mpi.node_number\n self._mpi_nodes = mpi.n_nodes\n self._loss_stats = None\n self._loss_name = minimized_quantity_name\n self._step_count = 0\n\n self._variational_state = variational_state\n self.optimizer = optimizer\n\n def _forward_and_backward(self):\n \"\"\"\n Performs the forward and backward pass at the same time.\n Concrete drivers should either override this method, or override individually\n _forward and _backward.\n\n Returns:\n the update for the weights.\n \"\"\"\n self._forward()\n dp = self._backward()\n return dp\n\n def _forward(self):\n \"\"\"\n Performs the forward pass, computing the loss function.\n Concrete should either implement _forward and _backward or the joint method\n _forward_and_backward.\n \"\"\"\n raise NotImplementedError()\n\n def _backward(self):\n \"\"\"\n Performs the backward pass, computing the update for the parameters.\n Concrete should either implement _forward and _backward or the joint method\n _forward_and_backward.\n \"\"\"\n raise NotImplementedError()\n\n def _estimate_stats(self, observable):\n \"\"\"\n Returns the MCMC statistics for the expectation value of an observable.\n Must be implemented by super-classes of AbstractVMC.\n\n :param observable: A quantum operator (netket observable)\n :return:\n \"\"\"\n return self.state.expect(observable)\n\n def reset(self):\n \"\"\"\n Resets the driver.\n Concrete drivers should also call super().reset() to ensure that the step\n count is set to 0.\n \"\"\"\n self.state.reset()\n self._step_count = 0\n pass\n\n @abc.abstractmethod\n def info(self, depth=0):\n \"\"\"\n Returns an info string used to print information to screen about this driver.\n \"\"\"\n pass\n\n @property\n def state(self):\n \"\"\"\n Returns the machine that is optimized by this driver.\n \"\"\"\n return self._variational_state\n\n @property\n def optimizer(self):\n \"\"\"\n The optimizer used to update the parameters at every iteration.\n \"\"\"\n return self._optimizer\n\n @optimizer.setter\n def optimizer(self, optimizer):\n self._optimizer = optimizer\n self._optimizer_state = optimizer.init(self.state.parameters)\n\n @property\n def step_count(self):\n \"\"\"\n Returns a monotonic integer labelling all the steps performed by this driver.\n This can be used, for example, to identify the line in a log file.\n \"\"\"\n return self._step_count\n\n def iter(self, n_steps: int, step: int = 1):\n \"\"\"\n Returns a generator which advances the VMC optimization, yielding\n after every `step_size` steps.\n\n Args:\n n_iter: The total number of steps to perform.\n step_size: The number of internal steps the simulation\n is advanced every turn.\n\n Yields:\n int: The current step.\n \"\"\"\n for _ in range(0, n_steps, step):\n for i in range(0, step):\n dp = self._forward_and_backward()\n if i == 0:\n yield self.step_count\n\n self._step_count += 1\n self.update_parameters(dp)\n\n def advance(self, steps: int = 1):\n \"\"\"\n Performs `steps` optimization steps.\n\n steps: (Default=1) number of steps\n \"\"\"\n for _ in self.iter(steps):\n pass\n\n def run(\n self,\n n_iter,\n out=None,\n obs=None,\n show_progress=True,\n save_params_every=50, # for default logger\n write_every=50, # for default logger\n step_size=1, # for default logger\n callback=lambda *x: True,\n ):\n \"\"\"\n Executes the Monte Carlo Variational optimization, updating the weights of the network\n stored in this driver for `n_iter` steps and dumping values of the observables `obs`\n in the output `logger`. If no logger is specified, creates a json file at `out`,\n overwriting files with the same prefix.\n\n By default uses :ref:`netket.logging.JsonLog`. To know about the output format\n check it's documentation. The logger object is also returned at the end of this function\n so that you can inspect the results without reading the json output.\n\n Args:\n n_iter: the total number of iterations\n out: A logger object, or an iterable of loggers, to be used to store simulation log and data.\n If this argument is a string, it will be used as output prefix for the standard JSON logger.\n obs: An iterable containing all observables that should be computed\n save_params_every: Every how many steps the parameters of the network should be\n serialized to disk (ignored if logger is provided)\n write_every: Every how many steps the json data should be flushed to disk (ignored if\n logger is provided)\n step_size: Every how many steps should observables be logged to disk (default=1)\n show_progress: If true displays a progress bar (default=True)\n callback: Callable or list of callable callback functions to stop training given a condition\n \"\"\"\n\n if not isinstance(n_iter, numbers.Number):\n raise ValueError(\n \"n_iter, the first positional argument to `run`, must be a number!\"\n )\n\n if obs is None:\n obs = {}\n\n if out is None:\n out = tuple()\n print(\n \"No output specified (out=[apath|nk.logging.JsonLogger(...)]).\"\n \"Running the optimization but not saving the output.\"\n )\n\n # Log only non-root nodes\n if self._mynode == 0:\n # if out is a path, create an overwriting Json Log for output\n if isinstance(out, str):\n loggers = (JsonLog(out, \"w\", save_params_every, write_every),)\n else:\n loggers = _to_iterable(out)\n else:\n loggers = tuple()\n show_progress = False\n\n callbacks = _to_iterable(callback)\n callback_stop = False\n\n with tqdm(total=n_iter, disable=not show_progress) as pbar:\n old_step = self.step_count\n first_step = True\n\n for step in self.iter(n_iter, step_size):\n\n log_data = self.estimate(obs)\n\n # if the cost-function is defined then report it in the progress bar\n if self._loss_stats is not None:\n pbar.set_postfix_str(self._loss_name + \"=\" + str(self._loss_stats))\n log_data[self._loss_name] = self._loss_stats\n\n # Execute callbacks before loggers because they can append to log_data\n for callback in callbacks:\n if not callback(step, log_data, self):\n callback_stop = True\n\n for logger in loggers:\n logger(self.step_count, log_data, self.state)\n\n if len(callbacks) > 0:\n if mpi.mpi_any(callback_stop):\n break\n\n # Reset the timing of tqdm after the first step, to ignore compilation time\n if first_step:\n first_step = False\n pbar.unpause()\n\n # Update the progress bar\n pbar.update(self.step_count - old_step)\n old_step = self.step_count\n\n # Final update so that it shows up filled.\n pbar.update(self.step_count - old_step)\n\n # flush at the end of the evolution so that final values are saved to\n # file\n for logger in loggers:\n logger.flush(self.state)\n\n return loggers\n\n def estimate(self, observables):\n \"\"\"\n Return MCMC statistics for the expectation value of observables in the\n current state of the driver.\n\n Args:\n observables: A pytree of operators for which statistics should be computed.\n\n Returns:\n A pytree of the same structure as the input, containing MCMC statistics\n for the corresponding operators as leaves.\n \"\"\"\n return tree_map(self._estimate_stats, observables)\n\n def update_parameters(self, dp):\n \"\"\"\n Updates the parameters of the machine using the optimizer in this driver\n\n Args:\n dp: the pytree containing the updates to the parameters\n \"\"\"\n self._optimizer_state, self.state.parameters = apply_gradient(\n self._optimizer.update, self._optimizer_state, dp, self.state.parameters\n )\n\n\n@partial(jax.jit, static_argnums=0)\ndef apply_gradient(optimizer_fun, optimizer_state, dp, params):\n import optax\n\n updates, new_optimizer_state = optimizer_fun(dp, optimizer_state, params)\n\n new_params = optax.apply_updates(params, updates)\n return new_optimizer_state, new_params\n", "path": "netket/driver/abstract_variational_driver.py"}]} |
gh_patches_debug_204 | rasdani/github-patches | git_diff | spotify__luigi-1372 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Add method to S3Target to get back path
With an `S3Target(path)`, we can load data into S3 at the specified path. It would be useful if we could also get back the path at which the target is pointing to so it can be used in subsequent tasks.
Correct me if I'm wrong, but I couldn't find any way to do this. I can work on a PR if this sounds reasonable.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `luigi/s3.py`
Content:
```
1 # -*- coding: utf-8 -*-
2 #
3 # Copyright 2012-2015 Spotify AB
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16 #
17 """
18 Implementation of Simple Storage Service support.
19 :py:class:`S3Target` is a subclass of the Target class to support S3 file system operations
20 """
21
22 from __future__ import division
23
24 import itertools
25 import logging
26 import os
27 import os.path
28 try:
29 from urlparse import urlsplit
30 except ImportError:
31 from urllib.parse import urlsplit
32 import warnings
33 try:
34 from ConfigParser import NoSectionError
35 except ImportError:
36 from configparser import NoSectionError
37
38 from luigi import six
39 from luigi.six.moves import range
40
41 from luigi import configuration
42 from luigi.format import get_default_format
43 from luigi.parameter import Parameter
44 from luigi.target import FileAlreadyExists, FileSystem, FileSystemException, FileSystemTarget, AtomicLocalFile, MissingParentDirectory
45 from luigi.task import ExternalTask
46
47 logger = logging.getLogger('luigi-interface')
48
49 try:
50 import boto
51 from boto.s3.key import Key
52 except ImportError:
53 logger.warning("Loading s3 module without boto installed. Will crash at "
54 "runtime if s3 functionality is used.")
55
56
57 # two different ways of marking a directory
58 # with a suffix in S3
59 S3_DIRECTORY_MARKER_SUFFIX_0 = '_$folder$'
60 S3_DIRECTORY_MARKER_SUFFIX_1 = '/'
61
62
63 class InvalidDeleteException(FileSystemException):
64 pass
65
66
67 class FileNotFoundException(FileSystemException):
68 pass
69
70
71 class S3Client(FileSystem):
72 """
73 boto-powered S3 client.
74 """
75
76 def __init__(self, aws_access_key_id=None, aws_secret_access_key=None,
77 **kwargs):
78 options = self._get_s3_config()
79 options.update(kwargs)
80 # Removing key args would break backwards compability
81 if not aws_access_key_id:
82 aws_access_key_id = options.get('aws_access_key_id')
83 if not aws_secret_access_key:
84 aws_secret_access_key = options.get('aws_secret_access_key')
85 for key in ['aws_access_key_id', 'aws_secret_access_key']:
86 if key in options:
87 options.pop(key)
88 self.s3 = boto.connect_s3(aws_access_key_id,
89 aws_secret_access_key,
90 **options)
91
92 def exists(self, path):
93 """
94 Does provided path exist on S3?
95 """
96 (bucket, key) = self._path_to_bucket_and_key(path)
97
98 # grab and validate the bucket
99 s3_bucket = self.s3.get_bucket(bucket, validate=True)
100
101 # root always exists
102 if self._is_root(key):
103 return True
104
105 # file
106 s3_key = s3_bucket.get_key(key)
107 if s3_key:
108 return True
109
110 if self.isdir(path):
111 return True
112
113 logger.debug('Path %s does not exist', path)
114 return False
115
116 def remove(self, path, recursive=True):
117 """
118 Remove a file or directory from S3.
119 """
120 if not self.exists(path):
121 logger.debug('Could not delete %s; path does not exist', path)
122 return False
123
124 (bucket, key) = self._path_to_bucket_and_key(path)
125
126 # root
127 if self._is_root(key):
128 raise InvalidDeleteException(
129 'Cannot delete root of bucket at path %s' % path)
130
131 # grab and validate the bucket
132 s3_bucket = self.s3.get_bucket(bucket, validate=True)
133
134 # file
135 s3_key = s3_bucket.get_key(key)
136 if s3_key:
137 s3_bucket.delete_key(s3_key)
138 logger.debug('Deleting %s from bucket %s', key, bucket)
139 return True
140
141 if self.isdir(path) and not recursive:
142 raise InvalidDeleteException(
143 'Path %s is a directory. Must use recursive delete' % path)
144
145 delete_key_list = [
146 k for k in s3_bucket.list(self._add_path_delimiter(key))]
147
148 # delete the directory marker file if it exists
149 s3_dir_with_suffix_key = s3_bucket.get_key(key + S3_DIRECTORY_MARKER_SUFFIX_0)
150 if s3_dir_with_suffix_key:
151 delete_key_list.append(s3_dir_with_suffix_key)
152
153 if len(delete_key_list) > 0:
154 for k in delete_key_list:
155 logger.debug('Deleting %s from bucket %s', k, bucket)
156 s3_bucket.delete_keys(delete_key_list)
157 return True
158
159 return False
160
161 def get_key(self, path):
162 (bucket, key) = self._path_to_bucket_and_key(path)
163
164 s3_bucket = self.s3.get_bucket(bucket, validate=True)
165
166 return s3_bucket.get_key(key)
167
168 def put(self, local_path, destination_s3_path):
169 """
170 Put an object stored locally to an S3 path.
171 """
172 (bucket, key) = self._path_to_bucket_and_key(destination_s3_path)
173
174 # grab and validate the bucket
175 s3_bucket = self.s3.get_bucket(bucket, validate=True)
176
177 # put the file
178 s3_key = Key(s3_bucket)
179 s3_key.key = key
180 s3_key.set_contents_from_filename(local_path)
181
182 def put_string(self, content, destination_s3_path):
183 """
184 Put a string to an S3 path.
185 """
186 (bucket, key) = self._path_to_bucket_and_key(destination_s3_path)
187 # grab and validate the bucket
188 s3_bucket = self.s3.get_bucket(bucket, validate=True)
189
190 # put the content
191 s3_key = Key(s3_bucket)
192 s3_key.key = key
193 s3_key.set_contents_from_string(content)
194
195 def put_multipart(self, local_path, destination_s3_path, part_size=67108864):
196 """
197 Put an object stored locally to an S3 path
198 using S3 multi-part upload (for files > 5GB).
199
200 :param local_path: Path to source local file
201 :param destination_s3_path: URL for target S3 location
202 :param part_size: Part size in bytes. Default: 67108864 (64MB), must be >= 5MB and <= 5 GB.
203 """
204 # calculate number of parts to upload
205 # based on the size of the file
206 source_size = os.stat(local_path).st_size
207
208 if source_size <= part_size:
209 # fallback to standard, non-multipart strategy
210 return self.put(local_path, destination_s3_path)
211
212 (bucket, key) = self._path_to_bucket_and_key(destination_s3_path)
213
214 # grab and validate the bucket
215 s3_bucket = self.s3.get_bucket(bucket, validate=True)
216
217 # calculate the number of parts (int division).
218 # use modulo to avoid float precision issues
219 # for exactly-sized fits
220 num_parts = \
221 (source_size // part_size) \
222 if source_size % part_size == 0 \
223 else (source_size // part_size) + 1
224
225 mp = None
226 try:
227 mp = s3_bucket.initiate_multipart_upload(key)
228
229 for i in range(num_parts):
230 # upload a part at a time to S3
231 offset = part_size * i
232 bytes = min(part_size, source_size - offset)
233 with open(local_path, 'rb') as fp:
234 part_num = i + 1
235 logger.info('Uploading part %s/%s to %s', part_num, num_parts, destination_s3_path)
236 fp.seek(offset)
237 mp.upload_part_from_file(fp, part_num=part_num, size=bytes)
238
239 # finish the upload, making the file available in S3
240 mp.complete_upload()
241 except BaseException:
242 if mp:
243 logger.info('Canceling multipart s3 upload for %s', destination_s3_path)
244 # cancel the upload so we don't get charged for
245 # storage consumed by uploaded parts
246 mp.cancel_upload()
247 raise
248
249 def get(self, s3_path, destination_local_path):
250 """
251 Get an object stored in S3 and write it to a local path.
252 """
253 (bucket, key) = self._path_to_bucket_and_key(s3_path)
254
255 # grab and validate the bucket
256 s3_bucket = self.s3.get_bucket(bucket, validate=True)
257
258 # download the file
259 s3_key = Key(s3_bucket)
260 s3_key.key = key
261 s3_key.get_contents_to_filename(destination_local_path)
262
263 def get_as_string(self, s3_path):
264 """
265 Get the contents of an object stored in S3 as a string.
266 """
267 (bucket, key) = self._path_to_bucket_and_key(s3_path)
268
269 # grab and validate the bucket
270 s3_bucket = self.s3.get_bucket(bucket, validate=True)
271
272 # get the content
273 s3_key = Key(s3_bucket)
274 s3_key.key = key
275 contents = s3_key.get_contents_as_string()
276
277 return contents
278
279 def copy(self, source_path, destination_path):
280 """
281 Copy an object from one S3 location to another.
282 """
283 (src_bucket, src_key) = self._path_to_bucket_and_key(source_path)
284 (dst_bucket, dst_key) = self._path_to_bucket_and_key(destination_path)
285
286 s3_bucket = self.s3.get_bucket(dst_bucket, validate=True)
287
288 if self.isdir(source_path):
289 src_prefix = self._add_path_delimiter(src_key)
290 dst_prefix = self._add_path_delimiter(dst_key)
291 for key in self.list(source_path):
292 s3_bucket.copy_key(dst_prefix + key,
293 src_bucket,
294 src_prefix + key)
295 else:
296 s3_bucket.copy_key(dst_key, src_bucket, src_key)
297
298 def rename(self, source_path, destination_path):
299 """
300 Rename/move an object from one S3 location to another.
301 """
302 self.copy(source_path, destination_path)
303 self.remove(source_path)
304
305 def listdir(self, path):
306 """
307 Get an iterable with S3 folder contents.
308 Iterable contains paths relative to queried path.
309 """
310 (bucket, key) = self._path_to_bucket_and_key(path)
311
312 # grab and validate the bucket
313 s3_bucket = self.s3.get_bucket(bucket, validate=True)
314
315 key_path = self._add_path_delimiter(key)
316 key_path_len = len(key_path)
317 for item in s3_bucket.list(prefix=key_path):
318 yield self._add_path_delimiter(path) + item.key[key_path_len:]
319
320 def list(self, path): # backwards compat
321 key_path_len = len(self._add_path_delimiter(path))
322 for item in self.listdir(path):
323 yield item[key_path_len:]
324
325 def isdir(self, path):
326 """
327 Is the parameter S3 path a directory?
328 """
329 (bucket, key) = self._path_to_bucket_and_key(path)
330
331 # grab and validate the bucket
332 s3_bucket = self.s3.get_bucket(bucket, validate=True)
333
334 # root is a directory
335 if self._is_root(key):
336 return True
337
338 for suffix in (S3_DIRECTORY_MARKER_SUFFIX_0,
339 S3_DIRECTORY_MARKER_SUFFIX_1):
340 s3_dir_with_suffix_key = s3_bucket.get_key(key + suffix)
341 if s3_dir_with_suffix_key:
342 return True
343
344 # files with this prefix
345 key_path = self._add_path_delimiter(key)
346 s3_bucket_list_result = \
347 list(itertools.islice(
348 s3_bucket.list(prefix=key_path),
349 1))
350 if s3_bucket_list_result:
351 return True
352
353 return False
354 is_dir = isdir # compatibility with old version.
355
356 def mkdir(self, path, parents=True, raise_if_exists=False):
357 if raise_if_exists and self.isdir(path):
358 raise FileAlreadyExists()
359
360 _, key = self._path_to_bucket_and_key(path)
361 if self._is_root(key):
362 return # isdir raises if the bucket doesn't exist; nothing to do here.
363
364 key = self._add_path_delimiter(key)
365
366 if not parents and not self.isdir(os.path.dirname(key)):
367 raise MissingParentDirectory()
368
369 return self.put_string("", self._add_path_delimiter(path))
370
371 def _get_s3_config(self, key=None):
372 try:
373 config = dict(configuration.get_config().items('s3'))
374 except NoSectionError:
375 return {}
376 # So what ports etc can be read without us having to specify all dtypes
377 for k, v in six.iteritems(config):
378 try:
379 config[k] = int(v)
380 except ValueError:
381 pass
382 if key:
383 return config.get(key)
384 return config
385
386 def _path_to_bucket_and_key(self, path):
387 (scheme, netloc, path, query, fragment) = urlsplit(path)
388 path_without_initial_slash = path[1:]
389 return netloc, path_without_initial_slash
390
391 def _is_root(self, key):
392 return (len(key) == 0) or (key == '/')
393
394 def _add_path_delimiter(self, key):
395 return key if key[-1:] == '/' else key + '/'
396
397
398 class AtomicS3File(AtomicLocalFile):
399 """
400 An S3 file that writes to a temp file and put to S3 on close.
401 """
402
403 def __init__(self, path, s3_client):
404 self.s3_client = s3_client
405 super(AtomicS3File, self).__init__(path)
406
407 def move_to_final_destination(self):
408 self.s3_client.put_multipart(self.tmp_path, self.path)
409
410
411 class ReadableS3File(object):
412
413 def __init__(self, s3_key):
414 self.s3_key = s3_key
415 self.buffer = []
416 self.closed = False
417 self.finished = False
418
419 def read(self, size=0):
420 f = self.s3_key.read(size=size)
421
422 # boto will loop on the key forever and it's not what is expected by
423 # the python io interface
424 # boto/boto#2805
425 if f == b'':
426 self.finished = True
427 if self.finished:
428 return b''
429
430 return f
431
432 def close(self):
433 self.s3_key.close()
434 self.closed = True
435
436 def __del__(self):
437 self.close()
438
439 def __exit__(self, exc_type, exc, traceback):
440 self.close()
441
442 def __enter__(self):
443 return self
444
445 def _add_to_buffer(self, line):
446 self.buffer.append(line)
447
448 def _flush_buffer(self):
449 output = b''.join(self.buffer)
450 self.buffer = []
451 return output
452
453 def readable(self):
454 return True
455
456 def writable(self):
457 return False
458
459 def seekable(self):
460 return False
461
462 def __iter__(self):
463 key_iter = self.s3_key.__iter__()
464
465 has_next = True
466 while has_next:
467 try:
468 # grab the next chunk
469 chunk = next(key_iter)
470
471 # split on newlines, preserving the newline
472 for line in chunk.splitlines(True):
473
474 if not line.endswith(os.linesep):
475 # no newline, so store in buffer
476 self._add_to_buffer(line)
477 else:
478 # newline found, send it out
479 if self.buffer:
480 self._add_to_buffer(line)
481 yield self._flush_buffer()
482 else:
483 yield line
484 except StopIteration:
485 # send out anything we have left in the buffer
486 output = self._flush_buffer()
487 if output:
488 yield output
489 has_next = False
490 self.close()
491
492
493 class S3Target(FileSystemTarget):
494 """
495 """
496
497 fs = None
498
499 def __init__(self, path, format=None, client=None):
500 super(S3Target, self).__init__(path)
501 if format is None:
502 format = get_default_format()
503
504 self.format = format
505 self.fs = client or S3Client()
506
507 def open(self, mode='r'):
508 """
509 """
510 if mode not in ('r', 'w'):
511 raise ValueError("Unsupported open mode '%s'" % mode)
512
513 if mode == 'r':
514 s3_key = self.fs.get_key(self.path)
515 if not s3_key:
516 raise FileNotFoundException("Could not find file at %s" % self.path)
517
518 fileobj = ReadableS3File(s3_key)
519 return self.format.pipe_reader(fileobj)
520 else:
521 return self.format.pipe_writer(AtomicS3File(self.path, self.fs))
522
523
524 class S3FlagTarget(S3Target):
525 """
526 Defines a target directory with a flag-file (defaults to `_SUCCESS`) used
527 to signify job success.
528
529 This checks for two things:
530
531 * the path exists (just like the S3Target)
532 * the _SUCCESS file exists within the directory.
533
534 Because Hadoop outputs into a directory and not a single file,
535 the path is assumed to be a directory.
536
537 This is meant to be a handy alternative to AtomicS3File.
538
539 The AtomicFile approach can be burdensome for S3 since there are no directories, per se.
540
541 If we have 1,000,000 output files, then we have to rename 1,000,000 objects.
542 """
543
544 fs = None
545
546 def __init__(self, path, format=None, client=None, flag='_SUCCESS'):
547 """
548 Initializes a S3FlagTarget.
549
550 :param path: the directory where the files are stored.
551 :type path: str
552 :param client:
553 :type client:
554 :param flag:
555 :type flag: str
556 """
557 if format is None:
558 format = get_default_format()
559
560 if path[-1] != "/":
561 raise ValueError("S3FlagTarget requires the path to be to a "
562 "directory. It must end with a slash ( / ).")
563 super(S3FlagTarget, self).__init__(path)
564 self.format = format
565 self.fs = client or S3Client()
566 self.flag = flag
567
568 def exists(self):
569 hadoopSemaphore = self.path + self.flag
570 return self.fs.exists(hadoopSemaphore)
571
572
573 class S3EmrTarget(S3FlagTarget):
574 """
575 Deprecated. Use :py:class:`S3FlagTarget`
576 """
577
578 def __init__(self, *args, **kwargs):
579 warnings.warn("S3EmrTarget is deprecated. Please use S3FlagTarget")
580 super(S3EmrTarget, self).__init__(*args, **kwargs)
581
582
583 class S3PathTask(ExternalTask):
584 """
585 A external task that to require existence of a path in S3.
586 """
587 path = Parameter()
588
589 def output(self):
590 return S3Target(self.path)
591
592
593 class S3EmrTask(ExternalTask):
594 """
595 An external task that requires the existence of EMR output in S3.
596 """
597 path = Parameter()
598
599 def output(self):
600 return S3EmrTarget(self.path)
601
602
603 class S3FlagTask(ExternalTask):
604 """
605 An external task that requires the existence of EMR output in S3.
606 """
607 path = Parameter()
608 flag = Parameter(default=None)
609
610 def output(self):
611 return S3FlagTarget(self.path, flag=self.flag)
612
```
--- 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/luigi/s3.py b/luigi/s3.py
--- a/luigi/s3.py
+++ b/luigi/s3.py
@@ -501,6 +501,7 @@
if format is None:
format = get_default_format()
+ self.path = path
self.format = format
self.fs = client or S3Client()
| {"golden_diff": "diff --git a/luigi/s3.py b/luigi/s3.py\n--- a/luigi/s3.py\n+++ b/luigi/s3.py\n@@ -501,6 +501,7 @@\n if format is None:\n format = get_default_format()\n \n+ self.path = path\n self.format = format\n self.fs = client or S3Client()\n", "issue": "Add method to S3Target to get back path\nWith an `S3Target(path)`, we can load data into S3 at the specified path. It would be useful if we could also get back the path at which the target is pointing to so it can be used in subsequent tasks.\n\nCorrect me if I'm wrong, but I couldn't find any way to do this. I can work on a PR if this sounds reasonable.\n\n", "before_files": [{"content": "# -*- coding: utf-8 -*-\n#\n# Copyright 2012-2015 Spotify AB\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\"\"\"\nImplementation of Simple Storage Service support.\n:py:class:`S3Target` is a subclass of the Target class to support S3 file system operations\n\"\"\"\n\nfrom __future__ import division\n\nimport itertools\nimport logging\nimport os\nimport os.path\ntry:\n from urlparse import urlsplit\nexcept ImportError:\n from urllib.parse import urlsplit\nimport warnings\ntry:\n from ConfigParser import NoSectionError\nexcept ImportError:\n from configparser import NoSectionError\n\nfrom luigi import six\nfrom luigi.six.moves import range\n\nfrom luigi import configuration\nfrom luigi.format import get_default_format\nfrom luigi.parameter import Parameter\nfrom luigi.target import FileAlreadyExists, FileSystem, FileSystemException, FileSystemTarget, AtomicLocalFile, MissingParentDirectory\nfrom luigi.task import ExternalTask\n\nlogger = logging.getLogger('luigi-interface')\n\ntry:\n import boto\n from boto.s3.key import Key\nexcept ImportError:\n logger.warning(\"Loading s3 module without boto installed. Will crash at \"\n \"runtime if s3 functionality is used.\")\n\n\n# two different ways of marking a directory\n# with a suffix in S3\nS3_DIRECTORY_MARKER_SUFFIX_0 = '_$folder$'\nS3_DIRECTORY_MARKER_SUFFIX_1 = '/'\n\n\nclass InvalidDeleteException(FileSystemException):\n pass\n\n\nclass FileNotFoundException(FileSystemException):\n pass\n\n\nclass S3Client(FileSystem):\n \"\"\"\n boto-powered S3 client.\n \"\"\"\n\n def __init__(self, aws_access_key_id=None, aws_secret_access_key=None,\n **kwargs):\n options = self._get_s3_config()\n options.update(kwargs)\n # Removing key args would break backwards compability\n if not aws_access_key_id:\n aws_access_key_id = options.get('aws_access_key_id')\n if not aws_secret_access_key:\n aws_secret_access_key = options.get('aws_secret_access_key')\n for key in ['aws_access_key_id', 'aws_secret_access_key']:\n if key in options:\n options.pop(key)\n self.s3 = boto.connect_s3(aws_access_key_id,\n aws_secret_access_key,\n **options)\n\n def exists(self, path):\n \"\"\"\n Does provided path exist on S3?\n \"\"\"\n (bucket, key) = self._path_to_bucket_and_key(path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # root always exists\n if self._is_root(key):\n return True\n\n # file\n s3_key = s3_bucket.get_key(key)\n if s3_key:\n return True\n\n if self.isdir(path):\n return True\n\n logger.debug('Path %s does not exist', path)\n return False\n\n def remove(self, path, recursive=True):\n \"\"\"\n Remove a file or directory from S3.\n \"\"\"\n if not self.exists(path):\n logger.debug('Could not delete %s; path does not exist', path)\n return False\n\n (bucket, key) = self._path_to_bucket_and_key(path)\n\n # root\n if self._is_root(key):\n raise InvalidDeleteException(\n 'Cannot delete root of bucket at path %s' % path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # file\n s3_key = s3_bucket.get_key(key)\n if s3_key:\n s3_bucket.delete_key(s3_key)\n logger.debug('Deleting %s from bucket %s', key, bucket)\n return True\n\n if self.isdir(path) and not recursive:\n raise InvalidDeleteException(\n 'Path %s is a directory. Must use recursive delete' % path)\n\n delete_key_list = [\n k for k in s3_bucket.list(self._add_path_delimiter(key))]\n\n # delete the directory marker file if it exists\n s3_dir_with_suffix_key = s3_bucket.get_key(key + S3_DIRECTORY_MARKER_SUFFIX_0)\n if s3_dir_with_suffix_key:\n delete_key_list.append(s3_dir_with_suffix_key)\n\n if len(delete_key_list) > 0:\n for k in delete_key_list:\n logger.debug('Deleting %s from bucket %s', k, bucket)\n s3_bucket.delete_keys(delete_key_list)\n return True\n\n return False\n\n def get_key(self, path):\n (bucket, key) = self._path_to_bucket_and_key(path)\n\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n return s3_bucket.get_key(key)\n\n def put(self, local_path, destination_s3_path):\n \"\"\"\n Put an object stored locally to an S3 path.\n \"\"\"\n (bucket, key) = self._path_to_bucket_and_key(destination_s3_path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # put the file\n s3_key = Key(s3_bucket)\n s3_key.key = key\n s3_key.set_contents_from_filename(local_path)\n\n def put_string(self, content, destination_s3_path):\n \"\"\"\n Put a string to an S3 path.\n \"\"\"\n (bucket, key) = self._path_to_bucket_and_key(destination_s3_path)\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # put the content\n s3_key = Key(s3_bucket)\n s3_key.key = key\n s3_key.set_contents_from_string(content)\n\n def put_multipart(self, local_path, destination_s3_path, part_size=67108864):\n \"\"\"\n Put an object stored locally to an S3 path\n using S3 multi-part upload (for files > 5GB).\n\n :param local_path: Path to source local file\n :param destination_s3_path: URL for target S3 location\n :param part_size: Part size in bytes. Default: 67108864 (64MB), must be >= 5MB and <= 5 GB.\n \"\"\"\n # calculate number of parts to upload\n # based on the size of the file\n source_size = os.stat(local_path).st_size\n\n if source_size <= part_size:\n # fallback to standard, non-multipart strategy\n return self.put(local_path, destination_s3_path)\n\n (bucket, key) = self._path_to_bucket_and_key(destination_s3_path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # calculate the number of parts (int division).\n # use modulo to avoid float precision issues\n # for exactly-sized fits\n num_parts = \\\n (source_size // part_size) \\\n if source_size % part_size == 0 \\\n else (source_size // part_size) + 1\n\n mp = None\n try:\n mp = s3_bucket.initiate_multipart_upload(key)\n\n for i in range(num_parts):\n # upload a part at a time to S3\n offset = part_size * i\n bytes = min(part_size, source_size - offset)\n with open(local_path, 'rb') as fp:\n part_num = i + 1\n logger.info('Uploading part %s/%s to %s', part_num, num_parts, destination_s3_path)\n fp.seek(offset)\n mp.upload_part_from_file(fp, part_num=part_num, size=bytes)\n\n # finish the upload, making the file available in S3\n mp.complete_upload()\n except BaseException:\n if mp:\n logger.info('Canceling multipart s3 upload for %s', destination_s3_path)\n # cancel the upload so we don't get charged for\n # storage consumed by uploaded parts\n mp.cancel_upload()\n raise\n\n def get(self, s3_path, destination_local_path):\n \"\"\"\n Get an object stored in S3 and write it to a local path.\n \"\"\"\n (bucket, key) = self._path_to_bucket_and_key(s3_path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # download the file\n s3_key = Key(s3_bucket)\n s3_key.key = key\n s3_key.get_contents_to_filename(destination_local_path)\n\n def get_as_string(self, s3_path):\n \"\"\"\n Get the contents of an object stored in S3 as a string.\n \"\"\"\n (bucket, key) = self._path_to_bucket_and_key(s3_path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # get the content\n s3_key = Key(s3_bucket)\n s3_key.key = key\n contents = s3_key.get_contents_as_string()\n\n return contents\n\n def copy(self, source_path, destination_path):\n \"\"\"\n Copy an object from one S3 location to another.\n \"\"\"\n (src_bucket, src_key) = self._path_to_bucket_and_key(source_path)\n (dst_bucket, dst_key) = self._path_to_bucket_and_key(destination_path)\n\n s3_bucket = self.s3.get_bucket(dst_bucket, validate=True)\n\n if self.isdir(source_path):\n src_prefix = self._add_path_delimiter(src_key)\n dst_prefix = self._add_path_delimiter(dst_key)\n for key in self.list(source_path):\n s3_bucket.copy_key(dst_prefix + key,\n src_bucket,\n src_prefix + key)\n else:\n s3_bucket.copy_key(dst_key, src_bucket, src_key)\n\n def rename(self, source_path, destination_path):\n \"\"\"\n Rename/move an object from one S3 location to another.\n \"\"\"\n self.copy(source_path, destination_path)\n self.remove(source_path)\n\n def listdir(self, path):\n \"\"\"\n Get an iterable with S3 folder contents.\n Iterable contains paths relative to queried path.\n \"\"\"\n (bucket, key) = self._path_to_bucket_and_key(path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n key_path = self._add_path_delimiter(key)\n key_path_len = len(key_path)\n for item in s3_bucket.list(prefix=key_path):\n yield self._add_path_delimiter(path) + item.key[key_path_len:]\n\n def list(self, path): # backwards compat\n key_path_len = len(self._add_path_delimiter(path))\n for item in self.listdir(path):\n yield item[key_path_len:]\n\n def isdir(self, path):\n \"\"\"\n Is the parameter S3 path a directory?\n \"\"\"\n (bucket, key) = self._path_to_bucket_and_key(path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # root is a directory\n if self._is_root(key):\n return True\n\n for suffix in (S3_DIRECTORY_MARKER_SUFFIX_0,\n S3_DIRECTORY_MARKER_SUFFIX_1):\n s3_dir_with_suffix_key = s3_bucket.get_key(key + suffix)\n if s3_dir_with_suffix_key:\n return True\n\n # files with this prefix\n key_path = self._add_path_delimiter(key)\n s3_bucket_list_result = \\\n list(itertools.islice(\n s3_bucket.list(prefix=key_path),\n 1))\n if s3_bucket_list_result:\n return True\n\n return False\n is_dir = isdir # compatibility with old version.\n\n def mkdir(self, path, parents=True, raise_if_exists=False):\n if raise_if_exists and self.isdir(path):\n raise FileAlreadyExists()\n\n _, key = self._path_to_bucket_and_key(path)\n if self._is_root(key):\n return # isdir raises if the bucket doesn't exist; nothing to do here.\n\n key = self._add_path_delimiter(key)\n\n if not parents and not self.isdir(os.path.dirname(key)):\n raise MissingParentDirectory()\n\n return self.put_string(\"\", self._add_path_delimiter(path))\n\n def _get_s3_config(self, key=None):\n try:\n config = dict(configuration.get_config().items('s3'))\n except NoSectionError:\n return {}\n # So what ports etc can be read without us having to specify all dtypes\n for k, v in six.iteritems(config):\n try:\n config[k] = int(v)\n except ValueError:\n pass\n if key:\n return config.get(key)\n return config\n\n def _path_to_bucket_and_key(self, path):\n (scheme, netloc, path, query, fragment) = urlsplit(path)\n path_without_initial_slash = path[1:]\n return netloc, path_without_initial_slash\n\n def _is_root(self, key):\n return (len(key) == 0) or (key == '/')\n\n def _add_path_delimiter(self, key):\n return key if key[-1:] == '/' else key + '/'\n\n\nclass AtomicS3File(AtomicLocalFile):\n \"\"\"\n An S3 file that writes to a temp file and put to S3 on close.\n \"\"\"\n\n def __init__(self, path, s3_client):\n self.s3_client = s3_client\n super(AtomicS3File, self).__init__(path)\n\n def move_to_final_destination(self):\n self.s3_client.put_multipart(self.tmp_path, self.path)\n\n\nclass ReadableS3File(object):\n\n def __init__(self, s3_key):\n self.s3_key = s3_key\n self.buffer = []\n self.closed = False\n self.finished = False\n\n def read(self, size=0):\n f = self.s3_key.read(size=size)\n\n # boto will loop on the key forever and it's not what is expected by\n # the python io interface\n # boto/boto#2805\n if f == b'':\n self.finished = True\n if self.finished:\n return b''\n\n return f\n\n def close(self):\n self.s3_key.close()\n self.closed = True\n\n def __del__(self):\n self.close()\n\n def __exit__(self, exc_type, exc, traceback):\n self.close()\n\n def __enter__(self):\n return self\n\n def _add_to_buffer(self, line):\n self.buffer.append(line)\n\n def _flush_buffer(self):\n output = b''.join(self.buffer)\n self.buffer = []\n return output\n\n def readable(self):\n return True\n\n def writable(self):\n return False\n\n def seekable(self):\n return False\n\n def __iter__(self):\n key_iter = self.s3_key.__iter__()\n\n has_next = True\n while has_next:\n try:\n # grab the next chunk\n chunk = next(key_iter)\n\n # split on newlines, preserving the newline\n for line in chunk.splitlines(True):\n\n if not line.endswith(os.linesep):\n # no newline, so store in buffer\n self._add_to_buffer(line)\n else:\n # newline found, send it out\n if self.buffer:\n self._add_to_buffer(line)\n yield self._flush_buffer()\n else:\n yield line\n except StopIteration:\n # send out anything we have left in the buffer\n output = self._flush_buffer()\n if output:\n yield output\n has_next = False\n self.close()\n\n\nclass S3Target(FileSystemTarget):\n \"\"\"\n \"\"\"\n\n fs = None\n\n def __init__(self, path, format=None, client=None):\n super(S3Target, self).__init__(path)\n if format is None:\n format = get_default_format()\n\n self.format = format\n self.fs = client or S3Client()\n\n def open(self, mode='r'):\n \"\"\"\n \"\"\"\n if mode not in ('r', 'w'):\n raise ValueError(\"Unsupported open mode '%s'\" % mode)\n\n if mode == 'r':\n s3_key = self.fs.get_key(self.path)\n if not s3_key:\n raise FileNotFoundException(\"Could not find file at %s\" % self.path)\n\n fileobj = ReadableS3File(s3_key)\n return self.format.pipe_reader(fileobj)\n else:\n return self.format.pipe_writer(AtomicS3File(self.path, self.fs))\n\n\nclass S3FlagTarget(S3Target):\n \"\"\"\n Defines a target directory with a flag-file (defaults to `_SUCCESS`) used\n to signify job success.\n\n This checks for two things:\n\n * the path exists (just like the S3Target)\n * the _SUCCESS file exists within the directory.\n\n Because Hadoop outputs into a directory and not a single file,\n the path is assumed to be a directory.\n\n This is meant to be a handy alternative to AtomicS3File.\n\n The AtomicFile approach can be burdensome for S3 since there are no directories, per se.\n\n If we have 1,000,000 output files, then we have to rename 1,000,000 objects.\n \"\"\"\n\n fs = None\n\n def __init__(self, path, format=None, client=None, flag='_SUCCESS'):\n \"\"\"\n Initializes a S3FlagTarget.\n\n :param path: the directory where the files are stored.\n :type path: str\n :param client:\n :type client:\n :param flag:\n :type flag: str\n \"\"\"\n if format is None:\n format = get_default_format()\n\n if path[-1] != \"/\":\n raise ValueError(\"S3FlagTarget requires the path to be to a \"\n \"directory. It must end with a slash ( / ).\")\n super(S3FlagTarget, self).__init__(path)\n self.format = format\n self.fs = client or S3Client()\n self.flag = flag\n\n def exists(self):\n hadoopSemaphore = self.path + self.flag\n return self.fs.exists(hadoopSemaphore)\n\n\nclass S3EmrTarget(S3FlagTarget):\n \"\"\"\n Deprecated. Use :py:class:`S3FlagTarget`\n \"\"\"\n\n def __init__(self, *args, **kwargs):\n warnings.warn(\"S3EmrTarget is deprecated. Please use S3FlagTarget\")\n super(S3EmrTarget, self).__init__(*args, **kwargs)\n\n\nclass S3PathTask(ExternalTask):\n \"\"\"\n A external task that to require existence of a path in S3.\n \"\"\"\n path = Parameter()\n\n def output(self):\n return S3Target(self.path)\n\n\nclass S3EmrTask(ExternalTask):\n \"\"\"\n An external task that requires the existence of EMR output in S3.\n \"\"\"\n path = Parameter()\n\n def output(self):\n return S3EmrTarget(self.path)\n\n\nclass S3FlagTask(ExternalTask):\n \"\"\"\n An external task that requires the existence of EMR output in S3.\n \"\"\"\n path = Parameter()\n flag = Parameter(default=None)\n\n def output(self):\n return S3FlagTarget(self.path, flag=self.flag)\n", "path": "luigi/s3.py"}], "after_files": [{"content": "# -*- coding: utf-8 -*-\n#\n# Copyright 2012-2015 Spotify AB\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\"\"\"\nImplementation of Simple Storage Service support.\n:py:class:`S3Target` is a subclass of the Target class to support S3 file system operations\n\"\"\"\n\nfrom __future__ import division\n\nimport itertools\nimport logging\nimport os\nimport os.path\ntry:\n from urlparse import urlsplit\nexcept ImportError:\n from urllib.parse import urlsplit\nimport warnings\ntry:\n from ConfigParser import NoSectionError\nexcept ImportError:\n from configparser import NoSectionError\n\nfrom luigi import six\nfrom luigi.six.moves import range\n\nfrom luigi import configuration\nfrom luigi.format import get_default_format\nfrom luigi.parameter import Parameter\nfrom luigi.target import FileAlreadyExists, FileSystem, FileSystemException, FileSystemTarget, AtomicLocalFile, MissingParentDirectory\nfrom luigi.task import ExternalTask\n\nlogger = logging.getLogger('luigi-interface')\n\ntry:\n import boto\n from boto.s3.key import Key\nexcept ImportError:\n logger.warning(\"Loading s3 module without boto installed. Will crash at \"\n \"runtime if s3 functionality is used.\")\n\n\n# two different ways of marking a directory\n# with a suffix in S3\nS3_DIRECTORY_MARKER_SUFFIX_0 = '_$folder$'\nS3_DIRECTORY_MARKER_SUFFIX_1 = '/'\n\n\nclass InvalidDeleteException(FileSystemException):\n pass\n\n\nclass FileNotFoundException(FileSystemException):\n pass\n\n\nclass S3Client(FileSystem):\n \"\"\"\n boto-powered S3 client.\n \"\"\"\n\n def __init__(self, aws_access_key_id=None, aws_secret_access_key=None,\n **kwargs):\n options = self._get_s3_config()\n options.update(kwargs)\n # Removing key args would break backwards compability\n if not aws_access_key_id:\n aws_access_key_id = options.get('aws_access_key_id')\n if not aws_secret_access_key:\n aws_secret_access_key = options.get('aws_secret_access_key')\n for key in ['aws_access_key_id', 'aws_secret_access_key']:\n if key in options:\n options.pop(key)\n self.s3 = boto.connect_s3(aws_access_key_id,\n aws_secret_access_key,\n **options)\n\n def exists(self, path):\n \"\"\"\n Does provided path exist on S3?\n \"\"\"\n (bucket, key) = self._path_to_bucket_and_key(path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # root always exists\n if self._is_root(key):\n return True\n\n # file\n s3_key = s3_bucket.get_key(key)\n if s3_key:\n return True\n\n if self.isdir(path):\n return True\n\n logger.debug('Path %s does not exist', path)\n return False\n\n def remove(self, path, recursive=True):\n \"\"\"\n Remove a file or directory from S3.\n \"\"\"\n if not self.exists(path):\n logger.debug('Could not delete %s; path does not exist', path)\n return False\n\n (bucket, key) = self._path_to_bucket_and_key(path)\n\n # root\n if self._is_root(key):\n raise InvalidDeleteException(\n 'Cannot delete root of bucket at path %s' % path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # file\n s3_key = s3_bucket.get_key(key)\n if s3_key:\n s3_bucket.delete_key(s3_key)\n logger.debug('Deleting %s from bucket %s', key, bucket)\n return True\n\n if self.isdir(path) and not recursive:\n raise InvalidDeleteException(\n 'Path %s is a directory. Must use recursive delete' % path)\n\n delete_key_list = [\n k for k in s3_bucket.list(self._add_path_delimiter(key))]\n\n # delete the directory marker file if it exists\n s3_dir_with_suffix_key = s3_bucket.get_key(key + S3_DIRECTORY_MARKER_SUFFIX_0)\n if s3_dir_with_suffix_key:\n delete_key_list.append(s3_dir_with_suffix_key)\n\n if len(delete_key_list) > 0:\n for k in delete_key_list:\n logger.debug('Deleting %s from bucket %s', k, bucket)\n s3_bucket.delete_keys(delete_key_list)\n return True\n\n return False\n\n def get_key(self, path):\n (bucket, key) = self._path_to_bucket_and_key(path)\n\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n return s3_bucket.get_key(key)\n\n def put(self, local_path, destination_s3_path):\n \"\"\"\n Put an object stored locally to an S3 path.\n \"\"\"\n (bucket, key) = self._path_to_bucket_and_key(destination_s3_path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # put the file\n s3_key = Key(s3_bucket)\n s3_key.key = key\n s3_key.set_contents_from_filename(local_path)\n\n def put_string(self, content, destination_s3_path):\n \"\"\"\n Put a string to an S3 path.\n \"\"\"\n (bucket, key) = self._path_to_bucket_and_key(destination_s3_path)\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # put the content\n s3_key = Key(s3_bucket)\n s3_key.key = key\n s3_key.set_contents_from_string(content)\n\n def put_multipart(self, local_path, destination_s3_path, part_size=67108864):\n \"\"\"\n Put an object stored locally to an S3 path\n using S3 multi-part upload (for files > 5GB).\n\n :param local_path: Path to source local file\n :param destination_s3_path: URL for target S3 location\n :param part_size: Part size in bytes. Default: 67108864 (64MB), must be >= 5MB and <= 5 GB.\n \"\"\"\n # calculate number of parts to upload\n # based on the size of the file\n source_size = os.stat(local_path).st_size\n\n if source_size <= part_size:\n # fallback to standard, non-multipart strategy\n return self.put(local_path, destination_s3_path)\n\n (bucket, key) = self._path_to_bucket_and_key(destination_s3_path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # calculate the number of parts (int division).\n # use modulo to avoid float precision issues\n # for exactly-sized fits\n num_parts = \\\n (source_size // part_size) \\\n if source_size % part_size == 0 \\\n else (source_size // part_size) + 1\n\n mp = None\n try:\n mp = s3_bucket.initiate_multipart_upload(key)\n\n for i in range(num_parts):\n # upload a part at a time to S3\n offset = part_size * i\n bytes = min(part_size, source_size - offset)\n with open(local_path, 'rb') as fp:\n part_num = i + 1\n logger.info('Uploading part %s/%s to %s', part_num, num_parts, destination_s3_path)\n fp.seek(offset)\n mp.upload_part_from_file(fp, part_num=part_num, size=bytes)\n\n # finish the upload, making the file available in S3\n mp.complete_upload()\n except BaseException:\n if mp:\n logger.info('Canceling multipart s3 upload for %s', destination_s3_path)\n # cancel the upload so we don't get charged for\n # storage consumed by uploaded parts\n mp.cancel_upload()\n raise\n\n def get(self, s3_path, destination_local_path):\n \"\"\"\n Get an object stored in S3 and write it to a local path.\n \"\"\"\n (bucket, key) = self._path_to_bucket_and_key(s3_path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # download the file\n s3_key = Key(s3_bucket)\n s3_key.key = key\n s3_key.get_contents_to_filename(destination_local_path)\n\n def get_as_string(self, s3_path):\n \"\"\"\n Get the contents of an object stored in S3 as a string.\n \"\"\"\n (bucket, key) = self._path_to_bucket_and_key(s3_path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # get the content\n s3_key = Key(s3_bucket)\n s3_key.key = key\n contents = s3_key.get_contents_as_string()\n\n return contents\n\n def copy(self, source_path, destination_path):\n \"\"\"\n Copy an object from one S3 location to another.\n \"\"\"\n (src_bucket, src_key) = self._path_to_bucket_and_key(source_path)\n (dst_bucket, dst_key) = self._path_to_bucket_and_key(destination_path)\n\n s3_bucket = self.s3.get_bucket(dst_bucket, validate=True)\n\n if self.isdir(source_path):\n src_prefix = self._add_path_delimiter(src_key)\n dst_prefix = self._add_path_delimiter(dst_key)\n for key in self.list(source_path):\n s3_bucket.copy_key(dst_prefix + key,\n src_bucket,\n src_prefix + key)\n else:\n s3_bucket.copy_key(dst_key, src_bucket, src_key)\n\n def rename(self, source_path, destination_path):\n \"\"\"\n Rename/move an object from one S3 location to another.\n \"\"\"\n self.copy(source_path, destination_path)\n self.remove(source_path)\n\n def listdir(self, path):\n \"\"\"\n Get an iterable with S3 folder contents.\n Iterable contains paths relative to queried path.\n \"\"\"\n (bucket, key) = self._path_to_bucket_and_key(path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n key_path = self._add_path_delimiter(key)\n key_path_len = len(key_path)\n for item in s3_bucket.list(prefix=key_path):\n yield self._add_path_delimiter(path) + item.key[key_path_len:]\n\n def list(self, path): # backwards compat\n key_path_len = len(self._add_path_delimiter(path))\n for item in self.listdir(path):\n yield item[key_path_len:]\n\n def isdir(self, path):\n \"\"\"\n Is the parameter S3 path a directory?\n \"\"\"\n (bucket, key) = self._path_to_bucket_and_key(path)\n\n # grab and validate the bucket\n s3_bucket = self.s3.get_bucket(bucket, validate=True)\n\n # root is a directory\n if self._is_root(key):\n return True\n\n for suffix in (S3_DIRECTORY_MARKER_SUFFIX_0,\n S3_DIRECTORY_MARKER_SUFFIX_1):\n s3_dir_with_suffix_key = s3_bucket.get_key(key + suffix)\n if s3_dir_with_suffix_key:\n return True\n\n # files with this prefix\n key_path = self._add_path_delimiter(key)\n s3_bucket_list_result = \\\n list(itertools.islice(\n s3_bucket.list(prefix=key_path),\n 1))\n if s3_bucket_list_result:\n return True\n\n return False\n is_dir = isdir # compatibility with old version.\n\n def mkdir(self, path, parents=True, raise_if_exists=False):\n if raise_if_exists and self.isdir(path):\n raise FileAlreadyExists()\n\n _, key = self._path_to_bucket_and_key(path)\n if self._is_root(key):\n return # isdir raises if the bucket doesn't exist; nothing to do here.\n\n key = self._add_path_delimiter(key)\n\n if not parents and not self.isdir(os.path.dirname(key)):\n raise MissingParentDirectory()\n\n return self.put_string(\"\", self._add_path_delimiter(path))\n\n def _get_s3_config(self, key=None):\n try:\n config = dict(configuration.get_config().items('s3'))\n except NoSectionError:\n return {}\n # So what ports etc can be read without us having to specify all dtypes\n for k, v in six.iteritems(config):\n try:\n config[k] = int(v)\n except ValueError:\n pass\n if key:\n return config.get(key)\n return config\n\n def _path_to_bucket_and_key(self, path):\n (scheme, netloc, path, query, fragment) = urlsplit(path)\n path_without_initial_slash = path[1:]\n return netloc, path_without_initial_slash\n\n def _is_root(self, key):\n return (len(key) == 0) or (key == '/')\n\n def _add_path_delimiter(self, key):\n return key if key[-1:] == '/' else key + '/'\n\n\nclass AtomicS3File(AtomicLocalFile):\n \"\"\"\n An S3 file that writes to a temp file and put to S3 on close.\n \"\"\"\n\n def __init__(self, path, s3_client):\n self.s3_client = s3_client\n super(AtomicS3File, self).__init__(path)\n\n def move_to_final_destination(self):\n self.s3_client.put_multipart(self.tmp_path, self.path)\n\n\nclass ReadableS3File(object):\n\n def __init__(self, s3_key):\n self.s3_key = s3_key\n self.buffer = []\n self.closed = False\n self.finished = False\n\n def read(self, size=0):\n f = self.s3_key.read(size=size)\n\n # boto will loop on the key forever and it's not what is expected by\n # the python io interface\n # boto/boto#2805\n if f == b'':\n self.finished = True\n if self.finished:\n return b''\n\n return f\n\n def close(self):\n self.s3_key.close()\n self.closed = True\n\n def __del__(self):\n self.close()\n\n def __exit__(self, exc_type, exc, traceback):\n self.close()\n\n def __enter__(self):\n return self\n\n def _add_to_buffer(self, line):\n self.buffer.append(line)\n\n def _flush_buffer(self):\n output = b''.join(self.buffer)\n self.buffer = []\n return output\n\n def readable(self):\n return True\n\n def writable(self):\n return False\n\n def seekable(self):\n return False\n\n def __iter__(self):\n key_iter = self.s3_key.__iter__()\n\n has_next = True\n while has_next:\n try:\n # grab the next chunk\n chunk = next(key_iter)\n\n # split on newlines, preserving the newline\n for line in chunk.splitlines(True):\n\n if not line.endswith(os.linesep):\n # no newline, so store in buffer\n self._add_to_buffer(line)\n else:\n # newline found, send it out\n if self.buffer:\n self._add_to_buffer(line)\n yield self._flush_buffer()\n else:\n yield line\n except StopIteration:\n # send out anything we have left in the buffer\n output = self._flush_buffer()\n if output:\n yield output\n has_next = False\n self.close()\n\n\nclass S3Target(FileSystemTarget):\n \"\"\"\n \"\"\"\n\n fs = None\n\n def __init__(self, path, format=None, client=None):\n super(S3Target, self).__init__(path)\n if format is None:\n format = get_default_format()\n\n self.path = path\n self.format = format\n self.fs = client or S3Client()\n\n def open(self, mode='r'):\n \"\"\"\n \"\"\"\n if mode not in ('r', 'w'):\n raise ValueError(\"Unsupported open mode '%s'\" % mode)\n\n if mode == 'r':\n s3_key = self.fs.get_key(self.path)\n if not s3_key:\n raise FileNotFoundException(\"Could not find file at %s\" % self.path)\n\n fileobj = ReadableS3File(s3_key)\n return self.format.pipe_reader(fileobj)\n else:\n return self.format.pipe_writer(AtomicS3File(self.path, self.fs))\n\n\nclass S3FlagTarget(S3Target):\n \"\"\"\n Defines a target directory with a flag-file (defaults to `_SUCCESS`) used\n to signify job success.\n\n This checks for two things:\n\n * the path exists (just like the S3Target)\n * the _SUCCESS file exists within the directory.\n\n Because Hadoop outputs into a directory and not a single file,\n the path is assumed to be a directory.\n\n This is meant to be a handy alternative to AtomicS3File.\n\n The AtomicFile approach can be burdensome for S3 since there are no directories, per se.\n\n If we have 1,000,000 output files, then we have to rename 1,000,000 objects.\n \"\"\"\n\n fs = None\n\n def __init__(self, path, format=None, client=None, flag='_SUCCESS'):\n \"\"\"\n Initializes a S3FlagTarget.\n\n :param path: the directory where the files are stored.\n :type path: str\n :param client:\n :type client:\n :param flag:\n :type flag: str\n \"\"\"\n if format is None:\n format = get_default_format()\n\n if path[-1] != \"/\":\n raise ValueError(\"S3FlagTarget requires the path to be to a \"\n \"directory. It must end with a slash ( / ).\")\n super(S3FlagTarget, self).__init__(path)\n self.format = format\n self.fs = client or S3Client()\n self.flag = flag\n\n def exists(self):\n hadoopSemaphore = self.path + self.flag\n return self.fs.exists(hadoopSemaphore)\n\n\nclass S3EmrTarget(S3FlagTarget):\n \"\"\"\n Deprecated. Use :py:class:`S3FlagTarget`\n \"\"\"\n\n def __init__(self, *args, **kwargs):\n warnings.warn(\"S3EmrTarget is deprecated. Please use S3FlagTarget\")\n super(S3EmrTarget, self).__init__(*args, **kwargs)\n\n\nclass S3PathTask(ExternalTask):\n \"\"\"\n A external task that to require existence of a path in S3.\n \"\"\"\n path = Parameter()\n\n def output(self):\n return S3Target(self.path)\n\n\nclass S3EmrTask(ExternalTask):\n \"\"\"\n An external task that requires the existence of EMR output in S3.\n \"\"\"\n path = Parameter()\n\n def output(self):\n return S3EmrTarget(self.path)\n\n\nclass S3FlagTask(ExternalTask):\n \"\"\"\n An external task that requires the existence of EMR output in S3.\n \"\"\"\n path = Parameter()\n flag = Parameter(default=None)\n\n def output(self):\n return S3FlagTarget(self.path, flag=self.flag)\n", "path": "luigi/s3.py"}]} |
gh_patches_debug_205 | rasdani/github-patches | git_diff | vllm-project__vllm-3129 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[v0.3.3] Release Tracker
**ETA**: Feb 29th - Mar 1st
## Major changes
* StarCoder2 support
* Performance optimization and LoRA support for Gemma
* Performance optimization for MoE kernel
* 2/3/8-bit GPTQ support
* [Experimental] AWS Inferentia2 support
## PRs to be merged before the release
- [x] #2330 #2223
- [ ] ~~#2761~~
- [x] #2819
- [x] #3087 #3099
- [x] #3089
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `vllm/__init__.py`
Content:
```
1 """vLLM: a high-throughput and memory-efficient inference engine for LLMs"""
2
3 from vllm.engine.arg_utils import AsyncEngineArgs, EngineArgs
4 from vllm.engine.async_llm_engine import AsyncLLMEngine
5 from vllm.engine.llm_engine import LLMEngine
6 from vllm.engine.ray_utils import initialize_cluster
7 from vllm.entrypoints.llm import LLM
8 from vllm.outputs import CompletionOutput, RequestOutput
9 from vllm.sampling_params import SamplingParams
10
11 __version__ = "0.3.2"
12
13 __all__ = [
14 "LLM",
15 "SamplingParams",
16 "RequestOutput",
17 "CompletionOutput",
18 "LLMEngine",
19 "EngineArgs",
20 "AsyncLLMEngine",
21 "AsyncEngineArgs",
22 "initialize_cluster",
23 ]
24
```
--- 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/vllm/__init__.py b/vllm/__init__.py
--- a/vllm/__init__.py
+++ b/vllm/__init__.py
@@ -8,7 +8,7 @@
from vllm.outputs import CompletionOutput, RequestOutput
from vllm.sampling_params import SamplingParams
-__version__ = "0.3.2"
+__version__ = "0.3.3"
__all__ = [
"LLM",
| {"golden_diff": "diff --git a/vllm/__init__.py b/vllm/__init__.py\n--- a/vllm/__init__.py\n+++ b/vllm/__init__.py\n@@ -8,7 +8,7 @@\n from vllm.outputs import CompletionOutput, RequestOutput\n from vllm.sampling_params import SamplingParams\n \n-__version__ = \"0.3.2\"\n+__version__ = \"0.3.3\"\n \n __all__ = [\n \"LLM\",\n", "issue": "[v0.3.3] Release Tracker\n**ETA**: Feb 29th - Mar 1st\r\n\r\n## Major changes\r\n\r\n* StarCoder2 support\r\n* Performance optimization and LoRA support for Gemma\r\n* Performance optimization for MoE kernel\r\n* 2/3/8-bit GPTQ support\r\n* [Experimental] AWS Inferentia2 support\r\n\r\n## PRs to be merged before the release\r\n\r\n- [x] #2330 #2223\r\n- [ ] ~~#2761~~\r\n- [x] #2819 \r\n- [x] #3087 #3099\r\n- [x] #3089 \n", "before_files": [{"content": "\"\"\"vLLM: a high-throughput and memory-efficient inference engine for LLMs\"\"\"\n\nfrom vllm.engine.arg_utils import AsyncEngineArgs, EngineArgs\nfrom vllm.engine.async_llm_engine import AsyncLLMEngine\nfrom vllm.engine.llm_engine import LLMEngine\nfrom vllm.engine.ray_utils import initialize_cluster\nfrom vllm.entrypoints.llm import LLM\nfrom vllm.outputs import CompletionOutput, RequestOutput\nfrom vllm.sampling_params import SamplingParams\n\n__version__ = \"0.3.2\"\n\n__all__ = [\n \"LLM\",\n \"SamplingParams\",\n \"RequestOutput\",\n \"CompletionOutput\",\n \"LLMEngine\",\n \"EngineArgs\",\n \"AsyncLLMEngine\",\n \"AsyncEngineArgs\",\n \"initialize_cluster\",\n]\n", "path": "vllm/__init__.py"}], "after_files": [{"content": "\"\"\"vLLM: a high-throughput and memory-efficient inference engine for LLMs\"\"\"\n\nfrom vllm.engine.arg_utils import AsyncEngineArgs, EngineArgs\nfrom vllm.engine.async_llm_engine import AsyncLLMEngine\nfrom vllm.engine.llm_engine import LLMEngine\nfrom vllm.engine.ray_utils import initialize_cluster\nfrom vllm.entrypoints.llm import LLM\nfrom vllm.outputs import CompletionOutput, RequestOutput\nfrom vllm.sampling_params import SamplingParams\n\n__version__ = \"0.3.3\"\n\n__all__ = [\n \"LLM\",\n \"SamplingParams\",\n \"RequestOutput\",\n \"CompletionOutput\",\n \"LLMEngine\",\n \"EngineArgs\",\n \"AsyncLLMEngine\",\n \"AsyncEngineArgs\",\n \"initialize_cluster\",\n]\n", "path": "vllm/__init__.py"}]} |
gh_patches_debug_206 | rasdani/github-patches | git_diff | vllm-project__vllm-2887 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[v0.3.1] Release Tracker
**ETA**: Feb 14-16 th
## Major changes
TBD
## PRs to be merged before the release
- [x] #2855
- [x] #2845
- [x] ~~#2514~~
- [x] Ensure memory release when `LLM` class is deleted. #2882
- [x] #2875 #2880
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `vllm/__init__.py`
Content:
```
1 """vLLM: a high-throughput and memory-efficient inference engine for LLMs"""
2
3 from vllm.engine.arg_utils import AsyncEngineArgs, EngineArgs
4 from vllm.engine.async_llm_engine import AsyncLLMEngine
5 from vllm.engine.llm_engine import LLMEngine
6 from vllm.engine.ray_utils import initialize_cluster
7 from vllm.entrypoints.llm import LLM
8 from vllm.outputs import CompletionOutput, RequestOutput
9 from vllm.sampling_params import SamplingParams
10
11 __version__ = "0.3.0"
12
13 __all__ = [
14 "LLM",
15 "SamplingParams",
16 "RequestOutput",
17 "CompletionOutput",
18 "LLMEngine",
19 "EngineArgs",
20 "AsyncLLMEngine",
21 "AsyncEngineArgs",
22 "initialize_cluster",
23 ]
24
```
--- 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/vllm/__init__.py b/vllm/__init__.py
--- a/vllm/__init__.py
+++ b/vllm/__init__.py
@@ -8,7 +8,7 @@
from vllm.outputs import CompletionOutput, RequestOutput
from vllm.sampling_params import SamplingParams
-__version__ = "0.3.0"
+__version__ = "0.3.1"
__all__ = [
"LLM",
| {"golden_diff": "diff --git a/vllm/__init__.py b/vllm/__init__.py\n--- a/vllm/__init__.py\n+++ b/vllm/__init__.py\n@@ -8,7 +8,7 @@\n from vllm.outputs import CompletionOutput, RequestOutput\n from vllm.sampling_params import SamplingParams\n \n-__version__ = \"0.3.0\"\n+__version__ = \"0.3.1\"\n \n __all__ = [\n \"LLM\",\n", "issue": "[v0.3.1] Release Tracker\n**ETA**: Feb 14-16 th\r\n\r\n## Major changes\r\n\r\nTBD\r\n\r\n## PRs to be merged before the release\r\n\r\n- [x] #2855 \r\n- [x] #2845 \r\n- [x] ~~#2514~~\r\n- [x] Ensure memory release when `LLM` class is deleted. #2882 \r\n- [x] #2875 #2880\n", "before_files": [{"content": "\"\"\"vLLM: a high-throughput and memory-efficient inference engine for LLMs\"\"\"\n\nfrom vllm.engine.arg_utils import AsyncEngineArgs, EngineArgs\nfrom vllm.engine.async_llm_engine import AsyncLLMEngine\nfrom vllm.engine.llm_engine import LLMEngine\nfrom vllm.engine.ray_utils import initialize_cluster\nfrom vllm.entrypoints.llm import LLM\nfrom vllm.outputs import CompletionOutput, RequestOutput\nfrom vllm.sampling_params import SamplingParams\n\n__version__ = \"0.3.0\"\n\n__all__ = [\n \"LLM\",\n \"SamplingParams\",\n \"RequestOutput\",\n \"CompletionOutput\",\n \"LLMEngine\",\n \"EngineArgs\",\n \"AsyncLLMEngine\",\n \"AsyncEngineArgs\",\n \"initialize_cluster\",\n]\n", "path": "vllm/__init__.py"}], "after_files": [{"content": "\"\"\"vLLM: a high-throughput and memory-efficient inference engine for LLMs\"\"\"\n\nfrom vllm.engine.arg_utils import AsyncEngineArgs, EngineArgs\nfrom vllm.engine.async_llm_engine import AsyncLLMEngine\nfrom vllm.engine.llm_engine import LLMEngine\nfrom vllm.engine.ray_utils import initialize_cluster\nfrom vllm.entrypoints.llm import LLM\nfrom vllm.outputs import CompletionOutput, RequestOutput\nfrom vllm.sampling_params import SamplingParams\n\n__version__ = \"0.3.1\"\n\n__all__ = [\n \"LLM\",\n \"SamplingParams\",\n \"RequestOutput\",\n \"CompletionOutput\",\n \"LLMEngine\",\n \"EngineArgs\",\n \"AsyncLLMEngine\",\n \"AsyncEngineArgs\",\n \"initialize_cluster\",\n]\n", "path": "vllm/__init__.py"}]} |
gh_patches_debug_207 | rasdani/github-patches | git_diff | Gallopsled__pwntools-1252 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
'from pwn import *' fails when one of the command line args is a Base64 string (or has more than one equal sign)
The argument parsing functionality invoked by `from pwn import *` causes an error when one of the command line arguments has more than one equal sign:
`echo "from pwn import *\nprint('hello world')" > test.py`
`python test.py afdsa==`
```
Traceback (most recent call last):
File "test.py", line 1, in <module>
from pwn import *
File "/usr/local/lib/python2.7/site-packages/pwn/__init__.py", line 6, in <module>
pwnlib.args.initialize()
File "/usr/local/lib/python2.7/site-packages/pwnlib/args.py", line 197, in initialize
arg, value = arg.split('=')
ValueError: too many values to unpack
```
https://github.com/Gallopsled/pwntools/blob/dev/pwnlib/args.py#L197 probably just needs to be changed to `if arg.count("=") == 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: `pwnlib/args.py`
Content:
```
1
2 #!/usr/bin/env python2
3 """
4 Pwntools exposes several magic command-line arguments and environment
5 variables when operating in `from pwn import *` mode.
6
7 The arguments extracted from the command-line and removed from ``sys.argv``.
8
9 Arguments can be set by appending them to the command-line, or setting
10 them in the environment prefixed by ``PWNLIB_``.
11
12 The easiest example is to enable more verbose debugging. Just set ``DEBUG``.
13
14 .. code-block:: bash
15
16 $ PWNLIB_DEBUG=1 python exploit.py
17 $ python exploit.py DEBUG
18
19 These arguments are automatically extracted, regardless of their name, and
20 exposed via :mod:`pwnlib.args.args`, which is exposed as the global variable
21 :data:`args`. Arguments which ``pwntools`` reserves internally are not exposed
22 this way.
23
24 .. code-block:: bash
25
26 $ python -c 'from pwn import *; print args' A=1 B=Hello HOST=1.2.3.4 DEBUG
27 defaultdict(<type 'str'>, {'A': '1', 'HOST': '1.2.3.4', 'B': 'Hello'})
28
29 This is very useful for conditional code, for example determining whether to
30 run an exploit locally or to connect to a remote server. Arguments which are
31 not specified evaluate to an empty string.
32
33 .. code-block:: python
34
35 if args['REMOTE']:
36 io = remote('exploitme.com', 4141)
37 else:
38 io = process('./pwnable')
39
40 Arguments can also be accessed directly with the dot operator, e.g.:
41
42 .. code-block:: python
43
44 if args.REMOTE:
45 ...
46
47 Any undefined arguments evaluate to an empty string, ``''``.
48
49 The full list of supported "magic arguments" and their effects are listed
50 below.
51
52 """
53 from __future__ import absolute_import
54
55 import collections
56 import logging
57 import os
58 import string
59 import sys
60
61 from pwnlib import term
62 from pwnlib.context import context
63
64 class PwnlibArgs(collections.defaultdict):
65 def __getattr__(self, attr):
66 return self[attr]
67
68 args = PwnlibArgs(str)
69 term_mode = True
70 env_prefix = 'PWNLIB_'
71 free_form = True
72
73 # Check to see if we were invoked as one of the 'pwn xxx' scripts.
74 # If so, we don't want to remove e.g. "SYS_" from the end of the command
75 # line, as this breaks things like constgrep.
76 import pwnlib.commandline
77 basename = os.path.basename(sys.argv[0])
78
79 if basename == 'pwn' or basename in pwnlib.commandline.__all__:
80 free_form = False
81
82
83 def isident(s):
84 """
85 Helper function to check whether a string is a valid identifier,
86 as passed in on the command-line.
87 """
88 first = string.uppercase + '_'
89 body = string.digits + first
90 if not s:
91 return False
92 if s[0] not in first:
93 return False
94 if not all(c in body for c in s[1:]):
95 return False
96 return True
97
98 def asbool(s):
99 """
100 Convert a string to its boolean value
101 """
102 if s.lower() == 'true':
103 return True
104 elif s.lower() == 'false':
105 return False
106 elif s.isdigit():
107 return bool(int(s))
108 else:
109 raise ValueError('must be integer or boolean: %r' % s)
110
111 def LOG_LEVEL(x):
112 """Sets the logging verbosity used via ``context.log_level``,
113 e.g. ``LOG_LEVEL=debug``.
114 """
115 with context.local(log_level=x):
116 context.defaults['log_level']=context.log_level
117
118 def LOG_FILE(x):
119 """Sets a log file to be used via ``context.log_file``, e.g.
120 ``LOG_FILE=./log.txt``"""
121 context.log_file=x
122
123 def SILENT(x):
124 """Sets the logging verbosity to ``error`` which silences most
125 output."""
126 LOG_LEVEL('error')
127
128 def DEBUG(x):
129 """Sets the logging verbosity to ``debug`` which displays much
130 more information, including logging each byte sent by tubes."""
131 LOG_LEVEL('debug')
132
133 def NOTERM(v):
134 """Disables pretty terminal settings and animations."""
135 if asbool(v):
136 global term_mode
137 term_mode = False
138
139 def TIMEOUT(v):
140 """Sets a timeout for tube operations (in seconds) via
141 ``context.timeout``, e.g. ``TIMEOUT=30``"""
142 context.defaults['timeout'] = int(v)
143
144 def RANDOMIZE(v):
145 """Enables randomization of various pieces via ``context.randomize``"""
146 context.defaults['randomize'] = asbool(v)
147
148 def NOASLR(v):
149 """Disables ASLR via ``context.aslr``"""
150 context.defaults['aslr'] = not asbool(v)
151
152 def NOPTRACE(v):
153 """Disables facilities which require ``ptrace`` such as ``gdb.attach()``
154 statements, via ``context.noptrace``."""
155 context.defaults['noptrace'] = asbool(v)
156
157 def STDERR(v):
158 """Sends logging to ``stderr`` by default, instead of ``stdout``"""
159 context.log_console = sys.stderr
160
161 hooks = {
162 'LOG_LEVEL': LOG_LEVEL,
163 'LOG_FILE': LOG_FILE,
164 'DEBUG': DEBUG,
165 'NOTERM': NOTERM,
166 'SILENT': SILENT,
167 'RANDOMIZE': RANDOMIZE,
168 'TIMEOUT': TIMEOUT,
169 'NOASLR': NOASLR,
170 'NOPTRACE': NOPTRACE,
171 'STDERR': STDERR,
172 }
173
174 def initialize():
175 global args, term_mode
176
177 # Hack for readthedocs.org
178 if 'READTHEDOCS' in os.environ:
179 os.environ['PWNLIB_NOTERM'] = '1'
180
181 for k, v in os.environ.items():
182 if not k.startswith(env_prefix):
183 continue
184 k = k[len(env_prefix):]
185
186 if k in hooks:
187 hooks[k](v)
188 elif isident(k):
189 args[k] = v
190
191 argv = sys.argv[:]
192 for arg in sys.argv[:]:
193 orig = arg
194 value = 'True'
195
196 if '=' in arg:
197 arg, value = arg.split('=')
198
199 if arg in hooks:
200 sys.argv.remove(orig)
201 hooks[arg](value)
202
203 elif free_form and isident(arg):
204 sys.argv.remove(orig)
205 args[arg] = value
206
207 if term_mode:
208 term.init()
209
```
--- 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/pwnlib/args.py b/pwnlib/args.py
--- a/pwnlib/args.py
+++ b/pwnlib/args.py
@@ -194,7 +194,7 @@
value = 'True'
if '=' in arg:
- arg, value = arg.split('=')
+ arg, value = arg.split('=', 1)
if arg in hooks:
sys.argv.remove(orig)
| {"golden_diff": "diff --git a/pwnlib/args.py b/pwnlib/args.py\n--- a/pwnlib/args.py\n+++ b/pwnlib/args.py\n@@ -194,7 +194,7 @@\n value = 'True'\n \n if '=' in arg:\n- arg, value = arg.split('=')\n+ arg, value = arg.split('=', 1)\n \n if arg in hooks:\n sys.argv.remove(orig)\n", "issue": "'from pwn import *' fails when one of the command line args is a Base64 string (or has more than one equal sign)\nThe argument parsing functionality invoked by `from pwn import *` causes an error when one of the command line arguments has more than one equal sign:\r\n`echo \"from pwn import *\\nprint('hello world')\" > test.py`\r\n`python test.py afdsa==`\r\n\r\n```\r\nTraceback (most recent call last):\r\n File \"test.py\", line 1, in <module>\r\n from pwn import *\r\n File \"/usr/local/lib/python2.7/site-packages/pwn/__init__.py\", line 6, in <module>\r\n pwnlib.args.initialize()\r\n File \"/usr/local/lib/python2.7/site-packages/pwnlib/args.py\", line 197, in initialize\r\n arg, value = arg.split('=')\r\nValueError: too many values to unpack\r\n```\r\n\r\nhttps://github.com/Gallopsled/pwntools/blob/dev/pwnlib/args.py#L197 probably just needs to be changed to `if arg.count(\"=\") == 1:`\n", "before_files": [{"content": "\n#!/usr/bin/env python2\n\"\"\"\nPwntools exposes several magic command-line arguments and environment\nvariables when operating in `from pwn import *` mode.\n\nThe arguments extracted from the command-line and removed from ``sys.argv``.\n\nArguments can be set by appending them to the command-line, or setting\nthem in the environment prefixed by ``PWNLIB_``.\n\nThe easiest example is to enable more verbose debugging. Just set ``DEBUG``.\n\n.. code-block:: bash\n\n $ PWNLIB_DEBUG=1 python exploit.py\n $ python exploit.py DEBUG\n\nThese arguments are automatically extracted, regardless of their name, and\nexposed via :mod:`pwnlib.args.args`, which is exposed as the global variable\n:data:`args`. Arguments which ``pwntools`` reserves internally are not exposed\nthis way.\n\n.. code-block:: bash\n\n $ python -c 'from pwn import *; print args' A=1 B=Hello HOST=1.2.3.4 DEBUG\n defaultdict(<type 'str'>, {'A': '1', 'HOST': '1.2.3.4', 'B': 'Hello'})\n\nThis is very useful for conditional code, for example determining whether to\nrun an exploit locally or to connect to a remote server. Arguments which are\nnot specified evaluate to an empty string.\n\n.. code-block:: python\n\n if args['REMOTE']:\n io = remote('exploitme.com', 4141)\n else:\n io = process('./pwnable')\n\nArguments can also be accessed directly with the dot operator, e.g.:\n\n.. code-block:: python\n\n if args.REMOTE:\n ...\n\nAny undefined arguments evaluate to an empty string, ``''``.\n\nThe full list of supported \"magic arguments\" and their effects are listed\nbelow.\n\n\"\"\"\nfrom __future__ import absolute_import\n\nimport collections\nimport logging\nimport os\nimport string\nimport sys\n\nfrom pwnlib import term\nfrom pwnlib.context import context\n\nclass PwnlibArgs(collections.defaultdict):\n def __getattr__(self, attr):\n return self[attr]\n\nargs = PwnlibArgs(str)\nterm_mode = True\nenv_prefix = 'PWNLIB_'\nfree_form = True\n\n# Check to see if we were invoked as one of the 'pwn xxx' scripts.\n# If so, we don't want to remove e.g. \"SYS_\" from the end of the command\n# line, as this breaks things like constgrep.\nimport pwnlib.commandline\nbasename = os.path.basename(sys.argv[0])\n\nif basename == 'pwn' or basename in pwnlib.commandline.__all__:\n free_form = False\n\n\ndef isident(s):\n \"\"\"\n Helper function to check whether a string is a valid identifier,\n as passed in on the command-line.\n \"\"\"\n first = string.uppercase + '_'\n body = string.digits + first\n if not s:\n return False\n if s[0] not in first:\n return False\n if not all(c in body for c in s[1:]):\n return False\n return True\n\ndef asbool(s):\n \"\"\"\n Convert a string to its boolean value\n \"\"\"\n if s.lower() == 'true':\n return True\n elif s.lower() == 'false':\n return False\n elif s.isdigit():\n return bool(int(s))\n else:\n raise ValueError('must be integer or boolean: %r' % s)\n\ndef LOG_LEVEL(x):\n \"\"\"Sets the logging verbosity used via ``context.log_level``,\n e.g. ``LOG_LEVEL=debug``.\n \"\"\"\n with context.local(log_level=x):\n context.defaults['log_level']=context.log_level\n\ndef LOG_FILE(x):\n \"\"\"Sets a log file to be used via ``context.log_file``, e.g.\n ``LOG_FILE=./log.txt``\"\"\"\n context.log_file=x\n\ndef SILENT(x):\n \"\"\"Sets the logging verbosity to ``error`` which silences most\n output.\"\"\"\n LOG_LEVEL('error')\n\ndef DEBUG(x):\n \"\"\"Sets the logging verbosity to ``debug`` which displays much\n more information, including logging each byte sent by tubes.\"\"\"\n LOG_LEVEL('debug')\n\ndef NOTERM(v):\n \"\"\"Disables pretty terminal settings and animations.\"\"\"\n if asbool(v):\n global term_mode\n term_mode = False\n\ndef TIMEOUT(v):\n \"\"\"Sets a timeout for tube operations (in seconds) via\n ``context.timeout``, e.g. ``TIMEOUT=30``\"\"\"\n context.defaults['timeout'] = int(v)\n\ndef RANDOMIZE(v):\n \"\"\"Enables randomization of various pieces via ``context.randomize``\"\"\"\n context.defaults['randomize'] = asbool(v)\n\ndef NOASLR(v):\n \"\"\"Disables ASLR via ``context.aslr``\"\"\"\n context.defaults['aslr'] = not asbool(v)\n\ndef NOPTRACE(v):\n \"\"\"Disables facilities which require ``ptrace`` such as ``gdb.attach()``\n statements, via ``context.noptrace``.\"\"\"\n context.defaults['noptrace'] = asbool(v)\n\ndef STDERR(v):\n \"\"\"Sends logging to ``stderr`` by default, instead of ``stdout``\"\"\"\n context.log_console = sys.stderr\n\nhooks = {\n 'LOG_LEVEL': LOG_LEVEL,\n 'LOG_FILE': LOG_FILE,\n 'DEBUG': DEBUG,\n 'NOTERM': NOTERM,\n 'SILENT': SILENT,\n 'RANDOMIZE': RANDOMIZE,\n 'TIMEOUT': TIMEOUT,\n 'NOASLR': NOASLR,\n 'NOPTRACE': NOPTRACE,\n 'STDERR': STDERR,\n}\n\ndef initialize():\n global args, term_mode\n\n # Hack for readthedocs.org\n if 'READTHEDOCS' in os.environ:\n os.environ['PWNLIB_NOTERM'] = '1'\n\n for k, v in os.environ.items():\n if not k.startswith(env_prefix):\n continue\n k = k[len(env_prefix):]\n\n if k in hooks:\n hooks[k](v)\n elif isident(k):\n args[k] = v\n\n argv = sys.argv[:]\n for arg in sys.argv[:]:\n orig = arg\n value = 'True'\n\n if '=' in arg:\n arg, value = arg.split('=')\n\n if arg in hooks:\n sys.argv.remove(orig)\n hooks[arg](value)\n\n elif free_form and isident(arg):\n sys.argv.remove(orig)\n args[arg] = value\n\n if term_mode:\n term.init()\n", "path": "pwnlib/args.py"}], "after_files": [{"content": "\n#!/usr/bin/env python2\n\"\"\"\nPwntools exposes several magic command-line arguments and environment\nvariables when operating in `from pwn import *` mode.\n\nThe arguments extracted from the command-line and removed from ``sys.argv``.\n\nArguments can be set by appending them to the command-line, or setting\nthem in the environment prefixed by ``PWNLIB_``.\n\nThe easiest example is to enable more verbose debugging. Just set ``DEBUG``.\n\n.. code-block:: bash\n\n $ PWNLIB_DEBUG=1 python exploit.py\n $ python exploit.py DEBUG\n\nThese arguments are automatically extracted, regardless of their name, and\nexposed via :mod:`pwnlib.args.args`, which is exposed as the global variable\n:data:`args`. Arguments which ``pwntools`` reserves internally are not exposed\nthis way.\n\n.. code-block:: bash\n\n $ python -c 'from pwn import *; print args' A=1 B=Hello HOST=1.2.3.4 DEBUG\n defaultdict(<type 'str'>, {'A': '1', 'HOST': '1.2.3.4', 'B': 'Hello'})\n\nThis is very useful for conditional code, for example determining whether to\nrun an exploit locally or to connect to a remote server. Arguments which are\nnot specified evaluate to an empty string.\n\n.. code-block:: python\n\n if args['REMOTE']:\n io = remote('exploitme.com', 4141)\n else:\n io = process('./pwnable')\n\nArguments can also be accessed directly with the dot operator, e.g.:\n\n.. code-block:: python\n\n if args.REMOTE:\n ...\n\nAny undefined arguments evaluate to an empty string, ``''``.\n\nThe full list of supported \"magic arguments\" and their effects are listed\nbelow.\n\n\"\"\"\nfrom __future__ import absolute_import\n\nimport collections\nimport logging\nimport os\nimport string\nimport sys\n\nfrom pwnlib import term\nfrom pwnlib.context import context\n\nclass PwnlibArgs(collections.defaultdict):\n def __getattr__(self, attr):\n return self[attr]\n\nargs = PwnlibArgs(str)\nterm_mode = True\nenv_prefix = 'PWNLIB_'\nfree_form = True\n\n# Check to see if we were invoked as one of the 'pwn xxx' scripts.\n# If so, we don't want to remove e.g. \"SYS_\" from the end of the command\n# line, as this breaks things like constgrep.\nimport pwnlib.commandline\nbasename = os.path.basename(sys.argv[0])\n\nif basename == 'pwn' or basename in pwnlib.commandline.__all__:\n free_form = False\n\n\ndef isident(s):\n \"\"\"\n Helper function to check whether a string is a valid identifier,\n as passed in on the command-line.\n \"\"\"\n first = string.uppercase + '_'\n body = string.digits + first\n if not s:\n return False\n if s[0] not in first:\n return False\n if not all(c in body for c in s[1:]):\n return False\n return True\n\ndef asbool(s):\n \"\"\"\n Convert a string to its boolean value\n \"\"\"\n if s.lower() == 'true':\n return True\n elif s.lower() == 'false':\n return False\n elif s.isdigit():\n return bool(int(s))\n else:\n raise ValueError('must be integer or boolean: %r' % s)\n\ndef LOG_LEVEL(x):\n \"\"\"Sets the logging verbosity used via ``context.log_level``,\n e.g. ``LOG_LEVEL=debug``.\n \"\"\"\n with context.local(log_level=x):\n context.defaults['log_level']=context.log_level\n\ndef LOG_FILE(x):\n \"\"\"Sets a log file to be used via ``context.log_file``, e.g.\n ``LOG_FILE=./log.txt``\"\"\"\n context.log_file=x\n\ndef SILENT(x):\n \"\"\"Sets the logging verbosity to ``error`` which silences most\n output.\"\"\"\n LOG_LEVEL('error')\n\ndef DEBUG(x):\n \"\"\"Sets the logging verbosity to ``debug`` which displays much\n more information, including logging each byte sent by tubes.\"\"\"\n LOG_LEVEL('debug')\n\ndef NOTERM(v):\n \"\"\"Disables pretty terminal settings and animations.\"\"\"\n if asbool(v):\n global term_mode\n term_mode = False\n\ndef TIMEOUT(v):\n \"\"\"Sets a timeout for tube operations (in seconds) via\n ``context.timeout``, e.g. ``TIMEOUT=30``\"\"\"\n context.defaults['timeout'] = int(v)\n\ndef RANDOMIZE(v):\n \"\"\"Enables randomization of various pieces via ``context.randomize``\"\"\"\n context.defaults['randomize'] = asbool(v)\n\ndef NOASLR(v):\n \"\"\"Disables ASLR via ``context.aslr``\"\"\"\n context.defaults['aslr'] = not asbool(v)\n\ndef NOPTRACE(v):\n \"\"\"Disables facilities which require ``ptrace`` such as ``gdb.attach()``\n statements, via ``context.noptrace``.\"\"\"\n context.defaults['noptrace'] = asbool(v)\n\ndef STDERR(v):\n \"\"\"Sends logging to ``stderr`` by default, instead of ``stdout``\"\"\"\n context.log_console = sys.stderr\n\nhooks = {\n 'LOG_LEVEL': LOG_LEVEL,\n 'LOG_FILE': LOG_FILE,\n 'DEBUG': DEBUG,\n 'NOTERM': NOTERM,\n 'SILENT': SILENT,\n 'RANDOMIZE': RANDOMIZE,\n 'TIMEOUT': TIMEOUT,\n 'NOASLR': NOASLR,\n 'NOPTRACE': NOPTRACE,\n 'STDERR': STDERR,\n}\n\ndef initialize():\n global args, term_mode\n\n # Hack for readthedocs.org\n if 'READTHEDOCS' in os.environ:\n os.environ['PWNLIB_NOTERM'] = '1'\n\n for k, v in os.environ.items():\n if not k.startswith(env_prefix):\n continue\n k = k[len(env_prefix):]\n\n if k in hooks:\n hooks[k](v)\n elif isident(k):\n args[k] = v\n\n argv = sys.argv[:]\n for arg in sys.argv[:]:\n orig = arg\n value = 'True'\n\n if '=' in arg:\n arg, value = arg.split('=', 1)\n\n if arg in hooks:\n sys.argv.remove(orig)\n hooks[arg](value)\n\n elif free_form and isident(arg):\n sys.argv.remove(orig)\n args[arg] = value\n\n if term_mode:\n term.init()\n", "path": "pwnlib/args.py"}]} |
gh_patches_debug_208 | 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"}]} |
gh_patches_debug_209 | rasdani/github-patches | git_diff | AUTOMATIC1111__stable-diffusion-webui-10635 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[Bug]: h11._util.LocalProtocolError: Can't send data when our state is ERROR
### Is there an existing issue for this?
- [X] I have searched the existing issues and checked the recent builds/commits
### What happened?
It very strong that when use webui , it could not see the problem, but when use API, it usually release this issue
Exception in callback H11Protocol.timeout_keep_alive_handler()
handle: <TimerHandle when=30411.431255625 H11Protocol.timeout_keep_alive_handler()>
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/h11/_connection.py", line 483, in send_with_data_passthrough
raise LocalProtocolError("Can't send data when our state is ERROR")
### Steps to reproduce the problem
Just common call the API
### What should have happened?
It is very stange, sometimes it will happen, but in some times , the same prompt, it could work good
### Commit where the problem happens
Common call api
### What platforms do you use to access the UI ?
Linux
### What browsers do you use to access the UI ?
Microsoft Edge
### Command Line Arguments
```Shell
(no background:1.30)，(There is only 1 Africa black boy:1.4), (front_view, full_body:1.50), cartoon ,with a yellow Lakers basketball shirt and blue shorts standing with his hands in his pockets and his hair in the air
, best quality, 8K,( extreme detail description:1.4), (sharp focus:1.4), <lora:zby-50k-000010:0.5>
```
### List of extensions
No extension
### Console logs
```Shell
Traceback (most recent call last):
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/errors.py", line 162, in __call__
await self.app(scope, receive, _send)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/base.py", line 109, in __call__
await response(scope, receive, send)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/responses.py", line 270, in __call__
async with anyio.create_task_group() as task_group:
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/anyio/_backends/_asyncio.py", line 662, in __aexit__
raise exceptions[0]
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/responses.py", line 273, in wrap
await func()
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/base.py", line 134, in stream_response
return await super().stream_response(send)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/responses.py", line 255, in stream_response
await send(
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/errors.py", line 159, in _send
await send(message)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/uvicorn/protocols/http/h11_impl.py", line 513, in send
output = self.conn.send(event)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/h11/_connection.py", line 468, in send
data_list = self.send_with_data_passthrough(event)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/h11/_connection.py", line 483, in send_with_data_passthrough
raise LocalProtocolError("Can't send data when our state is ERROR")
h11._util.LocalProtocolError: Can't send data when our state is ERROR
ERROR: Exception in ASGI application
Traceback (most recent call last):
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/uvicorn/protocols/http/h11_impl.py", line 429, in run_asgi
result = await app( # type: ignore[func-returns-value]
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/uvicorn/middleware/proxy_headers.py", line 78, in __call__
return await self.app(scope, receive, send)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/fastapi/applications.py", line 273, in __call__
await super().__call__(scope, receive, send)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/applications.py", line 122, in __call__
await self.middleware_stack(scope, receive, send)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/errors.py", line 184, in __call__
raise exc
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/errors.py", line 162, in __call__
await self.app(scope, receive, _send)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/base.py", line 109, in __call__
await response(scope, receive, send)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/responses.py", line 270, in __call__
async with anyio.create_task_group() as task_group:
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/anyio/_backends/_asyncio.py", line 662, in __aexit__
raise exceptions[0]
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/responses.py", line 273, in wrap
await func()
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/base.py", line 134, in stream_response
return await super().stream_response(send)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/responses.py", line 255, in stream_response
await send(
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/errors.py", line 159, in _send
await send(message)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/uvicorn/protocols/http/h11_impl.py", line 513, in send
output = self.conn.send(event)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/h11/_connection.py", line 468, in send
data_list = self.send_with_data_passthrough(event)
File "/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/h11/_connection.py", line 483, in send_with_data_passthrough
raise LocalProtocolError("Can't send data when our state is ERROR")
h11._util.LocalProtocolError: Can't send data when our state is ERROR
```
### Additional information
I just check a lot of issue, but not see same as mine, any expert please help me to fix the issue, 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: `modules/api/api.py`
Content:
```
1 import base64
2 import io
3 import time
4 import datetime
5 import uvicorn
6 import gradio as gr
7 from threading import Lock
8 from io import BytesIO
9 from fastapi import APIRouter, Depends, FastAPI, Request, Response
10 from fastapi.security import HTTPBasic, HTTPBasicCredentials
11 from fastapi.exceptions import HTTPException
12 from fastapi.responses import JSONResponse
13 from fastapi.encoders import jsonable_encoder
14 from secrets import compare_digest
15
16 import modules.shared as shared
17 from modules import sd_samplers, deepbooru, sd_hijack, images, scripts, ui, postprocessing
18 from modules.api import models
19 from modules.shared import opts
20 from modules.processing import StableDiffusionProcessingTxt2Img, StableDiffusionProcessingImg2Img, process_images
21 from modules.textual_inversion.textual_inversion import create_embedding, train_embedding
22 from modules.textual_inversion.preprocess import preprocess
23 from modules.hypernetworks.hypernetwork import create_hypernetwork, train_hypernetwork
24 from PIL import PngImagePlugin,Image
25 from modules.sd_models import checkpoints_list, unload_model_weights, reload_model_weights
26 from modules.sd_models_config import find_checkpoint_config_near_filename
27 from modules.realesrgan_model import get_realesrgan_models
28 from modules import devices
29 from typing import Dict, List, Any
30 import piexif
31 import piexif.helper
32
33
34 def upscaler_to_index(name: str):
35 try:
36 return [x.name.lower() for x in shared.sd_upscalers].index(name.lower())
37 except Exception as e:
38 raise HTTPException(status_code=400, detail=f"Invalid upscaler, needs to be one of these: {' , '.join([x.name for x in shared.sd_upscalers])}") from e
39
40
41 def script_name_to_index(name, scripts):
42 try:
43 return [script.title().lower() for script in scripts].index(name.lower())
44 except Exception as e:
45 raise HTTPException(status_code=422, detail=f"Script '{name}' not found") from e
46
47
48 def validate_sampler_name(name):
49 config = sd_samplers.all_samplers_map.get(name, None)
50 if config is None:
51 raise HTTPException(status_code=404, detail="Sampler not found")
52
53 return name
54
55
56 def setUpscalers(req: dict):
57 reqDict = vars(req)
58 reqDict['extras_upscaler_1'] = reqDict.pop('upscaler_1', None)
59 reqDict['extras_upscaler_2'] = reqDict.pop('upscaler_2', None)
60 return reqDict
61
62
63 def decode_base64_to_image(encoding):
64 if encoding.startswith("data:image/"):
65 encoding = encoding.split(";")[1].split(",")[1]
66 try:
67 image = Image.open(BytesIO(base64.b64decode(encoding)))
68 return image
69 except Exception as e:
70 raise HTTPException(status_code=500, detail="Invalid encoded image") from e
71
72
73 def encode_pil_to_base64(image):
74 with io.BytesIO() as output_bytes:
75
76 if opts.samples_format.lower() == 'png':
77 use_metadata = False
78 metadata = PngImagePlugin.PngInfo()
79 for key, value in image.info.items():
80 if isinstance(key, str) and isinstance(value, str):
81 metadata.add_text(key, value)
82 use_metadata = True
83 image.save(output_bytes, format="PNG", pnginfo=(metadata if use_metadata else None), quality=opts.jpeg_quality)
84
85 elif opts.samples_format.lower() in ("jpg", "jpeg", "webp"):
86 parameters = image.info.get('parameters', None)
87 exif_bytes = piexif.dump({
88 "Exif": { piexif.ExifIFD.UserComment: piexif.helper.UserComment.dump(parameters or "", encoding="unicode") }
89 })
90 if opts.samples_format.lower() in ("jpg", "jpeg"):
91 image.save(output_bytes, format="JPEG", exif = exif_bytes, quality=opts.jpeg_quality)
92 else:
93 image.save(output_bytes, format="WEBP", exif = exif_bytes, quality=opts.jpeg_quality)
94
95 else:
96 raise HTTPException(status_code=500, detail="Invalid image format")
97
98 bytes_data = output_bytes.getvalue()
99
100 return base64.b64encode(bytes_data)
101
102
103 def api_middleware(app: FastAPI):
104 rich_available = True
105 try:
106 import anyio # importing just so it can be placed on silent list
107 import starlette # importing just so it can be placed on silent list
108 from rich.console import Console
109 console = Console()
110 except Exception:
111 import traceback
112 rich_available = False
113
114 @app.middleware("http")
115 async def log_and_time(req: Request, call_next):
116 ts = time.time()
117 res: Response = await call_next(req)
118 duration = str(round(time.time() - ts, 4))
119 res.headers["X-Process-Time"] = duration
120 endpoint = req.scope.get('path', 'err')
121 if shared.cmd_opts.api_log and endpoint.startswith('/sdapi'):
122 print('API {t} {code} {prot}/{ver} {method} {endpoint} {cli} {duration}'.format(
123 t = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S.%f"),
124 code = res.status_code,
125 ver = req.scope.get('http_version', '0.0'),
126 cli = req.scope.get('client', ('0:0.0.0', 0))[0],
127 prot = req.scope.get('scheme', 'err'),
128 method = req.scope.get('method', 'err'),
129 endpoint = endpoint,
130 duration = duration,
131 ))
132 return res
133
134 def handle_exception(request: Request, e: Exception):
135 err = {
136 "error": type(e).__name__,
137 "detail": vars(e).get('detail', ''),
138 "body": vars(e).get('body', ''),
139 "errors": str(e),
140 }
141 if not isinstance(e, HTTPException): # do not print backtrace on known httpexceptions
142 print(f"API error: {request.method}: {request.url} {err}")
143 if rich_available:
144 console.print_exception(show_locals=True, max_frames=2, extra_lines=1, suppress=[anyio, starlette], word_wrap=False, width=min([console.width, 200]))
145 else:
146 traceback.print_exc()
147 return JSONResponse(status_code=vars(e).get('status_code', 500), content=jsonable_encoder(err))
148
149 @app.middleware("http")
150 async def exception_handling(request: Request, call_next):
151 try:
152 return await call_next(request)
153 except Exception as e:
154 return handle_exception(request, e)
155
156 @app.exception_handler(Exception)
157 async def fastapi_exception_handler(request: Request, e: Exception):
158 return handle_exception(request, e)
159
160 @app.exception_handler(HTTPException)
161 async def http_exception_handler(request: Request, e: HTTPException):
162 return handle_exception(request, e)
163
164
165 class Api:
166 def __init__(self, app: FastAPI, queue_lock: Lock):
167 if shared.cmd_opts.api_auth:
168 self.credentials = {}
169 for auth in shared.cmd_opts.api_auth.split(","):
170 user, password = auth.split(":")
171 self.credentials[user] = password
172
173 self.router = APIRouter()
174 self.app = app
175 self.queue_lock = queue_lock
176 api_middleware(self.app)
177 self.add_api_route("/sdapi/v1/txt2img", self.text2imgapi, methods=["POST"], response_model=models.TextToImageResponse)
178 self.add_api_route("/sdapi/v1/img2img", self.img2imgapi, methods=["POST"], response_model=models.ImageToImageResponse)
179 self.add_api_route("/sdapi/v1/extra-single-image", self.extras_single_image_api, methods=["POST"], response_model=models.ExtrasSingleImageResponse)
180 self.add_api_route("/sdapi/v1/extra-batch-images", self.extras_batch_images_api, methods=["POST"], response_model=models.ExtrasBatchImagesResponse)
181 self.add_api_route("/sdapi/v1/png-info", self.pnginfoapi, methods=["POST"], response_model=models.PNGInfoResponse)
182 self.add_api_route("/sdapi/v1/progress", self.progressapi, methods=["GET"], response_model=models.ProgressResponse)
183 self.add_api_route("/sdapi/v1/interrogate", self.interrogateapi, methods=["POST"])
184 self.add_api_route("/sdapi/v1/interrupt", self.interruptapi, methods=["POST"])
185 self.add_api_route("/sdapi/v1/skip", self.skip, methods=["POST"])
186 self.add_api_route("/sdapi/v1/options", self.get_config, methods=["GET"], response_model=models.OptionsModel)
187 self.add_api_route("/sdapi/v1/options", self.set_config, methods=["POST"])
188 self.add_api_route("/sdapi/v1/cmd-flags", self.get_cmd_flags, methods=["GET"], response_model=models.FlagsModel)
189 self.add_api_route("/sdapi/v1/samplers", self.get_samplers, methods=["GET"], response_model=List[models.SamplerItem])
190 self.add_api_route("/sdapi/v1/upscalers", self.get_upscalers, methods=["GET"], response_model=List[models.UpscalerItem])
191 self.add_api_route("/sdapi/v1/sd-models", self.get_sd_models, methods=["GET"], response_model=List[models.SDModelItem])
192 self.add_api_route("/sdapi/v1/hypernetworks", self.get_hypernetworks, methods=["GET"], response_model=List[models.HypernetworkItem])
193 self.add_api_route("/sdapi/v1/face-restorers", self.get_face_restorers, methods=["GET"], response_model=List[models.FaceRestorerItem])
194 self.add_api_route("/sdapi/v1/realesrgan-models", self.get_realesrgan_models, methods=["GET"], response_model=List[models.RealesrganItem])
195 self.add_api_route("/sdapi/v1/prompt-styles", self.get_prompt_styles, methods=["GET"], response_model=List[models.PromptStyleItem])
196 self.add_api_route("/sdapi/v1/embeddings", self.get_embeddings, methods=["GET"], response_model=models.EmbeddingsResponse)
197 self.add_api_route("/sdapi/v1/refresh-checkpoints", self.refresh_checkpoints, methods=["POST"])
198 self.add_api_route("/sdapi/v1/create/embedding", self.create_embedding, methods=["POST"], response_model=models.CreateResponse)
199 self.add_api_route("/sdapi/v1/create/hypernetwork", self.create_hypernetwork, methods=["POST"], response_model=models.CreateResponse)
200 self.add_api_route("/sdapi/v1/preprocess", self.preprocess, methods=["POST"], response_model=models.PreprocessResponse)
201 self.add_api_route("/sdapi/v1/train/embedding", self.train_embedding, methods=["POST"], response_model=models.TrainResponse)
202 self.add_api_route("/sdapi/v1/train/hypernetwork", self.train_hypernetwork, methods=["POST"], response_model=models.TrainResponse)
203 self.add_api_route("/sdapi/v1/memory", self.get_memory, methods=["GET"], response_model=models.MemoryResponse)
204 self.add_api_route("/sdapi/v1/unload-checkpoint", self.unloadapi, methods=["POST"])
205 self.add_api_route("/sdapi/v1/reload-checkpoint", self.reloadapi, methods=["POST"])
206 self.add_api_route("/sdapi/v1/scripts", self.get_scripts_list, methods=["GET"], response_model=models.ScriptsList)
207 self.add_api_route("/sdapi/v1/script-info", self.get_script_info, methods=["GET"], response_model=List[models.ScriptInfo])
208
209 self.default_script_arg_txt2img = []
210 self.default_script_arg_img2img = []
211
212 def add_api_route(self, path: str, endpoint, **kwargs):
213 if shared.cmd_opts.api_auth:
214 return self.app.add_api_route(path, endpoint, dependencies=[Depends(self.auth)], **kwargs)
215 return self.app.add_api_route(path, endpoint, **kwargs)
216
217 def auth(self, credentials: HTTPBasicCredentials = Depends(HTTPBasic())):
218 if credentials.username in self.credentials:
219 if compare_digest(credentials.password, self.credentials[credentials.username]):
220 return True
221
222 raise HTTPException(status_code=401, detail="Incorrect username or password", headers={"WWW-Authenticate": "Basic"})
223
224 def get_selectable_script(self, script_name, script_runner):
225 if script_name is None or script_name == "":
226 return None, None
227
228 script_idx = script_name_to_index(script_name, script_runner.selectable_scripts)
229 script = script_runner.selectable_scripts[script_idx]
230 return script, script_idx
231
232 def get_scripts_list(self):
233 t2ilist = [script.name for script in scripts.scripts_txt2img.scripts if script.name is not None]
234 i2ilist = [script.name for script in scripts.scripts_img2img.scripts if script.name is not None]
235
236 return models.ScriptsList(txt2img=t2ilist, img2img=i2ilist)
237
238 def get_script_info(self):
239 res = []
240
241 for script_list in [scripts.scripts_txt2img.scripts, scripts.scripts_img2img.scripts]:
242 res += [script.api_info for script in script_list if script.api_info is not None]
243
244 return res
245
246 def get_script(self, script_name, script_runner):
247 if script_name is None or script_name == "":
248 return None, None
249
250 script_idx = script_name_to_index(script_name, script_runner.scripts)
251 return script_runner.scripts[script_idx]
252
253 def init_default_script_args(self, script_runner):
254 #find max idx from the scripts in runner and generate a none array to init script_args
255 last_arg_index = 1
256 for script in script_runner.scripts:
257 if last_arg_index < script.args_to:
258 last_arg_index = script.args_to
259 # None everywhere except position 0 to initialize script args
260 script_args = [None]*last_arg_index
261 script_args[0] = 0
262
263 # get default values
264 with gr.Blocks(): # will throw errors calling ui function without this
265 for script in script_runner.scripts:
266 if script.ui(script.is_img2img):
267 ui_default_values = []
268 for elem in script.ui(script.is_img2img):
269 ui_default_values.append(elem.value)
270 script_args[script.args_from:script.args_to] = ui_default_values
271 return script_args
272
273 def init_script_args(self, request, default_script_args, selectable_scripts, selectable_idx, script_runner):
274 script_args = default_script_args.copy()
275 # position 0 in script_arg is the idx+1 of the selectable script that is going to be run when using scripts.scripts_*2img.run()
276 if selectable_scripts:
277 script_args[selectable_scripts.args_from:selectable_scripts.args_to] = request.script_args
278 script_args[0] = selectable_idx + 1
279
280 # Now check for always on scripts
281 if request.alwayson_scripts and (len(request.alwayson_scripts) > 0):
282 for alwayson_script_name in request.alwayson_scripts.keys():
283 alwayson_script = self.get_script(alwayson_script_name, script_runner)
284 if alwayson_script is None:
285 raise HTTPException(status_code=422, detail=f"always on script {alwayson_script_name} not found")
286 # Selectable script in always on script param check
287 if alwayson_script.alwayson is False:
288 raise HTTPException(status_code=422, detail="Cannot have a selectable script in the always on scripts params")
289 # always on script with no arg should always run so you don't really need to add them to the requests
290 if "args" in request.alwayson_scripts[alwayson_script_name]:
291 # min between arg length in scriptrunner and arg length in the request
292 for idx in range(0, min((alwayson_script.args_to - alwayson_script.args_from), len(request.alwayson_scripts[alwayson_script_name]["args"]))):
293 script_args[alwayson_script.args_from + idx] = request.alwayson_scripts[alwayson_script_name]["args"][idx]
294 return script_args
295
296 def text2imgapi(self, txt2imgreq: models.StableDiffusionTxt2ImgProcessingAPI):
297 script_runner = scripts.scripts_txt2img
298 if not script_runner.scripts:
299 script_runner.initialize_scripts(False)
300 ui.create_ui()
301 if not self.default_script_arg_txt2img:
302 self.default_script_arg_txt2img = self.init_default_script_args(script_runner)
303 selectable_scripts, selectable_script_idx = self.get_selectable_script(txt2imgreq.script_name, script_runner)
304
305 populate = txt2imgreq.copy(update={ # Override __init__ params
306 "sampler_name": validate_sampler_name(txt2imgreq.sampler_name or txt2imgreq.sampler_index),
307 "do_not_save_samples": not txt2imgreq.save_images,
308 "do_not_save_grid": not txt2imgreq.save_images,
309 })
310 if populate.sampler_name:
311 populate.sampler_index = None # prevent a warning later on
312
313 args = vars(populate)
314 args.pop('script_name', None)
315 args.pop('script_args', None) # will refeed them to the pipeline directly after initializing them
316 args.pop('alwayson_scripts', None)
317
318 script_args = self.init_script_args(txt2imgreq, self.default_script_arg_txt2img, selectable_scripts, selectable_script_idx, script_runner)
319
320 send_images = args.pop('send_images', True)
321 args.pop('save_images', None)
322
323 with self.queue_lock:
324 p = StableDiffusionProcessingTxt2Img(sd_model=shared.sd_model, **args)
325 p.scripts = script_runner
326 p.outpath_grids = opts.outdir_txt2img_grids
327 p.outpath_samples = opts.outdir_txt2img_samples
328
329 shared.state.begin()
330 if selectable_scripts is not None:
331 p.script_args = script_args
332 processed = scripts.scripts_txt2img.run(p, *p.script_args) # Need to pass args as list here
333 else:
334 p.script_args = tuple(script_args) # Need to pass args as tuple here
335 processed = process_images(p)
336 shared.state.end()
337
338 b64images = list(map(encode_pil_to_base64, processed.images)) if send_images else []
339
340 return models.TextToImageResponse(images=b64images, parameters=vars(txt2imgreq), info=processed.js())
341
342 def img2imgapi(self, img2imgreq: models.StableDiffusionImg2ImgProcessingAPI):
343 init_images = img2imgreq.init_images
344 if init_images is None:
345 raise HTTPException(status_code=404, detail="Init image not found")
346
347 mask = img2imgreq.mask
348 if mask:
349 mask = decode_base64_to_image(mask)
350
351 script_runner = scripts.scripts_img2img
352 if not script_runner.scripts:
353 script_runner.initialize_scripts(True)
354 ui.create_ui()
355 if not self.default_script_arg_img2img:
356 self.default_script_arg_img2img = self.init_default_script_args(script_runner)
357 selectable_scripts, selectable_script_idx = self.get_selectable_script(img2imgreq.script_name, script_runner)
358
359 populate = img2imgreq.copy(update={ # Override __init__ params
360 "sampler_name": validate_sampler_name(img2imgreq.sampler_name or img2imgreq.sampler_index),
361 "do_not_save_samples": not img2imgreq.save_images,
362 "do_not_save_grid": not img2imgreq.save_images,
363 "mask": mask,
364 })
365 if populate.sampler_name:
366 populate.sampler_index = None # prevent a warning later on
367
368 args = vars(populate)
369 args.pop('include_init_images', None) # this is meant to be done by "exclude": True in model, but it's for a reason that I cannot determine.
370 args.pop('script_name', None)
371 args.pop('script_args', None) # will refeed them to the pipeline directly after initializing them
372 args.pop('alwayson_scripts', None)
373
374 script_args = self.init_script_args(img2imgreq, self.default_script_arg_img2img, selectable_scripts, selectable_script_idx, script_runner)
375
376 send_images = args.pop('send_images', True)
377 args.pop('save_images', None)
378
379 with self.queue_lock:
380 p = StableDiffusionProcessingImg2Img(sd_model=shared.sd_model, **args)
381 p.init_images = [decode_base64_to_image(x) for x in init_images]
382 p.scripts = script_runner
383 p.outpath_grids = opts.outdir_img2img_grids
384 p.outpath_samples = opts.outdir_img2img_samples
385
386 shared.state.begin()
387 if selectable_scripts is not None:
388 p.script_args = script_args
389 processed = scripts.scripts_img2img.run(p, *p.script_args) # Need to pass args as list here
390 else:
391 p.script_args = tuple(script_args) # Need to pass args as tuple here
392 processed = process_images(p)
393 shared.state.end()
394
395 b64images = list(map(encode_pil_to_base64, processed.images)) if send_images else []
396
397 if not img2imgreq.include_init_images:
398 img2imgreq.init_images = None
399 img2imgreq.mask = None
400
401 return models.ImageToImageResponse(images=b64images, parameters=vars(img2imgreq), info=processed.js())
402
403 def extras_single_image_api(self, req: models.ExtrasSingleImageRequest):
404 reqDict = setUpscalers(req)
405
406 reqDict['image'] = decode_base64_to_image(reqDict['image'])
407
408 with self.queue_lock:
409 result = postprocessing.run_extras(extras_mode=0, image_folder="", input_dir="", output_dir="", save_output=False, **reqDict)
410
411 return models.ExtrasSingleImageResponse(image=encode_pil_to_base64(result[0][0]), html_info=result[1])
412
413 def extras_batch_images_api(self, req: models.ExtrasBatchImagesRequest):
414 reqDict = setUpscalers(req)
415
416 image_list = reqDict.pop('imageList', [])
417 image_folder = [decode_base64_to_image(x.data) for x in image_list]
418
419 with self.queue_lock:
420 result = postprocessing.run_extras(extras_mode=1, image_folder=image_folder, image="", input_dir="", output_dir="", save_output=False, **reqDict)
421
422 return models.ExtrasBatchImagesResponse(images=list(map(encode_pil_to_base64, result[0])), html_info=result[1])
423
424 def pnginfoapi(self, req: models.PNGInfoRequest):
425 if(not req.image.strip()):
426 return models.PNGInfoResponse(info="")
427
428 image = decode_base64_to_image(req.image.strip())
429 if image is None:
430 return models.PNGInfoResponse(info="")
431
432 geninfo, items = images.read_info_from_image(image)
433 if geninfo is None:
434 geninfo = ""
435
436 items = {**{'parameters': geninfo}, **items}
437
438 return models.PNGInfoResponse(info=geninfo, items=items)
439
440 def progressapi(self, req: models.ProgressRequest = Depends()):
441 # copy from check_progress_call of ui.py
442
443 if shared.state.job_count == 0:
444 return models.ProgressResponse(progress=0, eta_relative=0, state=shared.state.dict(), textinfo=shared.state.textinfo)
445
446 # avoid dividing zero
447 progress = 0.01
448
449 if shared.state.job_count > 0:
450 progress += shared.state.job_no / shared.state.job_count
451 if shared.state.sampling_steps > 0:
452 progress += 1 / shared.state.job_count * shared.state.sampling_step / shared.state.sampling_steps
453
454 time_since_start = time.time() - shared.state.time_start
455 eta = (time_since_start/progress)
456 eta_relative = eta-time_since_start
457
458 progress = min(progress, 1)
459
460 shared.state.set_current_image()
461
462 current_image = None
463 if shared.state.current_image and not req.skip_current_image:
464 current_image = encode_pil_to_base64(shared.state.current_image)
465
466 return models.ProgressResponse(progress=progress, eta_relative=eta_relative, state=shared.state.dict(), current_image=current_image, textinfo=shared.state.textinfo)
467
468 def interrogateapi(self, interrogatereq: models.InterrogateRequest):
469 image_b64 = interrogatereq.image
470 if image_b64 is None:
471 raise HTTPException(status_code=404, detail="Image not found")
472
473 img = decode_base64_to_image(image_b64)
474 img = img.convert('RGB')
475
476 # Override object param
477 with self.queue_lock:
478 if interrogatereq.model == "clip":
479 processed = shared.interrogator.interrogate(img)
480 elif interrogatereq.model == "deepdanbooru":
481 processed = deepbooru.model.tag(img)
482 else:
483 raise HTTPException(status_code=404, detail="Model not found")
484
485 return models.InterrogateResponse(caption=processed)
486
487 def interruptapi(self):
488 shared.state.interrupt()
489
490 return {}
491
492 def unloadapi(self):
493 unload_model_weights()
494
495 return {}
496
497 def reloadapi(self):
498 reload_model_weights()
499
500 return {}
501
502 def skip(self):
503 shared.state.skip()
504
505 def get_config(self):
506 options = {}
507 for key in shared.opts.data.keys():
508 metadata = shared.opts.data_labels.get(key)
509 if(metadata is not None):
510 options.update({key: shared.opts.data.get(key, shared.opts.data_labels.get(key).default)})
511 else:
512 options.update({key: shared.opts.data.get(key, None)})
513
514 return options
515
516 def set_config(self, req: Dict[str, Any]):
517 for k, v in req.items():
518 shared.opts.set(k, v)
519
520 shared.opts.save(shared.config_filename)
521 return
522
523 def get_cmd_flags(self):
524 return vars(shared.cmd_opts)
525
526 def get_samplers(self):
527 return [{"name": sampler[0], "aliases":sampler[2], "options":sampler[3]} for sampler in sd_samplers.all_samplers]
528
529 def get_upscalers(self):
530 return [
531 {
532 "name": upscaler.name,
533 "model_name": upscaler.scaler.model_name,
534 "model_path": upscaler.data_path,
535 "model_url": None,
536 "scale": upscaler.scale,
537 }
538 for upscaler in shared.sd_upscalers
539 ]
540
541 def get_sd_models(self):
542 return [{"title": x.title, "model_name": x.model_name, "hash": x.shorthash, "sha256": x.sha256, "filename": x.filename, "config": find_checkpoint_config_near_filename(x)} for x in checkpoints_list.values()]
543
544 def get_hypernetworks(self):
545 return [{"name": name, "path": shared.hypernetworks[name]} for name in shared.hypernetworks]
546
547 def get_face_restorers(self):
548 return [{"name":x.name(), "cmd_dir": getattr(x, "cmd_dir", None)} for x in shared.face_restorers]
549
550 def get_realesrgan_models(self):
551 return [{"name":x.name,"path":x.data_path, "scale":x.scale} for x in get_realesrgan_models(None)]
552
553 def get_prompt_styles(self):
554 styleList = []
555 for k in shared.prompt_styles.styles:
556 style = shared.prompt_styles.styles[k]
557 styleList.append({"name":style[0], "prompt": style[1], "negative_prompt": style[2]})
558
559 return styleList
560
561 def get_embeddings(self):
562 db = sd_hijack.model_hijack.embedding_db
563
564 def convert_embedding(embedding):
565 return {
566 "step": embedding.step,
567 "sd_checkpoint": embedding.sd_checkpoint,
568 "sd_checkpoint_name": embedding.sd_checkpoint_name,
569 "shape": embedding.shape,
570 "vectors": embedding.vectors,
571 }
572
573 def convert_embeddings(embeddings):
574 return {embedding.name: convert_embedding(embedding) for embedding in embeddings.values()}
575
576 return {
577 "loaded": convert_embeddings(db.word_embeddings),
578 "skipped": convert_embeddings(db.skipped_embeddings),
579 }
580
581 def refresh_checkpoints(self):
582 shared.refresh_checkpoints()
583
584 def create_embedding(self, args: dict):
585 try:
586 shared.state.begin()
587 filename = create_embedding(**args) # create empty embedding
588 sd_hijack.model_hijack.embedding_db.load_textual_inversion_embeddings() # reload embeddings so new one can be immediately used
589 shared.state.end()
590 return models.CreateResponse(info=f"create embedding filename: {filename}")
591 except AssertionError as e:
592 shared.state.end()
593 return models.TrainResponse(info=f"create embedding error: {e}")
594
595 def create_hypernetwork(self, args: dict):
596 try:
597 shared.state.begin()
598 filename = create_hypernetwork(**args) # create empty embedding
599 shared.state.end()
600 return models.CreateResponse(info=f"create hypernetwork filename: {filename}")
601 except AssertionError as e:
602 shared.state.end()
603 return models.TrainResponse(info=f"create hypernetwork error: {e}")
604
605 def preprocess(self, args: dict):
606 try:
607 shared.state.begin()
608 preprocess(**args) # quick operation unless blip/booru interrogation is enabled
609 shared.state.end()
610 return models.PreprocessResponse(info = 'preprocess complete')
611 except KeyError as e:
612 shared.state.end()
613 return models.PreprocessResponse(info=f"preprocess error: invalid token: {e}")
614 except AssertionError as e:
615 shared.state.end()
616 return models.PreprocessResponse(info=f"preprocess error: {e}")
617 except FileNotFoundError as e:
618 shared.state.end()
619 return models.PreprocessResponse(info=f'preprocess error: {e}')
620
621 def train_embedding(self, args: dict):
622 try:
623 shared.state.begin()
624 apply_optimizations = shared.opts.training_xattention_optimizations
625 error = None
626 filename = ''
627 if not apply_optimizations:
628 sd_hijack.undo_optimizations()
629 try:
630 embedding, filename = train_embedding(**args) # can take a long time to complete
631 except Exception as e:
632 error = e
633 finally:
634 if not apply_optimizations:
635 sd_hijack.apply_optimizations()
636 shared.state.end()
637 return models.TrainResponse(info=f"train embedding complete: filename: {filename} error: {error}")
638 except AssertionError as msg:
639 shared.state.end()
640 return models.TrainResponse(info=f"train embedding error: {msg}")
641
642 def train_hypernetwork(self, args: dict):
643 try:
644 shared.state.begin()
645 shared.loaded_hypernetworks = []
646 apply_optimizations = shared.opts.training_xattention_optimizations
647 error = None
648 filename = ''
649 if not apply_optimizations:
650 sd_hijack.undo_optimizations()
651 try:
652 hypernetwork, filename = train_hypernetwork(**args)
653 except Exception as e:
654 error = e
655 finally:
656 shared.sd_model.cond_stage_model.to(devices.device)
657 shared.sd_model.first_stage_model.to(devices.device)
658 if not apply_optimizations:
659 sd_hijack.apply_optimizations()
660 shared.state.end()
661 return models.TrainResponse(info=f"train embedding complete: filename: {filename} error: {error}")
662 except AssertionError:
663 shared.state.end()
664 return models.TrainResponse(info=f"train embedding error: {error}")
665
666 def get_memory(self):
667 try:
668 import os
669 import psutil
670 process = psutil.Process(os.getpid())
671 res = process.memory_info() # only rss is cross-platform guaranteed so we dont rely on other values
672 ram_total = 100 * res.rss / process.memory_percent() # and total memory is calculated as actual value is not cross-platform safe
673 ram = { 'free': ram_total - res.rss, 'used': res.rss, 'total': ram_total }
674 except Exception as err:
675 ram = { 'error': f'{err}' }
676 try:
677 import torch
678 if torch.cuda.is_available():
679 s = torch.cuda.mem_get_info()
680 system = { 'free': s[0], 'used': s[1] - s[0], 'total': s[1] }
681 s = dict(torch.cuda.memory_stats(shared.device))
682 allocated = { 'current': s['allocated_bytes.all.current'], 'peak': s['allocated_bytes.all.peak'] }
683 reserved = { 'current': s['reserved_bytes.all.current'], 'peak': s['reserved_bytes.all.peak'] }
684 active = { 'current': s['active_bytes.all.current'], 'peak': s['active_bytes.all.peak'] }
685 inactive = { 'current': s['inactive_split_bytes.all.current'], 'peak': s['inactive_split_bytes.all.peak'] }
686 warnings = { 'retries': s['num_alloc_retries'], 'oom': s['num_ooms'] }
687 cuda = {
688 'system': system,
689 'active': active,
690 'allocated': allocated,
691 'reserved': reserved,
692 'inactive': inactive,
693 'events': warnings,
694 }
695 else:
696 cuda = {'error': 'unavailable'}
697 except Exception as err:
698 cuda = {'error': f'{err}'}
699 return models.MemoryResponse(ram=ram, cuda=cuda)
700
701 def launch(self, server_name, port):
702 self.app.include_router(self.router)
703 uvicorn.run(self.app, host=server_name, port=port)
704
```
--- 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/modules/api/api.py b/modules/api/api.py
--- a/modules/api/api.py
+++ b/modules/api/api.py
@@ -682,4 +682,4 @@
def launch(self, server_name, port):
self.app.include_router(self.router)
- uvicorn.run(self.app, host=server_name, port=port)
+ uvicorn.run(self.app, host=server_name, port=port, timeout_keep_alive=0)
| {"golden_diff": "diff --git a/modules/api/api.py b/modules/api/api.py\n--- a/modules/api/api.py\n+++ b/modules/api/api.py\n@@ -682,4 +682,4 @@\n \n def launch(self, server_name, port):\n self.app.include_router(self.router)\n- uvicorn.run(self.app, host=server_name, port=port)\n+ uvicorn.run(self.app, host=server_name, port=port, timeout_keep_alive=0)\n", "issue": "[Bug]: h11._util.LocalProtocolError: Can't send data when our state is ERROR\n### Is there an existing issue for this?\r\n\r\n- [X] I have searched the existing issues and checked the recent builds/commits\r\n\r\n### What happened?\r\n\r\nIt very strong that when use webui , it could not see the problem, but when use API, it usually release this issue \r\n\r\nException in callback H11Protocol.timeout_keep_alive_handler()\r\nhandle: <TimerHandle when=30411.431255625 H11Protocol.timeout_keep_alive_handler()>\r\n\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/h11/_connection.py\", line 483, in send_with_data_passthrough\r\n raise LocalProtocolError(\"Can't send data when our state is ERROR\")\r\n\r\n\r\n### Steps to reproduce the problem\r\n\r\nJust common call the API\r\n\r\n\r\n### What should have happened?\r\n\r\nIt is very stange, sometimes it will happen, but in some times , the same prompt, it could work good \r\n\r\n### Commit where the problem happens\r\n\r\nCommon call api\r\n\r\n### What platforms do you use to access the UI ?\r\n\r\nLinux\r\n\r\n### What browsers do you use to access the UI ?\r\n\r\nMicrosoft Edge\r\n\r\n### Command Line Arguments\r\n\r\n```Shell\r\n(no background:1.30)\uff0c(There is only 1 Africa black boy:1.4), (front_view, full_body:1.50), cartoon ,with a yellow Lakers basketball shirt and blue shorts standing with his hands in his pockets and his hair in the air\r\n, best quality, 8K,( extreme detail description:1.4), (sharp focus:1.4), <lora:zby-50k-000010:0.5>\r\n```\r\n\r\n\r\n### List of extensions\r\n\r\nNo extension\r\n\r\n### Console logs\r\n\r\n```Shell\r\n\r\nTraceback (most recent call last):\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/errors.py\", line 162, in __call__\r\n await self.app(scope, receive, _send)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/base.py\", line 109, in __call__\r\n await response(scope, receive, send)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/responses.py\", line 270, in __call__\r\n async with anyio.create_task_group() as task_group:\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/anyio/_backends/_asyncio.py\", line 662, in __aexit__\r\n raise exceptions[0]\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/responses.py\", line 273, in wrap\r\n await func()\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/base.py\", line 134, in stream_response\r\n return await super().stream_response(send)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/responses.py\", line 255, in stream_response\r\n await send(\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/errors.py\", line 159, in _send\r\n await send(message)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/uvicorn/protocols/http/h11_impl.py\", line 513, in send\r\n output = self.conn.send(event)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/h11/_connection.py\", line 468, in send\r\n data_list = self.send_with_data_passthrough(event)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/h11/_connection.py\", line 483, in send_with_data_passthrough\r\n raise LocalProtocolError(\"Can't send data when our state is ERROR\")\r\nh11._util.LocalProtocolError: Can't send data when our state is ERROR\r\nERROR: Exception in ASGI application\r\nTraceback (most recent call last):\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/uvicorn/protocols/http/h11_impl.py\", line 429, in run_asgi\r\n result = await app( # type: ignore[func-returns-value]\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/uvicorn/middleware/proxy_headers.py\", line 78, in __call__\r\n return await self.app(scope, receive, send)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/fastapi/applications.py\", line 273, in __call__\r\n await super().__call__(scope, receive, send)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/applications.py\", line 122, in __call__\r\n await self.middleware_stack(scope, receive, send)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/errors.py\", line 184, in __call__\r\n raise exc\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/errors.py\", line 162, in __call__\r\n await self.app(scope, receive, _send)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/base.py\", line 109, in __call__\r\n await response(scope, receive, send)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/responses.py\", line 270, in __call__\r\n async with anyio.create_task_group() as task_group:\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/anyio/_backends/_asyncio.py\", line 662, in __aexit__\r\n raise exceptions[0]\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/responses.py\", line 273, in wrap\r\n await func()\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/base.py\", line 134, in stream_response\r\n return await super().stream_response(send)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/responses.py\", line 255, in stream_response\r\n await send(\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/starlette/middleware/errors.py\", line 159, in _send\r\n await send(message)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/uvicorn/protocols/http/h11_impl.py\", line 513, in send\r\n output = self.conn.send(event)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/h11/_connection.py\", line 468, in send\r\n data_list = self.send_with_data_passthrough(event)\r\n File \"/aml/stable-diffusion-webui/venv/lib/python3.10/site-packages/h11/_connection.py\", line 483, in send_with_data_passthrough\r\n raise LocalProtocolError(\"Can't send data when our state is ERROR\")\r\nh11._util.LocalProtocolError: Can't send data when our state is ERROR\r\n```\r\n\r\n\r\n### Additional information\r\n\r\nI just check a lot of issue, but not see same as mine, any expert please help me to fix the issue, Thanks\n", "before_files": [{"content": "import base64\nimport io\nimport time\nimport datetime\nimport uvicorn\nimport gradio as gr\nfrom threading import Lock\nfrom io import BytesIO\nfrom fastapi import APIRouter, Depends, FastAPI, Request, Response\nfrom fastapi.security import HTTPBasic, HTTPBasicCredentials\nfrom fastapi.exceptions import HTTPException\nfrom fastapi.responses import JSONResponse\nfrom fastapi.encoders import jsonable_encoder\nfrom secrets import compare_digest\n\nimport modules.shared as shared\nfrom modules import sd_samplers, deepbooru, sd_hijack, images, scripts, ui, postprocessing\nfrom modules.api import models\nfrom modules.shared import opts\nfrom modules.processing import StableDiffusionProcessingTxt2Img, StableDiffusionProcessingImg2Img, process_images\nfrom modules.textual_inversion.textual_inversion import create_embedding, train_embedding\nfrom modules.textual_inversion.preprocess import preprocess\nfrom modules.hypernetworks.hypernetwork import create_hypernetwork, train_hypernetwork\nfrom PIL import PngImagePlugin,Image\nfrom modules.sd_models import checkpoints_list, unload_model_weights, reload_model_weights\nfrom modules.sd_models_config import find_checkpoint_config_near_filename\nfrom modules.realesrgan_model import get_realesrgan_models\nfrom modules import devices\nfrom typing import Dict, List, Any\nimport piexif\nimport piexif.helper\n\n\ndef upscaler_to_index(name: str):\n try:\n return [x.name.lower() for x in shared.sd_upscalers].index(name.lower())\n except Exception as e:\n raise HTTPException(status_code=400, detail=f\"Invalid upscaler, needs to be one of these: {' , '.join([x.name for x in shared.sd_upscalers])}\") from e\n\n\ndef script_name_to_index(name, scripts):\n try:\n return [script.title().lower() for script in scripts].index(name.lower())\n except Exception as e:\n raise HTTPException(status_code=422, detail=f\"Script '{name}' not found\") from e\n\n\ndef validate_sampler_name(name):\n config = sd_samplers.all_samplers_map.get(name, None)\n if config is None:\n raise HTTPException(status_code=404, detail=\"Sampler not found\")\n\n return name\n\n\ndef setUpscalers(req: dict):\n reqDict = vars(req)\n reqDict['extras_upscaler_1'] = reqDict.pop('upscaler_1', None)\n reqDict['extras_upscaler_2'] = reqDict.pop('upscaler_2', None)\n return reqDict\n\n\ndef decode_base64_to_image(encoding):\n if encoding.startswith(\"data:image/\"):\n encoding = encoding.split(\";\")[1].split(\",\")[1]\n try:\n image = Image.open(BytesIO(base64.b64decode(encoding)))\n return image\n except Exception as e:\n raise HTTPException(status_code=500, detail=\"Invalid encoded image\") from e\n\n\ndef encode_pil_to_base64(image):\n with io.BytesIO() as output_bytes:\n\n if opts.samples_format.lower() == 'png':\n use_metadata = False\n metadata = PngImagePlugin.PngInfo()\n for key, value in image.info.items():\n if isinstance(key, str) and isinstance(value, str):\n metadata.add_text(key, value)\n use_metadata = True\n image.save(output_bytes, format=\"PNG\", pnginfo=(metadata if use_metadata else None), quality=opts.jpeg_quality)\n\n elif opts.samples_format.lower() in (\"jpg\", \"jpeg\", \"webp\"):\n parameters = image.info.get('parameters', None)\n exif_bytes = piexif.dump({\n \"Exif\": { piexif.ExifIFD.UserComment: piexif.helper.UserComment.dump(parameters or \"\", encoding=\"unicode\") }\n })\n if opts.samples_format.lower() in (\"jpg\", \"jpeg\"):\n image.save(output_bytes, format=\"JPEG\", exif = exif_bytes, quality=opts.jpeg_quality)\n else:\n image.save(output_bytes, format=\"WEBP\", exif = exif_bytes, quality=opts.jpeg_quality)\n\n else:\n raise HTTPException(status_code=500, detail=\"Invalid image format\")\n\n bytes_data = output_bytes.getvalue()\n\n return base64.b64encode(bytes_data)\n\n\ndef api_middleware(app: FastAPI):\n rich_available = True\n try:\n import anyio # importing just so it can be placed on silent list\n import starlette # importing just so it can be placed on silent list\n from rich.console import Console\n console = Console()\n except Exception:\n import traceback\n rich_available = False\n\n @app.middleware(\"http\")\n async def log_and_time(req: Request, call_next):\n ts = time.time()\n res: Response = await call_next(req)\n duration = str(round(time.time() - ts, 4))\n res.headers[\"X-Process-Time\"] = duration\n endpoint = req.scope.get('path', 'err')\n if shared.cmd_opts.api_log and endpoint.startswith('/sdapi'):\n print('API {t} {code} {prot}/{ver} {method} {endpoint} {cli} {duration}'.format(\n t = datetime.datetime.now().strftime(\"%Y-%m-%d %H:%M:%S.%f\"),\n code = res.status_code,\n ver = req.scope.get('http_version', '0.0'),\n cli = req.scope.get('client', ('0:0.0.0', 0))[0],\n prot = req.scope.get('scheme', 'err'),\n method = req.scope.get('method', 'err'),\n endpoint = endpoint,\n duration = duration,\n ))\n return res\n\n def handle_exception(request: Request, e: Exception):\n err = {\n \"error\": type(e).__name__,\n \"detail\": vars(e).get('detail', ''),\n \"body\": vars(e).get('body', ''),\n \"errors\": str(e),\n }\n if not isinstance(e, HTTPException): # do not print backtrace on known httpexceptions\n print(f\"API error: {request.method}: {request.url} {err}\")\n if rich_available:\n console.print_exception(show_locals=True, max_frames=2, extra_lines=1, suppress=[anyio, starlette], word_wrap=False, width=min([console.width, 200]))\n else:\n traceback.print_exc()\n return JSONResponse(status_code=vars(e).get('status_code', 500), content=jsonable_encoder(err))\n\n @app.middleware(\"http\")\n async def exception_handling(request: Request, call_next):\n try:\n return await call_next(request)\n except Exception as e:\n return handle_exception(request, e)\n\n @app.exception_handler(Exception)\n async def fastapi_exception_handler(request: Request, e: Exception):\n return handle_exception(request, e)\n\n @app.exception_handler(HTTPException)\n async def http_exception_handler(request: Request, e: HTTPException):\n return handle_exception(request, e)\n\n\nclass Api:\n def __init__(self, app: FastAPI, queue_lock: Lock):\n if shared.cmd_opts.api_auth:\n self.credentials = {}\n for auth in shared.cmd_opts.api_auth.split(\",\"):\n user, password = auth.split(\":\")\n self.credentials[user] = password\n\n self.router = APIRouter()\n self.app = app\n self.queue_lock = queue_lock\n api_middleware(self.app)\n self.add_api_route(\"/sdapi/v1/txt2img\", self.text2imgapi, methods=[\"POST\"], response_model=models.TextToImageResponse)\n self.add_api_route(\"/sdapi/v1/img2img\", self.img2imgapi, methods=[\"POST\"], response_model=models.ImageToImageResponse)\n self.add_api_route(\"/sdapi/v1/extra-single-image\", self.extras_single_image_api, methods=[\"POST\"], response_model=models.ExtrasSingleImageResponse)\n self.add_api_route(\"/sdapi/v1/extra-batch-images\", self.extras_batch_images_api, methods=[\"POST\"], response_model=models.ExtrasBatchImagesResponse)\n self.add_api_route(\"/sdapi/v1/png-info\", self.pnginfoapi, methods=[\"POST\"], response_model=models.PNGInfoResponse)\n self.add_api_route(\"/sdapi/v1/progress\", self.progressapi, methods=[\"GET\"], response_model=models.ProgressResponse)\n self.add_api_route(\"/sdapi/v1/interrogate\", self.interrogateapi, methods=[\"POST\"])\n self.add_api_route(\"/sdapi/v1/interrupt\", self.interruptapi, methods=[\"POST\"])\n self.add_api_route(\"/sdapi/v1/skip\", self.skip, methods=[\"POST\"])\n self.add_api_route(\"/sdapi/v1/options\", self.get_config, methods=[\"GET\"], response_model=models.OptionsModel)\n self.add_api_route(\"/sdapi/v1/options\", self.set_config, methods=[\"POST\"])\n self.add_api_route(\"/sdapi/v1/cmd-flags\", self.get_cmd_flags, methods=[\"GET\"], response_model=models.FlagsModel)\n self.add_api_route(\"/sdapi/v1/samplers\", self.get_samplers, methods=[\"GET\"], response_model=List[models.SamplerItem])\n self.add_api_route(\"/sdapi/v1/upscalers\", self.get_upscalers, methods=[\"GET\"], response_model=List[models.UpscalerItem])\n self.add_api_route(\"/sdapi/v1/sd-models\", self.get_sd_models, methods=[\"GET\"], response_model=List[models.SDModelItem])\n self.add_api_route(\"/sdapi/v1/hypernetworks\", self.get_hypernetworks, methods=[\"GET\"], response_model=List[models.HypernetworkItem])\n self.add_api_route(\"/sdapi/v1/face-restorers\", self.get_face_restorers, methods=[\"GET\"], response_model=List[models.FaceRestorerItem])\n self.add_api_route(\"/sdapi/v1/realesrgan-models\", self.get_realesrgan_models, methods=[\"GET\"], response_model=List[models.RealesrganItem])\n self.add_api_route(\"/sdapi/v1/prompt-styles\", self.get_prompt_styles, methods=[\"GET\"], response_model=List[models.PromptStyleItem])\n self.add_api_route(\"/sdapi/v1/embeddings\", self.get_embeddings, methods=[\"GET\"], response_model=models.EmbeddingsResponse)\n self.add_api_route(\"/sdapi/v1/refresh-checkpoints\", self.refresh_checkpoints, methods=[\"POST\"])\n self.add_api_route(\"/sdapi/v1/create/embedding\", self.create_embedding, methods=[\"POST\"], response_model=models.CreateResponse)\n self.add_api_route(\"/sdapi/v1/create/hypernetwork\", self.create_hypernetwork, methods=[\"POST\"], response_model=models.CreateResponse)\n self.add_api_route(\"/sdapi/v1/preprocess\", self.preprocess, methods=[\"POST\"], response_model=models.PreprocessResponse)\n self.add_api_route(\"/sdapi/v1/train/embedding\", self.train_embedding, methods=[\"POST\"], response_model=models.TrainResponse)\n self.add_api_route(\"/sdapi/v1/train/hypernetwork\", self.train_hypernetwork, methods=[\"POST\"], response_model=models.TrainResponse)\n self.add_api_route(\"/sdapi/v1/memory\", self.get_memory, methods=[\"GET\"], response_model=models.MemoryResponse)\n self.add_api_route(\"/sdapi/v1/unload-checkpoint\", self.unloadapi, methods=[\"POST\"])\n self.add_api_route(\"/sdapi/v1/reload-checkpoint\", self.reloadapi, methods=[\"POST\"])\n self.add_api_route(\"/sdapi/v1/scripts\", self.get_scripts_list, methods=[\"GET\"], response_model=models.ScriptsList)\n self.add_api_route(\"/sdapi/v1/script-info\", self.get_script_info, methods=[\"GET\"], response_model=List[models.ScriptInfo])\n\n self.default_script_arg_txt2img = []\n self.default_script_arg_img2img = []\n\n def add_api_route(self, path: str, endpoint, **kwargs):\n if shared.cmd_opts.api_auth:\n return self.app.add_api_route(path, endpoint, dependencies=[Depends(self.auth)], **kwargs)\n return self.app.add_api_route(path, endpoint, **kwargs)\n\n def auth(self, credentials: HTTPBasicCredentials = Depends(HTTPBasic())):\n if credentials.username in self.credentials:\n if compare_digest(credentials.password, self.credentials[credentials.username]):\n return True\n\n raise HTTPException(status_code=401, detail=\"Incorrect username or password\", headers={\"WWW-Authenticate\": \"Basic\"})\n\n def get_selectable_script(self, script_name, script_runner):\n if script_name is None or script_name == \"\":\n return None, None\n\n script_idx = script_name_to_index(script_name, script_runner.selectable_scripts)\n script = script_runner.selectable_scripts[script_idx]\n return script, script_idx\n\n def get_scripts_list(self):\n t2ilist = [script.name for script in scripts.scripts_txt2img.scripts if script.name is not None]\n i2ilist = [script.name for script in scripts.scripts_img2img.scripts if script.name is not None]\n\n return models.ScriptsList(txt2img=t2ilist, img2img=i2ilist)\n\n def get_script_info(self):\n res = []\n\n for script_list in [scripts.scripts_txt2img.scripts, scripts.scripts_img2img.scripts]:\n res += [script.api_info for script in script_list if script.api_info is not None]\n\n return res\n\n def get_script(self, script_name, script_runner):\n if script_name is None or script_name == \"\":\n return None, None\n\n script_idx = script_name_to_index(script_name, script_runner.scripts)\n return script_runner.scripts[script_idx]\n\n def init_default_script_args(self, script_runner):\n #find max idx from the scripts in runner and generate a none array to init script_args\n last_arg_index = 1\n for script in script_runner.scripts:\n if last_arg_index < script.args_to:\n last_arg_index = script.args_to\n # None everywhere except position 0 to initialize script args\n script_args = [None]*last_arg_index\n script_args[0] = 0\n\n # get default values\n with gr.Blocks(): # will throw errors calling ui function without this\n for script in script_runner.scripts:\n if script.ui(script.is_img2img):\n ui_default_values = []\n for elem in script.ui(script.is_img2img):\n ui_default_values.append(elem.value)\n script_args[script.args_from:script.args_to] = ui_default_values\n return script_args\n\n def init_script_args(self, request, default_script_args, selectable_scripts, selectable_idx, script_runner):\n script_args = default_script_args.copy()\n # position 0 in script_arg is the idx+1 of the selectable script that is going to be run when using scripts.scripts_*2img.run()\n if selectable_scripts:\n script_args[selectable_scripts.args_from:selectable_scripts.args_to] = request.script_args\n script_args[0] = selectable_idx + 1\n\n # Now check for always on scripts\n if request.alwayson_scripts and (len(request.alwayson_scripts) > 0):\n for alwayson_script_name in request.alwayson_scripts.keys():\n alwayson_script = self.get_script(alwayson_script_name, script_runner)\n if alwayson_script is None:\n raise HTTPException(status_code=422, detail=f\"always on script {alwayson_script_name} not found\")\n # Selectable script in always on script param check\n if alwayson_script.alwayson is False:\n raise HTTPException(status_code=422, detail=\"Cannot have a selectable script in the always on scripts params\")\n # always on script with no arg should always run so you don't really need to add them to the requests\n if \"args\" in request.alwayson_scripts[alwayson_script_name]:\n # min between arg length in scriptrunner and arg length in the request\n for idx in range(0, min((alwayson_script.args_to - alwayson_script.args_from), len(request.alwayson_scripts[alwayson_script_name][\"args\"]))):\n script_args[alwayson_script.args_from + idx] = request.alwayson_scripts[alwayson_script_name][\"args\"][idx]\n return script_args\n\n def text2imgapi(self, txt2imgreq: models.StableDiffusionTxt2ImgProcessingAPI):\n script_runner = scripts.scripts_txt2img\n if not script_runner.scripts:\n script_runner.initialize_scripts(False)\n ui.create_ui()\n if not self.default_script_arg_txt2img:\n self.default_script_arg_txt2img = self.init_default_script_args(script_runner)\n selectable_scripts, selectable_script_idx = self.get_selectable_script(txt2imgreq.script_name, script_runner)\n\n populate = txt2imgreq.copy(update={ # Override __init__ params\n \"sampler_name\": validate_sampler_name(txt2imgreq.sampler_name or txt2imgreq.sampler_index),\n \"do_not_save_samples\": not txt2imgreq.save_images,\n \"do_not_save_grid\": not txt2imgreq.save_images,\n })\n if populate.sampler_name:\n populate.sampler_index = None # prevent a warning later on\n\n args = vars(populate)\n args.pop('script_name', None)\n args.pop('script_args', None) # will refeed them to the pipeline directly after initializing them\n args.pop('alwayson_scripts', None)\n\n script_args = self.init_script_args(txt2imgreq, self.default_script_arg_txt2img, selectable_scripts, selectable_script_idx, script_runner)\n\n send_images = args.pop('send_images', True)\n args.pop('save_images', None)\n\n with self.queue_lock:\n p = StableDiffusionProcessingTxt2Img(sd_model=shared.sd_model, **args)\n p.scripts = script_runner\n p.outpath_grids = opts.outdir_txt2img_grids\n p.outpath_samples = opts.outdir_txt2img_samples\n\n shared.state.begin()\n if selectable_scripts is not None:\n p.script_args = script_args\n processed = scripts.scripts_txt2img.run(p, *p.script_args) # Need to pass args as list here\n else:\n p.script_args = tuple(script_args) # Need to pass args as tuple here\n processed = process_images(p)\n shared.state.end()\n\n b64images = list(map(encode_pil_to_base64, processed.images)) if send_images else []\n\n return models.TextToImageResponse(images=b64images, parameters=vars(txt2imgreq), info=processed.js())\n\n def img2imgapi(self, img2imgreq: models.StableDiffusionImg2ImgProcessingAPI):\n init_images = img2imgreq.init_images\n if init_images is None:\n raise HTTPException(status_code=404, detail=\"Init image not found\")\n\n mask = img2imgreq.mask\n if mask:\n mask = decode_base64_to_image(mask)\n\n script_runner = scripts.scripts_img2img\n if not script_runner.scripts:\n script_runner.initialize_scripts(True)\n ui.create_ui()\n if not self.default_script_arg_img2img:\n self.default_script_arg_img2img = self.init_default_script_args(script_runner)\n selectable_scripts, selectable_script_idx = self.get_selectable_script(img2imgreq.script_name, script_runner)\n\n populate = img2imgreq.copy(update={ # Override __init__ params\n \"sampler_name\": validate_sampler_name(img2imgreq.sampler_name or img2imgreq.sampler_index),\n \"do_not_save_samples\": not img2imgreq.save_images,\n \"do_not_save_grid\": not img2imgreq.save_images,\n \"mask\": mask,\n })\n if populate.sampler_name:\n populate.sampler_index = None # prevent a warning later on\n\n args = vars(populate)\n args.pop('include_init_images', None) # this is meant to be done by \"exclude\": True in model, but it's for a reason that I cannot determine.\n args.pop('script_name', None)\n args.pop('script_args', None) # will refeed them to the pipeline directly after initializing them\n args.pop('alwayson_scripts', None)\n\n script_args = self.init_script_args(img2imgreq, self.default_script_arg_img2img, selectable_scripts, selectable_script_idx, script_runner)\n\n send_images = args.pop('send_images', True)\n args.pop('save_images', None)\n\n with self.queue_lock:\n p = StableDiffusionProcessingImg2Img(sd_model=shared.sd_model, **args)\n p.init_images = [decode_base64_to_image(x) for x in init_images]\n p.scripts = script_runner\n p.outpath_grids = opts.outdir_img2img_grids\n p.outpath_samples = opts.outdir_img2img_samples\n\n shared.state.begin()\n if selectable_scripts is not None:\n p.script_args = script_args\n processed = scripts.scripts_img2img.run(p, *p.script_args) # Need to pass args as list here\n else:\n p.script_args = tuple(script_args) # Need to pass args as tuple here\n processed = process_images(p)\n shared.state.end()\n\n b64images = list(map(encode_pil_to_base64, processed.images)) if send_images else []\n\n if not img2imgreq.include_init_images:\n img2imgreq.init_images = None\n img2imgreq.mask = None\n\n return models.ImageToImageResponse(images=b64images, parameters=vars(img2imgreq), info=processed.js())\n\n def extras_single_image_api(self, req: models.ExtrasSingleImageRequest):\n reqDict = setUpscalers(req)\n\n reqDict['image'] = decode_base64_to_image(reqDict['image'])\n\n with self.queue_lock:\n result = postprocessing.run_extras(extras_mode=0, image_folder=\"\", input_dir=\"\", output_dir=\"\", save_output=False, **reqDict)\n\n return models.ExtrasSingleImageResponse(image=encode_pil_to_base64(result[0][0]), html_info=result[1])\n\n def extras_batch_images_api(self, req: models.ExtrasBatchImagesRequest):\n reqDict = setUpscalers(req)\n\n image_list = reqDict.pop('imageList', [])\n image_folder = [decode_base64_to_image(x.data) for x in image_list]\n\n with self.queue_lock:\n result = postprocessing.run_extras(extras_mode=1, image_folder=image_folder, image=\"\", input_dir=\"\", output_dir=\"\", save_output=False, **reqDict)\n\n return models.ExtrasBatchImagesResponse(images=list(map(encode_pil_to_base64, result[0])), html_info=result[1])\n\n def pnginfoapi(self, req: models.PNGInfoRequest):\n if(not req.image.strip()):\n return models.PNGInfoResponse(info=\"\")\n\n image = decode_base64_to_image(req.image.strip())\n if image is None:\n return models.PNGInfoResponse(info=\"\")\n\n geninfo, items = images.read_info_from_image(image)\n if geninfo is None:\n geninfo = \"\"\n\n items = {**{'parameters': geninfo}, **items}\n\n return models.PNGInfoResponse(info=geninfo, items=items)\n\n def progressapi(self, req: models.ProgressRequest = Depends()):\n # copy from check_progress_call of ui.py\n\n if shared.state.job_count == 0:\n return models.ProgressResponse(progress=0, eta_relative=0, state=shared.state.dict(), textinfo=shared.state.textinfo)\n\n # avoid dividing zero\n progress = 0.01\n\n if shared.state.job_count > 0:\n progress += shared.state.job_no / shared.state.job_count\n if shared.state.sampling_steps > 0:\n progress += 1 / shared.state.job_count * shared.state.sampling_step / shared.state.sampling_steps\n\n time_since_start = time.time() - shared.state.time_start\n eta = (time_since_start/progress)\n eta_relative = eta-time_since_start\n\n progress = min(progress, 1)\n\n shared.state.set_current_image()\n\n current_image = None\n if shared.state.current_image and not req.skip_current_image:\n current_image = encode_pil_to_base64(shared.state.current_image)\n\n return models.ProgressResponse(progress=progress, eta_relative=eta_relative, state=shared.state.dict(), current_image=current_image, textinfo=shared.state.textinfo)\n\n def interrogateapi(self, interrogatereq: models.InterrogateRequest):\n image_b64 = interrogatereq.image\n if image_b64 is None:\n raise HTTPException(status_code=404, detail=\"Image not found\")\n\n img = decode_base64_to_image(image_b64)\n img = img.convert('RGB')\n\n # Override object param\n with self.queue_lock:\n if interrogatereq.model == \"clip\":\n processed = shared.interrogator.interrogate(img)\n elif interrogatereq.model == \"deepdanbooru\":\n processed = deepbooru.model.tag(img)\n else:\n raise HTTPException(status_code=404, detail=\"Model not found\")\n\n return models.InterrogateResponse(caption=processed)\n\n def interruptapi(self):\n shared.state.interrupt()\n\n return {}\n\n def unloadapi(self):\n unload_model_weights()\n\n return {}\n\n def reloadapi(self):\n reload_model_weights()\n\n return {}\n\n def skip(self):\n shared.state.skip()\n\n def get_config(self):\n options = {}\n for key in shared.opts.data.keys():\n metadata = shared.opts.data_labels.get(key)\n if(metadata is not None):\n options.update({key: shared.opts.data.get(key, shared.opts.data_labels.get(key).default)})\n else:\n options.update({key: shared.opts.data.get(key, None)})\n\n return options\n\n def set_config(self, req: Dict[str, Any]):\n for k, v in req.items():\n shared.opts.set(k, v)\n\n shared.opts.save(shared.config_filename)\n return\n\n def get_cmd_flags(self):\n return vars(shared.cmd_opts)\n\n def get_samplers(self):\n return [{\"name\": sampler[0], \"aliases\":sampler[2], \"options\":sampler[3]} for sampler in sd_samplers.all_samplers]\n\n def get_upscalers(self):\n return [\n {\n \"name\": upscaler.name,\n \"model_name\": upscaler.scaler.model_name,\n \"model_path\": upscaler.data_path,\n \"model_url\": None,\n \"scale\": upscaler.scale,\n }\n for upscaler in shared.sd_upscalers\n ]\n\n def get_sd_models(self):\n return [{\"title\": x.title, \"model_name\": x.model_name, \"hash\": x.shorthash, \"sha256\": x.sha256, \"filename\": x.filename, \"config\": find_checkpoint_config_near_filename(x)} for x in checkpoints_list.values()]\n\n def get_hypernetworks(self):\n return [{\"name\": name, \"path\": shared.hypernetworks[name]} for name in shared.hypernetworks]\n\n def get_face_restorers(self):\n return [{\"name\":x.name(), \"cmd_dir\": getattr(x, \"cmd_dir\", None)} for x in shared.face_restorers]\n\n def get_realesrgan_models(self):\n return [{\"name\":x.name,\"path\":x.data_path, \"scale\":x.scale} for x in get_realesrgan_models(None)]\n\n def get_prompt_styles(self):\n styleList = []\n for k in shared.prompt_styles.styles:\n style = shared.prompt_styles.styles[k]\n styleList.append({\"name\":style[0], \"prompt\": style[1], \"negative_prompt\": style[2]})\n\n return styleList\n\n def get_embeddings(self):\n db = sd_hijack.model_hijack.embedding_db\n\n def convert_embedding(embedding):\n return {\n \"step\": embedding.step,\n \"sd_checkpoint\": embedding.sd_checkpoint,\n \"sd_checkpoint_name\": embedding.sd_checkpoint_name,\n \"shape\": embedding.shape,\n \"vectors\": embedding.vectors,\n }\n\n def convert_embeddings(embeddings):\n return {embedding.name: convert_embedding(embedding) for embedding in embeddings.values()}\n\n return {\n \"loaded\": convert_embeddings(db.word_embeddings),\n \"skipped\": convert_embeddings(db.skipped_embeddings),\n }\n\n def refresh_checkpoints(self):\n shared.refresh_checkpoints()\n\n def create_embedding(self, args: dict):\n try:\n shared.state.begin()\n filename = create_embedding(**args) # create empty embedding\n sd_hijack.model_hijack.embedding_db.load_textual_inversion_embeddings() # reload embeddings so new one can be immediately used\n shared.state.end()\n return models.CreateResponse(info=f\"create embedding filename: {filename}\")\n except AssertionError as e:\n shared.state.end()\n return models.TrainResponse(info=f\"create embedding error: {e}\")\n\n def create_hypernetwork(self, args: dict):\n try:\n shared.state.begin()\n filename = create_hypernetwork(**args) # create empty embedding\n shared.state.end()\n return models.CreateResponse(info=f\"create hypernetwork filename: {filename}\")\n except AssertionError as e:\n shared.state.end()\n return models.TrainResponse(info=f\"create hypernetwork error: {e}\")\n\n def preprocess(self, args: dict):\n try:\n shared.state.begin()\n preprocess(**args) # quick operation unless blip/booru interrogation is enabled\n shared.state.end()\n return models.PreprocessResponse(info = 'preprocess complete')\n except KeyError as e:\n shared.state.end()\n return models.PreprocessResponse(info=f\"preprocess error: invalid token: {e}\")\n except AssertionError as e:\n shared.state.end()\n return models.PreprocessResponse(info=f\"preprocess error: {e}\")\n except FileNotFoundError as e:\n shared.state.end()\n return models.PreprocessResponse(info=f'preprocess error: {e}')\n\n def train_embedding(self, args: dict):\n try:\n shared.state.begin()\n apply_optimizations = shared.opts.training_xattention_optimizations\n error = None\n filename = ''\n if not apply_optimizations:\n sd_hijack.undo_optimizations()\n try:\n embedding, filename = train_embedding(**args) # can take a long time to complete\n except Exception as e:\n error = e\n finally:\n if not apply_optimizations:\n sd_hijack.apply_optimizations()\n shared.state.end()\n return models.TrainResponse(info=f\"train embedding complete: filename: {filename} error: {error}\")\n except AssertionError as msg:\n shared.state.end()\n return models.TrainResponse(info=f\"train embedding error: {msg}\")\n\n def train_hypernetwork(self, args: dict):\n try:\n shared.state.begin()\n shared.loaded_hypernetworks = []\n apply_optimizations = shared.opts.training_xattention_optimizations\n error = None\n filename = ''\n if not apply_optimizations:\n sd_hijack.undo_optimizations()\n try:\n hypernetwork, filename = train_hypernetwork(**args)\n except Exception as e:\n error = e\n finally:\n shared.sd_model.cond_stage_model.to(devices.device)\n shared.sd_model.first_stage_model.to(devices.device)\n if not apply_optimizations:\n sd_hijack.apply_optimizations()\n shared.state.end()\n return models.TrainResponse(info=f\"train embedding complete: filename: {filename} error: {error}\")\n except AssertionError:\n shared.state.end()\n return models.TrainResponse(info=f\"train embedding error: {error}\")\n\n def get_memory(self):\n try:\n import os\n import psutil\n process = psutil.Process(os.getpid())\n res = process.memory_info() # only rss is cross-platform guaranteed so we dont rely on other values\n ram_total = 100 * res.rss / process.memory_percent() # and total memory is calculated as actual value is not cross-platform safe\n ram = { 'free': ram_total - res.rss, 'used': res.rss, 'total': ram_total }\n except Exception as err:\n ram = { 'error': f'{err}' }\n try:\n import torch\n if torch.cuda.is_available():\n s = torch.cuda.mem_get_info()\n system = { 'free': s[0], 'used': s[1] - s[0], 'total': s[1] }\n s = dict(torch.cuda.memory_stats(shared.device))\n allocated = { 'current': s['allocated_bytes.all.current'], 'peak': s['allocated_bytes.all.peak'] }\n reserved = { 'current': s['reserved_bytes.all.current'], 'peak': s['reserved_bytes.all.peak'] }\n active = { 'current': s['active_bytes.all.current'], 'peak': s['active_bytes.all.peak'] }\n inactive = { 'current': s['inactive_split_bytes.all.current'], 'peak': s['inactive_split_bytes.all.peak'] }\n warnings = { 'retries': s['num_alloc_retries'], 'oom': s['num_ooms'] }\n cuda = {\n 'system': system,\n 'active': active,\n 'allocated': allocated,\n 'reserved': reserved,\n 'inactive': inactive,\n 'events': warnings,\n }\n else:\n cuda = {'error': 'unavailable'}\n except Exception as err:\n cuda = {'error': f'{err}'}\n return models.MemoryResponse(ram=ram, cuda=cuda)\n\n def launch(self, server_name, port):\n self.app.include_router(self.router)\n uvicorn.run(self.app, host=server_name, port=port)\n", "path": "modules/api/api.py"}], "after_files": [{"content": "import base64\nimport io\nimport time\nimport datetime\nimport uvicorn\nimport gradio as gr\nfrom threading import Lock\nfrom io import BytesIO\nfrom fastapi import APIRouter, Depends, FastAPI, Request, Response\nfrom fastapi.security import HTTPBasic, HTTPBasicCredentials\nfrom fastapi.exceptions import HTTPException\nfrom fastapi.responses import JSONResponse\nfrom fastapi.encoders import jsonable_encoder\nfrom secrets import compare_digest\n\nimport modules.shared as shared\nfrom modules import sd_samplers, deepbooru, sd_hijack, images, scripts, ui, postprocessing\nfrom modules.api.models import *\nfrom modules.processing import StableDiffusionProcessingTxt2Img, StableDiffusionProcessingImg2Img, process_images\nfrom modules.textual_inversion.textual_inversion import create_embedding, train_embedding\nfrom modules.textual_inversion.preprocess import preprocess\nfrom modules.hypernetworks.hypernetwork import create_hypernetwork, train_hypernetwork\nfrom PIL import PngImagePlugin,Image\nfrom modules.sd_models import checkpoints_list, unload_model_weights, reload_model_weights\nfrom modules.sd_models_config import find_checkpoint_config_near_filename\nfrom modules.realesrgan_model import get_realesrgan_models\nfrom modules import devices\nfrom typing import List\nimport piexif\nimport piexif.helper\n\ndef upscaler_to_index(name: str):\n try:\n return [x.name.lower() for x in shared.sd_upscalers].index(name.lower())\n except:\n raise HTTPException(status_code=400, detail=f\"Invalid upscaler, needs to be one of these: {' , '.join([x.name for x in sd_upscalers])}\")\n\ndef script_name_to_index(name, scripts):\n try:\n return [script.title().lower() for script in scripts].index(name.lower())\n except:\n raise HTTPException(status_code=422, detail=f\"Script '{name}' not found\")\n\ndef validate_sampler_name(name):\n config = sd_samplers.all_samplers_map.get(name, None)\n if config is None:\n raise HTTPException(status_code=404, detail=\"Sampler not found\")\n\n return name\n\ndef setUpscalers(req: dict):\n reqDict = vars(req)\n reqDict['extras_upscaler_1'] = reqDict.pop('upscaler_1', None)\n reqDict['extras_upscaler_2'] = reqDict.pop('upscaler_2', None)\n return reqDict\n\ndef decode_base64_to_image(encoding):\n if encoding.startswith(\"data:image/\"):\n encoding = encoding.split(\";\")[1].split(\",\")[1]\n try:\n image = Image.open(BytesIO(base64.b64decode(encoding)))\n return image\n except Exception as err:\n raise HTTPException(status_code=500, detail=\"Invalid encoded image\")\n\ndef encode_pil_to_base64(image):\n with io.BytesIO() as output_bytes:\n\n if opts.samples_format.lower() == 'png':\n use_metadata = False\n metadata = PngImagePlugin.PngInfo()\n for key, value in image.info.items():\n if isinstance(key, str) and isinstance(value, str):\n metadata.add_text(key, value)\n use_metadata = True\n image.save(output_bytes, format=\"PNG\", pnginfo=(metadata if use_metadata else None), quality=opts.jpeg_quality)\n\n elif opts.samples_format.lower() in (\"jpg\", \"jpeg\", \"webp\"):\n parameters = image.info.get('parameters', None)\n exif_bytes = piexif.dump({\n \"Exif\": { piexif.ExifIFD.UserComment: piexif.helper.UserComment.dump(parameters or \"\", encoding=\"unicode\") }\n })\n if opts.samples_format.lower() in (\"jpg\", \"jpeg\"):\n image.save(output_bytes, format=\"JPEG\", exif = exif_bytes, quality=opts.jpeg_quality)\n else:\n image.save(output_bytes, format=\"WEBP\", exif = exif_bytes, quality=opts.jpeg_quality)\n\n else:\n raise HTTPException(status_code=500, detail=\"Invalid image format\")\n\n bytes_data = output_bytes.getvalue()\n\n return base64.b64encode(bytes_data)\n\ndef api_middleware(app: FastAPI):\n rich_available = True\n try:\n import anyio # importing just so it can be placed on silent list\n import starlette # importing just so it can be placed on silent list\n from rich.console import Console\n console = Console()\n except:\n import traceback\n rich_available = False\n\n @app.middleware(\"http\")\n async def log_and_time(req: Request, call_next):\n ts = time.time()\n res: Response = await call_next(req)\n duration = str(round(time.time() - ts, 4))\n res.headers[\"X-Process-Time\"] = duration\n endpoint = req.scope.get('path', 'err')\n if shared.cmd_opts.api_log and endpoint.startswith('/sdapi'):\n print('API {t} {code} {prot}/{ver} {method} {endpoint} {cli} {duration}'.format(\n t = datetime.datetime.now().strftime(\"%Y-%m-%d %H:%M:%S.%f\"),\n code = res.status_code,\n ver = req.scope.get('http_version', '0.0'),\n cli = req.scope.get('client', ('0:0.0.0', 0))[0],\n prot = req.scope.get('scheme', 'err'),\n method = req.scope.get('method', 'err'),\n endpoint = endpoint,\n duration = duration,\n ))\n return res\n\n def handle_exception(request: Request, e: Exception):\n err = {\n \"error\": type(e).__name__,\n \"detail\": vars(e).get('detail', ''),\n \"body\": vars(e).get('body', ''),\n \"errors\": str(e),\n }\n if not isinstance(e, HTTPException): # do not print backtrace on known httpexceptions\n print(f\"API error: {request.method}: {request.url} {err}\")\n if rich_available:\n console.print_exception(show_locals=True, max_frames=2, extra_lines=1, suppress=[anyio, starlette], word_wrap=False, width=min([console.width, 200]))\n else:\n traceback.print_exc()\n return JSONResponse(status_code=vars(e).get('status_code', 500), content=jsonable_encoder(err))\n\n @app.middleware(\"http\")\n async def exception_handling(request: Request, call_next):\n try:\n return await call_next(request)\n except Exception as e:\n return handle_exception(request, e)\n\n @app.exception_handler(Exception)\n async def fastapi_exception_handler(request: Request, e: Exception):\n return handle_exception(request, e)\n\n @app.exception_handler(HTTPException)\n async def http_exception_handler(request: Request, e: HTTPException):\n return handle_exception(request, e)\n\n\nclass Api:\n def __init__(self, app: FastAPI, queue_lock: Lock):\n if shared.cmd_opts.api_auth:\n self.credentials = dict()\n for auth in shared.cmd_opts.api_auth.split(\",\"):\n user, password = auth.split(\":\")\n self.credentials[user] = password\n\n self.router = APIRouter()\n self.app = app\n self.queue_lock = queue_lock\n api_middleware(self.app)\n self.add_api_route(\"/sdapi/v1/txt2img\", self.text2imgapi, methods=[\"POST\"], response_model=TextToImageResponse)\n self.add_api_route(\"/sdapi/v1/img2img\", self.img2imgapi, methods=[\"POST\"], response_model=ImageToImageResponse)\n self.add_api_route(\"/sdapi/v1/extra-single-image\", self.extras_single_image_api, methods=[\"POST\"], response_model=ExtrasSingleImageResponse)\n self.add_api_route(\"/sdapi/v1/extra-batch-images\", self.extras_batch_images_api, methods=[\"POST\"], response_model=ExtrasBatchImagesResponse)\n self.add_api_route(\"/sdapi/v1/png-info\", self.pnginfoapi, methods=[\"POST\"], response_model=PNGInfoResponse)\n self.add_api_route(\"/sdapi/v1/progress\", self.progressapi, methods=[\"GET\"], response_model=ProgressResponse)\n self.add_api_route(\"/sdapi/v1/interrogate\", self.interrogateapi, methods=[\"POST\"])\n self.add_api_route(\"/sdapi/v1/interrupt\", self.interruptapi, methods=[\"POST\"])\n self.add_api_route(\"/sdapi/v1/skip\", self.skip, methods=[\"POST\"])\n self.add_api_route(\"/sdapi/v1/options\", self.get_config, methods=[\"GET\"], response_model=OptionsModel)\n self.add_api_route(\"/sdapi/v1/options\", self.set_config, methods=[\"POST\"])\n self.add_api_route(\"/sdapi/v1/cmd-flags\", self.get_cmd_flags, methods=[\"GET\"], response_model=FlagsModel)\n self.add_api_route(\"/sdapi/v1/samplers\", self.get_samplers, methods=[\"GET\"], response_model=List[SamplerItem])\n self.add_api_route(\"/sdapi/v1/upscalers\", self.get_upscalers, methods=[\"GET\"], response_model=List[UpscalerItem])\n self.add_api_route(\"/sdapi/v1/sd-models\", self.get_sd_models, methods=[\"GET\"], response_model=List[SDModelItem])\n self.add_api_route(\"/sdapi/v1/hypernetworks\", self.get_hypernetworks, methods=[\"GET\"], response_model=List[HypernetworkItem])\n self.add_api_route(\"/sdapi/v1/face-restorers\", self.get_face_restorers, methods=[\"GET\"], response_model=List[FaceRestorerItem])\n self.add_api_route(\"/sdapi/v1/realesrgan-models\", self.get_realesrgan_models, methods=[\"GET\"], response_model=List[RealesrganItem])\n self.add_api_route(\"/sdapi/v1/prompt-styles\", self.get_prompt_styles, methods=[\"GET\"], response_model=List[PromptStyleItem])\n self.add_api_route(\"/sdapi/v1/embeddings\", self.get_embeddings, methods=[\"GET\"], response_model=EmbeddingsResponse)\n self.add_api_route(\"/sdapi/v1/refresh-checkpoints\", self.refresh_checkpoints, methods=[\"POST\"])\n self.add_api_route(\"/sdapi/v1/create/embedding\", self.create_embedding, methods=[\"POST\"], response_model=CreateResponse)\n self.add_api_route(\"/sdapi/v1/create/hypernetwork\", self.create_hypernetwork, methods=[\"POST\"], response_model=CreateResponse)\n self.add_api_route(\"/sdapi/v1/preprocess\", self.preprocess, methods=[\"POST\"], response_model=PreprocessResponse)\n self.add_api_route(\"/sdapi/v1/train/embedding\", self.train_embedding, methods=[\"POST\"], response_model=TrainResponse)\n self.add_api_route(\"/sdapi/v1/train/hypernetwork\", self.train_hypernetwork, methods=[\"POST\"], response_model=TrainResponse)\n self.add_api_route(\"/sdapi/v1/memory\", self.get_memory, methods=[\"GET\"], response_model=MemoryResponse)\n self.add_api_route(\"/sdapi/v1/unload-checkpoint\", self.unloadapi, methods=[\"POST\"])\n self.add_api_route(\"/sdapi/v1/reload-checkpoint\", self.reloadapi, methods=[\"POST\"])\n self.add_api_route(\"/sdapi/v1/scripts\", self.get_scripts_list, methods=[\"GET\"], response_model=ScriptsList)\n\n self.default_script_arg_txt2img = []\n self.default_script_arg_img2img = []\n\n def add_api_route(self, path: str, endpoint, **kwargs):\n if shared.cmd_opts.api_auth:\n return self.app.add_api_route(path, endpoint, dependencies=[Depends(self.auth)], **kwargs)\n return self.app.add_api_route(path, endpoint, **kwargs)\n\n def auth(self, credentials: HTTPBasicCredentials = Depends(HTTPBasic())):\n if credentials.username in self.credentials:\n if compare_digest(credentials.password, self.credentials[credentials.username]):\n return True\n\n raise HTTPException(status_code=401, detail=\"Incorrect username or password\", headers={\"WWW-Authenticate\": \"Basic\"})\n\n def get_selectable_script(self, script_name, script_runner):\n if script_name is None or script_name == \"\":\n return None, None\n\n script_idx = script_name_to_index(script_name, script_runner.selectable_scripts)\n script = script_runner.selectable_scripts[script_idx]\n return script, script_idx\n \n def get_scripts_list(self):\n t2ilist = [str(title.lower()) for title in scripts.scripts_txt2img.titles]\n i2ilist = [str(title.lower()) for title in scripts.scripts_img2img.titles]\n\n return ScriptsList(txt2img = t2ilist, img2img = i2ilist) \n\n def get_script(self, script_name, script_runner):\n if script_name is None or script_name == \"\":\n return None, None\n \n script_idx = script_name_to_index(script_name, script_runner.scripts)\n return script_runner.scripts[script_idx]\n\n def init_default_script_args(self, script_runner):\n #find max idx from the scripts in runner and generate a none array to init script_args\n last_arg_index = 1\n for script in script_runner.scripts:\n if last_arg_index < script.args_to:\n last_arg_index = script.args_to\n # None everywhere except position 0 to initialize script args\n script_args = [None]*last_arg_index\n script_args[0] = 0\n\n # get default values\n with gr.Blocks(): # will throw errors calling ui function without this\n for script in script_runner.scripts:\n if script.ui(script.is_img2img):\n ui_default_values = []\n for elem in script.ui(script.is_img2img):\n ui_default_values.append(elem.value)\n script_args[script.args_from:script.args_to] = ui_default_values\n return script_args\n\n def init_script_args(self, request, default_script_args, selectable_scripts, selectable_idx, script_runner):\n script_args = default_script_args.copy()\n # position 0 in script_arg is the idx+1 of the selectable script that is going to be run when using scripts.scripts_*2img.run()\n if selectable_scripts:\n script_args[selectable_scripts.args_from:selectable_scripts.args_to] = request.script_args\n script_args[0] = selectable_idx + 1\n\n # Now check for always on scripts\n if request.alwayson_scripts and (len(request.alwayson_scripts) > 0):\n for alwayson_script_name in request.alwayson_scripts.keys():\n alwayson_script = self.get_script(alwayson_script_name, script_runner)\n if alwayson_script == None:\n raise HTTPException(status_code=422, detail=f\"always on script {alwayson_script_name} not found\")\n # Selectable script in always on script param check\n if alwayson_script.alwayson == False:\n raise HTTPException(status_code=422, detail=f\"Cannot have a selectable script in the always on scripts params\")\n # always on script with no arg should always run so you don't really need to add them to the requests\n if \"args\" in request.alwayson_scripts[alwayson_script_name]:\n # min between arg length in scriptrunner and arg length in the request\n for idx in range(0, min((alwayson_script.args_to - alwayson_script.args_from), len(request.alwayson_scripts[alwayson_script_name][\"args\"]))):\n script_args[alwayson_script.args_from + idx] = request.alwayson_scripts[alwayson_script_name][\"args\"][idx]\n return script_args\n\n def text2imgapi(self, txt2imgreq: StableDiffusionTxt2ImgProcessingAPI):\n script_runner = scripts.scripts_txt2img\n if not script_runner.scripts:\n script_runner.initialize_scripts(False)\n ui.create_ui()\n if not self.default_script_arg_txt2img:\n self.default_script_arg_txt2img = self.init_default_script_args(script_runner)\n selectable_scripts, selectable_script_idx = self.get_selectable_script(txt2imgreq.script_name, script_runner)\n\n populate = txt2imgreq.copy(update={ # Override __init__ params\n \"sampler_name\": validate_sampler_name(txt2imgreq.sampler_name or txt2imgreq.sampler_index),\n \"do_not_save_samples\": not txt2imgreq.save_images,\n \"do_not_save_grid\": not txt2imgreq.save_images,\n })\n if populate.sampler_name:\n populate.sampler_index = None # prevent a warning later on\n\n args = vars(populate)\n args.pop('script_name', None)\n args.pop('script_args', None) # will refeed them to the pipeline directly after initializing them\n args.pop('alwayson_scripts', None)\n\n script_args = self.init_script_args(txt2imgreq, self.default_script_arg_txt2img, selectable_scripts, selectable_script_idx, script_runner)\n\n send_images = args.pop('send_images', True)\n args.pop('save_images', None)\n\n with self.queue_lock:\n p = StableDiffusionProcessingTxt2Img(sd_model=shared.sd_model, **args)\n p.scripts = script_runner\n p.outpath_grids = opts.outdir_txt2img_grids\n p.outpath_samples = opts.outdir_txt2img_samples\n\n shared.state.begin()\n if selectable_scripts != None:\n p.script_args = script_args\n processed = scripts.scripts_txt2img.run(p, *p.script_args) # Need to pass args as list here\n else:\n p.script_args = tuple(script_args) # Need to pass args as tuple here\n processed = process_images(p)\n shared.state.end()\n\n b64images = list(map(encode_pil_to_base64, processed.images)) if send_images else []\n\n return TextToImageResponse(images=b64images, parameters=vars(txt2imgreq), info=processed.js())\n\n def img2imgapi(self, img2imgreq: StableDiffusionImg2ImgProcessingAPI):\n init_images = img2imgreq.init_images\n if init_images is None:\n raise HTTPException(status_code=404, detail=\"Init image not found\")\n\n mask = img2imgreq.mask\n if mask:\n mask = decode_base64_to_image(mask)\n\n script_runner = scripts.scripts_img2img\n if not script_runner.scripts:\n script_runner.initialize_scripts(True)\n ui.create_ui()\n if not self.default_script_arg_img2img:\n self.default_script_arg_img2img = self.init_default_script_args(script_runner)\n selectable_scripts, selectable_script_idx = self.get_selectable_script(img2imgreq.script_name, script_runner)\n\n populate = img2imgreq.copy(update={ # Override __init__ params\n \"sampler_name\": validate_sampler_name(img2imgreq.sampler_name or img2imgreq.sampler_index),\n \"do_not_save_samples\": not img2imgreq.save_images,\n \"do_not_save_grid\": not img2imgreq.save_images,\n \"mask\": mask,\n })\n if populate.sampler_name:\n populate.sampler_index = None # prevent a warning later on\n\n args = vars(populate)\n args.pop('include_init_images', None) # this is meant to be done by \"exclude\": True in model, but it's for a reason that I cannot determine.\n args.pop('script_name', None)\n args.pop('script_args', None) # will refeed them to the pipeline directly after initializing them\n args.pop('alwayson_scripts', None)\n\n script_args = self.init_script_args(img2imgreq, self.default_script_arg_img2img, selectable_scripts, selectable_script_idx, script_runner)\n\n send_images = args.pop('send_images', True)\n args.pop('save_images', None)\n\n with self.queue_lock:\n p = StableDiffusionProcessingImg2Img(sd_model=shared.sd_model, **args)\n p.init_images = [decode_base64_to_image(x) for x in init_images]\n p.scripts = script_runner\n p.outpath_grids = opts.outdir_img2img_grids\n p.outpath_samples = opts.outdir_img2img_samples\n\n shared.state.begin()\n if selectable_scripts != None:\n p.script_args = script_args\n processed = scripts.scripts_img2img.run(p, *p.script_args) # Need to pass args as list here\n else:\n p.script_args = tuple(script_args) # Need to pass args as tuple here\n processed = process_images(p)\n shared.state.end()\n\n b64images = list(map(encode_pil_to_base64, processed.images)) if send_images else []\n\n if not img2imgreq.include_init_images:\n img2imgreq.init_images = None\n img2imgreq.mask = None\n\n return ImageToImageResponse(images=b64images, parameters=vars(img2imgreq), info=processed.js())\n\n def extras_single_image_api(self, req: ExtrasSingleImageRequest):\n reqDict = setUpscalers(req)\n\n reqDict['image'] = decode_base64_to_image(reqDict['image'])\n\n with self.queue_lock:\n result = postprocessing.run_extras(extras_mode=0, image_folder=\"\", input_dir=\"\", output_dir=\"\", save_output=False, **reqDict)\n\n return ExtrasSingleImageResponse(image=encode_pil_to_base64(result[0][0]), html_info=result[1])\n\n def extras_batch_images_api(self, req: ExtrasBatchImagesRequest):\n reqDict = setUpscalers(req)\n\n image_list = reqDict.pop('imageList', [])\n image_folder = [decode_base64_to_image(x.data) for x in image_list]\n\n with self.queue_lock:\n result = postprocessing.run_extras(extras_mode=1, image_folder=image_folder, image=\"\", input_dir=\"\", output_dir=\"\", save_output=False, **reqDict)\n\n return ExtrasBatchImagesResponse(images=list(map(encode_pil_to_base64, result[0])), html_info=result[1])\n\n def pnginfoapi(self, req: PNGInfoRequest):\n if(not req.image.strip()):\n return PNGInfoResponse(info=\"\")\n\n image = decode_base64_to_image(req.image.strip())\n if image is None:\n return PNGInfoResponse(info=\"\")\n\n geninfo, items = images.read_info_from_image(image)\n if geninfo is None:\n geninfo = \"\"\n\n items = {**{'parameters': geninfo}, **items}\n\n return PNGInfoResponse(info=geninfo, items=items)\n\n def progressapi(self, req: ProgressRequest = Depends()):\n # copy from check_progress_call of ui.py\n\n if shared.state.job_count == 0:\n return ProgressResponse(progress=0, eta_relative=0, state=shared.state.dict(), textinfo=shared.state.textinfo)\n\n # avoid dividing zero\n progress = 0.01\n\n if shared.state.job_count > 0:\n progress += shared.state.job_no / shared.state.job_count\n if shared.state.sampling_steps > 0:\n progress += 1 / shared.state.job_count * shared.state.sampling_step / shared.state.sampling_steps\n\n time_since_start = time.time() - shared.state.time_start\n eta = (time_since_start/progress)\n eta_relative = eta-time_since_start\n\n progress = min(progress, 1)\n\n shared.state.set_current_image()\n\n current_image = None\n if shared.state.current_image and not req.skip_current_image:\n current_image = encode_pil_to_base64(shared.state.current_image)\n\n return ProgressResponse(progress=progress, eta_relative=eta_relative, state=shared.state.dict(), current_image=current_image, textinfo=shared.state.textinfo)\n\n def interrogateapi(self, interrogatereq: InterrogateRequest):\n image_b64 = interrogatereq.image\n if image_b64 is None:\n raise HTTPException(status_code=404, detail=\"Image not found\")\n\n img = decode_base64_to_image(image_b64)\n img = img.convert('RGB')\n\n # Override object param\n with self.queue_lock:\n if interrogatereq.model == \"clip\":\n processed = shared.interrogator.interrogate(img)\n elif interrogatereq.model == \"deepdanbooru\":\n processed = deepbooru.model.tag(img)\n else:\n raise HTTPException(status_code=404, detail=\"Model not found\")\n\n return InterrogateResponse(caption=processed)\n\n def interruptapi(self):\n shared.state.interrupt()\n\n return {}\n\n def unloadapi(self):\n unload_model_weights()\n\n return {}\n\n def reloadapi(self):\n reload_model_weights()\n\n return {}\n\n def skip(self):\n shared.state.skip()\n\n def get_config(self):\n options = {}\n for key in shared.opts.data.keys():\n metadata = shared.opts.data_labels.get(key)\n if(metadata is not None):\n options.update({key: shared.opts.data.get(key, shared.opts.data_labels.get(key).default)})\n else:\n options.update({key: shared.opts.data.get(key, None)})\n\n return options\n\n def set_config(self, req: Dict[str, Any]):\n for k, v in req.items():\n shared.opts.set(k, v)\n\n shared.opts.save(shared.config_filename)\n return\n\n def get_cmd_flags(self):\n return vars(shared.cmd_opts)\n\n def get_samplers(self):\n return [{\"name\": sampler[0], \"aliases\":sampler[2], \"options\":sampler[3]} for sampler in sd_samplers.all_samplers]\n\n def get_upscalers(self):\n return [\n {\n \"name\": upscaler.name,\n \"model_name\": upscaler.scaler.model_name,\n \"model_path\": upscaler.data_path,\n \"model_url\": None,\n \"scale\": upscaler.scale,\n }\n for upscaler in shared.sd_upscalers\n ]\n\n def get_sd_models(self):\n return [{\"title\": x.title, \"model_name\": x.model_name, \"hash\": x.shorthash, \"sha256\": x.sha256, \"filename\": x.filename, \"config\": find_checkpoint_config_near_filename(x)} for x in checkpoints_list.values()]\n\n def get_hypernetworks(self):\n return [{\"name\": name, \"path\": shared.hypernetworks[name]} for name in shared.hypernetworks]\n\n def get_face_restorers(self):\n return [{\"name\":x.name(), \"cmd_dir\": getattr(x, \"cmd_dir\", None)} for x in shared.face_restorers]\n\n def get_realesrgan_models(self):\n return [{\"name\":x.name,\"path\":x.data_path, \"scale\":x.scale} for x in get_realesrgan_models(None)]\n\n def get_prompt_styles(self):\n styleList = []\n for k in shared.prompt_styles.styles:\n style = shared.prompt_styles.styles[k]\n styleList.append({\"name\":style[0], \"prompt\": style[1], \"negative_prompt\": style[2]})\n\n return styleList\n\n def get_embeddings(self):\n db = sd_hijack.model_hijack.embedding_db\n\n def convert_embedding(embedding):\n return {\n \"step\": embedding.step,\n \"sd_checkpoint\": embedding.sd_checkpoint,\n \"sd_checkpoint_name\": embedding.sd_checkpoint_name,\n \"shape\": embedding.shape,\n \"vectors\": embedding.vectors,\n }\n\n def convert_embeddings(embeddings):\n return {embedding.name: convert_embedding(embedding) for embedding in embeddings.values()}\n\n return {\n \"loaded\": convert_embeddings(db.word_embeddings),\n \"skipped\": convert_embeddings(db.skipped_embeddings),\n }\n\n def refresh_checkpoints(self):\n shared.refresh_checkpoints()\n\n def create_embedding(self, args: dict):\n try:\n shared.state.begin()\n filename = create_embedding(**args) # create empty embedding\n sd_hijack.model_hijack.embedding_db.load_textual_inversion_embeddings() # reload embeddings so new one can be immediately used\n shared.state.end()\n return CreateResponse(info=f\"create embedding filename: {filename}\")\n except AssertionError as e:\n shared.state.end()\n return TrainResponse(info=f\"create embedding error: {e}\")\n\n def create_hypernetwork(self, args: dict):\n try:\n shared.state.begin()\n filename = create_hypernetwork(**args) # create empty embedding\n shared.state.end()\n return CreateResponse(info=f\"create hypernetwork filename: {filename}\")\n except AssertionError as e:\n shared.state.end()\n return TrainResponse(info=f\"create hypernetwork error: {e}\")\n\n def preprocess(self, args: dict):\n try:\n shared.state.begin()\n preprocess(**args) # quick operation unless blip/booru interrogation is enabled\n shared.state.end()\n return PreprocessResponse(info = 'preprocess complete')\n except KeyError as e:\n shared.state.end()\n return PreprocessResponse(info=f\"preprocess error: invalid token: {e}\")\n except AssertionError as e:\n shared.state.end()\n return PreprocessResponse(info=f\"preprocess error: {e}\")\n except FileNotFoundError as e:\n shared.state.end()\n return PreprocessResponse(info=f'preprocess error: {e}')\n\n def train_embedding(self, args: dict):\n try:\n shared.state.begin()\n apply_optimizations = shared.opts.training_xattention_optimizations\n error = None\n filename = ''\n if not apply_optimizations:\n sd_hijack.undo_optimizations()\n try:\n embedding, filename = train_embedding(**args) # can take a long time to complete\n except Exception as e:\n error = e\n finally:\n if not apply_optimizations:\n sd_hijack.apply_optimizations()\n shared.state.end()\n return TrainResponse(info=f\"train embedding complete: filename: {filename} error: {error}\")\n except AssertionError as msg:\n shared.state.end()\n return TrainResponse(info=f\"train embedding error: {msg}\")\n\n def train_hypernetwork(self, args: dict):\n try:\n shared.state.begin()\n shared.loaded_hypernetworks = []\n apply_optimizations = shared.opts.training_xattention_optimizations\n error = None\n filename = ''\n if not apply_optimizations:\n sd_hijack.undo_optimizations()\n try:\n hypernetwork, filename = train_hypernetwork(**args)\n except Exception as e:\n error = e\n finally:\n shared.sd_model.cond_stage_model.to(devices.device)\n shared.sd_model.first_stage_model.to(devices.device)\n if not apply_optimizations:\n sd_hijack.apply_optimizations()\n shared.state.end()\n return TrainResponse(info=f\"train embedding complete: filename: {filename} error: {error}\")\n except AssertionError as msg:\n shared.state.end()\n return TrainResponse(info=f\"train embedding error: {error}\")\n\n def get_memory(self):\n try:\n import os, psutil\n process = psutil.Process(os.getpid())\n res = process.memory_info() # only rss is cross-platform guaranteed so we dont rely on other values\n ram_total = 100 * res.rss / process.memory_percent() # and total memory is calculated as actual value is not cross-platform safe\n ram = { 'free': ram_total - res.rss, 'used': res.rss, 'total': ram_total }\n except Exception as err:\n ram = { 'error': f'{err}' }\n try:\n import torch\n if torch.cuda.is_available():\n s = torch.cuda.mem_get_info()\n system = { 'free': s[0], 'used': s[1] - s[0], 'total': s[1] }\n s = dict(torch.cuda.memory_stats(shared.device))\n allocated = { 'current': s['allocated_bytes.all.current'], 'peak': s['allocated_bytes.all.peak'] }\n reserved = { 'current': s['reserved_bytes.all.current'], 'peak': s['reserved_bytes.all.peak'] }\n active = { 'current': s['active_bytes.all.current'], 'peak': s['active_bytes.all.peak'] }\n inactive = { 'current': s['inactive_split_bytes.all.current'], 'peak': s['inactive_split_bytes.all.peak'] }\n warnings = { 'retries': s['num_alloc_retries'], 'oom': s['num_ooms'] }\n cuda = {\n 'system': system,\n 'active': active,\n 'allocated': allocated,\n 'reserved': reserved,\n 'inactive': inactive,\n 'events': warnings,\n }\n else:\n cuda = { 'error': 'unavailable' }\n except Exception as err:\n cuda = { 'error': f'{err}' }\n return MemoryResponse(ram = ram, cuda = cuda)\n\n def launch(self, server_name, port):\n self.app.include_router(self.router)\n uvicorn.run(self.app, host=server_name, port=port, timeout_keep_alive=0)\n", "path": "modules/api/api.py"}]} |
gh_patches_debug_210 | rasdani/github-patches | git_diff | sunpy__sunpy-2906 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Pip installing sunpy dev fails
With `ci-helpers` I run into this issue for both travis/linux and appveyor:
Please have a look and open a PR in `ci-helpers` with the suggested fix for the case of `SUNPY_VERSION='dev'`
```
+++++python -m pip install git+https://github.com/sunpy/sunpy.git#egg=sunpy --upgrade --no-deps
Collecting sunpy from git+https://github.com/sunpy/sunpy.git#egg=sunpy
Cloning https://github.com/sunpy/sunpy.git to /tmp/pip-install-uowizwdl/sunpy
Installing build dependencies ... done
Getting requirements to build wheel ... error
Complete output from command /home/travis/miniconda/envs/test/bin/python /home/travis/miniconda/envs/test/lib/python3.6/site-packages/pip/_vendor/pep517/_in_process.py get_requires_for_build_wheel /tmp/tmp6h0521mp:
Traceback (most recent call last):
File "/home/travis/miniconda/envs/test/lib/python3.6/site-packages/pip/_vendor/pep517/_in_process.py", line 207, in <module>
main()
File "/home/travis/miniconda/envs/test/lib/python3.6/site-packages/pip/_vendor/pep517/_in_process.py", line 197, in main
json_out['return_val'] = hook(**hook_input['kwargs'])
File "/home/travis/miniconda/envs/test/lib/python3.6/site-packages/pip/_vendor/pep517/_in_process.py", line 54, in get_requires_for_build_wheel
return hook(config_settings)
File "/tmp/pip-build-env-3jro2te9/overlay/lib/python3.6/site-packages/setuptools/build_meta.py", line 115, in get_requires_for_build_wheel
return _get_build_requires(config_settings, requirements=['wheel'])
File "/tmp/pip-build-env-3jro2te9/overlay/lib/python3.6/site-packages/setuptools/build_meta.py", line 101, in _get_build_requires
_run_setup()
File "/tmp/pip-build-env-3jro2te9/overlay/lib/python3.6/site-packages/setuptools/build_meta.py", line 85, in _run_setup
exec(compile(code, __file__, 'exec'), locals())
File "setup.py", line 46, in <module>
import ah_bootstrap # noqa
ModuleNotFoundError: No module named 'ah_bootstrap'
```
--- 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 # This file is based havily on the astropy version here:
3 # https://github.com/astropy/package-template/blob/master/setup.py
4 # Which is licensed under the astropy license, see licenses/ASTROPY.rst.
5
6 ################################################################################
7 ###### YOU SHOULD NOT HAVE TO EDIT THIS FILE, YOU SHOULD EDIT setup.cfg. #######
8 ################################################################################
9 # Note: This file needs to be Python 2 / <3.6 compatible, so that the nice
10 # "SunPy only supports Python 3.6+" error prints without syntax errors etc.
11
12 import os
13 import sys
14 import glob
15 import builtins # noqa
16 import itertools
17
18 try:
19 from configparser import ConfigParser
20 except ImportError:
21 from ConfigParser import ConfigParser
22
23 # Get some values from the setup.cfg
24 conf = ConfigParser()
25 conf.read(['setup.cfg'])
26 metadata = dict(conf.items('metadata'))
27
28 PACKAGENAME = metadata.get('package_name', 'sunpy')
29 DESCRIPTION = metadata.get('description', 'SunPy: Python for Solar Physics')
30 AUTHOR = metadata.get('author', 'The SunPy Community')
31 AUTHOR_EMAIL = metadata.get('author_email', '')
32 LICENSE = metadata.get('license', 'unknown')
33 URL = metadata.get('url', 'https://sunpy.org')
34 __minimum_python_version__ = metadata.get("minimum_python_version", "3.6")
35
36 # Enforce Python version check - this is the same check as in __init__.py but
37 # this one has to happen before importing ah_bootstrap.
38 if sys.version_info < tuple((int(val) for val in __minimum_python_version__.split('.'))):
39 sys.stderr.write("ERROR: SunPy requires Python {} or later\n".format(__minimum_python_version__))
40 sys.exit(1)
41
42 with open(os.path.join(os.path.abspath(os.path.dirname(__file__)), 'README.rst'), encoding='utf-8') as f:
43 LONG_DESCRIPTION = f.read()
44
45 # Import ah_bootstrap after the python version validation
46 import ah_bootstrap # noqa
47 from setuptools import setup # noqa
48 from astropy_helpers.git_helpers import get_git_devstr # noqa
49 from astropy_helpers.setup_helpers import get_package_info # noqa
50 from astropy_helpers.setup_helpers import get_debug_option, register_commands
51 from astropy_helpers.version_helpers import generate_version_py # noqa
52
53 builtins._SUNPY_SETUP_ = True
54
55
56 # -- Read the Docs Setup -----------------------------------------------------
57
58 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
59
60 if on_rtd:
61 os.environ['HOME'] = '/home/docs/'
62 os.environ['SUNPY_CONFIGDIR'] = '/home/docs/'
63
64 # Store the package name in a built-in variable so it's easy
65 # to get from other parts of the setup infrastructure
66 # This is used by get_pkg_data in astropy amongst other things
67 builtins._ASTROPY_PACKAGE_NAME_ = PACKAGENAME
68
69 # VERSION should be PEP440 compatible (http://www.python.org/dev/peps/pep-0440)
70 VERSION = metadata.get('version', '0.0.dev0')
71
72 # Indicates if this version is a release version
73 RELEASE = 'dev' not in VERSION
74
75 if not RELEASE:
76 VERSION += get_git_devstr(False)
77
78 # Populate the dict of setup command overrides; this should be done before
79 # invoking any other functionality from distutils since it can potentially
80 # modify distutils' behaviour.
81 cmdclassd = register_commands(PACKAGENAME, VERSION, RELEASE)
82
83 try:
84 from sunpy.tests.setup_command import SunPyTest
85 # Overwrite the Astropy Testing framework
86 cmdclassd['test'] = type('SunPyTest', (SunPyTest,),
87 {'package_name': 'sunpy'})
88
89 except Exception:
90 # Catch everything, if it doesn't work, we still want SunPy to install.
91 pass
92
93 # Freeze build information in version.py
94 generate_version_py(PACKAGENAME, VERSION, RELEASE,
95 get_debug_option(PACKAGENAME))
96
97 # Treat everything in scripts except README* as a script to be installed
98 scripts = [fname for fname in glob.glob(os.path.join('scripts', '*'))
99 if not os.path.basename(fname).startswith('README')]
100
101
102 # Get configuration information from all of the various subpackages.
103 # See the docstring for setup_helpers.update_package_files for more
104 # details.
105 package_info = get_package_info()
106
107 # Add the project-global data
108 package_info['package_data'].setdefault(PACKAGENAME, [])
109 package_info['package_data'][PACKAGENAME].append('data/*')
110
111 # Define entry points for command-line scripts
112 entry_points = {'console_scripts': []}
113
114 if conf.has_section('entry_points'):
115 entry_point_list = conf.items('entry_points')
116 for entry_point in entry_point_list:
117 entry_points['console_scripts'].append('{0} = {1}'.format(
118 entry_point[0], entry_point[1]))
119
120 # Include all .c files, recursively, including those generated by
121 # Cython, since we can not do this in MANIFEST.in with a "dynamic"
122 # directory name.
123 c_files = []
124 for root, dirs, files in os.walk(PACKAGENAME):
125 for filename in files:
126 if filename.endswith('.c'):
127 c_files.append(
128 os.path.join(
129 os.path.relpath(root, PACKAGENAME), filename))
130 package_info['package_data'][PACKAGENAME].extend(c_files)
131
132
133 extra_tags = [m.strip() for m in metadata.get("extra_requires", "").split(',')]
134 if extra_tags:
135 extras_require = {tag: [m.strip() for m in metadata["{tag}_requires".format(tag=tag)].split(',')]
136 for tag in extra_tags}
137 extras_require['all'] = list(itertools.chain.from_iterable(extras_require.values()))
138 else:
139 extras_require = None
140
141 # Entry points
142 entry_points['asdf_extensions'] = [
143 'sunpy = sunpy.io.special.asdf.extension:SunpyExtension',
144 ]
145
146 setup(name=PACKAGENAME,
147 version=VERSION,
148 description=DESCRIPTION,
149 scripts=scripts,
150 setup_requires=[s.strip() for s in metadata.get("setup_requires", "").split(',')],
151 install_requires=[s.strip() for s in metadata['install_requires'].split(',')],
152 extras_require=extras_require,
153 tests_require=extras_require.get("all", ""),
154 author=AUTHOR,
155 author_email=AUTHOR_EMAIL,
156 license=LICENSE,
157 url=URL,
158 project_urls={'Funding': 'https://www.flipcause.com/widget/widget_home/MTgxMTU=',
159 'Source': 'https://github.com/sunpy/sunpy/',
160 'Tracker': 'https://github.com/sunpy/sunpy/issues'
161 },
162 long_description=LONG_DESCRIPTION,
163 long_description_content_type='text/x-rst',
164 cmdclass=cmdclassd,
165 zip_safe=False,
166 entry_points=entry_points,
167 python_requires='>={}'.format(__minimum_python_version__),
168 include_package_data=True,
169 **package_info
170 )
171
```
--- 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
@@ -15,6 +15,9 @@
import builtins # noqa
import itertools
+# Fix for https://github.com/pypa/pip/issues/6163
+sys.path.insert(0, os.path.dirname(__file__))
+
try:
from configparser import ConfigParser
except ImportError:
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -15,6 +15,9 @@\n import builtins # noqa\n import itertools\n \n+# Fix for https://github.com/pypa/pip/issues/6163\n+sys.path.insert(0, os.path.dirname(__file__))\n+\n try:\n from configparser import ConfigParser\n except ImportError:\n", "issue": "Pip installing sunpy dev fails\nWith `ci-helpers` I run into this issue for both travis/linux and appveyor:\r\n\r\nPlease have a look and open a PR in `ci-helpers` with the suggested fix for the case of `SUNPY_VERSION='dev'`\r\n\r\n```\r\n+++++python -m pip install git+https://github.com/sunpy/sunpy.git#egg=sunpy --upgrade --no-deps\r\nCollecting sunpy from git+https://github.com/sunpy/sunpy.git#egg=sunpy\r\n Cloning https://github.com/sunpy/sunpy.git to /tmp/pip-install-uowizwdl/sunpy\r\n Installing build dependencies ... done\r\n Getting requirements to build wheel ... error\r\n Complete output from command /home/travis/miniconda/envs/test/bin/python /home/travis/miniconda/envs/test/lib/python3.6/site-packages/pip/_vendor/pep517/_in_process.py get_requires_for_build_wheel /tmp/tmp6h0521mp:\r\n Traceback (most recent call last):\r\n File \"/home/travis/miniconda/envs/test/lib/python3.6/site-packages/pip/_vendor/pep517/_in_process.py\", line 207, in <module>\r\n main()\r\n File \"/home/travis/miniconda/envs/test/lib/python3.6/site-packages/pip/_vendor/pep517/_in_process.py\", line 197, in main\r\n json_out['return_val'] = hook(**hook_input['kwargs'])\r\n File \"/home/travis/miniconda/envs/test/lib/python3.6/site-packages/pip/_vendor/pep517/_in_process.py\", line 54, in get_requires_for_build_wheel\r\n return hook(config_settings)\r\n File \"/tmp/pip-build-env-3jro2te9/overlay/lib/python3.6/site-packages/setuptools/build_meta.py\", line 115, in get_requires_for_build_wheel\r\n return _get_build_requires(config_settings, requirements=['wheel'])\r\n File \"/tmp/pip-build-env-3jro2te9/overlay/lib/python3.6/site-packages/setuptools/build_meta.py\", line 101, in _get_build_requires\r\n _run_setup()\r\n File \"/tmp/pip-build-env-3jro2te9/overlay/lib/python3.6/site-packages/setuptools/build_meta.py\", line 85, in _run_setup\r\n exec(compile(code, __file__, 'exec'), locals())\r\n File \"setup.py\", line 46, in <module>\r\n import ah_bootstrap # noqa\r\n ModuleNotFoundError: No module named 'ah_bootstrap'\r\n```\n", "before_files": [{"content": "#!/usr/bin/env python\n# This file is based havily on the astropy version here:\n# https://github.com/astropy/package-template/blob/master/setup.py\n# Which is licensed under the astropy license, see licenses/ASTROPY.rst.\n\n################################################################################\n###### YOU SHOULD NOT HAVE TO EDIT THIS FILE, YOU SHOULD EDIT setup.cfg. #######\n################################################################################\n# Note: This file needs to be Python 2 / <3.6 compatible, so that the nice\n# \"SunPy only supports Python 3.6+\" error prints without syntax errors etc.\n\nimport os\nimport sys\nimport glob\nimport builtins # noqa\nimport itertools\n\ntry:\n from configparser import ConfigParser\nexcept ImportError:\n from ConfigParser import ConfigParser\n\n# Get some values from the setup.cfg\nconf = ConfigParser()\nconf.read(['setup.cfg'])\nmetadata = dict(conf.items('metadata'))\n\nPACKAGENAME = metadata.get('package_name', 'sunpy')\nDESCRIPTION = metadata.get('description', 'SunPy: Python for Solar Physics')\nAUTHOR = metadata.get('author', 'The SunPy Community')\nAUTHOR_EMAIL = metadata.get('author_email', '')\nLICENSE = metadata.get('license', 'unknown')\nURL = metadata.get('url', 'https://sunpy.org')\n__minimum_python_version__ = metadata.get(\"minimum_python_version\", \"3.6\")\n\n# Enforce Python version check - this is the same check as in __init__.py but\n# this one has to happen before importing ah_bootstrap.\nif sys.version_info < tuple((int(val) for val in __minimum_python_version__.split('.'))):\n sys.stderr.write(\"ERROR: SunPy requires Python {} or later\\n\".format(__minimum_python_version__))\n sys.exit(1)\n\nwith open(os.path.join(os.path.abspath(os.path.dirname(__file__)), 'README.rst'), encoding='utf-8') as f:\n LONG_DESCRIPTION = f.read()\n\n# Import ah_bootstrap after the python version validation\nimport ah_bootstrap # noqa\nfrom setuptools import setup # noqa\nfrom astropy_helpers.git_helpers import get_git_devstr # noqa\nfrom astropy_helpers.setup_helpers import get_package_info # noqa\nfrom astropy_helpers.setup_helpers import get_debug_option, register_commands\nfrom astropy_helpers.version_helpers import generate_version_py # noqa\n\nbuiltins._SUNPY_SETUP_ = True\n\n\n# -- Read the Docs Setup -----------------------------------------------------\n\non_rtd = os.environ.get('READTHEDOCS', None) == 'True'\n\nif on_rtd:\n os.environ['HOME'] = '/home/docs/'\n os.environ['SUNPY_CONFIGDIR'] = '/home/docs/'\n\n# Store the package name in a built-in variable so it's easy\n# to get from other parts of the setup infrastructure\n# This is used by get_pkg_data in astropy amongst other things\nbuiltins._ASTROPY_PACKAGE_NAME_ = PACKAGENAME\n\n# VERSION should be PEP440 compatible (http://www.python.org/dev/peps/pep-0440)\nVERSION = metadata.get('version', '0.0.dev0')\n\n# Indicates if this version is a release version\nRELEASE = 'dev' not in VERSION\n\nif not RELEASE:\n VERSION += get_git_devstr(False)\n\n# Populate the dict of setup command overrides; this should be done before\n# invoking any other functionality from distutils since it can potentially\n# modify distutils' behaviour.\ncmdclassd = register_commands(PACKAGENAME, VERSION, RELEASE)\n\ntry:\n from sunpy.tests.setup_command import SunPyTest\n # Overwrite the Astropy Testing framework\n cmdclassd['test'] = type('SunPyTest', (SunPyTest,),\n {'package_name': 'sunpy'})\n\nexcept Exception:\n # Catch everything, if it doesn't work, we still want SunPy to install.\n pass\n\n# Freeze build information in version.py\ngenerate_version_py(PACKAGENAME, VERSION, RELEASE,\n get_debug_option(PACKAGENAME))\n\n# Treat everything in scripts except README* as a script to be installed\nscripts = [fname for fname in glob.glob(os.path.join('scripts', '*'))\n if not os.path.basename(fname).startswith('README')]\n\n\n# Get configuration information from all of the various subpackages.\n# See the docstring for setup_helpers.update_package_files for more\n# details.\npackage_info = get_package_info()\n\n# Add the project-global data\npackage_info['package_data'].setdefault(PACKAGENAME, [])\npackage_info['package_data'][PACKAGENAME].append('data/*')\n\n# Define entry points for command-line scripts\nentry_points = {'console_scripts': []}\n\nif conf.has_section('entry_points'):\n entry_point_list = conf.items('entry_points')\n for entry_point in entry_point_list:\n entry_points['console_scripts'].append('{0} = {1}'.format(\n entry_point[0], entry_point[1]))\n\n# Include all .c files, recursively, including those generated by\n# Cython, since we can not do this in MANIFEST.in with a \"dynamic\"\n# directory name.\nc_files = []\nfor root, dirs, files in os.walk(PACKAGENAME):\n for filename in files:\n if filename.endswith('.c'):\n c_files.append(\n os.path.join(\n os.path.relpath(root, PACKAGENAME), filename))\npackage_info['package_data'][PACKAGENAME].extend(c_files)\n\n\nextra_tags = [m.strip() for m in metadata.get(\"extra_requires\", \"\").split(',')]\nif extra_tags:\n extras_require = {tag: [m.strip() for m in metadata[\"{tag}_requires\".format(tag=tag)].split(',')]\n for tag in extra_tags}\n extras_require['all'] = list(itertools.chain.from_iterable(extras_require.values()))\nelse:\n extras_require = None\n\n# Entry points\nentry_points['asdf_extensions'] = [\n 'sunpy = sunpy.io.special.asdf.extension:SunpyExtension',\n]\n\nsetup(name=PACKAGENAME,\n version=VERSION,\n description=DESCRIPTION,\n scripts=scripts,\n setup_requires=[s.strip() for s in metadata.get(\"setup_requires\", \"\").split(',')],\n install_requires=[s.strip() for s in metadata['install_requires'].split(',')],\n extras_require=extras_require,\n tests_require=extras_require.get(\"all\", \"\"),\n author=AUTHOR,\n author_email=AUTHOR_EMAIL,\n license=LICENSE,\n url=URL,\n project_urls={'Funding': 'https://www.flipcause.com/widget/widget_home/MTgxMTU=',\n 'Source': 'https://github.com/sunpy/sunpy/',\n 'Tracker': 'https://github.com/sunpy/sunpy/issues'\n },\n long_description=LONG_DESCRIPTION,\n long_description_content_type='text/x-rst',\n cmdclass=cmdclassd,\n zip_safe=False,\n entry_points=entry_points,\n python_requires='>={}'.format(__minimum_python_version__),\n include_package_data=True,\n **package_info\n )\n", "path": "setup.py"}], "after_files": [{"content": "#!/usr/bin/env python\n# This file is based havily on the astropy version here:\n# https://github.com/astropy/package-template/blob/master/setup.py\n# Which is licensed under the astropy license, see licenses/ASTROPY.rst.\n\n################################################################################\n###### YOU SHOULD NOT HAVE TO EDIT THIS FILE, YOU SHOULD EDIT setup.cfg. #######\n################################################################################\n# Note: This file needs to be Python 2 / <3.6 compatible, so that the nice\n# \"SunPy only supports Python 3.6+\" error prints without syntax errors etc.\n\nimport os\nimport sys\nimport glob\nimport builtins # noqa\nimport itertools\n\n# Fix for https://github.com/pypa/pip/issues/6163\nsys.path.insert(0, os.path.dirname(__file__))\n\ntry:\n from configparser import ConfigParser\nexcept ImportError:\n from ConfigParser import ConfigParser\n\n# Get some values from the setup.cfg\nconf = ConfigParser()\nconf.read(['setup.cfg'])\nmetadata = dict(conf.items('metadata'))\n\nPACKAGENAME = metadata.get('package_name', 'sunpy')\nDESCRIPTION = metadata.get('description', 'SunPy: Python for Solar Physics')\nAUTHOR = metadata.get('author', 'The SunPy Community')\nAUTHOR_EMAIL = metadata.get('author_email', '')\nLICENSE = metadata.get('license', 'unknown')\nURL = metadata.get('url', 'https://sunpy.org')\n__minimum_python_version__ = metadata.get(\"minimum_python_version\", \"3.6\")\n\n# Enforce Python version check - this is the same check as in __init__.py but\n# this one has to happen before importing ah_bootstrap.\nif sys.version_info < tuple((int(val) for val in __minimum_python_version__.split('.'))):\n sys.stderr.write(\"ERROR: SunPy requires Python {} or later\\n\".format(__minimum_python_version__))\n sys.exit(1)\n\nwith open(os.path.join(os.path.abspath(os.path.dirname(__file__)), 'README.rst'), encoding='utf-8') as f:\n LONG_DESCRIPTION = f.read()\n\n# Import ah_bootstrap after the python version validation\nimport ah_bootstrap # noqa\nfrom setuptools import setup # noqa\nfrom astropy_helpers.git_helpers import get_git_devstr # noqa\nfrom astropy_helpers.setup_helpers import get_package_info # noqa\nfrom astropy_helpers.setup_helpers import get_debug_option, register_commands\nfrom astropy_helpers.version_helpers import generate_version_py # noqa\n\nbuiltins._SUNPY_SETUP_ = True\n\n\n# -- Read the Docs Setup -----------------------------------------------------\n\non_rtd = os.environ.get('READTHEDOCS', None) == 'True'\n\nif on_rtd:\n os.environ['HOME'] = '/home/docs/'\n os.environ['SUNPY_CONFIGDIR'] = '/home/docs/'\n\n# Store the package name in a built-in variable so it's easy\n# to get from other parts of the setup infrastructure\n# This is used by get_pkg_data in astropy amongst other things\nbuiltins._ASTROPY_PACKAGE_NAME_ = PACKAGENAME\n\n# VERSION should be PEP440 compatible (http://www.python.org/dev/peps/pep-0440)\nVERSION = metadata.get('version', '0.0.dev0')\n\n# Indicates if this version is a release version\nRELEASE = 'dev' not in VERSION\n\nif not RELEASE:\n VERSION += get_git_devstr(False)\n\n# Populate the dict of setup command overrides; this should be done before\n# invoking any other functionality from distutils since it can potentially\n# modify distutils' behaviour.\ncmdclassd = register_commands(PACKAGENAME, VERSION, RELEASE)\n\ntry:\n from sunpy.tests.setup_command import SunPyTest\n # Overwrite the Astropy Testing framework\n cmdclassd['test'] = type('SunPyTest', (SunPyTest,),\n {'package_name': 'sunpy'})\n\nexcept Exception:\n # Catch everything, if it doesn't work, we still want SunPy to install.\n pass\n\n# Freeze build information in version.py\ngenerate_version_py(PACKAGENAME, VERSION, RELEASE,\n get_debug_option(PACKAGENAME))\n\n# Treat everything in scripts except README* as a script to be installed\nscripts = [fname for fname in glob.glob(os.path.join('scripts', '*'))\n if not os.path.basename(fname).startswith('README')]\n\n\n# Get configuration information from all of the various subpackages.\n# See the docstring for setup_helpers.update_package_files for more\n# details.\npackage_info = get_package_info()\n\n# Add the project-global data\npackage_info['package_data'].setdefault(PACKAGENAME, [])\npackage_info['package_data'][PACKAGENAME].append('data/*')\n\n# Define entry points for command-line scripts\nentry_points = {'console_scripts': []}\n\nif conf.has_section('entry_points'):\n entry_point_list = conf.items('entry_points')\n for entry_point in entry_point_list:\n entry_points['console_scripts'].append('{0} = {1}'.format(\n entry_point[0], entry_point[1]))\n\n# Include all .c files, recursively, including those generated by\n# Cython, since we can not do this in MANIFEST.in with a \"dynamic\"\n# directory name.\nc_files = []\nfor root, dirs, files in os.walk(PACKAGENAME):\n for filename in files:\n if filename.endswith('.c'):\n c_files.append(\n os.path.join(\n os.path.relpath(root, PACKAGENAME), filename))\npackage_info['package_data'][PACKAGENAME].extend(c_files)\n\n\nextra_tags = [m.strip() for m in metadata.get(\"extra_requires\", \"\").split(',')]\nif extra_tags:\n extras_require = {tag: [m.strip() for m in metadata[\"{tag}_requires\".format(tag=tag)].split(',')]\n for tag in extra_tags}\n extras_require['all'] = list(itertools.chain.from_iterable(extras_require.values()))\nelse:\n extras_require = None\n\n# Entry points\nentry_points['asdf_extensions'] = [\n 'sunpy = sunpy.io.special.asdf.extension:SunpyExtension',\n]\n\nsetup(name=PACKAGENAME,\n version=VERSION,\n description=DESCRIPTION,\n scripts=scripts,\n setup_requires=[s.strip() for s in metadata.get(\"setup_requires\", \"\").split(',')],\n install_requires=[s.strip() for s in metadata['install_requires'].split(',')],\n extras_require=extras_require,\n tests_require=extras_require.get(\"all\", \"\"),\n author=AUTHOR,\n author_email=AUTHOR_EMAIL,\n license=LICENSE,\n url=URL,\n project_urls={'Funding': 'https://www.flipcause.com/widget/widget_home/MTgxMTU=',\n 'Source': 'https://github.com/sunpy/sunpy/',\n 'Tracker': 'https://github.com/sunpy/sunpy/issues'\n },\n long_description=LONG_DESCRIPTION,\n long_description_content_type='text/x-rst',\n cmdclass=cmdclassd,\n zip_safe=False,\n entry_points=entry_points,\n python_requires='>={}'.format(__minimum_python_version__),\n include_package_data=True,\n **package_info\n )\n", "path": "setup.py"}]} |
gh_patches_debug_211 | rasdani/github-patches | git_diff | django-wiki__django-wiki-762 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Installation of 0.2.3 using pip seems to be missing a file
specifically the glyphicons font from bootstrap, located at: `/wiki/static/wiki/bootstrap/fonts/glyphicons-halflings-regular.woff2` within the repository
causes a bug when calling `collectstatic`.. I've verified it by manually downloading the `.whl` archive from pypi and it seems to be missing there.., maybe something went wrong while publishing, since the file is in the repository in the `0.2.3` tag?
--- 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 # -*- coding: utf-8 -*-
3 from __future__ import print_function
4
5 import os
6 import sys
7 from glob import glob
8
9 from setuptools import find_packages, setup
10
11 sys.path.append(
12 os.path.join(os.path.dirname(__file__), 'src')
13 )
14
15 # noqa
16 from wiki import __version__ # isort:skip # noqa
17
18
19 # Utility function to read the README file.
20 # Used for the long_description. It's nice, because now 1) we have a top level
21 # README file and 2) it's easier to type in the README file than to put a raw
22 # string in below ...
23 def get_path(fname):
24 return os.path.join(os.path.dirname(__file__), fname)
25
26
27 def read_file(fname):
28 """
29 Read file and decode in py2k
30 """
31 if sys.version_info < (3,):
32 return open(fname).read().decode("utf-8")
33 return open(fname).read()
34
35
36 requirements = [
37 "Django>=1.8,<2.0",
38 "bleach>=1.5,<2",
39 "Pillow",
40 "django-nyt>=1.0b1",
41 "six",
42 "django-mptt>=0.8.6,<0.9",
43 "django-sekizai>=0.10",
44 "sorl-thumbnail>=12,<13",
45 "Markdown>=2.6,<2.7",
46 ]
47
48
49 setup(
50 name="wiki",
51 version=__version__,
52 author="Benjamin Bach",
53 author_email="[email protected]",
54 url="http://www.django-wiki.org",
55 description="A wiki system written for the Django framework.",
56 license="GPLv3",
57 keywords=["django", "wiki", "markdown"],
58 packages=find_packages('src'),
59 package_dir={'': 'src'},
60 py_modules=[os.path.splitext(os.path.basename(path))[0] for path in glob('src/*.py')],
61 long_description=read_file('README.rst'),
62 zip_safe=False,
63 install_requires=requirements,
64 classifiers=[
65 'Development Status :: 5 - Production/Stable',
66 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
67 'Environment :: Web Environment',
68 'Framework :: Django',
69 'Intended Audience :: Developers',
70 'Operating System :: OS Independent',
71 'Programming Language :: Python',
72 'Programming Language :: Python :: 2.7',
73 'Programming Language :: Python :: 3.4',
74 'Programming Language :: Python :: 3.5',
75 'Programming Language :: Python :: 3.6',
76 'Programming Language :: Python :: Implementation :: CPython',
77 'Programming Language :: Python :: Implementation :: PyPy',
78 'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
79 'Topic :: Software Development',
80 'Topic :: Software Development :: Libraries :: Application Frameworks',
81 ],
82 include_package_data=True,
83 test_suite='runtests',
84 )
85
```
--- 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
@@ -37,7 +37,7 @@
"Django>=1.8,<2.0",
"bleach>=1.5,<2",
"Pillow",
- "django-nyt>=1.0b1",
+ "django-nyt>=1.0b1,<1.1",
"six",
"django-mptt>=0.8.6,<0.9",
"django-sekizai>=0.10",
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -37,7 +37,7 @@\n \"Django>=1.8,<2.0\",\n \"bleach>=1.5,<2\",\n \"Pillow\",\n- \"django-nyt>=1.0b1\",\n+ \"django-nyt>=1.0b1,<1.1\",\n \"six\",\n \"django-mptt>=0.8.6,<0.9\",\n \"django-sekizai>=0.10\",\n", "issue": "Installation of 0.2.3 using pip seems to be missing a file\nspecifically the glyphicons font from bootstrap, located at: `/wiki/static/wiki/bootstrap/fonts/glyphicons-halflings-regular.woff2` within the repository\r\n\r\ncauses a bug when calling `collectstatic`.. I've verified it by manually downloading the `.whl` archive from pypi and it seems to be missing there.., maybe something went wrong while publishing, since the file is in the repository in the `0.2.3` tag? \n", "before_files": [{"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\nfrom __future__ import print_function\n\nimport os\nimport sys\nfrom glob import glob\n\nfrom setuptools import find_packages, setup\n\nsys.path.append(\n os.path.join(os.path.dirname(__file__), 'src')\n)\n\n# noqa\nfrom wiki import __version__ # isort:skip # noqa\n\n\n# Utility function to read the README file.\n# Used for the long_description. It's nice, because now 1) we have a top level\n# README file and 2) it's easier to type in the README file than to put a raw\n# string in below ...\ndef get_path(fname):\n return os.path.join(os.path.dirname(__file__), fname)\n\n\ndef read_file(fname):\n \"\"\"\n Read file and decode in py2k\n \"\"\"\n if sys.version_info < (3,):\n return open(fname).read().decode(\"utf-8\")\n return open(fname).read()\n\n\nrequirements = [\n \"Django>=1.8,<2.0\",\n \"bleach>=1.5,<2\",\n \"Pillow\",\n \"django-nyt>=1.0b1\",\n \"six\",\n \"django-mptt>=0.8.6,<0.9\",\n \"django-sekizai>=0.10\",\n \"sorl-thumbnail>=12,<13\",\n \"Markdown>=2.6,<2.7\",\n]\n\n\nsetup(\n name=\"wiki\",\n version=__version__,\n author=\"Benjamin Bach\",\n author_email=\"[email protected]\",\n url=\"http://www.django-wiki.org\",\n description=\"A wiki system written for the Django framework.\",\n license=\"GPLv3\",\n keywords=[\"django\", \"wiki\", \"markdown\"],\n packages=find_packages('src'),\n package_dir={'': 'src'},\n py_modules=[os.path.splitext(os.path.basename(path))[0] for path in glob('src/*.py')],\n long_description=read_file('README.rst'),\n zip_safe=False,\n install_requires=requirements,\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',\n 'Environment :: Web Environment',\n 'Framework :: Django',\n 'Intended Audience :: Developers',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 2.7',\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 'Topic :: Internet :: WWW/HTTP :: Dynamic Content',\n 'Topic :: Software Development',\n 'Topic :: Software Development :: Libraries :: Application Frameworks',\n ],\n include_package_data=True,\n test_suite='runtests',\n)\n", "path": "setup.py"}], "after_files": [{"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\nfrom __future__ import print_function\n\nimport os\nimport sys\nfrom glob import glob\n\nfrom setuptools import find_packages, setup\n\nsys.path.append(\n os.path.join(os.path.dirname(__file__), 'src')\n)\n\n# noqa\nfrom wiki import __version__ # isort:skip # noqa\n\n\n# Utility function to read the README file.\n# Used for the long_description. It's nice, because now 1) we have a top level\n# README file and 2) it's easier to type in the README file than to put a raw\n# string in below ...\ndef get_path(fname):\n return os.path.join(os.path.dirname(__file__), fname)\n\n\ndef read_file(fname):\n \"\"\"\n Read file and decode in py2k\n \"\"\"\n if sys.version_info < (3,):\n return open(fname).read().decode(\"utf-8\")\n return open(fname).read()\n\n\nrequirements = [\n \"Django>=1.8,<2.0\",\n \"bleach>=1.5,<2\",\n \"Pillow\",\n \"django-nyt>=1.0b1,<1.1\",\n \"six\",\n \"django-mptt>=0.8.6,<0.9\",\n \"django-sekizai>=0.10\",\n \"sorl-thumbnail>=12,<13\",\n \"Markdown>=2.6,<2.7\",\n]\n\n\nsetup(\n name=\"wiki\",\n version=__version__,\n author=\"Benjamin Bach\",\n author_email=\"[email protected]\",\n url=\"http://www.django-wiki.org\",\n description=\"A wiki system written for the Django framework.\",\n license=\"GPLv3\",\n keywords=[\"django\", \"wiki\", \"markdown\"],\n packages=find_packages('src'),\n package_dir={'': 'src'},\n py_modules=[os.path.splitext(os.path.basename(path))[0] for path in glob('src/*.py')],\n long_description=read_file('README.rst'),\n zip_safe=False,\n install_requires=requirements,\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',\n 'Environment :: Web Environment',\n 'Framework :: Django',\n 'Intended Audience :: Developers',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python',\n 'Programming Language :: Python :: 2.7',\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 'Topic :: Internet :: WWW/HTTP :: Dynamic Content',\n 'Topic :: Software Development',\n 'Topic :: Software Development :: Libraries :: Application Frameworks',\n ],\n include_package_data=True,\n test_suite='runtests',\n)\n", "path": "setup.py"}]} |
gh_patches_debug_212 | rasdani/github-patches | git_diff | facebookresearch__hydra-279 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[Bug] Documentation inconsistency for `utils.get_original_cwd`
# 🐛 Bug
The tutorial for working directories has a few commands for setting the working directory [see here](https://cli.dev/docs/tutorial/working_directory), but the version of hydra on pip does not have these functions. Additionally, the install instructions do not include instructions on how to install from source (even if that's fairly trivial). The simple solution is to update the wheels on pip. Another alternative would be to put on the installation page that hydra is rapidly developing and suggest that one can install from source directly.
## System information
- 0.10.0 from pip
- python 3.7
- arch linux
## One more thing...
This is very minor but the pip version is `0.10.0` and the github master version is also `0.10.0`, but they not the same as evidenced by this issue. You should probably bump the version of git master. Keep up the good work, I think this is a great idea.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `hydra/__init__.py`
Content:
```
1 # Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved
2 from . import utils
3 from .errors import MissingConfigException
4 from .main import main
5
6 # Source of truth for Hydra's version
7 __version__ = "0.10.0"
8
9 __all__ = ["__version__", "MissingConfigException", "main", "utils"]
10
```
--- 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/hydra/__init__.py b/hydra/__init__.py
--- a/hydra/__init__.py
+++ b/hydra/__init__.py
@@ -4,6 +4,6 @@
from .main import main
# Source of truth for Hydra's version
-__version__ = "0.10.0"
+__version__ = "0.11.0-pre1"
__all__ = ["__version__", "MissingConfigException", "main", "utils"]
| {"golden_diff": "diff --git a/hydra/__init__.py b/hydra/__init__.py\n--- a/hydra/__init__.py\n+++ b/hydra/__init__.py\n@@ -4,6 +4,6 @@\n from .main import main\n \n # Source of truth for Hydra's version\n-__version__ = \"0.10.0\"\n+__version__ = \"0.11.0-pre1\"\n \n __all__ = [\"__version__\", \"MissingConfigException\", \"main\", \"utils\"]\n", "issue": "[Bug] Documentation inconsistency for `utils.get_original_cwd`\n# \ud83d\udc1b Bug\r\n\r\nThe tutorial for working directories has a few commands for setting the working directory [see here](https://cli.dev/docs/tutorial/working_directory), but the version of hydra on pip does not have these functions. Additionally, the install instructions do not include instructions on how to install from source (even if that's fairly trivial). The simple solution is to update the wheels on pip. Another alternative would be to put on the installation page that hydra is rapidly developing and suggest that one can install from source directly.\r\n\r\n## System information\r\n- 0.10.0 from pip\r\n- python 3.7\r\n- arch linux\r\n\r\n## One more thing...\r\nThis is very minor but the pip version is `0.10.0` and the github master version is also `0.10.0`, but they not the same as evidenced by this issue. You should probably bump the version of git master. Keep up the good work, I think this is a great idea.\n", "before_files": [{"content": "# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved\nfrom . import utils\nfrom .errors import MissingConfigException\nfrom .main import main\n\n# Source of truth for Hydra's version\n__version__ = \"0.10.0\"\n\n__all__ = [\"__version__\", \"MissingConfigException\", \"main\", \"utils\"]\n", "path": "hydra/__init__.py"}], "after_files": [{"content": "# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved\nfrom . import utils\nfrom .errors import MissingConfigException\nfrom .main import main\n\n# Source of truth for Hydra's version\n__version__ = \"0.11.0-pre1\"\n\n__all__ = [\"__version__\", \"MissingConfigException\", \"main\", \"utils\"]\n", "path": "hydra/__init__.py"}]} |
gh_patches_debug_213 | rasdani/github-patches | git_diff | Gallopsled__pwntools-1129 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Unable to create a shell shellcraft for MIPS
The problem is as follows:
```py
>>> from pwnlib.shellcraft import mips
>>> mips.sh()
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "<string>", line 8, in sh
File "/usr/lib64/python2.7/site-packages/mako/template.py", line 462, in render
return runtime._render(self, self.callable_, args, data)
File "/usr/lib64/python2.7/site-packages/mako/runtime.py", line 838, in _render
**_kwargs_for_callable(callable_, data))
File "/usr/lib64/python2.7/site-packages/mako/runtime.py", line 873, in _render_context
_exec_template(inherit, lclcontext, args=args, kwargs=kwargs)
File "/usr/lib64/python2.7/site-packages/mako/runtime.py", line 899, in _exec_template
callable_(context, *args, **kwargs)
File "/home/are/.pwntools-cache/mako/mips/linux/sh.asm.py", line 28, in render_body
__M_writer(unicode(mips.execve('//bin/sh', ['sh'], {})))
File "<string>", line 8, in execve
File "/usr/lib64/python2.7/site-packages/mako/template.py", line 462, in render
return runtime._render(self, self.callable_, args, data)
File "/usr/lib64/python2.7/site-packages/mako/runtime.py", line 838, in _render
**_kwargs_for_callable(callable_, data))
File "/usr/lib64/python2.7/site-packages/mako/runtime.py", line 873, in _render_context
_exec_template(inherit, lclcontext, args=args, kwargs=kwargs)
File "/usr/lib64/python2.7/site-packages/mako/runtime.py", line 899, in _exec_template
callable_(context, *args, **kwargs)
File "/home/are/.pwntools-cache/mako/mips/linux/syscalls/execve.asm.py", line 69, in render_body
if arg in allregs:
TypeError: unhashable type: 'list'
```
But it can be fixed by making sure that `shellcraft.registers.current()` returns a list rather than a dict (mips is the only architecture that it happens for, since `type(shellcraft.registers.mips)==dict`). A pull request is on its way.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `pwnlib/shellcraft/registers.py`
Content:
```
1 from __future__ import absolute_import
2
3 import re
4
5 from pwnlib.context import context
6 from pwnlib.util.misc import register_sizes
7
8 mips = {
9 '$0' : 0, '$zero': 0,
10 '$1' : 1, '$at': 1,
11 '$2' : 2, '$v0': 2,
12 '$3' : 3, '$v1': 3,
13 '$4' : 4, '$a0': 4,
14 '$5' : 5, '$a1': 5,
15 '$6' : 6, '$a2': 6,
16 '$7' : 7, '$a3': 7,
17 '$8' : 8, '$t0': 8,
18 '$9' : 9, '$t1': 9,
19 '$10': 10, '$t2': 10,
20 '$11': 11, '$t3': 11,
21 '$12': 12, '$t4': 12,
22 '$13': 13, '$t5': 13,
23 '$14': 14, '$t6': 14,
24 '$15': 15, '$t7': 15,
25 '$16': 16, '$s0': 16,
26 '$17': 17, '$s1': 17,
27 '$18': 18, '$s2': 18,
28 '$19': 19, '$s3': 19,
29 '$20': 20, '$s4': 20,
30 '$21': 21, '$s5': 21,
31 '$22': 22, '$s6': 22,
32 '$23': 23, '$s7': 23,
33 '$24': 24, '$t8': 24,
34 '$25': 25, '$t9': 25,
35 '$26': 26, '$k0': 26,
36 '$27': 27, '$k1': 27,
37 '$28': 28, '$gp': 28,
38 '$29': 29, '$sp': 29,
39 '$30': 30, '$s8': 30,
40 '$31': 31, '$ra': 31,
41 }
42
43 arm = map('r{}'.format, range(13))
44 arm += ["sp", "lr", "pc", "cpsr"]
45
46 thumb = arm
47
48 aarch64 = map('x{}'.format, range(32))
49 aarch64 += ["sp", "lr", "pc", "cpsr"]
50
51 i386_baseregs = [ "ax", "cx", "dx", "bx", "sp", "bp", "si", "di", "ip"]
52
53 i386 = map('e{}'.format, i386_baseregs)
54 i386 += i386_baseregs
55 i386 += [ "eflags", "cs", "ss", "ds", "es", "fs", "gs", ]
56
57 amd64 = map('r{}'.format, i386_baseregs)
58 amd64 += map('r{}'.format, range(8,16))
59 amd64 += map('r{}d'.format, range(8,16))
60 amd64 += i386
61
62 powerpc = map('r{}'.format, range(32))
63 powerpc += ["pc", "msr", "cr", "lr", "ctr", "xer", "orig_r3", "trap" ]
64 powerpc = map('%{}'.format, powerpc)
65
66 sparc = map('g{}'.format, range(8))
67 sparc += map('o{}'.format, range(5))
68 sparc += map('l{}'.format, range(8))
69 sparc += map('i{}'.format, range(5))
70 sparc += ["pc", "sp", "fp", "psr" ]
71 sparc = map('%{}'.format, sparc)
72
73
74
75 # x86/amd64 registers in decreasing size
76 i386_ordered = [
77 ['rax', 'eax', 'ax', 'al'],
78 ['rbx', 'ebx', 'bx', 'bl'],
79 ['rcx', 'ecx', 'cx', 'cl'],
80 ['rdx', 'edx', 'dx', 'dl'],
81 ['rdi', 'edi', 'di'],
82 ['rsi', 'esi', 'si'],
83 ['rbp', 'ebp', 'bp'],
84 ['rsp', 'esp', 'sp'],
85 ['r8', 'r8d', 'r8w', 'r8b'],
86 ['r9', 'r9d', 'r9w', 'r9b'],
87 ['r10', 'r10d', 'r10w', 'r10b'],
88 ['r11', 'r11d', 'r11w', 'r11b'],
89 ['r12', 'r12d', 'r12w', 'r12b'],
90 ['r13', 'r13d', 'r13w', 'r13b'],
91 ['r14', 'r14d', 'r14w', 'r14b'],
92 ['r15', 'r15d', 'r15w', 'r15b']
93 ]
94
95 all_regs, sizes, bigger, smaller = register_sizes(i386_ordered, [64, 32, 16, 8, 8])
96 native64 = {k:v[0] for k,v in bigger.items()}
97 native32 = {k:v[1] for k,v in bigger.items() if not k.startswith('r')}
98
99 class Register(object):
100 #: Register name
101 name = None
102
103 #: List of larger registers, in order from largest to smallest
104 bigger = None
105
106 #: List of smaller regsters, in order from smallest to largest
107 smaller = None
108
109 #: Size of the register, in bits
110 size = None
111
112 #: Does this register have a 'high' register for mask 0xff00
113 ff00 = None
114
115 #: Flags for 64-bit mode.64-bit
116 #: The first bit is set, if the register can be used with a REX-mode
117 #: The second bit is set, if the register can be used without a REX-prefix
118 rex_mode = 0
119
120 #: Is this a 64-bit only register?
121 is64bit = False
122
123 #: Name of the native 64-bit register
124 native64 = None
125
126 #: Name of the native 32-bit register
127 native32 = None
128
129 #: Name of the register which should be used to clear
130 #: this register, e.g. xor REG, REG.
131 #: Useful for AMD64 for xor eax, eax is shorter than
132 #: xor rax, rax and has the same effect.
133 xor = None
134
135 def __init__(self, name, size):
136 self.name = name
137 self.size = size
138
139 for row in i386_ordered:
140 if name in row:
141 self.bigger = row[0:row.index(name)]
142 self.smaller = row[row.index(name)+1:]
143 self.sizes = {64>>i:r for i,r in enumerate(row)}
144 self.native64 = row[0]
145 self.native32 = row[1]
146 self.xor = self.sizes[min(self.size, 32)]
147
148 if self.size >= 32 and name.endswith('x'):
149 self.ff00 = name[1] + 'h'
150
151 if name[-1] != 'h':
152 self.rex_mode |= 1
153
154 if name[0] != 'r':
155 self.rex_mode |= 2
156
157 if name.startswith('r') or name[1:3].isdigit():
158 self.is64bit = True
159
160 @property
161 def bits(self):
162 return self.size
163
164 @property
165 def bytes(self):
166 return self.bits / 8
167
168 def fits(self, value):
169 return self.size >= bits_required(value)
170
171 def __str__(self):
172 return self.name
173
174 def __repr__(self):
175 return "Register(%r)" % self.name
176
177 intel = {}
178
179 for row in i386_ordered:
180 for i, reg in enumerate(row):
181 intel[reg] = Register(reg, 64 >> i)
182
183 def get_register(name):
184 if isinstance(name, Register):
185 return name
186 if isinstance(name, str):
187 return intel.get(name, None)
188 return None
189
190 def is_register(obj):
191 if isinstance(obj, Register):
192 return True
193 return get_register(obj)
194
195
196 def bits_required(value):
197 bits = 0
198
199 if value < 0:
200 value = -(value)
201
202 while value:
203 value >>= 8
204 bits += 8
205 return bits
206
207 def current():
208 return {
209 'i386': i386,
210 'amd64': amd64,
211 'arm': arm,
212 'thumb': arm,
213 'aarch64': aarch64,
214 'mips': mips,
215 'powerpc': powerpc
216 }[context.arch]
217
218 # def is_register(sz):
219 # try:
220 # sz = sz.lower()
221 # return sz.lower() in {
222 # 'i386': i386,
223 # 'amd64': amd64,
224 # 'powerpc': powerpc,
225 # 'sparc': sparc,
226 # 'arm': arm,
227 # 'aarch64': arm,
228 # 'thumb': arm,
229 # 'mips': mips,
230 # 'mips64': mips
231 # }[context.arch]
232 # except:
233 # return False
234
235 def register_size(reg):
236 return sizes[reg]
237
238 def fits_in_register(reg, value):
239 return register_size(reg) >= bits_required(value)
240
```
--- 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/pwnlib/shellcraft/registers.py b/pwnlib/shellcraft/registers.py
--- a/pwnlib/shellcraft/registers.py
+++ b/pwnlib/shellcraft/registers.py
@@ -211,7 +211,7 @@
'arm': arm,
'thumb': arm,
'aarch64': aarch64,
- 'mips': mips,
+ 'mips': list(mips),
'powerpc': powerpc
}[context.arch]
| {"golden_diff": "diff --git a/pwnlib/shellcraft/registers.py b/pwnlib/shellcraft/registers.py\n--- a/pwnlib/shellcraft/registers.py\n+++ b/pwnlib/shellcraft/registers.py\n@@ -211,7 +211,7 @@\n 'arm': arm,\n 'thumb': arm,\n 'aarch64': aarch64,\n- 'mips': mips,\n+ 'mips': list(mips),\n 'powerpc': powerpc\n }[context.arch]\n", "issue": "Unable to create a shell shellcraft for MIPS\nThe problem is as follows:\r\n```py\r\n>>> from pwnlib.shellcraft import mips\r\n>>> mips.sh()\r\nTraceback (most recent call last):\r\n File \"<stdin>\", line 1, in <module>\r\n File \"<string>\", line 8, in sh\r\n File \"/usr/lib64/python2.7/site-packages/mako/template.py\", line 462, in render\r\n return runtime._render(self, self.callable_, args, data)\r\n File \"/usr/lib64/python2.7/site-packages/mako/runtime.py\", line 838, in _render\r\n **_kwargs_for_callable(callable_, data))\r\n File \"/usr/lib64/python2.7/site-packages/mako/runtime.py\", line 873, in _render_context\r\n _exec_template(inherit, lclcontext, args=args, kwargs=kwargs)\r\n File \"/usr/lib64/python2.7/site-packages/mako/runtime.py\", line 899, in _exec_template\r\n callable_(context, *args, **kwargs)\r\n File \"/home/are/.pwntools-cache/mako/mips/linux/sh.asm.py\", line 28, in render_body\r\n __M_writer(unicode(mips.execve('//bin/sh', ['sh'], {})))\r\n File \"<string>\", line 8, in execve\r\n File \"/usr/lib64/python2.7/site-packages/mako/template.py\", line 462, in render\r\n return runtime._render(self, self.callable_, args, data)\r\n File \"/usr/lib64/python2.7/site-packages/mako/runtime.py\", line 838, in _render\r\n **_kwargs_for_callable(callable_, data))\r\n File \"/usr/lib64/python2.7/site-packages/mako/runtime.py\", line 873, in _render_context\r\n _exec_template(inherit, lclcontext, args=args, kwargs=kwargs)\r\n File \"/usr/lib64/python2.7/site-packages/mako/runtime.py\", line 899, in _exec_template\r\n callable_(context, *args, **kwargs)\r\n File \"/home/are/.pwntools-cache/mako/mips/linux/syscalls/execve.asm.py\", line 69, in render_body\r\n if arg in allregs:\r\nTypeError: unhashable type: 'list'\r\n```\r\nBut it can be fixed by making sure that `shellcraft.registers.current()` returns a list rather than a dict (mips is the only architecture that it happens for, since `type(shellcraft.registers.mips)==dict`). A pull request is on its way.\n", "before_files": [{"content": "from __future__ import absolute_import\n\nimport re\n\nfrom pwnlib.context import context\nfrom pwnlib.util.misc import register_sizes\n\nmips = {\n '$0' : 0, '$zero': 0,\n '$1' : 1, '$at': 1,\n '$2' : 2, '$v0': 2,\n '$3' : 3, '$v1': 3,\n '$4' : 4, '$a0': 4,\n '$5' : 5, '$a1': 5,\n '$6' : 6, '$a2': 6,\n '$7' : 7, '$a3': 7,\n '$8' : 8, '$t0': 8,\n '$9' : 9, '$t1': 9,\n '$10': 10, '$t2': 10,\n '$11': 11, '$t3': 11,\n '$12': 12, '$t4': 12,\n '$13': 13, '$t5': 13,\n '$14': 14, '$t6': 14,\n '$15': 15, '$t7': 15,\n '$16': 16, '$s0': 16,\n '$17': 17, '$s1': 17,\n '$18': 18, '$s2': 18,\n '$19': 19, '$s3': 19,\n '$20': 20, '$s4': 20,\n '$21': 21, '$s5': 21,\n '$22': 22, '$s6': 22,\n '$23': 23, '$s7': 23,\n '$24': 24, '$t8': 24,\n '$25': 25, '$t9': 25,\n '$26': 26, '$k0': 26,\n '$27': 27, '$k1': 27,\n '$28': 28, '$gp': 28,\n '$29': 29, '$sp': 29,\n '$30': 30, '$s8': 30,\n '$31': 31, '$ra': 31,\n}\n\narm = map('r{}'.format, range(13))\narm += [\"sp\", \"lr\", \"pc\", \"cpsr\"]\n\nthumb = arm\n\naarch64 = map('x{}'.format, range(32))\naarch64 += [\"sp\", \"lr\", \"pc\", \"cpsr\"]\n\ni386_baseregs = [ \"ax\", \"cx\", \"dx\", \"bx\", \"sp\", \"bp\", \"si\", \"di\", \"ip\"]\n\ni386 = map('e{}'.format, i386_baseregs)\ni386 += i386_baseregs\ni386 += [ \"eflags\", \"cs\", \"ss\", \"ds\", \"es\", \"fs\", \"gs\", ]\n\namd64 = map('r{}'.format, i386_baseregs)\namd64 += map('r{}'.format, range(8,16))\namd64 += map('r{}d'.format, range(8,16))\namd64 += i386\n\npowerpc = map('r{}'.format, range(32))\npowerpc += [\"pc\", \"msr\", \"cr\", \"lr\", \"ctr\", \"xer\", \"orig_r3\", \"trap\" ]\npowerpc = map('%{}'.format, powerpc)\n\nsparc = map('g{}'.format, range(8))\nsparc += map('o{}'.format, range(5))\nsparc += map('l{}'.format, range(8))\nsparc += map('i{}'.format, range(5))\nsparc += [\"pc\", \"sp\", \"fp\", \"psr\" ]\nsparc = map('%{}'.format, sparc)\n\n\n\n# x86/amd64 registers in decreasing size\ni386_ordered = [\n ['rax', 'eax', 'ax', 'al'],\n ['rbx', 'ebx', 'bx', 'bl'],\n ['rcx', 'ecx', 'cx', 'cl'],\n ['rdx', 'edx', 'dx', 'dl'],\n ['rdi', 'edi', 'di'],\n ['rsi', 'esi', 'si'],\n ['rbp', 'ebp', 'bp'],\n ['rsp', 'esp', 'sp'],\n ['r8', 'r8d', 'r8w', 'r8b'],\n ['r9', 'r9d', 'r9w', 'r9b'],\n ['r10', 'r10d', 'r10w', 'r10b'],\n ['r11', 'r11d', 'r11w', 'r11b'],\n ['r12', 'r12d', 'r12w', 'r12b'],\n ['r13', 'r13d', 'r13w', 'r13b'],\n ['r14', 'r14d', 'r14w', 'r14b'],\n ['r15', 'r15d', 'r15w', 'r15b']\n]\n\nall_regs, sizes, bigger, smaller = register_sizes(i386_ordered, [64, 32, 16, 8, 8])\nnative64 = {k:v[0] for k,v in bigger.items()}\nnative32 = {k:v[1] for k,v in bigger.items() if not k.startswith('r')}\n\nclass Register(object):\n #: Register name\n name = None\n\n #: List of larger registers, in order from largest to smallest\n bigger = None\n\n #: List of smaller regsters, in order from smallest to largest\n smaller = None\n\n #: Size of the register, in bits\n size = None\n\n #: Does this register have a 'high' register for mask 0xff00\n ff00 = None\n\n #: Flags for 64-bit mode.64-bit\n #: The first bit is set, if the register can be used with a REX-mode\n #: The second bit is set, if the register can be used without a REX-prefix\n rex_mode = 0\n\n #: Is this a 64-bit only register?\n is64bit = False\n\n #: Name of the native 64-bit register\n native64 = None\n\n #: Name of the native 32-bit register\n native32 = None\n\n #: Name of the register which should be used to clear\n #: this register, e.g. xor REG, REG.\n #: Useful for AMD64 for xor eax, eax is shorter than\n #: xor rax, rax and has the same effect.\n xor = None\n\n def __init__(self, name, size):\n self.name = name\n self.size = size\n\n for row in i386_ordered:\n if name in row:\n self.bigger = row[0:row.index(name)]\n self.smaller = row[row.index(name)+1:]\n self.sizes = {64>>i:r for i,r in enumerate(row)}\n self.native64 = row[0]\n self.native32 = row[1]\n self.xor = self.sizes[min(self.size, 32)]\n\n if self.size >= 32 and name.endswith('x'):\n self.ff00 = name[1] + 'h'\n\n if name[-1] != 'h':\n self.rex_mode |= 1\n\n if name[0] != 'r':\n self.rex_mode |= 2\n\n if name.startswith('r') or name[1:3].isdigit():\n self.is64bit = True\n\n @property\n def bits(self):\n return self.size\n\n @property\n def bytes(self):\n return self.bits / 8\n\n def fits(self, value):\n return self.size >= bits_required(value)\n\n def __str__(self):\n return self.name\n\n def __repr__(self):\n return \"Register(%r)\" % self.name\n\nintel = {}\n\nfor row in i386_ordered:\n for i, reg in enumerate(row):\n intel[reg] = Register(reg, 64 >> i)\n\ndef get_register(name):\n if isinstance(name, Register):\n return name\n if isinstance(name, str):\n return intel.get(name, None)\n return None\n\ndef is_register(obj):\n if isinstance(obj, Register):\n return True\n return get_register(obj)\n\n\ndef bits_required(value):\n bits = 0\n\n if value < 0:\n value = -(value)\n\n while value:\n value >>= 8\n bits += 8\n return bits\n\ndef current():\n return {\n 'i386': i386,\n 'amd64': amd64,\n 'arm': arm,\n 'thumb': arm,\n 'aarch64': aarch64,\n 'mips': mips,\n 'powerpc': powerpc\n }[context.arch]\n\n# def is_register(sz):\n# try:\n# sz = sz.lower()\n# return sz.lower() in {\n# 'i386': i386,\n# 'amd64': amd64,\n# 'powerpc': powerpc,\n# 'sparc': sparc,\n# 'arm': arm,\n# 'aarch64': arm,\n# 'thumb': arm,\n# 'mips': mips,\n# 'mips64': mips\n# }[context.arch]\n# except:\n# return False\n\ndef register_size(reg):\n return sizes[reg]\n\ndef fits_in_register(reg, value):\n return register_size(reg) >= bits_required(value)\n", "path": "pwnlib/shellcraft/registers.py"}], "after_files": [{"content": "from __future__ import absolute_import\n\nimport re\n\nfrom pwnlib.context import context\nfrom pwnlib.util.misc import register_sizes\n\nmips = {\n '$0' : 0, '$zero': 0,\n '$1' : 1, '$at': 1,\n '$2' : 2, '$v0': 2,\n '$3' : 3, '$v1': 3,\n '$4' : 4, '$a0': 4,\n '$5' : 5, '$a1': 5,\n '$6' : 6, '$a2': 6,\n '$7' : 7, '$a3': 7,\n '$8' : 8, '$t0': 8,\n '$9' : 9, '$t1': 9,\n '$10': 10, '$t2': 10,\n '$11': 11, '$t3': 11,\n '$12': 12, '$t4': 12,\n '$13': 13, '$t5': 13,\n '$14': 14, '$t6': 14,\n '$15': 15, '$t7': 15,\n '$16': 16, '$s0': 16,\n '$17': 17, '$s1': 17,\n '$18': 18, '$s2': 18,\n '$19': 19, '$s3': 19,\n '$20': 20, '$s4': 20,\n '$21': 21, '$s5': 21,\n '$22': 22, '$s6': 22,\n '$23': 23, '$s7': 23,\n '$24': 24, '$t8': 24,\n '$25': 25, '$t9': 25,\n '$26': 26, '$k0': 26,\n '$27': 27, '$k1': 27,\n '$28': 28, '$gp': 28,\n '$29': 29, '$sp': 29,\n '$30': 30, '$s8': 30,\n '$31': 31, '$ra': 31,\n}\n\narm = map('r{}'.format, range(13))\narm += [\"sp\", \"lr\", \"pc\", \"cpsr\"]\n\nthumb = arm\n\naarch64 = map('x{}'.format, range(32))\naarch64 += [\"sp\", \"lr\", \"pc\", \"cpsr\"]\n\ni386_baseregs = [ \"ax\", \"cx\", \"dx\", \"bx\", \"sp\", \"bp\", \"si\", \"di\", \"ip\"]\n\ni386 = map('e{}'.format, i386_baseregs)\ni386 += i386_baseregs\ni386 += [ \"eflags\", \"cs\", \"ss\", \"ds\", \"es\", \"fs\", \"gs\", ]\n\namd64 = map('r{}'.format, i386_baseregs)\namd64 += map('r{}'.format, range(8,16))\namd64 += map('r{}d'.format, range(8,16))\namd64 += i386\n\npowerpc = map('r{}'.format, range(32))\npowerpc += [\"pc\", \"msr\", \"cr\", \"lr\", \"ctr\", \"xer\", \"orig_r3\", \"trap\" ]\npowerpc = map('%{}'.format, powerpc)\n\nsparc = map('g{}'.format, range(8))\nsparc += map('o{}'.format, range(5))\nsparc += map('l{}'.format, range(8))\nsparc += map('i{}'.format, range(5))\nsparc += [\"pc\", \"sp\", \"fp\", \"psr\" ]\nsparc = map('%{}'.format, sparc)\n\n\n\n# x86/amd64 registers in decreasing size\ni386_ordered = [\n ['rax', 'eax', 'ax', 'al'],\n ['rbx', 'ebx', 'bx', 'bl'],\n ['rcx', 'ecx', 'cx', 'cl'],\n ['rdx', 'edx', 'dx', 'dl'],\n ['rdi', 'edi', 'di'],\n ['rsi', 'esi', 'si'],\n ['rbp', 'ebp', 'bp'],\n ['rsp', 'esp', 'sp'],\n ['r8', 'r8d', 'r8w', 'r8b'],\n ['r9', 'r9d', 'r9w', 'r9b'],\n ['r10', 'r10d', 'r10w', 'r10b'],\n ['r11', 'r11d', 'r11w', 'r11b'],\n ['r12', 'r12d', 'r12w', 'r12b'],\n ['r13', 'r13d', 'r13w', 'r13b'],\n ['r14', 'r14d', 'r14w', 'r14b'],\n ['r15', 'r15d', 'r15w', 'r15b']\n]\n\nall_regs, sizes, bigger, smaller = register_sizes(i386_ordered, [64, 32, 16, 8, 8])\nnative64 = {k:v[0] for k,v in bigger.items()}\nnative32 = {k:v[1] for k,v in bigger.items() if not k.startswith('r')}\n\nclass Register(object):\n #: Register name\n name = None\n\n #: List of larger registers, in order from largest to smallest\n bigger = None\n\n #: List of smaller regsters, in order from smallest to largest\n smaller = None\n\n #: Size of the register, in bits\n size = None\n\n #: Does this register have a 'high' register for mask 0xff00\n ff00 = None\n\n #: Flags for 64-bit mode.64-bit\n #: The first bit is set, if the register can be used with a REX-mode\n #: The second bit is set, if the register can be used without a REX-prefix\n rex_mode = 0\n\n #: Is this a 64-bit only register?\n is64bit = False\n\n #: Name of the native 64-bit register\n native64 = None\n\n #: Name of the native 32-bit register\n native32 = None\n\n #: Name of the register which should be used to clear\n #: this register, e.g. xor REG, REG.\n #: Useful for AMD64 for xor eax, eax is shorter than\n #: xor rax, rax and has the same effect.\n xor = None\n\n def __init__(self, name, size):\n self.name = name\n self.size = size\n\n for row in i386_ordered:\n if name in row:\n self.bigger = row[0:row.index(name)]\n self.smaller = row[row.index(name)+1:]\n self.sizes = {64>>i:r for i,r in enumerate(row)}\n self.native64 = row[0]\n self.native32 = row[1]\n self.xor = self.sizes[min(self.size, 32)]\n\n if self.size >= 32 and name.endswith('x'):\n self.ff00 = name[1] + 'h'\n\n if name[-1] != 'h':\n self.rex_mode |= 1\n\n if name[0] != 'r':\n self.rex_mode |= 2\n\n if name.startswith('r') or name[1:3].isdigit():\n self.is64bit = True\n\n @property\n def bits(self):\n return self.size\n\n @property\n def bytes(self):\n return self.bits / 8\n\n def fits(self, value):\n return self.size >= bits_required(value)\n\n def __str__(self):\n return self.name\n\n def __repr__(self):\n return \"Register(%r)\" % self.name\n\nintel = {}\n\nfor row in i386_ordered:\n for i, reg in enumerate(row):\n intel[reg] = Register(reg, 64 >> i)\n\ndef get_register(name):\n if isinstance(name, Register):\n return name\n if isinstance(name, str):\n return intel.get(name, None)\n return None\n\ndef is_register(obj):\n if isinstance(obj, Register):\n return True\n return get_register(obj)\n\n\ndef bits_required(value):\n bits = 0\n\n if value < 0:\n value = -(value)\n\n while value:\n value >>= 8\n bits += 8\n return bits\n\ndef current():\n return {\n 'i386': i386,\n 'amd64': amd64,\n 'arm': arm,\n 'thumb': arm,\n 'aarch64': aarch64,\n 'mips': list(mips),\n 'powerpc': powerpc\n }[context.arch]\n\n# def is_register(sz):\n# try:\n# sz = sz.lower()\n# return sz.lower() in {\n# 'i386': i386,\n# 'amd64': amd64,\n# 'powerpc': powerpc,\n# 'sparc': sparc,\n# 'arm': arm,\n# 'aarch64': arm,\n# 'thumb': arm,\n# 'mips': mips,\n# 'mips64': mips\n# }[context.arch]\n# except:\n# return False\n\ndef register_size(reg):\n return sizes[reg]\n\ndef fits_in_register(reg, value):\n return register_size(reg) >= bits_required(value)\n", "path": "pwnlib/shellcraft/registers.py"}]} |
gh_patches_debug_214 | rasdani/github-patches | git_diff | elastic__apm-agent-python-1149 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
AttributeError: 'Config' object has no attribute 'start_stop_order'
# Error
We started seeing this traceback via Sentry coming from the elasticapm agent with the Django integration after upgrading from 6.1.3 to 6.2.0:
```
AttributeError: 'Config' object has no attribute 'start_stop_order'
File "elasticapm/instrumentation/packages/dbapi2.py", line 276, in call_if_sampling
return self.call(module, method, wrapped, instance, args, kwargs)
File "elasticapm/instrumentation/packages/psycopg2.py", line 104, in call
return PGConnectionProxy(wrapped(*args, **kwargs), destination_info=destination_info)
File "elasticapm/traces.py", line 709, in __exit__
span = transaction.end_span(self.skip_frames, duration=self.duration, outcome=outcome)
File "elasticapm/traces.py", line 293, in end_span
span.end(skip_frames=skip_frames, duration=duration)
File "elasticapm/traces.py", line 484, in end
tracer.queue_func(SPAN, self.to_dict())
File "elasticapm/base.py", line 275, in queue
self.start_threads()
File "elasticapm/base.py", line 220, in start_threads
for manager_type, manager in sorted(
File "elasticapm/base.py", line 221, in <lambda>
self._thread_managers.items(), key=lambda item: item[1].start_stop_order
File "elasticapm/conf/__init__.py", line 709, in __getattr__
return getattr(self._config, item)
```
# Environment
OS: Linux
Python version: 3.8.9
Framework and version [e.g. Django 2.1]: Django 3.1.10
APM Server version: 7.6
Agent version: 6.2.0
# Additional context
I think the bug was introduced in https://github.com/elastic/apm-agent-python/pull/1139/files.
The change sorts `self._thread_managers.items()` by the `start_stop_order` of each dict item.
`self._thread_managers['config']` is an instance of [`VersionedConfig`](https://github.com/elastic/apm-agent-python/blob/master/elasticapm/conf/__init__.py#L636), which inherits [`ThreadManager`](https://github.com/elastic/apm-agent-python/blob/c5fe64662f971f26deb200b4619860c363b3e483/elasticapm/utils/threading.py#L98) where this attribute is set. But the `__getattr__` method of `VersionedConfig` [is overriden](https://github.com/elastic/apm-agent-python/blob/master/elasticapm/conf/__init__.py#L708) to instead fetch the item from `VersionedConfig._config`, which is a [`Config`](https://github.com/elastic/apm-agent-python/blob/master/elasticapm/conf/__init__.py#L508) object and doesn't have the attribute `start_stop_order`.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `elasticapm/conf/__init__.py`
Content:
```
1 # BSD 3-Clause License
2 #
3 # Copyright (c) 2012, the Sentry Team, see AUTHORS for more details
4 # Copyright (c) 2019, Elasticsearch BV
5 # All rights reserved.
6 #
7 # Redistribution and use in source and binary forms, with or without
8 # modification, are permitted provided that the following conditions are met:
9 #
10 # * Redistributions of source code must retain the above copyright notice, this
11 # list of conditions and the following disclaimer.
12 #
13 # * Redistributions in binary form must reproduce the above copyright notice,
14 # this list of conditions and the following disclaimer in the documentation
15 # and/or other materials provided with the distribution.
16 #
17 # * Neither the name of the copyright holder nor the names of its
18 # contributors may be used to endorse or promote products derived from
19 # this software without specific prior written permission.
20 #
21 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30
31
32 import logging
33 import logging.handlers
34 import math
35 import os
36 import re
37 import socket
38 import threading
39
40 from elasticapm.conf.constants import BASE_SANITIZE_FIELD_NAMES
41 from elasticapm.utils import compat, starmatch_to_regex
42 from elasticapm.utils.logging import get_logger
43 from elasticapm.utils.threading import IntervalTimer, ThreadManager
44
45 __all__ = ("setup_logging", "Config")
46
47
48 logger = get_logger("elasticapm.conf")
49
50 log_levels_map = {
51 "trace": 5,
52 "debug": logging.DEBUG,
53 "info": logging.INFO,
54 "warning": logging.WARNING,
55 "warn": logging.WARNING,
56 "error": logging.ERROR,
57 "critical": logging.CRITICAL,
58 "off": 1000,
59 }
60 logfile_set_up = False
61
62
63 class ConfigurationError(ValueError):
64 def __init__(self, msg, field_name):
65 self.field_name = field_name
66 super(ValueError, self).__init__(msg)
67
68
69 class _ConfigValue(object):
70 """
71 Base class for configuration values
72
73 dict_key
74 String representing the key used for this config value in dict configs.
75 env_key
76 String representing the key used in environment variables for this
77 config value. If not specified, will be set to `"ELASTIC_APM_" + dict_key`.
78 type
79 Type of value stored in this config value.
80 validators
81 List of validator classes. Must be callables, which will be called with
82 a value and the dict_key for the config value. The validator either
83 returns the validated value or raises a ConfigurationError if validation
84 fails.
85 callbacks
86 List of functions which will be called when the config value is updated.
87 The callbacks must match this signature:
88 callback(dict_key, old_value, new_value, config_instance)
89
90 Note that callbacks wait until the end of any given `update()` operation
91 and are called at this point. This, coupled with the fact that callbacks
92 receive the config instance, means that callbacks can utilize multiple
93 configuration values (such as is the case for logging). This is
94 complicated if more than one of the involved config values are
95 dynamic, as both would need callbacks and the callback would need to
96 be idempotent.
97 callbacks_on_default
98 Whether the callback should be called on config initialization if the
99 default value is used. Default: True
100 default
101 The default for this config value if not user-configured.
102 required
103 Whether this config value is required. If a default is specified,
104 this is a redundant option (except to ensure that this config value
105 is specified if a default were ever to be removed).
106
107 Note that _ConfigValues and any inheriting classes must implement __set__
108 and __get__. The calling instance will always be a _ConfigBase descendant
109 and the __set__ and __get__ calls will access `instance._values[self.dict_key]`
110 to get and set values.
111 """
112
113 def __init__(
114 self,
115 dict_key,
116 env_key=None,
117 type=compat.text_type,
118 validators=None,
119 callbacks=None,
120 callbacks_on_default=True,
121 default=None,
122 required=False,
123 ):
124 self.type = type
125 self.dict_key = dict_key
126 self.validators = validators
127 self.callbacks = callbacks
128 self.default = default
129 self.required = required
130 if env_key is None:
131 env_key = "ELASTIC_APM_" + dict_key
132 self.env_key = env_key
133 self.callbacks_on_default = callbacks_on_default
134
135 def __get__(self, instance, owner):
136 if instance:
137 return instance._values.get(self.dict_key, self.default)
138 else:
139 return self.default
140
141 def __set__(self, config_instance, value):
142 value = self._validate(config_instance, value)
143 self._callback_if_changed(config_instance, value)
144 config_instance._values[self.dict_key] = value
145
146 def _validate(self, instance, value):
147 if value is None and self.required:
148 raise ConfigurationError(
149 "Configuration error: value for {} is required.".format(self.dict_key), self.dict_key
150 )
151 if self.validators and value is not None:
152 for validator in self.validators:
153 value = validator(value, self.dict_key)
154 if self.type and value is not None:
155 try:
156 value = self.type(value)
157 except ValueError as e:
158 raise ConfigurationError("{}: {}".format(self.dict_key, compat.text_type(e)), self.dict_key)
159 instance._errors.pop(self.dict_key, None)
160 return value
161
162 def _callback_if_changed(self, instance, new_value):
163 """
164 If the value changed (checked against instance._values[self.dict_key]),
165 then run the callback function (if defined)
166 """
167 old_value = instance._values.get(self.dict_key, self.default)
168 if old_value != new_value:
169 instance.callbacks_queue.append((self.dict_key, old_value, new_value))
170
171 def call_callbacks(self, old_value, new_value, config_instance):
172 if not self.callbacks:
173 return
174 for callback in self.callbacks:
175 try:
176 callback(self.dict_key, old_value, new_value, config_instance)
177 except Exception as e:
178 raise ConfigurationError(
179 "Callback {} raised an exception when setting {} to {}: {}".format(
180 callback, self.dict_key, new_value, e
181 ),
182 self.dict_key,
183 )
184
185
186 class _ListConfigValue(_ConfigValue):
187 def __init__(self, dict_key, list_separator=",", **kwargs):
188 self.list_separator = list_separator
189 super(_ListConfigValue, self).__init__(dict_key, **kwargs)
190
191 def __set__(self, instance, value):
192 if isinstance(value, compat.string_types):
193 value = value.split(self.list_separator)
194 elif value is not None:
195 value = list(value)
196 if value:
197 value = [self.type(item) for item in value]
198 self._callback_if_changed(instance, value)
199 instance._values[self.dict_key] = value
200
201
202 class _DictConfigValue(_ConfigValue):
203 def __init__(self, dict_key, item_separator=",", keyval_separator="=", **kwargs):
204 self.item_separator = item_separator
205 self.keyval_separator = keyval_separator
206 super(_DictConfigValue, self).__init__(dict_key, **kwargs)
207
208 def __set__(self, instance, value):
209 if isinstance(value, compat.string_types):
210 items = (item.split(self.keyval_separator) for item in value.split(self.item_separator))
211 value = {key.strip(): self.type(val.strip()) for key, val in items}
212 elif not isinstance(value, dict):
213 # TODO: better error handling
214 value = None
215 self._callback_if_changed(instance, value)
216 instance._values[self.dict_key] = value
217
218
219 class _BoolConfigValue(_ConfigValue):
220 def __init__(self, dict_key, true_string="true", false_string="false", **kwargs):
221 self.true_string = true_string
222 self.false_string = false_string
223 super(_BoolConfigValue, self).__init__(dict_key, **kwargs)
224
225 def __set__(self, instance, value):
226 if isinstance(value, compat.string_types):
227 if value.lower() == self.true_string:
228 value = True
229 elif value.lower() == self.false_string:
230 value = False
231 self._callback_if_changed(instance, value)
232 instance._values[self.dict_key] = bool(value)
233
234
235 class RegexValidator(object):
236 def __init__(self, regex, verbose_pattern=None):
237 self.regex = regex
238 self.verbose_pattern = verbose_pattern or regex
239
240 def __call__(self, value, field_name):
241 value = compat.text_type(value)
242 match = re.match(self.regex, value)
243 if match:
244 return value
245 raise ConfigurationError("{} does not match pattern {}".format(value, self.verbose_pattern), field_name)
246
247
248 class UnitValidator(object):
249 def __init__(self, regex, verbose_pattern, unit_multipliers):
250 self.regex = regex
251 self.verbose_pattern = verbose_pattern
252 self.unit_multipliers = unit_multipliers
253
254 def __call__(self, value, field_name):
255 value = compat.text_type(value)
256 match = re.match(self.regex, value, re.IGNORECASE)
257 if not match:
258 raise ConfigurationError("{} does not match pattern {}".format(value, self.verbose_pattern), field_name)
259 val, unit = match.groups()
260 try:
261 val = int(val) * self.unit_multipliers[unit]
262 except KeyError:
263 raise ConfigurationError("{} is not a supported unit".format(unit), field_name)
264 return val
265
266
267 class PrecisionValidator(object):
268 """
269 Forces a float value to `precision` digits of precision.
270
271 Rounds half away from zero.
272
273 If `minimum` is provided, and the value rounds to 0 (but was not zero to
274 begin with), use the minimum instead.
275 """
276
277 def __init__(self, precision=0, minimum=None):
278 self.precision = precision
279 self.minimum = minimum
280
281 def __call__(self, value, field_name):
282 try:
283 value = float(value)
284 except ValueError:
285 raise ConfigurationError("{} is not a float".format(value), field_name)
286 multiplier = 10 ** self.precision
287 rounded = math.floor(value * multiplier + 0.5) / multiplier
288 if rounded == 0 and self.minimum and value != 0:
289 rounded = self.minimum
290 return rounded
291
292
293 duration_validator = UnitValidator(r"^((?:-)?\d+)(ms|s|m)$", r"\d+(ms|s|m)", {"ms": 1, "s": 1000, "m": 60000})
294 size_validator = UnitValidator(
295 r"^(\d+)(b|kb|mb|gb)$", r"\d+(b|KB|MB|GB)", {"b": 1, "kb": 1024, "mb": 1024 * 1024, "gb": 1024 * 1024 * 1024}
296 )
297
298
299 class ExcludeRangeValidator(object):
300 def __init__(self, range_start, range_end, range_desc):
301 self.range_start = range_start
302 self.range_end = range_end
303 self.range_desc = range_desc
304
305 def __call__(self, value, field_name):
306 if self.range_start <= value <= self.range_end:
307 raise ConfigurationError(
308 "{} cannot be in range: {}".format(
309 value, self.range_desc.format(**{"range_start": self.range_start, "range_end": self.range_end})
310 ),
311 field_name,
312 )
313 return value
314
315
316 class FileIsReadableValidator(object):
317 def __call__(self, value, field_name):
318 value = os.path.normpath(value)
319 if not os.path.exists(value):
320 raise ConfigurationError("{} does not exist".format(value), field_name)
321 elif not os.path.isfile(value):
322 raise ConfigurationError("{} is not a file".format(value), field_name)
323 elif not os.access(value, os.R_OK):
324 raise ConfigurationError("{} is not readable".format(value), field_name)
325 return value
326
327
328 class EnumerationValidator(object):
329 """
330 Validator which ensures that a given config value is chosen from a list
331 of valid string options.
332 """
333
334 def __init__(self, valid_values, case_sensitive=False):
335 """
336 valid_values
337 List of valid string values for the config value
338 case_sensitive
339 Whether to compare case when comparing a value to the valid list.
340 Defaults to False (case-insensitive)
341 """
342 self.case_sensitive = case_sensitive
343 if case_sensitive:
344 self.valid_values = {s: s for s in valid_values}
345 else:
346 self.valid_values = {s.lower(): s for s in valid_values}
347
348 def __call__(self, value, field_name):
349 if self.case_sensitive:
350 ret = self.valid_values.get(value)
351 else:
352 ret = self.valid_values.get(value.lower())
353 if ret is None:
354 raise ConfigurationError(
355 "{} is not in the list of valid values: {}".format(value, list(self.valid_values.values())), field_name
356 )
357 return ret
358
359
360 def _log_level_callback(dict_key, old_value, new_value, config_instance):
361 elasticapm_logger = logging.getLogger("elasticapm")
362 elasticapm_logger.setLevel(log_levels_map.get(new_value, 100))
363
364 global logfile_set_up
365 if not logfile_set_up and config_instance.log_file:
366 logfile_set_up = True
367 filehandler = logging.handlers.RotatingFileHandler(
368 config_instance.log_file, maxBytes=config_instance.log_file_size, backupCount=1
369 )
370 try:
371 import ecs_logging
372
373 filehandler.setFormatter(ecs_logging.StdlibFormatter())
374 except ImportError:
375 pass
376 elasticapm_logger.addHandler(filehandler)
377
378
379 def _log_ecs_formatting_callback(dict_key, old_value, new_value, config_instance):
380 """
381 If ecs_logging is installed and log_ecs_formatting is set to "override", we should
382 set the ecs_logging.StdlibFormatter as the formatted for every handler in
383 the root logger, and set the default processor for structlog to the
384 ecs_logging.StructlogFormatter.
385 """
386 if new_value.lower() == "override":
387 try:
388 import ecs_logging
389 except ImportError:
390 return
391
392 # Stdlib
393 root_logger = logging.getLogger()
394 formatter = ecs_logging.StdlibFormatter()
395 for handler in root_logger.handlers:
396 handler.setFormatter(formatter)
397
398 # Structlog
399 try:
400 import structlog
401
402 structlog.configure(processors=[ecs_logging.StructlogFormatter()])
403 except ImportError:
404 pass
405
406
407 class _ConfigBase(object):
408 _NO_VALUE = object() # sentinel object
409
410 def __init__(self, config_dict=None, env_dict=None, inline_dict=None, copy=False):
411 """
412 config_dict
413 Configuration dict as is common for frameworks such as flask and django.
414 Keys match the _ConfigValue.dict_key (usually all caps)
415 env_dict
416 Environment variables dict. Keys match the _ConfigValue.env_key
417 (usually "ELASTIC_APM_" + dict_key)
418 inline_dict
419 Any config passed in as kwargs to the Client object. Typically
420 the keys match the names of the _ConfigValue variables in the Config
421 object.
422 copy
423 Whether this object is being created to copy an existing Config
424 object. If True, don't run the initial `update` (which would call
425 callbacks if present)
426 """
427 self._values = {}
428 self._errors = {}
429 self._dict_key_lookup = {}
430 self.callbacks_queue = []
431 for config_value in self.__class__.__dict__.values():
432 if not isinstance(config_value, _ConfigValue):
433 continue
434 self._dict_key_lookup[config_value.dict_key] = config_value
435 if not copy:
436 self.update(config_dict, env_dict, inline_dict, initial=True)
437
438 def update(self, config_dict=None, env_dict=None, inline_dict=None, initial=False):
439 if config_dict is None:
440 config_dict = {}
441 if env_dict is None:
442 env_dict = os.environ
443 if inline_dict is None:
444 inline_dict = {}
445 for field, config_value in compat.iteritems(self.__class__.__dict__):
446 if not isinstance(config_value, _ConfigValue):
447 continue
448 new_value = self._NO_VALUE
449 # first check environment
450 if config_value.env_key and config_value.env_key in env_dict:
451 new_value = env_dict[config_value.env_key]
452 # check the inline config
453 elif field in inline_dict:
454 new_value = inline_dict[field]
455 # finally, check config dictionary
456 elif config_value.dict_key in config_dict:
457 new_value = config_dict[config_value.dict_key]
458 # only set if new_value changed. We'll fall back to the field default if not.
459 if new_value is not self._NO_VALUE:
460 try:
461 setattr(self, field, new_value)
462 except ConfigurationError as e:
463 self._errors[e.field_name] = str(e)
464 # handle initial callbacks
465 if (
466 initial
467 and config_value.callbacks_on_default
468 and getattr(self, field) is not None
469 and getattr(self, field) == config_value.default
470 ):
471 self.callbacks_queue.append((config_value.dict_key, self._NO_VALUE, config_value.default))
472 # if a field has not been provided by any config source, we have to check separately if it is required
473 if config_value.required and getattr(self, field) is None:
474 self._errors[config_value.dict_key] = "Configuration error: value for {} is required.".format(
475 config_value.dict_key
476 )
477 self.call_pending_callbacks()
478
479 def call_pending_callbacks(self):
480 """
481 Call callbacks for config options matching list of tuples:
482
483 (dict_key, old_value, new_value)
484 """
485 for dict_key, old_value, new_value in self.callbacks_queue:
486 self._dict_key_lookup[dict_key].call_callbacks(old_value, new_value, self)
487 self.callbacks_queue = []
488
489 @property
490 def values(self):
491 return self._values
492
493 @values.setter
494 def values(self, values):
495 self._values = values
496
497 @property
498 def errors(self):
499 return self._errors
500
501 def copy(self):
502 c = self.__class__(copy=True)
503 c._errors = {}
504 c.values = self.values.copy()
505 return c
506
507
508 class Config(_ConfigBase):
509 service_name = _ConfigValue(
510 "SERVICE_NAME", validators=[RegexValidator("^[a-zA-Z0-9 _-]+$")], default="python_service", required=True
511 )
512 service_node_name = _ConfigValue("SERVICE_NODE_NAME")
513 environment = _ConfigValue("ENVIRONMENT")
514 secret_token = _ConfigValue("SECRET_TOKEN")
515 api_key = _ConfigValue("API_KEY")
516 debug = _BoolConfigValue("DEBUG", default=False)
517 server_url = _ConfigValue("SERVER_URL", default="http://localhost:8200", required=True)
518 server_cert = _ConfigValue("SERVER_CERT", validators=[FileIsReadableValidator()])
519 verify_server_cert = _BoolConfigValue("VERIFY_SERVER_CERT", default=True)
520 include_paths = _ListConfigValue("INCLUDE_PATHS")
521 exclude_paths = _ListConfigValue("EXCLUDE_PATHS", default=compat.get_default_library_patters())
522 filter_exception_types = _ListConfigValue("FILTER_EXCEPTION_TYPES")
523 server_timeout = _ConfigValue(
524 "SERVER_TIMEOUT",
525 type=float,
526 validators=[
527 UnitValidator(r"^((?:-)?\d+)(ms|s|m)?$", r"\d+(ms|s|m)", {"ms": 0.001, "s": 1, "m": 60, None: 1000})
528 ],
529 default=5,
530 )
531 hostname = _ConfigValue("HOSTNAME", default=socket.gethostname())
532 auto_log_stacks = _BoolConfigValue("AUTO_LOG_STACKS", default=True)
533 transport_class = _ConfigValue("TRANSPORT_CLASS", default="elasticapm.transport.http.Transport", required=True)
534 processors = _ListConfigValue(
535 "PROCESSORS",
536 default=[
537 "elasticapm.processors.sanitize_stacktrace_locals",
538 "elasticapm.processors.sanitize_http_request_cookies",
539 "elasticapm.processors.sanitize_http_response_cookies",
540 "elasticapm.processors.sanitize_http_headers",
541 "elasticapm.processors.sanitize_http_wsgi_env",
542 "elasticapm.processors.sanitize_http_request_body",
543 ],
544 )
545 sanitize_field_names = _ListConfigValue(
546 "SANITIZE_FIELD_NAMES", type=starmatch_to_regex, default=BASE_SANITIZE_FIELD_NAMES
547 )
548 metrics_sets = _ListConfigValue(
549 "METRICS_SETS",
550 default=[
551 "elasticapm.metrics.sets.cpu.CPUMetricSet",
552 "elasticapm.metrics.sets.transactions.TransactionsMetricSet",
553 ],
554 )
555 metrics_interval = _ConfigValue(
556 "METRICS_INTERVAL",
557 type=int,
558 validators=[duration_validator, ExcludeRangeValidator(1, 999, "{range_start} - {range_end} ms")],
559 default=30000,
560 )
561 breakdown_metrics = _BoolConfigValue("BREAKDOWN_METRICS", default=True)
562 prometheus_metrics = _BoolConfigValue("PROMETHEUS_METRICS", default=False)
563 prometheus_metrics_prefix = _ConfigValue("PROMETHEUS_METRICS_PREFIX", default="prometheus.metrics.")
564 disable_metrics = _ListConfigValue("DISABLE_METRICS", type=starmatch_to_regex, default=[])
565 central_config = _BoolConfigValue("CENTRAL_CONFIG", default=True)
566 api_request_size = _ConfigValue("API_REQUEST_SIZE", type=int, validators=[size_validator], default=768 * 1024)
567 api_request_time = _ConfigValue("API_REQUEST_TIME", type=int, validators=[duration_validator], default=10 * 1000)
568 transaction_sample_rate = _ConfigValue(
569 "TRANSACTION_SAMPLE_RATE", type=float, validators=[PrecisionValidator(4, 0.0001)], default=1.0
570 )
571 transaction_max_spans = _ConfigValue("TRANSACTION_MAX_SPANS", type=int, default=500)
572 stack_trace_limit = _ConfigValue("STACK_TRACE_LIMIT", type=int, default=500)
573 span_frames_min_duration = _ConfigValue(
574 "SPAN_FRAMES_MIN_DURATION",
575 default=5,
576 validators=[
577 UnitValidator(r"^((?:-)?\d+)(ms|s|m)?$", r"\d+(ms|s|m)", {"ms": 1, "s": 1000, "m": 60000, None: 1})
578 ],
579 type=int,
580 )
581 collect_local_variables = _ConfigValue("COLLECT_LOCAL_VARIABLES", default="errors")
582 source_lines_error_app_frames = _ConfigValue("SOURCE_LINES_ERROR_APP_FRAMES", type=int, default=5)
583 source_lines_error_library_frames = _ConfigValue("SOURCE_LINES_ERROR_LIBRARY_FRAMES", type=int, default=5)
584 source_lines_span_app_frames = _ConfigValue("SOURCE_LINES_SPAN_APP_FRAMES", type=int, default=0)
585 source_lines_span_library_frames = _ConfigValue("SOURCE_LINES_SPAN_LIBRARY_FRAMES", type=int, default=0)
586 local_var_max_length = _ConfigValue("LOCAL_VAR_MAX_LENGTH", type=int, default=200)
587 local_var_list_max_length = _ConfigValue("LOCAL_VAR_LIST_MAX_LENGTH", type=int, default=10)
588 local_var_dict_max_length = _ConfigValue("LOCAL_VAR_DICT_MAX_LENGTH", type=int, default=10)
589 capture_body = _ConfigValue(
590 "CAPTURE_BODY",
591 default="off",
592 validators=[lambda val, _: {"errors": "error", "transactions": "transaction"}.get(val, val)],
593 )
594 async_mode = _BoolConfigValue("ASYNC_MODE", default=True)
595 instrument_django_middleware = _BoolConfigValue("INSTRUMENT_DJANGO_MIDDLEWARE", default=True)
596 autoinsert_django_middleware = _BoolConfigValue("AUTOINSERT_DJANGO_MIDDLEWARE", default=True)
597 transactions_ignore_patterns = _ListConfigValue("TRANSACTIONS_IGNORE_PATTERNS", default=[])
598 transaction_ignore_urls = _ListConfigValue("TRANSACTION_IGNORE_URLS", type=starmatch_to_regex, default=[])
599 service_version = _ConfigValue("SERVICE_VERSION")
600 framework_name = _ConfigValue("FRAMEWORK_NAME")
601 framework_version = _ConfigValue("FRAMEWORK_VERSION")
602 global_labels = _DictConfigValue("GLOBAL_LABELS")
603 disable_send = _BoolConfigValue("DISABLE_SEND", default=False)
604 enabled = _BoolConfigValue("ENABLED", default=True)
605 recording = _BoolConfigValue("RECORDING", default=True)
606 instrument = _BoolConfigValue("INSTRUMENT", default=True)
607 enable_distributed_tracing = _BoolConfigValue("ENABLE_DISTRIBUTED_TRACING", default=True)
608 capture_headers = _BoolConfigValue("CAPTURE_HEADERS", default=True)
609 django_transaction_name_from_route = _BoolConfigValue("DJANGO_TRANSACTION_NAME_FROM_ROUTE", default=False)
610 disable_log_record_factory = _BoolConfigValue("DISABLE_LOG_RECORD_FACTORY", default=False)
611 use_elastic_traceparent_header = _BoolConfigValue("USE_ELASTIC_TRACEPARENT_HEADER", default=True)
612 use_elastic_excepthook = _BoolConfigValue("USE_ELASTIC_EXCEPTHOOK", default=False)
613 cloud_provider = _ConfigValue("CLOUD_PROVIDER", default=True)
614 log_level = _ConfigValue(
615 "LOG_LEVEL",
616 validators=[EnumerationValidator(["trace", "debug", "info", "warning", "warn", "error", "critical", "off"])],
617 callbacks=[_log_level_callback],
618 )
619 log_file = _ConfigValue("LOG_FILE", default="")
620 log_file_size = _ConfigValue("LOG_FILE_SIZE", validators=[size_validator], type=int, default=50 * 1024 * 1024)
621 log_ecs_formatting = _ConfigValue(
622 "LOG_ECS_FORMATTING",
623 validators=[EnumerationValidator(["off", "override"])],
624 callbacks=[_log_ecs_formatting_callback],
625 default="off",
626 )
627
628 @property
629 def is_recording(self):
630 if not self.enabled:
631 return False
632 else:
633 return self.recording
634
635
636 class VersionedConfig(ThreadManager):
637 """
638 A thin layer around Config that provides versioning
639 """
640
641 __slots__ = (
642 "_config",
643 "_version",
644 "_first_config",
645 "_first_version",
646 "_lock",
647 "transport",
648 "_update_thread",
649 "pid",
650 )
651
652 def __init__(self, config_object, version, transport=None):
653 """
654 Create a new VersionedConfig with an initial Config object
655 :param config_object: the initial Config object
656 :param version: a version identifier for the configuration
657 """
658 self._config = self._first_config = config_object
659 self._version = self._first_version = version
660 self.transport = transport
661 self._lock = threading.Lock()
662 self._update_thread = None
663 super(VersionedConfig, self).__init__()
664
665 def update(self, version, **config):
666 """
667 Update the configuration version
668 :param version: version identifier for the new configuration
669 :param config: a key/value map of new configuration
670 :return: configuration errors, if any
671 """
672 new_config = self._config.copy()
673
674 # pass an empty env dict to ensure the environment doesn't get precedence
675 new_config.update(inline_dict=config, env_dict={})
676 if not new_config.errors:
677 with self._lock:
678 self._version = version
679 self._config = new_config
680 else:
681 return new_config.errors
682
683 def reset(self):
684 """
685 Reset state to the original configuration
686
687 Note that because ConfigurationValues can have callbacks, we need to
688 note any differences between the original configuration and the most
689 recent configuration and run any callbacks that might exist for those
690 values.
691 """
692 callbacks = []
693 for key in compat.iterkeys(self._config.values):
694 if key in self._first_config.values and self._config.values[key] != self._first_config.values[key]:
695 callbacks.append((key, self._config.values[key], self._first_config.values[key]))
696
697 with self._lock:
698 self._version = self._first_version
699 self._config = self._first_config
700
701 self._config.callbacks_queue.extend(callbacks)
702 self._config.call_pending_callbacks()
703
704 @property
705 def changed(self):
706 return self._config != self._first_config
707
708 def __getattr__(self, item):
709 return getattr(self._config, item)
710
711 def __setattr__(self, name, value):
712 if name not in self.__slots__:
713 setattr(self._config, name, value)
714 else:
715 super(VersionedConfig, self).__setattr__(name, value)
716
717 @property
718 def config_version(self):
719 return self._version
720
721 def update_config(self):
722 if not self.transport:
723 logger.warning("No transport set for config updates, skipping")
724 return
725 logger.debug("Checking for new config...")
726 keys = {"service": {"name": self.service_name}}
727 if self.environment:
728 keys["service"]["environment"] = self.environment
729 new_version, new_config, next_run = self.transport.get_config(self.config_version, keys)
730 if new_version and new_config:
731 errors = self.update(new_version, **new_config)
732 if errors:
733 logger.error("Error applying new configuration: %s", repr(errors))
734 else:
735 logger.info(
736 "Applied new remote configuration: %s",
737 "; ".join(
738 "%s=%s" % (compat.text_type(k), compat.text_type(v)) for k, v in compat.iteritems(new_config)
739 ),
740 )
741 elif new_version == self.config_version:
742 logger.debug("Remote config unchanged")
743 elif not new_config and self.changed:
744 logger.debug("Remote config disappeared, resetting to original")
745 self.reset()
746
747 return next_run
748
749 def start_thread(self, pid=None):
750 self._update_thread = IntervalTimer(
751 self.update_config, 1, "eapm conf updater", daemon=True, evaluate_function_interval=True
752 )
753 self._update_thread.start()
754 super(VersionedConfig, self).start_thread(pid=pid)
755
756 def stop_thread(self):
757 if self._update_thread:
758 self._update_thread.cancel()
759 self._update_thread = None
760
761
762 def setup_logging(handler):
763 """
764 Configures logging to pipe to Elastic APM.
765
766 For a typical Python install:
767
768 >>> from elasticapm.handlers.logging import LoggingHandler
769 >>> client = ElasticAPM(...)
770 >>> setup_logging(LoggingHandler(client))
771
772 Within Django:
773
774 >>> from elasticapm.contrib.django.handlers import LoggingHandler
775 >>> setup_logging(LoggingHandler())
776
777 Returns a boolean based on if logging was configured or not.
778 """
779 # TODO We should probably revisit this. Does it make more sense as
780 # a method within the Client class? The Client object could easily
781 # pass itself into LoggingHandler and we could eliminate args altogether.
782 logger = logging.getLogger()
783 if handler.__class__ in map(type, logger.handlers):
784 return False
785
786 logger.addHandler(handler)
787
788 return True
789
```
--- 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/elasticapm/conf/__init__.py b/elasticapm/conf/__init__.py
--- a/elasticapm/conf/__init__.py
+++ b/elasticapm/conf/__init__.py
@@ -647,6 +647,7 @@
"transport",
"_update_thread",
"pid",
+ "start_stop_order",
)
def __init__(self, config_object, version, transport=None):
| {"golden_diff": "diff --git a/elasticapm/conf/__init__.py b/elasticapm/conf/__init__.py\n--- a/elasticapm/conf/__init__.py\n+++ b/elasticapm/conf/__init__.py\n@@ -647,6 +647,7 @@\n \"transport\",\n \"_update_thread\",\n \"pid\",\n+ \"start_stop_order\",\n )\n \n def __init__(self, config_object, version, transport=None):\n", "issue": "AttributeError: 'Config' object has no attribute 'start_stop_order'\n# Error\r\nWe started seeing this traceback via Sentry coming from the elasticapm agent with the Django integration after upgrading from 6.1.3 to 6.2.0:\r\n\r\n```\r\nAttributeError: 'Config' object has no attribute 'start_stop_order'\r\n File \"elasticapm/instrumentation/packages/dbapi2.py\", line 276, in call_if_sampling\r\n return self.call(module, method, wrapped, instance, args, kwargs)\r\n File \"elasticapm/instrumentation/packages/psycopg2.py\", line 104, in call\r\n return PGConnectionProxy(wrapped(*args, **kwargs), destination_info=destination_info)\r\n File \"elasticapm/traces.py\", line 709, in __exit__\r\n span = transaction.end_span(self.skip_frames, duration=self.duration, outcome=outcome)\r\n File \"elasticapm/traces.py\", line 293, in end_span\r\n span.end(skip_frames=skip_frames, duration=duration)\r\n File \"elasticapm/traces.py\", line 484, in end\r\n tracer.queue_func(SPAN, self.to_dict())\r\n File \"elasticapm/base.py\", line 275, in queue\r\n self.start_threads()\r\n File \"elasticapm/base.py\", line 220, in start_threads\r\n for manager_type, manager in sorted(\r\n File \"elasticapm/base.py\", line 221, in <lambda>\r\n self._thread_managers.items(), key=lambda item: item[1].start_stop_order\r\n File \"elasticapm/conf/__init__.py\", line 709, in __getattr__\r\n return getattr(self._config, item)\r\n```\r\n\r\n# Environment\r\n\r\nOS: Linux\r\nPython version: 3.8.9\r\nFramework and version [e.g. Django 2.1]: Django 3.1.10\r\nAPM Server version: 7.6\r\nAgent version: 6.2.0\r\n\r\n# Additional context\r\n\r\nI think the bug was introduced in https://github.com/elastic/apm-agent-python/pull/1139/files.\r\n\r\nThe change sorts `self._thread_managers.items()` by the `start_stop_order` of each dict item.\r\n`self._thread_managers['config']` is an instance of [`VersionedConfig`](https://github.com/elastic/apm-agent-python/blob/master/elasticapm/conf/__init__.py#L636), which inherits [`ThreadManager`](https://github.com/elastic/apm-agent-python/blob/c5fe64662f971f26deb200b4619860c363b3e483/elasticapm/utils/threading.py#L98) where this attribute is set. But the `__getattr__` method of `VersionedConfig` [is overriden](https://github.com/elastic/apm-agent-python/blob/master/elasticapm/conf/__init__.py#L708) to instead fetch the item from `VersionedConfig._config`, which is a [`Config`](https://github.com/elastic/apm-agent-python/blob/master/elasticapm/conf/__init__.py#L508) object and doesn't have the attribute `start_stop_order`.\r\n\n", "before_files": [{"content": "# BSD 3-Clause License\n#\n# Copyright (c) 2012, the Sentry Team, see AUTHORS for more details\n# Copyright (c) 2019, Elasticsearch BV\n# All rights reserved.\n#\n# Redistribution and use in source and binary forms, with or without\n# modification, are permitted provided that the following conditions are met:\n#\n# * Redistributions of source code must retain the above copyright notice, this\n# list of conditions and the following disclaimer.\n#\n# * Redistributions in binary form must reproduce the above copyright notice,\n# this list of conditions and the following disclaimer in the documentation\n# and/or other materials provided with the distribution.\n#\n# * Neither the name of the copyright holder nor the names of its\n# contributors may be used to endorse or promote products derived from\n# this software without specific prior written permission.\n#\n# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n\n\nimport logging\nimport logging.handlers\nimport math\nimport os\nimport re\nimport socket\nimport threading\n\nfrom elasticapm.conf.constants import BASE_SANITIZE_FIELD_NAMES\nfrom elasticapm.utils import compat, starmatch_to_regex\nfrom elasticapm.utils.logging import get_logger\nfrom elasticapm.utils.threading import IntervalTimer, ThreadManager\n\n__all__ = (\"setup_logging\", \"Config\")\n\n\nlogger = get_logger(\"elasticapm.conf\")\n\nlog_levels_map = {\n \"trace\": 5,\n \"debug\": logging.DEBUG,\n \"info\": logging.INFO,\n \"warning\": logging.WARNING,\n \"warn\": logging.WARNING,\n \"error\": logging.ERROR,\n \"critical\": logging.CRITICAL,\n \"off\": 1000,\n}\nlogfile_set_up = False\n\n\nclass ConfigurationError(ValueError):\n def __init__(self, msg, field_name):\n self.field_name = field_name\n super(ValueError, self).__init__(msg)\n\n\nclass _ConfigValue(object):\n \"\"\"\n Base class for configuration values\n\n dict_key\n String representing the key used for this config value in dict configs.\n env_key\n String representing the key used in environment variables for this\n config value. If not specified, will be set to `\"ELASTIC_APM_\" + dict_key`.\n type\n Type of value stored in this config value.\n validators\n List of validator classes. Must be callables, which will be called with\n a value and the dict_key for the config value. The validator either\n returns the validated value or raises a ConfigurationError if validation\n fails.\n callbacks\n List of functions which will be called when the config value is updated.\n The callbacks must match this signature:\n callback(dict_key, old_value, new_value, config_instance)\n\n Note that callbacks wait until the end of any given `update()` operation\n and are called at this point. This, coupled with the fact that callbacks\n receive the config instance, means that callbacks can utilize multiple\n configuration values (such as is the case for logging). This is\n complicated if more than one of the involved config values are\n dynamic, as both would need callbacks and the callback would need to\n be idempotent.\n callbacks_on_default\n Whether the callback should be called on config initialization if the\n default value is used. Default: True\n default\n The default for this config value if not user-configured.\n required\n Whether this config value is required. If a default is specified,\n this is a redundant option (except to ensure that this config value\n is specified if a default were ever to be removed).\n\n Note that _ConfigValues and any inheriting classes must implement __set__\n and __get__. The calling instance will always be a _ConfigBase descendant\n and the __set__ and __get__ calls will access `instance._values[self.dict_key]`\n to get and set values.\n \"\"\"\n\n def __init__(\n self,\n dict_key,\n env_key=None,\n type=compat.text_type,\n validators=None,\n callbacks=None,\n callbacks_on_default=True,\n default=None,\n required=False,\n ):\n self.type = type\n self.dict_key = dict_key\n self.validators = validators\n self.callbacks = callbacks\n self.default = default\n self.required = required\n if env_key is None:\n env_key = \"ELASTIC_APM_\" + dict_key\n self.env_key = env_key\n self.callbacks_on_default = callbacks_on_default\n\n def __get__(self, instance, owner):\n if instance:\n return instance._values.get(self.dict_key, self.default)\n else:\n return self.default\n\n def __set__(self, config_instance, value):\n value = self._validate(config_instance, value)\n self._callback_if_changed(config_instance, value)\n config_instance._values[self.dict_key] = value\n\n def _validate(self, instance, value):\n if value is None and self.required:\n raise ConfigurationError(\n \"Configuration error: value for {} is required.\".format(self.dict_key), self.dict_key\n )\n if self.validators and value is not None:\n for validator in self.validators:\n value = validator(value, self.dict_key)\n if self.type and value is not None:\n try:\n value = self.type(value)\n except ValueError as e:\n raise ConfigurationError(\"{}: {}\".format(self.dict_key, compat.text_type(e)), self.dict_key)\n instance._errors.pop(self.dict_key, None)\n return value\n\n def _callback_if_changed(self, instance, new_value):\n \"\"\"\n If the value changed (checked against instance._values[self.dict_key]),\n then run the callback function (if defined)\n \"\"\"\n old_value = instance._values.get(self.dict_key, self.default)\n if old_value != new_value:\n instance.callbacks_queue.append((self.dict_key, old_value, new_value))\n\n def call_callbacks(self, old_value, new_value, config_instance):\n if not self.callbacks:\n return\n for callback in self.callbacks:\n try:\n callback(self.dict_key, old_value, new_value, config_instance)\n except Exception as e:\n raise ConfigurationError(\n \"Callback {} raised an exception when setting {} to {}: {}\".format(\n callback, self.dict_key, new_value, e\n ),\n self.dict_key,\n )\n\n\nclass _ListConfigValue(_ConfigValue):\n def __init__(self, dict_key, list_separator=\",\", **kwargs):\n self.list_separator = list_separator\n super(_ListConfigValue, self).__init__(dict_key, **kwargs)\n\n def __set__(self, instance, value):\n if isinstance(value, compat.string_types):\n value = value.split(self.list_separator)\n elif value is not None:\n value = list(value)\n if value:\n value = [self.type(item) for item in value]\n self._callback_if_changed(instance, value)\n instance._values[self.dict_key] = value\n\n\nclass _DictConfigValue(_ConfigValue):\n def __init__(self, dict_key, item_separator=\",\", keyval_separator=\"=\", **kwargs):\n self.item_separator = item_separator\n self.keyval_separator = keyval_separator\n super(_DictConfigValue, self).__init__(dict_key, **kwargs)\n\n def __set__(self, instance, value):\n if isinstance(value, compat.string_types):\n items = (item.split(self.keyval_separator) for item in value.split(self.item_separator))\n value = {key.strip(): self.type(val.strip()) for key, val in items}\n elif not isinstance(value, dict):\n # TODO: better error handling\n value = None\n self._callback_if_changed(instance, value)\n instance._values[self.dict_key] = value\n\n\nclass _BoolConfigValue(_ConfigValue):\n def __init__(self, dict_key, true_string=\"true\", false_string=\"false\", **kwargs):\n self.true_string = true_string\n self.false_string = false_string\n super(_BoolConfigValue, self).__init__(dict_key, **kwargs)\n\n def __set__(self, instance, value):\n if isinstance(value, compat.string_types):\n if value.lower() == self.true_string:\n value = True\n elif value.lower() == self.false_string:\n value = False\n self._callback_if_changed(instance, value)\n instance._values[self.dict_key] = bool(value)\n\n\nclass RegexValidator(object):\n def __init__(self, regex, verbose_pattern=None):\n self.regex = regex\n self.verbose_pattern = verbose_pattern or regex\n\n def __call__(self, value, field_name):\n value = compat.text_type(value)\n match = re.match(self.regex, value)\n if match:\n return value\n raise ConfigurationError(\"{} does not match pattern {}\".format(value, self.verbose_pattern), field_name)\n\n\nclass UnitValidator(object):\n def __init__(self, regex, verbose_pattern, unit_multipliers):\n self.regex = regex\n self.verbose_pattern = verbose_pattern\n self.unit_multipliers = unit_multipliers\n\n def __call__(self, value, field_name):\n value = compat.text_type(value)\n match = re.match(self.regex, value, re.IGNORECASE)\n if not match:\n raise ConfigurationError(\"{} does not match pattern {}\".format(value, self.verbose_pattern), field_name)\n val, unit = match.groups()\n try:\n val = int(val) * self.unit_multipliers[unit]\n except KeyError:\n raise ConfigurationError(\"{} is not a supported unit\".format(unit), field_name)\n return val\n\n\nclass PrecisionValidator(object):\n \"\"\"\n Forces a float value to `precision` digits of precision.\n\n Rounds half away from zero.\n\n If `minimum` is provided, and the value rounds to 0 (but was not zero to\n begin with), use the minimum instead.\n \"\"\"\n\n def __init__(self, precision=0, minimum=None):\n self.precision = precision\n self.minimum = minimum\n\n def __call__(self, value, field_name):\n try:\n value = float(value)\n except ValueError:\n raise ConfigurationError(\"{} is not a float\".format(value), field_name)\n multiplier = 10 ** self.precision\n rounded = math.floor(value * multiplier + 0.5) / multiplier\n if rounded == 0 and self.minimum and value != 0:\n rounded = self.minimum\n return rounded\n\n\nduration_validator = UnitValidator(r\"^((?:-)?\\d+)(ms|s|m)$\", r\"\\d+(ms|s|m)\", {\"ms\": 1, \"s\": 1000, \"m\": 60000})\nsize_validator = UnitValidator(\n r\"^(\\d+)(b|kb|mb|gb)$\", r\"\\d+(b|KB|MB|GB)\", {\"b\": 1, \"kb\": 1024, \"mb\": 1024 * 1024, \"gb\": 1024 * 1024 * 1024}\n)\n\n\nclass ExcludeRangeValidator(object):\n def __init__(self, range_start, range_end, range_desc):\n self.range_start = range_start\n self.range_end = range_end\n self.range_desc = range_desc\n\n def __call__(self, value, field_name):\n if self.range_start <= value <= self.range_end:\n raise ConfigurationError(\n \"{} cannot be in range: {}\".format(\n value, self.range_desc.format(**{\"range_start\": self.range_start, \"range_end\": self.range_end})\n ),\n field_name,\n )\n return value\n\n\nclass FileIsReadableValidator(object):\n def __call__(self, value, field_name):\n value = os.path.normpath(value)\n if not os.path.exists(value):\n raise ConfigurationError(\"{} does not exist\".format(value), field_name)\n elif not os.path.isfile(value):\n raise ConfigurationError(\"{} is not a file\".format(value), field_name)\n elif not os.access(value, os.R_OK):\n raise ConfigurationError(\"{} is not readable\".format(value), field_name)\n return value\n\n\nclass EnumerationValidator(object):\n \"\"\"\n Validator which ensures that a given config value is chosen from a list\n of valid string options.\n \"\"\"\n\n def __init__(self, valid_values, case_sensitive=False):\n \"\"\"\n valid_values\n List of valid string values for the config value\n case_sensitive\n Whether to compare case when comparing a value to the valid list.\n Defaults to False (case-insensitive)\n \"\"\"\n self.case_sensitive = case_sensitive\n if case_sensitive:\n self.valid_values = {s: s for s in valid_values}\n else:\n self.valid_values = {s.lower(): s for s in valid_values}\n\n def __call__(self, value, field_name):\n if self.case_sensitive:\n ret = self.valid_values.get(value)\n else:\n ret = self.valid_values.get(value.lower())\n if ret is None:\n raise ConfigurationError(\n \"{} is not in the list of valid values: {}\".format(value, list(self.valid_values.values())), field_name\n )\n return ret\n\n\ndef _log_level_callback(dict_key, old_value, new_value, config_instance):\n elasticapm_logger = logging.getLogger(\"elasticapm\")\n elasticapm_logger.setLevel(log_levels_map.get(new_value, 100))\n\n global logfile_set_up\n if not logfile_set_up and config_instance.log_file:\n logfile_set_up = True\n filehandler = logging.handlers.RotatingFileHandler(\n config_instance.log_file, maxBytes=config_instance.log_file_size, backupCount=1\n )\n try:\n import ecs_logging\n\n filehandler.setFormatter(ecs_logging.StdlibFormatter())\n except ImportError:\n pass\n elasticapm_logger.addHandler(filehandler)\n\n\ndef _log_ecs_formatting_callback(dict_key, old_value, new_value, config_instance):\n \"\"\"\n If ecs_logging is installed and log_ecs_formatting is set to \"override\", we should\n set the ecs_logging.StdlibFormatter as the formatted for every handler in\n the root logger, and set the default processor for structlog to the\n ecs_logging.StructlogFormatter.\n \"\"\"\n if new_value.lower() == \"override\":\n try:\n import ecs_logging\n except ImportError:\n return\n\n # Stdlib\n root_logger = logging.getLogger()\n formatter = ecs_logging.StdlibFormatter()\n for handler in root_logger.handlers:\n handler.setFormatter(formatter)\n\n # Structlog\n try:\n import structlog\n\n structlog.configure(processors=[ecs_logging.StructlogFormatter()])\n except ImportError:\n pass\n\n\nclass _ConfigBase(object):\n _NO_VALUE = object() # sentinel object\n\n def __init__(self, config_dict=None, env_dict=None, inline_dict=None, copy=False):\n \"\"\"\n config_dict\n Configuration dict as is common for frameworks such as flask and django.\n Keys match the _ConfigValue.dict_key (usually all caps)\n env_dict\n Environment variables dict. Keys match the _ConfigValue.env_key\n (usually \"ELASTIC_APM_\" + dict_key)\n inline_dict\n Any config passed in as kwargs to the Client object. Typically\n the keys match the names of the _ConfigValue variables in the Config\n object.\n copy\n Whether this object is being created to copy an existing Config\n object. If True, don't run the initial `update` (which would call\n callbacks if present)\n \"\"\"\n self._values = {}\n self._errors = {}\n self._dict_key_lookup = {}\n self.callbacks_queue = []\n for config_value in self.__class__.__dict__.values():\n if not isinstance(config_value, _ConfigValue):\n continue\n self._dict_key_lookup[config_value.dict_key] = config_value\n if not copy:\n self.update(config_dict, env_dict, inline_dict, initial=True)\n\n def update(self, config_dict=None, env_dict=None, inline_dict=None, initial=False):\n if config_dict is None:\n config_dict = {}\n if env_dict is None:\n env_dict = os.environ\n if inline_dict is None:\n inline_dict = {}\n for field, config_value in compat.iteritems(self.__class__.__dict__):\n if not isinstance(config_value, _ConfigValue):\n continue\n new_value = self._NO_VALUE\n # first check environment\n if config_value.env_key and config_value.env_key in env_dict:\n new_value = env_dict[config_value.env_key]\n # check the inline config\n elif field in inline_dict:\n new_value = inline_dict[field]\n # finally, check config dictionary\n elif config_value.dict_key in config_dict:\n new_value = config_dict[config_value.dict_key]\n # only set if new_value changed. We'll fall back to the field default if not.\n if new_value is not self._NO_VALUE:\n try:\n setattr(self, field, new_value)\n except ConfigurationError as e:\n self._errors[e.field_name] = str(e)\n # handle initial callbacks\n if (\n initial\n and config_value.callbacks_on_default\n and getattr(self, field) is not None\n and getattr(self, field) == config_value.default\n ):\n self.callbacks_queue.append((config_value.dict_key, self._NO_VALUE, config_value.default))\n # if a field has not been provided by any config source, we have to check separately if it is required\n if config_value.required and getattr(self, field) is None:\n self._errors[config_value.dict_key] = \"Configuration error: value for {} is required.\".format(\n config_value.dict_key\n )\n self.call_pending_callbacks()\n\n def call_pending_callbacks(self):\n \"\"\"\n Call callbacks for config options matching list of tuples:\n\n (dict_key, old_value, new_value)\n \"\"\"\n for dict_key, old_value, new_value in self.callbacks_queue:\n self._dict_key_lookup[dict_key].call_callbacks(old_value, new_value, self)\n self.callbacks_queue = []\n\n @property\n def values(self):\n return self._values\n\n @values.setter\n def values(self, values):\n self._values = values\n\n @property\n def errors(self):\n return self._errors\n\n def copy(self):\n c = self.__class__(copy=True)\n c._errors = {}\n c.values = self.values.copy()\n return c\n\n\nclass Config(_ConfigBase):\n service_name = _ConfigValue(\n \"SERVICE_NAME\", validators=[RegexValidator(\"^[a-zA-Z0-9 _-]+$\")], default=\"python_service\", required=True\n )\n service_node_name = _ConfigValue(\"SERVICE_NODE_NAME\")\n environment = _ConfigValue(\"ENVIRONMENT\")\n secret_token = _ConfigValue(\"SECRET_TOKEN\")\n api_key = _ConfigValue(\"API_KEY\")\n debug = _BoolConfigValue(\"DEBUG\", default=False)\n server_url = _ConfigValue(\"SERVER_URL\", default=\"http://localhost:8200\", required=True)\n server_cert = _ConfigValue(\"SERVER_CERT\", validators=[FileIsReadableValidator()])\n verify_server_cert = _BoolConfigValue(\"VERIFY_SERVER_CERT\", default=True)\n include_paths = _ListConfigValue(\"INCLUDE_PATHS\")\n exclude_paths = _ListConfigValue(\"EXCLUDE_PATHS\", default=compat.get_default_library_patters())\n filter_exception_types = _ListConfigValue(\"FILTER_EXCEPTION_TYPES\")\n server_timeout = _ConfigValue(\n \"SERVER_TIMEOUT\",\n type=float,\n validators=[\n UnitValidator(r\"^((?:-)?\\d+)(ms|s|m)?$\", r\"\\d+(ms|s|m)\", {\"ms\": 0.001, \"s\": 1, \"m\": 60, None: 1000})\n ],\n default=5,\n )\n hostname = _ConfigValue(\"HOSTNAME\", default=socket.gethostname())\n auto_log_stacks = _BoolConfigValue(\"AUTO_LOG_STACKS\", default=True)\n transport_class = _ConfigValue(\"TRANSPORT_CLASS\", default=\"elasticapm.transport.http.Transport\", required=True)\n processors = _ListConfigValue(\n \"PROCESSORS\",\n default=[\n \"elasticapm.processors.sanitize_stacktrace_locals\",\n \"elasticapm.processors.sanitize_http_request_cookies\",\n \"elasticapm.processors.sanitize_http_response_cookies\",\n \"elasticapm.processors.sanitize_http_headers\",\n \"elasticapm.processors.sanitize_http_wsgi_env\",\n \"elasticapm.processors.sanitize_http_request_body\",\n ],\n )\n sanitize_field_names = _ListConfigValue(\n \"SANITIZE_FIELD_NAMES\", type=starmatch_to_regex, default=BASE_SANITIZE_FIELD_NAMES\n )\n metrics_sets = _ListConfigValue(\n \"METRICS_SETS\",\n default=[\n \"elasticapm.metrics.sets.cpu.CPUMetricSet\",\n \"elasticapm.metrics.sets.transactions.TransactionsMetricSet\",\n ],\n )\n metrics_interval = _ConfigValue(\n \"METRICS_INTERVAL\",\n type=int,\n validators=[duration_validator, ExcludeRangeValidator(1, 999, \"{range_start} - {range_end} ms\")],\n default=30000,\n )\n breakdown_metrics = _BoolConfigValue(\"BREAKDOWN_METRICS\", default=True)\n prometheus_metrics = _BoolConfigValue(\"PROMETHEUS_METRICS\", default=False)\n prometheus_metrics_prefix = _ConfigValue(\"PROMETHEUS_METRICS_PREFIX\", default=\"prometheus.metrics.\")\n disable_metrics = _ListConfigValue(\"DISABLE_METRICS\", type=starmatch_to_regex, default=[])\n central_config = _BoolConfigValue(\"CENTRAL_CONFIG\", default=True)\n api_request_size = _ConfigValue(\"API_REQUEST_SIZE\", type=int, validators=[size_validator], default=768 * 1024)\n api_request_time = _ConfigValue(\"API_REQUEST_TIME\", type=int, validators=[duration_validator], default=10 * 1000)\n transaction_sample_rate = _ConfigValue(\n \"TRANSACTION_SAMPLE_RATE\", type=float, validators=[PrecisionValidator(4, 0.0001)], default=1.0\n )\n transaction_max_spans = _ConfigValue(\"TRANSACTION_MAX_SPANS\", type=int, default=500)\n stack_trace_limit = _ConfigValue(\"STACK_TRACE_LIMIT\", type=int, default=500)\n span_frames_min_duration = _ConfigValue(\n \"SPAN_FRAMES_MIN_DURATION\",\n default=5,\n validators=[\n UnitValidator(r\"^((?:-)?\\d+)(ms|s|m)?$\", r\"\\d+(ms|s|m)\", {\"ms\": 1, \"s\": 1000, \"m\": 60000, None: 1})\n ],\n type=int,\n )\n collect_local_variables = _ConfigValue(\"COLLECT_LOCAL_VARIABLES\", default=\"errors\")\n source_lines_error_app_frames = _ConfigValue(\"SOURCE_LINES_ERROR_APP_FRAMES\", type=int, default=5)\n source_lines_error_library_frames = _ConfigValue(\"SOURCE_LINES_ERROR_LIBRARY_FRAMES\", type=int, default=5)\n source_lines_span_app_frames = _ConfigValue(\"SOURCE_LINES_SPAN_APP_FRAMES\", type=int, default=0)\n source_lines_span_library_frames = _ConfigValue(\"SOURCE_LINES_SPAN_LIBRARY_FRAMES\", type=int, default=0)\n local_var_max_length = _ConfigValue(\"LOCAL_VAR_MAX_LENGTH\", type=int, default=200)\n local_var_list_max_length = _ConfigValue(\"LOCAL_VAR_LIST_MAX_LENGTH\", type=int, default=10)\n local_var_dict_max_length = _ConfigValue(\"LOCAL_VAR_DICT_MAX_LENGTH\", type=int, default=10)\n capture_body = _ConfigValue(\n \"CAPTURE_BODY\",\n default=\"off\",\n validators=[lambda val, _: {\"errors\": \"error\", \"transactions\": \"transaction\"}.get(val, val)],\n )\n async_mode = _BoolConfigValue(\"ASYNC_MODE\", default=True)\n instrument_django_middleware = _BoolConfigValue(\"INSTRUMENT_DJANGO_MIDDLEWARE\", default=True)\n autoinsert_django_middleware = _BoolConfigValue(\"AUTOINSERT_DJANGO_MIDDLEWARE\", default=True)\n transactions_ignore_patterns = _ListConfigValue(\"TRANSACTIONS_IGNORE_PATTERNS\", default=[])\n transaction_ignore_urls = _ListConfigValue(\"TRANSACTION_IGNORE_URLS\", type=starmatch_to_regex, default=[])\n service_version = _ConfigValue(\"SERVICE_VERSION\")\n framework_name = _ConfigValue(\"FRAMEWORK_NAME\")\n framework_version = _ConfigValue(\"FRAMEWORK_VERSION\")\n global_labels = _DictConfigValue(\"GLOBAL_LABELS\")\n disable_send = _BoolConfigValue(\"DISABLE_SEND\", default=False)\n enabled = _BoolConfigValue(\"ENABLED\", default=True)\n recording = _BoolConfigValue(\"RECORDING\", default=True)\n instrument = _BoolConfigValue(\"INSTRUMENT\", default=True)\n enable_distributed_tracing = _BoolConfigValue(\"ENABLE_DISTRIBUTED_TRACING\", default=True)\n capture_headers = _BoolConfigValue(\"CAPTURE_HEADERS\", default=True)\n django_transaction_name_from_route = _BoolConfigValue(\"DJANGO_TRANSACTION_NAME_FROM_ROUTE\", default=False)\n disable_log_record_factory = _BoolConfigValue(\"DISABLE_LOG_RECORD_FACTORY\", default=False)\n use_elastic_traceparent_header = _BoolConfigValue(\"USE_ELASTIC_TRACEPARENT_HEADER\", default=True)\n use_elastic_excepthook = _BoolConfigValue(\"USE_ELASTIC_EXCEPTHOOK\", default=False)\n cloud_provider = _ConfigValue(\"CLOUD_PROVIDER\", default=True)\n log_level = _ConfigValue(\n \"LOG_LEVEL\",\n validators=[EnumerationValidator([\"trace\", \"debug\", \"info\", \"warning\", \"warn\", \"error\", \"critical\", \"off\"])],\n callbacks=[_log_level_callback],\n )\n log_file = _ConfigValue(\"LOG_FILE\", default=\"\")\n log_file_size = _ConfigValue(\"LOG_FILE_SIZE\", validators=[size_validator], type=int, default=50 * 1024 * 1024)\n log_ecs_formatting = _ConfigValue(\n \"LOG_ECS_FORMATTING\",\n validators=[EnumerationValidator([\"off\", \"override\"])],\n callbacks=[_log_ecs_formatting_callback],\n default=\"off\",\n )\n\n @property\n def is_recording(self):\n if not self.enabled:\n return False\n else:\n return self.recording\n\n\nclass VersionedConfig(ThreadManager):\n \"\"\"\n A thin layer around Config that provides versioning\n \"\"\"\n\n __slots__ = (\n \"_config\",\n \"_version\",\n \"_first_config\",\n \"_first_version\",\n \"_lock\",\n \"transport\",\n \"_update_thread\",\n \"pid\",\n )\n\n def __init__(self, config_object, version, transport=None):\n \"\"\"\n Create a new VersionedConfig with an initial Config object\n :param config_object: the initial Config object\n :param version: a version identifier for the configuration\n \"\"\"\n self._config = self._first_config = config_object\n self._version = self._first_version = version\n self.transport = transport\n self._lock = threading.Lock()\n self._update_thread = None\n super(VersionedConfig, self).__init__()\n\n def update(self, version, **config):\n \"\"\"\n Update the configuration version\n :param version: version identifier for the new configuration\n :param config: a key/value map of new configuration\n :return: configuration errors, if any\n \"\"\"\n new_config = self._config.copy()\n\n # pass an empty env dict to ensure the environment doesn't get precedence\n new_config.update(inline_dict=config, env_dict={})\n if not new_config.errors:\n with self._lock:\n self._version = version\n self._config = new_config\n else:\n return new_config.errors\n\n def reset(self):\n \"\"\"\n Reset state to the original configuration\n\n Note that because ConfigurationValues can have callbacks, we need to\n note any differences between the original configuration and the most\n recent configuration and run any callbacks that might exist for those\n values.\n \"\"\"\n callbacks = []\n for key in compat.iterkeys(self._config.values):\n if key in self._first_config.values and self._config.values[key] != self._first_config.values[key]:\n callbacks.append((key, self._config.values[key], self._first_config.values[key]))\n\n with self._lock:\n self._version = self._first_version\n self._config = self._first_config\n\n self._config.callbacks_queue.extend(callbacks)\n self._config.call_pending_callbacks()\n\n @property\n def changed(self):\n return self._config != self._first_config\n\n def __getattr__(self, item):\n return getattr(self._config, item)\n\n def __setattr__(self, name, value):\n if name not in self.__slots__:\n setattr(self._config, name, value)\n else:\n super(VersionedConfig, self).__setattr__(name, value)\n\n @property\n def config_version(self):\n return self._version\n\n def update_config(self):\n if not self.transport:\n logger.warning(\"No transport set for config updates, skipping\")\n return\n logger.debug(\"Checking for new config...\")\n keys = {\"service\": {\"name\": self.service_name}}\n if self.environment:\n keys[\"service\"][\"environment\"] = self.environment\n new_version, new_config, next_run = self.transport.get_config(self.config_version, keys)\n if new_version and new_config:\n errors = self.update(new_version, **new_config)\n if errors:\n logger.error(\"Error applying new configuration: %s\", repr(errors))\n else:\n logger.info(\n \"Applied new remote configuration: %s\",\n \"; \".join(\n \"%s=%s\" % (compat.text_type(k), compat.text_type(v)) for k, v in compat.iteritems(new_config)\n ),\n )\n elif new_version == self.config_version:\n logger.debug(\"Remote config unchanged\")\n elif not new_config and self.changed:\n logger.debug(\"Remote config disappeared, resetting to original\")\n self.reset()\n\n return next_run\n\n def start_thread(self, pid=None):\n self._update_thread = IntervalTimer(\n self.update_config, 1, \"eapm conf updater\", daemon=True, evaluate_function_interval=True\n )\n self._update_thread.start()\n super(VersionedConfig, self).start_thread(pid=pid)\n\n def stop_thread(self):\n if self._update_thread:\n self._update_thread.cancel()\n self._update_thread = None\n\n\ndef setup_logging(handler):\n \"\"\"\n Configures logging to pipe to Elastic APM.\n\n For a typical Python install:\n\n >>> from elasticapm.handlers.logging import LoggingHandler\n >>> client = ElasticAPM(...)\n >>> setup_logging(LoggingHandler(client))\n\n Within Django:\n\n >>> from elasticapm.contrib.django.handlers import LoggingHandler\n >>> setup_logging(LoggingHandler())\n\n Returns a boolean based on if logging was configured or not.\n \"\"\"\n # TODO We should probably revisit this. Does it make more sense as\n # a method within the Client class? The Client object could easily\n # pass itself into LoggingHandler and we could eliminate args altogether.\n logger = logging.getLogger()\n if handler.__class__ in map(type, logger.handlers):\n return False\n\n logger.addHandler(handler)\n\n return True\n", "path": "elasticapm/conf/__init__.py"}], "after_files": [{"content": "# BSD 3-Clause License\n#\n# Copyright (c) 2012, the Sentry Team, see AUTHORS for more details\n# Copyright (c) 2019, Elasticsearch BV\n# All rights reserved.\n#\n# Redistribution and use in source and binary forms, with or without\n# modification, are permitted provided that the following conditions are met:\n#\n# * Redistributions of source code must retain the above copyright notice, this\n# list of conditions and the following disclaimer.\n#\n# * Redistributions in binary form must reproduce the above copyright notice,\n# this list of conditions and the following disclaimer in the documentation\n# and/or other materials provided with the distribution.\n#\n# * Neither the name of the copyright holder nor the names of its\n# contributors may be used to endorse or promote products derived from\n# this software without specific prior written permission.\n#\n# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n\n\nimport logging\nimport logging.handlers\nimport math\nimport os\nimport re\nimport socket\nimport threading\n\nfrom elasticapm.conf.constants import BASE_SANITIZE_FIELD_NAMES\nfrom elasticapm.utils import compat, starmatch_to_regex\nfrom elasticapm.utils.logging import get_logger\nfrom elasticapm.utils.threading import IntervalTimer, ThreadManager\n\n__all__ = (\"setup_logging\", \"Config\")\n\n\nlogger = get_logger(\"elasticapm.conf\")\n\nlog_levels_map = {\n \"trace\": 5,\n \"debug\": logging.DEBUG,\n \"info\": logging.INFO,\n \"warning\": logging.WARNING,\n \"warn\": logging.WARNING,\n \"error\": logging.ERROR,\n \"critical\": logging.CRITICAL,\n \"off\": 1000,\n}\nlogfile_set_up = False\n\n\nclass ConfigurationError(ValueError):\n def __init__(self, msg, field_name):\n self.field_name = field_name\n super(ValueError, self).__init__(msg)\n\n\nclass _ConfigValue(object):\n \"\"\"\n Base class for configuration values\n\n dict_key\n String representing the key used for this config value in dict configs.\n env_key\n String representing the key used in environment variables for this\n config value. If not specified, will be set to `\"ELASTIC_APM_\" + dict_key`.\n type\n Type of value stored in this config value.\n validators\n List of validator classes. Must be callables, which will be called with\n a value and the dict_key for the config value. The validator either\n returns the validated value or raises a ConfigurationError if validation\n fails.\n callbacks\n List of functions which will be called when the config value is updated.\n The callbacks must match this signature:\n callback(dict_key, old_value, new_value, config_instance)\n\n Note that callbacks wait until the end of any given `update()` operation\n and are called at this point. This, coupled with the fact that callbacks\n receive the config instance, means that callbacks can utilize multiple\n configuration values (such as is the case for logging). This is\n complicated if more than one of the involved config values are\n dynamic, as both would need callbacks and the callback would need to\n be idempotent.\n callbacks_on_default\n Whether the callback should be called on config initialization if the\n default value is used. Default: True\n default\n The default for this config value if not user-configured.\n required\n Whether this config value is required. If a default is specified,\n this is a redundant option (except to ensure that this config value\n is specified if a default were ever to be removed).\n\n Note that _ConfigValues and any inheriting classes must implement __set__\n and __get__. The calling instance will always be a _ConfigBase descendant\n and the __set__ and __get__ calls will access `instance._values[self.dict_key]`\n to get and set values.\n \"\"\"\n\n def __init__(\n self,\n dict_key,\n env_key=None,\n type=compat.text_type,\n validators=None,\n callbacks=None,\n callbacks_on_default=True,\n default=None,\n required=False,\n ):\n self.type = type\n self.dict_key = dict_key\n self.validators = validators\n self.callbacks = callbacks\n self.default = default\n self.required = required\n if env_key is None:\n env_key = \"ELASTIC_APM_\" + dict_key\n self.env_key = env_key\n self.callbacks_on_default = callbacks_on_default\n\n def __get__(self, instance, owner):\n if instance:\n return instance._values.get(self.dict_key, self.default)\n else:\n return self.default\n\n def __set__(self, config_instance, value):\n value = self._validate(config_instance, value)\n self._callback_if_changed(config_instance, value)\n config_instance._values[self.dict_key] = value\n\n def _validate(self, instance, value):\n if value is None and self.required:\n raise ConfigurationError(\n \"Configuration error: value for {} is required.\".format(self.dict_key), self.dict_key\n )\n if self.validators and value is not None:\n for validator in self.validators:\n value = validator(value, self.dict_key)\n if self.type and value is not None:\n try:\n value = self.type(value)\n except ValueError as e:\n raise ConfigurationError(\"{}: {}\".format(self.dict_key, compat.text_type(e)), self.dict_key)\n instance._errors.pop(self.dict_key, None)\n return value\n\n def _callback_if_changed(self, instance, new_value):\n \"\"\"\n If the value changed (checked against instance._values[self.dict_key]),\n then run the callback function (if defined)\n \"\"\"\n old_value = instance._values.get(self.dict_key, self.default)\n if old_value != new_value:\n instance.callbacks_queue.append((self.dict_key, old_value, new_value))\n\n def call_callbacks(self, old_value, new_value, config_instance):\n if not self.callbacks:\n return\n for callback in self.callbacks:\n try:\n callback(self.dict_key, old_value, new_value, config_instance)\n except Exception as e:\n raise ConfigurationError(\n \"Callback {} raised an exception when setting {} to {}: {}\".format(\n callback, self.dict_key, new_value, e\n ),\n self.dict_key,\n )\n\n\nclass _ListConfigValue(_ConfigValue):\n def __init__(self, dict_key, list_separator=\",\", **kwargs):\n self.list_separator = list_separator\n super(_ListConfigValue, self).__init__(dict_key, **kwargs)\n\n def __set__(self, instance, value):\n if isinstance(value, compat.string_types):\n value = value.split(self.list_separator)\n elif value is not None:\n value = list(value)\n if value:\n value = [self.type(item) for item in value]\n self._callback_if_changed(instance, value)\n instance._values[self.dict_key] = value\n\n\nclass _DictConfigValue(_ConfigValue):\n def __init__(self, dict_key, item_separator=\",\", keyval_separator=\"=\", **kwargs):\n self.item_separator = item_separator\n self.keyval_separator = keyval_separator\n super(_DictConfigValue, self).__init__(dict_key, **kwargs)\n\n def __set__(self, instance, value):\n if isinstance(value, compat.string_types):\n items = (item.split(self.keyval_separator) for item in value.split(self.item_separator))\n value = {key.strip(): self.type(val.strip()) for key, val in items}\n elif not isinstance(value, dict):\n # TODO: better error handling\n value = None\n self._callback_if_changed(instance, value)\n instance._values[self.dict_key] = value\n\n\nclass _BoolConfigValue(_ConfigValue):\n def __init__(self, dict_key, true_string=\"true\", false_string=\"false\", **kwargs):\n self.true_string = true_string\n self.false_string = false_string\n super(_BoolConfigValue, self).__init__(dict_key, **kwargs)\n\n def __set__(self, instance, value):\n if isinstance(value, compat.string_types):\n if value.lower() == self.true_string:\n value = True\n elif value.lower() == self.false_string:\n value = False\n self._callback_if_changed(instance, value)\n instance._values[self.dict_key] = bool(value)\n\n\nclass RegexValidator(object):\n def __init__(self, regex, verbose_pattern=None):\n self.regex = regex\n self.verbose_pattern = verbose_pattern or regex\n\n def __call__(self, value, field_name):\n value = compat.text_type(value)\n match = re.match(self.regex, value)\n if match:\n return value\n raise ConfigurationError(\"{} does not match pattern {}\".format(value, self.verbose_pattern), field_name)\n\n\nclass UnitValidator(object):\n def __init__(self, regex, verbose_pattern, unit_multipliers):\n self.regex = regex\n self.verbose_pattern = verbose_pattern\n self.unit_multipliers = unit_multipliers\n\n def __call__(self, value, field_name):\n value = compat.text_type(value)\n match = re.match(self.regex, value, re.IGNORECASE)\n if not match:\n raise ConfigurationError(\"{} does not match pattern {}\".format(value, self.verbose_pattern), field_name)\n val, unit = match.groups()\n try:\n val = int(val) * self.unit_multipliers[unit]\n except KeyError:\n raise ConfigurationError(\"{} is not a supported unit\".format(unit), field_name)\n return val\n\n\nclass PrecisionValidator(object):\n \"\"\"\n Forces a float value to `precision` digits of precision.\n\n Rounds half away from zero.\n\n If `minimum` is provided, and the value rounds to 0 (but was not zero to\n begin with), use the minimum instead.\n \"\"\"\n\n def __init__(self, precision=0, minimum=None):\n self.precision = precision\n self.minimum = minimum\n\n def __call__(self, value, field_name):\n try:\n value = float(value)\n except ValueError:\n raise ConfigurationError(\"{} is not a float\".format(value), field_name)\n multiplier = 10 ** self.precision\n rounded = math.floor(value * multiplier + 0.5) / multiplier\n if rounded == 0 and self.minimum and value != 0:\n rounded = self.minimum\n return rounded\n\n\nduration_validator = UnitValidator(r\"^((?:-)?\\d+)(ms|s|m)$\", r\"\\d+(ms|s|m)\", {\"ms\": 1, \"s\": 1000, \"m\": 60000})\nsize_validator = UnitValidator(\n r\"^(\\d+)(b|kb|mb|gb)$\", r\"\\d+(b|KB|MB|GB)\", {\"b\": 1, \"kb\": 1024, \"mb\": 1024 * 1024, \"gb\": 1024 * 1024 * 1024}\n)\n\n\nclass ExcludeRangeValidator(object):\n def __init__(self, range_start, range_end, range_desc):\n self.range_start = range_start\n self.range_end = range_end\n self.range_desc = range_desc\n\n def __call__(self, value, field_name):\n if self.range_start <= value <= self.range_end:\n raise ConfigurationError(\n \"{} cannot be in range: {}\".format(\n value, self.range_desc.format(**{\"range_start\": self.range_start, \"range_end\": self.range_end})\n ),\n field_name,\n )\n return value\n\n\nclass FileIsReadableValidator(object):\n def __call__(self, value, field_name):\n value = os.path.normpath(value)\n if not os.path.exists(value):\n raise ConfigurationError(\"{} does not exist\".format(value), field_name)\n elif not os.path.isfile(value):\n raise ConfigurationError(\"{} is not a file\".format(value), field_name)\n elif not os.access(value, os.R_OK):\n raise ConfigurationError(\"{} is not readable\".format(value), field_name)\n return value\n\n\nclass EnumerationValidator(object):\n \"\"\"\n Validator which ensures that a given config value is chosen from a list\n of valid string options.\n \"\"\"\n\n def __init__(self, valid_values, case_sensitive=False):\n \"\"\"\n valid_values\n List of valid string values for the config value\n case_sensitive\n Whether to compare case when comparing a value to the valid list.\n Defaults to False (case-insensitive)\n \"\"\"\n self.case_sensitive = case_sensitive\n if case_sensitive:\n self.valid_values = {s: s for s in valid_values}\n else:\n self.valid_values = {s.lower(): s for s in valid_values}\n\n def __call__(self, value, field_name):\n if self.case_sensitive:\n ret = self.valid_values.get(value)\n else:\n ret = self.valid_values.get(value.lower())\n if ret is None:\n raise ConfigurationError(\n \"{} is not in the list of valid values: {}\".format(value, list(self.valid_values.values())), field_name\n )\n return ret\n\n\ndef _log_level_callback(dict_key, old_value, new_value, config_instance):\n elasticapm_logger = logging.getLogger(\"elasticapm\")\n elasticapm_logger.setLevel(log_levels_map.get(new_value, 100))\n\n global logfile_set_up\n if not logfile_set_up and config_instance.log_file:\n logfile_set_up = True\n filehandler = logging.handlers.RotatingFileHandler(\n config_instance.log_file, maxBytes=config_instance.log_file_size, backupCount=1\n )\n try:\n import ecs_logging\n\n filehandler.setFormatter(ecs_logging.StdlibFormatter())\n except ImportError:\n pass\n elasticapm_logger.addHandler(filehandler)\n\n\ndef _log_ecs_formatting_callback(dict_key, old_value, new_value, config_instance):\n \"\"\"\n If ecs_logging is installed and log_ecs_formatting is set to \"override\", we should\n set the ecs_logging.StdlibFormatter as the formatted for every handler in\n the root logger, and set the default processor for structlog to the\n ecs_logging.StructlogFormatter.\n \"\"\"\n if new_value.lower() == \"override\":\n try:\n import ecs_logging\n except ImportError:\n return\n\n # Stdlib\n root_logger = logging.getLogger()\n formatter = ecs_logging.StdlibFormatter()\n for handler in root_logger.handlers:\n handler.setFormatter(formatter)\n\n # Structlog\n try:\n import structlog\n\n structlog.configure(processors=[ecs_logging.StructlogFormatter()])\n except ImportError:\n pass\n\n\nclass _ConfigBase(object):\n _NO_VALUE = object() # sentinel object\n\n def __init__(self, config_dict=None, env_dict=None, inline_dict=None, copy=False):\n \"\"\"\n config_dict\n Configuration dict as is common for frameworks such as flask and django.\n Keys match the _ConfigValue.dict_key (usually all caps)\n env_dict\n Environment variables dict. Keys match the _ConfigValue.env_key\n (usually \"ELASTIC_APM_\" + dict_key)\n inline_dict\n Any config passed in as kwargs to the Client object. Typically\n the keys match the names of the _ConfigValue variables in the Config\n object.\n copy\n Whether this object is being created to copy an existing Config\n object. If True, don't run the initial `update` (which would call\n callbacks if present)\n \"\"\"\n self._values = {}\n self._errors = {}\n self._dict_key_lookup = {}\n self.callbacks_queue = []\n for config_value in self.__class__.__dict__.values():\n if not isinstance(config_value, _ConfigValue):\n continue\n self._dict_key_lookup[config_value.dict_key] = config_value\n if not copy:\n self.update(config_dict, env_dict, inline_dict, initial=True)\n\n def update(self, config_dict=None, env_dict=None, inline_dict=None, initial=False):\n if config_dict is None:\n config_dict = {}\n if env_dict is None:\n env_dict = os.environ\n if inline_dict is None:\n inline_dict = {}\n for field, config_value in compat.iteritems(self.__class__.__dict__):\n if not isinstance(config_value, _ConfigValue):\n continue\n new_value = self._NO_VALUE\n # first check environment\n if config_value.env_key and config_value.env_key in env_dict:\n new_value = env_dict[config_value.env_key]\n # check the inline config\n elif field in inline_dict:\n new_value = inline_dict[field]\n # finally, check config dictionary\n elif config_value.dict_key in config_dict:\n new_value = config_dict[config_value.dict_key]\n # only set if new_value changed. We'll fall back to the field default if not.\n if new_value is not self._NO_VALUE:\n try:\n setattr(self, field, new_value)\n except ConfigurationError as e:\n self._errors[e.field_name] = str(e)\n # handle initial callbacks\n if (\n initial\n and config_value.callbacks_on_default\n and getattr(self, field) is not None\n and getattr(self, field) == config_value.default\n ):\n self.callbacks_queue.append((config_value.dict_key, self._NO_VALUE, config_value.default))\n # if a field has not been provided by any config source, we have to check separately if it is required\n if config_value.required and getattr(self, field) is None:\n self._errors[config_value.dict_key] = \"Configuration error: value for {} is required.\".format(\n config_value.dict_key\n )\n self.call_pending_callbacks()\n\n def call_pending_callbacks(self):\n \"\"\"\n Call callbacks for config options matching list of tuples:\n\n (dict_key, old_value, new_value)\n \"\"\"\n for dict_key, old_value, new_value in self.callbacks_queue:\n self._dict_key_lookup[dict_key].call_callbacks(old_value, new_value, self)\n self.callbacks_queue = []\n\n @property\n def values(self):\n return self._values\n\n @values.setter\n def values(self, values):\n self._values = values\n\n @property\n def errors(self):\n return self._errors\n\n def copy(self):\n c = self.__class__(copy=True)\n c._errors = {}\n c.values = self.values.copy()\n return c\n\n\nclass Config(_ConfigBase):\n service_name = _ConfigValue(\n \"SERVICE_NAME\", validators=[RegexValidator(\"^[a-zA-Z0-9 _-]+$\")], default=\"python_service\", required=True\n )\n service_node_name = _ConfigValue(\"SERVICE_NODE_NAME\")\n environment = _ConfigValue(\"ENVIRONMENT\")\n secret_token = _ConfigValue(\"SECRET_TOKEN\")\n api_key = _ConfigValue(\"API_KEY\")\n debug = _BoolConfigValue(\"DEBUG\", default=False)\n server_url = _ConfigValue(\"SERVER_URL\", default=\"http://localhost:8200\", required=True)\n server_cert = _ConfigValue(\"SERVER_CERT\", validators=[FileIsReadableValidator()])\n verify_server_cert = _BoolConfigValue(\"VERIFY_SERVER_CERT\", default=True)\n include_paths = _ListConfigValue(\"INCLUDE_PATHS\")\n exclude_paths = _ListConfigValue(\"EXCLUDE_PATHS\", default=compat.get_default_library_patters())\n filter_exception_types = _ListConfigValue(\"FILTER_EXCEPTION_TYPES\")\n server_timeout = _ConfigValue(\n \"SERVER_TIMEOUT\",\n type=float,\n validators=[\n UnitValidator(r\"^((?:-)?\\d+)(ms|s|m)?$\", r\"\\d+(ms|s|m)\", {\"ms\": 0.001, \"s\": 1, \"m\": 60, None: 1000})\n ],\n default=5,\n )\n hostname = _ConfigValue(\"HOSTNAME\", default=socket.gethostname())\n auto_log_stacks = _BoolConfigValue(\"AUTO_LOG_STACKS\", default=True)\n transport_class = _ConfigValue(\"TRANSPORT_CLASS\", default=\"elasticapm.transport.http.Transport\", required=True)\n processors = _ListConfigValue(\n \"PROCESSORS\",\n default=[\n \"elasticapm.processors.sanitize_stacktrace_locals\",\n \"elasticapm.processors.sanitize_http_request_cookies\",\n \"elasticapm.processors.sanitize_http_response_cookies\",\n \"elasticapm.processors.sanitize_http_headers\",\n \"elasticapm.processors.sanitize_http_wsgi_env\",\n \"elasticapm.processors.sanitize_http_request_body\",\n ],\n )\n sanitize_field_names = _ListConfigValue(\n \"SANITIZE_FIELD_NAMES\", type=starmatch_to_regex, default=BASE_SANITIZE_FIELD_NAMES\n )\n metrics_sets = _ListConfigValue(\n \"METRICS_SETS\",\n default=[\n \"elasticapm.metrics.sets.cpu.CPUMetricSet\",\n \"elasticapm.metrics.sets.transactions.TransactionsMetricSet\",\n ],\n )\n metrics_interval = _ConfigValue(\n \"METRICS_INTERVAL\",\n type=int,\n validators=[duration_validator, ExcludeRangeValidator(1, 999, \"{range_start} - {range_end} ms\")],\n default=30000,\n )\n breakdown_metrics = _BoolConfigValue(\"BREAKDOWN_METRICS\", default=True)\n prometheus_metrics = _BoolConfigValue(\"PROMETHEUS_METRICS\", default=False)\n prometheus_metrics_prefix = _ConfigValue(\"PROMETHEUS_METRICS_PREFIX\", default=\"prometheus.metrics.\")\n disable_metrics = _ListConfigValue(\"DISABLE_METRICS\", type=starmatch_to_regex, default=[])\n central_config = _BoolConfigValue(\"CENTRAL_CONFIG\", default=True)\n api_request_size = _ConfigValue(\"API_REQUEST_SIZE\", type=int, validators=[size_validator], default=768 * 1024)\n api_request_time = _ConfigValue(\"API_REQUEST_TIME\", type=int, validators=[duration_validator], default=10 * 1000)\n transaction_sample_rate = _ConfigValue(\n \"TRANSACTION_SAMPLE_RATE\", type=float, validators=[PrecisionValidator(4, 0.0001)], default=1.0\n )\n transaction_max_spans = _ConfigValue(\"TRANSACTION_MAX_SPANS\", type=int, default=500)\n stack_trace_limit = _ConfigValue(\"STACK_TRACE_LIMIT\", type=int, default=500)\n span_frames_min_duration = _ConfigValue(\n \"SPAN_FRAMES_MIN_DURATION\",\n default=5,\n validators=[\n UnitValidator(r\"^((?:-)?\\d+)(ms|s|m)?$\", r\"\\d+(ms|s|m)\", {\"ms\": 1, \"s\": 1000, \"m\": 60000, None: 1})\n ],\n type=int,\n )\n collect_local_variables = _ConfigValue(\"COLLECT_LOCAL_VARIABLES\", default=\"errors\")\n source_lines_error_app_frames = _ConfigValue(\"SOURCE_LINES_ERROR_APP_FRAMES\", type=int, default=5)\n source_lines_error_library_frames = _ConfigValue(\"SOURCE_LINES_ERROR_LIBRARY_FRAMES\", type=int, default=5)\n source_lines_span_app_frames = _ConfigValue(\"SOURCE_LINES_SPAN_APP_FRAMES\", type=int, default=0)\n source_lines_span_library_frames = _ConfigValue(\"SOURCE_LINES_SPAN_LIBRARY_FRAMES\", type=int, default=0)\n local_var_max_length = _ConfigValue(\"LOCAL_VAR_MAX_LENGTH\", type=int, default=200)\n local_var_list_max_length = _ConfigValue(\"LOCAL_VAR_LIST_MAX_LENGTH\", type=int, default=10)\n local_var_dict_max_length = _ConfigValue(\"LOCAL_VAR_DICT_MAX_LENGTH\", type=int, default=10)\n capture_body = _ConfigValue(\n \"CAPTURE_BODY\",\n default=\"off\",\n validators=[lambda val, _: {\"errors\": \"error\", \"transactions\": \"transaction\"}.get(val, val)],\n )\n async_mode = _BoolConfigValue(\"ASYNC_MODE\", default=True)\n instrument_django_middleware = _BoolConfigValue(\"INSTRUMENT_DJANGO_MIDDLEWARE\", default=True)\n autoinsert_django_middleware = _BoolConfigValue(\"AUTOINSERT_DJANGO_MIDDLEWARE\", default=True)\n transactions_ignore_patterns = _ListConfigValue(\"TRANSACTIONS_IGNORE_PATTERNS\", default=[])\n transaction_ignore_urls = _ListConfigValue(\"TRANSACTION_IGNORE_URLS\", type=starmatch_to_regex, default=[])\n service_version = _ConfigValue(\"SERVICE_VERSION\")\n framework_name = _ConfigValue(\"FRAMEWORK_NAME\")\n framework_version = _ConfigValue(\"FRAMEWORK_VERSION\")\n global_labels = _DictConfigValue(\"GLOBAL_LABELS\")\n disable_send = _BoolConfigValue(\"DISABLE_SEND\", default=False)\n enabled = _BoolConfigValue(\"ENABLED\", default=True)\n recording = _BoolConfigValue(\"RECORDING\", default=True)\n instrument = _BoolConfigValue(\"INSTRUMENT\", default=True)\n enable_distributed_tracing = _BoolConfigValue(\"ENABLE_DISTRIBUTED_TRACING\", default=True)\n capture_headers = _BoolConfigValue(\"CAPTURE_HEADERS\", default=True)\n django_transaction_name_from_route = _BoolConfigValue(\"DJANGO_TRANSACTION_NAME_FROM_ROUTE\", default=False)\n disable_log_record_factory = _BoolConfigValue(\"DISABLE_LOG_RECORD_FACTORY\", default=False)\n use_elastic_traceparent_header = _BoolConfigValue(\"USE_ELASTIC_TRACEPARENT_HEADER\", default=True)\n use_elastic_excepthook = _BoolConfigValue(\"USE_ELASTIC_EXCEPTHOOK\", default=False)\n cloud_provider = _ConfigValue(\"CLOUD_PROVIDER\", default=True)\n log_level = _ConfigValue(\n \"LOG_LEVEL\",\n validators=[EnumerationValidator([\"trace\", \"debug\", \"info\", \"warning\", \"warn\", \"error\", \"critical\", \"off\"])],\n callbacks=[_log_level_callback],\n )\n log_file = _ConfigValue(\"LOG_FILE\", default=\"\")\n log_file_size = _ConfigValue(\"LOG_FILE_SIZE\", validators=[size_validator], type=int, default=50 * 1024 * 1024)\n log_ecs_formatting = _ConfigValue(\n \"LOG_ECS_FORMATTING\",\n validators=[EnumerationValidator([\"off\", \"override\"])],\n callbacks=[_log_ecs_formatting_callback],\n default=\"off\",\n )\n\n @property\n def is_recording(self):\n if not self.enabled:\n return False\n else:\n return self.recording\n\n\nclass VersionedConfig(ThreadManager):\n \"\"\"\n A thin layer around Config that provides versioning\n \"\"\"\n\n __slots__ = (\n \"_config\",\n \"_version\",\n \"_first_config\",\n \"_first_version\",\n \"_lock\",\n \"transport\",\n \"_update_thread\",\n \"pid\",\n \"start_stop_order\",\n )\n\n def __init__(self, config_object, version, transport=None):\n \"\"\"\n Create a new VersionedConfig with an initial Config object\n :param config_object: the initial Config object\n :param version: a version identifier for the configuration\n \"\"\"\n self._config = self._first_config = config_object\n self._version = self._first_version = version\n self.transport = transport\n self._lock = threading.Lock()\n self._update_thread = None\n super(VersionedConfig, self).__init__()\n\n def update(self, version, **config):\n \"\"\"\n Update the configuration version\n :param version: version identifier for the new configuration\n :param config: a key/value map of new configuration\n :return: configuration errors, if any\n \"\"\"\n new_config = self._config.copy()\n\n # pass an empty env dict to ensure the environment doesn't get precedence\n new_config.update(inline_dict=config, env_dict={})\n if not new_config.errors:\n with self._lock:\n self._version = version\n self._config = new_config\n else:\n return new_config.errors\n\n def reset(self):\n \"\"\"\n Reset state to the original configuration\n\n Note that because ConfigurationValues can have callbacks, we need to\n note any differences between the original configuration and the most\n recent configuration and run any callbacks that might exist for those\n values.\n \"\"\"\n callbacks = []\n for key in compat.iterkeys(self._config.values):\n if key in self._first_config.values and self._config.values[key] != self._first_config.values[key]:\n callbacks.append((key, self._config.values[key], self._first_config.values[key]))\n\n with self._lock:\n self._version = self._first_version\n self._config = self._first_config\n\n self._config.callbacks_queue.extend(callbacks)\n self._config.call_pending_callbacks()\n\n @property\n def changed(self):\n return self._config != self._first_config\n\n def __getattr__(self, item):\n return getattr(self._config, item)\n\n def __setattr__(self, name, value):\n if name not in self.__slots__:\n setattr(self._config, name, value)\n else:\n super(VersionedConfig, self).__setattr__(name, value)\n\n @property\n def config_version(self):\n return self._version\n\n def update_config(self):\n if not self.transport:\n logger.warning(\"No transport set for config updates, skipping\")\n return\n logger.debug(\"Checking for new config...\")\n keys = {\"service\": {\"name\": self.service_name}}\n if self.environment:\n keys[\"service\"][\"environment\"] = self.environment\n new_version, new_config, next_run = self.transport.get_config(self.config_version, keys)\n if new_version and new_config:\n errors = self.update(new_version, **new_config)\n if errors:\n logger.error(\"Error applying new configuration: %s\", repr(errors))\n else:\n logger.info(\n \"Applied new remote configuration: %s\",\n \"; \".join(\n \"%s=%s\" % (compat.text_type(k), compat.text_type(v)) for k, v in compat.iteritems(new_config)\n ),\n )\n elif new_version == self.config_version:\n logger.debug(\"Remote config unchanged\")\n elif not new_config and self.changed:\n logger.debug(\"Remote config disappeared, resetting to original\")\n self.reset()\n\n return next_run\n\n def start_thread(self, pid=None):\n self._update_thread = IntervalTimer(\n self.update_config, 1, \"eapm conf updater\", daemon=True, evaluate_function_interval=True\n )\n self._update_thread.start()\n super(VersionedConfig, self).start_thread(pid=pid)\n\n def stop_thread(self):\n if self._update_thread:\n self._update_thread.cancel()\n self._update_thread = None\n\n\ndef setup_logging(handler):\n \"\"\"\n Configures logging to pipe to Elastic APM.\n\n For a typical Python install:\n\n >>> from elasticapm.handlers.logging import LoggingHandler\n >>> client = ElasticAPM(...)\n >>> setup_logging(LoggingHandler(client))\n\n Within Django:\n\n >>> from elasticapm.contrib.django.handlers import LoggingHandler\n >>> setup_logging(LoggingHandler())\n\n Returns a boolean based on if logging was configured or not.\n \"\"\"\n # TODO We should probably revisit this. Does it make more sense as\n # a method within the Client class? The Client object could easily\n # pass itself into LoggingHandler and we could eliminate args altogether.\n logger = logging.getLogger()\n if handler.__class__ in map(type, logger.handlers):\n return False\n\n logger.addHandler(handler)\n\n return True\n", "path": "elasticapm/conf/__init__.py"}]} |
gh_patches_debug_215 | rasdani/github-patches | git_diff | facebookresearch__xformers-151 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Follow up on #141 with a proper unit test
# 🐛 Bug
Make sure that #141 cannot happen anymore, add a small unit test to guard parity
Follow up on #141 with a proper unit test
# 🐛 Bug
Make sure that #141 cannot happen anymore, add a small unit test to guard parity
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `xformers/triton/softmax.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 import logging
8 from enum import Enum
9 from typing import Optional
10
11 import torch
12 import triton
13 from torch.cuda.amp import custom_bwd, custom_fwd
14
15 from xformers.triton.k_softmax import _softmax, _softmax_backward
16
17 # CREDITS: This is adapted from the vanilla Triton example. See https://openai.com/blog/triton/
18 # and https://triton-lang.org/getting-started/tutorials/02-fused-softmax.html
19
20
21 _triton_registered_overflow = False
22 _triton_registered_warnings = False
23 _triton_softmax_fp16_enabled = False # NOTE: PyTorch keeps softmax as fp32
24
25
26 class MaskType(str, Enum):
27 ADD = "add"
28 MUL = "mul"
29
30
31 # Helper to handle the SPMD launch grid and error cases
32 class _softmax_triton(torch.autograd.Function):
33 @staticmethod
34 @custom_fwd(cast_inputs=torch.float16 if _triton_softmax_fp16_enabled else None)
35 def forward(ctx, x, mask, log_outputs, causal):
36 """
37 Fused softmax implementation, using the Triton programming model.
38 This only supports a reduction over the last dimension for now
39 """
40
41 # Handle 2D/3D tensors
42 x_ = x.unsqueeze(0) if x.ndim == 2 else x
43
44 if not x_.is_contiguous():
45 x_ = x_.contiguous()
46
47 y = torch.empty_like(x_)
48 assert (
49 y.stride(2) == 1 and x_.stride(2) == 1
50 ), f"{x.shape} - {x_.shape} - {x_.stride()}"
51
52 # SPMD launch grid
53 grid_2d = (
54 x_.shape[0],
55 x_.shape[1],
56 )
57
58 # enqueue GPU kernel
59 use_mask = True
60 if mask is None:
61 # placeholder, will not be used
62 mask = x_
63 use_mask = False
64 else:
65 # Make sure that the mask is binary
66 assert mask.dtype == x.dtype, "An additive mask is requested"
67
68 _softmax[grid_2d](
69 y,
70 x_,
71 mask,
72 y.stride(0),
73 y.stride(1),
74 x_.stride(0),
75 x_.stride(1),
76 mask.stride(0),
77 x_.shape[2],
78 log=log_outputs,
79 use_mask=use_mask,
80 causal=causal,
81 )
82
83 ctx.save_for_backward(y)
84 ctx.log_outputs = log_outputs
85 ctx.causal = causal
86 return y.reshape_as(x)
87
88 @staticmethod
89 @custom_bwd
90 def backward(ctx, grad_out):
91 (out,) = ctx.saved_tensors
92
93 # Handle 2D/3D tensors
94 grad_out_ = grad_out.unsqueeze(0) if grad_out.ndim == 2 else grad_out
95
96 # SPMD launch grid
97 grid_2d = (
98 grad_out_.shape[0],
99 grad_out_.shape[1],
100 )
101
102 depth = triton.next_power_of_2(grad_out_.shape[2])
103 grad_in = torch.empty_like(
104 out
105 ) # torch.zeros is measurably slower, we'll zero out in the kernel
106
107 # Make sure that the tensor are contiguous
108 grad_in, grad_out, out = map(lambda x: x.contiguous(), [grad_in, grad_out, out])
109
110 # fmt: off
111 _softmax_backward[grid_2d](
112 grad_in, grad_out_, out,
113 grad_in.stride(0), grad_in.stride(1),
114 grad_out_.stride(0), grad_out_.stride(1),
115 out.stride(0), out.stride(1),
116 out.shape[2],
117 depth=depth,
118 log=ctx.log_outputs,
119 causal=ctx.causal
120 )
121 # fmt: on
122 return grad_in.reshape_as(grad_out), None, None, None
123
124
125 def softmax(
126 x: torch.Tensor, mask: Optional[torch.Tensor] = None, causal: bool = False
127 ) -> torch.Tensor:
128 r"""Applies the Softmax function to an 3-dimensional input Tensor
129 rescaling them so that the elements of the n-dimensional output Tensor
130 lie in the range [0,1] and sum to 1.
131
132 Softmax is defined as:
133
134 .. math::
135 \text{Softmax}(x_{i}) = \frac{\exp(x_i)}{\sum_j \exp(x_j)}
136
137 .. warning: softmax is computed on the last dimension of the input tensor.
138
139
140 Args:
141 x: input tensor.
142 mask: optional mask, its application will be fused to the softmax computation if triton is used
143 causal: optional performance optimization, if triton is used and the attention is causal
144
145 Returns:
146 a Tensor of the same dimension and shape as the input with
147 values in the range [0, 1] and sum to 1
148 """
149 return _softmax_dispatch(x, log=False, mask=mask, causal=causal)
150
151
152 def log_softmax(
153 x: torch.Tensor, mask: Optional[torch.Tensor] = None, causal: bool = False
154 ) -> torch.Tensor:
155 r"""Applies the :math:`\log(\text{Softmax}(x))` function to an 3-dimensional
156 input Tensor. The LogSoftmax formulation can be simplified as:
157
158 .. math::
159 \text{LogSoftmax}(x_{i}) = \log\left(\frac{\exp(x_i) }{ \sum_j \exp(x_j)} \right)
160
161 Args:
162 x: input tensor.
163
164 Returns:
165 a Tensor of the same dimension and shape as the input with
166 values in the range [-inf, 0)
167 """
168 return _softmax_dispatch(x, log=True, mask=mask, causal=causal)
169
170
171 def _softmax_dispatch(
172 x: torch.Tensor, log: bool, mask: Optional[torch.Tensor], causal: bool = False
173 ) -> torch.Tensor:
174 # Triton is used if
175 # - CUDA
176 # - there's enough data to make it faster than pytorch. This could change over time, Triton is improving
177 # - there was no previous failure
178
179 global _triton_registered_overflow
180 global _triton_registered_warnings
181
182 try:
183 if torch.cuda.is_available() and x.is_cuda and not _triton_registered_overflow:
184 return _softmax_triton.apply(x, mask, log, causal)
185 except (triton.code_gen.OutOfResources, RuntimeError) as e:
186 # Catch cases where the current GPU does not have enough registers to hold a full tensor line
187 # fallback to PyTorch's implementation, which streams the tensor in and out
188 _triton_registered_overflow = True
189 logging.warning(
190 "Triton softmax kernel register spillover or invalid image caught."
191 "Deactivating this kernel, please file an issue int the xFormers repository"
192 )
193 logging.warning(e)
194
195 if causal and not _triton_registered_warnings:
196 logging.warning(
197 "Triton softmax could not be used. \
198 The causal flags is being passed but it does not provide any benefit with PyTorch softmax."
199 )
200 _triton_registered_warnings = True
201
202 if mask is not None:
203 x += mask
204
205 if log:
206 return torch.log_softmax(x, dim=-1)
207 else:
208 return torch.softmax(x, dim=-1)
209
```
--- 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/xformers/triton/softmax.py b/xformers/triton/softmax.py
--- a/xformers/triton/softmax.py
+++ b/xformers/triton/softmax.py
@@ -200,7 +200,7 @@
_triton_registered_warnings = True
if mask is not None:
- x += mask
+ x = x + mask
if log:
return torch.log_softmax(x, dim=-1)
| {"golden_diff": "diff --git a/xformers/triton/softmax.py b/xformers/triton/softmax.py\n--- a/xformers/triton/softmax.py\n+++ b/xformers/triton/softmax.py\n@@ -200,7 +200,7 @@\n _triton_registered_warnings = True\n \n if mask is not None:\n- x += mask\n+ x = x + mask\n \n if log:\n return torch.log_softmax(x, dim=-1)\n", "issue": "Follow up on #141 with a proper unit test\n# \ud83d\udc1b Bug\r\nMake sure that #141 cannot happen anymore, add a small unit test to guard parity\r\n\nFollow up on #141 with a proper unit test\n# \ud83d\udc1b Bug\r\nMake sure that #141 cannot happen anymore, add a small unit test to guard parity\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\nimport logging\nfrom enum import Enum\nfrom typing import Optional\n\nimport torch\nimport triton\nfrom torch.cuda.amp import custom_bwd, custom_fwd\n\nfrom xformers.triton.k_softmax import _softmax, _softmax_backward\n\n# CREDITS: This is adapted from the vanilla Triton example. See https://openai.com/blog/triton/\n# and https://triton-lang.org/getting-started/tutorials/02-fused-softmax.html\n\n\n_triton_registered_overflow = False\n_triton_registered_warnings = False\n_triton_softmax_fp16_enabled = False # NOTE: PyTorch keeps softmax as fp32\n\n\nclass MaskType(str, Enum):\n ADD = \"add\"\n MUL = \"mul\"\n\n\n# Helper to handle the SPMD launch grid and error cases\nclass _softmax_triton(torch.autograd.Function):\n @staticmethod\n @custom_fwd(cast_inputs=torch.float16 if _triton_softmax_fp16_enabled else None)\n def forward(ctx, x, mask, log_outputs, causal):\n \"\"\"\n Fused softmax implementation, using the Triton programming model.\n This only supports a reduction over the last dimension for now\n \"\"\"\n\n # Handle 2D/3D tensors\n x_ = x.unsqueeze(0) if x.ndim == 2 else x\n\n if not x_.is_contiguous():\n x_ = x_.contiguous()\n\n y = torch.empty_like(x_)\n assert (\n y.stride(2) == 1 and x_.stride(2) == 1\n ), f\"{x.shape} - {x_.shape} - {x_.stride()}\"\n\n # SPMD launch grid\n grid_2d = (\n x_.shape[0],\n x_.shape[1],\n )\n\n # enqueue GPU kernel\n use_mask = True\n if mask is None:\n # placeholder, will not be used\n mask = x_\n use_mask = False\n else:\n # Make sure that the mask is binary\n assert mask.dtype == x.dtype, \"An additive mask is requested\"\n\n _softmax[grid_2d](\n y,\n x_,\n mask,\n y.stride(0),\n y.stride(1),\n x_.stride(0),\n x_.stride(1),\n mask.stride(0),\n x_.shape[2],\n log=log_outputs,\n use_mask=use_mask,\n causal=causal,\n )\n\n ctx.save_for_backward(y)\n ctx.log_outputs = log_outputs\n ctx.causal = causal\n return y.reshape_as(x)\n\n @staticmethod\n @custom_bwd\n def backward(ctx, grad_out):\n (out,) = ctx.saved_tensors\n\n # Handle 2D/3D tensors\n grad_out_ = grad_out.unsqueeze(0) if grad_out.ndim == 2 else grad_out\n\n # SPMD launch grid\n grid_2d = (\n grad_out_.shape[0],\n grad_out_.shape[1],\n )\n\n depth = triton.next_power_of_2(grad_out_.shape[2])\n grad_in = torch.empty_like(\n out\n ) # torch.zeros is measurably slower, we'll zero out in the kernel\n\n # Make sure that the tensor are contiguous\n grad_in, grad_out, out = map(lambda x: x.contiguous(), [grad_in, grad_out, out])\n\n # fmt: off\n _softmax_backward[grid_2d](\n grad_in, grad_out_, out,\n grad_in.stride(0), grad_in.stride(1),\n grad_out_.stride(0), grad_out_.stride(1),\n out.stride(0), out.stride(1),\n out.shape[2],\n depth=depth,\n log=ctx.log_outputs,\n causal=ctx.causal\n )\n # fmt: on\n return grad_in.reshape_as(grad_out), None, None, None\n\n\ndef softmax(\n x: torch.Tensor, mask: Optional[torch.Tensor] = None, causal: bool = False\n) -> torch.Tensor:\n r\"\"\"Applies the Softmax function to an 3-dimensional input Tensor\n rescaling them so that the elements of the n-dimensional output Tensor\n lie in the range [0,1] and sum to 1.\n\n Softmax is defined as:\n\n .. math::\n \\text{Softmax}(x_{i}) = \\frac{\\exp(x_i)}{\\sum_j \\exp(x_j)}\n\n .. warning: softmax is computed on the last dimension of the input tensor.\n\n\n Args:\n x: input tensor.\n mask: optional mask, its application will be fused to the softmax computation if triton is used\n causal: optional performance optimization, if triton is used and the attention is causal\n\n Returns:\n a Tensor of the same dimension and shape as the input with\n values in the range [0, 1] and sum to 1\n \"\"\"\n return _softmax_dispatch(x, log=False, mask=mask, causal=causal)\n\n\ndef log_softmax(\n x: torch.Tensor, mask: Optional[torch.Tensor] = None, causal: bool = False\n) -> torch.Tensor:\n r\"\"\"Applies the :math:`\\log(\\text{Softmax}(x))` function to an 3-dimensional\n input Tensor. The LogSoftmax formulation can be simplified as:\n\n .. math::\n \\text{LogSoftmax}(x_{i}) = \\log\\left(\\frac{\\exp(x_i) }{ \\sum_j \\exp(x_j)} \\right)\n\n Args:\n x: input tensor.\n\n Returns:\n a Tensor of the same dimension and shape as the input with\n values in the range [-inf, 0)\n \"\"\"\n return _softmax_dispatch(x, log=True, mask=mask, causal=causal)\n\n\ndef _softmax_dispatch(\n x: torch.Tensor, log: bool, mask: Optional[torch.Tensor], causal: bool = False\n) -> torch.Tensor:\n # Triton is used if\n # - CUDA\n # - there's enough data to make it faster than pytorch. This could change over time, Triton is improving\n # - there was no previous failure\n\n global _triton_registered_overflow\n global _triton_registered_warnings\n\n try:\n if torch.cuda.is_available() and x.is_cuda and not _triton_registered_overflow:\n return _softmax_triton.apply(x, mask, log, causal)\n except (triton.code_gen.OutOfResources, RuntimeError) as e:\n # Catch cases where the current GPU does not have enough registers to hold a full tensor line\n # fallback to PyTorch's implementation, which streams the tensor in and out\n _triton_registered_overflow = True\n logging.warning(\n \"Triton softmax kernel register spillover or invalid image caught.\"\n \"Deactivating this kernel, please file an issue int the xFormers repository\"\n )\n logging.warning(e)\n\n if causal and not _triton_registered_warnings:\n logging.warning(\n \"Triton softmax could not be used. \\\n The causal flags is being passed but it does not provide any benefit with PyTorch softmax.\"\n )\n _triton_registered_warnings = True\n\n if mask is not None:\n x += mask\n\n if log:\n return torch.log_softmax(x, dim=-1)\n else:\n return torch.softmax(x, dim=-1)\n", "path": "xformers/triton/softmax.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\nimport logging\nfrom enum import Enum\nfrom typing import Optional\n\nimport torch\nimport triton\nfrom torch.cuda.amp import custom_bwd, custom_fwd\n\nfrom xformers.triton.k_softmax import _softmax, _softmax_backward\n\n# CREDITS: This is adapted from the vanilla Triton example. See https://openai.com/blog/triton/\n# and https://triton-lang.org/getting-started/tutorials/02-fused-softmax.html\n\n\n_triton_registered_overflow = False\n_triton_registered_warnings = False\n_triton_softmax_fp16_enabled = False # NOTE: PyTorch keeps softmax as fp32\n\n\nclass MaskType(str, Enum):\n ADD = \"add\"\n MUL = \"mul\"\n\n\n# Helper to handle the SPMD launch grid and error cases\nclass _softmax_triton(torch.autograd.Function):\n @staticmethod\n @custom_fwd(cast_inputs=torch.float16 if _triton_softmax_fp16_enabled else None)\n def forward(ctx, x, mask, log_outputs, causal):\n \"\"\"\n Fused softmax implementation, using the Triton programming model.\n This only supports a reduction over the last dimension for now\n \"\"\"\n\n # Handle 2D/3D tensors\n x_ = x.unsqueeze(0) if x.ndim == 2 else x\n\n if not x_.is_contiguous():\n x_ = x_.contiguous()\n\n y = torch.empty_like(x_)\n assert (\n y.stride(2) == 1 and x_.stride(2) == 1\n ), f\"{x.shape} - {x_.shape} - {x_.stride()}\"\n\n # SPMD launch grid\n grid_2d = (\n x_.shape[0],\n x_.shape[1],\n )\n\n # enqueue GPU kernel\n use_mask = True\n if mask is None:\n # placeholder, will not be used\n mask = x_\n use_mask = False\n else:\n # Make sure that the mask is binary\n assert mask.dtype == x.dtype, \"An additive mask is requested\"\n\n _softmax[grid_2d](\n y,\n x_,\n mask,\n y.stride(0),\n y.stride(1),\n x_.stride(0),\n x_.stride(1),\n mask.stride(0),\n x_.shape[2],\n log=log_outputs,\n use_mask=use_mask,\n causal=causal,\n )\n\n ctx.save_for_backward(y)\n ctx.log_outputs = log_outputs\n ctx.causal = causal\n return y.reshape_as(x)\n\n @staticmethod\n @custom_bwd\n def backward(ctx, grad_out):\n (out,) = ctx.saved_tensors\n\n # Handle 2D/3D tensors\n grad_out_ = grad_out.unsqueeze(0) if grad_out.ndim == 2 else grad_out\n\n # SPMD launch grid\n grid_2d = (\n grad_out_.shape[0],\n grad_out_.shape[1],\n )\n\n depth = triton.next_power_of_2(grad_out_.shape[2])\n grad_in = torch.empty_like(\n out\n ) # torch.zeros is measurably slower, we'll zero out in the kernel\n\n # Make sure that the tensor are contiguous\n grad_in, grad_out, out = map(lambda x: x.contiguous(), [grad_in, grad_out, out])\n\n # fmt: off\n _softmax_backward[grid_2d](\n grad_in, grad_out_, out,\n grad_in.stride(0), grad_in.stride(1),\n grad_out_.stride(0), grad_out_.stride(1),\n out.stride(0), out.stride(1),\n out.shape[2],\n depth=depth,\n log=ctx.log_outputs,\n causal=ctx.causal\n )\n # fmt: on\n return grad_in.reshape_as(grad_out), None, None, None\n\n\ndef softmax(\n x: torch.Tensor, mask: Optional[torch.Tensor] = None, causal: bool = False\n) -> torch.Tensor:\n r\"\"\"Applies the Softmax function to an 3-dimensional input Tensor\n rescaling them so that the elements of the n-dimensional output Tensor\n lie in the range [0,1] and sum to 1.\n\n Softmax is defined as:\n\n .. math::\n \\text{Softmax}(x_{i}) = \\frac{\\exp(x_i)}{\\sum_j \\exp(x_j)}\n\n .. warning: softmax is computed on the last dimension of the input tensor.\n\n\n Args:\n x: input tensor.\n mask: optional mask, its application will be fused to the softmax computation if triton is used\n causal: optional performance optimization, if triton is used and the attention is causal\n\n Returns:\n a Tensor of the same dimension and shape as the input with\n values in the range [0, 1] and sum to 1\n \"\"\"\n return _softmax_dispatch(x, log=False, mask=mask, causal=causal)\n\n\ndef log_softmax(\n x: torch.Tensor, mask: Optional[torch.Tensor] = None, causal: bool = False\n) -> torch.Tensor:\n r\"\"\"Applies the :math:`\\log(\\text{Softmax}(x))` function to an 3-dimensional\n input Tensor. The LogSoftmax formulation can be simplified as:\n\n .. math::\n \\text{LogSoftmax}(x_{i}) = \\log\\left(\\frac{\\exp(x_i) }{ \\sum_j \\exp(x_j)} \\right)\n\n Args:\n x: input tensor.\n\n Returns:\n a Tensor of the same dimension and shape as the input with\n values in the range [-inf, 0)\n \"\"\"\n return _softmax_dispatch(x, log=True, mask=mask, causal=causal)\n\n\ndef _softmax_dispatch(\n x: torch.Tensor, log: bool, mask: Optional[torch.Tensor], causal: bool = False\n) -> torch.Tensor:\n # Triton is used if\n # - CUDA\n # - there's enough data to make it faster than pytorch. This could change over time, Triton is improving\n # - there was no previous failure\n\n global _triton_registered_overflow\n global _triton_registered_warnings\n\n try:\n if torch.cuda.is_available() and x.is_cuda and not _triton_registered_overflow:\n return _softmax_triton.apply(x, mask, log, causal)\n except (triton.code_gen.OutOfResources, RuntimeError) as e:\n # Catch cases where the current GPU does not have enough registers to hold a full tensor line\n # fallback to PyTorch's implementation, which streams the tensor in and out\n _triton_registered_overflow = True\n logging.warning(\n \"Triton softmax kernel register spillover or invalid image caught.\"\n \"Deactivating this kernel, please file an issue int the xFormers repository\"\n )\n logging.warning(e)\n\n if causal and not _triton_registered_warnings:\n logging.warning(\n \"Triton softmax could not be used. \\\n The causal flags is being passed but it does not provide any benefit with PyTorch softmax.\"\n )\n _triton_registered_warnings = True\n\n if mask is not None:\n x = x + mask\n\n if log:\n return torch.log_softmax(x, dim=-1)\n else:\n return torch.softmax(x, dim=-1)\n", "path": "xformers/triton/softmax.py"}]} |
gh_patches_debug_216 | rasdani/github-patches | git_diff | pypi__warehouse-7741 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Add Russian translation
The Russian Translation is at [100% on Weblate](https://hosted.weblate.org/languages/ru/pypa/) so I think it should be added to the localization footer.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `warehouse/i18n/__init__.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 import functools
14
15 from babel.core import Locale
16 from pyramid import viewderivers
17 from pyramid.i18n import TranslationStringFactory, default_locale_negotiator
18 from pyramid.threadlocal import get_current_request
19
20 from warehouse.cache.http import add_vary
21
22 # Taken from:
23 # https://github.com/django/django/blob/master/django/conf/locale/__init__.py
24 KNOWN_LOCALES = {
25 "en": "English", # English
26 "es": "español", # Spanish
27 "fr": "français", # French
28 "ja": "日本語", # Japanese
29 "pt_BR": "Português Brasileiro", # Brazilian Portugeuse
30 "uk": "Українська", # Ukrainian
31 "el": "Ελληνικά", # Greek
32 "de": "Deutsch", # German
33 "zh_Hans": "简体中文", # Simplified Chinese
34 }
35
36 LOCALE_ATTR = "_LOCALE_"
37
38 _translation_factory = TranslationStringFactory("messages")
39
40
41 class LazyString:
42 def __init__(self, fn, *args, **kwargs):
43 self.fn = fn
44 self.args = args
45 self.mapping = kwargs.get("mapping", {})
46 self.kwargs = kwargs
47
48 def __json__(self, request):
49 return str(self)
50
51 def __mod__(self, new_mapping):
52 mapping = self.mapping.copy()
53 mapping.update(new_mapping)
54 return LazyString(self.fn, *self.args, mapping=new_mapping, **self.kwargs)
55
56 def __str__(self):
57 return self.fn(*self.args, **self.kwargs)
58
59
60 def _locale(request):
61 """
62 Computes a babel.core:Locale() object for this request.
63 """
64 return Locale.parse(request.locale_name, sep="_")
65
66
67 def _negotiate_locale(request):
68 locale_name = getattr(request, LOCALE_ATTR, None)
69 if locale_name is not None:
70 return locale_name
71
72 locale_name = request.params.get(LOCALE_ATTR)
73 if locale_name is not None:
74 return locale_name
75
76 locale_name = request.cookies.get(LOCALE_ATTR)
77 if locale_name is not None:
78 return locale_name
79
80 if not request.accept_language:
81 return default_locale_negotiator(request)
82
83 return request.accept_language.best_match(
84 tuple(KNOWN_LOCALES.keys()), default_match=default_locale_negotiator(request)
85 )
86
87
88 def localize(message, **kwargs):
89 def _localize(message, **kwargs):
90 request = get_current_request()
91 return request.localizer.translate(_translation_factory(message, **kwargs))
92
93 return LazyString(_localize, message, **kwargs)
94
95
96 class InvalidLocalizer:
97 def _fail(self):
98 raise RuntimeError("Cannot use localizer without has_translations=True")
99
100 @property
101 def locale_name(self):
102 self._fail()
103
104 def pluralize(self, *args, **kwargs):
105 self._fail()
106
107 def translate(self, *args, **kwargs):
108 self._fail()
109
110
111 def translated_view(view, info):
112 if info.options.get("has_translations"):
113 # If this page can be translated, then we'll add a Vary: PyPI-Locale
114 # Vary header.
115 # Note: This will give weird results if hitting PyPI directly instead of through
116 # the Fastly VCL which sets PyPI-Locale.
117 return add_vary("PyPI-Locale")(view)
118 elif info.exception_only:
119 return view
120 else:
121 # If we're not using translations on this view, then we'll wrap the view
122 # with a wrapper that just ensures that the localizer cannot be used.
123 @functools.wraps(view)
124 def wrapped(context, request):
125 # This whole method is a little bit of an odd duck, we want to make
126 # sure that we don't actually *access* request.localizer, because
127 # doing so triggers the machinery to create a new localizer. So
128 # instead we will dig into the request object __dict__ to
129 # effectively do the same thing, just without triggering an access
130 # on request.localizer.
131
132 # Save the original session so that we can restore it once the
133 # inner views have been called.
134 nothing = object()
135 original_localizer = request.__dict__.get("localizer", nothing)
136
137 # This particular view hasn't been set to allow access to the
138 # translations, so we'll just assign an InvalidLocalizer to
139 # request.localizer
140 request.__dict__["localizer"] = InvalidLocalizer()
141
142 try:
143 # Invoke the real view
144 return view(context, request)
145 finally:
146 # Restore the original session so that things like
147 # pyramid_debugtoolbar can access it.
148 if original_localizer is nothing:
149 del request.__dict__["localizer"]
150 else:
151 request.__dict__["localizer"] = original_localizer
152
153 return wrapped
154
155
156 translated_view.options = {"has_translations"}
157
158
159 def includeme(config):
160 # Add the request attributes
161 config.add_request_method(_locale, name="locale", reify=True)
162
163 # Register our translation directory.
164 config.add_translation_dirs("warehouse:locale/")
165
166 config.set_locale_negotiator(_negotiate_locale)
167
168 # Register our i18n/l10n filters for Jinja2
169 filters = config.get_settings().setdefault("jinja2.filters", {})
170 filters.setdefault("format_date", "warehouse.i18n.filters:format_date")
171 filters.setdefault("format_datetime", "warehouse.i18n.filters:format_datetime")
172 filters.setdefault(
173 "format_rfc822_datetime", "warehouse.i18n.filters:format_rfc822_datetime"
174 )
175 filters.setdefault("format_number", "warehouse.i18n.filters:format_number")
176
177 jglobals = config.get_settings().setdefault("jinja2.globals", {})
178 jglobals.setdefault("KNOWN_LOCALES", "warehouse.i18n:KNOWN_LOCALES")
179
180 config.add_view_deriver(
181 translated_view, over="rendered_view", under=viewderivers.INGRESS
182 )
183
```
--- 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/warehouse/i18n/__init__.py b/warehouse/i18n/__init__.py
--- a/warehouse/i18n/__init__.py
+++ b/warehouse/i18n/__init__.py
@@ -31,6 +31,7 @@
"el": "Ελληνικά", # Greek
"de": "Deutsch", # German
"zh_Hans": "简体中文", # Simplified Chinese
+ "ru": "Русский", # Russian
}
LOCALE_ATTR = "_LOCALE_"
| {"golden_diff": "diff --git a/warehouse/i18n/__init__.py b/warehouse/i18n/__init__.py\n--- a/warehouse/i18n/__init__.py\n+++ b/warehouse/i18n/__init__.py\n@@ -31,6 +31,7 @@\n \"el\": \"\u0395\u03bb\u03bb\u03b7\u03bd\u03b9\u03ba\u03ac\", # Greek\n \"de\": \"Deutsch\", # German\n \"zh_Hans\": \"\u7b80\u4f53\u4e2d\u6587\", # Simplified Chinese\n+ \"ru\": \"\u0420\u0443\u0441\u0441\u043a\u0438\u0439\", # Russian\n }\n \n LOCALE_ATTR = \"_LOCALE_\"\n", "issue": "Add Russian translation\nThe Russian Translation is at [100% on Weblate](https://hosted.weblate.org/languages/ru/pypa/) so I think it should be added to the localization footer.\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\nimport functools\n\nfrom babel.core import Locale\nfrom pyramid import viewderivers\nfrom pyramid.i18n import TranslationStringFactory, default_locale_negotiator\nfrom pyramid.threadlocal import get_current_request\n\nfrom warehouse.cache.http import add_vary\n\n# Taken from:\n# https://github.com/django/django/blob/master/django/conf/locale/__init__.py\nKNOWN_LOCALES = {\n \"en\": \"English\", # English\n \"es\": \"espa\u00f1ol\", # Spanish\n \"fr\": \"fran\u00e7ais\", # French\n \"ja\": \"\u65e5\u672c\u8a9e\", # Japanese\n \"pt_BR\": \"Portugu\u00eas Brasileiro\", # Brazilian Portugeuse\n \"uk\": \"\u0423\u043a\u0440\u0430\u0457\u043d\u0441\u044c\u043a\u0430\", # Ukrainian\n \"el\": \"\u0395\u03bb\u03bb\u03b7\u03bd\u03b9\u03ba\u03ac\", # Greek\n \"de\": \"Deutsch\", # German\n \"zh_Hans\": \"\u7b80\u4f53\u4e2d\u6587\", # Simplified Chinese\n}\n\nLOCALE_ATTR = \"_LOCALE_\"\n\n_translation_factory = TranslationStringFactory(\"messages\")\n\n\nclass LazyString:\n def __init__(self, fn, *args, **kwargs):\n self.fn = fn\n self.args = args\n self.mapping = kwargs.get(\"mapping\", {})\n self.kwargs = kwargs\n\n def __json__(self, request):\n return str(self)\n\n def __mod__(self, new_mapping):\n mapping = self.mapping.copy()\n mapping.update(new_mapping)\n return LazyString(self.fn, *self.args, mapping=new_mapping, **self.kwargs)\n\n def __str__(self):\n return self.fn(*self.args, **self.kwargs)\n\n\ndef _locale(request):\n \"\"\"\n Computes a babel.core:Locale() object for this request.\n \"\"\"\n return Locale.parse(request.locale_name, sep=\"_\")\n\n\ndef _negotiate_locale(request):\n locale_name = getattr(request, LOCALE_ATTR, None)\n if locale_name is not None:\n return locale_name\n\n locale_name = request.params.get(LOCALE_ATTR)\n if locale_name is not None:\n return locale_name\n\n locale_name = request.cookies.get(LOCALE_ATTR)\n if locale_name is not None:\n return locale_name\n\n if not request.accept_language:\n return default_locale_negotiator(request)\n\n return request.accept_language.best_match(\n tuple(KNOWN_LOCALES.keys()), default_match=default_locale_negotiator(request)\n )\n\n\ndef localize(message, **kwargs):\n def _localize(message, **kwargs):\n request = get_current_request()\n return request.localizer.translate(_translation_factory(message, **kwargs))\n\n return LazyString(_localize, message, **kwargs)\n\n\nclass InvalidLocalizer:\n def _fail(self):\n raise RuntimeError(\"Cannot use localizer without has_translations=True\")\n\n @property\n def locale_name(self):\n self._fail()\n\n def pluralize(self, *args, **kwargs):\n self._fail()\n\n def translate(self, *args, **kwargs):\n self._fail()\n\n\ndef translated_view(view, info):\n if info.options.get(\"has_translations\"):\n # If this page can be translated, then we'll add a Vary: PyPI-Locale\n # Vary header.\n # Note: This will give weird results if hitting PyPI directly instead of through\n # the Fastly VCL which sets PyPI-Locale.\n return add_vary(\"PyPI-Locale\")(view)\n elif info.exception_only:\n return view\n else:\n # If we're not using translations on this view, then we'll wrap the view\n # with a wrapper that just ensures that the localizer cannot be used.\n @functools.wraps(view)\n def wrapped(context, request):\n # This whole method is a little bit of an odd duck, we want to make\n # sure that we don't actually *access* request.localizer, because\n # doing so triggers the machinery to create a new localizer. So\n # instead we will dig into the request object __dict__ to\n # effectively do the same thing, just without triggering an access\n # on request.localizer.\n\n # Save the original session so that we can restore it once the\n # inner views have been called.\n nothing = object()\n original_localizer = request.__dict__.get(\"localizer\", nothing)\n\n # This particular view hasn't been set to allow access to the\n # translations, so we'll just assign an InvalidLocalizer to\n # request.localizer\n request.__dict__[\"localizer\"] = InvalidLocalizer()\n\n try:\n # Invoke the real view\n return view(context, request)\n finally:\n # Restore the original session so that things like\n # pyramid_debugtoolbar can access it.\n if original_localizer is nothing:\n del request.__dict__[\"localizer\"]\n else:\n request.__dict__[\"localizer\"] = original_localizer\n\n return wrapped\n\n\ntranslated_view.options = {\"has_translations\"}\n\n\ndef includeme(config):\n # Add the request attributes\n config.add_request_method(_locale, name=\"locale\", reify=True)\n\n # Register our translation directory.\n config.add_translation_dirs(\"warehouse:locale/\")\n\n config.set_locale_negotiator(_negotiate_locale)\n\n # Register our i18n/l10n filters for Jinja2\n filters = config.get_settings().setdefault(\"jinja2.filters\", {})\n filters.setdefault(\"format_date\", \"warehouse.i18n.filters:format_date\")\n filters.setdefault(\"format_datetime\", \"warehouse.i18n.filters:format_datetime\")\n filters.setdefault(\n \"format_rfc822_datetime\", \"warehouse.i18n.filters:format_rfc822_datetime\"\n )\n filters.setdefault(\"format_number\", \"warehouse.i18n.filters:format_number\")\n\n jglobals = config.get_settings().setdefault(\"jinja2.globals\", {})\n jglobals.setdefault(\"KNOWN_LOCALES\", \"warehouse.i18n:KNOWN_LOCALES\")\n\n config.add_view_deriver(\n translated_view, over=\"rendered_view\", under=viewderivers.INGRESS\n )\n", "path": "warehouse/i18n/__init__.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\nimport functools\n\nfrom babel.core import Locale\nfrom pyramid import viewderivers\nfrom pyramid.i18n import TranslationStringFactory, default_locale_negotiator\nfrom pyramid.threadlocal import get_current_request\n\nfrom warehouse.cache.http import add_vary\n\n# Taken from:\n# https://github.com/django/django/blob/master/django/conf/locale/__init__.py\nKNOWN_LOCALES = {\n \"en\": \"English\", # English\n \"es\": \"espa\u00f1ol\", # Spanish\n \"fr\": \"fran\u00e7ais\", # French\n \"ja\": \"\u65e5\u672c\u8a9e\", # Japanese\n \"pt_BR\": \"Portugu\u00eas Brasileiro\", # Brazilian Portugeuse\n \"uk\": \"\u0423\u043a\u0440\u0430\u0457\u043d\u0441\u044c\u043a\u0430\", # Ukrainian\n \"el\": \"\u0395\u03bb\u03bb\u03b7\u03bd\u03b9\u03ba\u03ac\", # Greek\n \"de\": \"Deutsch\", # German\n \"zh_Hans\": \"\u7b80\u4f53\u4e2d\u6587\", # Simplified Chinese\n \"ru\": \"\u0420\u0443\u0441\u0441\u043a\u0438\u0439\", # Russian\n}\n\nLOCALE_ATTR = \"_LOCALE_\"\n\n_translation_factory = TranslationStringFactory(\"messages\")\n\n\nclass LazyString:\n def __init__(self, fn, *args, **kwargs):\n self.fn = fn\n self.args = args\n self.mapping = kwargs.get(\"mapping\", {})\n self.kwargs = kwargs\n\n def __json__(self, request):\n return str(self)\n\n def __mod__(self, new_mapping):\n mapping = self.mapping.copy()\n mapping.update(new_mapping)\n return LazyString(self.fn, *self.args, mapping=new_mapping, **self.kwargs)\n\n def __str__(self):\n return self.fn(*self.args, **self.kwargs)\n\n\ndef _locale(request):\n \"\"\"\n Computes a babel.core:Locale() object for this request.\n \"\"\"\n return Locale.parse(request.locale_name, sep=\"_\")\n\n\ndef _negotiate_locale(request):\n locale_name = getattr(request, LOCALE_ATTR, None)\n if locale_name is not None:\n return locale_name\n\n locale_name = request.params.get(LOCALE_ATTR)\n if locale_name is not None:\n return locale_name\n\n locale_name = request.cookies.get(LOCALE_ATTR)\n if locale_name is not None:\n return locale_name\n\n if not request.accept_language:\n return default_locale_negotiator(request)\n\n return request.accept_language.best_match(\n tuple(KNOWN_LOCALES.keys()), default_match=default_locale_negotiator(request)\n )\n\n\ndef localize(message, **kwargs):\n def _localize(message, **kwargs):\n request = get_current_request()\n return request.localizer.translate(_translation_factory(message, **kwargs))\n\n return LazyString(_localize, message, **kwargs)\n\n\nclass InvalidLocalizer:\n def _fail(self):\n raise RuntimeError(\"Cannot use localizer without has_translations=True\")\n\n @property\n def locale_name(self):\n self._fail()\n\n def pluralize(self, *args, **kwargs):\n self._fail()\n\n def translate(self, *args, **kwargs):\n self._fail()\n\n\ndef translated_view(view, info):\n if info.options.get(\"has_translations\"):\n # If this page can be translated, then we'll add a Vary: PyPI-Locale\n # Vary header.\n # Note: This will give weird results if hitting PyPI directly instead of through\n # the Fastly VCL which sets PyPI-Locale.\n return add_vary(\"PyPI-Locale\")(view)\n elif info.exception_only:\n return view\n else:\n # If we're not using translations on this view, then we'll wrap the view\n # with a wrapper that just ensures that the localizer cannot be used.\n @functools.wraps(view)\n def wrapped(context, request):\n # This whole method is a little bit of an odd duck, we want to make\n # sure that we don't actually *access* request.localizer, because\n # doing so triggers the machinery to create a new localizer. So\n # instead we will dig into the request object __dict__ to\n # effectively do the same thing, just without triggering an access\n # on request.localizer.\n\n # Save the original session so that we can restore it once the\n # inner views have been called.\n nothing = object()\n original_localizer = request.__dict__.get(\"localizer\", nothing)\n\n # This particular view hasn't been set to allow access to the\n # translations, so we'll just assign an InvalidLocalizer to\n # request.localizer\n request.__dict__[\"localizer\"] = InvalidLocalizer()\n\n try:\n # Invoke the real view\n return view(context, request)\n finally:\n # Restore the original session so that things like\n # pyramid_debugtoolbar can access it.\n if original_localizer is nothing:\n del request.__dict__[\"localizer\"]\n else:\n request.__dict__[\"localizer\"] = original_localizer\n\n return wrapped\n\n\ntranslated_view.options = {\"has_translations\"}\n\n\ndef includeme(config):\n # Add the request attributes\n config.add_request_method(_locale, name=\"locale\", reify=True)\n\n # Register our translation directory.\n config.add_translation_dirs(\"warehouse:locale/\")\n\n config.set_locale_negotiator(_negotiate_locale)\n\n # Register our i18n/l10n filters for Jinja2\n filters = config.get_settings().setdefault(\"jinja2.filters\", {})\n filters.setdefault(\"format_date\", \"warehouse.i18n.filters:format_date\")\n filters.setdefault(\"format_datetime\", \"warehouse.i18n.filters:format_datetime\")\n filters.setdefault(\n \"format_rfc822_datetime\", \"warehouse.i18n.filters:format_rfc822_datetime\"\n )\n filters.setdefault(\"format_number\", \"warehouse.i18n.filters:format_number\")\n\n jglobals = config.get_settings().setdefault(\"jinja2.globals\", {})\n jglobals.setdefault(\"KNOWN_LOCALES\", \"warehouse.i18n:KNOWN_LOCALES\")\n\n config.add_view_deriver(\n translated_view, over=\"rendered_view\", under=viewderivers.INGRESS\n )\n", "path": "warehouse/i18n/__init__.py"}]} |
gh_patches_debug_217 | rasdani/github-patches | git_diff | getpelican__pelican-905 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
pelican-quickstart: error with accented characters
Hello,
I've got a problem with pelican-quickstart, when I put accented characters in answers.
Here is the output I got :
> Who will be the author of this web site? Guillaume LAMÉ
> Traceback (most recent call last):
> File "/home/lomig/StaticGen/Pelican/bin/pelican-quickstart", line 9, in <module>
> load_entry_point('pelican==3.2.1', 'console_scripts', 'pelican-quickstart')()
> File "/home/lomig/StaticGen/Pelican/local/lib/python2.7/site-packages/pelican/tools/pelican_quickstart.py", line 184, in main
> CONF['author'] = ask('Who will be the author of this web site?', answer=str_compat, default=args.author)
> File "/home/lomig/StaticGen/Pelican/local/lib/python2.7/site-packages/pelican/tools/pelican_quickstart.py", line 57, in wrapper
> return out.decode(sys.stdin.encoding)
> File "/home/lomig/StaticGen/Pelican/lib/python2.7/encodings/utf_8.py", line 16, in decode
> return codecs.utf_8_decode(input, errors, True)
> UnicodeEncodeError: 'ascii' codec can't encode character u'\xc9' in position 13: ordinal not in range(128)
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: `pelican/tools/pelican_quickstart.py`
Content:
```
1 #!/usr/bin/env python
2
3 # -*- coding: utf-8 -*-
4 from __future__ import unicode_literals, print_function
5 import six
6
7 import os
8 import string
9 import argparse
10 import sys
11 import codecs
12
13 from pelican import __version__
14
15 _TEMPLATES_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)),
16 "templates")
17
18 CONF = {
19 'pelican': 'pelican',
20 'pelicanopts': '',
21 'basedir': os.curdir,
22 'ftp_host': 'localhost',
23 'ftp_user': 'anonymous',
24 'ftp_target_dir': '/',
25 'ssh_host': 'localhost',
26 'ssh_port': 22,
27 'ssh_user': 'root',
28 'ssh_target_dir': '/var/www',
29 's3_bucket': 'my_s3_bucket',
30 'dropbox_dir': '~/Dropbox/Public/',
31 'default_pagination': 10,
32 'siteurl': '',
33 'lang': 'en'
34 }
35
36 def _input_compat(prompt):
37 if six.PY3:
38 r = input(prompt)
39 else:
40 # FIXME: why use this with @decoding_strings?
41 r = raw_input(prompt).decode('utf-8')
42 return r
43
44 if six.PY3:
45 str_compat = str
46 else:
47 str_compat = unicode
48
49 def decoding_strings(f):
50 def wrapper(*args, **kwargs):
51 out = f(*args, **kwargs)
52 if isinstance(out, six.string_types) and not six.PY3:
53 # todo: make encoding configurable?
54 if six.PY3:
55 return out
56 else:
57 return out.decode(sys.stdin.encoding)
58 return out
59 return wrapper
60
61
62 def get_template(name, as_encoding='utf-8'):
63 template = os.path.join(_TEMPLATES_DIR, "{0}.in".format(name))
64
65 if not os.path.isfile(template):
66 raise RuntimeError("Cannot open {0}".format(template))
67
68 with codecs.open(template, 'r', as_encoding) as fd:
69 line = fd.readline()
70 while line:
71 yield line
72 line = fd.readline()
73 fd.close()
74
75
76 @decoding_strings
77 def ask(question, answer=str_compat, default=None, l=None):
78 if answer == str_compat:
79 r = ''
80 while True:
81 if default:
82 r = _input_compat('> {0} [{1}] '.format(question, default))
83 else:
84 r = _input_compat('> {0} '.format(question, default))
85
86 r = r.strip()
87
88 if len(r) <= 0:
89 if default:
90 r = default
91 break
92 else:
93 print('You must enter something')
94 else:
95 if l and len(r) != l:
96 print('You must enter a {0} letters long string'.format(l))
97 else:
98 break
99
100 return r
101
102 elif answer == bool:
103 r = None
104 while True:
105 if default is True:
106 r = _input_compat('> {0} (Y/n) '.format(question))
107 elif default is False:
108 r = _input_compat('> {0} (y/N) '.format(question))
109 else:
110 r = _input_compat('> {0} (y/n) '.format(question))
111
112 r = r.strip().lower()
113
114 if r in ('y', 'yes'):
115 r = True
116 break
117 elif r in ('n', 'no'):
118 r = False
119 break
120 elif not r:
121 r = default
122 break
123 else:
124 print("You must answer 'yes' or 'no'")
125 return r
126 elif answer == int:
127 r = None
128 while True:
129 if default:
130 r = _input_compat('> {0} [{1}] '.format(question, default))
131 else:
132 r = _input_compat('> {0} '.format(question))
133
134 r = r.strip()
135
136 if not r:
137 r = default
138 break
139
140 try:
141 r = int(r)
142 break
143 except:
144 print('You must enter an integer')
145 return r
146 else:
147 raise NotImplemented('Argument `answer` must be str_compat, bool, or integer')
148
149
150 def main():
151 parser = argparse.ArgumentParser(
152 description="A kickstarter for Pelican",
153 formatter_class=argparse.ArgumentDefaultsHelpFormatter)
154 parser.add_argument('-p', '--path', default=os.curdir,
155 help="The path to generate the blog into")
156 parser.add_argument('-t', '--title', metavar="title",
157 help='Set the title of the website')
158 parser.add_argument('-a', '--author', metavar="author",
159 help='Set the author name of the website')
160 parser.add_argument('-l', '--lang', metavar="lang",
161 help='Set the default web site language')
162
163 args = parser.parse_args()
164
165 print('''Welcome to pelican-quickstart v{v}.
166
167 This script will help you create a new Pelican-based website.
168
169 Please answer the following questions so this script can generate the files
170 needed by Pelican.
171
172 '''.format(v=__version__))
173
174 project = os.path.join(
175 os.environ.get('VIRTUAL_ENV', os.curdir), '.project')
176 if os.path.isfile(project):
177 CONF['basedir'] = open(project, 'r').read().rstrip("\n")
178 print('Using project associated with current virtual environment.'
179 'Will save to:\n%s\n' % CONF['basedir'])
180 else:
181 CONF['basedir'] = os.path.abspath(ask('Where do you want to create your new web site?', answer=str_compat, default=args.path))
182
183 CONF['sitename'] = ask('What will be the title of this web site?', answer=str_compat, default=args.title)
184 CONF['author'] = ask('Who will be the author of this web site?', answer=str_compat, default=args.author)
185 CONF['lang'] = ask('What will be the default language of this web site?', str_compat, args.lang or CONF['lang'], 2)
186
187 if ask('Do you want to specify a URL prefix? e.g., http://example.com ', answer=bool, default=True):
188 CONF['siteurl'] = ask('What is your URL prefix? (see above example; no trailing slash)', str_compat, CONF['siteurl'])
189
190 CONF['with_pagination'] = ask('Do you want to enable article pagination?', bool, bool(CONF['default_pagination']))
191
192 if CONF['with_pagination']:
193 CONF['default_pagination'] = ask('How many articles per page do you want?', int, CONF['default_pagination'])
194 else:
195 CONF['default_pagination'] = False
196
197 mkfile = ask('Do you want to generate a Makefile to easily manage your website?', bool, True)
198 develop = ask('Do you want an auto-reload & simpleHTTP script to assist with theme and site development?', bool, True)
199
200 if mkfile:
201 if ask('Do you want to upload your website using FTP?', answer=bool, default=False):
202 CONF['ftp_host'] = ask('What is the hostname of your FTP server?', str_compat, CONF['ftp_host'])
203 CONF['ftp_user'] = ask('What is your username on that server?', str_compat, CONF['ftp_user'])
204 CONF['ftp_target_dir'] = ask('Where do you want to put your web site on that server?', str_compat, CONF['ftp_target_dir'])
205 if ask('Do you want to upload your website using SSH?', answer=bool, default=False):
206 CONF['ssh_host'] = ask('What is the hostname of your SSH server?', str_compat, CONF['ssh_host'])
207 CONF['ssh_port'] = ask('What is the port of your SSH server?', int, CONF['ssh_port'])
208 CONF['ssh_user'] = ask('What is your username on that server?', str_compat, CONF['ssh_user'])
209 CONF['ssh_target_dir'] = ask('Where do you want to put your web site on that server?', str_compat, CONF['ssh_target_dir'])
210 if ask('Do you want to upload your website using Dropbox?', answer=bool, default=False):
211 CONF['dropbox_dir'] = ask('Where is your Dropbox directory?', str_compat, CONF['dropbox_dir'])
212 if ask('Do you want to upload your website using S3?', answer=bool, default=False):
213 CONF['s3_bucket'] = ask('What is the name of your S3 bucket?', str_compat, CONF['s3_bucket'])
214
215 try:
216 os.makedirs(os.path.join(CONF['basedir'], 'content'))
217 except OSError as e:
218 print('Error: {0}'.format(e))
219
220 try:
221 os.makedirs(os.path.join(CONF['basedir'], 'output'))
222 except OSError as e:
223 print('Error: {0}'.format(e))
224
225 try:
226 with codecs.open(os.path.join(CONF['basedir'], 'pelicanconf.py'), 'w', 'utf-8') as fd:
227 conf_python = dict()
228 for key, value in CONF.items():
229 conf_python[key] = repr(value)
230
231 for line in get_template('pelicanconf.py'):
232 template = string.Template(line)
233 fd.write(template.safe_substitute(conf_python))
234 fd.close()
235 except OSError as e:
236 print('Error: {0}'.format(e))
237
238 try:
239 with codecs.open(os.path.join(CONF['basedir'], 'publishconf.py'), 'w', 'utf-8') as fd:
240 for line in get_template('publishconf.py'):
241 template = string.Template(line)
242 fd.write(template.safe_substitute(CONF))
243 fd.close()
244 except OSError as e:
245 print('Error: {0}'.format(e))
246
247 if mkfile:
248 try:
249 with codecs.open(os.path.join(CONF['basedir'], 'Makefile'), 'w', 'utf-8') as fd:
250 mkfile_template_name = 'Makefile'
251 py_v = 'PY=python'
252 if six.PY3:
253 py_v = 'PY=python3'
254 template = string.Template(py_v)
255 fd.write(template.safe_substitute(CONF))
256 fd.write('\n')
257 for line in get_template(mkfile_template_name):
258 template = string.Template(line)
259 fd.write(template.safe_substitute(CONF))
260 fd.close()
261 except OSError as e:
262 print('Error: {0}'.format(e))
263
264 if develop:
265 conf_shell = dict()
266 for key, value in CONF.items():
267 if isinstance(value, six.string_types) and ' ' in value:
268 value = '"' + value.replace('"', '\\"') + '"'
269 conf_shell[key] = value
270 try:
271 with codecs.open(os.path.join(CONF['basedir'], 'develop_server.sh'), 'w', 'utf-8') as fd:
272 lines = list(get_template('develop_server.sh'))
273 py_v = 'PY=python\n'
274 if six.PY3:
275 py_v = 'PY=python3\n'
276 lines = lines[:4] + [py_v] + lines[4:]
277 for line in lines:
278 template = string.Template(line)
279 fd.write(template.safe_substitute(conf_shell))
280 fd.close()
281 os.chmod((os.path.join(CONF['basedir'], 'develop_server.sh')), 493) # mode 0o755
282 except OSError as e:
283 print('Error: {0}'.format(e))
284
285 print('Done. Your new project is available at %s' % CONF['basedir'])
286
```
--- 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/pelican/tools/pelican_quickstart.py b/pelican/tools/pelican_quickstart.py
--- a/pelican/tools/pelican_quickstart.py
+++ b/pelican/tools/pelican_quickstart.py
@@ -37,8 +37,7 @@
if six.PY3:
r = input(prompt)
else:
- # FIXME: why use this with @decoding_strings?
- r = raw_input(prompt).decode('utf-8')
+ r = raw_input(prompt)
return r
if six.PY3:
| {"golden_diff": "diff --git a/pelican/tools/pelican_quickstart.py b/pelican/tools/pelican_quickstart.py\n--- a/pelican/tools/pelican_quickstart.py\n+++ b/pelican/tools/pelican_quickstart.py\n@@ -37,8 +37,7 @@\n if six.PY3:\n r = input(prompt)\n else:\n- # FIXME: why use this with @decoding_strings?\n- r = raw_input(prompt).decode('utf-8')\n+ r = raw_input(prompt)\n return r\n \n if six.PY3:\n", "issue": "pelican-quickstart: error with accented characters\nHello,\n\nI've got a problem with pelican-quickstart, when I put accented characters in answers.\n\nHere is the output I got : \n\n> Who will be the author of this web site? Guillaume LAM\u00c9\n> Traceback (most recent call last):\n> File \"/home/lomig/StaticGen/Pelican/bin/pelican-quickstart\", line 9, in <module>\n> load_entry_point('pelican==3.2.1', 'console_scripts', 'pelican-quickstart')()\n> File \"/home/lomig/StaticGen/Pelican/local/lib/python2.7/site-packages/pelican/tools/pelican_quickstart.py\", line 184, in main\n> CONF['author'] = ask('Who will be the author of this web site?', answer=str_compat, default=args.author)\n> File \"/home/lomig/StaticGen/Pelican/local/lib/python2.7/site-packages/pelican/tools/pelican_quickstart.py\", line 57, in wrapper\n> return out.decode(sys.stdin.encoding)\n> File \"/home/lomig/StaticGen/Pelican/lib/python2.7/encodings/utf_8.py\", line 16, in decode\n> return codecs.utf_8_decode(input, errors, True)\n> UnicodeEncodeError: 'ascii' codec can't encode character u'\\xc9' in position 13: ordinal not in range(128)\n\nThanks.\n\n", "before_files": [{"content": "#!/usr/bin/env python\n\n# -*- coding: utf-8 -*-\nfrom __future__ import unicode_literals, print_function\nimport six\n\nimport os\nimport string\nimport argparse\nimport sys\nimport codecs\n\nfrom pelican import __version__\n\n_TEMPLATES_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)),\n \"templates\")\n\nCONF = {\n 'pelican': 'pelican',\n 'pelicanopts': '',\n 'basedir': os.curdir,\n 'ftp_host': 'localhost',\n 'ftp_user': 'anonymous',\n 'ftp_target_dir': '/',\n 'ssh_host': 'localhost',\n 'ssh_port': 22,\n 'ssh_user': 'root',\n 'ssh_target_dir': '/var/www',\n 's3_bucket': 'my_s3_bucket',\n 'dropbox_dir': '~/Dropbox/Public/',\n 'default_pagination': 10,\n 'siteurl': '',\n 'lang': 'en'\n}\n\ndef _input_compat(prompt):\n if six.PY3:\n r = input(prompt)\n else:\n # FIXME: why use this with @decoding_strings?\n r = raw_input(prompt).decode('utf-8')\n return r\n\nif six.PY3:\n str_compat = str\nelse:\n str_compat = unicode\n\ndef decoding_strings(f):\n def wrapper(*args, **kwargs):\n out = f(*args, **kwargs)\n if isinstance(out, six.string_types) and not six.PY3:\n # todo: make encoding configurable?\n if six.PY3:\n return out\n else:\n return out.decode(sys.stdin.encoding)\n return out\n return wrapper\n\n\ndef get_template(name, as_encoding='utf-8'):\n template = os.path.join(_TEMPLATES_DIR, \"{0}.in\".format(name))\n\n if not os.path.isfile(template):\n raise RuntimeError(\"Cannot open {0}\".format(template))\n\n with codecs.open(template, 'r', as_encoding) as fd:\n line = fd.readline()\n while line:\n yield line\n line = fd.readline()\n fd.close()\n\n\n@decoding_strings\ndef ask(question, answer=str_compat, default=None, l=None):\n if answer == str_compat:\n r = ''\n while True:\n if default:\n r = _input_compat('> {0} [{1}] '.format(question, default))\n else:\n r = _input_compat('> {0} '.format(question, default))\n\n r = r.strip()\n\n if len(r) <= 0:\n if default:\n r = default\n break\n else:\n print('You must enter something')\n else:\n if l and len(r) != l:\n print('You must enter a {0} letters long string'.format(l))\n else:\n break\n\n return r\n\n elif answer == bool:\n r = None\n while True:\n if default is True:\n r = _input_compat('> {0} (Y/n) '.format(question))\n elif default is False:\n r = _input_compat('> {0} (y/N) '.format(question))\n else:\n r = _input_compat('> {0} (y/n) '.format(question))\n\n r = r.strip().lower()\n\n if r in ('y', 'yes'):\n r = True\n break\n elif r in ('n', 'no'):\n r = False\n break\n elif not r:\n r = default\n break\n else:\n print(\"You must answer 'yes' or 'no'\")\n return r\n elif answer == int:\n r = None\n while True:\n if default:\n r = _input_compat('> {0} [{1}] '.format(question, default))\n else:\n r = _input_compat('> {0} '.format(question))\n\n r = r.strip()\n\n if not r:\n r = default\n break\n\n try:\n r = int(r)\n break\n except:\n print('You must enter an integer')\n return r\n else:\n raise NotImplemented('Argument `answer` must be str_compat, bool, or integer')\n\n\ndef main():\n parser = argparse.ArgumentParser(\n description=\"A kickstarter for Pelican\",\n formatter_class=argparse.ArgumentDefaultsHelpFormatter)\n parser.add_argument('-p', '--path', default=os.curdir,\n help=\"The path to generate the blog into\")\n parser.add_argument('-t', '--title', metavar=\"title\",\n help='Set the title of the website')\n parser.add_argument('-a', '--author', metavar=\"author\",\n help='Set the author name of the website')\n parser.add_argument('-l', '--lang', metavar=\"lang\",\n help='Set the default web site language')\n\n args = parser.parse_args()\n\n print('''Welcome to pelican-quickstart v{v}.\n\nThis script will help you create a new Pelican-based website.\n\nPlease answer the following questions so this script can generate the files\nneeded by Pelican.\n\n '''.format(v=__version__))\n\n project = os.path.join(\n os.environ.get('VIRTUAL_ENV', os.curdir), '.project')\n if os.path.isfile(project):\n CONF['basedir'] = open(project, 'r').read().rstrip(\"\\n\")\n print('Using project associated with current virtual environment.'\n 'Will save to:\\n%s\\n' % CONF['basedir'])\n else:\n CONF['basedir'] = os.path.abspath(ask('Where do you want to create your new web site?', answer=str_compat, default=args.path))\n\n CONF['sitename'] = ask('What will be the title of this web site?', answer=str_compat, default=args.title)\n CONF['author'] = ask('Who will be the author of this web site?', answer=str_compat, default=args.author)\n CONF['lang'] = ask('What will be the default language of this web site?', str_compat, args.lang or CONF['lang'], 2)\n\n if ask('Do you want to specify a URL prefix? e.g., http://example.com ', answer=bool, default=True):\n CONF['siteurl'] = ask('What is your URL prefix? (see above example; no trailing slash)', str_compat, CONF['siteurl'])\n\n CONF['with_pagination'] = ask('Do you want to enable article pagination?', bool, bool(CONF['default_pagination']))\n\n if CONF['with_pagination']:\n CONF['default_pagination'] = ask('How many articles per page do you want?', int, CONF['default_pagination'])\n else:\n CONF['default_pagination'] = False\n\n mkfile = ask('Do you want to generate a Makefile to easily manage your website?', bool, True)\n develop = ask('Do you want an auto-reload & simpleHTTP script to assist with theme and site development?', bool, True)\n\n if mkfile:\n if ask('Do you want to upload your website using FTP?', answer=bool, default=False):\n CONF['ftp_host'] = ask('What is the hostname of your FTP server?', str_compat, CONF['ftp_host'])\n CONF['ftp_user'] = ask('What is your username on that server?', str_compat, CONF['ftp_user'])\n CONF['ftp_target_dir'] = ask('Where do you want to put your web site on that server?', str_compat, CONF['ftp_target_dir'])\n if ask('Do you want to upload your website using SSH?', answer=bool, default=False):\n CONF['ssh_host'] = ask('What is the hostname of your SSH server?', str_compat, CONF['ssh_host'])\n CONF['ssh_port'] = ask('What is the port of your SSH server?', int, CONF['ssh_port'])\n CONF['ssh_user'] = ask('What is your username on that server?', str_compat, CONF['ssh_user'])\n CONF['ssh_target_dir'] = ask('Where do you want to put your web site on that server?', str_compat, CONF['ssh_target_dir'])\n if ask('Do you want to upload your website using Dropbox?', answer=bool, default=False):\n CONF['dropbox_dir'] = ask('Where is your Dropbox directory?', str_compat, CONF['dropbox_dir'])\n if ask('Do you want to upload your website using S3?', answer=bool, default=False):\n CONF['s3_bucket'] = ask('What is the name of your S3 bucket?', str_compat, CONF['s3_bucket'])\n\n try:\n os.makedirs(os.path.join(CONF['basedir'], 'content'))\n except OSError as e:\n print('Error: {0}'.format(e))\n\n try:\n os.makedirs(os.path.join(CONF['basedir'], 'output'))\n except OSError as e:\n print('Error: {0}'.format(e))\n\n try:\n with codecs.open(os.path.join(CONF['basedir'], 'pelicanconf.py'), 'w', 'utf-8') as fd:\n conf_python = dict()\n for key, value in CONF.items():\n conf_python[key] = repr(value)\n\n for line in get_template('pelicanconf.py'):\n template = string.Template(line)\n fd.write(template.safe_substitute(conf_python))\n fd.close()\n except OSError as e:\n print('Error: {0}'.format(e))\n\n try:\n with codecs.open(os.path.join(CONF['basedir'], 'publishconf.py'), 'w', 'utf-8') as fd:\n for line in get_template('publishconf.py'):\n template = string.Template(line)\n fd.write(template.safe_substitute(CONF))\n fd.close()\n except OSError as e:\n print('Error: {0}'.format(e))\n\n if mkfile:\n try:\n with codecs.open(os.path.join(CONF['basedir'], 'Makefile'), 'w', 'utf-8') as fd:\n mkfile_template_name = 'Makefile'\n py_v = 'PY=python'\n if six.PY3:\n py_v = 'PY=python3'\n template = string.Template(py_v)\n fd.write(template.safe_substitute(CONF))\n fd.write('\\n')\n for line in get_template(mkfile_template_name):\n template = string.Template(line)\n fd.write(template.safe_substitute(CONF))\n fd.close()\n except OSError as e:\n print('Error: {0}'.format(e))\n\n if develop:\n conf_shell = dict()\n for key, value in CONF.items():\n if isinstance(value, six.string_types) and ' ' in value:\n value = '\"' + value.replace('\"', '\\\\\"') + '\"'\n conf_shell[key] = value\n try:\n with codecs.open(os.path.join(CONF['basedir'], 'develop_server.sh'), 'w', 'utf-8') as fd:\n lines = list(get_template('develop_server.sh'))\n py_v = 'PY=python\\n'\n if six.PY3:\n py_v = 'PY=python3\\n'\n lines = lines[:4] + [py_v] + lines[4:]\n for line in lines:\n template = string.Template(line)\n fd.write(template.safe_substitute(conf_shell))\n fd.close()\n os.chmod((os.path.join(CONF['basedir'], 'develop_server.sh')), 493) # mode 0o755\n except OSError as e:\n print('Error: {0}'.format(e))\n\n print('Done. Your new project is available at %s' % CONF['basedir'])\n", "path": "pelican/tools/pelican_quickstart.py"}], "after_files": [{"content": "#!/usr/bin/env python\n\n# -*- coding: utf-8 -*-\nfrom __future__ import unicode_literals, print_function\nimport six\n\nimport os\nimport string\nimport argparse\nimport sys\nimport codecs\n\nfrom pelican import __version__\n\n_TEMPLATES_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)),\n \"templates\")\n\nCONF = {\n 'pelican': 'pelican',\n 'pelicanopts': '',\n 'basedir': os.curdir,\n 'ftp_host': 'localhost',\n 'ftp_user': 'anonymous',\n 'ftp_target_dir': '/',\n 'ssh_host': 'localhost',\n 'ssh_port': 22,\n 'ssh_user': 'root',\n 'ssh_target_dir': '/var/www',\n 's3_bucket': 'my_s3_bucket',\n 'dropbox_dir': '~/Dropbox/Public/',\n 'default_pagination': 10,\n 'siteurl': '',\n 'lang': 'en'\n}\n\ndef _input_compat(prompt):\n if six.PY3:\n r = input(prompt)\n else:\n r = raw_input(prompt)\n return r\n\nif six.PY3:\n str_compat = str\nelse:\n str_compat = unicode\n\ndef decoding_strings(f):\n def wrapper(*args, **kwargs):\n out = f(*args, **kwargs)\n if isinstance(out, six.string_types) and not six.PY3:\n # todo: make encoding configurable?\n if six.PY3:\n return out\n else:\n return out.decode(sys.stdin.encoding)\n return out\n return wrapper\n\n\ndef get_template(name, as_encoding='utf-8'):\n template = os.path.join(_TEMPLATES_DIR, \"{0}.in\".format(name))\n\n if not os.path.isfile(template):\n raise RuntimeError(\"Cannot open {0}\".format(template))\n\n with codecs.open(template, 'r', as_encoding) as fd:\n line = fd.readline()\n while line:\n yield line\n line = fd.readline()\n fd.close()\n\n\n@decoding_strings\ndef ask(question, answer=str_compat, default=None, l=None):\n if answer == str_compat:\n r = ''\n while True:\n if default:\n r = _input_compat('> {0} [{1}] '.format(question, default))\n else:\n r = _input_compat('> {0} '.format(question, default))\n\n r = r.strip()\n\n if len(r) <= 0:\n if default:\n r = default\n break\n else:\n print('You must enter something')\n else:\n if l and len(r) != l:\n print('You must enter a {0} letters long string'.format(l))\n else:\n break\n\n return r\n\n elif answer == bool:\n r = None\n while True:\n if default is True:\n r = _input_compat('> {0} (Y/n) '.format(question))\n elif default is False:\n r = _input_compat('> {0} (y/N) '.format(question))\n else:\n r = _input_compat('> {0} (y/n) '.format(question))\n\n r = r.strip().lower()\n\n if r in ('y', 'yes'):\n r = True\n break\n elif r in ('n', 'no'):\n r = False\n break\n elif not r:\n r = default\n break\n else:\n print(\"You must answer 'yes' or 'no'\")\n return r\n elif answer == int:\n r = None\n while True:\n if default:\n r = _input_compat('> {0} [{1}] '.format(question, default))\n else:\n r = _input_compat('> {0} '.format(question))\n\n r = r.strip()\n\n if not r:\n r = default\n break\n\n try:\n r = int(r)\n break\n except:\n print('You must enter an integer')\n return r\n else:\n raise NotImplemented('Argument `answer` must be str_compat, bool, or integer')\n\n\ndef main():\n parser = argparse.ArgumentParser(\n description=\"A kickstarter for Pelican\",\n formatter_class=argparse.ArgumentDefaultsHelpFormatter)\n parser.add_argument('-p', '--path', default=os.curdir,\n help=\"The path to generate the blog into\")\n parser.add_argument('-t', '--title', metavar=\"title\",\n help='Set the title of the website')\n parser.add_argument('-a', '--author', metavar=\"author\",\n help='Set the author name of the website')\n parser.add_argument('-l', '--lang', metavar=\"lang\",\n help='Set the default web site language')\n\n args = parser.parse_args()\n\n print('''Welcome to pelican-quickstart v{v}.\n\nThis script will help you create a new Pelican-based website.\n\nPlease answer the following questions so this script can generate the files\nneeded by Pelican.\n\n '''.format(v=__version__))\n\n project = os.path.join(\n os.environ.get('VIRTUAL_ENV', os.curdir), '.project')\n if os.path.isfile(project):\n CONF['basedir'] = open(project, 'r').read().rstrip(\"\\n\")\n print('Using project associated with current virtual environment.'\n 'Will save to:\\n%s\\n' % CONF['basedir'])\n else:\n CONF['basedir'] = os.path.abspath(ask('Where do you want to create your new web site?', answer=str_compat, default=args.path))\n\n CONF['sitename'] = ask('What will be the title of this web site?', answer=str_compat, default=args.title)\n CONF['author'] = ask('Who will be the author of this web site?', answer=str_compat, default=args.author)\n CONF['lang'] = ask('What will be the default language of this web site?', str_compat, args.lang or CONF['lang'], 2)\n\n if ask('Do you want to specify a URL prefix? e.g., http://example.com ', answer=bool, default=True):\n CONF['siteurl'] = ask('What is your URL prefix? (see above example; no trailing slash)', str_compat, CONF['siteurl'])\n\n CONF['with_pagination'] = ask('Do you want to enable article pagination?', bool, bool(CONF['default_pagination']))\n\n if CONF['with_pagination']:\n CONF['default_pagination'] = ask('How many articles per page do you want?', int, CONF['default_pagination'])\n else:\n CONF['default_pagination'] = False\n\n mkfile = ask('Do you want to generate a Makefile to easily manage your website?', bool, True)\n develop = ask('Do you want an auto-reload & simpleHTTP script to assist with theme and site development?', bool, True)\n\n if mkfile:\n if ask('Do you want to upload your website using FTP?', answer=bool, default=False):\n CONF['ftp_host'] = ask('What is the hostname of your FTP server?', str_compat, CONF['ftp_host'])\n CONF['ftp_user'] = ask('What is your username on that server?', str_compat, CONF['ftp_user'])\n CONF['ftp_target_dir'] = ask('Where do you want to put your web site on that server?', str_compat, CONF['ftp_target_dir'])\n if ask('Do you want to upload your website using SSH?', answer=bool, default=False):\n CONF['ssh_host'] = ask('What is the hostname of your SSH server?', str_compat, CONF['ssh_host'])\n CONF['ssh_port'] = ask('What is the port of your SSH server?', int, CONF['ssh_port'])\n CONF['ssh_user'] = ask('What is your username on that server?', str_compat, CONF['ssh_user'])\n CONF['ssh_target_dir'] = ask('Where do you want to put your web site on that server?', str_compat, CONF['ssh_target_dir'])\n if ask('Do you want to upload your website using Dropbox?', answer=bool, default=False):\n CONF['dropbox_dir'] = ask('Where is your Dropbox directory?', str_compat, CONF['dropbox_dir'])\n if ask('Do you want to upload your website using S3?', answer=bool, default=False):\n CONF['s3_bucket'] = ask('What is the name of your S3 bucket?', str_compat, CONF['s3_bucket'])\n\n try:\n os.makedirs(os.path.join(CONF['basedir'], 'content'))\n except OSError as e:\n print('Error: {0}'.format(e))\n\n try:\n os.makedirs(os.path.join(CONF['basedir'], 'output'))\n except OSError as e:\n print('Error: {0}'.format(e))\n\n try:\n with codecs.open(os.path.join(CONF['basedir'], 'pelicanconf.py'), 'w', 'utf-8') as fd:\n conf_python = dict()\n for key, value in CONF.items():\n conf_python[key] = repr(value)\n\n for line in get_template('pelicanconf.py'):\n template = string.Template(line)\n fd.write(template.safe_substitute(conf_python))\n fd.close()\n except OSError as e:\n print('Error: {0}'.format(e))\n\n try:\n with codecs.open(os.path.join(CONF['basedir'], 'publishconf.py'), 'w', 'utf-8') as fd:\n for line in get_template('publishconf.py'):\n template = string.Template(line)\n fd.write(template.safe_substitute(CONF))\n fd.close()\n except OSError as e:\n print('Error: {0}'.format(e))\n\n if mkfile:\n try:\n with codecs.open(os.path.join(CONF['basedir'], 'Makefile'), 'w', 'utf-8') as fd:\n mkfile_template_name = 'Makefile'\n py_v = 'PY=python'\n if six.PY3:\n py_v = 'PY=python3'\n template = string.Template(py_v)\n fd.write(template.safe_substitute(CONF))\n fd.write('\\n')\n for line in get_template(mkfile_template_name):\n template = string.Template(line)\n fd.write(template.safe_substitute(CONF))\n fd.close()\n except OSError as e:\n print('Error: {0}'.format(e))\n\n if develop:\n conf_shell = dict()\n for key, value in CONF.items():\n if isinstance(value, six.string_types) and ' ' in value:\n value = '\"' + value.replace('\"', '\\\\\"') + '\"'\n conf_shell[key] = value\n try:\n with codecs.open(os.path.join(CONF['basedir'], 'develop_server.sh'), 'w', 'utf-8') as fd:\n lines = list(get_template('develop_server.sh'))\n py_v = 'PY=python\\n'\n if six.PY3:\n py_v = 'PY=python3\\n'\n lines = lines[:4] + [py_v] + lines[4:]\n for line in lines:\n template = string.Template(line)\n fd.write(template.safe_substitute(conf_shell))\n fd.close()\n os.chmod((os.path.join(CONF['basedir'], 'develop_server.sh')), 493) # mode 0o755\n except OSError as e:\n print('Error: {0}'.format(e))\n\n print('Done. Your new project is available at %s' % CONF['basedir'])\n", "path": "pelican/tools/pelican_quickstart.py"}]} |
gh_patches_debug_218 | rasdani/github-patches | git_diff | searxng__searxng-299 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Bug: openstreetmap engine
**Version of SearXNG, commit number if you are using on master branch and stipulate if you forked SearXNG**
Repository: https://github.com/searxng/searxng
Branch: master
Version: 1.0.0-728-b57d776e
**How did you install SearXNG?**
`git clone`
**What happened?**
osm engine crash
**How To Reproduce**
any query
**Technical report**
Error
* Error: NameError
* Percentage: 100
* Parameters: `()`
* File name: `searx/engines/wikidata.py:137`
* Function: `send_wikidata_query`
* Code: `logger.debug('request time %s', str(http_response.elapsed))`
---
* https://github.com/searxng/searxng/pull/296 initialize an logger per engine.
* https://github.com/searxng/searxng/blob/b57d776edb65665cb514d5f8197c6f1960c80412/searx/engines/openstreetmap.py#L18
* the wikidata module imported by openstreetmap doesn't contains `logger`
* this line raises an exception:
https://github.com/searxng/searxng/blob/b57d776edb65665cb514d5f8197c6f1960c80412/searx/engines/wikidata.py#L137
--- 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/openstreetmap.py`
Content:
```
1 # SPDX-License-Identifier: AGPL-3.0-or-later
2 # lint: pylint
3 """OpenStreetMap (Map)
4
5 """
6 # pylint: disable=missing-function-docstring
7
8 import re
9 from json import loads
10 from urllib.parse import urlencode
11 from functools import partial
12
13 from flask_babel import gettext
14
15 from searx.data import OSM_KEYS_TAGS, CURRENCIES
16 from searx.utils import searx_useragent
17 from searx.external_urls import get_external_url
18 from searx.engines.wikidata import send_wikidata_query, sparql_string_escape
19
20 # about
21 about = {
22 "website": 'https://www.openstreetmap.org/',
23 "wikidata_id": 'Q936',
24 "official_api_documentation": 'http://wiki.openstreetmap.org/wiki/Nominatim',
25 "use_official_api": True,
26 "require_api_key": False,
27 "results": 'JSON',
28 }
29
30 # engine dependent config
31 categories = ['map']
32 paging = False
33
34 # search-url
35 base_url = 'https://nominatim.openstreetmap.org/'
36 search_string = 'search?{query}&polygon_geojson=1&format=jsonv2&addressdetails=1&extratags=1&dedupe=1'
37 result_id_url = 'https://openstreetmap.org/{osm_type}/{osm_id}'
38 result_lat_lon_url = 'https://www.openstreetmap.org/?mlat={lat}&mlon={lon}&zoom={zoom}&layers=M'
39
40 route_url = 'https://graphhopper.com/maps/?point={}&point={}&locale=en-US&vehicle=car&weighting=fastest&turn_costs=true&use_miles=false&layer=Omniscale' # pylint: disable=line-too-long
41 route_re = re.compile('(?:from )?(.+) to (.+)')
42
43 wikidata_image_sparql = """
44 select ?item ?itemLabel ?image ?sign ?symbol ?website ?wikipediaName
45 where {
46 values ?item { %WIKIDATA_IDS% }
47 OPTIONAL { ?item wdt:P18|wdt:P8517|wdt:P4291|wdt:P5252|wdt:P3451|wdt:P4640|wdt:P5775|wdt:P2716|wdt:P1801|wdt:P4896 ?image }
48 OPTIONAL { ?item wdt:P1766|wdt:P8505|wdt:P8667 ?sign }
49 OPTIONAL { ?item wdt:P41|wdt:P94|wdt:P154|wdt:P158|wdt:P2910|wdt:P4004|wdt:P5962|wdt:P8972 ?symbol }
50 OPTIONAL { ?item wdt:P856 ?website }
51 SERVICE wikibase:label {
52 bd:serviceParam wikibase:language "%LANGUAGE%,en".
53 ?item rdfs:label ?itemLabel .
54 }
55 OPTIONAL {
56 ?wikipediaUrl schema:about ?item;
57 schema:isPartOf/wikibase:wikiGroup "wikipedia";
58 schema:name ?wikipediaName;
59 schema:inLanguage "%LANGUAGE%" .
60 }
61 }
62 ORDER by ?item
63 """
64
65
66 # key value that are link: mapping functions
67 # 'mapillary': P1947
68 # but https://github.com/kartaview/openstreetcam.org/issues/60
69 # but https://taginfo.openstreetmap.org/keys/kartaview ...
70 def value_to_https_link(value):
71 http = 'http://'
72 if value.startswith(http):
73 value = 'https://' + value[len(http) :]
74 return (value, value)
75
76
77 def value_to_website_link(value):
78 value = value.split(';')[0]
79 return (value, value)
80
81
82 def value_wikipedia_link(value):
83 value = value.split(':', 1)
84 return ('https://{0}.wikipedia.org/wiki/{1}'.format(*value), '{1} ({0})'.format(*value))
85
86
87 def value_with_prefix(prefix, value):
88 return (prefix + value, value)
89
90
91 VALUE_TO_LINK = {
92 'website': value_to_website_link,
93 'contact:website': value_to_website_link,
94 'email': partial(value_with_prefix, 'mailto:'),
95 'contact:email': partial(value_with_prefix, 'mailto:'),
96 'contact:phone': partial(value_with_prefix, 'tel:'),
97 'phone': partial(value_with_prefix, 'tel:'),
98 'fax': partial(value_with_prefix, 'fax:'),
99 'contact:fax': partial(value_with_prefix, 'fax:'),
100 'contact:mastodon': value_to_https_link,
101 'facebook': value_to_https_link,
102 'contact:facebook': value_to_https_link,
103 'contact:foursquare': value_to_https_link,
104 'contact:instagram': value_to_https_link,
105 'contact:linkedin': value_to_https_link,
106 'contact:pinterest': value_to_https_link,
107 'contact:telegram': value_to_https_link,
108 'contact:tripadvisor': value_to_https_link,
109 'contact:twitter': value_to_https_link,
110 'contact:yelp': value_to_https_link,
111 'contact:youtube': value_to_https_link,
112 'contact:webcam': value_to_website_link,
113 'wikipedia': value_wikipedia_link,
114 'wikidata': partial(value_with_prefix, 'https://wikidata.org/wiki/'),
115 'brand:wikidata': partial(value_with_prefix, 'https://wikidata.org/wiki/'),
116 }
117 KEY_ORDER = [
118 'cuisine',
119 'organic',
120 'delivery',
121 'delivery:covid19',
122 'opening_hours',
123 'opening_hours:covid19',
124 'fee',
125 'payment:*',
126 'currency:*',
127 'outdoor_seating',
128 'bench',
129 'wheelchair',
130 'level',
131 'building:levels',
132 'bin',
133 'public_transport',
134 'internet_access:ssid',
135 ]
136 KEY_RANKS = {k: i for i, k in enumerate(KEY_ORDER)}
137
138
139 def request(query, params):
140 """do search-request"""
141 params['url'] = base_url + search_string.format(query=urlencode({'q': query}))
142 params['route'] = route_re.match(query)
143 params['headers']['User-Agent'] = searx_useragent()
144 return params
145
146
147 def response(resp):
148 """get response from search-request"""
149 results = []
150 nominatim_json = loads(resp.text)
151 user_language = resp.search_params['language']
152
153 if resp.search_params['route']:
154 results.append({
155 'answer': gettext('Get directions'),
156 'url': route_url.format(*resp.search_params['route'].groups()),
157 })
158
159 fetch_wikidata(nominatim_json, user_language)
160
161 for result in nominatim_json:
162 title, address = get_title_address(result)
163
164 # ignore result without title
165 if not title:
166 continue
167
168 url, osm, geojson = get_url_osm_geojson(result)
169 img_src = get_img_src(result)
170 links, link_keys = get_links(result, user_language)
171 data = get_data(result, user_language, link_keys)
172
173 results.append({
174 'template': 'map.html',
175 'title': title,
176 'address': address,
177 'address_label': get_key_label('addr', user_language),
178 'url': url,
179 'osm': osm,
180 'geojson': geojson,
181 'img_src': img_src,
182 'links': links,
183 'data': data,
184 'type': get_tag_label(
185 result.get('category'), result.get('type', ''), user_language
186 ),
187 'type_icon': result.get('icon'),
188 'content': '',
189 'longitude': result['lon'],
190 'latitude': result['lat'],
191 'boundingbox': result['boundingbox'],
192 })
193
194 return results
195
196
197 def get_wikipedia_image(raw_value):
198 if not raw_value:
199 return None
200 return get_external_url('wikimedia_image', raw_value)
201
202
203 def fetch_wikidata(nominatim_json, user_langage):
204 """Update nominatim_json using the result of an unique to wikidata
205
206 For result in nominatim_json:
207 If result['extratags']['wikidata'] or r['extratags']['wikidata link']:
208 Set result['wikidata'] to { 'image': ..., 'image_sign':..., 'image_symbal':... }
209 Set result['extratags']['wikipedia'] if not defined
210 Set result['extratags']['contact:website'] if not defined
211 """
212 wikidata_ids = []
213 wd_to_results = {}
214 for result in nominatim_json:
215 e = result.get("extratags")
216 if e:
217 # ignore brand:wikidata
218 wd_id = e.get("wikidata", e.get("wikidata link"))
219 if wd_id and wd_id not in wikidata_ids:
220 wikidata_ids.append("wd:" + wd_id)
221 wd_to_results.setdefault(wd_id, []).append(result)
222
223 if wikidata_ids:
224 wikidata_ids_str = " ".join(wikidata_ids)
225 query = wikidata_image_sparql.replace('%WIKIDATA_IDS%', sparql_string_escape(wikidata_ids_str)).replace(
226 '%LANGUAGE%', sparql_string_escape(user_langage)
227 )
228 wikidata_json = send_wikidata_query(query)
229 for wd_result in wikidata_json.get('results', {}).get('bindings', {}):
230 wd_id = wd_result['item']['value'].replace('http://www.wikidata.org/entity/', '')
231 for result in wd_to_results.get(wd_id, []):
232 result['wikidata'] = {
233 'itemLabel': wd_result['itemLabel']['value'],
234 'image': get_wikipedia_image(wd_result.get('image', {}).get('value')),
235 'image_sign': get_wikipedia_image(wd_result.get('sign', {}).get('value')),
236 'image_symbol': get_wikipedia_image(wd_result.get('symbol', {}).get('value')),
237 }
238 # overwrite wikipedia link
239 wikipedia_name = wd_result.get('wikipediaName', {}).get('value')
240 if wikipedia_name:
241 result['extratags']['wikipedia'] = user_langage + ':' + wikipedia_name
242 # get website if not already defined
243 website = wd_result.get('website', {}).get('value')
244 if (
245 website
246 and not result['extratags'].get('contact:website')
247 and not result['extratags'].get('website')
248 ):
249 result['extratags']['contact:website'] = website
250
251
252 def get_title_address(result):
253 """Return title and address
254
255 title may be None
256 """
257 address_raw = result.get('address')
258 address_name = None
259 address = {}
260
261 # get name
262 if (
263 result['category'] == 'amenity'
264 or result['category'] == 'shop'
265 or result['category'] == 'tourism'
266 or result['category'] == 'leisure'
267 ):
268 if address_raw.get('address29'):
269 # https://github.com/osm-search/Nominatim/issues/1662
270 address_name = address_raw.get('address29')
271 else:
272 address_name = address_raw.get(result['category'])
273 elif result['type'] in address_raw:
274 address_name = address_raw.get(result['type'])
275
276 # add rest of adressdata, if something is already found
277 if address_name:
278 title = address_name
279 address.update(
280 {
281 'name': address_name,
282 'house_number': address_raw.get('house_number'),
283 'road': address_raw.get('road'),
284 'locality': address_raw.get(
285 'city', address_raw.get('town', address_raw.get('village')) # noqa
286 ), # noqa
287 'postcode': address_raw.get('postcode'),
288 'country': address_raw.get('country'),
289 'country_code': address_raw.get('country_code'),
290 }
291 )
292 else:
293 title = result.get('display_name')
294
295 return title, address
296
297
298 def get_url_osm_geojson(result):
299 """Get url, osm and geojson
300 """
301 osm_type = result.get('osm_type', result.get('type'))
302 if 'osm_id' not in result:
303 # see https://github.com/osm-search/Nominatim/issues/1521
304 # query example: "EC1M 5RF London"
305 url = result_lat_lon_url.format(lat=result['lat'], lon=result['lon'], zoom=12)
306 osm = {}
307 else:
308 url = result_id_url.format(osm_type=osm_type, osm_id=result['osm_id'])
309 osm = {'type': osm_type, 'id': result['osm_id']}
310
311 geojson = result.get('geojson')
312 # if no geojson is found and osm_type is a node, add geojson Point
313 if not geojson and osm_type == 'node':
314 geojson = {'type': 'Point', 'coordinates': [result['lon'], result['lat']]}
315
316 return url, osm, geojson
317
318
319 def get_img_src(result):
320 """Get image URL from either wikidata or r['extratags']"""
321 # wikidata
322 img_src = None
323 if 'wikidata' in result:
324 img_src = result['wikidata']['image']
325 if not img_src:
326 img_src = result['wikidata']['image_symbol']
327 if not img_src:
328 img_src = result['wikidata']['image_sign']
329
330 # img_src
331 if not img_src and result.get('extratags', {}).get('image'):
332 img_src = result['extratags']['image']
333 del result['extratags']['image']
334 if not img_src and result.get('extratags', {}).get('wikimedia_commons'):
335 img_src = get_external_url('wikimedia_image', result['extratags']['wikimedia_commons'])
336 del result['extratags']['wikimedia_commons']
337
338 return img_src
339
340
341 def get_links(result, user_language):
342 """Return links from result['extratags']"""
343 links = []
344 link_keys = set()
345 for k, mapping_function in VALUE_TO_LINK.items():
346 raw_value = result['extratags'].get(k)
347 if raw_value:
348 url, url_label = mapping_function(raw_value)
349 if url.startswith('https://wikidata.org'):
350 url_label = result.get('wikidata', {}).get('itemLabel') or url_label
351 links.append({
352 'label': get_key_label(k, user_language),
353 'url': url,
354 'url_label': url_label,
355 })
356 link_keys.add(k)
357 return links, link_keys
358
359
360 def get_data(result, user_language, ignore_keys):
361 """Return key, value of result['extratags']
362
363 Must be call after get_links
364
365 Note: the values are not translated
366 """
367 data = []
368 for k, v in result['extratags'].items():
369 if k in ignore_keys:
370 continue
371 if get_key_rank(k) is None:
372 continue
373 k_label = get_key_label(k, user_language)
374 if k_label:
375 data.append({
376 'label': k_label,
377 'key': k,
378 'value': v,
379 })
380 data.sort(key=lambda entry: (get_key_rank(entry['key']), entry['label']))
381 return data
382
383
384 def get_key_rank(k):
385 """Get OSM key rank
386
387 The rank defines in which order the key are displayed in the HTML result
388 """
389 key_rank = KEY_RANKS.get(k)
390 if key_rank is None:
391 # "payment:*" in KEY_ORDER matches "payment:cash", "payment:debit card", etc...
392 key_rank = KEY_RANKS.get(k.split(':')[0] + ':*')
393 return key_rank
394
395
396 def get_label(labels, lang):
397 """Get label from labels in OSM_KEYS_TAGS
398
399 in OSM_KEYS_TAGS, labels have key == '*'
400 """
401 tag_label = labels.get(lang.lower())
402 if tag_label is None:
403 # example: if 'zh-hk' is not found, check 'zh'
404 tag_label = labels.get(lang.split('-')[0])
405 if tag_label is None and lang != 'en':
406 # example: if 'zh' is not found, check 'en'
407 tag_label = labels.get('en')
408 if tag_label is None and len(labels.values()) > 0:
409 # example: if still not found, use the first entry
410 tag_label = labels.values()[0]
411 return tag_label
412
413
414 def get_tag_label(tag_category, tag_name, lang):
415 """Get tag label from OSM_KEYS_TAGS"""
416 tag_name = '' if tag_name is None else tag_name
417 tag_labels = OSM_KEYS_TAGS['tags'].get(tag_category, {}).get(tag_name, {})
418 return get_label(tag_labels, lang)
419
420
421 def get_key_label(key_name, lang):
422 """Get key label from OSM_KEYS_TAGS"""
423 if key_name.startswith('currency:'):
424 # currency:EUR --> get the name from the CURRENCIES variable
425 # see https://wiki.openstreetmap.org/wiki/Key%3Acurrency
426 # and for exampe https://taginfo.openstreetmap.org/keys/currency:EUR#values
427 # but there is also currency=EUR (currently not handled)
428 # https://taginfo.openstreetmap.org/keys/currency#values
429 currency = key_name.split(':')
430 if len(currency) > 1:
431 o = CURRENCIES['iso4217'].get(currency)
432 if o:
433 return get_label(o, lang).lower()
434 return currency
435
436 labels = OSM_KEYS_TAGS['keys']
437 for k in key_name.split(':') + ['*']:
438 labels = labels.get(k)
439 if labels is None:
440 return None
441 return get_label(labels, lang)
442
```
--- 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/openstreetmap.py b/searx/engines/openstreetmap.py
--- a/searx/engines/openstreetmap.py
+++ b/searx/engines/openstreetmap.py
@@ -439,3 +439,8 @@
if labels is None:
return None
return get_label(labels, lang)
+
+
+def init(_):
+ import searx.engines.wikidata # pylint: disable=import-outside-toplevel
+ searx.engines.wikidata.logger = logger
| {"golden_diff": "diff --git a/searx/engines/openstreetmap.py b/searx/engines/openstreetmap.py\n--- a/searx/engines/openstreetmap.py\n+++ b/searx/engines/openstreetmap.py\n@@ -439,3 +439,8 @@\n if labels is None:\n return None\n return get_label(labels, lang)\n+\n+\n+def init(_):\n+ import searx.engines.wikidata # pylint: disable=import-outside-toplevel\n+ searx.engines.wikidata.logger = logger\n", "issue": "Bug: openstreetmap engine\n**Version of SearXNG, commit number if you are using on master branch and stipulate if you forked SearXNG**\r\nRepository: https://github.com/searxng/searxng\r\nBranch: master\r\nVersion: 1.0.0-728-b57d776e\r\n\r\n**How did you install SearXNG?**\r\n`git clone`\r\n\r\n**What happened?**\r\nosm engine crash\r\n\r\n**How To Reproduce**\r\nany query\r\n\r\n**Technical report**\r\n\r\nError\r\n * Error: NameError\r\n * Percentage: 100\r\n * Parameters: `()`\r\n * File name: `searx/engines/wikidata.py:137`\r\n * Function: `send_wikidata_query`\r\n * Code: `logger.debug('request time %s', str(http_response.elapsed))`\r\n\r\n---\r\n\r\n* https://github.com/searxng/searxng/pull/296 initialize an logger per engine.\r\n* https://github.com/searxng/searxng/blob/b57d776edb65665cb514d5f8197c6f1960c80412/searx/engines/openstreetmap.py#L18\r\n* the wikidata module imported by openstreetmap doesn't contains `logger`\r\n* this line raises an exception:\r\n https://github.com/searxng/searxng/blob/b57d776edb65665cb514d5f8197c6f1960c80412/searx/engines/wikidata.py#L137\r\n\n", "before_files": [{"content": "# SPDX-License-Identifier: AGPL-3.0-or-later\n# lint: pylint\n\"\"\"OpenStreetMap (Map)\n\n\"\"\"\n# pylint: disable=missing-function-docstring\n\nimport re\nfrom json import loads\nfrom urllib.parse import urlencode\nfrom functools import partial\n\nfrom flask_babel import gettext\n\nfrom searx.data import OSM_KEYS_TAGS, CURRENCIES\nfrom searx.utils import searx_useragent\nfrom searx.external_urls import get_external_url\nfrom searx.engines.wikidata import send_wikidata_query, sparql_string_escape\n\n# about\nabout = {\n \"website\": 'https://www.openstreetmap.org/',\n \"wikidata_id\": 'Q936',\n \"official_api_documentation\": 'http://wiki.openstreetmap.org/wiki/Nominatim',\n \"use_official_api\": True,\n \"require_api_key\": False,\n \"results\": 'JSON',\n}\n\n# engine dependent config\ncategories = ['map']\npaging = False\n\n# search-url\nbase_url = 'https://nominatim.openstreetmap.org/'\nsearch_string = 'search?{query}&polygon_geojson=1&format=jsonv2&addressdetails=1&extratags=1&dedupe=1'\nresult_id_url = 'https://openstreetmap.org/{osm_type}/{osm_id}'\nresult_lat_lon_url = 'https://www.openstreetmap.org/?mlat={lat}&mlon={lon}&zoom={zoom}&layers=M'\n\nroute_url = 'https://graphhopper.com/maps/?point={}&point={}&locale=en-US&vehicle=car&weighting=fastest&turn_costs=true&use_miles=false&layer=Omniscale' # pylint: disable=line-too-long\nroute_re = re.compile('(?:from )?(.+) to (.+)')\n\nwikidata_image_sparql = \"\"\"\nselect ?item ?itemLabel ?image ?sign ?symbol ?website ?wikipediaName\nwhere {\n values ?item { %WIKIDATA_IDS% }\n OPTIONAL { ?item wdt:P18|wdt:P8517|wdt:P4291|wdt:P5252|wdt:P3451|wdt:P4640|wdt:P5775|wdt:P2716|wdt:P1801|wdt:P4896 ?image }\n OPTIONAL { ?item wdt:P1766|wdt:P8505|wdt:P8667 ?sign }\n OPTIONAL { ?item wdt:P41|wdt:P94|wdt:P154|wdt:P158|wdt:P2910|wdt:P4004|wdt:P5962|wdt:P8972 ?symbol }\n OPTIONAL { ?item wdt:P856 ?website }\n SERVICE wikibase:label {\n bd:serviceParam wikibase:language \"%LANGUAGE%,en\".\n ?item rdfs:label ?itemLabel .\n }\n OPTIONAL {\n ?wikipediaUrl schema:about ?item;\n schema:isPartOf/wikibase:wikiGroup \"wikipedia\";\n schema:name ?wikipediaName;\n schema:inLanguage \"%LANGUAGE%\" .\n }\n}\nORDER by ?item\n\"\"\"\n\n\n# key value that are link: mapping functions\n# 'mapillary': P1947\n# but https://github.com/kartaview/openstreetcam.org/issues/60\n# but https://taginfo.openstreetmap.org/keys/kartaview ...\ndef value_to_https_link(value):\n http = 'http://'\n if value.startswith(http):\n value = 'https://' + value[len(http) :]\n return (value, value)\n\n\ndef value_to_website_link(value):\n value = value.split(';')[0]\n return (value, value)\n\n\ndef value_wikipedia_link(value):\n value = value.split(':', 1)\n return ('https://{0}.wikipedia.org/wiki/{1}'.format(*value), '{1} ({0})'.format(*value))\n\n\ndef value_with_prefix(prefix, value):\n return (prefix + value, value)\n\n\nVALUE_TO_LINK = {\n 'website': value_to_website_link,\n 'contact:website': value_to_website_link,\n 'email': partial(value_with_prefix, 'mailto:'),\n 'contact:email': partial(value_with_prefix, 'mailto:'),\n 'contact:phone': partial(value_with_prefix, 'tel:'),\n 'phone': partial(value_with_prefix, 'tel:'),\n 'fax': partial(value_with_prefix, 'fax:'),\n 'contact:fax': partial(value_with_prefix, 'fax:'),\n 'contact:mastodon': value_to_https_link,\n 'facebook': value_to_https_link,\n 'contact:facebook': value_to_https_link,\n 'contact:foursquare': value_to_https_link,\n 'contact:instagram': value_to_https_link,\n 'contact:linkedin': value_to_https_link,\n 'contact:pinterest': value_to_https_link,\n 'contact:telegram': value_to_https_link,\n 'contact:tripadvisor': value_to_https_link,\n 'contact:twitter': value_to_https_link,\n 'contact:yelp': value_to_https_link,\n 'contact:youtube': value_to_https_link,\n 'contact:webcam': value_to_website_link,\n 'wikipedia': value_wikipedia_link,\n 'wikidata': partial(value_with_prefix, 'https://wikidata.org/wiki/'),\n 'brand:wikidata': partial(value_with_prefix, 'https://wikidata.org/wiki/'),\n}\nKEY_ORDER = [\n 'cuisine',\n 'organic',\n 'delivery',\n 'delivery:covid19',\n 'opening_hours',\n 'opening_hours:covid19',\n 'fee',\n 'payment:*',\n 'currency:*',\n 'outdoor_seating',\n 'bench',\n 'wheelchair',\n 'level',\n 'building:levels',\n 'bin',\n 'public_transport',\n 'internet_access:ssid',\n]\nKEY_RANKS = {k: i for i, k in enumerate(KEY_ORDER)}\n\n\ndef request(query, params):\n \"\"\"do search-request\"\"\"\n params['url'] = base_url + search_string.format(query=urlencode({'q': query}))\n params['route'] = route_re.match(query)\n params['headers']['User-Agent'] = searx_useragent()\n return params\n\n\ndef response(resp):\n \"\"\"get response from search-request\"\"\"\n results = []\n nominatim_json = loads(resp.text)\n user_language = resp.search_params['language']\n\n if resp.search_params['route']:\n results.append({\n 'answer': gettext('Get directions'),\n 'url': route_url.format(*resp.search_params['route'].groups()),\n })\n\n fetch_wikidata(nominatim_json, user_language)\n\n for result in nominatim_json:\n title, address = get_title_address(result)\n\n # ignore result without title\n if not title:\n continue\n\n url, osm, geojson = get_url_osm_geojson(result)\n img_src = get_img_src(result)\n links, link_keys = get_links(result, user_language)\n data = get_data(result, user_language, link_keys)\n\n results.append({\n 'template': 'map.html',\n 'title': title,\n 'address': address,\n 'address_label': get_key_label('addr', user_language),\n 'url': url,\n 'osm': osm,\n 'geojson': geojson,\n 'img_src': img_src,\n 'links': links,\n 'data': data,\n 'type': get_tag_label(\n result.get('category'), result.get('type', ''), user_language\n ),\n 'type_icon': result.get('icon'),\n 'content': '',\n 'longitude': result['lon'],\n 'latitude': result['lat'],\n 'boundingbox': result['boundingbox'],\n })\n\n return results\n\n\ndef get_wikipedia_image(raw_value):\n if not raw_value:\n return None\n return get_external_url('wikimedia_image', raw_value)\n\n\ndef fetch_wikidata(nominatim_json, user_langage):\n \"\"\"Update nominatim_json using the result of an unique to wikidata\n\n For result in nominatim_json:\n If result['extratags']['wikidata'] or r['extratags']['wikidata link']:\n Set result['wikidata'] to { 'image': ..., 'image_sign':..., 'image_symbal':... }\n Set result['extratags']['wikipedia'] if not defined\n Set result['extratags']['contact:website'] if not defined\n \"\"\"\n wikidata_ids = []\n wd_to_results = {}\n for result in nominatim_json:\n e = result.get(\"extratags\")\n if e:\n # ignore brand:wikidata\n wd_id = e.get(\"wikidata\", e.get(\"wikidata link\"))\n if wd_id and wd_id not in wikidata_ids:\n wikidata_ids.append(\"wd:\" + wd_id)\n wd_to_results.setdefault(wd_id, []).append(result)\n\n if wikidata_ids:\n wikidata_ids_str = \" \".join(wikidata_ids)\n query = wikidata_image_sparql.replace('%WIKIDATA_IDS%', sparql_string_escape(wikidata_ids_str)).replace(\n '%LANGUAGE%', sparql_string_escape(user_langage)\n )\n wikidata_json = send_wikidata_query(query)\n for wd_result in wikidata_json.get('results', {}).get('bindings', {}):\n wd_id = wd_result['item']['value'].replace('http://www.wikidata.org/entity/', '')\n for result in wd_to_results.get(wd_id, []):\n result['wikidata'] = {\n 'itemLabel': wd_result['itemLabel']['value'],\n 'image': get_wikipedia_image(wd_result.get('image', {}).get('value')),\n 'image_sign': get_wikipedia_image(wd_result.get('sign', {}).get('value')),\n 'image_symbol': get_wikipedia_image(wd_result.get('symbol', {}).get('value')),\n }\n # overwrite wikipedia link\n wikipedia_name = wd_result.get('wikipediaName', {}).get('value')\n if wikipedia_name:\n result['extratags']['wikipedia'] = user_langage + ':' + wikipedia_name\n # get website if not already defined\n website = wd_result.get('website', {}).get('value')\n if (\n website\n and not result['extratags'].get('contact:website')\n and not result['extratags'].get('website')\n ):\n result['extratags']['contact:website'] = website\n\n\ndef get_title_address(result):\n \"\"\"Return title and address\n\n title may be None\n \"\"\"\n address_raw = result.get('address')\n address_name = None\n address = {}\n\n # get name\n if (\n result['category'] == 'amenity'\n or result['category'] == 'shop'\n or result['category'] == 'tourism'\n or result['category'] == 'leisure'\n ):\n if address_raw.get('address29'):\n # https://github.com/osm-search/Nominatim/issues/1662\n address_name = address_raw.get('address29')\n else:\n address_name = address_raw.get(result['category'])\n elif result['type'] in address_raw:\n address_name = address_raw.get(result['type'])\n\n # add rest of adressdata, if something is already found\n if address_name:\n title = address_name\n address.update(\n {\n 'name': address_name,\n 'house_number': address_raw.get('house_number'),\n 'road': address_raw.get('road'),\n 'locality': address_raw.get(\n 'city', address_raw.get('town', address_raw.get('village')) # noqa\n ), # noqa\n 'postcode': address_raw.get('postcode'),\n 'country': address_raw.get('country'),\n 'country_code': address_raw.get('country_code'),\n }\n )\n else:\n title = result.get('display_name')\n\n return title, address\n\n\ndef get_url_osm_geojson(result):\n \"\"\"Get url, osm and geojson\n \"\"\"\n osm_type = result.get('osm_type', result.get('type'))\n if 'osm_id' not in result:\n # see https://github.com/osm-search/Nominatim/issues/1521\n # query example: \"EC1M 5RF London\"\n url = result_lat_lon_url.format(lat=result['lat'], lon=result['lon'], zoom=12)\n osm = {}\n else:\n url = result_id_url.format(osm_type=osm_type, osm_id=result['osm_id'])\n osm = {'type': osm_type, 'id': result['osm_id']}\n\n geojson = result.get('geojson')\n # if no geojson is found and osm_type is a node, add geojson Point\n if not geojson and osm_type == 'node':\n geojson = {'type': 'Point', 'coordinates': [result['lon'], result['lat']]}\n\n return url, osm, geojson\n\n\ndef get_img_src(result):\n \"\"\"Get image URL from either wikidata or r['extratags']\"\"\"\n # wikidata\n img_src = None\n if 'wikidata' in result:\n img_src = result['wikidata']['image']\n if not img_src:\n img_src = result['wikidata']['image_symbol']\n if not img_src:\n img_src = result['wikidata']['image_sign']\n\n # img_src\n if not img_src and result.get('extratags', {}).get('image'):\n img_src = result['extratags']['image']\n del result['extratags']['image']\n if not img_src and result.get('extratags', {}).get('wikimedia_commons'):\n img_src = get_external_url('wikimedia_image', result['extratags']['wikimedia_commons'])\n del result['extratags']['wikimedia_commons']\n\n return img_src\n\n\ndef get_links(result, user_language):\n \"\"\"Return links from result['extratags']\"\"\"\n links = []\n link_keys = set()\n for k, mapping_function in VALUE_TO_LINK.items():\n raw_value = result['extratags'].get(k)\n if raw_value:\n url, url_label = mapping_function(raw_value)\n if url.startswith('https://wikidata.org'):\n url_label = result.get('wikidata', {}).get('itemLabel') or url_label\n links.append({\n 'label': get_key_label(k, user_language),\n 'url': url,\n 'url_label': url_label,\n })\n link_keys.add(k)\n return links, link_keys\n\n\ndef get_data(result, user_language, ignore_keys):\n \"\"\"Return key, value of result['extratags']\n\n Must be call after get_links\n\n Note: the values are not translated\n \"\"\"\n data = []\n for k, v in result['extratags'].items():\n if k in ignore_keys:\n continue\n if get_key_rank(k) is None:\n continue\n k_label = get_key_label(k, user_language)\n if k_label:\n data.append({\n 'label': k_label,\n 'key': k,\n 'value': v,\n })\n data.sort(key=lambda entry: (get_key_rank(entry['key']), entry['label']))\n return data\n\n\ndef get_key_rank(k):\n \"\"\"Get OSM key rank\n\n The rank defines in which order the key are displayed in the HTML result\n \"\"\"\n key_rank = KEY_RANKS.get(k)\n if key_rank is None:\n # \"payment:*\" in KEY_ORDER matches \"payment:cash\", \"payment:debit card\", etc...\n key_rank = KEY_RANKS.get(k.split(':')[0] + ':*')\n return key_rank\n\n\ndef get_label(labels, lang):\n \"\"\"Get label from labels in OSM_KEYS_TAGS\n\n in OSM_KEYS_TAGS, labels have key == '*'\n \"\"\"\n tag_label = labels.get(lang.lower())\n if tag_label is None:\n # example: if 'zh-hk' is not found, check 'zh'\n tag_label = labels.get(lang.split('-')[0])\n if tag_label is None and lang != 'en':\n # example: if 'zh' is not found, check 'en'\n tag_label = labels.get('en')\n if tag_label is None and len(labels.values()) > 0:\n # example: if still not found, use the first entry\n tag_label = labels.values()[0]\n return tag_label\n\n\ndef get_tag_label(tag_category, tag_name, lang):\n \"\"\"Get tag label from OSM_KEYS_TAGS\"\"\"\n tag_name = '' if tag_name is None else tag_name\n tag_labels = OSM_KEYS_TAGS['tags'].get(tag_category, {}).get(tag_name, {})\n return get_label(tag_labels, lang)\n\n\ndef get_key_label(key_name, lang):\n \"\"\"Get key label from OSM_KEYS_TAGS\"\"\"\n if key_name.startswith('currency:'):\n # currency:EUR --> get the name from the CURRENCIES variable\n # see https://wiki.openstreetmap.org/wiki/Key%3Acurrency\n # and for exampe https://taginfo.openstreetmap.org/keys/currency:EUR#values\n # but there is also currency=EUR (currently not handled)\n # https://taginfo.openstreetmap.org/keys/currency#values\n currency = key_name.split(':')\n if len(currency) > 1:\n o = CURRENCIES['iso4217'].get(currency)\n if o:\n return get_label(o, lang).lower()\n return currency\n\n labels = OSM_KEYS_TAGS['keys']\n for k in key_name.split(':') + ['*']:\n labels = labels.get(k)\n if labels is None:\n return None\n return get_label(labels, lang)\n", "path": "searx/engines/openstreetmap.py"}], "after_files": [{"content": "# SPDX-License-Identifier: AGPL-3.0-or-later\n# lint: pylint\n\"\"\"OpenStreetMap (Map)\n\n\"\"\"\n# pylint: disable=missing-function-docstring\n\nimport re\nfrom json import loads\nfrom urllib.parse import urlencode\nfrom functools import partial\n\nfrom flask_babel import gettext\n\nfrom searx.data import OSM_KEYS_TAGS, CURRENCIES\nfrom searx.utils import searx_useragent\nfrom searx.external_urls import get_external_url\nfrom searx.engines.wikidata import send_wikidata_query, sparql_string_escape\n\n# about\nabout = {\n \"website\": 'https://www.openstreetmap.org/',\n \"wikidata_id\": 'Q936',\n \"official_api_documentation\": 'http://wiki.openstreetmap.org/wiki/Nominatim',\n \"use_official_api\": True,\n \"require_api_key\": False,\n \"results\": 'JSON',\n}\n\n# engine dependent config\ncategories = ['map']\npaging = False\n\n# search-url\nbase_url = 'https://nominatim.openstreetmap.org/'\nsearch_string = 'search?{query}&polygon_geojson=1&format=jsonv2&addressdetails=1&extratags=1&dedupe=1'\nresult_id_url = 'https://openstreetmap.org/{osm_type}/{osm_id}'\nresult_lat_lon_url = 'https://www.openstreetmap.org/?mlat={lat}&mlon={lon}&zoom={zoom}&layers=M'\n\nroute_url = 'https://graphhopper.com/maps/?point={}&point={}&locale=en-US&vehicle=car&weighting=fastest&turn_costs=true&use_miles=false&layer=Omniscale' # pylint: disable=line-too-long\nroute_re = re.compile('(?:from )?(.+) to (.+)')\n\nwikidata_image_sparql = \"\"\"\nselect ?item ?itemLabel ?image ?sign ?symbol ?website ?wikipediaName\nwhere {\n values ?item { %WIKIDATA_IDS% }\n OPTIONAL { ?item wdt:P18|wdt:P8517|wdt:P4291|wdt:P5252|wdt:P3451|wdt:P4640|wdt:P5775|wdt:P2716|wdt:P1801|wdt:P4896 ?image }\n OPTIONAL { ?item wdt:P1766|wdt:P8505|wdt:P8667 ?sign }\n OPTIONAL { ?item wdt:P41|wdt:P94|wdt:P154|wdt:P158|wdt:P2910|wdt:P4004|wdt:P5962|wdt:P8972 ?symbol }\n OPTIONAL { ?item wdt:P856 ?website }\n SERVICE wikibase:label {\n bd:serviceParam wikibase:language \"%LANGUAGE%,en\".\n ?item rdfs:label ?itemLabel .\n }\n OPTIONAL {\n ?wikipediaUrl schema:about ?item;\n schema:isPartOf/wikibase:wikiGroup \"wikipedia\";\n schema:name ?wikipediaName;\n schema:inLanguage \"%LANGUAGE%\" .\n }\n}\nORDER by ?item\n\"\"\"\n\n\n# key value that are link: mapping functions\n# 'mapillary': P1947\n# but https://github.com/kartaview/openstreetcam.org/issues/60\n# but https://taginfo.openstreetmap.org/keys/kartaview ...\ndef value_to_https_link(value):\n http = 'http://'\n if value.startswith(http):\n value = 'https://' + value[len(http) :]\n return (value, value)\n\n\ndef value_to_website_link(value):\n value = value.split(';')[0]\n return (value, value)\n\n\ndef value_wikipedia_link(value):\n value = value.split(':', 1)\n return ('https://{0}.wikipedia.org/wiki/{1}'.format(*value), '{1} ({0})'.format(*value))\n\n\ndef value_with_prefix(prefix, value):\n return (prefix + value, value)\n\n\nVALUE_TO_LINK = {\n 'website': value_to_website_link,\n 'contact:website': value_to_website_link,\n 'email': partial(value_with_prefix, 'mailto:'),\n 'contact:email': partial(value_with_prefix, 'mailto:'),\n 'contact:phone': partial(value_with_prefix, 'tel:'),\n 'phone': partial(value_with_prefix, 'tel:'),\n 'fax': partial(value_with_prefix, 'fax:'),\n 'contact:fax': partial(value_with_prefix, 'fax:'),\n 'contact:mastodon': value_to_https_link,\n 'facebook': value_to_https_link,\n 'contact:facebook': value_to_https_link,\n 'contact:foursquare': value_to_https_link,\n 'contact:instagram': value_to_https_link,\n 'contact:linkedin': value_to_https_link,\n 'contact:pinterest': value_to_https_link,\n 'contact:telegram': value_to_https_link,\n 'contact:tripadvisor': value_to_https_link,\n 'contact:twitter': value_to_https_link,\n 'contact:yelp': value_to_https_link,\n 'contact:youtube': value_to_https_link,\n 'contact:webcam': value_to_website_link,\n 'wikipedia': value_wikipedia_link,\n 'wikidata': partial(value_with_prefix, 'https://wikidata.org/wiki/'),\n 'brand:wikidata': partial(value_with_prefix, 'https://wikidata.org/wiki/'),\n}\nKEY_ORDER = [\n 'cuisine',\n 'organic',\n 'delivery',\n 'delivery:covid19',\n 'opening_hours',\n 'opening_hours:covid19',\n 'fee',\n 'payment:*',\n 'currency:*',\n 'outdoor_seating',\n 'bench',\n 'wheelchair',\n 'level',\n 'building:levels',\n 'bin',\n 'public_transport',\n 'internet_access:ssid',\n]\nKEY_RANKS = {k: i for i, k in enumerate(KEY_ORDER)}\n\n\ndef request(query, params):\n \"\"\"do search-request\"\"\"\n params['url'] = base_url + search_string.format(query=urlencode({'q': query}))\n params['route'] = route_re.match(query)\n params['headers']['User-Agent'] = searx_useragent()\n return params\n\n\ndef response(resp):\n \"\"\"get response from search-request\"\"\"\n results = []\n nominatim_json = loads(resp.text)\n user_language = resp.search_params['language']\n\n if resp.search_params['route']:\n results.append({\n 'answer': gettext('Get directions'),\n 'url': route_url.format(*resp.search_params['route'].groups()),\n })\n\n fetch_wikidata(nominatim_json, user_language)\n\n for result in nominatim_json:\n title, address = get_title_address(result)\n\n # ignore result without title\n if not title:\n continue\n\n url, osm, geojson = get_url_osm_geojson(result)\n img_src = get_img_src(result)\n links, link_keys = get_links(result, user_language)\n data = get_data(result, user_language, link_keys)\n\n results.append({\n 'template': 'map.html',\n 'title': title,\n 'address': address,\n 'address_label': get_key_label('addr', user_language),\n 'url': url,\n 'osm': osm,\n 'geojson': geojson,\n 'img_src': img_src,\n 'links': links,\n 'data': data,\n 'type': get_tag_label(\n result.get('category'), result.get('type', ''), user_language\n ),\n 'type_icon': result.get('icon'),\n 'content': '',\n 'longitude': result['lon'],\n 'latitude': result['lat'],\n 'boundingbox': result['boundingbox'],\n })\n\n return results\n\n\ndef get_wikipedia_image(raw_value):\n if not raw_value:\n return None\n return get_external_url('wikimedia_image', raw_value)\n\n\ndef fetch_wikidata(nominatim_json, user_langage):\n \"\"\"Update nominatim_json using the result of an unique to wikidata\n\n For result in nominatim_json:\n If result['extratags']['wikidata'] or r['extratags']['wikidata link']:\n Set result['wikidata'] to { 'image': ..., 'image_sign':..., 'image_symbal':... }\n Set result['extratags']['wikipedia'] if not defined\n Set result['extratags']['contact:website'] if not defined\n \"\"\"\n wikidata_ids = []\n wd_to_results = {}\n for result in nominatim_json:\n e = result.get(\"extratags\")\n if e:\n # ignore brand:wikidata\n wd_id = e.get(\"wikidata\", e.get(\"wikidata link\"))\n if wd_id and wd_id not in wikidata_ids:\n wikidata_ids.append(\"wd:\" + wd_id)\n wd_to_results.setdefault(wd_id, []).append(result)\n\n if wikidata_ids:\n wikidata_ids_str = \" \".join(wikidata_ids)\n query = wikidata_image_sparql.replace('%WIKIDATA_IDS%', sparql_string_escape(wikidata_ids_str)).replace(\n '%LANGUAGE%', sparql_string_escape(user_langage)\n )\n wikidata_json = send_wikidata_query(query)\n for wd_result in wikidata_json.get('results', {}).get('bindings', {}):\n wd_id = wd_result['item']['value'].replace('http://www.wikidata.org/entity/', '')\n for result in wd_to_results.get(wd_id, []):\n result['wikidata'] = {\n 'itemLabel': wd_result['itemLabel']['value'],\n 'image': get_wikipedia_image(wd_result.get('image', {}).get('value')),\n 'image_sign': get_wikipedia_image(wd_result.get('sign', {}).get('value')),\n 'image_symbol': get_wikipedia_image(wd_result.get('symbol', {}).get('value')),\n }\n # overwrite wikipedia link\n wikipedia_name = wd_result.get('wikipediaName', {}).get('value')\n if wikipedia_name:\n result['extratags']['wikipedia'] = user_langage + ':' + wikipedia_name\n # get website if not already defined\n website = wd_result.get('website', {}).get('value')\n if (\n website\n and not result['extratags'].get('contact:website')\n and not result['extratags'].get('website')\n ):\n result['extratags']['contact:website'] = website\n\n\ndef get_title_address(result):\n \"\"\"Return title and address\n\n title may be None\n \"\"\"\n address_raw = result.get('address')\n address_name = None\n address = {}\n\n # get name\n if (\n result['category'] == 'amenity'\n or result['category'] == 'shop'\n or result['category'] == 'tourism'\n or result['category'] == 'leisure'\n ):\n if address_raw.get('address29'):\n # https://github.com/osm-search/Nominatim/issues/1662\n address_name = address_raw.get('address29')\n else:\n address_name = address_raw.get(result['category'])\n elif result['type'] in address_raw:\n address_name = address_raw.get(result['type'])\n\n # add rest of adressdata, if something is already found\n if address_name:\n title = address_name\n address.update(\n {\n 'name': address_name,\n 'house_number': address_raw.get('house_number'),\n 'road': address_raw.get('road'),\n 'locality': address_raw.get(\n 'city', address_raw.get('town', address_raw.get('village')) # noqa\n ), # noqa\n 'postcode': address_raw.get('postcode'),\n 'country': address_raw.get('country'),\n 'country_code': address_raw.get('country_code'),\n }\n )\n else:\n title = result.get('display_name')\n\n return title, address\n\n\ndef get_url_osm_geojson(result):\n \"\"\"Get url, osm and geojson\n \"\"\"\n osm_type = result.get('osm_type', result.get('type'))\n if 'osm_id' not in result:\n # see https://github.com/osm-search/Nominatim/issues/1521\n # query example: \"EC1M 5RF London\"\n url = result_lat_lon_url.format(lat=result['lat'], lon=result['lon'], zoom=12)\n osm = {}\n else:\n url = result_id_url.format(osm_type=osm_type, osm_id=result['osm_id'])\n osm = {'type': osm_type, 'id': result['osm_id']}\n\n geojson = result.get('geojson')\n # if no geojson is found and osm_type is a node, add geojson Point\n if not geojson and osm_type == 'node':\n geojson = {'type': 'Point', 'coordinates': [result['lon'], result['lat']]}\n\n return url, osm, geojson\n\n\ndef get_img_src(result):\n \"\"\"Get image URL from either wikidata or r['extratags']\"\"\"\n # wikidata\n img_src = None\n if 'wikidata' in result:\n img_src = result['wikidata']['image']\n if not img_src:\n img_src = result['wikidata']['image_symbol']\n if not img_src:\n img_src = result['wikidata']['image_sign']\n\n # img_src\n if not img_src and result.get('extratags', {}).get('image'):\n img_src = result['extratags']['image']\n del result['extratags']['image']\n if not img_src and result.get('extratags', {}).get('wikimedia_commons'):\n img_src = get_external_url('wikimedia_image', result['extratags']['wikimedia_commons'])\n del result['extratags']['wikimedia_commons']\n\n return img_src\n\n\ndef get_links(result, user_language):\n \"\"\"Return links from result['extratags']\"\"\"\n links = []\n link_keys = set()\n for k, mapping_function in VALUE_TO_LINK.items():\n raw_value = result['extratags'].get(k)\n if raw_value:\n url, url_label = mapping_function(raw_value)\n if url.startswith('https://wikidata.org'):\n url_label = result.get('wikidata', {}).get('itemLabel') or url_label\n links.append({\n 'label': get_key_label(k, user_language),\n 'url': url,\n 'url_label': url_label,\n })\n link_keys.add(k)\n return links, link_keys\n\n\ndef get_data(result, user_language, ignore_keys):\n \"\"\"Return key, value of result['extratags']\n\n Must be call after get_links\n\n Note: the values are not translated\n \"\"\"\n data = []\n for k, v in result['extratags'].items():\n if k in ignore_keys:\n continue\n if get_key_rank(k) is None:\n continue\n k_label = get_key_label(k, user_language)\n if k_label:\n data.append({\n 'label': k_label,\n 'key': k,\n 'value': v,\n })\n data.sort(key=lambda entry: (get_key_rank(entry['key']), entry['label']))\n return data\n\n\ndef get_key_rank(k):\n \"\"\"Get OSM key rank\n\n The rank defines in which order the key are displayed in the HTML result\n \"\"\"\n key_rank = KEY_RANKS.get(k)\n if key_rank is None:\n # \"payment:*\" in KEY_ORDER matches \"payment:cash\", \"payment:debit card\", etc...\n key_rank = KEY_RANKS.get(k.split(':')[0] + ':*')\n return key_rank\n\n\ndef get_label(labels, lang):\n \"\"\"Get label from labels in OSM_KEYS_TAGS\n\n in OSM_KEYS_TAGS, labels have key == '*'\n \"\"\"\n tag_label = labels.get(lang.lower())\n if tag_label is None:\n # example: if 'zh-hk' is not found, check 'zh'\n tag_label = labels.get(lang.split('-')[0])\n if tag_label is None and lang != 'en':\n # example: if 'zh' is not found, check 'en'\n tag_label = labels.get('en')\n if tag_label is None and len(labels.values()) > 0:\n # example: if still not found, use the first entry\n tag_label = labels.values()[0]\n return tag_label\n\n\ndef get_tag_label(tag_category, tag_name, lang):\n \"\"\"Get tag label from OSM_KEYS_TAGS\"\"\"\n tag_name = '' if tag_name is None else tag_name\n tag_labels = OSM_KEYS_TAGS['tags'].get(tag_category, {}).get(tag_name, {})\n return get_label(tag_labels, lang)\n\n\ndef get_key_label(key_name, lang):\n \"\"\"Get key label from OSM_KEYS_TAGS\"\"\"\n if key_name.startswith('currency:'):\n # currency:EUR --> get the name from the CURRENCIES variable\n # see https://wiki.openstreetmap.org/wiki/Key%3Acurrency\n # and for exampe https://taginfo.openstreetmap.org/keys/currency:EUR#values\n # but there is also currency=EUR (currently not handled)\n # https://taginfo.openstreetmap.org/keys/currency#values\n currency = key_name.split(':')\n if len(currency) > 1:\n o = CURRENCIES['iso4217'].get(currency)\n if o:\n return get_label(o, lang).lower()\n return currency\n\n labels = OSM_KEYS_TAGS['keys']\n for k in key_name.split(':') + ['*']:\n labels = labels.get(k)\n if labels is None:\n return None\n return get_label(labels, lang)\n\n\ndef init(_):\n import searx.engines.wikidata # pylint: disable=import-outside-toplevel\n searx.engines.wikidata.logger = logger\n", "path": "searx/engines/openstreetmap.py"}]} |
gh_patches_debug_219 | rasdani/github-patches | git_diff | googleapis__google-api-python-client-1030 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
googleapiclient.discovery.build fails with module 'six.moves' has no attribute 'collections_abc' since version 1.12.0
#### Environment details
- OS type and version: 18.04.1-Ubuntu
- Python version: Python 3.6.9
- pip version: `pip --version` pip 9.0.1
- `google-api-python-client` version: `pip show google-api-python-client`: Version: 1.12.0
#### Code example
googleapiclient.discovery.build() fails with message: module 'six.moves' has no attribute 'collections_abc'
We only see this problem with google-api-python-client 1.12.0. 1.11.0 is fine.
--- 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 # Copyright 2014 Google Inc. 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 """Setup script for Google API Python client.
16
17 Also installs included versions of third party libraries, if those libraries
18 are not already installed.
19 """
20 from __future__ import print_function
21
22 import sys
23
24 if sys.version_info < (2, 7):
25 print("google-api-python-client requires python version >= 2.7.", file=sys.stderr)
26 sys.exit(1)
27 if (3, 1) <= sys.version_info < (3, 4):
28 print("google-api-python-client requires python3 version >= 3.4.", file=sys.stderr)
29 sys.exit(1)
30
31 import io
32 import os
33 from setuptools import setup
34
35 packages = ["apiclient", "googleapiclient", "googleapiclient/discovery_cache"]
36
37 install_requires = [
38 # NOTE: Apache Beam tests depend on this library and cannot
39 # currently upgrade their httplib2 version.
40 # Please see https://github.com/googleapis/google-api-python-client/pull/841
41 "httplib2>=0.9.2,<1dev",
42 "google-auth>=1.16.0",
43 "google-auth-httplib2>=0.0.3",
44 "google-api-core>=1.21.0,<2dev",
45 "six>=1.6.1,<2dev",
46 "uritemplate>=3.0.0,<4dev",
47 ]
48
49 package_root = os.path.abspath(os.path.dirname(__file__))
50
51 readme_filename = os.path.join(package_root, "README.md")
52 with io.open(readme_filename, encoding="utf-8") as readme_file:
53 readme = readme_file.read()
54
55 version = "1.12.0"
56
57 setup(
58 name="google-api-python-client",
59 version=version,
60 description="Google API Client Library for Python",
61 long_description=readme,
62 long_description_content_type='text/markdown',
63 author="Google LLC",
64 author_email="[email protected]",
65 url="https://github.com/googleapis/google-api-python-client/",
66 install_requires=install_requires,
67 python_requires=">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*",
68 packages=packages,
69 package_data={},
70 license="Apache 2.0",
71 keywords="google api client",
72 classifiers=[
73 "Programming Language :: Python :: 2",
74 "Programming Language :: Python :: 2.7",
75 "Programming Language :: Python :: 3",
76 "Programming Language :: Python :: 3.5",
77 "Programming Language :: Python :: 3.6",
78 "Programming Language :: Python :: 3.7",
79 "Development Status :: 5 - Production/Stable",
80 "Intended Audience :: Developers",
81 "License :: OSI Approved :: Apache Software License",
82 "Operating System :: OS Independent",
83 "Topic :: Internet :: WWW/HTTP",
84 ],
85 )
86
```
--- 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
@@ -42,7 +42,7 @@
"google-auth>=1.16.0",
"google-auth-httplib2>=0.0.3",
"google-api-core>=1.21.0,<2dev",
- "six>=1.6.1,<2dev",
+ "six>=1.13.0,<2dev",
"uritemplate>=3.0.0,<4dev",
]
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -42,7 +42,7 @@\n \"google-auth>=1.16.0\",\n \"google-auth-httplib2>=0.0.3\",\n \"google-api-core>=1.21.0,<2dev\",\n- \"six>=1.6.1,<2dev\",\n+ \"six>=1.13.0,<2dev\",\n \"uritemplate>=3.0.0,<4dev\",\n ]\n", "issue": "googleapiclient.discovery.build fails with module 'six.moves' has no attribute 'collections_abc' since version 1.12.0\n#### Environment details\r\n\r\n - OS type and version: 18.04.1-Ubuntu\r\n - Python version: Python 3.6.9\r\n - pip version: `pip --version` pip 9.0.1\r\n - `google-api-python-client` version: `pip show google-api-python-client`: Version: 1.12.0\r\n\r\n#### Code example\r\ngoogleapiclient.discovery.build() fails with message: module 'six.moves' has no attribute 'collections_abc'\r\n\r\nWe only see this problem with google-api-python-client 1.12.0. 1.11.0 is fine.\r\n\r\n\n", "before_files": [{"content": "# Copyright 2014 Google Inc. 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\"\"\"Setup script for Google API Python client.\n\nAlso installs included versions of third party libraries, if those libraries\nare not already installed.\n\"\"\"\nfrom __future__ import print_function\n\nimport sys\n\nif sys.version_info < (2, 7):\n print(\"google-api-python-client requires python version >= 2.7.\", file=sys.stderr)\n sys.exit(1)\nif (3, 1) <= sys.version_info < (3, 4):\n print(\"google-api-python-client requires python3 version >= 3.4.\", file=sys.stderr)\n sys.exit(1)\n\nimport io\nimport os\nfrom setuptools import setup\n\npackages = [\"apiclient\", \"googleapiclient\", \"googleapiclient/discovery_cache\"]\n\ninstall_requires = [\n # NOTE: Apache Beam tests depend on this library and cannot\n # currently upgrade their httplib2 version.\n # Please see https://github.com/googleapis/google-api-python-client/pull/841\n \"httplib2>=0.9.2,<1dev\",\n \"google-auth>=1.16.0\",\n \"google-auth-httplib2>=0.0.3\",\n \"google-api-core>=1.21.0,<2dev\",\n \"six>=1.6.1,<2dev\",\n \"uritemplate>=3.0.0,<4dev\",\n]\n\npackage_root = os.path.abspath(os.path.dirname(__file__))\n\nreadme_filename = os.path.join(package_root, \"README.md\")\nwith io.open(readme_filename, encoding=\"utf-8\") as readme_file:\n readme = readme_file.read()\n\nversion = \"1.12.0\"\n\nsetup(\n name=\"google-api-python-client\",\n version=version,\n description=\"Google API Client Library for Python\",\n long_description=readme,\n long_description_content_type='text/markdown',\n author=\"Google LLC\",\n author_email=\"[email protected]\",\n url=\"https://github.com/googleapis/google-api-python-client/\",\n install_requires=install_requires,\n python_requires=\">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*\",\n packages=packages,\n package_data={},\n license=\"Apache 2.0\",\n keywords=\"google api client\",\n classifiers=[\n \"Programming Language :: Python :: 2\",\n \"Programming Language :: Python :: 2.7\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Development Status :: 5 - Production/Stable\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: Apache Software License\",\n \"Operating System :: OS Independent\",\n \"Topic :: Internet :: WWW/HTTP\",\n ],\n)\n", "path": "setup.py"}], "after_files": [{"content": "# Copyright 2014 Google Inc. 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\"\"\"Setup script for Google API Python client.\n\nAlso installs included versions of third party libraries, if those libraries\nare not already installed.\n\"\"\"\nfrom __future__ import print_function\n\nimport sys\n\nif sys.version_info < (2, 7):\n print(\"google-api-python-client requires python version >= 2.7.\", file=sys.stderr)\n sys.exit(1)\nif (3, 1) <= sys.version_info < (3, 4):\n print(\"google-api-python-client requires python3 version >= 3.4.\", file=sys.stderr)\n sys.exit(1)\n\nimport io\nimport os\nfrom setuptools import setup\n\npackages = [\"apiclient\", \"googleapiclient\", \"googleapiclient/discovery_cache\"]\n\ninstall_requires = [\n # NOTE: Apache Beam tests depend on this library and cannot\n # currently upgrade their httplib2 version.\n # Please see https://github.com/googleapis/google-api-python-client/pull/841\n \"httplib2>=0.9.2,<1dev\",\n \"google-auth>=1.16.0\",\n \"google-auth-httplib2>=0.0.3\",\n \"google-api-core>=1.21.0,<2dev\",\n \"six>=1.13.0,<2dev\",\n \"uritemplate>=3.0.0,<4dev\",\n]\n\npackage_root = os.path.abspath(os.path.dirname(__file__))\n\nreadme_filename = os.path.join(package_root, \"README.md\")\nwith io.open(readme_filename, encoding=\"utf-8\") as readme_file:\n readme = readme_file.read()\n\nversion = \"1.12.0\"\n\nsetup(\n name=\"google-api-python-client\",\n version=version,\n description=\"Google API Client Library for Python\",\n long_description=readme,\n long_description_content_type='text/markdown',\n author=\"Google LLC\",\n author_email=\"[email protected]\",\n url=\"https://github.com/googleapis/google-api-python-client/\",\n install_requires=install_requires,\n python_requires=\">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*\",\n packages=packages,\n package_data={},\n license=\"Apache 2.0\",\n keywords=\"google api client\",\n classifiers=[\n \"Programming Language :: Python :: 2\",\n \"Programming Language :: Python :: 2.7\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Development Status :: 5 - Production/Stable\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: Apache Software License\",\n \"Operating System :: OS Independent\",\n \"Topic :: Internet :: WWW/HTTP\",\n ],\n)\n", "path": "setup.py"}]} |
gh_patches_debug_220 | rasdani/github-patches | git_diff | pypi__warehouse-3600 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Set samesite=lax on session cookies
This is a strong defense-in-depth mechanism for protecting against CSRF. It's currently only respected by Chrome, but Firefox will add it as well.
Update webob to 1.8.0
This PR updates [WebOb](https://pypi.org/project/WebOb) from **1.7.4** to **1.8.0**.
<details>
<summary>Changelog</summary>
### 1.8.0
```
------------------
Feature
~~~~~~~
- ``request.POST`` now supports any requests with the appropriate
Content-Type. Allowing any HTTP method to access form encoded content,
including DELETE, PUT, and others. See
https://github.com/Pylons/webob/pull/352
Compatibility
~~~~~~~~~~~~~
- WebOb is no longer officially supported on Python 3.3 which was EOL'ed on
2017-09-29.
Backwards Incompatibilities
~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Many changes have been made to the way WebOb does Accept handling, not just
for the Accept header itself, but also for Accept-Charset, Accept-Encoding
and Accept-Language. This was a `Google Summer of Code
<https://developers.google.com/open-source/gsoc/>`_ project completed by
Whiteroses (https://github.com/whiteroses). Many thanks to Google for running
GSoC, the Python Software Foundation for organising and a huge thanks to Ira
for completing the work. See https://github.com/Pylons/webob/pull/338 and
https://github.com/Pylons/webob/pull/335. Documentation is available at
https://docs.pylonsproject.org/projects/webob/en/master/api/webob.html
- When calling a ``wsgify`` decorated function, the default arguments passed
to ``wsgify`` are now used when called with the request, and not as a
`start_response`
.. code::
def hello(req, name):
return "Hello, %s!" % name
app = wsgify(hello, args=("Fred",))
req = Request.blank('/')
resp = req.get_response(app) => "Hello, Fred"
resp2 = app(req) => "Hello, Fred"
Previously the ``resp2`` line would have failed with a ``TypeError``. With
this change there is no way to override the default arguments with no
arguments. See https://github.com/Pylons/webob/pull/203
- When setting ``app_iter`` on a ``Response`` object the ``content_md5`` header
is no longer cleared. This behaviour is odd and disallows setting the
``content_md5`` and then returning an iterator for chunked content encoded
responses. See https://github.com/Pylons/webob/issues/86
Experimental Features
~~~~~~~~~~~~~~~~~~~~~
These features are experimental and may change at any point in the future.
- The cookie APIs now have the ability to set the SameSite attribute on a
cookie in both ``webob.cookies.make_cookie`` and
``webob.cookies.CookieProfile``. See https://github.com/Pylons/webob/pull/255
Bugfix
~~~~~~
- Exceptions now use string.Template.safe_substitute rather than
string.Template.substitute. The latter would raise for missing mappings, the
former will simply not substitute the missing variable. This is safer in case
the WSGI environ does not contain the keys necessary for the body template.
See https://github.com/Pylons/webob/issues/345.
- Request.host_url, Request.host_port, Request.domain correctly parse IPv6 Host
headers as provided by a browser. See
https://github.com/Pylons/webob/pull/332
- Request.authorization would raise ValueError for unusual or malformed header
values. See https://github.com/Pylons/webob/issues/231
- Allow unnamed fields in form data to be properly transcoded when calling
request.decode with an alternate encoding. See
https://github.com/Pylons/webob/pull/309
- ``Response.__init__`` would discard ``app_iter`` when a ``Response`` had no
body, this would cause issues when ``app_iter`` was an object that was tied
to the life-cycle of a web application and had to be properly closed.
``app_iter`` is more advanced API for ``Response`` and thus even if it
contains a body and is thus against the HTTP RFC's, we should let the users
shoot themselves by returning a body. See
https://github.com/Pylons/webob/issues/305
```
</details>
<details>
<summary>Links</summary>
- PyPI: https://pypi.org/project/webob
- Changelog: https://pyup.io/changelogs/webob/
- Homepage: http://webob.org/
</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: `warehouse/sessions.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 import functools
14 import time
15
16 import msgpack
17 import msgpack.exceptions
18 import redis
19
20 from pyramid import viewderivers
21 from pyramid.interfaces import ISession, ISessionFactory
22 from zope.interface import implementer
23
24 from warehouse.cache.http import add_vary
25 from warehouse.utils import crypto
26
27
28 def _invalid_method(method):
29 @functools.wraps(method)
30 def wrapped(self, *args, **kwargs):
31 self._error_message()
32 return wrapped
33
34
35 @implementer(ISession)
36 class InvalidSession(dict):
37
38 __contains__ = _invalid_method(dict.__contains__)
39 __delitem__ = _invalid_method(dict.__delitem__)
40 __getitem__ = _invalid_method(dict.__getitem__)
41 __iter__ = _invalid_method(dict.__iter__)
42 __len__ = _invalid_method(dict.__len__)
43 __setitem__ = _invalid_method(dict.__setitem__)
44 clear = _invalid_method(dict.clear)
45 copy = _invalid_method(dict.copy)
46 fromkeys = _invalid_method(dict.fromkeys)
47 get = _invalid_method(dict.get)
48 items = _invalid_method(dict.items)
49 keys = _invalid_method(dict.keys)
50 pop = _invalid_method(dict.pop)
51 popitem = _invalid_method(dict.popitem)
52 setdefault = _invalid_method(dict.setdefault)
53 update = _invalid_method(dict.update)
54 values = _invalid_method(dict.values)
55
56 def _error_message(self):
57 raise RuntimeError(
58 "Cannot use request.session in a view without uses_session=True."
59 )
60
61 def __getattr__(self, name):
62 self._error_message()
63
64 @property
65 def created(self):
66 self._error_message()
67
68
69 def _changed_method(method):
70 @functools.wraps(method)
71 def wrapped(self, *args, **kwargs):
72 self.changed()
73 return method(self, *args, **kwargs)
74 return wrapped
75
76
77 @implementer(ISession)
78 class Session(dict):
79
80 _csrf_token_key = "_csrf_token"
81 _flash_key = "_flash_messages"
82
83 # A number of our methods need to be decorated so that they also call
84 # self.changed()
85 __delitem__ = _changed_method(dict.__delitem__)
86 __setitem__ = _changed_method(dict.__setitem__)
87 clear = _changed_method(dict.clear)
88 pop = _changed_method(dict.pop)
89 popitem = _changed_method(dict.popitem)
90 setdefault = _changed_method(dict.setdefault)
91 update = _changed_method(dict.update)
92
93 def __init__(self, data=None, session_id=None, new=True):
94 # Brand new sessions don't have any data, so we'll just create an empty
95 # dictionary for them.
96 if data is None:
97 data = {}
98
99 # Initialize our actual dictionary here.
100 super().__init__(data)
101
102 # We need to track the state of our Session.
103 self._sid = session_id
104 self._changed = False
105 self.new = new
106 self.created = int(time.time())
107
108 # We'll track all of the IDs that have been invalidated here
109 self.invalidated = set()
110
111 @property
112 def sid(self):
113 if self._sid is None:
114 self._sid = crypto.random_token()
115 return self._sid
116
117 def changed(self):
118 self._changed = True
119
120 def invalidate(self):
121 self.clear()
122 self.new = True
123 self.created = int(time.time())
124 self._changed = False
125
126 # If the current session id isn't None we'll want to record it as one
127 # of the ones that have been invalidated.
128 if self._sid is not None:
129 self.invalidated.add(self._sid)
130 self._sid = None
131
132 def should_save(self):
133 return self._changed
134
135 # Flash Messages Methods
136 def _get_flash_queue_key(self, queue):
137 return ".".join(filter(None, [self._flash_key, queue]))
138
139 def flash(self, msg, queue="", allow_duplicate=True):
140 queue_key = self._get_flash_queue_key(queue)
141
142 # If we're not allowing duplicates check if this message is already
143 # in the queue, and if it is just return immediately.
144 if not allow_duplicate and msg in self[queue_key]:
145 return
146
147 self.setdefault(queue_key, []).append(msg)
148
149 def peek_flash(self, queue=""):
150 return self.get(self._get_flash_queue_key(queue), [])
151
152 def pop_flash(self, queue=""):
153 queue_key = self._get_flash_queue_key(queue)
154 messages = self.get(queue_key, [])
155 self.pop(queue_key, None)
156 return messages
157
158 # CSRF Methods
159 def new_csrf_token(self):
160 self[self._csrf_token_key] = crypto.random_token()
161 return self[self._csrf_token_key]
162
163 def get_csrf_token(self):
164 token = self.get(self._csrf_token_key)
165 if token is None:
166 token = self.new_csrf_token()
167 return token
168
169
170 @implementer(ISessionFactory)
171 class SessionFactory:
172
173 cookie_name = "session_id"
174 max_age = 12 * 60 * 60 # 12 hours
175
176 def __init__(self, secret, url):
177 self.redis = redis.StrictRedis.from_url(url)
178 self.signer = crypto.TimestampSigner(secret, salt="session")
179
180 def __call__(self, request):
181 return self._process_request(request)
182
183 def _redis_key(self, session_id):
184 return "warehouse/session/data/{}".format(session_id)
185
186 def _process_request(self, request):
187 # Register a callback with the request so we can save the session once
188 # it's finished.
189 request.add_response_callback(self._process_response)
190
191 # Load our session ID from the request.
192 session_id = request.cookies.get(self.cookie_name)
193
194 # If we do not have a session ID then we'll just use a new empty
195 # session.
196 if session_id is None:
197 return Session()
198
199 # Check to make sure we have a valid session id
200 try:
201 session_id = self.signer.unsign(session_id, max_age=self.max_age)
202 session_id = session_id.decode("utf8")
203 except crypto.BadSignature:
204 return Session()
205
206 # Fetch the serialized data from redis
207 bdata = self.redis.get(self._redis_key(session_id))
208
209 # If the session didn't exist in redis, we'll give the user a new
210 # session.
211 if bdata is None:
212 return Session()
213
214 # De-serialize our session data
215 try:
216 data = msgpack.unpackb(bdata, encoding="utf8", use_list=True)
217 except (msgpack.exceptions.UnpackException,
218 msgpack.exceptions.ExtraData):
219 # If the session data was invalid we'll give the user a new session
220 return Session()
221
222 # If we were able to load existing session data, load it into a
223 # Session class
224 session = Session(data, session_id, False)
225
226 return session
227
228 def _process_response(self, request, response):
229 # If the request has an InvalidSession, then the view can't have
230 # accessed the session, and we can just skip all of this anyways.
231 if isinstance(request.session, InvalidSession):
232 return
233
234 # Check to see if the session has been marked to be deleted, if it has
235 # benn then we'll delete it, and tell our response to delete the
236 # session cookie as well.
237 if request.session.invalidated:
238 for session_id in request.session.invalidated:
239 self.redis.delete(self._redis_key(session_id))
240
241 if not request.session.should_save():
242 response.delete_cookie(self.cookie_name)
243
244 # Check to see if the session has been marked to be saved, generally
245 # this means that the session data has been modified and thus we need
246 # to store the new data.
247 if request.session.should_save():
248 # Save our session in Redis
249 self.redis.setex(
250 self._redis_key(request.session.sid),
251 self.max_age,
252 msgpack.packb(
253 request.session,
254 encoding="utf8",
255 use_bin_type=True,
256 ),
257 )
258
259 # Send our session cookie to the client
260 response.set_cookie(
261 self.cookie_name,
262 self.signer.sign(request.session.sid.encode("utf8")),
263 max_age=self.max_age,
264 httponly=True,
265 secure=request.scheme == "https",
266 )
267
268
269 def session_view(view, info):
270 if info.options.get("uses_session"):
271 # If we're using the session, then we'll just return the original view
272 # with a small wrapper around it to ensure that it has a Vary: Cookie
273 # header.
274 return add_vary("Cookie")(view)
275 elif info.exception_only:
276 return view
277 else:
278 # If we're not using the session on this view, then we'll wrap the view
279 # with a wrapper that just ensures that the session cannot be used.
280 @functools.wraps(view)
281 def wrapped(context, request):
282 # This whole method is a little bit of an odd duck, we want to make
283 # sure that we don't actually *access* request.session, because
284 # doing so triggers the machinery to create a new session. So
285 # instead we will dig into the request object __dict__ to
286 # effectively do the same thing, jsut without triggering an access
287 # on request.session.
288
289 # Save the original session so that we can restore it once the
290 # inner views have been called.
291 nothing = object()
292 original_session = request.__dict__.get("session", nothing)
293
294 # This particular view hasn't been set to allow access to the
295 # session, so we'll just assign an InvalidSession to
296 # request.session
297 request.__dict__["session"] = InvalidSession()
298
299 try:
300 # Invoke the real view
301 return view(context, request)
302 finally:
303 # Restore the original session so that things like
304 # pyramid_debugtoolbar can access it.
305 if original_session is nothing:
306 del request.__dict__["session"]
307 else:
308 request.__dict__["session"] = original_session
309
310 return wrapped
311
312
313 session_view.options = {"uses_session"}
314
315
316 def includeme(config):
317 config.set_session_factory(
318 SessionFactory(
319 config.registry.settings["sessions.secret"],
320 config.registry.settings["sessions.url"],
321 ),
322 )
323
324 config.add_view_deriver(
325 session_view,
326 over="csrf_view",
327 under=viewderivers.INGRESS,
328 )
329
```
--- 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/warehouse/sessions.py b/warehouse/sessions.py
--- a/warehouse/sessions.py
+++ b/warehouse/sessions.py
@@ -263,6 +263,7 @@
max_age=self.max_age,
httponly=True,
secure=request.scheme == "https",
+ samesite=b"lax"
)
| {"golden_diff": "diff --git a/warehouse/sessions.py b/warehouse/sessions.py\n--- a/warehouse/sessions.py\n+++ b/warehouse/sessions.py\n@@ -263,6 +263,7 @@\n max_age=self.max_age,\n httponly=True,\n secure=request.scheme == \"https\",\n+ samesite=b\"lax\"\n )\n", "issue": "Set samesite=lax on session cookies\nThis is a strong defense-in-depth mechanism for protecting against CSRF. It's currently only respected by Chrome, but Firefox will add it as well.\nUpdate webob to 1.8.0\n\nThis PR updates [WebOb](https://pypi.org/project/WebOb) from **1.7.4** to **1.8.0**.\n\n\n\n<details>\n <summary>Changelog</summary>\n \n \n ### 1.8.0\n ```\n ------------------\n\nFeature\n~~~~~~~\n\n- ``request.POST`` now supports any requests with the appropriate\n Content-Type. Allowing any HTTP method to access form encoded content,\n including DELETE, PUT, and others. See\n https://github.com/Pylons/webob/pull/352\n\nCompatibility\n~~~~~~~~~~~~~\n\n- WebOb is no longer officially supported on Python 3.3 which was EOL'ed on\n 2017-09-29.\n\nBackwards Incompatibilities\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n- Many changes have been made to the way WebOb does Accept handling, not just\n for the Accept header itself, but also for Accept-Charset, Accept-Encoding\n and Accept-Language. This was a `Google Summer of Code\n <https://developers.google.com/open-source/gsoc/>`_ project completed by\n Whiteroses (https://github.com/whiteroses). Many thanks to Google for running\n GSoC, the Python Software Foundation for organising and a huge thanks to Ira\n for completing the work. See https://github.com/Pylons/webob/pull/338 and\n https://github.com/Pylons/webob/pull/335. Documentation is available at\n https://docs.pylonsproject.org/projects/webob/en/master/api/webob.html\n\n- When calling a ``wsgify`` decorated function, the default arguments passed\n to ``wsgify`` are now used when called with the request, and not as a\n `start_response`\n\n .. code::\n\n def hello(req, name):\n return "Hello, %s!" % name\n app = wsgify(hello, args=("Fred",))\n\n req = Request.blank('/')\n resp = req.get_response(app) => "Hello, Fred"\n resp2 = app(req) => "Hello, Fred"\n\n Previously the ``resp2`` line would have failed with a ``TypeError``. With\n this change there is no way to override the default arguments with no\n arguments. See https://github.com/Pylons/webob/pull/203\n\n- When setting ``app_iter`` on a ``Response`` object the ``content_md5`` header\n is no longer cleared. This behaviour is odd and disallows setting the\n ``content_md5`` and then returning an iterator for chunked content encoded\n responses. See https://github.com/Pylons/webob/issues/86\n\nExperimental Features\n~~~~~~~~~~~~~~~~~~~~~\n\nThese features are experimental and may change at any point in the future.\n\n- The cookie APIs now have the ability to set the SameSite attribute on a\n cookie in both ``webob.cookies.make_cookie`` and\n ``webob.cookies.CookieProfile``. See https://github.com/Pylons/webob/pull/255\n\nBugfix\n~~~~~~\n\n- Exceptions now use string.Template.safe_substitute rather than\n string.Template.substitute. The latter would raise for missing mappings, the\n former will simply not substitute the missing variable. This is safer in case\n the WSGI environ does not contain the keys necessary for the body template.\n See https://github.com/Pylons/webob/issues/345.\n\n- Request.host_url, Request.host_port, Request.domain correctly parse IPv6 Host\n headers as provided by a browser. See\n https://github.com/Pylons/webob/pull/332\n\n- Request.authorization would raise ValueError for unusual or malformed header\n values. See https://github.com/Pylons/webob/issues/231\n\n- Allow unnamed fields in form data to be properly transcoded when calling\n request.decode with an alternate encoding. See\n https://github.com/Pylons/webob/pull/309\n\n- ``Response.__init__`` would discard ``app_iter`` when a ``Response`` had no\n body, this would cause issues when ``app_iter`` was an object that was tied\n to the life-cycle of a web application and had to be properly closed.\n ``app_iter`` is more advanced API for ``Response`` and thus even if it\n contains a body and is thus against the HTTP RFC's, we should let the users\n shoot themselves by returning a body. See\n https://github.com/Pylons/webob/issues/305\n ```\n \n \n</details>\n\n\n \n\n<details>\n <summary>Links</summary>\n \n - PyPI: https://pypi.org/project/webob\n - Changelog: https://pyup.io/changelogs/webob/\n - Homepage: http://webob.org/\n</details>\n\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\nimport functools\nimport time\n\nimport msgpack\nimport msgpack.exceptions\nimport redis\n\nfrom pyramid import viewderivers\nfrom pyramid.interfaces import ISession, ISessionFactory\nfrom zope.interface import implementer\n\nfrom warehouse.cache.http import add_vary\nfrom warehouse.utils import crypto\n\n\ndef _invalid_method(method):\n @functools.wraps(method)\n def wrapped(self, *args, **kwargs):\n self._error_message()\n return wrapped\n\n\n@implementer(ISession)\nclass InvalidSession(dict):\n\n __contains__ = _invalid_method(dict.__contains__)\n __delitem__ = _invalid_method(dict.__delitem__)\n __getitem__ = _invalid_method(dict.__getitem__)\n __iter__ = _invalid_method(dict.__iter__)\n __len__ = _invalid_method(dict.__len__)\n __setitem__ = _invalid_method(dict.__setitem__)\n clear = _invalid_method(dict.clear)\n copy = _invalid_method(dict.copy)\n fromkeys = _invalid_method(dict.fromkeys)\n get = _invalid_method(dict.get)\n items = _invalid_method(dict.items)\n keys = _invalid_method(dict.keys)\n pop = _invalid_method(dict.pop)\n popitem = _invalid_method(dict.popitem)\n setdefault = _invalid_method(dict.setdefault)\n update = _invalid_method(dict.update)\n values = _invalid_method(dict.values)\n\n def _error_message(self):\n raise RuntimeError(\n \"Cannot use request.session in a view without uses_session=True.\"\n )\n\n def __getattr__(self, name):\n self._error_message()\n\n @property\n def created(self):\n self._error_message()\n\n\ndef _changed_method(method):\n @functools.wraps(method)\n def wrapped(self, *args, **kwargs):\n self.changed()\n return method(self, *args, **kwargs)\n return wrapped\n\n\n@implementer(ISession)\nclass Session(dict):\n\n _csrf_token_key = \"_csrf_token\"\n _flash_key = \"_flash_messages\"\n\n # A number of our methods need to be decorated so that they also call\n # self.changed()\n __delitem__ = _changed_method(dict.__delitem__)\n __setitem__ = _changed_method(dict.__setitem__)\n clear = _changed_method(dict.clear)\n pop = _changed_method(dict.pop)\n popitem = _changed_method(dict.popitem)\n setdefault = _changed_method(dict.setdefault)\n update = _changed_method(dict.update)\n\n def __init__(self, data=None, session_id=None, new=True):\n # Brand new sessions don't have any data, so we'll just create an empty\n # dictionary for them.\n if data is None:\n data = {}\n\n # Initialize our actual dictionary here.\n super().__init__(data)\n\n # We need to track the state of our Session.\n self._sid = session_id\n self._changed = False\n self.new = new\n self.created = int(time.time())\n\n # We'll track all of the IDs that have been invalidated here\n self.invalidated = set()\n\n @property\n def sid(self):\n if self._sid is None:\n self._sid = crypto.random_token()\n return self._sid\n\n def changed(self):\n self._changed = True\n\n def invalidate(self):\n self.clear()\n self.new = True\n self.created = int(time.time())\n self._changed = False\n\n # If the current session id isn't None we'll want to record it as one\n # of the ones that have been invalidated.\n if self._sid is not None:\n self.invalidated.add(self._sid)\n self._sid = None\n\n def should_save(self):\n return self._changed\n\n # Flash Messages Methods\n def _get_flash_queue_key(self, queue):\n return \".\".join(filter(None, [self._flash_key, queue]))\n\n def flash(self, msg, queue=\"\", allow_duplicate=True):\n queue_key = self._get_flash_queue_key(queue)\n\n # If we're not allowing duplicates check if this message is already\n # in the queue, and if it is just return immediately.\n if not allow_duplicate and msg in self[queue_key]:\n return\n\n self.setdefault(queue_key, []).append(msg)\n\n def peek_flash(self, queue=\"\"):\n return self.get(self._get_flash_queue_key(queue), [])\n\n def pop_flash(self, queue=\"\"):\n queue_key = self._get_flash_queue_key(queue)\n messages = self.get(queue_key, [])\n self.pop(queue_key, None)\n return messages\n\n # CSRF Methods\n def new_csrf_token(self):\n self[self._csrf_token_key] = crypto.random_token()\n return self[self._csrf_token_key]\n\n def get_csrf_token(self):\n token = self.get(self._csrf_token_key)\n if token is None:\n token = self.new_csrf_token()\n return token\n\n\n@implementer(ISessionFactory)\nclass SessionFactory:\n\n cookie_name = \"session_id\"\n max_age = 12 * 60 * 60 # 12 hours\n\n def __init__(self, secret, url):\n self.redis = redis.StrictRedis.from_url(url)\n self.signer = crypto.TimestampSigner(secret, salt=\"session\")\n\n def __call__(self, request):\n return self._process_request(request)\n\n def _redis_key(self, session_id):\n return \"warehouse/session/data/{}\".format(session_id)\n\n def _process_request(self, request):\n # Register a callback with the request so we can save the session once\n # it's finished.\n request.add_response_callback(self._process_response)\n\n # Load our session ID from the request.\n session_id = request.cookies.get(self.cookie_name)\n\n # If we do not have a session ID then we'll just use a new empty\n # session.\n if session_id is None:\n return Session()\n\n # Check to make sure we have a valid session id\n try:\n session_id = self.signer.unsign(session_id, max_age=self.max_age)\n session_id = session_id.decode(\"utf8\")\n except crypto.BadSignature:\n return Session()\n\n # Fetch the serialized data from redis\n bdata = self.redis.get(self._redis_key(session_id))\n\n # If the session didn't exist in redis, we'll give the user a new\n # session.\n if bdata is None:\n return Session()\n\n # De-serialize our session data\n try:\n data = msgpack.unpackb(bdata, encoding=\"utf8\", use_list=True)\n except (msgpack.exceptions.UnpackException,\n msgpack.exceptions.ExtraData):\n # If the session data was invalid we'll give the user a new session\n return Session()\n\n # If we were able to load existing session data, load it into a\n # Session class\n session = Session(data, session_id, False)\n\n return session\n\n def _process_response(self, request, response):\n # If the request has an InvalidSession, then the view can't have\n # accessed the session, and we can just skip all of this anyways.\n if isinstance(request.session, InvalidSession):\n return\n\n # Check to see if the session has been marked to be deleted, if it has\n # benn then we'll delete it, and tell our response to delete the\n # session cookie as well.\n if request.session.invalidated:\n for session_id in request.session.invalidated:\n self.redis.delete(self._redis_key(session_id))\n\n if not request.session.should_save():\n response.delete_cookie(self.cookie_name)\n\n # Check to see if the session has been marked to be saved, generally\n # this means that the session data has been modified and thus we need\n # to store the new data.\n if request.session.should_save():\n # Save our session in Redis\n self.redis.setex(\n self._redis_key(request.session.sid),\n self.max_age,\n msgpack.packb(\n request.session,\n encoding=\"utf8\",\n use_bin_type=True,\n ),\n )\n\n # Send our session cookie to the client\n response.set_cookie(\n self.cookie_name,\n self.signer.sign(request.session.sid.encode(\"utf8\")),\n max_age=self.max_age,\n httponly=True,\n secure=request.scheme == \"https\",\n )\n\n\ndef session_view(view, info):\n if info.options.get(\"uses_session\"):\n # If we're using the session, then we'll just return the original view\n # with a small wrapper around it to ensure that it has a Vary: Cookie\n # header.\n return add_vary(\"Cookie\")(view)\n elif info.exception_only:\n return view\n else:\n # If we're not using the session on this view, then we'll wrap the view\n # with a wrapper that just ensures that the session cannot be used.\n @functools.wraps(view)\n def wrapped(context, request):\n # This whole method is a little bit of an odd duck, we want to make\n # sure that we don't actually *access* request.session, because\n # doing so triggers the machinery to create a new session. So\n # instead we will dig into the request object __dict__ to\n # effectively do the same thing, jsut without triggering an access\n # on request.session.\n\n # Save the original session so that we can restore it once the\n # inner views have been called.\n nothing = object()\n original_session = request.__dict__.get(\"session\", nothing)\n\n # This particular view hasn't been set to allow access to the\n # session, so we'll just assign an InvalidSession to\n # request.session\n request.__dict__[\"session\"] = InvalidSession()\n\n try:\n # Invoke the real view\n return view(context, request)\n finally:\n # Restore the original session so that things like\n # pyramid_debugtoolbar can access it.\n if original_session is nothing:\n del request.__dict__[\"session\"]\n else:\n request.__dict__[\"session\"] = original_session\n\n return wrapped\n\n\nsession_view.options = {\"uses_session\"}\n\n\ndef includeme(config):\n config.set_session_factory(\n SessionFactory(\n config.registry.settings[\"sessions.secret\"],\n config.registry.settings[\"sessions.url\"],\n ),\n )\n\n config.add_view_deriver(\n session_view,\n over=\"csrf_view\",\n under=viewderivers.INGRESS,\n )\n", "path": "warehouse/sessions.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\nimport functools\nimport time\n\nimport msgpack\nimport msgpack.exceptions\nimport redis\n\nfrom pyramid import viewderivers\nfrom pyramid.interfaces import ISession, ISessionFactory\nfrom zope.interface import implementer\n\nfrom warehouse.cache.http import add_vary\nfrom warehouse.utils import crypto\n\n\ndef _invalid_method(method):\n @functools.wraps(method)\n def wrapped(self, *args, **kwargs):\n self._error_message()\n return wrapped\n\n\n@implementer(ISession)\nclass InvalidSession(dict):\n\n __contains__ = _invalid_method(dict.__contains__)\n __delitem__ = _invalid_method(dict.__delitem__)\n __getitem__ = _invalid_method(dict.__getitem__)\n __iter__ = _invalid_method(dict.__iter__)\n __len__ = _invalid_method(dict.__len__)\n __setitem__ = _invalid_method(dict.__setitem__)\n clear = _invalid_method(dict.clear)\n copy = _invalid_method(dict.copy)\n fromkeys = _invalid_method(dict.fromkeys)\n get = _invalid_method(dict.get)\n items = _invalid_method(dict.items)\n keys = _invalid_method(dict.keys)\n pop = _invalid_method(dict.pop)\n popitem = _invalid_method(dict.popitem)\n setdefault = _invalid_method(dict.setdefault)\n update = _invalid_method(dict.update)\n values = _invalid_method(dict.values)\n\n def _error_message(self):\n raise RuntimeError(\n \"Cannot use request.session in a view without uses_session=True.\"\n )\n\n def __getattr__(self, name):\n self._error_message()\n\n @property\n def created(self):\n self._error_message()\n\n\ndef _changed_method(method):\n @functools.wraps(method)\n def wrapped(self, *args, **kwargs):\n self.changed()\n return method(self, *args, **kwargs)\n return wrapped\n\n\n@implementer(ISession)\nclass Session(dict):\n\n _csrf_token_key = \"_csrf_token\"\n _flash_key = \"_flash_messages\"\n\n # A number of our methods need to be decorated so that they also call\n # self.changed()\n __delitem__ = _changed_method(dict.__delitem__)\n __setitem__ = _changed_method(dict.__setitem__)\n clear = _changed_method(dict.clear)\n pop = _changed_method(dict.pop)\n popitem = _changed_method(dict.popitem)\n setdefault = _changed_method(dict.setdefault)\n update = _changed_method(dict.update)\n\n def __init__(self, data=None, session_id=None, new=True):\n # Brand new sessions don't have any data, so we'll just create an empty\n # dictionary for them.\n if data is None:\n data = {}\n\n # Initialize our actual dictionary here.\n super().__init__(data)\n\n # We need to track the state of our Session.\n self._sid = session_id\n self._changed = False\n self.new = new\n self.created = int(time.time())\n\n # We'll track all of the IDs that have been invalidated here\n self.invalidated = set()\n\n @property\n def sid(self):\n if self._sid is None:\n self._sid = crypto.random_token()\n return self._sid\n\n def changed(self):\n self._changed = True\n\n def invalidate(self):\n self.clear()\n self.new = True\n self.created = int(time.time())\n self._changed = False\n\n # If the current session id isn't None we'll want to record it as one\n # of the ones that have been invalidated.\n if self._sid is not None:\n self.invalidated.add(self._sid)\n self._sid = None\n\n def should_save(self):\n return self._changed\n\n # Flash Messages Methods\n def _get_flash_queue_key(self, queue):\n return \".\".join(filter(None, [self._flash_key, queue]))\n\n def flash(self, msg, queue=\"\", allow_duplicate=True):\n queue_key = self._get_flash_queue_key(queue)\n\n # If we're not allowing duplicates check if this message is already\n # in the queue, and if it is just return immediately.\n if not allow_duplicate and msg in self[queue_key]:\n return\n\n self.setdefault(queue_key, []).append(msg)\n\n def peek_flash(self, queue=\"\"):\n return self.get(self._get_flash_queue_key(queue), [])\n\n def pop_flash(self, queue=\"\"):\n queue_key = self._get_flash_queue_key(queue)\n messages = self.get(queue_key, [])\n self.pop(queue_key, None)\n return messages\n\n # CSRF Methods\n def new_csrf_token(self):\n self[self._csrf_token_key] = crypto.random_token()\n return self[self._csrf_token_key]\n\n def get_csrf_token(self):\n token = self.get(self._csrf_token_key)\n if token is None:\n token = self.new_csrf_token()\n return token\n\n\n@implementer(ISessionFactory)\nclass SessionFactory:\n\n cookie_name = \"session_id\"\n max_age = 12 * 60 * 60 # 12 hours\n\n def __init__(self, secret, url):\n self.redis = redis.StrictRedis.from_url(url)\n self.signer = crypto.TimestampSigner(secret, salt=\"session\")\n\n def __call__(self, request):\n return self._process_request(request)\n\n def _redis_key(self, session_id):\n return \"warehouse/session/data/{}\".format(session_id)\n\n def _process_request(self, request):\n # Register a callback with the request so we can save the session once\n # it's finished.\n request.add_response_callback(self._process_response)\n\n # Load our session ID from the request.\n session_id = request.cookies.get(self.cookie_name)\n\n # If we do not have a session ID then we'll just use a new empty\n # session.\n if session_id is None:\n return Session()\n\n # Check to make sure we have a valid session id\n try:\n session_id = self.signer.unsign(session_id, max_age=self.max_age)\n session_id = session_id.decode(\"utf8\")\n except crypto.BadSignature:\n return Session()\n\n # Fetch the serialized data from redis\n bdata = self.redis.get(self._redis_key(session_id))\n\n # If the session didn't exist in redis, we'll give the user a new\n # session.\n if bdata is None:\n return Session()\n\n # De-serialize our session data\n try:\n data = msgpack.unpackb(bdata, encoding=\"utf8\", use_list=True)\n except (msgpack.exceptions.UnpackException,\n msgpack.exceptions.ExtraData):\n # If the session data was invalid we'll give the user a new session\n return Session()\n\n # If we were able to load existing session data, load it into a\n # Session class\n session = Session(data, session_id, False)\n\n return session\n\n def _process_response(self, request, response):\n # If the request has an InvalidSession, then the view can't have\n # accessed the session, and we can just skip all of this anyways.\n if isinstance(request.session, InvalidSession):\n return\n\n # Check to see if the session has been marked to be deleted, if it has\n # benn then we'll delete it, and tell our response to delete the\n # session cookie as well.\n if request.session.invalidated:\n for session_id in request.session.invalidated:\n self.redis.delete(self._redis_key(session_id))\n\n if not request.session.should_save():\n response.delete_cookie(self.cookie_name)\n\n # Check to see if the session has been marked to be saved, generally\n # this means that the session data has been modified and thus we need\n # to store the new data.\n if request.session.should_save():\n # Save our session in Redis\n self.redis.setex(\n self._redis_key(request.session.sid),\n self.max_age,\n msgpack.packb(\n request.session,\n encoding=\"utf8\",\n use_bin_type=True,\n ),\n )\n\n # Send our session cookie to the client\n response.set_cookie(\n self.cookie_name,\n self.signer.sign(request.session.sid.encode(\"utf8\")),\n max_age=self.max_age,\n httponly=True,\n secure=request.scheme == \"https\",\n samesite=b\"lax\"\n )\n\n\ndef session_view(view, info):\n if info.options.get(\"uses_session\"):\n # If we're using the session, then we'll just return the original view\n # with a small wrapper around it to ensure that it has a Vary: Cookie\n # header.\n return add_vary(\"Cookie\")(view)\n elif info.exception_only:\n return view\n else:\n # If we're not using the session on this view, then we'll wrap the view\n # with a wrapper that just ensures that the session cannot be used.\n @functools.wraps(view)\n def wrapped(context, request):\n # This whole method is a little bit of an odd duck, we want to make\n # sure that we don't actually *access* request.session, because\n # doing so triggers the machinery to create a new session. So\n # instead we will dig into the request object __dict__ to\n # effectively do the same thing, jsut without triggering an access\n # on request.session.\n\n # Save the original session so that we can restore it once the\n # inner views have been called.\n nothing = object()\n original_session = request.__dict__.get(\"session\", nothing)\n\n # This particular view hasn't been set to allow access to the\n # session, so we'll just assign an InvalidSession to\n # request.session\n request.__dict__[\"session\"] = InvalidSession()\n\n try:\n # Invoke the real view\n return view(context, request)\n finally:\n # Restore the original session so that things like\n # pyramid_debugtoolbar can access it.\n if original_session is nothing:\n del request.__dict__[\"session\"]\n else:\n request.__dict__[\"session\"] = original_session\n\n return wrapped\n\n\nsession_view.options = {\"uses_session\"}\n\n\ndef includeme(config):\n config.set_session_factory(\n SessionFactory(\n config.registry.settings[\"sessions.secret\"],\n config.registry.settings[\"sessions.url\"],\n ),\n )\n\n config.add_view_deriver(\n session_view,\n over=\"csrf_view\",\n under=viewderivers.INGRESS,\n )\n", "path": "warehouse/sessions.py"}]} |
gh_patches_debug_221 | rasdani/github-patches | git_diff | conda__conda-2472 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
When no condarc is found "no path!" is printed
Why was https://github.com/conda/conda/blob/master/conda/config.py#L115 added?
Is this a debug statement which never got removed?
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `conda/config.py`
Content:
```
1 # (c) 2012-2015 Continuum Analytics, Inc. / http://continuum.io
2 # All Rights Reserved
3 #
4 # conda is distributed under the terms of the BSD 3-clause license.
5 # Consult LICENSE.txt or http://opensource.org/licenses/BSD-3-Clause.
6
7 from __future__ import print_function, division, absolute_import
8
9 import logging
10 import os
11 import re
12 import sys
13 from collections import OrderedDict
14 from os.path import abspath, expanduser, isfile, isdir, join
15 from platform import machine
16
17 from conda.compat import urlparse
18 from conda.utils import try_write, memoized, yaml_load
19
20 log = logging.getLogger(__name__)
21 stderrlog = logging.getLogger('stderrlog')
22
23 default_python = '%d.%d' % sys.version_info[:2]
24 # CONDA_FORCE_32BIT should only be used when running conda-build (in order
25 # to build 32-bit packages on a 64-bit system). We don't want to mention it
26 # in the documentation, because it can mess up a lot of things.
27 force_32bit = bool(int(os.getenv('CONDA_FORCE_32BIT', 0)))
28
29 # ----- operating system and architecture -----
30
31 _sys_map = {'linux2': 'linux', 'linux': 'linux',
32 'darwin': 'osx', 'win32': 'win', 'openbsd5': 'openbsd'}
33 non_x86_linux_machines = {'armv6l', 'armv7l', 'ppc64le'}
34 platform = _sys_map.get(sys.platform, 'unknown')
35 bits = 8 * tuple.__itemsize__
36 if force_32bit:
37 bits = 32
38
39 if platform == 'linux' and machine() in non_x86_linux_machines:
40 arch_name = machine()
41 subdir = 'linux-%s' % arch_name
42 else:
43 arch_name = {64: 'x86_64', 32: 'x86'}[bits]
44 subdir = '%s-%d' % (platform, bits)
45
46 # ----- rc file -----
47
48 # This is used by conda config to check which keys are allowed in the config
49 # file. Be sure to update it when new keys are added.
50
51 #################################################################
52 # Also update the example condarc file when you add a key here! #
53 #################################################################
54
55 rc_list_keys = [
56 'channels',
57 'disallow',
58 'create_default_packages',
59 'track_features',
60 'envs_dirs',
61 'default_channels',
62 ]
63
64 DEFAULT_CHANNEL_ALIAS = 'https://conda.anaconda.org/'
65
66 ADD_BINSTAR_TOKEN = True
67
68 rc_bool_keys = [
69 'add_binstar_token',
70 'add_anaconda_token',
71 'add_pip_as_python_dependency',
72 'always_yes',
73 'always_copy',
74 'allow_softlinks',
75 'changeps1',
76 'use_pip',
77 'offline',
78 'binstar_upload',
79 'anaconda_upload',
80 'show_channel_urls',
81 'allow_other_channels',
82 'update_dependencies',
83 'channel_priority',
84 ]
85
86 rc_string_keys = [
87 'ssl_verify',
88 'channel_alias',
89 'root_dir',
90 ]
91
92 # Not supported by conda config yet
93 rc_other = [
94 'proxy_servers',
95 ]
96
97 user_rc_path = abspath(expanduser('~/.condarc'))
98 sys_rc_path = join(sys.prefix, '.condarc')
99 local_channel = []
100
101 def get_rc_path():
102 path = os.getenv('CONDARC')
103 if path == ' ':
104 return None
105 if path:
106 return path
107 for path in user_rc_path, sys_rc_path:
108 if isfile(path):
109 return path
110 return None
111
112 rc_path = get_rc_path()
113
114 def load_condarc(path):
115 if not path or not isfile(path):
116 print("no path!")
117 return {}
118 with open(path) as f:
119 return yaml_load(f) or {}
120
121 rc = load_condarc(rc_path)
122 sys_rc = load_condarc(sys_rc_path) if isfile(sys_rc_path) else {}
123
124 # ----- local directories -----
125
126 # root_dir should only be used for testing, which is why don't mention it in
127 # the documentation, to avoid confusion (it can really mess up a lot of
128 # things)
129 root_dir = abspath(expanduser(os.getenv('CONDA_ROOT',
130 rc.get('root_dir', sys.prefix))))
131 root_writable = try_write(root_dir)
132 root_env_name = 'root'
133
134 def _default_envs_dirs():
135 lst = [join(root_dir, 'envs')]
136 if not root_writable:
137 # ~/envs for backwards compatibility
138 lst = ['~/.conda/envs', '~/envs'] + lst
139 return lst
140
141 def _pathsep_env(name):
142 x = os.getenv(name)
143 if x is None:
144 return []
145 res = []
146 for path in x.split(os.pathsep):
147 if path == 'DEFAULTS':
148 for p in rc.get('envs_dirs') or _default_envs_dirs():
149 res.append(p)
150 else:
151 res.append(path)
152 return res
153
154 envs_dirs = [abspath(expanduser(path)) for path in (
155 _pathsep_env('CONDA_ENVS_PATH') or
156 rc.get('envs_dirs') or
157 _default_envs_dirs()
158 )]
159
160 def pkgs_dir_from_envs_dir(envs_dir):
161 if abspath(envs_dir) == abspath(join(root_dir, 'envs')):
162 return join(root_dir, 'pkgs32' if force_32bit else 'pkgs')
163 else:
164 return join(envs_dir, '.pkgs')
165
166 pkgs_dirs = [pkgs_dir_from_envs_dir(envs_dir) for envs_dir in envs_dirs]
167
168 # ----- default environment prefix -----
169
170 _default_env = os.getenv('CONDA_DEFAULT_ENV')
171 if _default_env in (None, root_env_name):
172 default_prefix = root_dir
173 elif os.sep in _default_env:
174 default_prefix = abspath(_default_env)
175 else:
176 for envs_dir in envs_dirs:
177 default_prefix = join(envs_dir, _default_env)
178 if isdir(default_prefix):
179 break
180 else:
181 default_prefix = join(envs_dirs[0], _default_env)
182
183 # ----- channels -----
184
185 # Note, get_*_urls() return unnormalized urls.
186
187 def get_local_urls(clear_cache=True):
188 # remove the cache such that a refetch is made,
189 # this is necessary because we add the local build repo URL
190 if clear_cache:
191 from conda.fetch import fetch_index
192 fetch_index.cache = {}
193 if local_channel:
194 return local_channel
195 from os.path import exists
196 from conda.utils import url_path
197 try:
198 from conda_build.config import croot
199 if exists(croot):
200 local_channel.append(url_path(croot))
201 except ImportError:
202 pass
203 return local_channel
204
205 def get_default_urls():
206 if isfile(sys_rc_path):
207 sys_rc = load_condarc(sys_rc_path)
208 if 'default_channels' in sys_rc:
209 return sys_rc['default_channels']
210
211 return ['https://repo.continuum.io/pkgs/free',
212 'https://repo.continuum.io/pkgs/pro']
213
214 def get_rc_urls():
215 if rc.get('channels') is None:
216 return []
217 if 'system' in rc['channels']:
218 raise RuntimeError("system cannot be used in .condarc")
219 return rc['channels']
220
221 def is_url(url):
222 return urlparse.urlparse(url).scheme != ""
223
224 @memoized
225 def binstar_channel_alias(channel_alias):
226 if rc.get('add_anaconda_token',
227 rc.get('add_binstar_token', ADD_BINSTAR_TOKEN)):
228 try:
229 from binstar_client.utils import get_binstar
230 bs = get_binstar()
231 channel_alias = bs.domain.replace("api", "conda")
232 if not channel_alias.endswith('/'):
233 channel_alias += '/'
234 if bs.token:
235 channel_alias += 't/%s/' % bs.token
236 except ImportError:
237 log.debug("Could not import binstar")
238 pass
239 except Exception as e:
240 stderrlog.info("Warning: could not import binstar_client (%s)" % e)
241 return channel_alias
242
243 channel_alias = rc.get('channel_alias', DEFAULT_CHANNEL_ALIAS)
244 if not sys_rc.get('allow_other_channels', True) and 'channel_alias' in sys_rc:
245 channel_alias = sys_rc['channel_alias']
246
247 _binstar = r'((:?%s|binstar\.org|anaconda\.org)/?)(t/[0-9a-zA-Z\-<>]{4,})/'
248 BINSTAR_TOKEN_PAT = re.compile(_binstar % re.escape(channel_alias))
249
250 def hide_binstar_tokens(url):
251 return BINSTAR_TOKEN_PAT.sub(r'\1t/<TOKEN>/', url)
252
253 def remove_binstar_tokens(url):
254 return BINSTAR_TOKEN_PAT.sub(r'\1', url)
255
256 channel_alias = remove_binstar_tokens(channel_alias.rstrip('/') + '/')
257
258 def normalize_urls(urls, platform=None, offline_only=False):
259 platform = platform or subdir
260 defaults = tuple(x.rstrip('/') + '/' for x in get_default_urls())
261 alias = binstar_channel_alias(channel_alias)
262
263 def normalize_(url):
264 url = url.rstrip('/')
265 if is_url(url):
266 url_s = canonical_channel_name(url, True)
267 else:
268 url_s = url
269 url = alias + url
270 return url_s, url
271 newurls = OrderedDict()
272 priority = 0
273 while urls:
274 url = urls[0]
275 urls = urls[1:]
276 if url == "system" and rc_path:
277 urls = get_rc_urls() + urls
278 continue
279 elif url in ("defaults", "system"):
280 t_urls = defaults
281 elif url == "local":
282 t_urls = get_local_urls()
283 else:
284 t_urls = [url]
285 priority += 1
286 for url0 in t_urls:
287 url_s, url0 = normalize_(url0)
288 if offline_only and not url0.startswith('file:'):
289 continue
290 for plat in (platform, 'noarch'):
291 newurls.setdefault('%s/%s/' % (url0, plat), (url_s, priority))
292 return newurls
293
294 offline = bool(rc.get('offline', False))
295
296 def get_channel_urls(platform=None, offline=False):
297 if os.getenv('CIO_TEST'):
298 import cio_test
299 base_urls = cio_test.base_urls
300 elif 'channels' in rc:
301 base_urls = ['system']
302 else:
303 base_urls = ['defaults']
304 res = normalize_urls(base_urls, platform, offline)
305 return res
306
307 def canonical_channel_name(channel, hide=True, no_unknown=False):
308 if channel is None:
309 return 'defaults' if no_unknown else '<unknown>'
310 channel = remove_binstar_tokens(channel).rstrip('/')
311 if any(channel.startswith(i) for i in get_default_urls()):
312 return 'defaults'
313 elif any(channel.startswith(i) for i in get_local_urls(clear_cache=False)):
314 return 'local'
315 elif channel.startswith('http://filer/'):
316 return 'filer'
317 elif channel.startswith(channel_alias):
318 return channel.split(channel_alias, 1)[1]
319 elif channel.startswith('http:/'):
320 channel2 = 'https' + channel[4:]
321 channel3 = canonical_channel_name(channel2, hide, no_unknown)
322 return channel3 if channel3 != channel2 else channel
323 else:
324 return channel
325
326 def url_channel(url):
327 if url is None:
328 return None, '<unknown>'
329 channel = url.rsplit('/', 2)[0]
330 schannel = canonical_channel_name(channel)
331 return channel, schannel
332
333 # ----- allowed channels -----
334
335 def get_allowed_channels():
336 if not isfile(sys_rc_path):
337 return None
338 if sys_rc.get('allow_other_channels', True):
339 return None
340 if 'channels' in sys_rc:
341 base_urls = ['system']
342 else:
343 base_urls = ['default']
344 return normalize_urls(base_urls)
345
346 allowed_channels = get_allowed_channels()
347
348 # ----- proxy -----
349
350 def get_proxy_servers():
351 res = rc.get('proxy_servers') or {}
352 if isinstance(res, dict):
353 return res
354 sys.exit("Error: proxy_servers setting not a mapping")
355
356 # ----- foreign -----
357
358 try:
359 with open(join(root_dir, 'conda-meta', 'foreign')) as fi:
360 foreign = fi.read().split()
361 except IOError:
362 foreign = [] if isdir(join(root_dir, 'conda-meta')) else ['python']
363
364 # ----- misc -----
365
366 add_pip_as_python_dependency = bool(rc.get('add_pip_as_python_dependency', True))
367 always_yes = bool(rc.get('always_yes', False))
368 always_copy = bool(rc.get('always_copy', False))
369 changeps1 = bool(rc.get('changeps1', True))
370 use_pip = bool(rc.get('use_pip', True))
371 binstar_upload = rc.get('anaconda_upload',
372 rc.get('binstar_upload', None)) # None means ask
373 allow_softlinks = bool(rc.get('allow_softlinks', True))
374 self_update = bool(rc.get('self_update', True))
375 # show channel URLs when displaying what is going to be downloaded
376 show_channel_urls = rc.get('show_channel_urls', None) # None means letting conda decide
377 # set packages disallowed to be installed
378 disallow = set(rc.get('disallow', []))
379 # packages which are added to a newly created environment by default
380 create_default_packages = list(rc.get('create_default_packages', []))
381 update_dependencies = bool(rc.get('update_dependencies', True))
382 channel_priority = bool(rc.get('channel_priority', True))
383
384 # ssl_verify can be a boolean value or a filename string
385 ssl_verify = rc.get('ssl_verify', True)
386
387 try:
388 track_features = set(rc['track_features'])
389 except KeyError:
390 track_features = None
391
```
--- 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/conda/config.py b/conda/config.py
--- a/conda/config.py
+++ b/conda/config.py
@@ -113,7 +113,6 @@
def load_condarc(path):
if not path or not isfile(path):
- print("no path!")
return {}
with open(path) as f:
return yaml_load(f) or {}
| {"golden_diff": "diff --git a/conda/config.py b/conda/config.py\n--- a/conda/config.py\n+++ b/conda/config.py\n@@ -113,7 +113,6 @@\n \n def load_condarc(path):\n if not path or not isfile(path):\n- print(\"no path!\")\n return {}\n with open(path) as f:\n return yaml_load(f) or {}\n", "issue": "When no condarc is found \"no path!\" is printed\nWhy was https://github.com/conda/conda/blob/master/conda/config.py#L115 added?\nIs this a debug statement which never got removed?\n\n", "before_files": [{"content": "# (c) 2012-2015 Continuum Analytics, Inc. / http://continuum.io\n# All Rights Reserved\n#\n# conda is distributed under the terms of the BSD 3-clause license.\n# Consult LICENSE.txt or http://opensource.org/licenses/BSD-3-Clause.\n\nfrom __future__ import print_function, division, absolute_import\n\nimport logging\nimport os\nimport re\nimport sys\nfrom collections import OrderedDict\nfrom os.path import abspath, expanduser, isfile, isdir, join\nfrom platform import machine\n\nfrom conda.compat import urlparse\nfrom conda.utils import try_write, memoized, yaml_load\n\nlog = logging.getLogger(__name__)\nstderrlog = logging.getLogger('stderrlog')\n\ndefault_python = '%d.%d' % sys.version_info[:2]\n# CONDA_FORCE_32BIT should only be used when running conda-build (in order\n# to build 32-bit packages on a 64-bit system). We don't want to mention it\n# in the documentation, because it can mess up a lot of things.\nforce_32bit = bool(int(os.getenv('CONDA_FORCE_32BIT', 0)))\n\n# ----- operating system and architecture -----\n\n_sys_map = {'linux2': 'linux', 'linux': 'linux',\n 'darwin': 'osx', 'win32': 'win', 'openbsd5': 'openbsd'}\nnon_x86_linux_machines = {'armv6l', 'armv7l', 'ppc64le'}\nplatform = _sys_map.get(sys.platform, 'unknown')\nbits = 8 * tuple.__itemsize__\nif force_32bit:\n bits = 32\n\nif platform == 'linux' and machine() in non_x86_linux_machines:\n arch_name = machine()\n subdir = 'linux-%s' % arch_name\nelse:\n arch_name = {64: 'x86_64', 32: 'x86'}[bits]\n subdir = '%s-%d' % (platform, bits)\n\n# ----- rc file -----\n\n# This is used by conda config to check which keys are allowed in the config\n# file. Be sure to update it when new keys are added.\n\n#################################################################\n# Also update the example condarc file when you add a key here! #\n#################################################################\n\nrc_list_keys = [\n 'channels',\n 'disallow',\n 'create_default_packages',\n 'track_features',\n 'envs_dirs',\n 'default_channels',\n]\n\nDEFAULT_CHANNEL_ALIAS = 'https://conda.anaconda.org/'\n\nADD_BINSTAR_TOKEN = True\n\nrc_bool_keys = [\n 'add_binstar_token',\n 'add_anaconda_token',\n 'add_pip_as_python_dependency',\n 'always_yes',\n 'always_copy',\n 'allow_softlinks',\n 'changeps1',\n 'use_pip',\n 'offline',\n 'binstar_upload',\n 'anaconda_upload',\n 'show_channel_urls',\n 'allow_other_channels',\n 'update_dependencies',\n 'channel_priority',\n]\n\nrc_string_keys = [\n 'ssl_verify',\n 'channel_alias',\n 'root_dir',\n]\n\n# Not supported by conda config yet\nrc_other = [\n 'proxy_servers',\n]\n\nuser_rc_path = abspath(expanduser('~/.condarc'))\nsys_rc_path = join(sys.prefix, '.condarc')\nlocal_channel = []\n\ndef get_rc_path():\n path = os.getenv('CONDARC')\n if path == ' ':\n return None\n if path:\n return path\n for path in user_rc_path, sys_rc_path:\n if isfile(path):\n return path\n return None\n\nrc_path = get_rc_path()\n\ndef load_condarc(path):\n if not path or not isfile(path):\n print(\"no path!\")\n return {}\n with open(path) as f:\n return yaml_load(f) or {}\n\nrc = load_condarc(rc_path)\nsys_rc = load_condarc(sys_rc_path) if isfile(sys_rc_path) else {}\n\n# ----- local directories -----\n\n# root_dir should only be used for testing, which is why don't mention it in\n# the documentation, to avoid confusion (it can really mess up a lot of\n# things)\nroot_dir = abspath(expanduser(os.getenv('CONDA_ROOT',\n rc.get('root_dir', sys.prefix))))\nroot_writable = try_write(root_dir)\nroot_env_name = 'root'\n\ndef _default_envs_dirs():\n lst = [join(root_dir, 'envs')]\n if not root_writable:\n # ~/envs for backwards compatibility\n lst = ['~/.conda/envs', '~/envs'] + lst\n return lst\n\ndef _pathsep_env(name):\n x = os.getenv(name)\n if x is None:\n return []\n res = []\n for path in x.split(os.pathsep):\n if path == 'DEFAULTS':\n for p in rc.get('envs_dirs') or _default_envs_dirs():\n res.append(p)\n else:\n res.append(path)\n return res\n\nenvs_dirs = [abspath(expanduser(path)) for path in (\n _pathsep_env('CONDA_ENVS_PATH') or\n rc.get('envs_dirs') or\n _default_envs_dirs()\n )]\n\ndef pkgs_dir_from_envs_dir(envs_dir):\n if abspath(envs_dir) == abspath(join(root_dir, 'envs')):\n return join(root_dir, 'pkgs32' if force_32bit else 'pkgs')\n else:\n return join(envs_dir, '.pkgs')\n\npkgs_dirs = [pkgs_dir_from_envs_dir(envs_dir) for envs_dir in envs_dirs]\n\n# ----- default environment prefix -----\n\n_default_env = os.getenv('CONDA_DEFAULT_ENV')\nif _default_env in (None, root_env_name):\n default_prefix = root_dir\nelif os.sep in _default_env:\n default_prefix = abspath(_default_env)\nelse:\n for envs_dir in envs_dirs:\n default_prefix = join(envs_dir, _default_env)\n if isdir(default_prefix):\n break\n else:\n default_prefix = join(envs_dirs[0], _default_env)\n\n# ----- channels -----\n\n# Note, get_*_urls() return unnormalized urls.\n\ndef get_local_urls(clear_cache=True):\n # remove the cache such that a refetch is made,\n # this is necessary because we add the local build repo URL\n if clear_cache:\n from conda.fetch import fetch_index\n fetch_index.cache = {}\n if local_channel:\n return local_channel\n from os.path import exists\n from conda.utils import url_path\n try:\n from conda_build.config import croot\n if exists(croot):\n local_channel.append(url_path(croot))\n except ImportError:\n pass\n return local_channel\n\ndef get_default_urls():\n if isfile(sys_rc_path):\n sys_rc = load_condarc(sys_rc_path)\n if 'default_channels' in sys_rc:\n return sys_rc['default_channels']\n\n return ['https://repo.continuum.io/pkgs/free',\n 'https://repo.continuum.io/pkgs/pro']\n\ndef get_rc_urls():\n if rc.get('channels') is None:\n return []\n if 'system' in rc['channels']:\n raise RuntimeError(\"system cannot be used in .condarc\")\n return rc['channels']\n\ndef is_url(url):\n return urlparse.urlparse(url).scheme != \"\"\n\n@memoized\ndef binstar_channel_alias(channel_alias):\n if rc.get('add_anaconda_token',\n rc.get('add_binstar_token', ADD_BINSTAR_TOKEN)):\n try:\n from binstar_client.utils import get_binstar\n bs = get_binstar()\n channel_alias = bs.domain.replace(\"api\", \"conda\")\n if not channel_alias.endswith('/'):\n channel_alias += '/'\n if bs.token:\n channel_alias += 't/%s/' % bs.token\n except ImportError:\n log.debug(\"Could not import binstar\")\n pass\n except Exception as e:\n stderrlog.info(\"Warning: could not import binstar_client (%s)\" % e)\n return channel_alias\n\nchannel_alias = rc.get('channel_alias', DEFAULT_CHANNEL_ALIAS)\nif not sys_rc.get('allow_other_channels', True) and 'channel_alias' in sys_rc:\n channel_alias = sys_rc['channel_alias']\n\n_binstar = r'((:?%s|binstar\\.org|anaconda\\.org)/?)(t/[0-9a-zA-Z\\-<>]{4,})/'\nBINSTAR_TOKEN_PAT = re.compile(_binstar % re.escape(channel_alias))\n\ndef hide_binstar_tokens(url):\n return BINSTAR_TOKEN_PAT.sub(r'\\1t/<TOKEN>/', url)\n\ndef remove_binstar_tokens(url):\n return BINSTAR_TOKEN_PAT.sub(r'\\1', url)\n\nchannel_alias = remove_binstar_tokens(channel_alias.rstrip('/') + '/')\n\ndef normalize_urls(urls, platform=None, offline_only=False):\n platform = platform or subdir\n defaults = tuple(x.rstrip('/') + '/' for x in get_default_urls())\n alias = binstar_channel_alias(channel_alias)\n\n def normalize_(url):\n url = url.rstrip('/')\n if is_url(url):\n url_s = canonical_channel_name(url, True)\n else:\n url_s = url\n url = alias + url\n return url_s, url\n newurls = OrderedDict()\n priority = 0\n while urls:\n url = urls[0]\n urls = urls[1:]\n if url == \"system\" and rc_path:\n urls = get_rc_urls() + urls\n continue\n elif url in (\"defaults\", \"system\"):\n t_urls = defaults\n elif url == \"local\":\n t_urls = get_local_urls()\n else:\n t_urls = [url]\n priority += 1\n for url0 in t_urls:\n url_s, url0 = normalize_(url0)\n if offline_only and not url0.startswith('file:'):\n continue\n for plat in (platform, 'noarch'):\n newurls.setdefault('%s/%s/' % (url0, plat), (url_s, priority))\n return newurls\n\noffline = bool(rc.get('offline', False))\n\ndef get_channel_urls(platform=None, offline=False):\n if os.getenv('CIO_TEST'):\n import cio_test\n base_urls = cio_test.base_urls\n elif 'channels' in rc:\n base_urls = ['system']\n else:\n base_urls = ['defaults']\n res = normalize_urls(base_urls, platform, offline)\n return res\n\ndef canonical_channel_name(channel, hide=True, no_unknown=False):\n if channel is None:\n return 'defaults' if no_unknown else '<unknown>'\n channel = remove_binstar_tokens(channel).rstrip('/')\n if any(channel.startswith(i) for i in get_default_urls()):\n return 'defaults'\n elif any(channel.startswith(i) for i in get_local_urls(clear_cache=False)):\n return 'local'\n elif channel.startswith('http://filer/'):\n return 'filer'\n elif channel.startswith(channel_alias):\n return channel.split(channel_alias, 1)[1]\n elif channel.startswith('http:/'):\n channel2 = 'https' + channel[4:]\n channel3 = canonical_channel_name(channel2, hide, no_unknown)\n return channel3 if channel3 != channel2 else channel\n else:\n return channel\n\ndef url_channel(url):\n if url is None:\n return None, '<unknown>'\n channel = url.rsplit('/', 2)[0]\n schannel = canonical_channel_name(channel)\n return channel, schannel\n\n# ----- allowed channels -----\n\ndef get_allowed_channels():\n if not isfile(sys_rc_path):\n return None\n if sys_rc.get('allow_other_channels', True):\n return None\n if 'channels' in sys_rc:\n base_urls = ['system']\n else:\n base_urls = ['default']\n return normalize_urls(base_urls)\n\nallowed_channels = get_allowed_channels()\n\n# ----- proxy -----\n\ndef get_proxy_servers():\n res = rc.get('proxy_servers') or {}\n if isinstance(res, dict):\n return res\n sys.exit(\"Error: proxy_servers setting not a mapping\")\n\n# ----- foreign -----\n\ntry:\n with open(join(root_dir, 'conda-meta', 'foreign')) as fi:\n foreign = fi.read().split()\nexcept IOError:\n foreign = [] if isdir(join(root_dir, 'conda-meta')) else ['python']\n\n# ----- misc -----\n\nadd_pip_as_python_dependency = bool(rc.get('add_pip_as_python_dependency', True))\nalways_yes = bool(rc.get('always_yes', False))\nalways_copy = bool(rc.get('always_copy', False))\nchangeps1 = bool(rc.get('changeps1', True))\nuse_pip = bool(rc.get('use_pip', True))\nbinstar_upload = rc.get('anaconda_upload',\n rc.get('binstar_upload', None)) # None means ask\nallow_softlinks = bool(rc.get('allow_softlinks', True))\nself_update = bool(rc.get('self_update', True))\n# show channel URLs when displaying what is going to be downloaded\nshow_channel_urls = rc.get('show_channel_urls', None) # None means letting conda decide\n# set packages disallowed to be installed\ndisallow = set(rc.get('disallow', []))\n# packages which are added to a newly created environment by default\ncreate_default_packages = list(rc.get('create_default_packages', []))\nupdate_dependencies = bool(rc.get('update_dependencies', True))\nchannel_priority = bool(rc.get('channel_priority', True))\n\n# ssl_verify can be a boolean value or a filename string\nssl_verify = rc.get('ssl_verify', True)\n\ntry:\n track_features = set(rc['track_features'])\nexcept KeyError:\n track_features = None\n", "path": "conda/config.py"}], "after_files": [{"content": "# (c) 2012-2015 Continuum Analytics, Inc. / http://continuum.io\n# All Rights Reserved\n#\n# conda is distributed under the terms of the BSD 3-clause license.\n# Consult LICENSE.txt or http://opensource.org/licenses/BSD-3-Clause.\n\nfrom __future__ import print_function, division, absolute_import\n\nimport logging\nimport os\nimport re\nimport sys\nfrom collections import OrderedDict\nfrom os.path import abspath, expanduser, isfile, isdir, join\nfrom platform import machine\n\nfrom conda.compat import urlparse\nfrom conda.utils import try_write, memoized, yaml_load\n\nlog = logging.getLogger(__name__)\nstderrlog = logging.getLogger('stderrlog')\n\ndefault_python = '%d.%d' % sys.version_info[:2]\n# CONDA_FORCE_32BIT should only be used when running conda-build (in order\n# to build 32-bit packages on a 64-bit system). We don't want to mention it\n# in the documentation, because it can mess up a lot of things.\nforce_32bit = bool(int(os.getenv('CONDA_FORCE_32BIT', 0)))\n\n# ----- operating system and architecture -----\n\n_sys_map = {'linux2': 'linux', 'linux': 'linux',\n 'darwin': 'osx', 'win32': 'win', 'openbsd5': 'openbsd'}\nnon_x86_linux_machines = {'armv6l', 'armv7l', 'ppc64le'}\nplatform = _sys_map.get(sys.platform, 'unknown')\nbits = 8 * tuple.__itemsize__\nif force_32bit:\n bits = 32\n\nif platform == 'linux' and machine() in non_x86_linux_machines:\n arch_name = machine()\n subdir = 'linux-%s' % arch_name\nelse:\n arch_name = {64: 'x86_64', 32: 'x86'}[bits]\n subdir = '%s-%d' % (platform, bits)\n\n# ----- rc file -----\n\n# This is used by conda config to check which keys are allowed in the config\n# file. Be sure to update it when new keys are added.\n\n#################################################################\n# Also update the example condarc file when you add a key here! #\n#################################################################\n\nrc_list_keys = [\n 'channels',\n 'disallow',\n 'create_default_packages',\n 'track_features',\n 'envs_dirs',\n 'default_channels',\n]\n\nDEFAULT_CHANNEL_ALIAS = 'https://conda.anaconda.org/'\n\nADD_BINSTAR_TOKEN = True\n\nrc_bool_keys = [\n 'add_binstar_token',\n 'add_anaconda_token',\n 'add_pip_as_python_dependency',\n 'always_yes',\n 'always_copy',\n 'allow_softlinks',\n 'changeps1',\n 'use_pip',\n 'offline',\n 'binstar_upload',\n 'anaconda_upload',\n 'show_channel_urls',\n 'allow_other_channels',\n 'update_dependencies',\n 'channel_priority',\n]\n\nrc_string_keys = [\n 'ssl_verify',\n 'channel_alias',\n 'root_dir',\n]\n\n# Not supported by conda config yet\nrc_other = [\n 'proxy_servers',\n]\n\nuser_rc_path = abspath(expanduser('~/.condarc'))\nsys_rc_path = join(sys.prefix, '.condarc')\nlocal_channel = []\n\ndef get_rc_path():\n path = os.getenv('CONDARC')\n if path == ' ':\n return None\n if path:\n return path\n for path in user_rc_path, sys_rc_path:\n if isfile(path):\n return path\n return None\n\nrc_path = get_rc_path()\n\ndef load_condarc(path):\n if not path or not isfile(path):\n return {}\n with open(path) as f:\n return yaml_load(f) or {}\n\nrc = load_condarc(rc_path)\nsys_rc = load_condarc(sys_rc_path) if isfile(sys_rc_path) else {}\n\n# ----- local directories -----\n\n# root_dir should only be used for testing, which is why don't mention it in\n# the documentation, to avoid confusion (it can really mess up a lot of\n# things)\nroot_dir = abspath(expanduser(os.getenv('CONDA_ROOT',\n rc.get('root_dir', sys.prefix))))\nroot_writable = try_write(root_dir)\nroot_env_name = 'root'\n\ndef _default_envs_dirs():\n lst = [join(root_dir, 'envs')]\n if not root_writable:\n # ~/envs for backwards compatibility\n lst = ['~/.conda/envs', '~/envs'] + lst\n return lst\n\ndef _pathsep_env(name):\n x = os.getenv(name)\n if x is None:\n return []\n res = []\n for path in x.split(os.pathsep):\n if path == 'DEFAULTS':\n for p in rc.get('envs_dirs') or _default_envs_dirs():\n res.append(p)\n else:\n res.append(path)\n return res\n\nenvs_dirs = [abspath(expanduser(path)) for path in (\n _pathsep_env('CONDA_ENVS_PATH') or\n rc.get('envs_dirs') or\n _default_envs_dirs()\n )]\n\ndef pkgs_dir_from_envs_dir(envs_dir):\n if abspath(envs_dir) == abspath(join(root_dir, 'envs')):\n return join(root_dir, 'pkgs32' if force_32bit else 'pkgs')\n else:\n return join(envs_dir, '.pkgs')\n\npkgs_dirs = [pkgs_dir_from_envs_dir(envs_dir) for envs_dir in envs_dirs]\n\n# ----- default environment prefix -----\n\n_default_env = os.getenv('CONDA_DEFAULT_ENV')\nif _default_env in (None, root_env_name):\n default_prefix = root_dir\nelif os.sep in _default_env:\n default_prefix = abspath(_default_env)\nelse:\n for envs_dir in envs_dirs:\n default_prefix = join(envs_dir, _default_env)\n if isdir(default_prefix):\n break\n else:\n default_prefix = join(envs_dirs[0], _default_env)\n\n# ----- channels -----\n\n# Note, get_*_urls() return unnormalized urls.\n\ndef get_local_urls(clear_cache=True):\n # remove the cache such that a refetch is made,\n # this is necessary because we add the local build repo URL\n if clear_cache:\n from conda.fetch import fetch_index\n fetch_index.cache = {}\n if local_channel:\n return local_channel\n from os.path import exists\n from conda.utils import url_path\n try:\n from conda_build.config import croot\n if exists(croot):\n local_channel.append(url_path(croot))\n except ImportError:\n pass\n return local_channel\n\ndef get_default_urls():\n if isfile(sys_rc_path):\n sys_rc = load_condarc(sys_rc_path)\n if 'default_channels' in sys_rc:\n return sys_rc['default_channels']\n\n return ['https://repo.continuum.io/pkgs/free',\n 'https://repo.continuum.io/pkgs/pro']\n\ndef get_rc_urls():\n if rc.get('channels') is None:\n return []\n if 'system' in rc['channels']:\n raise RuntimeError(\"system cannot be used in .condarc\")\n return rc['channels']\n\ndef is_url(url):\n return urlparse.urlparse(url).scheme != \"\"\n\n@memoized\ndef binstar_channel_alias(channel_alias):\n if rc.get('add_anaconda_token',\n rc.get('add_binstar_token', ADD_BINSTAR_TOKEN)):\n try:\n from binstar_client.utils import get_binstar\n bs = get_binstar()\n channel_alias = bs.domain.replace(\"api\", \"conda\")\n if not channel_alias.endswith('/'):\n channel_alias += '/'\n if bs.token:\n channel_alias += 't/%s/' % bs.token\n except ImportError:\n log.debug(\"Could not import binstar\")\n pass\n except Exception as e:\n stderrlog.info(\"Warning: could not import binstar_client (%s)\" % e)\n return channel_alias\n\nchannel_alias = rc.get('channel_alias', DEFAULT_CHANNEL_ALIAS)\nif not sys_rc.get('allow_other_channels', True) and 'channel_alias' in sys_rc:\n channel_alias = sys_rc['channel_alias']\n\n_binstar = r'((:?%s|binstar\\.org|anaconda\\.org)/?)(t/[0-9a-zA-Z\\-<>]{4,})/'\nBINSTAR_TOKEN_PAT = re.compile(_binstar % re.escape(channel_alias))\n\ndef hide_binstar_tokens(url):\n return BINSTAR_TOKEN_PAT.sub(r'\\1t/<TOKEN>/', url)\n\ndef remove_binstar_tokens(url):\n return BINSTAR_TOKEN_PAT.sub(r'\\1', url)\n\nchannel_alias = remove_binstar_tokens(channel_alias.rstrip('/') + '/')\n\ndef normalize_urls(urls, platform=None, offline_only=False):\n platform = platform or subdir\n defaults = tuple(x.rstrip('/') + '/' for x in get_default_urls())\n alias = binstar_channel_alias(channel_alias)\n\n def normalize_(url):\n url = url.rstrip('/')\n if is_url(url):\n url_s = canonical_channel_name(url, True)\n else:\n url_s = url\n url = alias + url\n return url_s, url\n newurls = OrderedDict()\n priority = 0\n while urls:\n url = urls[0]\n urls = urls[1:]\n if url == \"system\" and rc_path:\n urls = get_rc_urls() + urls\n continue\n elif url in (\"defaults\", \"system\"):\n t_urls = defaults\n elif url == \"local\":\n t_urls = get_local_urls()\n else:\n t_urls = [url]\n priority += 1\n for url0 in t_urls:\n url_s, url0 = normalize_(url0)\n if offline_only and not url0.startswith('file:'):\n continue\n for plat in (platform, 'noarch'):\n newurls.setdefault('%s/%s/' % (url0, plat), (url_s, priority))\n return newurls\n\noffline = bool(rc.get('offline', False))\n\ndef get_channel_urls(platform=None, offline=False):\n if os.getenv('CIO_TEST'):\n import cio_test\n base_urls = cio_test.base_urls\n elif 'channels' in rc:\n base_urls = ['system']\n else:\n base_urls = ['defaults']\n res = normalize_urls(base_urls, platform, offline)\n return res\n\ndef canonical_channel_name(channel, hide=True, no_unknown=False):\n if channel is None:\n return 'defaults' if no_unknown else '<unknown>'\n channel = remove_binstar_tokens(channel).rstrip('/')\n if any(channel.startswith(i) for i in get_default_urls()):\n return 'defaults'\n elif any(channel.startswith(i) for i in get_local_urls(clear_cache=False)):\n return 'local'\n elif channel.startswith('http://filer/'):\n return 'filer'\n elif channel.startswith(channel_alias):\n return channel.split(channel_alias, 1)[1]\n elif channel.startswith('http:/'):\n channel2 = 'https' + channel[4:]\n channel3 = canonical_channel_name(channel2, hide, no_unknown)\n return channel3 if channel3 != channel2 else channel\n else:\n return channel\n\ndef url_channel(url):\n if url is None:\n return None, '<unknown>'\n channel = url.rsplit('/', 2)[0]\n schannel = canonical_channel_name(channel)\n return channel, schannel\n\n# ----- allowed channels -----\n\ndef get_allowed_channels():\n if not isfile(sys_rc_path):\n return None\n if sys_rc.get('allow_other_channels', True):\n return None\n if 'channels' in sys_rc:\n base_urls = ['system']\n else:\n base_urls = ['default']\n return normalize_urls(base_urls)\n\nallowed_channels = get_allowed_channels()\n\n# ----- proxy -----\n\ndef get_proxy_servers():\n res = rc.get('proxy_servers') or {}\n if isinstance(res, dict):\n return res\n sys.exit(\"Error: proxy_servers setting not a mapping\")\n\n# ----- foreign -----\n\ntry:\n with open(join(root_dir, 'conda-meta', 'foreign')) as fi:\n foreign = fi.read().split()\nexcept IOError:\n foreign = [] if isdir(join(root_dir, 'conda-meta')) else ['python']\n\n# ----- misc -----\n\nadd_pip_as_python_dependency = bool(rc.get('add_pip_as_python_dependency', True))\nalways_yes = bool(rc.get('always_yes', False))\nalways_copy = bool(rc.get('always_copy', False))\nchangeps1 = bool(rc.get('changeps1', True))\nuse_pip = bool(rc.get('use_pip', True))\nbinstar_upload = rc.get('anaconda_upload',\n rc.get('binstar_upload', None)) # None means ask\nallow_softlinks = bool(rc.get('allow_softlinks', True))\nself_update = bool(rc.get('self_update', True))\n# show channel URLs when displaying what is going to be downloaded\nshow_channel_urls = rc.get('show_channel_urls', None) # None means letting conda decide\n# set packages disallowed to be installed\ndisallow = set(rc.get('disallow', []))\n# packages which are added to a newly created environment by default\ncreate_default_packages = list(rc.get('create_default_packages', []))\nupdate_dependencies = bool(rc.get('update_dependencies', True))\nchannel_priority = bool(rc.get('channel_priority', True))\n\n# ssl_verify can be a boolean value or a filename string\nssl_verify = rc.get('ssl_verify', True)\n\ntry:\n track_features = set(rc['track_features'])\nexcept KeyError:\n track_features = None\n", "path": "conda/config.py"}]} |
gh_patches_debug_222 | rasdani/github-patches | git_diff | urllib3__urllib3-1028 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Add unit test for RECENT_DATE
I've got a feeling this value could be easily forgotten to be updated over time. Could we perhaps add a unit test that will fail if it gets to be too far away from the current date. It seems like it was last modified in mid 2014 but wasn't updated since then, should this value be updated now?
Link to the blame: https://github.com/shazow/urllib3/blame/master/urllib3/connection.py#L59
##
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `urllib3/connection.py`
Content:
```
1 from __future__ import absolute_import
2 import datetime
3 import logging
4 import os
5 import sys
6 import socket
7 from socket import error as SocketError, timeout as SocketTimeout
8 import warnings
9 from .packages import six
10 from .packages.six.moves.http_client import HTTPConnection as _HTTPConnection
11 from .packages.six.moves.http_client import HTTPException # noqa: F401
12
13 try: # Compiled with SSL?
14 import ssl
15 BaseSSLError = ssl.SSLError
16 except (ImportError, AttributeError): # Platform-specific: No SSL.
17 ssl = None
18
19 class BaseSSLError(BaseException):
20 pass
21
22
23 try: # Python 3:
24 # Not a no-op, we're adding this to the namespace so it can be imported.
25 ConnectionError = ConnectionError
26 except NameError: # Python 2:
27 class ConnectionError(Exception):
28 pass
29
30
31 from .exceptions import (
32 NewConnectionError,
33 ConnectTimeoutError,
34 SubjectAltNameWarning,
35 SystemTimeWarning,
36 )
37 from .packages.ssl_match_hostname import match_hostname, CertificateError
38
39 from .util.ssl_ import (
40 resolve_cert_reqs,
41 resolve_ssl_version,
42 assert_fingerprint,
43 create_urllib3_context,
44 ssl_wrap_socket
45 )
46
47
48 from .util import connection
49
50 from ._collections import HTTPHeaderDict
51
52 log = logging.getLogger(__name__)
53
54 port_by_scheme = {
55 'http': 80,
56 'https': 443,
57 }
58
59 RECENT_DATE = datetime.date(2014, 1, 1)
60
61
62 class DummyConnection(object):
63 """Used to detect a failed ConnectionCls import."""
64 pass
65
66
67 class HTTPConnection(_HTTPConnection, object):
68 """
69 Based on httplib.HTTPConnection but provides an extra constructor
70 backwards-compatibility layer between older and newer Pythons.
71
72 Additional keyword parameters are used to configure attributes of the connection.
73 Accepted parameters include:
74
75 - ``strict``: See the documentation on :class:`urllib3.connectionpool.HTTPConnectionPool`
76 - ``source_address``: Set the source address for the current connection.
77
78 .. note:: This is ignored for Python 2.6. It is only applied for 2.7 and 3.x
79
80 - ``socket_options``: Set specific options on the underlying socket. If not specified, then
81 defaults are loaded from ``HTTPConnection.default_socket_options`` which includes disabling
82 Nagle's algorithm (sets TCP_NODELAY to 1) unless the connection is behind a proxy.
83
84 For example, if you wish to enable TCP Keep Alive in addition to the defaults,
85 you might pass::
86
87 HTTPConnection.default_socket_options + [
88 (socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),
89 ]
90
91 Or you may want to disable the defaults by passing an empty list (e.g., ``[]``).
92 """
93
94 default_port = port_by_scheme['http']
95
96 #: Disable Nagle's algorithm by default.
97 #: ``[(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)]``
98 default_socket_options = [(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)]
99
100 #: Whether this connection verifies the host's certificate.
101 is_verified = False
102
103 def __init__(self, *args, **kw):
104 if six.PY3: # Python 3
105 kw.pop('strict', None)
106
107 # Pre-set source_address in case we have an older Python like 2.6.
108 self.source_address = kw.get('source_address')
109
110 if sys.version_info < (2, 7): # Python 2.6
111 # _HTTPConnection on Python 2.6 will balk at this keyword arg, but
112 # not newer versions. We can still use it when creating a
113 # connection though, so we pop it *after* we have saved it as
114 # self.source_address.
115 kw.pop('source_address', None)
116
117 #: The socket options provided by the user. If no options are
118 #: provided, we use the default options.
119 self.socket_options = kw.pop('socket_options', self.default_socket_options)
120
121 # Superclass also sets self.source_address in Python 2.7+.
122 _HTTPConnection.__init__(self, *args, **kw)
123
124 def _new_conn(self):
125 """ Establish a socket connection and set nodelay settings on it.
126
127 :return: New socket connection.
128 """
129 extra_kw = {}
130 if self.source_address:
131 extra_kw['source_address'] = self.source_address
132
133 if self.socket_options:
134 extra_kw['socket_options'] = self.socket_options
135
136 try:
137 conn = connection.create_connection(
138 (self.host, self.port), self.timeout, **extra_kw)
139
140 except SocketTimeout as e:
141 raise ConnectTimeoutError(
142 self, "Connection to %s timed out. (connect timeout=%s)" %
143 (self.host, self.timeout))
144
145 except SocketError as e:
146 raise NewConnectionError(
147 self, "Failed to establish a new connection: %s" % e)
148
149 return conn
150
151 def _prepare_conn(self, conn):
152 self.sock = conn
153 # the _tunnel_host attribute was added in python 2.6.3 (via
154 # http://hg.python.org/cpython/rev/0f57b30a152f) so pythons 2.6(0-2) do
155 # not have them.
156 if getattr(self, '_tunnel_host', None):
157 # TODO: Fix tunnel so it doesn't depend on self.sock state.
158 self._tunnel()
159 # Mark this connection as not reusable
160 self.auto_open = 0
161
162 def connect(self):
163 conn = self._new_conn()
164 self._prepare_conn(conn)
165
166 def request_chunked(self, method, url, body=None, headers=None):
167 """
168 Alternative to the common request method, which sends the
169 body with chunked encoding and not as one block
170 """
171 headers = HTTPHeaderDict(headers if headers is not None else {})
172 skip_accept_encoding = 'accept-encoding' in headers
173 skip_host = 'host' in headers
174 self.putrequest(
175 method,
176 url,
177 skip_accept_encoding=skip_accept_encoding,
178 skip_host=skip_host
179 )
180 for header, value in headers.items():
181 self.putheader(header, value)
182 if 'transfer-encoding' not in headers:
183 self.putheader('Transfer-Encoding', 'chunked')
184 self.endheaders()
185
186 if body is not None:
187 stringish_types = six.string_types + (six.binary_type,)
188 if isinstance(body, stringish_types):
189 body = (body,)
190 for chunk in body:
191 if not chunk:
192 continue
193 if not isinstance(chunk, six.binary_type):
194 chunk = chunk.encode('utf8')
195 len_str = hex(len(chunk))[2:]
196 self.send(len_str.encode('utf-8'))
197 self.send(b'\r\n')
198 self.send(chunk)
199 self.send(b'\r\n')
200
201 # After the if clause, to always have a closed body
202 self.send(b'0\r\n\r\n')
203
204
205 class HTTPSConnection(HTTPConnection):
206 default_port = port_by_scheme['https']
207
208 ssl_version = None
209
210 def __init__(self, host, port=None, key_file=None, cert_file=None,
211 strict=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
212 ssl_context=None, **kw):
213
214 HTTPConnection.__init__(self, host, port, strict=strict,
215 timeout=timeout, **kw)
216
217 self.key_file = key_file
218 self.cert_file = cert_file
219 self.ssl_context = ssl_context
220
221 # Required property for Google AppEngine 1.9.0 which otherwise causes
222 # HTTPS requests to go out as HTTP. (See Issue #356)
223 self._protocol = 'https'
224
225 def connect(self):
226 conn = self._new_conn()
227 self._prepare_conn(conn)
228
229 if self.ssl_context is None:
230 self.ssl_context = create_urllib3_context(
231 ssl_version=resolve_ssl_version(None),
232 cert_reqs=resolve_cert_reqs(None),
233 )
234
235 self.sock = ssl_wrap_socket(
236 sock=conn,
237 keyfile=self.key_file,
238 certfile=self.cert_file,
239 ssl_context=self.ssl_context,
240 )
241
242
243 class VerifiedHTTPSConnection(HTTPSConnection):
244 """
245 Based on httplib.HTTPSConnection but wraps the socket with
246 SSL certification.
247 """
248 cert_reqs = None
249 ca_certs = None
250 ca_cert_dir = None
251 ssl_version = None
252 assert_fingerprint = None
253
254 def set_cert(self, key_file=None, cert_file=None,
255 cert_reqs=None, ca_certs=None,
256 assert_hostname=None, assert_fingerprint=None,
257 ca_cert_dir=None):
258 """
259 This method should only be called once, before the connection is used.
260 """
261 # If cert_reqs is not provided, we can try to guess. If the user gave
262 # us a cert database, we assume they want to use it: otherwise, if
263 # they gave us an SSL Context object we should use whatever is set for
264 # it.
265 if cert_reqs is None:
266 if ca_certs or ca_cert_dir:
267 cert_reqs = 'CERT_REQUIRED'
268 elif self.ssl_context is not None:
269 cert_reqs = self.ssl_context.verify_mode
270
271 self.key_file = key_file
272 self.cert_file = cert_file
273 self.cert_reqs = cert_reqs
274 self.assert_hostname = assert_hostname
275 self.assert_fingerprint = assert_fingerprint
276 self.ca_certs = ca_certs and os.path.expanduser(ca_certs)
277 self.ca_cert_dir = ca_cert_dir and os.path.expanduser(ca_cert_dir)
278
279 def connect(self):
280 # Add certificate verification
281 conn = self._new_conn()
282
283 hostname = self.host
284 if getattr(self, '_tunnel_host', None):
285 # _tunnel_host was added in Python 2.6.3
286 # (See: http://hg.python.org/cpython/rev/0f57b30a152f)
287
288 self.sock = conn
289 # Calls self._set_hostport(), so self.host is
290 # self._tunnel_host below.
291 self._tunnel()
292 # Mark this connection as not reusable
293 self.auto_open = 0
294
295 # Override the host with the one we're requesting data from.
296 hostname = self._tunnel_host
297
298 is_time_off = datetime.date.today() < RECENT_DATE
299 if is_time_off:
300 warnings.warn((
301 'System time is way off (before {0}). This will probably '
302 'lead to SSL verification errors').format(RECENT_DATE),
303 SystemTimeWarning
304 )
305
306 # Wrap socket using verification with the root certs in
307 # trusted_root_certs
308 if self.ssl_context is None:
309 self.ssl_context = create_urllib3_context(
310 ssl_version=resolve_ssl_version(self.ssl_version),
311 cert_reqs=resolve_cert_reqs(self.cert_reqs),
312 )
313
314 context = self.ssl_context
315 context.verify_mode = resolve_cert_reqs(self.cert_reqs)
316 self.sock = ssl_wrap_socket(
317 sock=conn,
318 keyfile=self.key_file,
319 certfile=self.cert_file,
320 ca_certs=self.ca_certs,
321 ca_cert_dir=self.ca_cert_dir,
322 server_hostname=hostname,
323 ssl_context=context)
324
325 if self.assert_fingerprint:
326 assert_fingerprint(self.sock.getpeercert(binary_form=True),
327 self.assert_fingerprint)
328 elif context.verify_mode != ssl.CERT_NONE \
329 and self.assert_hostname is not False:
330 cert = self.sock.getpeercert()
331 if not cert.get('subjectAltName', ()):
332 warnings.warn((
333 'Certificate for {0} has no `subjectAltName`, falling back to check for a '
334 '`commonName` for now. This feature is being removed by major browsers and '
335 'deprecated by RFC 2818. (See https://github.com/shazow/urllib3/issues/497 '
336 'for details.)'.format(hostname)),
337 SubjectAltNameWarning
338 )
339 _match_hostname(cert, self.assert_hostname or hostname)
340
341 self.is_verified = (
342 context.verify_mode == ssl.CERT_REQUIRED or
343 self.assert_fingerprint is not None
344 )
345
346
347 def _match_hostname(cert, asserted_hostname):
348 try:
349 match_hostname(cert, asserted_hostname)
350 except CertificateError as e:
351 log.error(
352 'Certificate did not match expected hostname: %s. '
353 'Certificate: %s', asserted_hostname, cert
354 )
355 # Add cert to exception and reraise so client code can inspect
356 # the cert when catching the exception, if they want to
357 e._peer_cert = cert
358 raise
359
360
361 if ssl:
362 # Make a copy for testing.
363 UnverifiedHTTPSConnection = HTTPSConnection
364 HTTPSConnection = VerifiedHTTPSConnection
365 else:
366 HTTPSConnection = DummyConnection
367
```
--- 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/urllib3/connection.py b/urllib3/connection.py
--- a/urllib3/connection.py
+++ b/urllib3/connection.py
@@ -56,7 +56,10 @@
'https': 443,
}
-RECENT_DATE = datetime.date(2014, 1, 1)
+# When updating RECENT_DATE, move it to
+# within two years of the current date, and no
+# earlier than 6 months ago.
+RECENT_DATE = datetime.date(2016, 1, 1)
class DummyConnection(object):
| {"golden_diff": "diff --git a/urllib3/connection.py b/urllib3/connection.py\n--- a/urllib3/connection.py\n+++ b/urllib3/connection.py\n@@ -56,7 +56,10 @@\n 'https': 443,\n }\n \n-RECENT_DATE = datetime.date(2014, 1, 1)\n+# When updating RECENT_DATE, move it to\n+# within two years of the current date, and no\n+# earlier than 6 months ago.\n+RECENT_DATE = datetime.date(2016, 1, 1)\n \n \n class DummyConnection(object):\n", "issue": "Add unit test for RECENT_DATE\nI've got a feeling this value could be easily forgotten to be updated over time. Could we perhaps add a unit test that will fail if it gets to be too far away from the current date. It seems like it was last modified in mid 2014 but wasn't updated since then, should this value be updated now?\n\nLink to the blame: https://github.com/shazow/urllib3/blame/master/urllib3/connection.py#L59\n## \n\n", "before_files": [{"content": "from __future__ import absolute_import\nimport datetime\nimport logging\nimport os\nimport sys\nimport socket\nfrom socket import error as SocketError, timeout as SocketTimeout\nimport warnings\nfrom .packages import six\nfrom .packages.six.moves.http_client import HTTPConnection as _HTTPConnection\nfrom .packages.six.moves.http_client import HTTPException # noqa: F401\n\ntry: # Compiled with SSL?\n import ssl\n BaseSSLError = ssl.SSLError\nexcept (ImportError, AttributeError): # Platform-specific: No SSL.\n ssl = None\n\n class BaseSSLError(BaseException):\n pass\n\n\ntry: # Python 3:\n # Not a no-op, we're adding this to the namespace so it can be imported.\n ConnectionError = ConnectionError\nexcept NameError: # Python 2:\n class ConnectionError(Exception):\n pass\n\n\nfrom .exceptions import (\n NewConnectionError,\n ConnectTimeoutError,\n SubjectAltNameWarning,\n SystemTimeWarning,\n)\nfrom .packages.ssl_match_hostname import match_hostname, CertificateError\n\nfrom .util.ssl_ import (\n resolve_cert_reqs,\n resolve_ssl_version,\n assert_fingerprint,\n create_urllib3_context,\n ssl_wrap_socket\n)\n\n\nfrom .util import connection\n\nfrom ._collections import HTTPHeaderDict\n\nlog = logging.getLogger(__name__)\n\nport_by_scheme = {\n 'http': 80,\n 'https': 443,\n}\n\nRECENT_DATE = datetime.date(2014, 1, 1)\n\n\nclass DummyConnection(object):\n \"\"\"Used to detect a failed ConnectionCls import.\"\"\"\n pass\n\n\nclass HTTPConnection(_HTTPConnection, object):\n \"\"\"\n Based on httplib.HTTPConnection but provides an extra constructor\n backwards-compatibility layer between older and newer Pythons.\n\n Additional keyword parameters are used to configure attributes of the connection.\n Accepted parameters include:\n\n - ``strict``: See the documentation on :class:`urllib3.connectionpool.HTTPConnectionPool`\n - ``source_address``: Set the source address for the current connection.\n\n .. note:: This is ignored for Python 2.6. It is only applied for 2.7 and 3.x\n\n - ``socket_options``: Set specific options on the underlying socket. If not specified, then\n defaults are loaded from ``HTTPConnection.default_socket_options`` which includes disabling\n Nagle's algorithm (sets TCP_NODELAY to 1) unless the connection is behind a proxy.\n\n For example, if you wish to enable TCP Keep Alive in addition to the defaults,\n you might pass::\n\n HTTPConnection.default_socket_options + [\n (socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),\n ]\n\n Or you may want to disable the defaults by passing an empty list (e.g., ``[]``).\n \"\"\"\n\n default_port = port_by_scheme['http']\n\n #: Disable Nagle's algorithm by default.\n #: ``[(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)]``\n default_socket_options = [(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)]\n\n #: Whether this connection verifies the host's certificate.\n is_verified = False\n\n def __init__(self, *args, **kw):\n if six.PY3: # Python 3\n kw.pop('strict', None)\n\n # Pre-set source_address in case we have an older Python like 2.6.\n self.source_address = kw.get('source_address')\n\n if sys.version_info < (2, 7): # Python 2.6\n # _HTTPConnection on Python 2.6 will balk at this keyword arg, but\n # not newer versions. We can still use it when creating a\n # connection though, so we pop it *after* we have saved it as\n # self.source_address.\n kw.pop('source_address', None)\n\n #: The socket options provided by the user. If no options are\n #: provided, we use the default options.\n self.socket_options = kw.pop('socket_options', self.default_socket_options)\n\n # Superclass also sets self.source_address in Python 2.7+.\n _HTTPConnection.__init__(self, *args, **kw)\n\n def _new_conn(self):\n \"\"\" Establish a socket connection and set nodelay settings on it.\n\n :return: New socket connection.\n \"\"\"\n extra_kw = {}\n if self.source_address:\n extra_kw['source_address'] = self.source_address\n\n if self.socket_options:\n extra_kw['socket_options'] = self.socket_options\n\n try:\n conn = connection.create_connection(\n (self.host, self.port), self.timeout, **extra_kw)\n\n except SocketTimeout as e:\n raise ConnectTimeoutError(\n self, \"Connection to %s timed out. (connect timeout=%s)\" %\n (self.host, self.timeout))\n\n except SocketError as e:\n raise NewConnectionError(\n self, \"Failed to establish a new connection: %s\" % e)\n\n return conn\n\n def _prepare_conn(self, conn):\n self.sock = conn\n # the _tunnel_host attribute was added in python 2.6.3 (via\n # http://hg.python.org/cpython/rev/0f57b30a152f) so pythons 2.6(0-2) do\n # not have them.\n if getattr(self, '_tunnel_host', None):\n # TODO: Fix tunnel so it doesn't depend on self.sock state.\n self._tunnel()\n # Mark this connection as not reusable\n self.auto_open = 0\n\n def connect(self):\n conn = self._new_conn()\n self._prepare_conn(conn)\n\n def request_chunked(self, method, url, body=None, headers=None):\n \"\"\"\n Alternative to the common request method, which sends the\n body with chunked encoding and not as one block\n \"\"\"\n headers = HTTPHeaderDict(headers if headers is not None else {})\n skip_accept_encoding = 'accept-encoding' in headers\n skip_host = 'host' in headers\n self.putrequest(\n method,\n url,\n skip_accept_encoding=skip_accept_encoding,\n skip_host=skip_host\n )\n for header, value in headers.items():\n self.putheader(header, value)\n if 'transfer-encoding' not in headers:\n self.putheader('Transfer-Encoding', 'chunked')\n self.endheaders()\n\n if body is not None:\n stringish_types = six.string_types + (six.binary_type,)\n if isinstance(body, stringish_types):\n body = (body,)\n for chunk in body:\n if not chunk:\n continue\n if not isinstance(chunk, six.binary_type):\n chunk = chunk.encode('utf8')\n len_str = hex(len(chunk))[2:]\n self.send(len_str.encode('utf-8'))\n self.send(b'\\r\\n')\n self.send(chunk)\n self.send(b'\\r\\n')\n\n # After the if clause, to always have a closed body\n self.send(b'0\\r\\n\\r\\n')\n\n\nclass HTTPSConnection(HTTPConnection):\n default_port = port_by_scheme['https']\n\n ssl_version = None\n\n def __init__(self, host, port=None, key_file=None, cert_file=None,\n strict=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,\n ssl_context=None, **kw):\n\n HTTPConnection.__init__(self, host, port, strict=strict,\n timeout=timeout, **kw)\n\n self.key_file = key_file\n self.cert_file = cert_file\n self.ssl_context = ssl_context\n\n # Required property for Google AppEngine 1.9.0 which otherwise causes\n # HTTPS requests to go out as HTTP. (See Issue #356)\n self._protocol = 'https'\n\n def connect(self):\n conn = self._new_conn()\n self._prepare_conn(conn)\n\n if self.ssl_context is None:\n self.ssl_context = create_urllib3_context(\n ssl_version=resolve_ssl_version(None),\n cert_reqs=resolve_cert_reqs(None),\n )\n\n self.sock = ssl_wrap_socket(\n sock=conn,\n keyfile=self.key_file,\n certfile=self.cert_file,\n ssl_context=self.ssl_context,\n )\n\n\nclass VerifiedHTTPSConnection(HTTPSConnection):\n \"\"\"\n Based on httplib.HTTPSConnection but wraps the socket with\n SSL certification.\n \"\"\"\n cert_reqs = None\n ca_certs = None\n ca_cert_dir = None\n ssl_version = None\n assert_fingerprint = None\n\n def set_cert(self, key_file=None, cert_file=None,\n cert_reqs=None, ca_certs=None,\n assert_hostname=None, assert_fingerprint=None,\n ca_cert_dir=None):\n \"\"\"\n This method should only be called once, before the connection is used.\n \"\"\"\n # If cert_reqs is not provided, we can try to guess. If the user gave\n # us a cert database, we assume they want to use it: otherwise, if\n # they gave us an SSL Context object we should use whatever is set for\n # it.\n if cert_reqs is None:\n if ca_certs or ca_cert_dir:\n cert_reqs = 'CERT_REQUIRED'\n elif self.ssl_context is not None:\n cert_reqs = self.ssl_context.verify_mode\n\n self.key_file = key_file\n self.cert_file = cert_file\n self.cert_reqs = cert_reqs\n self.assert_hostname = assert_hostname\n self.assert_fingerprint = assert_fingerprint\n self.ca_certs = ca_certs and os.path.expanduser(ca_certs)\n self.ca_cert_dir = ca_cert_dir and os.path.expanduser(ca_cert_dir)\n\n def connect(self):\n # Add certificate verification\n conn = self._new_conn()\n\n hostname = self.host\n if getattr(self, '_tunnel_host', None):\n # _tunnel_host was added in Python 2.6.3\n # (See: http://hg.python.org/cpython/rev/0f57b30a152f)\n\n self.sock = conn\n # Calls self._set_hostport(), so self.host is\n # self._tunnel_host below.\n self._tunnel()\n # Mark this connection as not reusable\n self.auto_open = 0\n\n # Override the host with the one we're requesting data from.\n hostname = self._tunnel_host\n\n is_time_off = datetime.date.today() < RECENT_DATE\n if is_time_off:\n warnings.warn((\n 'System time is way off (before {0}). This will probably '\n 'lead to SSL verification errors').format(RECENT_DATE),\n SystemTimeWarning\n )\n\n # Wrap socket using verification with the root certs in\n # trusted_root_certs\n if self.ssl_context is None:\n self.ssl_context = create_urllib3_context(\n ssl_version=resolve_ssl_version(self.ssl_version),\n cert_reqs=resolve_cert_reqs(self.cert_reqs),\n )\n\n context = self.ssl_context\n context.verify_mode = resolve_cert_reqs(self.cert_reqs)\n self.sock = ssl_wrap_socket(\n sock=conn,\n keyfile=self.key_file,\n certfile=self.cert_file,\n ca_certs=self.ca_certs,\n ca_cert_dir=self.ca_cert_dir,\n server_hostname=hostname,\n ssl_context=context)\n\n if self.assert_fingerprint:\n assert_fingerprint(self.sock.getpeercert(binary_form=True),\n self.assert_fingerprint)\n elif context.verify_mode != ssl.CERT_NONE \\\n and self.assert_hostname is not False:\n cert = self.sock.getpeercert()\n if not cert.get('subjectAltName', ()):\n warnings.warn((\n 'Certificate for {0} has no `subjectAltName`, falling back to check for a '\n '`commonName` for now. This feature is being removed by major browsers and '\n 'deprecated by RFC 2818. (See https://github.com/shazow/urllib3/issues/497 '\n 'for details.)'.format(hostname)),\n SubjectAltNameWarning\n )\n _match_hostname(cert, self.assert_hostname or hostname)\n\n self.is_verified = (\n context.verify_mode == ssl.CERT_REQUIRED or\n self.assert_fingerprint is not None\n )\n\n\ndef _match_hostname(cert, asserted_hostname):\n try:\n match_hostname(cert, asserted_hostname)\n except CertificateError as e:\n log.error(\n 'Certificate did not match expected hostname: %s. '\n 'Certificate: %s', asserted_hostname, cert\n )\n # Add cert to exception and reraise so client code can inspect\n # the cert when catching the exception, if they want to\n e._peer_cert = cert\n raise\n\n\nif ssl:\n # Make a copy for testing.\n UnverifiedHTTPSConnection = HTTPSConnection\n HTTPSConnection = VerifiedHTTPSConnection\nelse:\n HTTPSConnection = DummyConnection\n", "path": "urllib3/connection.py"}], "after_files": [{"content": "from __future__ import absolute_import\nimport datetime\nimport logging\nimport os\nimport sys\nimport socket\nfrom socket import error as SocketError, timeout as SocketTimeout\nimport warnings\nfrom .packages import six\nfrom .packages.six.moves.http_client import HTTPConnection as _HTTPConnection\nfrom .packages.six.moves.http_client import HTTPException # noqa: F401\n\ntry: # Compiled with SSL?\n import ssl\n BaseSSLError = ssl.SSLError\nexcept (ImportError, AttributeError): # Platform-specific: No SSL.\n ssl = None\n\n class BaseSSLError(BaseException):\n pass\n\n\ntry: # Python 3:\n # Not a no-op, we're adding this to the namespace so it can be imported.\n ConnectionError = ConnectionError\nexcept NameError: # Python 2:\n class ConnectionError(Exception):\n pass\n\n\nfrom .exceptions import (\n NewConnectionError,\n ConnectTimeoutError,\n SubjectAltNameWarning,\n SystemTimeWarning,\n)\nfrom .packages.ssl_match_hostname import match_hostname, CertificateError\n\nfrom .util.ssl_ import (\n resolve_cert_reqs,\n resolve_ssl_version,\n assert_fingerprint,\n create_urllib3_context,\n ssl_wrap_socket\n)\n\n\nfrom .util import connection\n\nfrom ._collections import HTTPHeaderDict\n\nlog = logging.getLogger(__name__)\n\nport_by_scheme = {\n 'http': 80,\n 'https': 443,\n}\n\n# When updating RECENT_DATE, move it to\n# within two years of the current date, and no\n# earlier than 6 months ago.\nRECENT_DATE = datetime.date(2016, 1, 1)\n\n\nclass DummyConnection(object):\n \"\"\"Used to detect a failed ConnectionCls import.\"\"\"\n pass\n\n\nclass HTTPConnection(_HTTPConnection, object):\n \"\"\"\n Based on httplib.HTTPConnection but provides an extra constructor\n backwards-compatibility layer between older and newer Pythons.\n\n Additional keyword parameters are used to configure attributes of the connection.\n Accepted parameters include:\n\n - ``strict``: See the documentation on :class:`urllib3.connectionpool.HTTPConnectionPool`\n - ``source_address``: Set the source address for the current connection.\n\n .. note:: This is ignored for Python 2.6. It is only applied for 2.7 and 3.x\n\n - ``socket_options``: Set specific options on the underlying socket. If not specified, then\n defaults are loaded from ``HTTPConnection.default_socket_options`` which includes disabling\n Nagle's algorithm (sets TCP_NODELAY to 1) unless the connection is behind a proxy.\n\n For example, if you wish to enable TCP Keep Alive in addition to the defaults,\n you might pass::\n\n HTTPConnection.default_socket_options + [\n (socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),\n ]\n\n Or you may want to disable the defaults by passing an empty list (e.g., ``[]``).\n \"\"\"\n\n default_port = port_by_scheme['http']\n\n #: Disable Nagle's algorithm by default.\n #: ``[(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)]``\n default_socket_options = [(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)]\n\n #: Whether this connection verifies the host's certificate.\n is_verified = False\n\n def __init__(self, *args, **kw):\n if six.PY3: # Python 3\n kw.pop('strict', None)\n\n # Pre-set source_address in case we have an older Python like 2.6.\n self.source_address = kw.get('source_address')\n\n if sys.version_info < (2, 7): # Python 2.6\n # _HTTPConnection on Python 2.6 will balk at this keyword arg, but\n # not newer versions. We can still use it when creating a\n # connection though, so we pop it *after* we have saved it as\n # self.source_address.\n kw.pop('source_address', None)\n\n #: The socket options provided by the user. If no options are\n #: provided, we use the default options.\n self.socket_options = kw.pop('socket_options', self.default_socket_options)\n\n # Superclass also sets self.source_address in Python 2.7+.\n _HTTPConnection.__init__(self, *args, **kw)\n\n def _new_conn(self):\n \"\"\" Establish a socket connection and set nodelay settings on it.\n\n :return: New socket connection.\n \"\"\"\n extra_kw = {}\n if self.source_address:\n extra_kw['source_address'] = self.source_address\n\n if self.socket_options:\n extra_kw['socket_options'] = self.socket_options\n\n try:\n conn = connection.create_connection(\n (self.host, self.port), self.timeout, **extra_kw)\n\n except SocketTimeout as e:\n raise ConnectTimeoutError(\n self, \"Connection to %s timed out. (connect timeout=%s)\" %\n (self.host, self.timeout))\n\n except SocketError as e:\n raise NewConnectionError(\n self, \"Failed to establish a new connection: %s\" % e)\n\n return conn\n\n def _prepare_conn(self, conn):\n self.sock = conn\n # the _tunnel_host attribute was added in python 2.6.3 (via\n # http://hg.python.org/cpython/rev/0f57b30a152f) so pythons 2.6(0-2) do\n # not have them.\n if getattr(self, '_tunnel_host', None):\n # TODO: Fix tunnel so it doesn't depend on self.sock state.\n self._tunnel()\n # Mark this connection as not reusable\n self.auto_open = 0\n\n def connect(self):\n conn = self._new_conn()\n self._prepare_conn(conn)\n\n def request_chunked(self, method, url, body=None, headers=None):\n \"\"\"\n Alternative to the common request method, which sends the\n body with chunked encoding and not as one block\n \"\"\"\n headers = HTTPHeaderDict(headers if headers is not None else {})\n skip_accept_encoding = 'accept-encoding' in headers\n skip_host = 'host' in headers\n self.putrequest(\n method,\n url,\n skip_accept_encoding=skip_accept_encoding,\n skip_host=skip_host\n )\n for header, value in headers.items():\n self.putheader(header, value)\n if 'transfer-encoding' not in headers:\n self.putheader('Transfer-Encoding', 'chunked')\n self.endheaders()\n\n if body is not None:\n stringish_types = six.string_types + (six.binary_type,)\n if isinstance(body, stringish_types):\n body = (body,)\n for chunk in body:\n if not chunk:\n continue\n if not isinstance(chunk, six.binary_type):\n chunk = chunk.encode('utf8')\n len_str = hex(len(chunk))[2:]\n self.send(len_str.encode('utf-8'))\n self.send(b'\\r\\n')\n self.send(chunk)\n self.send(b'\\r\\n')\n\n # After the if clause, to always have a closed body\n self.send(b'0\\r\\n\\r\\n')\n\n\nclass HTTPSConnection(HTTPConnection):\n default_port = port_by_scheme['https']\n\n ssl_version = None\n\n def __init__(self, host, port=None, key_file=None, cert_file=None,\n strict=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,\n ssl_context=None, **kw):\n\n HTTPConnection.__init__(self, host, port, strict=strict,\n timeout=timeout, **kw)\n\n self.key_file = key_file\n self.cert_file = cert_file\n self.ssl_context = ssl_context\n\n # Required property for Google AppEngine 1.9.0 which otherwise causes\n # HTTPS requests to go out as HTTP. (See Issue #356)\n self._protocol = 'https'\n\n def connect(self):\n conn = self._new_conn()\n self._prepare_conn(conn)\n\n if self.ssl_context is None:\n self.ssl_context = create_urllib3_context(\n ssl_version=resolve_ssl_version(None),\n cert_reqs=resolve_cert_reqs(None),\n )\n\n self.sock = ssl_wrap_socket(\n sock=conn,\n keyfile=self.key_file,\n certfile=self.cert_file,\n ssl_context=self.ssl_context,\n )\n\n\nclass VerifiedHTTPSConnection(HTTPSConnection):\n \"\"\"\n Based on httplib.HTTPSConnection but wraps the socket with\n SSL certification.\n \"\"\"\n cert_reqs = None\n ca_certs = None\n ca_cert_dir = None\n ssl_version = None\n assert_fingerprint = None\n\n def set_cert(self, key_file=None, cert_file=None,\n cert_reqs=None, ca_certs=None,\n assert_hostname=None, assert_fingerprint=None,\n ca_cert_dir=None):\n \"\"\"\n This method should only be called once, before the connection is used.\n \"\"\"\n # If cert_reqs is not provided, we can try to guess. If the user gave\n # us a cert database, we assume they want to use it: otherwise, if\n # they gave us an SSL Context object we should use whatever is set for\n # it.\n if cert_reqs is None:\n if ca_certs or ca_cert_dir:\n cert_reqs = 'CERT_REQUIRED'\n elif self.ssl_context is not None:\n cert_reqs = self.ssl_context.verify_mode\n\n self.key_file = key_file\n self.cert_file = cert_file\n self.cert_reqs = cert_reqs\n self.assert_hostname = assert_hostname\n self.assert_fingerprint = assert_fingerprint\n self.ca_certs = ca_certs and os.path.expanduser(ca_certs)\n self.ca_cert_dir = ca_cert_dir and os.path.expanduser(ca_cert_dir)\n\n def connect(self):\n # Add certificate verification\n conn = self._new_conn()\n\n hostname = self.host\n if getattr(self, '_tunnel_host', None):\n # _tunnel_host was added in Python 2.6.3\n # (See: http://hg.python.org/cpython/rev/0f57b30a152f)\n\n self.sock = conn\n # Calls self._set_hostport(), so self.host is\n # self._tunnel_host below.\n self._tunnel()\n # Mark this connection as not reusable\n self.auto_open = 0\n\n # Override the host with the one we're requesting data from.\n hostname = self._tunnel_host\n\n is_time_off = datetime.date.today() < RECENT_DATE\n if is_time_off:\n warnings.warn((\n 'System time is way off (before {0}). This will probably '\n 'lead to SSL verification errors').format(RECENT_DATE),\n SystemTimeWarning\n )\n\n # Wrap socket using verification with the root certs in\n # trusted_root_certs\n if self.ssl_context is None:\n self.ssl_context = create_urllib3_context(\n ssl_version=resolve_ssl_version(self.ssl_version),\n cert_reqs=resolve_cert_reqs(self.cert_reqs),\n )\n\n context = self.ssl_context\n context.verify_mode = resolve_cert_reqs(self.cert_reqs)\n self.sock = ssl_wrap_socket(\n sock=conn,\n keyfile=self.key_file,\n certfile=self.cert_file,\n ca_certs=self.ca_certs,\n ca_cert_dir=self.ca_cert_dir,\n server_hostname=hostname,\n ssl_context=context)\n\n if self.assert_fingerprint:\n assert_fingerprint(self.sock.getpeercert(binary_form=True),\n self.assert_fingerprint)\n elif context.verify_mode != ssl.CERT_NONE \\\n and self.assert_hostname is not False:\n cert = self.sock.getpeercert()\n if not cert.get('subjectAltName', ()):\n warnings.warn((\n 'Certificate for {0} has no `subjectAltName`, falling back to check for a '\n '`commonName` for now. This feature is being removed by major browsers and '\n 'deprecated by RFC 2818. (See https://github.com/shazow/urllib3/issues/497 '\n 'for details.)'.format(hostname)),\n SubjectAltNameWarning\n )\n _match_hostname(cert, self.assert_hostname or hostname)\n\n self.is_verified = (\n context.verify_mode == ssl.CERT_REQUIRED or\n self.assert_fingerprint is not None\n )\n\n\ndef _match_hostname(cert, asserted_hostname):\n try:\n match_hostname(cert, asserted_hostname)\n except CertificateError as e:\n log.error(\n 'Certificate did not match expected hostname: %s. '\n 'Certificate: %s', asserted_hostname, cert\n )\n # Add cert to exception and reraise so client code can inspect\n # the cert when catching the exception, if they want to\n e._peer_cert = cert\n raise\n\n\nif ssl:\n # Make a copy for testing.\n UnverifiedHTTPSConnection = HTTPSConnection\n HTTPSConnection = VerifiedHTTPSConnection\nelse:\n HTTPSConnection = DummyConnection\n", "path": "urllib3/connection.py"}]} |
gh_patches_debug_223 | rasdani/github-patches | git_diff | conda__conda-build-4062 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
conda build calls `sys.exit` when downloading the source
<!--
Thanks for opening an issue! A few things to keep in mind:
- This issue tracker is for issues with or enhancements for conda-build.
Anaconda Community Code of Conduct: https://www.anaconda.com/community-code-of-conduct/
For conda issues, you should open an issue at https://github.com/conda/conda/issues
For Anaconda issues, you should open an issue at https://github.com/ContinuumIO/anaconda-issues/issues
For an issue with a particular conda-forge package, you should open an issue on the
corresponding feedstock: https://github.com/conda-forge
-->
### Actual Behavior
If you use the `provide` function and a patch cannot be applied to the source, conda build calls `sys.exit`.
See https://github.com/conda/conda-build/blob/master/conda_build/source.py#L615
<!-- What actually happens? -->
### Expected Behavior
conda-build should raise a suitable error.
<!-- What do you think should happen? -->
### Steps to Reproduce
<!-- Steps to reproduce issue. -->
##### `Output of conda info`
This happens for the latest version of conda build in my CI jobs so I do not have the info output.
<!-- Between the ticks below, paste the output of 'conda info' -->
```
```
cc @mingwandroid @isuruf @scopatz @CJ-Wright
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `conda_build/source.py`
Content:
```
1 from __future__ import absolute_import, division, print_function
2
3 import io
4 import locale
5 import os
6 from os.path import join, isdir, isfile, abspath, basename, exists, normpath, expanduser
7 import re
8 import shutil
9 from subprocess import CalledProcessError
10 import sys
11 import time
12
13 from .conda_interface import download, TemporaryDirectory
14 from .conda_interface import hashsum_file
15
16 from conda_build.os_utils import external
17 from conda_build.conda_interface import url_path, CondaHTTPError
18 from conda_build.utils import (decompressible_exts, tar_xf, safe_print_unicode, copy_into, on_win, ensure_list,
19 check_output_env, check_call_env, convert_path_for_cygwin_or_msys2,
20 get_logger, rm_rf, LoggingContext)
21
22
23 if on_win:
24 from conda_build.utils import convert_unix_path_to_win
25
26 if sys.version_info[0] == 3:
27 from urllib.parse import urljoin
28 else:
29 from urlparse import urljoin
30
31 git_submod_re = re.compile(r'(?:.+)\.(.+)\.(?:.+)\s(.+)')
32 ext_re = re.compile(r"(.*?)(\.(?:tar\.)?[^.]+)$")
33
34
35 def append_hash_to_fn(fn, hash_value):
36 return ext_re.sub(r"\1_{}\2".format(hash_value[:10]), fn)
37
38
39 def download_to_cache(cache_folder, recipe_path, source_dict, verbose=False):
40 ''' Download a source to the local cache. '''
41 log = get_logger(__name__)
42 if verbose:
43 log.info('Source cache directory is: %s' % cache_folder)
44 if not isdir(cache_folder) and not os.path.islink(cache_folder):
45 os.makedirs(cache_folder)
46
47 source_urls = source_dict['url']
48 if not isinstance(source_urls, list):
49 source_urls = [source_urls]
50 unhashed_fn = fn = source_dict['fn'] if 'fn' in source_dict else basename(source_urls[0])
51 hash_added = False
52 for hash_type in ('md5', 'sha1', 'sha256'):
53 if hash_type in source_dict:
54 if source_dict[hash_type] in (None, ""):
55 raise ValueError('Empty {} hash provided for {}'.format(hash_type, fn))
56 fn = append_hash_to_fn(fn, source_dict[hash_type])
57 hash_added = True
58 break
59 else:
60 log.warn("No hash (md5, sha1, sha256) provided for {}. Source download forced. "
61 "Add hash to recipe to use source cache.".format(unhashed_fn))
62 path = join(cache_folder, fn)
63 if isfile(path):
64 if verbose:
65 log.info('Found source in cache: %s' % fn)
66 else:
67 if verbose:
68 log.info('Downloading source to cache: %s' % fn)
69
70 for url in source_urls:
71 if "://" not in url:
72 if url.startswith('~'):
73 url = expanduser(url)
74 if not os.path.isabs(url):
75 url = os.path.normpath(os.path.join(recipe_path, url))
76 url = url_path(url)
77 else:
78 if url.startswith('file:///~'):
79 url = 'file:///' + expanduser(url[8:]).replace('\\', '/')
80 try:
81 if verbose:
82 log.info("Downloading %s" % url)
83 with LoggingContext():
84 download(url, path)
85 except CondaHTTPError as e:
86 log.warn("Error: %s" % str(e).strip())
87 rm_rf(path)
88 except RuntimeError as e:
89 log.warn("Error: %s" % str(e).strip())
90 rm_rf(path)
91 else:
92 if verbose:
93 log.info("Success")
94 break
95 else: # no break
96 rm_rf(path)
97 raise RuntimeError("Could not download %s" % url)
98
99 hashed = None
100 for tp in ('md5', 'sha1', 'sha256'):
101 if tp in source_dict:
102 expected_hash = source_dict[tp]
103 hashed = hashsum_file(path, tp)
104 if expected_hash != hashed:
105 rm_rf(path)
106 raise RuntimeError("%s mismatch: '%s' != '%s'" %
107 (tp.upper(), hashed, expected_hash))
108 break
109
110 # this is really a fallback. If people don't provide the hash, we still need to prevent
111 # collisions in our source cache, but the end user will get no benefirt from the cache.
112 if not hash_added:
113 if not hashed:
114 hashed = hashsum_file(path, 'sha256')
115 dest_path = append_hash_to_fn(path, hashed)
116 if not os.path.isfile(dest_path):
117 shutil.move(path, dest_path)
118 path = dest_path
119
120 return path, unhashed_fn
121
122
123 def hoist_single_extracted_folder(nested_folder):
124 """Moves all files/folders one level up.
125
126 This is for when your archive extracts into its own folder, so that we don't need to
127 know exactly what that folder is called."""
128 parent = os.path.dirname(nested_folder)
129 flist = os.listdir(nested_folder)
130 with TemporaryDirectory() as tmpdir:
131 for entry in flist:
132 shutil.move(os.path.join(nested_folder, entry), os.path.join(tmpdir, entry))
133 rm_rf(nested_folder)
134 for entry in flist:
135 shutil.move(os.path.join(tmpdir, entry), os.path.join(parent, entry))
136
137
138 def unpack(source_dict, src_dir, cache_folder, recipe_path, croot, verbose=False,
139 timeout=900, locking=True):
140 ''' Uncompress a downloaded source. '''
141 src_path, unhashed_fn = download_to_cache(cache_folder, recipe_path, source_dict, verbose)
142
143 if not isdir(src_dir):
144 os.makedirs(src_dir)
145 if verbose:
146 print("Extracting download")
147 with TemporaryDirectory(dir=croot) as tmpdir:
148 unhashed_dest = os.path.join(tmpdir, unhashed_fn)
149 if src_path.lower().endswith(decompressible_exts):
150 tar_xf(src_path, tmpdir)
151 else:
152 # In this case, the build script will need to deal with unpacking the source
153 print("Warning: Unrecognized source format. Source file will be copied to the SRC_DIR")
154 copy_into(src_path, unhashed_dest, timeout, locking=locking)
155 if src_path.lower().endswith('.whl'):
156 # copy wheel itself *and* unpack it
157 # This allows test_files or about.license_file to locate files in the wheel,
158 # as well as `pip install name-version.whl` as install command
159 copy_into(src_path, unhashed_dest, timeout, locking=locking)
160 flist = os.listdir(tmpdir)
161 folder = os.path.join(tmpdir, flist[0])
162 # Hoisting is destructive of information, in CDT packages, a single top level
163 # folder of /usr64 must not be discarded.
164 if len(flist) == 1 and os.path.isdir(folder) and 'no_hoist' not in source_dict:
165 hoist_single_extracted_folder(folder)
166 flist = os.listdir(tmpdir)
167 for f in flist:
168 shutil.move(os.path.join(tmpdir, f), os.path.join(src_dir, f))
169
170
171 def git_mirror_checkout_recursive(git, mirror_dir, checkout_dir, git_url, git_cache, git_ref=None,
172 git_depth=-1, is_top_level=True, verbose=True):
173 """ Mirror (and checkout) a Git repository recursively.
174
175 It's not possible to use `git submodule` on a bare
176 repository, so the checkout must be done before we
177 know which submodules there are.
178
179 Worse, submodules can be identified by using either
180 absolute URLs or relative paths. If relative paths
181 are used those need to be relocated upon mirroring,
182 but you could end up with `../../../../blah` and in
183 that case conda-build could be tricked into writing
184 to the root of the drive and overwriting the system
185 folders unless steps are taken to prevent that.
186 """
187
188 if verbose:
189 stdout = None
190 stderr = None
191 else:
192 FNULL = open(os.devnull, 'w')
193 stdout = FNULL
194 stderr = FNULL
195
196 if not mirror_dir.startswith(git_cache + os.sep):
197 sys.exit("Error: Attempting to mirror to %s which is outside of GIT_CACHE %s"
198 % (mirror_dir, git_cache))
199
200 # This is necessary for Cygwin git and m2-git, although it is fixed in newer MSYS2.
201 git_mirror_dir = convert_path_for_cygwin_or_msys2(git, mirror_dir).rstrip('/')
202 git_checkout_dir = convert_path_for_cygwin_or_msys2(git, checkout_dir).rstrip('/')
203
204 # Set default here to catch empty dicts
205 git_ref = git_ref or 'HEAD'
206
207 mirror_dir = mirror_dir.rstrip('/')
208 if not isdir(os.path.dirname(mirror_dir)):
209 os.makedirs(os.path.dirname(mirror_dir))
210 if isdir(mirror_dir):
211 try:
212 if git_ref != 'HEAD':
213 check_call_env([git, 'fetch'], cwd=mirror_dir, stdout=stdout, stderr=stderr)
214 else:
215 # Unlike 'git clone', fetch doesn't automatically update the cache's HEAD,
216 # So here we explicitly store the remote HEAD in the cache's local refs/heads,
217 # and then explicitly set the cache's HEAD.
218 # This is important when the git repo is a local path like "git_url: ../",
219 # but the user is working with a branch other than 'master' without
220 # explicitly providing git_rev.
221 check_call_env([git, 'fetch', 'origin', '+HEAD:_conda_cache_origin_head'],
222 cwd=mirror_dir, stdout=stdout, stderr=stderr)
223 check_call_env([git, 'symbolic-ref', 'HEAD', 'refs/heads/_conda_cache_origin_head'],
224 cwd=mirror_dir, stdout=stdout, stderr=stderr)
225 except CalledProcessError:
226 msg = ("Failed to update local git cache. "
227 "Deleting local cached repo: {} ".format(mirror_dir))
228 print(msg)
229
230 # Maybe the failure was caused by a corrupt mirror directory.
231 # Delete it so the user can try again.
232 shutil.rmtree(mirror_dir)
233 raise
234 else:
235 args = [git, 'clone', '--mirror']
236 if git_depth > 0:
237 args += ['--depth', str(git_depth)]
238 try:
239 check_call_env(args + [git_url, git_mirror_dir], stdout=stdout, stderr=stderr)
240 except CalledProcessError:
241 # on windows, remote URL comes back to us as cygwin or msys format. Python doesn't
242 # know how to normalize it. Need to convert it to a windows path.
243 if sys.platform == 'win32' and git_url.startswith('/'):
244 git_url = convert_unix_path_to_win(git_url)
245
246 if os.path.exists(git_url):
247 # Local filepaths are allowed, but make sure we normalize them
248 git_url = normpath(git_url)
249 check_call_env(args + [git_url, git_mirror_dir], stdout=stdout, stderr=stderr)
250 assert isdir(mirror_dir)
251
252 # Now clone from mirror_dir into checkout_dir.
253 check_call_env([git, 'clone', git_mirror_dir, git_checkout_dir], stdout=stdout, stderr=stderr)
254 if is_top_level:
255 checkout = git_ref
256 if git_url.startswith('.'):
257 output = check_output_env([git, "rev-parse", checkout], stdout=stdout, stderr=stderr)
258 checkout = output.decode('utf-8')
259 if verbose:
260 print('checkout: %r' % checkout)
261 if checkout:
262 check_call_env([git, 'checkout', checkout],
263 cwd=checkout_dir, stdout=stdout, stderr=stderr)
264
265 # submodules may have been specified using relative paths.
266 # Those paths are relative to git_url, and will not exist
267 # relative to mirror_dir, unless we do some work to make
268 # it so.
269 try:
270 submodules = check_output_env([git, 'config', '--file', '.gitmodules', '--get-regexp',
271 'url'], stderr=stdout, cwd=checkout_dir)
272 submodules = submodules.decode('utf-8').splitlines()
273 except CalledProcessError:
274 submodules = []
275 for submodule in submodules:
276 matches = git_submod_re.match(submodule)
277 if matches and matches.group(2)[0] == '.':
278 submod_name = matches.group(1)
279 submod_rel_path = matches.group(2)
280 submod_url = urljoin(git_url + '/', submod_rel_path)
281 submod_mirror_dir = os.path.normpath(
282 os.path.join(mirror_dir, submod_rel_path))
283 if verbose:
284 print('Relative submodule %s found: url is %s, submod_mirror_dir is %s' % (
285 submod_name, submod_url, submod_mirror_dir))
286 with TemporaryDirectory() as temp_checkout_dir:
287 git_mirror_checkout_recursive(git, submod_mirror_dir, temp_checkout_dir, submod_url,
288 git_cache=git_cache, git_ref=git_ref,
289 git_depth=git_depth, is_top_level=False,
290 verbose=verbose)
291
292 if is_top_level:
293 # Now that all relative-URL-specified submodules are locally mirrored to
294 # relatively the same place we can go ahead and checkout the submodules.
295 check_call_env([git, 'submodule', 'update', '--init',
296 '--recursive'], cwd=checkout_dir, stdout=stdout, stderr=stderr)
297 git_info(checkout_dir, verbose=verbose)
298 if not verbose:
299 FNULL.close()
300
301
302 def git_source(source_dict, git_cache, src_dir, recipe_path=None, verbose=True):
303 ''' Download a source from a Git repo (or submodule, recursively) '''
304 if not isdir(git_cache):
305 os.makedirs(git_cache)
306
307 git = external.find_executable('git')
308 if not git:
309 sys.exit("Error: git is not installed in your root environment or as a build requirement.")
310
311 git_depth = int(source_dict.get('git_depth', -1))
312 git_ref = source_dict.get('git_rev') or 'HEAD'
313
314 git_url = source_dict['git_url']
315 if git_url.startswith('~'):
316 git_url = os.path.expanduser(git_url)
317 if git_url.startswith('.'):
318 # It's a relative path from the conda recipe
319 git_url = abspath(normpath(os.path.join(recipe_path, git_url)))
320 if sys.platform == 'win32':
321 git_dn = git_url.replace(':', '_')
322 else:
323 git_dn = git_url[1:]
324 else:
325 git_dn = git_url.split('://')[-1].replace('/', os.sep)
326 if git_dn.startswith(os.sep):
327 git_dn = git_dn[1:]
328 git_dn = git_dn.replace(':', '_')
329 mirror_dir = join(git_cache, git_dn)
330 git_mirror_checkout_recursive(
331 git, mirror_dir, src_dir, git_url, git_cache=git_cache, git_ref=git_ref,
332 git_depth=git_depth, is_top_level=True, verbose=verbose)
333 return git
334
335
336 def git_info(src_dir, verbose=True, fo=None):
337 ''' Print info about a Git repo. '''
338 assert isdir(src_dir)
339
340 git = external.find_executable('git')
341 if not git:
342 log = get_logger(__name__)
343 log.warn("git not installed in root environment. Skipping recording of git info.")
344 return
345
346 if verbose:
347 stderr = None
348 else:
349 FNULL = open(os.devnull, 'w')
350 stderr = FNULL
351
352 # Ensure to explicitly set GIT_DIR as some Linux machines will not
353 # properly execute without it.
354 env = os.environ.copy()
355 env['GIT_DIR'] = join(src_dir, '.git')
356 env = {str(key): str(value) for key, value in env.items()}
357 for cmd, check_error in [
358 ('git log -n1', True),
359 ('git describe --tags --dirty', False),
360 ('git status', True)]:
361 try:
362 stdout = check_output_env(cmd.split(), stderr=stderr, cwd=src_dir, env=env)
363 except CalledProcessError as e:
364 if check_error:
365 raise Exception("git error: %s" % str(e))
366 encoding = locale.getpreferredencoding()
367 if not fo:
368 encoding = sys.stdout.encoding
369 encoding = encoding or 'utf-8'
370 if hasattr(stdout, 'decode'):
371 stdout = stdout.decode(encoding, 'ignore')
372 if fo:
373 fo.write(u'==> %s <==\n' % cmd)
374 if verbose:
375 fo.write(stdout + u'\n')
376 else:
377 if verbose:
378 print(u'==> %s <==\n' % cmd)
379 safe_print_unicode(stdout + u'\n')
380
381
382 def hg_source(source_dict, src_dir, hg_cache, verbose):
383 ''' Download a source from Mercurial repo. '''
384 if verbose:
385 stdout = None
386 stderr = None
387 else:
388 FNULL = open(os.devnull, 'w')
389 stdout = FNULL
390 stderr = FNULL
391
392 hg_url = source_dict['hg_url']
393 if not isdir(hg_cache):
394 os.makedirs(hg_cache)
395 hg_dn = hg_url.split(':')[-1].replace('/', '_')
396 cache_repo = join(hg_cache, hg_dn)
397 if isdir(cache_repo):
398 check_call_env(['hg', 'pull'], cwd=cache_repo, stdout=stdout, stderr=stderr)
399 else:
400 check_call_env(['hg', 'clone', hg_url, cache_repo], stdout=stdout, stderr=stderr)
401 assert isdir(cache_repo)
402
403 # now clone in to work directory
404 update = source_dict.get('hg_tag') or 'tip'
405 if verbose:
406 print('checkout: %r' % update)
407
408 check_call_env(['hg', 'clone', cache_repo, src_dir], stdout=stdout,
409 stderr=stderr)
410 check_call_env(['hg', 'update', '-C', update], cwd=src_dir, stdout=stdout,
411 stderr=stderr)
412
413 if not verbose:
414 FNULL.close()
415
416 return src_dir
417
418
419 def svn_source(source_dict, src_dir, svn_cache, verbose=True, timeout=900, locking=True):
420 ''' Download a source from SVN repo. '''
421 if verbose:
422 stdout = None
423 stderr = None
424 else:
425 FNULL = open(os.devnull, 'w')
426 stdout = FNULL
427 stderr = FNULL
428
429 def parse_bool(s):
430 return str(s).lower().strip() in ('yes', 'true', '1', 'on')
431
432 svn_url = source_dict['svn_url']
433 svn_revision = source_dict.get('svn_rev') or 'head'
434 svn_ignore_externals = parse_bool(source_dict.get('svn_ignore_externals') or 'no')
435 if not isdir(svn_cache):
436 os.makedirs(svn_cache)
437 svn_dn = svn_url.split(':', 1)[-1].replace('/', '_').replace(':', '_')
438 cache_repo = join(svn_cache, svn_dn)
439 if svn_ignore_externals:
440 extra_args = ['--ignore-externals']
441 else:
442 extra_args = []
443 if isdir(cache_repo):
444 check_call_env(['svn', 'up', '-r', svn_revision] + extra_args, cwd=cache_repo,
445 stdout=stdout, stderr=stderr)
446 else:
447 check_call_env(['svn', 'co', '-r', svn_revision] + extra_args + [svn_url, cache_repo],
448 stdout=stdout, stderr=stderr)
449 assert isdir(cache_repo)
450
451 # now copy into work directory
452 copy_into(cache_repo, src_dir, timeout, symlinks=True, locking=locking)
453
454 if not verbose:
455 FNULL.close()
456
457 return src_dir
458
459
460 def get_repository_info(recipe_path):
461 """This tries to get information about where a recipe came from. This is different
462 from the source - you can have a recipe in svn that gets source via git."""
463 try:
464 if exists(join(recipe_path, ".git")):
465 origin = check_output_env(["git", "config", "--get", "remote.origin.url"],
466 cwd=recipe_path)
467 rev = check_output_env(["git", "rev-parse", "HEAD"], cwd=recipe_path)
468 return "Origin {}, commit {}".format(origin, rev)
469 elif isdir(join(recipe_path, ".hg")):
470 origin = check_output_env(["hg", "paths", "default"], cwd=recipe_path)
471 rev = check_output_env(["hg", "id"], cwd=recipe_path).split()[0]
472 return "Origin {}, commit {}".format(origin, rev)
473 elif isdir(join(recipe_path, ".svn")):
474 info = check_output_env(["svn", "info"], cwd=recipe_path)
475 info = info.decode("utf-8") # Py3 returns a byte string, but re needs unicode or str.
476 server = re.search("Repository Root: (.*)$", info, flags=re.M).group(1)
477 revision = re.search("Revision: (.*)$", info, flags=re.M).group(1)
478 return "{}, Revision {}".format(server, revision)
479 else:
480 return "{}, last modified {}".format(recipe_path,
481 time.ctime(os.path.getmtime(
482 join(recipe_path, "meta.yaml"))))
483 except CalledProcessError:
484 get_logger(__name__).debug("Failed to checkout source in " + recipe_path)
485 return "{}, last modified {}".format(recipe_path,
486 time.ctime(os.path.getmtime(
487 join(recipe_path, "meta.yaml"))))
488
489
490 def _ensure_unix_line_endings(path):
491 """Replace windows line endings with Unix. Return path to modified file."""
492 out_path = path + "_unix"
493 with open(path, "rb") as inputfile:
494 with open(out_path, "wb") as outputfile:
495 for line in inputfile:
496 outputfile.write(line.replace(b"\r\n", b"\n"))
497 return out_path
498
499
500 def _ensure_win_line_endings(path):
501 """Replace unix line endings with win. Return path to modified file."""
502 out_path = path + "_win"
503 with open(path, "rb") as inputfile:
504 with open(out_path, "wb") as outputfile:
505 for line in inputfile:
506 outputfile.write(line.replace(b"\n", b"\r\n"))
507 return out_path
508
509
510 def _guess_patch_strip_level(filesstr, src_dir):
511 """ Determine the patch strip level automatically. """
512 maxlevel = None
513 files = {filestr.encode(errors='ignore') for filestr in filesstr}
514 src_dir = src_dir.encode(errors='ignore')
515 for file in files:
516 numslash = file.count(b'/')
517 maxlevel = numslash if maxlevel is None else min(maxlevel, numslash)
518 if maxlevel == 0:
519 patchlevel = 0
520 else:
521 histo = dict()
522 histo = {i: 0 for i in range(maxlevel + 1)}
523 for file in files:
524 parts = file.split(b'/')
525 for level in range(maxlevel + 1):
526 if os.path.exists(join(src_dir, *parts[-len(parts) + level:])):
527 histo[level] += 1
528 order = sorted(histo, key=histo.get, reverse=True)
529 if histo[order[0]] == histo[order[1]]:
530 print("Patch level ambiguous, selecting least deep")
531 patchlevel = min([key for key, value
532 in histo.items() if value == histo[order[0]]])
533 return patchlevel
534
535
536 def _get_patch_file_details(path):
537 re_files = re.compile(r'^(?:---|\+\+\+) ([^\n\t]+)')
538 files = set()
539 with io.open(path, errors='ignore') as f:
540 files = []
541 first_line = True
542 is_git_format = True
543 for line in f.readlines():
544 if first_line and not re.match(r'From [0-9a-f]{40}', line):
545 is_git_format = False
546 first_line = False
547 m = re_files.search(line)
548 if m and m.group(1) != '/dev/null':
549 files.append(m.group(1))
550 elif is_git_format and line.startswith('git') and not line.startswith('git --diff'):
551 is_git_format = False
552 return (files, is_git_format)
553
554
555 def apply_patch(src_dir, path, config, git=None):
556 def patch_or_reverse(patch, patch_args, cwd, stdout, stderr):
557 # An old reference: https://unix.stackexchange.com/a/243748/34459
558 #
559 # I am worried that '--ignore-whitespace' may be destructive. If so we should
560 # avoid passing it, particularly in the initial (most likely to succeed) calls.
561 #
562 # From here-in I define a 'native' patch as one which has:
563 # 1. LF for the patch block metadata.
564 # 2. CRLF or LF for the actual patched lines matching those of the source lines.
565 #
566 # Calls to a raw 'patch' are destructive in various ways:
567 # 1. It leaves behind .rej and .orig files
568 # 2. If you pass it a patch with incorrect CRLF changes and do not pass --binary and
569 # if any of those blocks *can* be applied, then the whole file gets written out with
570 # LF. This cannot be reversed either; the text changes will be reversed but not
571 # line-feed changes (since all line-endings get changed, not just those of the of
572 # patched lines)
573 # 3. If patching fails, the bits that succeeded remain, so patching is not at all
574 # atomic.
575 #
576 # Still, we do our best to mitigate all of this as follows:
577 # 1. We disable .orig and .rej that for GNU patch via a temp file *
578 # 2 (1). We check for native application of a native patch (--binary, without --ignore-whitespace)
579 # 2 (2). We defer destructive calls to this until after the non-destructive ones.
580 # 3. When patch indicates failure, we call it with -R to reverse the damage.
581 #
582 # * Some may bemoan the loss of these, but they it is fairly random which patch and patch
583 # attempt they apply to so their informational value is low, besides that, they are ugly.
584 # (and destructive to the future patchability of the source tree).
585 #
586 import tempfile
587 temp_name = os.path.join(tempfile.gettempdir(), next(tempfile._get_candidate_names()))
588 patch_args.append('-r')
589 patch_args.append(temp_name)
590 patch_args = ['--no-backup-if-mismatch', '--batch'] + patch_args
591 log = get_logger(__name__)
592 try:
593 log.debug("Applying with\n{} {}".format(patch, patch_args))
594 check_call_env([patch] + patch_args, cwd=cwd, stdout=stdout, stderr=stderr)
595 # You can use this to pretend the patch failed so as to test reversal!
596 # raise CalledProcessError(-1, ' '.join([patch] + patch_args))
597 except Exception as e:
598 try:
599 if '--ignore-whitespace' in patch_args:
600 patch_args.remove('--ignore-whitespace')
601 patch_args.insert(0, '-R')
602 patch_args.append('--binary')
603 patch_args.append('--force')
604 log.debug("Reversing with\n{} {}".format(patch, patch_args))
605 check_call_env([patch] + patch_args, cwd=cwd, stdout=stdout, stderr=stderr)
606 except:
607 pass
608 raise e
609 finally:
610 if os.path.exists(temp_name):
611 os.unlink(temp_name)
612
613 exception = None
614 if not isfile(path):
615 sys.exit('Error: no such patch: %s' % path)
616
617 if config.verbose:
618 stdout = None
619 stderr = None
620 else:
621 FNULL = open(os.devnull, 'w')
622 stdout = FNULL
623 stderr = FNULL
624
625 files, is_git_format = _get_patch_file_details(path)
626 if git and is_git_format:
627 # Prevents git from asking interactive questions,
628 # also necessary to achieve sha1 reproducibility;
629 # as is --committer-date-is-author-date. By this,
630 # we mean a round-trip of git am/git format-patch
631 # gives the same file.
632 git_env = os.environ
633 git_env['GIT_COMMITTER_NAME'] = 'conda-build'
634 git_env['GIT_COMMITTER_EMAIL'] = '[email protected]'
635 check_call_env([git, 'am', '-3', '--committer-date-is-author-date', path],
636 cwd=src_dir, stdout=stdout, stderr=stderr, env=git_env)
637 config.git_commits_since_tag += 1
638 else:
639 if config.verbose:
640 print('Applying patch: %r' % path)
641 patch = external.find_executable('patch', config.build_prefix)
642 if patch is None or len(patch) == 0:
643 sys.exit("""\
644 Error:
645 Cannot use 'git' (not a git repo and/or patch) and did not find 'patch' in: %s
646 You can install 'patch' using apt-get, yum (Linux), Xcode (MacOSX),
647 or conda, m2-patch (Windows),
648 """ % (os.pathsep.join(external.dir_paths)))
649 patch_strip_level = _guess_patch_strip_level(files, src_dir)
650 path_args = ['-i', path]
651 patch_args = ['-p%d' % patch_strip_level]
652
653 try:
654 log = get_logger(__name__)
655 # This is the case we check first of all as it is the case that allows a properly line-ended
656 # patch to apply correctly to a properly line-ended source tree, modifying it following the
657 # patch chunks exactly.
658 patch_or_reverse(patch, patch_args + ['--binary'] + path_args,
659 cwd=src_dir, stdout=stdout, stderr=stderr)
660 except CalledProcessError as e:
661 # Capture the first exception
662 exception = e
663 if config.verbose:
664 log.info("Applying patch natively failed. "
665 "Trying to apply patch non-binary with --ignore-whitespace")
666 try:
667 patch_or_reverse(patch, patch_args + ['--ignore-whitespace'] + path_args,
668 cwd=src_dir, stdout=stdout, stderr=stderr)
669 except CalledProcessError as e: # noqa
670 unix_ending_file = _ensure_unix_line_endings(path)
671 path_args[-1] = unix_ending_file
672 try:
673 if config.verbose:
674 log.info("Applying natively *and* non-binary failed! "
675 "Converting to unix line endings and trying again. "
676 "WARNING :: This is destructive to the source file line-endings.")
677 # If this succeeds, it will change the source files' CRLFs to LFs. This can
678 # mess things up both for subsequent attempts (this line-ending change is not
679 # reversible) but worse, for subsequent, correctly crafted (I'm calling these
680 # "native" from now on) patches.
681 patch_or_reverse(patch, patch_args + ['--ignore-whitespace'] + path_args,
682 cwd=src_dir, stdout=stdout, stderr=stderr)
683 except CalledProcessError:
684 if config.verbose:
685 log.warning("Applying natively, non-binary *and* unix attempts all failed!? "
686 "Converting to CRLF line endings and trying again with "
687 "--ignore-whitespace and --binary. This can be destructive (even"
688 "with attempted reversal) to the source files' line-endings.")
689 win_ending_file = _ensure_win_line_endings(path)
690 path_args[-1] = win_ending_file
691 try:
692 patch_or_reverse(patch, patch_args + ['--ignore-whitespace', '--binary'] + path_args,
693 cwd=src_dir, stdout=stdout, stderr=stderr)
694 except:
695 pass
696 else:
697 exception = None
698 finally:
699 if os.path.exists(win_ending_file):
700 os.remove(win_ending_file) # clean up .patch_unix file
701 else:
702 exception = None
703 finally:
704 if os.path.exists(unix_ending_file):
705 os.remove(unix_ending_file)
706 if exception:
707 raise exception
708
709
710 def provide(metadata):
711 """
712 given a recipe_dir:
713 - download (if necessary)
714 - unpack
715 - apply patches (if any)
716 """
717 meta = metadata.get_section('source')
718 if not os.path.isdir(metadata.config.build_folder):
719 os.makedirs(metadata.config.build_folder)
720 git = None
721
722 if hasattr(meta, 'keys'):
723 dicts = [meta]
724 else:
725 dicts = meta
726
727 try:
728 for source_dict in dicts:
729 folder = source_dict.get('folder')
730 src_dir = os.path.join(metadata.config.work_dir, folder if folder else '')
731 if any(k in source_dict for k in ('fn', 'url')):
732 unpack(source_dict, src_dir, metadata.config.src_cache, recipe_path=metadata.path,
733 croot=metadata.config.croot, verbose=metadata.config.verbose,
734 timeout=metadata.config.timeout, locking=metadata.config.locking)
735 elif 'git_url' in source_dict:
736 git = git_source(source_dict, metadata.config.git_cache, src_dir, metadata.path,
737 verbose=metadata.config.verbose)
738 # build to make sure we have a work directory with source in it. We
739 # want to make sure that whatever version that is does not
740 # interfere with the test we run next.
741 elif 'hg_url' in source_dict:
742 hg_source(source_dict, src_dir, metadata.config.hg_cache,
743 verbose=metadata.config.verbose)
744 elif 'svn_url' in source_dict:
745 svn_source(source_dict, src_dir, metadata.config.svn_cache,
746 verbose=metadata.config.verbose, timeout=metadata.config.timeout,
747 locking=metadata.config.locking)
748 elif 'path' in source_dict:
749 source_path = os.path.expanduser(source_dict['path'])
750 path = normpath(abspath(join(metadata.path, source_path)))
751 path_via_symlink = 'path_via_symlink' in source_dict
752 if path_via_symlink and not folder:
753 print("WARNING: `path_via_symlink` is too dangerous without specifying a folder,\n"
754 " conda could end up changing - or deleting - your local source code!\n"
755 " Going to make copies instead. When using `path_via_symlink` you should\n"
756 " also take care to run the build outside of your local source code folder(s)\n"
757 " unless that is your intention.")
758 path_via_symlink = False
759 sys.exit(1)
760 if path_via_symlink:
761 src_dir_symlink = os.path.dirname(src_dir)
762 if not isdir(src_dir_symlink):
763 os.makedirs(src_dir_symlink)
764 if metadata.config.verbose:
765 print("Creating sybmolic link pointing to %s at %s" % (path, src_dir))
766 os.symlink(path, src_dir)
767 else:
768 if metadata.config.verbose:
769 print("Copying %s to %s" % (path, src_dir))
770 # careful here: we set test path to be outside of conda-build root in setup.cfg.
771 # If you don't do that, this is a recursive function
772 copy_into(path, src_dir, metadata.config.timeout, symlinks=True,
773 locking=metadata.config.locking, clobber=True)
774 else: # no source
775 if not isdir(src_dir):
776 os.makedirs(src_dir)
777
778 patches = ensure_list(source_dict.get('patches', []))
779 for patch in patches:
780 apply_patch(src_dir, join(metadata.path, patch), metadata.config, git)
781
782 except CalledProcessError:
783 shutil.move(metadata.config.work_dir, metadata.config.work_dir + '_failed_provide')
784 raise
785
786 return metadata.config.work_dir
787
```
--- 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/conda_build/source.py b/conda_build/source.py
--- a/conda_build/source.py
+++ b/conda_build/source.py
@@ -612,7 +612,7 @@
exception = None
if not isfile(path):
- sys.exit('Error: no such patch: %s' % path)
+ raise RuntimeError('Error: no such patch: %s' % path)
if config.verbose:
stdout = None
| {"golden_diff": "diff --git a/conda_build/source.py b/conda_build/source.py\n--- a/conda_build/source.py\n+++ b/conda_build/source.py\n@@ -612,7 +612,7 @@\n \n exception = None\n if not isfile(path):\n- sys.exit('Error: no such patch: %s' % path)\n+ raise RuntimeError('Error: no such patch: %s' % path)\n \n if config.verbose:\n stdout = None\n", "issue": "conda build calls `sys.exit` when downloading the source\n<!--\r\nThanks for opening an issue! A few things to keep in mind:\r\n\r\n- This issue tracker is for issues with or enhancements for conda-build.\r\n\r\nAnaconda Community Code of Conduct: https://www.anaconda.com/community-code-of-conduct/\r\n\r\nFor conda issues, you should open an issue at https://github.com/conda/conda/issues\r\nFor Anaconda issues, you should open an issue at https://github.com/ContinuumIO/anaconda-issues/issues\r\nFor an issue with a particular conda-forge package, you should open an issue on the \r\ncorresponding feedstock: https://github.com/conda-forge\r\n-->\r\n\r\n### Actual Behavior\r\n\r\nIf you use the `provide` function and a patch cannot be applied to the source, conda build calls `sys.exit`.\r\n\r\nSee https://github.com/conda/conda-build/blob/master/conda_build/source.py#L615\r\n\r\n<!-- What actually happens? -->\r\n\r\n### Expected Behavior\r\n\r\nconda-build should raise a suitable error.\r\n\r\n<!-- What do you think should happen? -->\r\n\r\n### Steps to Reproduce\r\n\r\n<!-- Steps to reproduce issue. -->\r\n\r\n\r\n##### `Output of conda info`\r\n\r\nThis happens for the latest version of conda build in my CI jobs so I do not have the info output.\r\n\r\n<!-- Between the ticks below, paste the output of 'conda info' -->\r\n```\r\n\r\n```\r\n\r\ncc @mingwandroid @isuruf @scopatz @CJ-Wright \r\n\r\n\n", "before_files": [{"content": "from __future__ import absolute_import, division, print_function\n\nimport io\nimport locale\nimport os\nfrom os.path import join, isdir, isfile, abspath, basename, exists, normpath, expanduser\nimport re\nimport shutil\nfrom subprocess import CalledProcessError\nimport sys\nimport time\n\nfrom .conda_interface import download, TemporaryDirectory\nfrom .conda_interface import hashsum_file\n\nfrom conda_build.os_utils import external\nfrom conda_build.conda_interface import url_path, CondaHTTPError\nfrom conda_build.utils import (decompressible_exts, tar_xf, safe_print_unicode, copy_into, on_win, ensure_list,\n check_output_env, check_call_env, convert_path_for_cygwin_or_msys2,\n get_logger, rm_rf, LoggingContext)\n\n\nif on_win:\n from conda_build.utils import convert_unix_path_to_win\n\nif sys.version_info[0] == 3:\n from urllib.parse import urljoin\nelse:\n from urlparse import urljoin\n\ngit_submod_re = re.compile(r'(?:.+)\\.(.+)\\.(?:.+)\\s(.+)')\next_re = re.compile(r\"(.*?)(\\.(?:tar\\.)?[^.]+)$\")\n\n\ndef append_hash_to_fn(fn, hash_value):\n return ext_re.sub(r\"\\1_{}\\2\".format(hash_value[:10]), fn)\n\n\ndef download_to_cache(cache_folder, recipe_path, source_dict, verbose=False):\n ''' Download a source to the local cache. '''\n log = get_logger(__name__)\n if verbose:\n log.info('Source cache directory is: %s' % cache_folder)\n if not isdir(cache_folder) and not os.path.islink(cache_folder):\n os.makedirs(cache_folder)\n\n source_urls = source_dict['url']\n if not isinstance(source_urls, list):\n source_urls = [source_urls]\n unhashed_fn = fn = source_dict['fn'] if 'fn' in source_dict else basename(source_urls[0])\n hash_added = False\n for hash_type in ('md5', 'sha1', 'sha256'):\n if hash_type in source_dict:\n if source_dict[hash_type] in (None, \"\"):\n raise ValueError('Empty {} hash provided for {}'.format(hash_type, fn))\n fn = append_hash_to_fn(fn, source_dict[hash_type])\n hash_added = True\n break\n else:\n log.warn(\"No hash (md5, sha1, sha256) provided for {}. Source download forced. \"\n \"Add hash to recipe to use source cache.\".format(unhashed_fn))\n path = join(cache_folder, fn)\n if isfile(path):\n if verbose:\n log.info('Found source in cache: %s' % fn)\n else:\n if verbose:\n log.info('Downloading source to cache: %s' % fn)\n\n for url in source_urls:\n if \"://\" not in url:\n if url.startswith('~'):\n url = expanduser(url)\n if not os.path.isabs(url):\n url = os.path.normpath(os.path.join(recipe_path, url))\n url = url_path(url)\n else:\n if url.startswith('file:///~'):\n url = 'file:///' + expanduser(url[8:]).replace('\\\\', '/')\n try:\n if verbose:\n log.info(\"Downloading %s\" % url)\n with LoggingContext():\n download(url, path)\n except CondaHTTPError as e:\n log.warn(\"Error: %s\" % str(e).strip())\n rm_rf(path)\n except RuntimeError as e:\n log.warn(\"Error: %s\" % str(e).strip())\n rm_rf(path)\n else:\n if verbose:\n log.info(\"Success\")\n break\n else: # no break\n rm_rf(path)\n raise RuntimeError(\"Could not download %s\" % url)\n\n hashed = None\n for tp in ('md5', 'sha1', 'sha256'):\n if tp in source_dict:\n expected_hash = source_dict[tp]\n hashed = hashsum_file(path, tp)\n if expected_hash != hashed:\n rm_rf(path)\n raise RuntimeError(\"%s mismatch: '%s' != '%s'\" %\n (tp.upper(), hashed, expected_hash))\n break\n\n # this is really a fallback. If people don't provide the hash, we still need to prevent\n # collisions in our source cache, but the end user will get no benefirt from the cache.\n if not hash_added:\n if not hashed:\n hashed = hashsum_file(path, 'sha256')\n dest_path = append_hash_to_fn(path, hashed)\n if not os.path.isfile(dest_path):\n shutil.move(path, dest_path)\n path = dest_path\n\n return path, unhashed_fn\n\n\ndef hoist_single_extracted_folder(nested_folder):\n \"\"\"Moves all files/folders one level up.\n\n This is for when your archive extracts into its own folder, so that we don't need to\n know exactly what that folder is called.\"\"\"\n parent = os.path.dirname(nested_folder)\n flist = os.listdir(nested_folder)\n with TemporaryDirectory() as tmpdir:\n for entry in flist:\n shutil.move(os.path.join(nested_folder, entry), os.path.join(tmpdir, entry))\n rm_rf(nested_folder)\n for entry in flist:\n shutil.move(os.path.join(tmpdir, entry), os.path.join(parent, entry))\n\n\ndef unpack(source_dict, src_dir, cache_folder, recipe_path, croot, verbose=False,\n timeout=900, locking=True):\n ''' Uncompress a downloaded source. '''\n src_path, unhashed_fn = download_to_cache(cache_folder, recipe_path, source_dict, verbose)\n\n if not isdir(src_dir):\n os.makedirs(src_dir)\n if verbose:\n print(\"Extracting download\")\n with TemporaryDirectory(dir=croot) as tmpdir:\n unhashed_dest = os.path.join(tmpdir, unhashed_fn)\n if src_path.lower().endswith(decompressible_exts):\n tar_xf(src_path, tmpdir)\n else:\n # In this case, the build script will need to deal with unpacking the source\n print(\"Warning: Unrecognized source format. Source file will be copied to the SRC_DIR\")\n copy_into(src_path, unhashed_dest, timeout, locking=locking)\n if src_path.lower().endswith('.whl'):\n # copy wheel itself *and* unpack it\n # This allows test_files or about.license_file to locate files in the wheel,\n # as well as `pip install name-version.whl` as install command\n copy_into(src_path, unhashed_dest, timeout, locking=locking)\n flist = os.listdir(tmpdir)\n folder = os.path.join(tmpdir, flist[0])\n # Hoisting is destructive of information, in CDT packages, a single top level\n # folder of /usr64 must not be discarded.\n if len(flist) == 1 and os.path.isdir(folder) and 'no_hoist' not in source_dict:\n hoist_single_extracted_folder(folder)\n flist = os.listdir(tmpdir)\n for f in flist:\n shutil.move(os.path.join(tmpdir, f), os.path.join(src_dir, f))\n\n\ndef git_mirror_checkout_recursive(git, mirror_dir, checkout_dir, git_url, git_cache, git_ref=None,\n git_depth=-1, is_top_level=True, verbose=True):\n \"\"\" Mirror (and checkout) a Git repository recursively.\n\n It's not possible to use `git submodule` on a bare\n repository, so the checkout must be done before we\n know which submodules there are.\n\n Worse, submodules can be identified by using either\n absolute URLs or relative paths. If relative paths\n are used those need to be relocated upon mirroring,\n but you could end up with `../../../../blah` and in\n that case conda-build could be tricked into writing\n to the root of the drive and overwriting the system\n folders unless steps are taken to prevent that.\n \"\"\"\n\n if verbose:\n stdout = None\n stderr = None\n else:\n FNULL = open(os.devnull, 'w')\n stdout = FNULL\n stderr = FNULL\n\n if not mirror_dir.startswith(git_cache + os.sep):\n sys.exit(\"Error: Attempting to mirror to %s which is outside of GIT_CACHE %s\"\n % (mirror_dir, git_cache))\n\n # This is necessary for Cygwin git and m2-git, although it is fixed in newer MSYS2.\n git_mirror_dir = convert_path_for_cygwin_or_msys2(git, mirror_dir).rstrip('/')\n git_checkout_dir = convert_path_for_cygwin_or_msys2(git, checkout_dir).rstrip('/')\n\n # Set default here to catch empty dicts\n git_ref = git_ref or 'HEAD'\n\n mirror_dir = mirror_dir.rstrip('/')\n if not isdir(os.path.dirname(mirror_dir)):\n os.makedirs(os.path.dirname(mirror_dir))\n if isdir(mirror_dir):\n try:\n if git_ref != 'HEAD':\n check_call_env([git, 'fetch'], cwd=mirror_dir, stdout=stdout, stderr=stderr)\n else:\n # Unlike 'git clone', fetch doesn't automatically update the cache's HEAD,\n # So here we explicitly store the remote HEAD in the cache's local refs/heads,\n # and then explicitly set the cache's HEAD.\n # This is important when the git repo is a local path like \"git_url: ../\",\n # but the user is working with a branch other than 'master' without\n # explicitly providing git_rev.\n check_call_env([git, 'fetch', 'origin', '+HEAD:_conda_cache_origin_head'],\n cwd=mirror_dir, stdout=stdout, stderr=stderr)\n check_call_env([git, 'symbolic-ref', 'HEAD', 'refs/heads/_conda_cache_origin_head'],\n cwd=mirror_dir, stdout=stdout, stderr=stderr)\n except CalledProcessError:\n msg = (\"Failed to update local git cache. \"\n \"Deleting local cached repo: {} \".format(mirror_dir))\n print(msg)\n\n # Maybe the failure was caused by a corrupt mirror directory.\n # Delete it so the user can try again.\n shutil.rmtree(mirror_dir)\n raise\n else:\n args = [git, 'clone', '--mirror']\n if git_depth > 0:\n args += ['--depth', str(git_depth)]\n try:\n check_call_env(args + [git_url, git_mirror_dir], stdout=stdout, stderr=stderr)\n except CalledProcessError:\n # on windows, remote URL comes back to us as cygwin or msys format. Python doesn't\n # know how to normalize it. Need to convert it to a windows path.\n if sys.platform == 'win32' and git_url.startswith('/'):\n git_url = convert_unix_path_to_win(git_url)\n\n if os.path.exists(git_url):\n # Local filepaths are allowed, but make sure we normalize them\n git_url = normpath(git_url)\n check_call_env(args + [git_url, git_mirror_dir], stdout=stdout, stderr=stderr)\n assert isdir(mirror_dir)\n\n # Now clone from mirror_dir into checkout_dir.\n check_call_env([git, 'clone', git_mirror_dir, git_checkout_dir], stdout=stdout, stderr=stderr)\n if is_top_level:\n checkout = git_ref\n if git_url.startswith('.'):\n output = check_output_env([git, \"rev-parse\", checkout], stdout=stdout, stderr=stderr)\n checkout = output.decode('utf-8')\n if verbose:\n print('checkout: %r' % checkout)\n if checkout:\n check_call_env([git, 'checkout', checkout],\n cwd=checkout_dir, stdout=stdout, stderr=stderr)\n\n # submodules may have been specified using relative paths.\n # Those paths are relative to git_url, and will not exist\n # relative to mirror_dir, unless we do some work to make\n # it so.\n try:\n submodules = check_output_env([git, 'config', '--file', '.gitmodules', '--get-regexp',\n 'url'], stderr=stdout, cwd=checkout_dir)\n submodules = submodules.decode('utf-8').splitlines()\n except CalledProcessError:\n submodules = []\n for submodule in submodules:\n matches = git_submod_re.match(submodule)\n if matches and matches.group(2)[0] == '.':\n submod_name = matches.group(1)\n submod_rel_path = matches.group(2)\n submod_url = urljoin(git_url + '/', submod_rel_path)\n submod_mirror_dir = os.path.normpath(\n os.path.join(mirror_dir, submod_rel_path))\n if verbose:\n print('Relative submodule %s found: url is %s, submod_mirror_dir is %s' % (\n submod_name, submod_url, submod_mirror_dir))\n with TemporaryDirectory() as temp_checkout_dir:\n git_mirror_checkout_recursive(git, submod_mirror_dir, temp_checkout_dir, submod_url,\n git_cache=git_cache, git_ref=git_ref,\n git_depth=git_depth, is_top_level=False,\n verbose=verbose)\n\n if is_top_level:\n # Now that all relative-URL-specified submodules are locally mirrored to\n # relatively the same place we can go ahead and checkout the submodules.\n check_call_env([git, 'submodule', 'update', '--init',\n '--recursive'], cwd=checkout_dir, stdout=stdout, stderr=stderr)\n git_info(checkout_dir, verbose=verbose)\n if not verbose:\n FNULL.close()\n\n\ndef git_source(source_dict, git_cache, src_dir, recipe_path=None, verbose=True):\n ''' Download a source from a Git repo (or submodule, recursively) '''\n if not isdir(git_cache):\n os.makedirs(git_cache)\n\n git = external.find_executable('git')\n if not git:\n sys.exit(\"Error: git is not installed in your root environment or as a build requirement.\")\n\n git_depth = int(source_dict.get('git_depth', -1))\n git_ref = source_dict.get('git_rev') or 'HEAD'\n\n git_url = source_dict['git_url']\n if git_url.startswith('~'):\n git_url = os.path.expanduser(git_url)\n if git_url.startswith('.'):\n # It's a relative path from the conda recipe\n git_url = abspath(normpath(os.path.join(recipe_path, git_url)))\n if sys.platform == 'win32':\n git_dn = git_url.replace(':', '_')\n else:\n git_dn = git_url[1:]\n else:\n git_dn = git_url.split('://')[-1].replace('/', os.sep)\n if git_dn.startswith(os.sep):\n git_dn = git_dn[1:]\n git_dn = git_dn.replace(':', '_')\n mirror_dir = join(git_cache, git_dn)\n git_mirror_checkout_recursive(\n git, mirror_dir, src_dir, git_url, git_cache=git_cache, git_ref=git_ref,\n git_depth=git_depth, is_top_level=True, verbose=verbose)\n return git\n\n\ndef git_info(src_dir, verbose=True, fo=None):\n ''' Print info about a Git repo. '''\n assert isdir(src_dir)\n\n git = external.find_executable('git')\n if not git:\n log = get_logger(__name__)\n log.warn(\"git not installed in root environment. Skipping recording of git info.\")\n return\n\n if verbose:\n stderr = None\n else:\n FNULL = open(os.devnull, 'w')\n stderr = FNULL\n\n # Ensure to explicitly set GIT_DIR as some Linux machines will not\n # properly execute without it.\n env = os.environ.copy()\n env['GIT_DIR'] = join(src_dir, '.git')\n env = {str(key): str(value) for key, value in env.items()}\n for cmd, check_error in [\n ('git log -n1', True),\n ('git describe --tags --dirty', False),\n ('git status', True)]:\n try:\n stdout = check_output_env(cmd.split(), stderr=stderr, cwd=src_dir, env=env)\n except CalledProcessError as e:\n if check_error:\n raise Exception(\"git error: %s\" % str(e))\n encoding = locale.getpreferredencoding()\n if not fo:\n encoding = sys.stdout.encoding\n encoding = encoding or 'utf-8'\n if hasattr(stdout, 'decode'):\n stdout = stdout.decode(encoding, 'ignore')\n if fo:\n fo.write(u'==> %s <==\\n' % cmd)\n if verbose:\n fo.write(stdout + u'\\n')\n else:\n if verbose:\n print(u'==> %s <==\\n' % cmd)\n safe_print_unicode(stdout + u'\\n')\n\n\ndef hg_source(source_dict, src_dir, hg_cache, verbose):\n ''' Download a source from Mercurial repo. '''\n if verbose:\n stdout = None\n stderr = None\n else:\n FNULL = open(os.devnull, 'w')\n stdout = FNULL\n stderr = FNULL\n\n hg_url = source_dict['hg_url']\n if not isdir(hg_cache):\n os.makedirs(hg_cache)\n hg_dn = hg_url.split(':')[-1].replace('/', '_')\n cache_repo = join(hg_cache, hg_dn)\n if isdir(cache_repo):\n check_call_env(['hg', 'pull'], cwd=cache_repo, stdout=stdout, stderr=stderr)\n else:\n check_call_env(['hg', 'clone', hg_url, cache_repo], stdout=stdout, stderr=stderr)\n assert isdir(cache_repo)\n\n # now clone in to work directory\n update = source_dict.get('hg_tag') or 'tip'\n if verbose:\n print('checkout: %r' % update)\n\n check_call_env(['hg', 'clone', cache_repo, src_dir], stdout=stdout,\n stderr=stderr)\n check_call_env(['hg', 'update', '-C', update], cwd=src_dir, stdout=stdout,\n stderr=stderr)\n\n if not verbose:\n FNULL.close()\n\n return src_dir\n\n\ndef svn_source(source_dict, src_dir, svn_cache, verbose=True, timeout=900, locking=True):\n ''' Download a source from SVN repo. '''\n if verbose:\n stdout = None\n stderr = None\n else:\n FNULL = open(os.devnull, 'w')\n stdout = FNULL\n stderr = FNULL\n\n def parse_bool(s):\n return str(s).lower().strip() in ('yes', 'true', '1', 'on')\n\n svn_url = source_dict['svn_url']\n svn_revision = source_dict.get('svn_rev') or 'head'\n svn_ignore_externals = parse_bool(source_dict.get('svn_ignore_externals') or 'no')\n if not isdir(svn_cache):\n os.makedirs(svn_cache)\n svn_dn = svn_url.split(':', 1)[-1].replace('/', '_').replace(':', '_')\n cache_repo = join(svn_cache, svn_dn)\n if svn_ignore_externals:\n extra_args = ['--ignore-externals']\n else:\n extra_args = []\n if isdir(cache_repo):\n check_call_env(['svn', 'up', '-r', svn_revision] + extra_args, cwd=cache_repo,\n stdout=stdout, stderr=stderr)\n else:\n check_call_env(['svn', 'co', '-r', svn_revision] + extra_args + [svn_url, cache_repo],\n stdout=stdout, stderr=stderr)\n assert isdir(cache_repo)\n\n # now copy into work directory\n copy_into(cache_repo, src_dir, timeout, symlinks=True, locking=locking)\n\n if not verbose:\n FNULL.close()\n\n return src_dir\n\n\ndef get_repository_info(recipe_path):\n \"\"\"This tries to get information about where a recipe came from. This is different\n from the source - you can have a recipe in svn that gets source via git.\"\"\"\n try:\n if exists(join(recipe_path, \".git\")):\n origin = check_output_env([\"git\", \"config\", \"--get\", \"remote.origin.url\"],\n cwd=recipe_path)\n rev = check_output_env([\"git\", \"rev-parse\", \"HEAD\"], cwd=recipe_path)\n return \"Origin {}, commit {}\".format(origin, rev)\n elif isdir(join(recipe_path, \".hg\")):\n origin = check_output_env([\"hg\", \"paths\", \"default\"], cwd=recipe_path)\n rev = check_output_env([\"hg\", \"id\"], cwd=recipe_path).split()[0]\n return \"Origin {}, commit {}\".format(origin, rev)\n elif isdir(join(recipe_path, \".svn\")):\n info = check_output_env([\"svn\", \"info\"], cwd=recipe_path)\n info = info.decode(\"utf-8\") # Py3 returns a byte string, but re needs unicode or str.\n server = re.search(\"Repository Root: (.*)$\", info, flags=re.M).group(1)\n revision = re.search(\"Revision: (.*)$\", info, flags=re.M).group(1)\n return \"{}, Revision {}\".format(server, revision)\n else:\n return \"{}, last modified {}\".format(recipe_path,\n time.ctime(os.path.getmtime(\n join(recipe_path, \"meta.yaml\"))))\n except CalledProcessError:\n get_logger(__name__).debug(\"Failed to checkout source in \" + recipe_path)\n return \"{}, last modified {}\".format(recipe_path,\n time.ctime(os.path.getmtime(\n join(recipe_path, \"meta.yaml\"))))\n\n\ndef _ensure_unix_line_endings(path):\n \"\"\"Replace windows line endings with Unix. Return path to modified file.\"\"\"\n out_path = path + \"_unix\"\n with open(path, \"rb\") as inputfile:\n with open(out_path, \"wb\") as outputfile:\n for line in inputfile:\n outputfile.write(line.replace(b\"\\r\\n\", b\"\\n\"))\n return out_path\n\n\ndef _ensure_win_line_endings(path):\n \"\"\"Replace unix line endings with win. Return path to modified file.\"\"\"\n out_path = path + \"_win\"\n with open(path, \"rb\") as inputfile:\n with open(out_path, \"wb\") as outputfile:\n for line in inputfile:\n outputfile.write(line.replace(b\"\\n\", b\"\\r\\n\"))\n return out_path\n\n\ndef _guess_patch_strip_level(filesstr, src_dir):\n \"\"\" Determine the patch strip level automatically. \"\"\"\n maxlevel = None\n files = {filestr.encode(errors='ignore') for filestr in filesstr}\n src_dir = src_dir.encode(errors='ignore')\n for file in files:\n numslash = file.count(b'/')\n maxlevel = numslash if maxlevel is None else min(maxlevel, numslash)\n if maxlevel == 0:\n patchlevel = 0\n else:\n histo = dict()\n histo = {i: 0 for i in range(maxlevel + 1)}\n for file in files:\n parts = file.split(b'/')\n for level in range(maxlevel + 1):\n if os.path.exists(join(src_dir, *parts[-len(parts) + level:])):\n histo[level] += 1\n order = sorted(histo, key=histo.get, reverse=True)\n if histo[order[0]] == histo[order[1]]:\n print(\"Patch level ambiguous, selecting least deep\")\n patchlevel = min([key for key, value\n in histo.items() if value == histo[order[0]]])\n return patchlevel\n\n\ndef _get_patch_file_details(path):\n re_files = re.compile(r'^(?:---|\\+\\+\\+) ([^\\n\\t]+)')\n files = set()\n with io.open(path, errors='ignore') as f:\n files = []\n first_line = True\n is_git_format = True\n for line in f.readlines():\n if first_line and not re.match(r'From [0-9a-f]{40}', line):\n is_git_format = False\n first_line = False\n m = re_files.search(line)\n if m and m.group(1) != '/dev/null':\n files.append(m.group(1))\n elif is_git_format and line.startswith('git') and not line.startswith('git --diff'):\n is_git_format = False\n return (files, is_git_format)\n\n\ndef apply_patch(src_dir, path, config, git=None):\n def patch_or_reverse(patch, patch_args, cwd, stdout, stderr):\n # An old reference: https://unix.stackexchange.com/a/243748/34459\n #\n # I am worried that '--ignore-whitespace' may be destructive. If so we should\n # avoid passing it, particularly in the initial (most likely to succeed) calls.\n #\n # From here-in I define a 'native' patch as one which has:\n # 1. LF for the patch block metadata.\n # 2. CRLF or LF for the actual patched lines matching those of the source lines.\n #\n # Calls to a raw 'patch' are destructive in various ways:\n # 1. It leaves behind .rej and .orig files\n # 2. If you pass it a patch with incorrect CRLF changes and do not pass --binary and\n # if any of those blocks *can* be applied, then the whole file gets written out with\n # LF. This cannot be reversed either; the text changes will be reversed but not\n # line-feed changes (since all line-endings get changed, not just those of the of\n # patched lines)\n # 3. If patching fails, the bits that succeeded remain, so patching is not at all\n # atomic.\n #\n # Still, we do our best to mitigate all of this as follows:\n # 1. We disable .orig and .rej that for GNU patch via a temp file *\n # 2 (1). We check for native application of a native patch (--binary, without --ignore-whitespace)\n # 2 (2). We defer destructive calls to this until after the non-destructive ones.\n # 3. When patch indicates failure, we call it with -R to reverse the damage.\n #\n # * Some may bemoan the loss of these, but they it is fairly random which patch and patch\n # attempt they apply to so their informational value is low, besides that, they are ugly.\n # (and destructive to the future patchability of the source tree).\n #\n import tempfile\n temp_name = os.path.join(tempfile.gettempdir(), next(tempfile._get_candidate_names()))\n patch_args.append('-r')\n patch_args.append(temp_name)\n patch_args = ['--no-backup-if-mismatch', '--batch'] + patch_args\n log = get_logger(__name__)\n try:\n log.debug(\"Applying with\\n{} {}\".format(patch, patch_args))\n check_call_env([patch] + patch_args, cwd=cwd, stdout=stdout, stderr=stderr)\n # You can use this to pretend the patch failed so as to test reversal!\n # raise CalledProcessError(-1, ' '.join([patch] + patch_args))\n except Exception as e:\n try:\n if '--ignore-whitespace' in patch_args:\n patch_args.remove('--ignore-whitespace')\n patch_args.insert(0, '-R')\n patch_args.append('--binary')\n patch_args.append('--force')\n log.debug(\"Reversing with\\n{} {}\".format(patch, patch_args))\n check_call_env([patch] + patch_args, cwd=cwd, stdout=stdout, stderr=stderr)\n except:\n pass\n raise e\n finally:\n if os.path.exists(temp_name):\n os.unlink(temp_name)\n\n exception = None\n if not isfile(path):\n sys.exit('Error: no such patch: %s' % path)\n\n if config.verbose:\n stdout = None\n stderr = None\n else:\n FNULL = open(os.devnull, 'w')\n stdout = FNULL\n stderr = FNULL\n\n files, is_git_format = _get_patch_file_details(path)\n if git and is_git_format:\n # Prevents git from asking interactive questions,\n # also necessary to achieve sha1 reproducibility;\n # as is --committer-date-is-author-date. By this,\n # we mean a round-trip of git am/git format-patch\n # gives the same file.\n git_env = os.environ\n git_env['GIT_COMMITTER_NAME'] = 'conda-build'\n git_env['GIT_COMMITTER_EMAIL'] = '[email protected]'\n check_call_env([git, 'am', '-3', '--committer-date-is-author-date', path],\n cwd=src_dir, stdout=stdout, stderr=stderr, env=git_env)\n config.git_commits_since_tag += 1\n else:\n if config.verbose:\n print('Applying patch: %r' % path)\n patch = external.find_executable('patch', config.build_prefix)\n if patch is None or len(patch) == 0:\n sys.exit(\"\"\"\\\n Error:\n Cannot use 'git' (not a git repo and/or patch) and did not find 'patch' in: %s\n You can install 'patch' using apt-get, yum (Linux), Xcode (MacOSX),\n or conda, m2-patch (Windows),\n \"\"\" % (os.pathsep.join(external.dir_paths)))\n patch_strip_level = _guess_patch_strip_level(files, src_dir)\n path_args = ['-i', path]\n patch_args = ['-p%d' % patch_strip_level]\n\n try:\n log = get_logger(__name__)\n # This is the case we check first of all as it is the case that allows a properly line-ended\n # patch to apply correctly to a properly line-ended source tree, modifying it following the\n # patch chunks exactly.\n patch_or_reverse(patch, patch_args + ['--binary'] + path_args,\n cwd=src_dir, stdout=stdout, stderr=stderr)\n except CalledProcessError as e:\n # Capture the first exception\n exception = e\n if config.verbose:\n log.info(\"Applying patch natively failed. \"\n \"Trying to apply patch non-binary with --ignore-whitespace\")\n try:\n patch_or_reverse(patch, patch_args + ['--ignore-whitespace'] + path_args,\n cwd=src_dir, stdout=stdout, stderr=stderr)\n except CalledProcessError as e: # noqa\n unix_ending_file = _ensure_unix_line_endings(path)\n path_args[-1] = unix_ending_file\n try:\n if config.verbose:\n log.info(\"Applying natively *and* non-binary failed! \"\n \"Converting to unix line endings and trying again. \"\n \"WARNING :: This is destructive to the source file line-endings.\")\n # If this succeeds, it will change the source files' CRLFs to LFs. This can\n # mess things up both for subsequent attempts (this line-ending change is not\n # reversible) but worse, for subsequent, correctly crafted (I'm calling these\n # \"native\" from now on) patches.\n patch_or_reverse(patch, patch_args + ['--ignore-whitespace'] + path_args,\n cwd=src_dir, stdout=stdout, stderr=stderr)\n except CalledProcessError:\n if config.verbose:\n log.warning(\"Applying natively, non-binary *and* unix attempts all failed!? \"\n \"Converting to CRLF line endings and trying again with \"\n \"--ignore-whitespace and --binary. This can be destructive (even\"\n \"with attempted reversal) to the source files' line-endings.\")\n win_ending_file = _ensure_win_line_endings(path)\n path_args[-1] = win_ending_file\n try:\n patch_or_reverse(patch, patch_args + ['--ignore-whitespace', '--binary'] + path_args,\n cwd=src_dir, stdout=stdout, stderr=stderr)\n except:\n pass\n else:\n exception = None\n finally:\n if os.path.exists(win_ending_file):\n os.remove(win_ending_file) # clean up .patch_unix file\n else:\n exception = None\n finally:\n if os.path.exists(unix_ending_file):\n os.remove(unix_ending_file)\n if exception:\n raise exception\n\n\ndef provide(metadata):\n \"\"\"\n given a recipe_dir:\n - download (if necessary)\n - unpack\n - apply patches (if any)\n \"\"\"\n meta = metadata.get_section('source')\n if not os.path.isdir(metadata.config.build_folder):\n os.makedirs(metadata.config.build_folder)\n git = None\n\n if hasattr(meta, 'keys'):\n dicts = [meta]\n else:\n dicts = meta\n\n try:\n for source_dict in dicts:\n folder = source_dict.get('folder')\n src_dir = os.path.join(metadata.config.work_dir, folder if folder else '')\n if any(k in source_dict for k in ('fn', 'url')):\n unpack(source_dict, src_dir, metadata.config.src_cache, recipe_path=metadata.path,\n croot=metadata.config.croot, verbose=metadata.config.verbose,\n timeout=metadata.config.timeout, locking=metadata.config.locking)\n elif 'git_url' in source_dict:\n git = git_source(source_dict, metadata.config.git_cache, src_dir, metadata.path,\n verbose=metadata.config.verbose)\n # build to make sure we have a work directory with source in it. We\n # want to make sure that whatever version that is does not\n # interfere with the test we run next.\n elif 'hg_url' in source_dict:\n hg_source(source_dict, src_dir, metadata.config.hg_cache,\n verbose=metadata.config.verbose)\n elif 'svn_url' in source_dict:\n svn_source(source_dict, src_dir, metadata.config.svn_cache,\n verbose=metadata.config.verbose, timeout=metadata.config.timeout,\n locking=metadata.config.locking)\n elif 'path' in source_dict:\n source_path = os.path.expanduser(source_dict['path'])\n path = normpath(abspath(join(metadata.path, source_path)))\n path_via_symlink = 'path_via_symlink' in source_dict\n if path_via_symlink and not folder:\n print(\"WARNING: `path_via_symlink` is too dangerous without specifying a folder,\\n\"\n \" conda could end up changing - or deleting - your local source code!\\n\"\n \" Going to make copies instead. When using `path_via_symlink` you should\\n\"\n \" also take care to run the build outside of your local source code folder(s)\\n\"\n \" unless that is your intention.\")\n path_via_symlink = False\n sys.exit(1)\n if path_via_symlink:\n src_dir_symlink = os.path.dirname(src_dir)\n if not isdir(src_dir_symlink):\n os.makedirs(src_dir_symlink)\n if metadata.config.verbose:\n print(\"Creating sybmolic link pointing to %s at %s\" % (path, src_dir))\n os.symlink(path, src_dir)\n else:\n if metadata.config.verbose:\n print(\"Copying %s to %s\" % (path, src_dir))\n # careful here: we set test path to be outside of conda-build root in setup.cfg.\n # If you don't do that, this is a recursive function\n copy_into(path, src_dir, metadata.config.timeout, symlinks=True,\n locking=metadata.config.locking, clobber=True)\n else: # no source\n if not isdir(src_dir):\n os.makedirs(src_dir)\n\n patches = ensure_list(source_dict.get('patches', []))\n for patch in patches:\n apply_patch(src_dir, join(metadata.path, patch), metadata.config, git)\n\n except CalledProcessError:\n shutil.move(metadata.config.work_dir, metadata.config.work_dir + '_failed_provide')\n raise\n\n return metadata.config.work_dir\n", "path": "conda_build/source.py"}], "after_files": [{"content": "from __future__ import absolute_import, division, print_function\n\nimport io\nimport locale\nimport os\nfrom os.path import join, isdir, isfile, abspath, basename, exists, normpath, expanduser\nimport re\nimport shutil\nfrom subprocess import CalledProcessError\nimport sys\nimport time\n\nfrom .conda_interface import download, TemporaryDirectory\nfrom .conda_interface import hashsum_file\n\nfrom conda_build.os_utils import external\nfrom conda_build.conda_interface import url_path, CondaHTTPError\nfrom conda_build.utils import (decompressible_exts, tar_xf, safe_print_unicode, copy_into, on_win, ensure_list,\n check_output_env, check_call_env, convert_path_for_cygwin_or_msys2,\n get_logger, rm_rf, LoggingContext)\n\n\nif on_win:\n from conda_build.utils import convert_unix_path_to_win\n\nif sys.version_info[0] == 3:\n from urllib.parse import urljoin\nelse:\n from urlparse import urljoin\n\ngit_submod_re = re.compile(r'(?:.+)\\.(.+)\\.(?:.+)\\s(.+)')\next_re = re.compile(r\"(.*?)(\\.(?:tar\\.)?[^.]+)$\")\n\n\ndef append_hash_to_fn(fn, hash_value):\n return ext_re.sub(r\"\\1_{}\\2\".format(hash_value[:10]), fn)\n\n\ndef download_to_cache(cache_folder, recipe_path, source_dict, verbose=False):\n ''' Download a source to the local cache. '''\n log = get_logger(__name__)\n if verbose:\n log.info('Source cache directory is: %s' % cache_folder)\n if not isdir(cache_folder) and not os.path.islink(cache_folder):\n os.makedirs(cache_folder)\n\n source_urls = source_dict['url']\n if not isinstance(source_urls, list):\n source_urls = [source_urls]\n unhashed_fn = fn = source_dict['fn'] if 'fn' in source_dict else basename(source_urls[0])\n hash_added = False\n for hash_type in ('md5', 'sha1', 'sha256'):\n if hash_type in source_dict:\n if source_dict[hash_type] in (None, \"\"):\n raise ValueError('Empty {} hash provided for {}'.format(hash_type, fn))\n fn = append_hash_to_fn(fn, source_dict[hash_type])\n hash_added = True\n break\n else:\n log.warn(\"No hash (md5, sha1, sha256) provided for {}. Source download forced. \"\n \"Add hash to recipe to use source cache.\".format(unhashed_fn))\n path = join(cache_folder, fn)\n if isfile(path):\n if verbose:\n log.info('Found source in cache: %s' % fn)\n else:\n if verbose:\n log.info('Downloading source to cache: %s' % fn)\n\n for url in source_urls:\n if \"://\" not in url:\n if url.startswith('~'):\n url = expanduser(url)\n if not os.path.isabs(url):\n url = os.path.normpath(os.path.join(recipe_path, url))\n url = url_path(url)\n else:\n if url.startswith('file:///~'):\n url = 'file:///' + expanduser(url[8:]).replace('\\\\', '/')\n try:\n if verbose:\n log.info(\"Downloading %s\" % url)\n with LoggingContext():\n download(url, path)\n except CondaHTTPError as e:\n log.warn(\"Error: %s\" % str(e).strip())\n rm_rf(path)\n except RuntimeError as e:\n log.warn(\"Error: %s\" % str(e).strip())\n rm_rf(path)\n else:\n if verbose:\n log.info(\"Success\")\n break\n else: # no break\n rm_rf(path)\n raise RuntimeError(\"Could not download %s\" % url)\n\n hashed = None\n for tp in ('md5', 'sha1', 'sha256'):\n if tp in source_dict:\n expected_hash = source_dict[tp]\n hashed = hashsum_file(path, tp)\n if expected_hash != hashed:\n rm_rf(path)\n raise RuntimeError(\"%s mismatch: '%s' != '%s'\" %\n (tp.upper(), hashed, expected_hash))\n break\n\n # this is really a fallback. If people don't provide the hash, we still need to prevent\n # collisions in our source cache, but the end user will get no benefirt from the cache.\n if not hash_added:\n if not hashed:\n hashed = hashsum_file(path, 'sha256')\n dest_path = append_hash_to_fn(path, hashed)\n if not os.path.isfile(dest_path):\n shutil.move(path, dest_path)\n path = dest_path\n\n return path, unhashed_fn\n\n\ndef hoist_single_extracted_folder(nested_folder):\n \"\"\"Moves all files/folders one level up.\n\n This is for when your archive extracts into its own folder, so that we don't need to\n know exactly what that folder is called.\"\"\"\n parent = os.path.dirname(nested_folder)\n flist = os.listdir(nested_folder)\n with TemporaryDirectory() as tmpdir:\n for entry in flist:\n shutil.move(os.path.join(nested_folder, entry), os.path.join(tmpdir, entry))\n rm_rf(nested_folder)\n for entry in flist:\n shutil.move(os.path.join(tmpdir, entry), os.path.join(parent, entry))\n\n\ndef unpack(source_dict, src_dir, cache_folder, recipe_path, croot, verbose=False,\n timeout=900, locking=True):\n ''' Uncompress a downloaded source. '''\n src_path, unhashed_fn = download_to_cache(cache_folder, recipe_path, source_dict, verbose)\n\n if not isdir(src_dir):\n os.makedirs(src_dir)\n if verbose:\n print(\"Extracting download\")\n with TemporaryDirectory(dir=croot) as tmpdir:\n unhashed_dest = os.path.join(tmpdir, unhashed_fn)\n if src_path.lower().endswith(decompressible_exts):\n tar_xf(src_path, tmpdir)\n else:\n # In this case, the build script will need to deal with unpacking the source\n print(\"Warning: Unrecognized source format. Source file will be copied to the SRC_DIR\")\n copy_into(src_path, unhashed_dest, timeout, locking=locking)\n if src_path.lower().endswith('.whl'):\n # copy wheel itself *and* unpack it\n # This allows test_files or about.license_file to locate files in the wheel,\n # as well as `pip install name-version.whl` as install command\n copy_into(src_path, unhashed_dest, timeout, locking=locking)\n flist = os.listdir(tmpdir)\n folder = os.path.join(tmpdir, flist[0])\n # Hoisting is destructive of information, in CDT packages, a single top level\n # folder of /usr64 must not be discarded.\n if len(flist) == 1 and os.path.isdir(folder) and 'no_hoist' not in source_dict:\n hoist_single_extracted_folder(folder)\n flist = os.listdir(tmpdir)\n for f in flist:\n shutil.move(os.path.join(tmpdir, f), os.path.join(src_dir, f))\n\n\ndef git_mirror_checkout_recursive(git, mirror_dir, checkout_dir, git_url, git_cache, git_ref=None,\n git_depth=-1, is_top_level=True, verbose=True):\n \"\"\" Mirror (and checkout) a Git repository recursively.\n\n It's not possible to use `git submodule` on a bare\n repository, so the checkout must be done before we\n know which submodules there are.\n\n Worse, submodules can be identified by using either\n absolute URLs or relative paths. If relative paths\n are used those need to be relocated upon mirroring,\n but you could end up with `../../../../blah` and in\n that case conda-build could be tricked into writing\n to the root of the drive and overwriting the system\n folders unless steps are taken to prevent that.\n \"\"\"\n\n if verbose:\n stdout = None\n stderr = None\n else:\n FNULL = open(os.devnull, 'w')\n stdout = FNULL\n stderr = FNULL\n\n if not mirror_dir.startswith(git_cache + os.sep):\n sys.exit(\"Error: Attempting to mirror to %s which is outside of GIT_CACHE %s\"\n % (mirror_dir, git_cache))\n\n # This is necessary for Cygwin git and m2-git, although it is fixed in newer MSYS2.\n git_mirror_dir = convert_path_for_cygwin_or_msys2(git, mirror_dir).rstrip('/')\n git_checkout_dir = convert_path_for_cygwin_or_msys2(git, checkout_dir).rstrip('/')\n\n # Set default here to catch empty dicts\n git_ref = git_ref or 'HEAD'\n\n mirror_dir = mirror_dir.rstrip('/')\n if not isdir(os.path.dirname(mirror_dir)):\n os.makedirs(os.path.dirname(mirror_dir))\n if isdir(mirror_dir):\n try:\n if git_ref != 'HEAD':\n check_call_env([git, 'fetch'], cwd=mirror_dir, stdout=stdout, stderr=stderr)\n else:\n # Unlike 'git clone', fetch doesn't automatically update the cache's HEAD,\n # So here we explicitly store the remote HEAD in the cache's local refs/heads,\n # and then explicitly set the cache's HEAD.\n # This is important when the git repo is a local path like \"git_url: ../\",\n # but the user is working with a branch other than 'master' without\n # explicitly providing git_rev.\n check_call_env([git, 'fetch', 'origin', '+HEAD:_conda_cache_origin_head'],\n cwd=mirror_dir, stdout=stdout, stderr=stderr)\n check_call_env([git, 'symbolic-ref', 'HEAD', 'refs/heads/_conda_cache_origin_head'],\n cwd=mirror_dir, stdout=stdout, stderr=stderr)\n except CalledProcessError:\n msg = (\"Failed to update local git cache. \"\n \"Deleting local cached repo: {} \".format(mirror_dir))\n print(msg)\n\n # Maybe the failure was caused by a corrupt mirror directory.\n # Delete it so the user can try again.\n shutil.rmtree(mirror_dir)\n raise\n else:\n args = [git, 'clone', '--mirror']\n if git_depth > 0:\n args += ['--depth', str(git_depth)]\n try:\n check_call_env(args + [git_url, git_mirror_dir], stdout=stdout, stderr=stderr)\n except CalledProcessError:\n # on windows, remote URL comes back to us as cygwin or msys format. Python doesn't\n # know how to normalize it. Need to convert it to a windows path.\n if sys.platform == 'win32' and git_url.startswith('/'):\n git_url = convert_unix_path_to_win(git_url)\n\n if os.path.exists(git_url):\n # Local filepaths are allowed, but make sure we normalize them\n git_url = normpath(git_url)\n check_call_env(args + [git_url, git_mirror_dir], stdout=stdout, stderr=stderr)\n assert isdir(mirror_dir)\n\n # Now clone from mirror_dir into checkout_dir.\n check_call_env([git, 'clone', git_mirror_dir, git_checkout_dir], stdout=stdout, stderr=stderr)\n if is_top_level:\n checkout = git_ref\n if git_url.startswith('.'):\n output = check_output_env([git, \"rev-parse\", checkout], stdout=stdout, stderr=stderr)\n checkout = output.decode('utf-8')\n if verbose:\n print('checkout: %r' % checkout)\n if checkout:\n check_call_env([git, 'checkout', checkout],\n cwd=checkout_dir, stdout=stdout, stderr=stderr)\n\n # submodules may have been specified using relative paths.\n # Those paths are relative to git_url, and will not exist\n # relative to mirror_dir, unless we do some work to make\n # it so.\n try:\n submodules = check_output_env([git, 'config', '--file', '.gitmodules', '--get-regexp',\n 'url'], stderr=stdout, cwd=checkout_dir)\n submodules = submodules.decode('utf-8').splitlines()\n except CalledProcessError:\n submodules = []\n for submodule in submodules:\n matches = git_submod_re.match(submodule)\n if matches and matches.group(2)[0] == '.':\n submod_name = matches.group(1)\n submod_rel_path = matches.group(2)\n submod_url = urljoin(git_url + '/', submod_rel_path)\n submod_mirror_dir = os.path.normpath(\n os.path.join(mirror_dir, submod_rel_path))\n if verbose:\n print('Relative submodule %s found: url is %s, submod_mirror_dir is %s' % (\n submod_name, submod_url, submod_mirror_dir))\n with TemporaryDirectory() as temp_checkout_dir:\n git_mirror_checkout_recursive(git, submod_mirror_dir, temp_checkout_dir, submod_url,\n git_cache=git_cache, git_ref=git_ref,\n git_depth=git_depth, is_top_level=False,\n verbose=verbose)\n\n if is_top_level:\n # Now that all relative-URL-specified submodules are locally mirrored to\n # relatively the same place we can go ahead and checkout the submodules.\n check_call_env([git, 'submodule', 'update', '--init',\n '--recursive'], cwd=checkout_dir, stdout=stdout, stderr=stderr)\n git_info(checkout_dir, verbose=verbose)\n if not verbose:\n FNULL.close()\n\n\ndef git_source(source_dict, git_cache, src_dir, recipe_path=None, verbose=True):\n ''' Download a source from a Git repo (or submodule, recursively) '''\n if not isdir(git_cache):\n os.makedirs(git_cache)\n\n git = external.find_executable('git')\n if not git:\n sys.exit(\"Error: git is not installed in your root environment or as a build requirement.\")\n\n git_depth = int(source_dict.get('git_depth', -1))\n git_ref = source_dict.get('git_rev') or 'HEAD'\n\n git_url = source_dict['git_url']\n if git_url.startswith('~'):\n git_url = os.path.expanduser(git_url)\n if git_url.startswith('.'):\n # It's a relative path from the conda recipe\n git_url = abspath(normpath(os.path.join(recipe_path, git_url)))\n if sys.platform == 'win32':\n git_dn = git_url.replace(':', '_')\n else:\n git_dn = git_url[1:]\n else:\n git_dn = git_url.split('://')[-1].replace('/', os.sep)\n if git_dn.startswith(os.sep):\n git_dn = git_dn[1:]\n git_dn = git_dn.replace(':', '_')\n mirror_dir = join(git_cache, git_dn)\n git_mirror_checkout_recursive(\n git, mirror_dir, src_dir, git_url, git_cache=git_cache, git_ref=git_ref,\n git_depth=git_depth, is_top_level=True, verbose=verbose)\n return git\n\n\ndef git_info(src_dir, verbose=True, fo=None):\n ''' Print info about a Git repo. '''\n assert isdir(src_dir)\n\n git = external.find_executable('git')\n if not git:\n log = get_logger(__name__)\n log.warn(\"git not installed in root environment. Skipping recording of git info.\")\n return\n\n if verbose:\n stderr = None\n else:\n FNULL = open(os.devnull, 'w')\n stderr = FNULL\n\n # Ensure to explicitly set GIT_DIR as some Linux machines will not\n # properly execute without it.\n env = os.environ.copy()\n env['GIT_DIR'] = join(src_dir, '.git')\n env = {str(key): str(value) for key, value in env.items()}\n for cmd, check_error in [\n ('git log -n1', True),\n ('git describe --tags --dirty', False),\n ('git status', True)]:\n try:\n stdout = check_output_env(cmd.split(), stderr=stderr, cwd=src_dir, env=env)\n except CalledProcessError as e:\n if check_error:\n raise Exception(\"git error: %s\" % str(e))\n encoding = locale.getpreferredencoding()\n if not fo:\n encoding = sys.stdout.encoding\n encoding = encoding or 'utf-8'\n if hasattr(stdout, 'decode'):\n stdout = stdout.decode(encoding, 'ignore')\n if fo:\n fo.write(u'==> %s <==\\n' % cmd)\n if verbose:\n fo.write(stdout + u'\\n')\n else:\n if verbose:\n print(u'==> %s <==\\n' % cmd)\n safe_print_unicode(stdout + u'\\n')\n\n\ndef hg_source(source_dict, src_dir, hg_cache, verbose):\n ''' Download a source from Mercurial repo. '''\n if verbose:\n stdout = None\n stderr = None\n else:\n FNULL = open(os.devnull, 'w')\n stdout = FNULL\n stderr = FNULL\n\n hg_url = source_dict['hg_url']\n if not isdir(hg_cache):\n os.makedirs(hg_cache)\n hg_dn = hg_url.split(':')[-1].replace('/', '_')\n cache_repo = join(hg_cache, hg_dn)\n if isdir(cache_repo):\n check_call_env(['hg', 'pull'], cwd=cache_repo, stdout=stdout, stderr=stderr)\n else:\n check_call_env(['hg', 'clone', hg_url, cache_repo], stdout=stdout, stderr=stderr)\n assert isdir(cache_repo)\n\n # now clone in to work directory\n update = source_dict.get('hg_tag') or 'tip'\n if verbose:\n print('checkout: %r' % update)\n\n check_call_env(['hg', 'clone', cache_repo, src_dir], stdout=stdout,\n stderr=stderr)\n check_call_env(['hg', 'update', '-C', update], cwd=src_dir, stdout=stdout,\n stderr=stderr)\n\n if not verbose:\n FNULL.close()\n\n return src_dir\n\n\ndef svn_source(source_dict, src_dir, svn_cache, verbose=True, timeout=900, locking=True):\n ''' Download a source from SVN repo. '''\n if verbose:\n stdout = None\n stderr = None\n else:\n FNULL = open(os.devnull, 'w')\n stdout = FNULL\n stderr = FNULL\n\n def parse_bool(s):\n return str(s).lower().strip() in ('yes', 'true', '1', 'on')\n\n svn_url = source_dict['svn_url']\n svn_revision = source_dict.get('svn_rev') or 'head'\n svn_ignore_externals = parse_bool(source_dict.get('svn_ignore_externals') or 'no')\n if not isdir(svn_cache):\n os.makedirs(svn_cache)\n svn_dn = svn_url.split(':', 1)[-1].replace('/', '_').replace(':', '_')\n cache_repo = join(svn_cache, svn_dn)\n if svn_ignore_externals:\n extra_args = ['--ignore-externals']\n else:\n extra_args = []\n if isdir(cache_repo):\n check_call_env(['svn', 'up', '-r', svn_revision] + extra_args, cwd=cache_repo,\n stdout=stdout, stderr=stderr)\n else:\n check_call_env(['svn', 'co', '-r', svn_revision] + extra_args + [svn_url, cache_repo],\n stdout=stdout, stderr=stderr)\n assert isdir(cache_repo)\n\n # now copy into work directory\n copy_into(cache_repo, src_dir, timeout, symlinks=True, locking=locking)\n\n if not verbose:\n FNULL.close()\n\n return src_dir\n\n\ndef get_repository_info(recipe_path):\n \"\"\"This tries to get information about where a recipe came from. This is different\n from the source - you can have a recipe in svn that gets source via git.\"\"\"\n try:\n if exists(join(recipe_path, \".git\")):\n origin = check_output_env([\"git\", \"config\", \"--get\", \"remote.origin.url\"],\n cwd=recipe_path)\n rev = check_output_env([\"git\", \"rev-parse\", \"HEAD\"], cwd=recipe_path)\n return \"Origin {}, commit {}\".format(origin, rev)\n elif isdir(join(recipe_path, \".hg\")):\n origin = check_output_env([\"hg\", \"paths\", \"default\"], cwd=recipe_path)\n rev = check_output_env([\"hg\", \"id\"], cwd=recipe_path).split()[0]\n return \"Origin {}, commit {}\".format(origin, rev)\n elif isdir(join(recipe_path, \".svn\")):\n info = check_output_env([\"svn\", \"info\"], cwd=recipe_path)\n info = info.decode(\"utf-8\") # Py3 returns a byte string, but re needs unicode or str.\n server = re.search(\"Repository Root: (.*)$\", info, flags=re.M).group(1)\n revision = re.search(\"Revision: (.*)$\", info, flags=re.M).group(1)\n return \"{}, Revision {}\".format(server, revision)\n else:\n return \"{}, last modified {}\".format(recipe_path,\n time.ctime(os.path.getmtime(\n join(recipe_path, \"meta.yaml\"))))\n except CalledProcessError:\n get_logger(__name__).debug(\"Failed to checkout source in \" + recipe_path)\n return \"{}, last modified {}\".format(recipe_path,\n time.ctime(os.path.getmtime(\n join(recipe_path, \"meta.yaml\"))))\n\n\ndef _ensure_unix_line_endings(path):\n \"\"\"Replace windows line endings with Unix. Return path to modified file.\"\"\"\n out_path = path + \"_unix\"\n with open(path, \"rb\") as inputfile:\n with open(out_path, \"wb\") as outputfile:\n for line in inputfile:\n outputfile.write(line.replace(b\"\\r\\n\", b\"\\n\"))\n return out_path\n\n\ndef _ensure_win_line_endings(path):\n \"\"\"Replace unix line endings with win. Return path to modified file.\"\"\"\n out_path = path + \"_win\"\n with open(path, \"rb\") as inputfile:\n with open(out_path, \"wb\") as outputfile:\n for line in inputfile:\n outputfile.write(line.replace(b\"\\n\", b\"\\r\\n\"))\n return out_path\n\n\ndef _guess_patch_strip_level(filesstr, src_dir):\n \"\"\" Determine the patch strip level automatically. \"\"\"\n maxlevel = None\n files = {filestr.encode(errors='ignore') for filestr in filesstr}\n src_dir = src_dir.encode(errors='ignore')\n for file in files:\n numslash = file.count(b'/')\n maxlevel = numslash if maxlevel is None else min(maxlevel, numslash)\n if maxlevel == 0:\n patchlevel = 0\n else:\n histo = dict()\n histo = {i: 0 for i in range(maxlevel + 1)}\n for file in files:\n parts = file.split(b'/')\n for level in range(maxlevel + 1):\n if os.path.exists(join(src_dir, *parts[-len(parts) + level:])):\n histo[level] += 1\n order = sorted(histo, key=histo.get, reverse=True)\n if histo[order[0]] == histo[order[1]]:\n print(\"Patch level ambiguous, selecting least deep\")\n patchlevel = min([key for key, value\n in histo.items() if value == histo[order[0]]])\n return patchlevel\n\n\ndef _get_patch_file_details(path):\n re_files = re.compile(r'^(?:---|\\+\\+\\+) ([^\\n\\t]+)')\n files = set()\n with io.open(path, errors='ignore') as f:\n files = []\n first_line = True\n is_git_format = True\n for line in f.readlines():\n if first_line and not re.match(r'From [0-9a-f]{40}', line):\n is_git_format = False\n first_line = False\n m = re_files.search(line)\n if m and m.group(1) != '/dev/null':\n files.append(m.group(1))\n elif is_git_format and line.startswith('git') and not line.startswith('git --diff'):\n is_git_format = False\n return (files, is_git_format)\n\n\ndef apply_patch(src_dir, path, config, git=None):\n def patch_or_reverse(patch, patch_args, cwd, stdout, stderr):\n # An old reference: https://unix.stackexchange.com/a/243748/34459\n #\n # I am worried that '--ignore-whitespace' may be destructive. If so we should\n # avoid passing it, particularly in the initial (most likely to succeed) calls.\n #\n # From here-in I define a 'native' patch as one which has:\n # 1. LF for the patch block metadata.\n # 2. CRLF or LF for the actual patched lines matching those of the source lines.\n #\n # Calls to a raw 'patch' are destructive in various ways:\n # 1. It leaves behind .rej and .orig files\n # 2. If you pass it a patch with incorrect CRLF changes and do not pass --binary and\n # if any of those blocks *can* be applied, then the whole file gets written out with\n # LF. This cannot be reversed either; the text changes will be reversed but not\n # line-feed changes (since all line-endings get changed, not just those of the of\n # patched lines)\n # 3. If patching fails, the bits that succeeded remain, so patching is not at all\n # atomic.\n #\n # Still, we do our best to mitigate all of this as follows:\n # 1. We disable .orig and .rej that for GNU patch via a temp file *\n # 2 (1). We check for native application of a native patch (--binary, without --ignore-whitespace)\n # 2 (2). We defer destructive calls to this until after the non-destructive ones.\n # 3. When patch indicates failure, we call it with -R to reverse the damage.\n #\n # * Some may bemoan the loss of these, but they it is fairly random which patch and patch\n # attempt they apply to so their informational value is low, besides that, they are ugly.\n # (and destructive to the future patchability of the source tree).\n #\n import tempfile\n temp_name = os.path.join(tempfile.gettempdir(), next(tempfile._get_candidate_names()))\n patch_args.append('-r')\n patch_args.append(temp_name)\n patch_args = ['--no-backup-if-mismatch', '--batch'] + patch_args\n log = get_logger(__name__)\n try:\n log.debug(\"Applying with\\n{} {}\".format(patch, patch_args))\n check_call_env([patch] + patch_args, cwd=cwd, stdout=stdout, stderr=stderr)\n # You can use this to pretend the patch failed so as to test reversal!\n # raise CalledProcessError(-1, ' '.join([patch] + patch_args))\n except Exception as e:\n try:\n if '--ignore-whitespace' in patch_args:\n patch_args.remove('--ignore-whitespace')\n patch_args.insert(0, '-R')\n patch_args.append('--binary')\n patch_args.append('--force')\n log.debug(\"Reversing with\\n{} {}\".format(patch, patch_args))\n check_call_env([patch] + patch_args, cwd=cwd, stdout=stdout, stderr=stderr)\n except:\n pass\n raise e\n finally:\n if os.path.exists(temp_name):\n os.unlink(temp_name)\n\n exception = None\n if not isfile(path):\n raise RuntimeError('Error: no such patch: %s' % path)\n\n if config.verbose:\n stdout = None\n stderr = None\n else:\n FNULL = open(os.devnull, 'w')\n stdout = FNULL\n stderr = FNULL\n\n files, is_git_format = _get_patch_file_details(path)\n if git and is_git_format:\n # Prevents git from asking interactive questions,\n # also necessary to achieve sha1 reproducibility;\n # as is --committer-date-is-author-date. By this,\n # we mean a round-trip of git am/git format-patch\n # gives the same file.\n git_env = os.environ\n git_env['GIT_COMMITTER_NAME'] = 'conda-build'\n git_env['GIT_COMMITTER_EMAIL'] = '[email protected]'\n check_call_env([git, 'am', '-3', '--committer-date-is-author-date', path],\n cwd=src_dir, stdout=stdout, stderr=stderr, env=git_env)\n config.git_commits_since_tag += 1\n else:\n if config.verbose:\n print('Applying patch: %r' % path)\n patch = external.find_executable('patch', config.build_prefix)\n if patch is None or len(patch) == 0:\n sys.exit(\"\"\"\\\n Error:\n Cannot use 'git' (not a git repo and/or patch) and did not find 'patch' in: %s\n You can install 'patch' using apt-get, yum (Linux), Xcode (MacOSX),\n or conda, m2-patch (Windows),\n \"\"\" % (os.pathsep.join(external.dir_paths)))\n patch_strip_level = _guess_patch_strip_level(files, src_dir)\n path_args = ['-i', path]\n patch_args = ['-p%d' % patch_strip_level]\n\n try:\n log = get_logger(__name__)\n # This is the case we check first of all as it is the case that allows a properly line-ended\n # patch to apply correctly to a properly line-ended source tree, modifying it following the\n # patch chunks exactly.\n patch_or_reverse(patch, patch_args + ['--binary'] + path_args,\n cwd=src_dir, stdout=stdout, stderr=stderr)\n except CalledProcessError as e:\n # Capture the first exception\n exception = e\n if config.verbose:\n log.info(\"Applying patch natively failed. \"\n \"Trying to apply patch non-binary with --ignore-whitespace\")\n try:\n patch_or_reverse(patch, patch_args + ['--ignore-whitespace'] + path_args,\n cwd=src_dir, stdout=stdout, stderr=stderr)\n except CalledProcessError as e: # noqa\n unix_ending_file = _ensure_unix_line_endings(path)\n path_args[-1] = unix_ending_file\n try:\n if config.verbose:\n log.info(\"Applying natively *and* non-binary failed! \"\n \"Converting to unix line endings and trying again. \"\n \"WARNING :: This is destructive to the source file line-endings.\")\n # If this succeeds, it will change the source files' CRLFs to LFs. This can\n # mess things up both for subsequent attempts (this line-ending change is not\n # reversible) but worse, for subsequent, correctly crafted (I'm calling these\n # \"native\" from now on) patches.\n patch_or_reverse(patch, patch_args + ['--ignore-whitespace'] + path_args,\n cwd=src_dir, stdout=stdout, stderr=stderr)\n except CalledProcessError:\n if config.verbose:\n log.warning(\"Applying natively, non-binary *and* unix attempts all failed!? \"\n \"Converting to CRLF line endings and trying again with \"\n \"--ignore-whitespace and --binary. This can be destructive (even\"\n \"with attempted reversal) to the source files' line-endings.\")\n win_ending_file = _ensure_win_line_endings(path)\n path_args[-1] = win_ending_file\n try:\n patch_or_reverse(patch, patch_args + ['--ignore-whitespace', '--binary'] + path_args,\n cwd=src_dir, stdout=stdout, stderr=stderr)\n except:\n pass\n else:\n exception = None\n finally:\n if os.path.exists(win_ending_file):\n os.remove(win_ending_file) # clean up .patch_unix file\n else:\n exception = None\n finally:\n if os.path.exists(unix_ending_file):\n os.remove(unix_ending_file)\n if exception:\n raise exception\n\n\ndef provide(metadata):\n \"\"\"\n given a recipe_dir:\n - download (if necessary)\n - unpack\n - apply patches (if any)\n \"\"\"\n meta = metadata.get_section('source')\n if not os.path.isdir(metadata.config.build_folder):\n os.makedirs(metadata.config.build_folder)\n git = None\n\n if hasattr(meta, 'keys'):\n dicts = [meta]\n else:\n dicts = meta\n\n try:\n for source_dict in dicts:\n folder = source_dict.get('folder')\n src_dir = os.path.join(metadata.config.work_dir, folder if folder else '')\n if any(k in source_dict for k in ('fn', 'url')):\n unpack(source_dict, src_dir, metadata.config.src_cache, recipe_path=metadata.path,\n croot=metadata.config.croot, verbose=metadata.config.verbose,\n timeout=metadata.config.timeout, locking=metadata.config.locking)\n elif 'git_url' in source_dict:\n git = git_source(source_dict, metadata.config.git_cache, src_dir, metadata.path,\n verbose=metadata.config.verbose)\n # build to make sure we have a work directory with source in it. We\n # want to make sure that whatever version that is does not\n # interfere with the test we run next.\n elif 'hg_url' in source_dict:\n hg_source(source_dict, src_dir, metadata.config.hg_cache,\n verbose=metadata.config.verbose)\n elif 'svn_url' in source_dict:\n svn_source(source_dict, src_dir, metadata.config.svn_cache,\n verbose=metadata.config.verbose, timeout=metadata.config.timeout,\n locking=metadata.config.locking)\n elif 'path' in source_dict:\n source_path = os.path.expanduser(source_dict['path'])\n path = normpath(abspath(join(metadata.path, source_path)))\n path_via_symlink = 'path_via_symlink' in source_dict\n if path_via_symlink and not folder:\n print(\"WARNING: `path_via_symlink` is too dangerous without specifying a folder,\\n\"\n \" conda could end up changing - or deleting - your local source code!\\n\"\n \" Going to make copies instead. When using `path_via_symlink` you should\\n\"\n \" also take care to run the build outside of your local source code folder(s)\\n\"\n \" unless that is your intention.\")\n path_via_symlink = False\n sys.exit(1)\n if path_via_symlink:\n src_dir_symlink = os.path.dirname(src_dir)\n if not isdir(src_dir_symlink):\n os.makedirs(src_dir_symlink)\n if metadata.config.verbose:\n print(\"Creating sybmolic link pointing to %s at %s\" % (path, src_dir))\n os.symlink(path, src_dir)\n else:\n if metadata.config.verbose:\n print(\"Copying %s to %s\" % (path, src_dir))\n # careful here: we set test path to be outside of conda-build root in setup.cfg.\n # If you don't do that, this is a recursive function\n copy_into(path, src_dir, metadata.config.timeout, symlinks=True,\n locking=metadata.config.locking, clobber=True)\n else: # no source\n if not isdir(src_dir):\n os.makedirs(src_dir)\n\n patches = ensure_list(source_dict.get('patches', []))\n for patch in patches:\n apply_patch(src_dir, join(metadata.path, patch), metadata.config, git)\n\n except CalledProcessError:\n shutil.move(metadata.config.work_dir, metadata.config.work_dir + '_failed_provide')\n raise\n\n return metadata.config.work_dir\n", "path": "conda_build/source.py"}]} |
gh_patches_debug_224 | rasdani/github-patches | git_diff | python-discord__site-758 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Missing API response for `last_applied` field
The added `last_applied` attribute in #751 currently is not in the API 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: `pydis_site/apps/api/serializers.py`
Content:
```
1 """Converters from Django models to data interchange formats and back."""
2 from django.db.models.query import QuerySet
3 from django.db.utils import IntegrityError
4 from rest_framework.exceptions import NotFound
5 from rest_framework.serializers import (
6 IntegerField,
7 ListSerializer,
8 ModelSerializer,
9 PrimaryKeyRelatedField,
10 ValidationError
11 )
12 from rest_framework.settings import api_settings
13 from rest_framework.validators import UniqueTogetherValidator
14
15 from .models import (
16 AocAccountLink,
17 AocCompletionistBlock,
18 BotSetting,
19 BumpedThread,
20 DeletedMessage,
21 DocumentationLink,
22 FilterList,
23 Infraction,
24 MessageDeletionContext,
25 Nomination,
26 NominationEntry,
27 OffTopicChannelName,
28 OffensiveMessage,
29 Reminder,
30 Role,
31 User
32 )
33
34
35 class BotSettingSerializer(ModelSerializer):
36 """A class providing (de-)serialization of `BotSetting` instances."""
37
38 class Meta:
39 """Metadata defined for the Django REST Framework."""
40
41 model = BotSetting
42 fields = ('name', 'data')
43
44
45 class ListBumpedThreadSerializer(ListSerializer):
46 """Custom ListSerializer to override to_representation() when list views are triggered."""
47
48 def to_representation(self, objects: list[BumpedThread]) -> int:
49 """
50 Used by the `ListModelMixin` to return just the list of bumped thread ids.
51
52 Only the thread_id field is useful, hence it is unnecessary to create a nested dictionary.
53
54 Additionally, this allows bumped thread routes to simply return an
55 array of thread_id ints instead of objects, saving on bandwidth.
56 """
57 return [obj.thread_id for obj in objects]
58
59
60 class BumpedThreadSerializer(ModelSerializer):
61 """A class providing (de-)serialization of `BumpedThread` instances."""
62
63 class Meta:
64 """Metadata defined for the Django REST Framework."""
65
66 list_serializer_class = ListBumpedThreadSerializer
67 model = BumpedThread
68 fields = ('thread_id',)
69
70
71 class DeletedMessageSerializer(ModelSerializer):
72 """
73 A class providing (de-)serialization of `DeletedMessage` instances.
74
75 The serializer generally requires a valid `deletion_context` to be
76 given, which should be created beforehand. See the `DeletedMessage`
77 model for more information.
78 """
79
80 author = PrimaryKeyRelatedField(
81 queryset=User.objects.all()
82 )
83 deletion_context = PrimaryKeyRelatedField(
84 queryset=MessageDeletionContext.objects.all(),
85 # This will be overridden in the `create` function
86 # of the deletion context serializer.
87 required=False
88 )
89
90 class Meta:
91 """Metadata defined for the Django REST Framework."""
92
93 model = DeletedMessage
94 fields = (
95 'id', 'author',
96 'channel_id', 'content',
97 'embeds', 'deletion_context',
98 'attachments'
99 )
100
101
102 class MessageDeletionContextSerializer(ModelSerializer):
103 """A class providing (de-)serialization of `MessageDeletionContext` instances."""
104
105 actor = PrimaryKeyRelatedField(queryset=User.objects.all(), allow_null=True)
106 deletedmessage_set = DeletedMessageSerializer(many=True)
107
108 class Meta:
109 """Metadata defined for the Django REST Framework."""
110
111 model = MessageDeletionContext
112 fields = ('actor', 'creation', 'id', 'deletedmessage_set')
113 depth = 1
114
115 def create(self, validated_data: dict) -> MessageDeletionContext:
116 """
117 Return a `MessageDeletionContext` based on the given data.
118
119 In addition to the normal attributes expected by the `MessageDeletionContext` model
120 itself, this serializer also allows for passing the `deletedmessage_set` element
121 which contains messages that were deleted as part of this context.
122 """
123 messages = validated_data.pop('deletedmessage_set')
124 deletion_context = MessageDeletionContext.objects.create(**validated_data)
125 for message in messages:
126 DeletedMessage.objects.create(
127 deletion_context=deletion_context,
128 **message
129 )
130
131 return deletion_context
132
133
134 class DocumentationLinkSerializer(ModelSerializer):
135 """A class providing (de-)serialization of `DocumentationLink` instances."""
136
137 class Meta:
138 """Metadata defined for the Django REST Framework."""
139
140 model = DocumentationLink
141 fields = ('package', 'base_url', 'inventory_url')
142
143
144 class FilterListSerializer(ModelSerializer):
145 """A class providing (de-)serialization of `FilterList` instances."""
146
147 class Meta:
148 """Metadata defined for the Django REST Framework."""
149
150 model = FilterList
151 fields = ('id', 'created_at', 'updated_at', 'type', 'allowed', 'content', 'comment')
152
153 # This validator ensures only one filterlist with the
154 # same content can exist. This means that we cannot have both an allow
155 # and a deny for the same item, and we cannot have duplicates of the
156 # same item.
157 validators = [
158 UniqueTogetherValidator(
159 queryset=FilterList.objects.all(),
160 fields=['content', 'type'],
161 message=(
162 "A filterlist for this item already exists. "
163 "Please note that you cannot add the same item to both allow and deny."
164 )
165 ),
166 ]
167
168
169 class InfractionSerializer(ModelSerializer):
170 """A class providing (de-)serialization of `Infraction` instances."""
171
172 class Meta:
173 """Metadata defined for the Django REST Framework."""
174
175 model = Infraction
176 fields = (
177 'id',
178 'inserted_at',
179 'expires_at',
180 'active',
181 'user',
182 'actor',
183 'type',
184 'reason',
185 'hidden',
186 'dm_sent'
187 )
188
189 def validate(self, attrs: dict) -> dict:
190 """Validate data constraints for the given data and abort if it is invalid."""
191 infr_type = attrs.get('type')
192
193 active = attrs.get('active')
194 if active and infr_type in ('note', 'warning', 'kick'):
195 raise ValidationError({'active': [f'{infr_type} infractions cannot be active.']})
196
197 expires_at = attrs.get('expires_at')
198 if expires_at and infr_type in ('kick', 'warning'):
199 raise ValidationError({'expires_at': [f'{infr_type} infractions cannot expire.']})
200
201 hidden = attrs.get('hidden')
202 if hidden and infr_type in ('superstar', 'warning', 'voice_ban', 'voice_mute'):
203 raise ValidationError({'hidden': [f'{infr_type} infractions cannot be hidden.']})
204
205 if not hidden and infr_type in ('note', ):
206 raise ValidationError({'hidden': [f'{infr_type} infractions must be hidden.']})
207
208 return attrs
209
210
211 class ExpandedInfractionSerializer(InfractionSerializer):
212 """
213 A class providing expanded (de-)serialization of `Infraction` instances.
214
215 In addition to the fields of `Infraction` objects themselves, this
216 serializer also attaches the `user` and `actor` fields when serializing.
217 """
218
219 def to_representation(self, instance: Infraction) -> dict:
220 """Return the dictionary representation of this infraction."""
221 ret = super().to_representation(instance)
222
223 user = User.objects.get(id=ret['user'])
224 user_data = UserSerializer(user).data
225 ret['user'] = user_data
226
227 actor = User.objects.get(id=ret['actor'])
228 actor_data = UserSerializer(actor).data
229 ret['actor'] = actor_data
230
231 return ret
232
233
234 class OffTopicChannelNameListSerializer(ListSerializer):
235 """Custom ListSerializer to override to_representation() when list views are triggered."""
236
237 def to_representation(self, objects: list[OffTopicChannelName]) -> list[str]:
238 """
239 Return a list with all `OffTopicChannelName`s in the database.
240
241 This returns the list of off topic channel names. We want to only return
242 the name attribute, hence it is unnecessary to create a nested dictionary.
243 Additionally, this allows off topic channel name routes to simply return an
244 array of names instead of objects, saving on bandwidth.
245 """
246 return [obj.name for obj in objects]
247
248
249 class OffTopicChannelNameSerializer(ModelSerializer):
250 """A class providing (de-)serialization of `OffTopicChannelName` instances."""
251
252 class Meta:
253 """Metadata defined for the Django REST Framework."""
254
255 list_serializer_class = OffTopicChannelNameListSerializer
256 model = OffTopicChannelName
257 fields = ('name', 'used', 'active')
258
259
260 class ReminderSerializer(ModelSerializer):
261 """A class providing (de-)serialization of `Reminder` instances."""
262
263 author = PrimaryKeyRelatedField(queryset=User.objects.all())
264
265 class Meta:
266 """Metadata defined for the Django REST Framework."""
267
268 model = Reminder
269 fields = (
270 'active',
271 'author',
272 'jump_url',
273 'channel_id',
274 'content',
275 'expiration',
276 'id',
277 'mentions',
278 'failures'
279 )
280
281
282 class AocCompletionistBlockSerializer(ModelSerializer):
283 """A class providing (de-)serialization of `AocCompletionistBlock` instances."""
284
285 class Meta:
286 """Metadata defined for the Django REST Framework."""
287
288 model = AocCompletionistBlock
289 fields = ("user", "is_blocked", "reason")
290
291
292 class AocAccountLinkSerializer(ModelSerializer):
293 """A class providing (de-)serialization of `AocAccountLink` instances."""
294
295 class Meta:
296 """Metadata defined for the Django REST Framework."""
297
298 model = AocAccountLink
299 fields = ("user", "aoc_username")
300
301
302 class RoleSerializer(ModelSerializer):
303 """A class providing (de-)serialization of `Role` instances."""
304
305 class Meta:
306 """Metadata defined for the Django REST Framework."""
307
308 model = Role
309 fields = ('id', 'name', 'colour', 'permissions', 'position')
310
311
312 class UserListSerializer(ListSerializer):
313 """List serializer for User model to handle bulk updates."""
314
315 def create(self, validated_data: list) -> list:
316 """Override create method to optimize django queries."""
317 new_users = []
318 seen = set()
319
320 for user_dict in validated_data:
321 if user_dict["id"] in seen:
322 raise ValidationError(
323 {"id": [f"User with ID {user_dict['id']} given multiple times."]}
324 )
325 seen.add(user_dict["id"])
326 new_users.append(User(**user_dict))
327
328 User.objects.bulk_create(new_users, ignore_conflicts=True)
329 return []
330
331 def update(self, queryset: QuerySet, validated_data: list) -> list:
332 """
333 Override update method to support bulk updates.
334
335 ref:https://www.django-rest-framework.org/api-guide/serializers/#customizing-multiple-update
336 """
337 object_ids = set()
338
339 for data in validated_data:
340 try:
341 if data["id"] in object_ids:
342 # If request data contains users with same ID.
343 raise ValidationError(
344 {"id": [f"User with ID {data['id']} given multiple times."]}
345 )
346 except KeyError:
347 # If user ID not provided in request body.
348 raise ValidationError(
349 {"id": ["This field is required."]}
350 )
351 object_ids.add(data["id"])
352
353 # filter queryset
354 filtered_instances = queryset.filter(id__in=object_ids)
355
356 instance_mapping = {user.id: user for user in filtered_instances}
357
358 updated = []
359 fields_to_update = set()
360 for user_data in validated_data:
361 for key in user_data:
362 fields_to_update.add(key)
363
364 try:
365 user = instance_mapping[user_data["id"]]
366 except KeyError:
367 raise NotFound({"detail": f"User with id {user_data['id']} not found."})
368
369 user.__dict__.update(user_data)
370 updated.append(user)
371
372 fields_to_update.remove("id")
373
374 if not fields_to_update:
375 # Raise ValidationError when only id field is given.
376 raise ValidationError(
377 {api_settings.NON_FIELD_ERRORS_KEY: ["Insufficient data provided."]}
378 )
379
380 User.objects.bulk_update(updated, fields_to_update)
381 return updated
382
383
384 class UserSerializer(ModelSerializer):
385 """A class providing (de-)serialization of `User` instances."""
386
387 # ID field must be explicitly set as the default id field is read-only.
388 id = IntegerField(min_value=0)
389
390 class Meta:
391 """Metadata defined for the Django REST Framework."""
392
393 model = User
394 fields = ('id', 'name', 'discriminator', 'roles', 'in_guild')
395 depth = 1
396 list_serializer_class = UserListSerializer
397
398 def create(self, validated_data: dict) -> User:
399 """Override create method to catch IntegrityError."""
400 try:
401 return super().create(validated_data)
402 except IntegrityError:
403 raise ValidationError({"id": ["User with ID already present."]})
404
405
406 class NominationEntrySerializer(ModelSerializer):
407 """A class providing (de-)serialization of `NominationEntry` instances."""
408
409 # We need to define it here, because we don't want that nomination ID
410 # return inside nomination response entry, because ID is already available
411 # as top-level field. Queryset is required if field is not read only.
412 nomination = PrimaryKeyRelatedField(
413 queryset=Nomination.objects.all(),
414 write_only=True
415 )
416
417 class Meta:
418 """Metadata defined for the Django REST framework."""
419
420 model = NominationEntry
421 fields = ('nomination', 'actor', 'reason', 'inserted_at')
422
423
424 class NominationSerializer(ModelSerializer):
425 """A class providing (de-)serialization of `Nomination` instances."""
426
427 entries = NominationEntrySerializer(many=True, read_only=True)
428
429 class Meta:
430 """Metadata defined for the Django REST Framework."""
431
432 model = Nomination
433 fields = (
434 'id', 'active', 'user', 'inserted_at', 'end_reason', 'ended_at', 'reviewed', 'entries'
435 )
436
437
438 class OffensiveMessageSerializer(ModelSerializer):
439 """A class providing (de-)serialization of `OffensiveMessage` instances."""
440
441 class Meta:
442 """Metadata defined for the Django REST Framework."""
443
444 model = OffensiveMessage
445 fields = ('id', 'channel_id', 'delete_date')
446
```
--- 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/pydis_site/apps/api/serializers.py b/pydis_site/apps/api/serializers.py
--- a/pydis_site/apps/api/serializers.py
+++ b/pydis_site/apps/api/serializers.py
@@ -176,6 +176,7 @@
fields = (
'id',
'inserted_at',
+ 'last_applied',
'expires_at',
'active',
'user',
| {"golden_diff": "diff --git a/pydis_site/apps/api/serializers.py b/pydis_site/apps/api/serializers.py\n--- a/pydis_site/apps/api/serializers.py\n+++ b/pydis_site/apps/api/serializers.py\n@@ -176,6 +176,7 @@\n fields = (\n 'id',\n 'inserted_at',\n+ 'last_applied',\n 'expires_at',\n 'active',\n 'user',\n", "issue": "Missing API response for `last_applied` field\nThe added `last_applied` attribute in #751 currently is not in the API response.\n", "before_files": [{"content": "\"\"\"Converters from Django models to data interchange formats and back.\"\"\"\nfrom django.db.models.query import QuerySet\nfrom django.db.utils import IntegrityError\nfrom rest_framework.exceptions import NotFound\nfrom rest_framework.serializers import (\n IntegerField,\n ListSerializer,\n ModelSerializer,\n PrimaryKeyRelatedField,\n ValidationError\n)\nfrom rest_framework.settings import api_settings\nfrom rest_framework.validators import UniqueTogetherValidator\n\nfrom .models import (\n AocAccountLink,\n AocCompletionistBlock,\n BotSetting,\n BumpedThread,\n DeletedMessage,\n DocumentationLink,\n FilterList,\n Infraction,\n MessageDeletionContext,\n Nomination,\n NominationEntry,\n OffTopicChannelName,\n OffensiveMessage,\n Reminder,\n Role,\n User\n)\n\n\nclass BotSettingSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `BotSetting` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = BotSetting\n fields = ('name', 'data')\n\n\nclass ListBumpedThreadSerializer(ListSerializer):\n \"\"\"Custom ListSerializer to override to_representation() when list views are triggered.\"\"\"\n\n def to_representation(self, objects: list[BumpedThread]) -> int:\n \"\"\"\n Used by the `ListModelMixin` to return just the list of bumped thread ids.\n\n Only the thread_id field is useful, hence it is unnecessary to create a nested dictionary.\n\n Additionally, this allows bumped thread routes to simply return an\n array of thread_id ints instead of objects, saving on bandwidth.\n \"\"\"\n return [obj.thread_id for obj in objects]\n\n\nclass BumpedThreadSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `BumpedThread` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n list_serializer_class = ListBumpedThreadSerializer\n model = BumpedThread\n fields = ('thread_id',)\n\n\nclass DeletedMessageSerializer(ModelSerializer):\n \"\"\"\n A class providing (de-)serialization of `DeletedMessage` instances.\n\n The serializer generally requires a valid `deletion_context` to be\n given, which should be created beforehand. See the `DeletedMessage`\n model for more information.\n \"\"\"\n\n author = PrimaryKeyRelatedField(\n queryset=User.objects.all()\n )\n deletion_context = PrimaryKeyRelatedField(\n queryset=MessageDeletionContext.objects.all(),\n # This will be overridden in the `create` function\n # of the deletion context serializer.\n required=False\n )\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = DeletedMessage\n fields = (\n 'id', 'author',\n 'channel_id', 'content',\n 'embeds', 'deletion_context',\n 'attachments'\n )\n\n\nclass MessageDeletionContextSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `MessageDeletionContext` instances.\"\"\"\n\n actor = PrimaryKeyRelatedField(queryset=User.objects.all(), allow_null=True)\n deletedmessage_set = DeletedMessageSerializer(many=True)\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = MessageDeletionContext\n fields = ('actor', 'creation', 'id', 'deletedmessage_set')\n depth = 1\n\n def create(self, validated_data: dict) -> MessageDeletionContext:\n \"\"\"\n Return a `MessageDeletionContext` based on the given data.\n\n In addition to the normal attributes expected by the `MessageDeletionContext` model\n itself, this serializer also allows for passing the `deletedmessage_set` element\n which contains messages that were deleted as part of this context.\n \"\"\"\n messages = validated_data.pop('deletedmessage_set')\n deletion_context = MessageDeletionContext.objects.create(**validated_data)\n for message in messages:\n DeletedMessage.objects.create(\n deletion_context=deletion_context,\n **message\n )\n\n return deletion_context\n\n\nclass DocumentationLinkSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `DocumentationLink` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = DocumentationLink\n fields = ('package', 'base_url', 'inventory_url')\n\n\nclass FilterListSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `FilterList` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = FilterList\n fields = ('id', 'created_at', 'updated_at', 'type', 'allowed', 'content', 'comment')\n\n # This validator ensures only one filterlist with the\n # same content can exist. This means that we cannot have both an allow\n # and a deny for the same item, and we cannot have duplicates of the\n # same item.\n validators = [\n UniqueTogetherValidator(\n queryset=FilterList.objects.all(),\n fields=['content', 'type'],\n message=(\n \"A filterlist for this item already exists. \"\n \"Please note that you cannot add the same item to both allow and deny.\"\n )\n ),\n ]\n\n\nclass InfractionSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `Infraction` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = Infraction\n fields = (\n 'id',\n 'inserted_at',\n 'expires_at',\n 'active',\n 'user',\n 'actor',\n 'type',\n 'reason',\n 'hidden',\n 'dm_sent'\n )\n\n def validate(self, attrs: dict) -> dict:\n \"\"\"Validate data constraints for the given data and abort if it is invalid.\"\"\"\n infr_type = attrs.get('type')\n\n active = attrs.get('active')\n if active and infr_type in ('note', 'warning', 'kick'):\n raise ValidationError({'active': [f'{infr_type} infractions cannot be active.']})\n\n expires_at = attrs.get('expires_at')\n if expires_at and infr_type in ('kick', 'warning'):\n raise ValidationError({'expires_at': [f'{infr_type} infractions cannot expire.']})\n\n hidden = attrs.get('hidden')\n if hidden and infr_type in ('superstar', 'warning', 'voice_ban', 'voice_mute'):\n raise ValidationError({'hidden': [f'{infr_type} infractions cannot be hidden.']})\n\n if not hidden and infr_type in ('note', ):\n raise ValidationError({'hidden': [f'{infr_type} infractions must be hidden.']})\n\n return attrs\n\n\nclass ExpandedInfractionSerializer(InfractionSerializer):\n \"\"\"\n A class providing expanded (de-)serialization of `Infraction` instances.\n\n In addition to the fields of `Infraction` objects themselves, this\n serializer also attaches the `user` and `actor` fields when serializing.\n \"\"\"\n\n def to_representation(self, instance: Infraction) -> dict:\n \"\"\"Return the dictionary representation of this infraction.\"\"\"\n ret = super().to_representation(instance)\n\n user = User.objects.get(id=ret['user'])\n user_data = UserSerializer(user).data\n ret['user'] = user_data\n\n actor = User.objects.get(id=ret['actor'])\n actor_data = UserSerializer(actor).data\n ret['actor'] = actor_data\n\n return ret\n\n\nclass OffTopicChannelNameListSerializer(ListSerializer):\n \"\"\"Custom ListSerializer to override to_representation() when list views are triggered.\"\"\"\n\n def to_representation(self, objects: list[OffTopicChannelName]) -> list[str]:\n \"\"\"\n Return a list with all `OffTopicChannelName`s in the database.\n\n This returns the list of off topic channel names. We want to only return\n the name attribute, hence it is unnecessary to create a nested dictionary.\n Additionally, this allows off topic channel name routes to simply return an\n array of names instead of objects, saving on bandwidth.\n \"\"\"\n return [obj.name for obj in objects]\n\n\nclass OffTopicChannelNameSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `OffTopicChannelName` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n list_serializer_class = OffTopicChannelNameListSerializer\n model = OffTopicChannelName\n fields = ('name', 'used', 'active')\n\n\nclass ReminderSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `Reminder` instances.\"\"\"\n\n author = PrimaryKeyRelatedField(queryset=User.objects.all())\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = Reminder\n fields = (\n 'active',\n 'author',\n 'jump_url',\n 'channel_id',\n 'content',\n 'expiration',\n 'id',\n 'mentions',\n 'failures'\n )\n\n\nclass AocCompletionistBlockSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `AocCompletionistBlock` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = AocCompletionistBlock\n fields = (\"user\", \"is_blocked\", \"reason\")\n\n\nclass AocAccountLinkSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `AocAccountLink` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = AocAccountLink\n fields = (\"user\", \"aoc_username\")\n\n\nclass RoleSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `Role` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = Role\n fields = ('id', 'name', 'colour', 'permissions', 'position')\n\n\nclass UserListSerializer(ListSerializer):\n \"\"\"List serializer for User model to handle bulk updates.\"\"\"\n\n def create(self, validated_data: list) -> list:\n \"\"\"Override create method to optimize django queries.\"\"\"\n new_users = []\n seen = set()\n\n for user_dict in validated_data:\n if user_dict[\"id\"] in seen:\n raise ValidationError(\n {\"id\": [f\"User with ID {user_dict['id']} given multiple times.\"]}\n )\n seen.add(user_dict[\"id\"])\n new_users.append(User(**user_dict))\n\n User.objects.bulk_create(new_users, ignore_conflicts=True)\n return []\n\n def update(self, queryset: QuerySet, validated_data: list) -> list:\n \"\"\"\n Override update method to support bulk updates.\n\n ref:https://www.django-rest-framework.org/api-guide/serializers/#customizing-multiple-update\n \"\"\"\n object_ids = set()\n\n for data in validated_data:\n try:\n if data[\"id\"] in object_ids:\n # If request data contains users with same ID.\n raise ValidationError(\n {\"id\": [f\"User with ID {data['id']} given multiple times.\"]}\n )\n except KeyError:\n # If user ID not provided in request body.\n raise ValidationError(\n {\"id\": [\"This field is required.\"]}\n )\n object_ids.add(data[\"id\"])\n\n # filter queryset\n filtered_instances = queryset.filter(id__in=object_ids)\n\n instance_mapping = {user.id: user for user in filtered_instances}\n\n updated = []\n fields_to_update = set()\n for user_data in validated_data:\n for key in user_data:\n fields_to_update.add(key)\n\n try:\n user = instance_mapping[user_data[\"id\"]]\n except KeyError:\n raise NotFound({\"detail\": f\"User with id {user_data['id']} not found.\"})\n\n user.__dict__.update(user_data)\n updated.append(user)\n\n fields_to_update.remove(\"id\")\n\n if not fields_to_update:\n # Raise ValidationError when only id field is given.\n raise ValidationError(\n {api_settings.NON_FIELD_ERRORS_KEY: [\"Insufficient data provided.\"]}\n )\n\n User.objects.bulk_update(updated, fields_to_update)\n return updated\n\n\nclass UserSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `User` instances.\"\"\"\n\n # ID field must be explicitly set as the default id field is read-only.\n id = IntegerField(min_value=0)\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = User\n fields = ('id', 'name', 'discriminator', 'roles', 'in_guild')\n depth = 1\n list_serializer_class = UserListSerializer\n\n def create(self, validated_data: dict) -> User:\n \"\"\"Override create method to catch IntegrityError.\"\"\"\n try:\n return super().create(validated_data)\n except IntegrityError:\n raise ValidationError({\"id\": [\"User with ID already present.\"]})\n\n\nclass NominationEntrySerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `NominationEntry` instances.\"\"\"\n\n # We need to define it here, because we don't want that nomination ID\n # return inside nomination response entry, because ID is already available\n # as top-level field. Queryset is required if field is not read only.\n nomination = PrimaryKeyRelatedField(\n queryset=Nomination.objects.all(),\n write_only=True\n )\n\n class Meta:\n \"\"\"Metadata defined for the Django REST framework.\"\"\"\n\n model = NominationEntry\n fields = ('nomination', 'actor', 'reason', 'inserted_at')\n\n\nclass NominationSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `Nomination` instances.\"\"\"\n\n entries = NominationEntrySerializer(many=True, read_only=True)\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = Nomination\n fields = (\n 'id', 'active', 'user', 'inserted_at', 'end_reason', 'ended_at', 'reviewed', 'entries'\n )\n\n\nclass OffensiveMessageSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `OffensiveMessage` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = OffensiveMessage\n fields = ('id', 'channel_id', 'delete_date')\n", "path": "pydis_site/apps/api/serializers.py"}], "after_files": [{"content": "\"\"\"Converters from Django models to data interchange formats and back.\"\"\"\nfrom django.db.models.query import QuerySet\nfrom django.db.utils import IntegrityError\nfrom rest_framework.exceptions import NotFound\nfrom rest_framework.serializers import (\n IntegerField,\n ListSerializer,\n ModelSerializer,\n PrimaryKeyRelatedField,\n ValidationError\n)\nfrom rest_framework.settings import api_settings\nfrom rest_framework.validators import UniqueTogetherValidator\n\nfrom .models import (\n AocAccountLink,\n AocCompletionistBlock,\n BotSetting,\n BumpedThread,\n DeletedMessage,\n DocumentationLink,\n FilterList,\n Infraction,\n MessageDeletionContext,\n Nomination,\n NominationEntry,\n OffTopicChannelName,\n OffensiveMessage,\n Reminder,\n Role,\n User\n)\n\n\nclass BotSettingSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `BotSetting` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = BotSetting\n fields = ('name', 'data')\n\n\nclass ListBumpedThreadSerializer(ListSerializer):\n \"\"\"Custom ListSerializer to override to_representation() when list views are triggered.\"\"\"\n\n def to_representation(self, objects: list[BumpedThread]) -> int:\n \"\"\"\n Used by the `ListModelMixin` to return just the list of bumped thread ids.\n\n Only the thread_id field is useful, hence it is unnecessary to create a nested dictionary.\n\n Additionally, this allows bumped thread routes to simply return an\n array of thread_id ints instead of objects, saving on bandwidth.\n \"\"\"\n return [obj.thread_id for obj in objects]\n\n\nclass BumpedThreadSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `BumpedThread` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n list_serializer_class = ListBumpedThreadSerializer\n model = BumpedThread\n fields = ('thread_id',)\n\n\nclass DeletedMessageSerializer(ModelSerializer):\n \"\"\"\n A class providing (de-)serialization of `DeletedMessage` instances.\n\n The serializer generally requires a valid `deletion_context` to be\n given, which should be created beforehand. See the `DeletedMessage`\n model for more information.\n \"\"\"\n\n author = PrimaryKeyRelatedField(\n queryset=User.objects.all()\n )\n deletion_context = PrimaryKeyRelatedField(\n queryset=MessageDeletionContext.objects.all(),\n # This will be overridden in the `create` function\n # of the deletion context serializer.\n required=False\n )\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = DeletedMessage\n fields = (\n 'id', 'author',\n 'channel_id', 'content',\n 'embeds', 'deletion_context',\n 'attachments'\n )\n\n\nclass MessageDeletionContextSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `MessageDeletionContext` instances.\"\"\"\n\n actor = PrimaryKeyRelatedField(queryset=User.objects.all(), allow_null=True)\n deletedmessage_set = DeletedMessageSerializer(many=True)\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = MessageDeletionContext\n fields = ('actor', 'creation', 'id', 'deletedmessage_set')\n depth = 1\n\n def create(self, validated_data: dict) -> MessageDeletionContext:\n \"\"\"\n Return a `MessageDeletionContext` based on the given data.\n\n In addition to the normal attributes expected by the `MessageDeletionContext` model\n itself, this serializer also allows for passing the `deletedmessage_set` element\n which contains messages that were deleted as part of this context.\n \"\"\"\n messages = validated_data.pop('deletedmessage_set')\n deletion_context = MessageDeletionContext.objects.create(**validated_data)\n for message in messages:\n DeletedMessage.objects.create(\n deletion_context=deletion_context,\n **message\n )\n\n return deletion_context\n\n\nclass DocumentationLinkSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `DocumentationLink` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = DocumentationLink\n fields = ('package', 'base_url', 'inventory_url')\n\n\nclass FilterListSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `FilterList` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = FilterList\n fields = ('id', 'created_at', 'updated_at', 'type', 'allowed', 'content', 'comment')\n\n # This validator ensures only one filterlist with the\n # same content can exist. This means that we cannot have both an allow\n # and a deny for the same item, and we cannot have duplicates of the\n # same item.\n validators = [\n UniqueTogetherValidator(\n queryset=FilterList.objects.all(),\n fields=['content', 'type'],\n message=(\n \"A filterlist for this item already exists. \"\n \"Please note that you cannot add the same item to both allow and deny.\"\n )\n ),\n ]\n\n\nclass InfractionSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `Infraction` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = Infraction\n fields = (\n 'id',\n 'inserted_at',\n 'last_applied',\n 'expires_at',\n 'active',\n 'user',\n 'actor',\n 'type',\n 'reason',\n 'hidden',\n 'dm_sent'\n )\n\n def validate(self, attrs: dict) -> dict:\n \"\"\"Validate data constraints for the given data and abort if it is invalid.\"\"\"\n infr_type = attrs.get('type')\n\n active = attrs.get('active')\n if active and infr_type in ('note', 'warning', 'kick'):\n raise ValidationError({'active': [f'{infr_type} infractions cannot be active.']})\n\n expires_at = attrs.get('expires_at')\n if expires_at and infr_type in ('kick', 'warning'):\n raise ValidationError({'expires_at': [f'{infr_type} infractions cannot expire.']})\n\n hidden = attrs.get('hidden')\n if hidden and infr_type in ('superstar', 'warning', 'voice_ban', 'voice_mute'):\n raise ValidationError({'hidden': [f'{infr_type} infractions cannot be hidden.']})\n\n if not hidden and infr_type in ('note', ):\n raise ValidationError({'hidden': [f'{infr_type} infractions must be hidden.']})\n\n return attrs\n\n\nclass ExpandedInfractionSerializer(InfractionSerializer):\n \"\"\"\n A class providing expanded (de-)serialization of `Infraction` instances.\n\n In addition to the fields of `Infraction` objects themselves, this\n serializer also attaches the `user` and `actor` fields when serializing.\n \"\"\"\n\n def to_representation(self, instance: Infraction) -> dict:\n \"\"\"Return the dictionary representation of this infraction.\"\"\"\n ret = super().to_representation(instance)\n\n user = User.objects.get(id=ret['user'])\n user_data = UserSerializer(user).data\n ret['user'] = user_data\n\n actor = User.objects.get(id=ret['actor'])\n actor_data = UserSerializer(actor).data\n ret['actor'] = actor_data\n\n return ret\n\n\nclass OffTopicChannelNameListSerializer(ListSerializer):\n \"\"\"Custom ListSerializer to override to_representation() when list views are triggered.\"\"\"\n\n def to_representation(self, objects: list[OffTopicChannelName]) -> list[str]:\n \"\"\"\n Return a list with all `OffTopicChannelName`s in the database.\n\n This returns the list of off topic channel names. We want to only return\n the name attribute, hence it is unnecessary to create a nested dictionary.\n Additionally, this allows off topic channel name routes to simply return an\n array of names instead of objects, saving on bandwidth.\n \"\"\"\n return [obj.name for obj in objects]\n\n\nclass OffTopicChannelNameSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `OffTopicChannelName` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n list_serializer_class = OffTopicChannelNameListSerializer\n model = OffTopicChannelName\n fields = ('name', 'used', 'active')\n\n\nclass ReminderSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `Reminder` instances.\"\"\"\n\n author = PrimaryKeyRelatedField(queryset=User.objects.all())\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = Reminder\n fields = (\n 'active',\n 'author',\n 'jump_url',\n 'channel_id',\n 'content',\n 'expiration',\n 'id',\n 'mentions',\n 'failures'\n )\n\n\nclass AocCompletionistBlockSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `AocCompletionistBlock` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = AocCompletionistBlock\n fields = (\"user\", \"is_blocked\", \"reason\")\n\n\nclass AocAccountLinkSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `AocAccountLink` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = AocAccountLink\n fields = (\"user\", \"aoc_username\")\n\n\nclass RoleSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `Role` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = Role\n fields = ('id', 'name', 'colour', 'permissions', 'position')\n\n\nclass UserListSerializer(ListSerializer):\n \"\"\"List serializer for User model to handle bulk updates.\"\"\"\n\n def create(self, validated_data: list) -> list:\n \"\"\"Override create method to optimize django queries.\"\"\"\n new_users = []\n seen = set()\n\n for user_dict in validated_data:\n if user_dict[\"id\"] in seen:\n raise ValidationError(\n {\"id\": [f\"User with ID {user_dict['id']} given multiple times.\"]}\n )\n seen.add(user_dict[\"id\"])\n new_users.append(User(**user_dict))\n\n User.objects.bulk_create(new_users, ignore_conflicts=True)\n return []\n\n def update(self, queryset: QuerySet, validated_data: list) -> list:\n \"\"\"\n Override update method to support bulk updates.\n\n ref:https://www.django-rest-framework.org/api-guide/serializers/#customizing-multiple-update\n \"\"\"\n object_ids = set()\n\n for data in validated_data:\n try:\n if data[\"id\"] in object_ids:\n # If request data contains users with same ID.\n raise ValidationError(\n {\"id\": [f\"User with ID {data['id']} given multiple times.\"]}\n )\n except KeyError:\n # If user ID not provided in request body.\n raise ValidationError(\n {\"id\": [\"This field is required.\"]}\n )\n object_ids.add(data[\"id\"])\n\n # filter queryset\n filtered_instances = queryset.filter(id__in=object_ids)\n\n instance_mapping = {user.id: user for user in filtered_instances}\n\n updated = []\n fields_to_update = set()\n for user_data in validated_data:\n for key in user_data:\n fields_to_update.add(key)\n\n try:\n user = instance_mapping[user_data[\"id\"]]\n except KeyError:\n raise NotFound({\"detail\": f\"User with id {user_data['id']} not found.\"})\n\n user.__dict__.update(user_data)\n updated.append(user)\n\n fields_to_update.remove(\"id\")\n\n if not fields_to_update:\n # Raise ValidationError when only id field is given.\n raise ValidationError(\n {api_settings.NON_FIELD_ERRORS_KEY: [\"Insufficient data provided.\"]}\n )\n\n User.objects.bulk_update(updated, fields_to_update)\n return updated\n\n\nclass UserSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `User` instances.\"\"\"\n\n # ID field must be explicitly set as the default id field is read-only.\n id = IntegerField(min_value=0)\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = User\n fields = ('id', 'name', 'discriminator', 'roles', 'in_guild')\n depth = 1\n list_serializer_class = UserListSerializer\n\n def create(self, validated_data: dict) -> User:\n \"\"\"Override create method to catch IntegrityError.\"\"\"\n try:\n return super().create(validated_data)\n except IntegrityError:\n raise ValidationError({\"id\": [\"User with ID already present.\"]})\n\n\nclass NominationEntrySerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `NominationEntry` instances.\"\"\"\n\n # We need to define it here, because we don't want that nomination ID\n # return inside nomination response entry, because ID is already available\n # as top-level field. Queryset is required if field is not read only.\n nomination = PrimaryKeyRelatedField(\n queryset=Nomination.objects.all(),\n write_only=True\n )\n\n class Meta:\n \"\"\"Metadata defined for the Django REST framework.\"\"\"\n\n model = NominationEntry\n fields = ('nomination', 'actor', 'reason', 'inserted_at')\n\n\nclass NominationSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `Nomination` instances.\"\"\"\n\n entries = NominationEntrySerializer(many=True, read_only=True)\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = Nomination\n fields = (\n 'id', 'active', 'user', 'inserted_at', 'end_reason', 'ended_at', 'reviewed', 'entries'\n )\n\n\nclass OffensiveMessageSerializer(ModelSerializer):\n \"\"\"A class providing (de-)serialization of `OffensiveMessage` instances.\"\"\"\n\n class Meta:\n \"\"\"Metadata defined for the Django REST Framework.\"\"\"\n\n model = OffensiveMessage\n fields = ('id', 'channel_id', 'delete_date')\n", "path": "pydis_site/apps/api/serializers.py"}]} |
gh_patches_debug_225 | rasdani/github-patches | git_diff | OBOFoundry__OBOFoundry.github.io-1378 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Implement schema for usages
Issue #1179 asks to add usage information to the ontology detail pages. Before we can do that, we need to standardize that information. #1008 points out that there are different formats in the registry right now. The current schema just allows the `usages` key without any constraint:
https://github.com/OBOFoundry/OBOFoundry.github.io/blob/master/util/schema/registry_schema.json#L417
So the steps are:
- [ ] implement a JSON Schema for usages based on @beckyjackson's suggestion in #1008
- [ ] update all registry entries to conform to the new schema
- [ ] update [ontology_detail.html](https://github.com/OBOFoundry/OBOFoundry.github.io/blob/master/_layouts/ontology_detail.html) layout to add the usages #1179
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `util/validate-metadata.py`
Content:
```
1 #!/usr/bin/env python3
2
3 import json
4 import jsonschema
5 import os
6 import re
7 import sys
8 import yaml
9
10 from argparse import ArgumentParser
11
12
13 # Path to JSON schema file:
14 SCHEMA_FILE = 'util/schema/registry_schema.json'
15
16 # The metadata grid to be generated:
17 metadata_grid = {}
18
19
20 def main(args):
21 global metadata_grid
22 parser = ArgumentParser(description='''
23 Validate registry metadata in the given YAML file yaml_infile and produce two output files:
24 1) violations_outfile: a CSV, TSV, or TXT file which contain all metadata violations, and
25 2) grid_outfile: a CSV, TSV, or TXT file which will contain a custom sorted metadata grid''')
26 parser.add_argument('yaml_infile', type=str, help='YAML file containing registry data')
27 parser.add_argument('violations_outfile', type=str,
28 help='Output file (CSV, TSV, or TXT) to contain metadata violations')
29 parser.add_argument('grid_outfile', type=str,
30 help='Output file (CSV, TSV, or TXT) to contain custom sorted metadata grid')
31 args = parser.parse_args()
32
33 yaml_infile = args.yaml_infile
34 violations_outfile = args.violations_outfile
35 grid_outfile = args.grid_outfile
36
37 # Load in the YAML and the JSON schemas that we will need:
38 data = load_data(yaml_infile)
39 schema = get_schema()
40
41 results = {'error': [], 'warn': [], 'info': []}
42
43 # Validate each object
44 for item in data["ontologies"]:
45 add = validate_metadata(item, schema)
46 results = update_results(results, add)
47
48 # save the metadata-grid with ALL results
49 headers = []
50 for s in schema['properties']:
51 if 'level' in s:
52 headers.append(s)
53 save_grid(metadata_grid, headers, grid_outfile)
54
55 # print and save the results that did not pass
56 print_results(results)
57 save_results(results, violations_outfile)
58 if results['error']:
59 print('Metadata validation failed with %d errors - see %s for details'
60 % (len(results['error']), violations_outfile))
61 sys.exit(1)
62 else:
63 print('Metadata validation passed - see %s for warnings' % violations_outfile)
64 sys.exit(0)
65
66
67 def load_data(yaml_infile):
68 '''Given a YAML data file, load the data to validate.'''
69 with open(yaml_infile, 'r') as stream:
70 data = yaml.load(stream, Loader=yaml.SafeLoader)
71 return data
72
73
74 def get_schema():
75 '''Return a schema from the master schema directory.'''
76 schema = None
77 try:
78 file = SCHEMA_FILE
79 with open(file, 'r') as s:
80 schema = json.load(s)
81 except Exception as e:
82 print('Unable to load %s: %s' % (f, str(e)))
83 return schema
84
85
86 def validate_metadata(item, schema):
87 '''Given an item and a schema, validate the item against the
88 schema. Add the full results to the metadata_grid and return a map of
89 errors, warnings, and infos for any active ontologies.'''
90 global metadata_grid
91
92 ont_id = item['id']
93 # these lists will be displayed on the console:
94 errors = []
95 warnings = []
96 infos = []
97 # these results are put into the metadata grid:
98 results = {}
99
100 # determine how to sort this item in the grid:
101 results['foundry'] = True if item.get('in_foundry_order') == 1 else False
102 results['obsolete'] = True if item.get('is_obsolete') is True else False
103 # if there is no status, put them at the bottom with inactive:
104 results['ontology_status'] = item['activity_status'] if 'activity_status' in item else 'inactive'
105
106 has_error = False
107 has_warn = False
108 has_info = False
109 try:
110 jsonschema.validate(item, schema)
111 except jsonschema.exceptions.ValidationError as ve:
112 title = list(ve.absolute_schema_path)[0] # Find the named section within the schema
113 if title == "required":
114 field_names = re.findall(r"\'(.*?)\'", ve.message) # Rather get which field
115 if len(field_names) > 0:
116 title = field_names[0]
117 if title == "properties":
118 title = list(ve.absolute_schema_path)[1] # Get which field
119 # Get the schema "level" for this field dynamically, if we can
120 if title in list(ve.absolute_schema_path) or title in schema['properties']:
121 if title in list(ve.absolute_schema_path):
122 title_index = list(ve.absolute_schema_path).index(title)
123 path = list(ve.absolute_schema_path)[0:(title_index+1)]
124 else:
125 path = ['properties',title]
126 abs_schema = schema
127 for schema_item in path:
128 if schema_item in abs_schema:
129 if 'level' in abs_schema[schema_item]:
130 level = abs_schema[schema_item]['level']
131 abs_schema = abs_schema[schema_item]
132
133 # add to the results map
134 results[title] = level
135
136 # flag for errors, warnings, and infos
137 # without adding results to the lists that are logged
138 if level == 'error':
139 has_error = True
140 elif level == 'warning':
141 has_warn = True
142 elif level == 'info':
143 has_info = True
144
145 # these cases will not cause test failure and will not be logged
146 # the results are just added to the metadata grid:
147 # - orphaned ontology on contact or license check
148 # - inactive ontology
149 # - obsolete ontology
150 # - ontology annotated with `validate: false`
151 if not ( (item.get('activity_status') == 'orphaned' and \
152 title in ['contact', 'license', 'license-lite']) or \
153 (item.get('is_obsolete') is True or item.get('activity_status') == 'inactive' or \
154 item.get('validate') is False) ):
155 # get a message for displaying on terminal
156 msg = ve.message
157 if title in ['license', 'license-lite']:
158 # license error message can show up in a few different ways
159 search = re.search('\'(.+?)\' is not one of', msg)
160 if search:
161 msg = '\'%s\' is not a recommended license' % search.group(1)
162 else:
163 search = re.search('({\'label\'.+?\'url\'.+?}) is not valid', msg)
164 if search:
165 msg = format_license_msg(search.group(1))
166 else:
167 search = re.search('({\'url\'.+?\'label\'.+?}) is not valid', msg)
168 if search:
169 msg = format_license_msg(search.group(1))
170
171 # format the message with the ontology ID
172 msg = '%s %s: %s' % (ont_id.upper(), title, msg)
173
174 # append to correct set of warnings
175 if level == 'error':
176 errors.append(msg)
177 elif level == 'warning':
178 # warnings are recommended fixes, not required
179 if 'required' in msg:
180 msg = msg.replace('required', 'recommended')
181 warnings.append(msg)
182 elif level == 'info':
183 infos.append(msg)
184
185 # add an overall validation status to the grid entry
186 if has_error:
187 results['validation_status'] = 'FAIL'
188 elif has_warn:
189 results['validation_status'] = 'WARN'
190 elif has_info:
191 results['validation_status'] = 'INFO'
192 else:
193 results['validation_status'] = 'PASS'
194 metadata_grid[ont_id] = results
195
196 return {'error': errors, 'warn': warnings, 'info': infos}
197
198
199 def format_license_msg(substr):
200 '''Format an exception message for a license issue.'''
201 # process to dict
202 d = json.loads(substr.replace('\'', '"'))
203 url = d['url']
204 label = d['label']
205 return '\'{0}\' <{1}> is not a recommended license'.format(label, url)
206
207
208 def update_results(results, add):
209 '''Given a map of results for all ontologies and a map of results to add,
210 append the results to the lists in the map.'''
211 results['error'] = results['error'] + add['error']
212 results['warn'] = results['warn'] + add['warn']
213 results['info'] = results['info'] + add['info']
214 return results
215
216
217 def sort_grid(metadata_grid):
218 """
219 Given a metadata grid as a map, sort the grid based on:
220 1. Foundry status
221 2. Ontology activity status
222 3. Validation status
223 4. Alphabetical
224 Return a sorted list of IDs.
225 """
226 foundry = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}
227 active = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}
228 orphaned = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}
229 inactive = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}
230 obsolete = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}
231
232 for ont_id, results in metadata_grid.items():
233 # get the info about the ontology to sort on
234 ontology_status = results['ontology_status']
235 validation_status = results['validation_status']
236
237 # foundry ontologies are displayed first
238 # they must be active
239 if results['foundry']:
240 foundry[validation_status].append(ont_id)
241 continue
242
243 # obsolete ontologies are displayed last
244 # they are always inactive
245 # (inactive does not mean obsolete)
246 if results['obsolete']:
247 obsolete[validation_status].append(ont_id)
248 continue
249
250 # finally, sort by: active, orphaned, inactive
251 if ontology_status == 'active':
252 active[validation_status].append(ont_id)
253 elif ontology_status == 'orphaned':
254 orphaned[validation_status].append(ont_id)
255 elif ontology_status == 'inactive':
256 inactive[validation_status].append(ont_id)
257
258 # concatenate everything to a sorted list:
259 def sort_list(arr):
260 arr.sort(key=str.lower)
261 if not arr:
262 return []
263 return arr
264
265 sort = []
266 for ont_type in [foundry, active, orphaned, inactive, obsolete]:
267 for v_status in ['PASS', 'INFO', 'WARN', 'FAIL']:
268 sort = sort + sort_list(ont_type[v_status])
269
270 return sort
271
272
273 def save_grid(metadata_grid, headers, grid_outfile):
274 '''Given a metadata grid of all results and a grid file to write to, create
275 a sorted table of the full results.'''
276 if '.csv' in grid_outfile:
277 separator = ','
278 elif '.tsv' or '.txt' in grid_outfile:
279 separator = '\t'
280 else:
281 print('Grid file must be CSV, TSV, or TXT', file=sys.stderr)
282 return
283
284 # Determine order of ontologies based on statuses
285 sort_order = sort_grid(metadata_grid)
286
287 # First three help to see overall details
288 header = 'Ontology{0}Activity Status{0}Validation Status'.format(separator)
289 # After that, we show the results of each check
290 for h in headers:
291 header += separator + h
292 header += '\n'
293
294 with open(grid_outfile, 'w') as f:
295 f.write(header)
296 for ont_id in sort_order:
297 results = metadata_grid[ont_id]
298 s = '{1}{0}{2}{0}{3}'.format(separator, ont_id, results['ontology_status'],
299 results['validation_status'])
300 for h in headers:
301 if h == 'license':
302 # license has two checks
303 # so the license entry will be the more severe violation
304 all_res = [results['license'], results['license-lite']]
305 if 'error' in all_res:
306 s += separator + 'error'
307 elif 'warning' in all_res:
308 s += separator + 'warning'
309 elif 'info' in all_res:
310 s += separator + 'info'
311 else:
312 s += separator + 'pass'
313 continue
314 s += separator + results[h]
315 s += '\n'
316 f.write(s)
317
318 print('Full validation results written to %s' % grid_outfile)
319
320
321 def print_results(results):
322 '''Given a map of results, log results on the console.'''
323 for level, messages in results.items():
324 for m in messages:
325 print('%s\t%s' % (level.upper(), m))
326
327
328 def save_results(results, violations_outfile):
329 '''Given a map of results and an output file to write to, write each result
330 on a line.'''
331 if '.csv' in violations_outfile:
332 separator = ','
333 elif '.tsv' or '.txt' in violations_outfile:
334 separator = '\t'
335 else:
336 print('Output file must be CSV, TSV, or TXT', file=sys.stderr)
337 return
338 with open(violations_outfile, 'w') as f:
339 f.write('Level%sMessage\n' % separator)
340 for level, messages in results.items():
341 for m in messages:
342 f.write('%s%s%s\n' % (level.upper(), separator, m))
343
344
345 if __name__ == '__main__':
346 main(sys.argv)
347
```
--- 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/util/validate-metadata.py b/util/validate-metadata.py
--- a/util/validate-metadata.py
+++ b/util/validate-metadata.py
@@ -79,7 +79,7 @@
with open(file, 'r') as s:
schema = json.load(s)
except Exception as e:
- print('Unable to load %s: %s' % (f, str(e)))
+ print('Unable to load %s: %s' % (file, str(e)))
return schema
| {"golden_diff": "diff --git a/util/validate-metadata.py b/util/validate-metadata.py\n--- a/util/validate-metadata.py\n+++ b/util/validate-metadata.py\n@@ -79,7 +79,7 @@\n with open(file, 'r') as s:\n schema = json.load(s)\n except Exception as e:\n- print('Unable to load %s: %s' % (f, str(e)))\n+ print('Unable to load %s: %s' % (file, str(e)))\n return schema\n", "issue": "Implement schema for usages\nIssue #1179 asks to add usage information to the ontology detail pages. Before we can do that, we need to standardize that information. #1008 points out that there are different formats in the registry right now. The current schema just allows the `usages` key without any constraint:\r\n\r\nhttps://github.com/OBOFoundry/OBOFoundry.github.io/blob/master/util/schema/registry_schema.json#L417\r\n\r\nSo the steps are:\r\n\r\n- [ ] implement a JSON Schema for usages based on @beckyjackson's suggestion in #1008 \r\n- [ ] update all registry entries to conform to the new schema\r\n- [ ] update [ontology_detail.html](https://github.com/OBOFoundry/OBOFoundry.github.io/blob/master/_layouts/ontology_detail.html) layout to add the usages #1179 \n", "before_files": [{"content": "#!/usr/bin/env python3\n\nimport json\nimport jsonschema\nimport os\nimport re\nimport sys\nimport yaml\n\nfrom argparse import ArgumentParser\n\n\n# Path to JSON schema file:\nSCHEMA_FILE = 'util/schema/registry_schema.json'\n\n# The metadata grid to be generated:\nmetadata_grid = {}\n\n\ndef main(args):\n global metadata_grid\n parser = ArgumentParser(description='''\n Validate registry metadata in the given YAML file yaml_infile and produce two output files:\n 1) violations_outfile: a CSV, TSV, or TXT file which contain all metadata violations, and\n 2) grid_outfile: a CSV, TSV, or TXT file which will contain a custom sorted metadata grid''')\n parser.add_argument('yaml_infile', type=str, help='YAML file containing registry data')\n parser.add_argument('violations_outfile', type=str,\n help='Output file (CSV, TSV, or TXT) to contain metadata violations')\n parser.add_argument('grid_outfile', type=str,\n help='Output file (CSV, TSV, or TXT) to contain custom sorted metadata grid')\n args = parser.parse_args()\n\n yaml_infile = args.yaml_infile\n violations_outfile = args.violations_outfile\n grid_outfile = args.grid_outfile\n\n # Load in the YAML and the JSON schemas that we will need:\n data = load_data(yaml_infile)\n schema = get_schema()\n\n results = {'error': [], 'warn': [], 'info': []}\n\n # Validate each object\n for item in data[\"ontologies\"]:\n add = validate_metadata(item, schema)\n results = update_results(results, add)\n\n # save the metadata-grid with ALL results\n headers = []\n for s in schema['properties']:\n if 'level' in s:\n headers.append(s)\n save_grid(metadata_grid, headers, grid_outfile)\n\n # print and save the results that did not pass\n print_results(results)\n save_results(results, violations_outfile)\n if results['error']:\n print('Metadata validation failed with %d errors - see %s for details'\n % (len(results['error']), violations_outfile))\n sys.exit(1)\n else:\n print('Metadata validation passed - see %s for warnings' % violations_outfile)\n sys.exit(0)\n\n\ndef load_data(yaml_infile):\n '''Given a YAML data file, load the data to validate.'''\n with open(yaml_infile, 'r') as stream:\n data = yaml.load(stream, Loader=yaml.SafeLoader)\n return data\n\n\ndef get_schema():\n '''Return a schema from the master schema directory.'''\n schema = None\n try:\n file = SCHEMA_FILE\n with open(file, 'r') as s:\n schema = json.load(s)\n except Exception as e:\n print('Unable to load %s: %s' % (f, str(e)))\n return schema\n\n\ndef validate_metadata(item, schema):\n '''Given an item and a schema, validate the item against the\n schema. Add the full results to the metadata_grid and return a map of\n errors, warnings, and infos for any active ontologies.'''\n global metadata_grid\n\n ont_id = item['id']\n # these lists will be displayed on the console:\n errors = []\n warnings = []\n infos = []\n # these results are put into the metadata grid:\n results = {}\n\n # determine how to sort this item in the grid:\n results['foundry'] = True if item.get('in_foundry_order') == 1 else False\n results['obsolete'] = True if item.get('is_obsolete') is True else False\n # if there is no status, put them at the bottom with inactive:\n results['ontology_status'] = item['activity_status'] if 'activity_status' in item else 'inactive'\n\n has_error = False\n has_warn = False\n has_info = False\n try:\n jsonschema.validate(item, schema)\n except jsonschema.exceptions.ValidationError as ve:\n title = list(ve.absolute_schema_path)[0] # Find the named section within the schema\n if title == \"required\":\n field_names = re.findall(r\"\\'(.*?)\\'\", ve.message) # Rather get which field\n if len(field_names) > 0:\n title = field_names[0]\n if title == \"properties\":\n title = list(ve.absolute_schema_path)[1] # Get which field\n # Get the schema \"level\" for this field dynamically, if we can\n if title in list(ve.absolute_schema_path) or title in schema['properties']:\n if title in list(ve.absolute_schema_path):\n title_index = list(ve.absolute_schema_path).index(title)\n path = list(ve.absolute_schema_path)[0:(title_index+1)]\n else:\n path = ['properties',title]\n abs_schema = schema\n for schema_item in path:\n if schema_item in abs_schema:\n if 'level' in abs_schema[schema_item]:\n level = abs_schema[schema_item]['level']\n abs_schema = abs_schema[schema_item]\n\n # add to the results map\n results[title] = level\n\n # flag for errors, warnings, and infos\n # without adding results to the lists that are logged\n if level == 'error':\n has_error = True\n elif level == 'warning':\n has_warn = True\n elif level == 'info':\n has_info = True\n\n # these cases will not cause test failure and will not be logged\n # the results are just added to the metadata grid:\n # - orphaned ontology on contact or license check\n # - inactive ontology\n # - obsolete ontology\n # - ontology annotated with `validate: false`\n if not ( (item.get('activity_status') == 'orphaned' and \\\n title in ['contact', 'license', 'license-lite']) or \\\n (item.get('is_obsolete') is True or item.get('activity_status') == 'inactive' or \\\n item.get('validate') is False) ):\n # get a message for displaying on terminal\n msg = ve.message\n if title in ['license', 'license-lite']:\n # license error message can show up in a few different ways\n search = re.search('\\'(.+?)\\' is not one of', msg)\n if search:\n msg = '\\'%s\\' is not a recommended license' % search.group(1)\n else:\n search = re.search('({\\'label\\'.+?\\'url\\'.+?}) is not valid', msg)\n if search:\n msg = format_license_msg(search.group(1))\n else:\n search = re.search('({\\'url\\'.+?\\'label\\'.+?}) is not valid', msg)\n if search:\n msg = format_license_msg(search.group(1))\n\n # format the message with the ontology ID\n msg = '%s %s: %s' % (ont_id.upper(), title, msg)\n\n # append to correct set of warnings\n if level == 'error':\n errors.append(msg)\n elif level == 'warning':\n # warnings are recommended fixes, not required\n if 'required' in msg:\n msg = msg.replace('required', 'recommended')\n warnings.append(msg)\n elif level == 'info':\n infos.append(msg)\n\n # add an overall validation status to the grid entry\n if has_error:\n results['validation_status'] = 'FAIL'\n elif has_warn:\n results['validation_status'] = 'WARN'\n elif has_info:\n results['validation_status'] = 'INFO'\n else:\n results['validation_status'] = 'PASS'\n metadata_grid[ont_id] = results\n\n return {'error': errors, 'warn': warnings, 'info': infos}\n\n\ndef format_license_msg(substr):\n '''Format an exception message for a license issue.'''\n # process to dict\n d = json.loads(substr.replace('\\'', '\"'))\n url = d['url']\n label = d['label']\n return '\\'{0}\\' <{1}> is not a recommended license'.format(label, url)\n\n\ndef update_results(results, add):\n '''Given a map of results for all ontologies and a map of results to add,\n append the results to the lists in the map.'''\n results['error'] = results['error'] + add['error']\n results['warn'] = results['warn'] + add['warn']\n results['info'] = results['info'] + add['info']\n return results\n\n\ndef sort_grid(metadata_grid):\n \"\"\"\n Given a metadata grid as a map, sort the grid based on:\n 1. Foundry status\n 2. Ontology activity status\n 3. Validation status\n 4. Alphabetical\n Return a sorted list of IDs.\n \"\"\"\n foundry = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}\n active = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}\n orphaned = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}\n inactive = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}\n obsolete = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}\n\n for ont_id, results in metadata_grid.items():\n # get the info about the ontology to sort on\n ontology_status = results['ontology_status']\n validation_status = results['validation_status']\n\n # foundry ontologies are displayed first\n # they must be active\n if results['foundry']:\n foundry[validation_status].append(ont_id)\n continue\n\n # obsolete ontologies are displayed last\n # they are always inactive\n # (inactive does not mean obsolete)\n if results['obsolete']:\n obsolete[validation_status].append(ont_id)\n continue\n\n # finally, sort by: active, orphaned, inactive\n if ontology_status == 'active':\n active[validation_status].append(ont_id)\n elif ontology_status == 'orphaned':\n orphaned[validation_status].append(ont_id)\n elif ontology_status == 'inactive':\n inactive[validation_status].append(ont_id)\n\n # concatenate everything to a sorted list:\n def sort_list(arr):\n arr.sort(key=str.lower)\n if not arr:\n return []\n return arr\n\n sort = []\n for ont_type in [foundry, active, orphaned, inactive, obsolete]:\n for v_status in ['PASS', 'INFO', 'WARN', 'FAIL']:\n sort = sort + sort_list(ont_type[v_status])\n\n return sort\n\n\ndef save_grid(metadata_grid, headers, grid_outfile):\n '''Given a metadata grid of all results and a grid file to write to, create\n a sorted table of the full results.'''\n if '.csv' in grid_outfile:\n separator = ','\n elif '.tsv' or '.txt' in grid_outfile:\n separator = '\\t'\n else:\n print('Grid file must be CSV, TSV, or TXT', file=sys.stderr)\n return\n\n # Determine order of ontologies based on statuses\n sort_order = sort_grid(metadata_grid)\n\n # First three help to see overall details\n header = 'Ontology{0}Activity Status{0}Validation Status'.format(separator)\n # After that, we show the results of each check\n for h in headers:\n header += separator + h\n header += '\\n'\n\n with open(grid_outfile, 'w') as f:\n f.write(header)\n for ont_id in sort_order:\n results = metadata_grid[ont_id]\n s = '{1}{0}{2}{0}{3}'.format(separator, ont_id, results['ontology_status'],\n results['validation_status'])\n for h in headers:\n if h == 'license':\n # license has two checks\n # so the license entry will be the more severe violation\n all_res = [results['license'], results['license-lite']]\n if 'error' in all_res:\n s += separator + 'error'\n elif 'warning' in all_res:\n s += separator + 'warning'\n elif 'info' in all_res:\n s += separator + 'info'\n else:\n s += separator + 'pass'\n continue\n s += separator + results[h]\n s += '\\n'\n f.write(s)\n\n print('Full validation results written to %s' % grid_outfile)\n\n\ndef print_results(results):\n '''Given a map of results, log results on the console.'''\n for level, messages in results.items():\n for m in messages:\n print('%s\\t%s' % (level.upper(), m))\n\n\ndef save_results(results, violations_outfile):\n '''Given a map of results and an output file to write to, write each result\n on a line.'''\n if '.csv' in violations_outfile:\n separator = ','\n elif '.tsv' or '.txt' in violations_outfile:\n separator = '\\t'\n else:\n print('Output file must be CSV, TSV, or TXT', file=sys.stderr)\n return\n with open(violations_outfile, 'w') as f:\n f.write('Level%sMessage\\n' % separator)\n for level, messages in results.items():\n for m in messages:\n f.write('%s%s%s\\n' % (level.upper(), separator, m))\n\n\nif __name__ == '__main__':\n main(sys.argv)\n", "path": "util/validate-metadata.py"}], "after_files": [{"content": "#!/usr/bin/env python3\n\nimport json\nimport jsonschema\nimport os\nimport re\nimport sys\nimport yaml\n\nfrom argparse import ArgumentParser\n\n\n# Path to JSON schema file:\nSCHEMA_FILE = 'util/schema/registry_schema.json'\n\n# The metadata grid to be generated:\nmetadata_grid = {}\n\n\ndef main(args):\n global metadata_grid\n parser = ArgumentParser(description='''\n Validate registry metadata in the given YAML file yaml_infile and produce two output files:\n 1) violations_outfile: a CSV, TSV, or TXT file which contain all metadata violations, and\n 2) grid_outfile: a CSV, TSV, or TXT file which will contain a custom sorted metadata grid''')\n parser.add_argument('yaml_infile', type=str, help='YAML file containing registry data')\n parser.add_argument('violations_outfile', type=str,\n help='Output file (CSV, TSV, or TXT) to contain metadata violations')\n parser.add_argument('grid_outfile', type=str,\n help='Output file (CSV, TSV, or TXT) to contain custom sorted metadata grid')\n args = parser.parse_args()\n\n yaml_infile = args.yaml_infile\n violations_outfile = args.violations_outfile\n grid_outfile = args.grid_outfile\n\n # Load in the YAML and the JSON schemas that we will need:\n data = load_data(yaml_infile)\n schema = get_schema()\n\n results = {'error': [], 'warn': [], 'info': []}\n\n # Validate each object\n for item in data[\"ontologies\"]:\n add = validate_metadata(item, schema)\n results = update_results(results, add)\n\n # save the metadata-grid with ALL results\n headers = []\n for s in schema['properties']:\n if 'level' in s:\n headers.append(s)\n save_grid(metadata_grid, headers, grid_outfile)\n\n # print and save the results that did not pass\n print_results(results)\n save_results(results, violations_outfile)\n if results['error']:\n print('Metadata validation failed with %d errors - see %s for details'\n % (len(results['error']), violations_outfile))\n sys.exit(1)\n else:\n print('Metadata validation passed - see %s for warnings' % violations_outfile)\n sys.exit(0)\n\n\ndef load_data(yaml_infile):\n '''Given a YAML data file, load the data to validate.'''\n with open(yaml_infile, 'r') as stream:\n data = yaml.load(stream, Loader=yaml.SafeLoader)\n return data\n\n\ndef get_schema():\n '''Return a schema from the master schema directory.'''\n schema = None\n try:\n file = SCHEMA_FILE\n with open(file, 'r') as s:\n schema = json.load(s)\n except Exception as e:\n print('Unable to load %s: %s' % (file, str(e)))\n return schema\n\n\ndef validate_metadata(item, schema):\n '''Given an item and a schema, validate the item against the\n schema. Add the full results to the metadata_grid and return a map of\n errors, warnings, and infos for any active ontologies.'''\n global metadata_grid\n\n ont_id = item['id']\n # these lists will be displayed on the console:\n errors = []\n warnings = []\n infos = []\n # these results are put into the metadata grid:\n results = {}\n\n # determine how to sort this item in the grid:\n results['foundry'] = True if item.get('in_foundry_order') == 1 else False\n results['obsolete'] = True if item.get('is_obsolete') is True else False\n # if there is no status, put them at the bottom with inactive:\n results['ontology_status'] = item['activity_status'] if 'activity_status' in item else 'inactive'\n\n has_error = False\n has_warn = False\n has_info = False\n try:\n jsonschema.validate(item, schema)\n except jsonschema.exceptions.ValidationError as ve:\n title = list(ve.absolute_schema_path)[0] # Find the named section within the schema\n if title == \"required\":\n field_names = re.findall(r\"\\'(.*?)\\'\", ve.message) # Rather get which field\n if len(field_names) > 0:\n title = field_names[0]\n if title == \"properties\":\n title = list(ve.absolute_schema_path)[1] # Get which field\n # Get the schema \"level\" for this field dynamically, if we can\n if title in list(ve.absolute_schema_path) or title in schema['properties']:\n if title in list(ve.absolute_schema_path):\n title_index = list(ve.absolute_schema_path).index(title)\n path = list(ve.absolute_schema_path)[0:(title_index+1)]\n else:\n path = ['properties',title]\n abs_schema = schema\n for schema_item in path:\n if schema_item in abs_schema:\n if 'level' in abs_schema[schema_item]:\n level = abs_schema[schema_item]['level']\n abs_schema = abs_schema[schema_item]\n\n # add to the results map\n results[title] = level\n\n # flag for errors, warnings, and infos\n # without adding results to the lists that are logged\n if level == 'error':\n has_error = True\n elif level == 'warning':\n has_warn = True\n elif level == 'info':\n has_info = True\n\n # these cases will not cause test failure and will not be logged\n # the results are just added to the metadata grid:\n # - orphaned ontology on contact or license check\n # - inactive ontology\n # - obsolete ontology\n # - ontology annotated with `validate: false`\n if not ( (item.get('activity_status') == 'orphaned' and \\\n title in ['contact', 'license', 'license-lite']) or \\\n (item.get('is_obsolete') is True or item.get('activity_status') == 'inactive' or \\\n item.get('validate') is False) ):\n # get a message for displaying on terminal\n msg = ve.message\n if title in ['license', 'license-lite']:\n # license error message can show up in a few different ways\n search = re.search('\\'(.+?)\\' is not one of', msg)\n if search:\n msg = '\\'%s\\' is not a recommended license' % search.group(1)\n else:\n search = re.search('({\\'label\\'.+?\\'url\\'.+?}) is not valid', msg)\n if search:\n msg = format_license_msg(search.group(1))\n else:\n search = re.search('({\\'url\\'.+?\\'label\\'.+?}) is not valid', msg)\n if search:\n msg = format_license_msg(search.group(1))\n\n # format the message with the ontology ID\n msg = '%s %s: %s' % (ont_id.upper(), title, msg)\n\n # append to correct set of warnings\n if level == 'error':\n errors.append(msg)\n elif level == 'warning':\n # warnings are recommended fixes, not required\n if 'required' in msg:\n msg = msg.replace('required', 'recommended')\n warnings.append(msg)\n elif level == 'info':\n infos.append(msg)\n\n # add an overall validation status to the grid entry\n if has_error:\n results['validation_status'] = 'FAIL'\n elif has_warn:\n results['validation_status'] = 'WARN'\n elif has_info:\n results['validation_status'] = 'INFO'\n else:\n results['validation_status'] = 'PASS'\n metadata_grid[ont_id] = results\n\n return {'error': errors, 'warn': warnings, 'info': infos}\n\n\ndef format_license_msg(substr):\n '''Format an exception message for a license issue.'''\n # process to dict\n d = json.loads(substr.replace('\\'', '\"'))\n url = d['url']\n label = d['label']\n return '\\'{0}\\' <{1}> is not a recommended license'.format(label, url)\n\n\ndef update_results(results, add):\n '''Given a map of results for all ontologies and a map of results to add,\n append the results to the lists in the map.'''\n results['error'] = results['error'] + add['error']\n results['warn'] = results['warn'] + add['warn']\n results['info'] = results['info'] + add['info']\n return results\n\n\ndef sort_grid(metadata_grid):\n \"\"\"\n Given a metadata grid as a map, sort the grid based on:\n 1. Foundry status\n 2. Ontology activity status\n 3. Validation status\n 4. Alphabetical\n Return a sorted list of IDs.\n \"\"\"\n foundry = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}\n active = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}\n orphaned = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}\n inactive = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}\n obsolete = {'PASS': [], 'INFO': [], 'WARN': [], 'FAIL': []}\n\n for ont_id, results in metadata_grid.items():\n # get the info about the ontology to sort on\n ontology_status = results['ontology_status']\n validation_status = results['validation_status']\n\n # foundry ontologies are displayed first\n # they must be active\n if results['foundry']:\n foundry[validation_status].append(ont_id)\n continue\n\n # obsolete ontologies are displayed last\n # they are always inactive\n # (inactive does not mean obsolete)\n if results['obsolete']:\n obsolete[validation_status].append(ont_id)\n continue\n\n # finally, sort by: active, orphaned, inactive\n if ontology_status == 'active':\n active[validation_status].append(ont_id)\n elif ontology_status == 'orphaned':\n orphaned[validation_status].append(ont_id)\n elif ontology_status == 'inactive':\n inactive[validation_status].append(ont_id)\n\n # concatenate everything to a sorted list:\n def sort_list(arr):\n arr.sort(key=str.lower)\n if not arr:\n return []\n return arr\n\n sort = []\n for ont_type in [foundry, active, orphaned, inactive, obsolete]:\n for v_status in ['PASS', 'INFO', 'WARN', 'FAIL']:\n sort = sort + sort_list(ont_type[v_status])\n\n return sort\n\n\ndef save_grid(metadata_grid, headers, grid_outfile):\n '''Given a metadata grid of all results and a grid file to write to, create\n a sorted table of the full results.'''\n if '.csv' in grid_outfile:\n separator = ','\n elif '.tsv' or '.txt' in grid_outfile:\n separator = '\\t'\n else:\n print('Grid file must be CSV, TSV, or TXT', file=sys.stderr)\n return\n\n # Determine order of ontologies based on statuses\n sort_order = sort_grid(metadata_grid)\n\n # First three help to see overall details\n header = 'Ontology{0}Activity Status{0}Validation Status'.format(separator)\n # After that, we show the results of each check\n for h in headers:\n header += separator + h\n header += '\\n'\n\n with open(grid_outfile, 'w') as f:\n f.write(header)\n for ont_id in sort_order:\n results = metadata_grid[ont_id]\n s = '{1}{0}{2}{0}{3}'.format(separator, ont_id, results['ontology_status'],\n results['validation_status'])\n for h in headers:\n if h == 'license':\n # license has two checks\n # so the license entry will be the more severe violation\n all_res = [results['license'], results['license-lite']]\n if 'error' in all_res:\n s += separator + 'error'\n elif 'warning' in all_res:\n s += separator + 'warning'\n elif 'info' in all_res:\n s += separator + 'info'\n else:\n s += separator + 'pass'\n continue\n s += separator + results[h]\n s += '\\n'\n f.write(s)\n\n print('Full validation results written to %s' % grid_outfile)\n\n\ndef print_results(results):\n '''Given a map of results, log results on the console.'''\n for level, messages in results.items():\n for m in messages:\n print('%s\\t%s' % (level.upper(), m))\n\n\ndef save_results(results, violations_outfile):\n '''Given a map of results and an output file to write to, write each result\n on a line.'''\n if '.csv' in violations_outfile:\n separator = ','\n elif '.tsv' or '.txt' in violations_outfile:\n separator = '\\t'\n else:\n print('Output file must be CSV, TSV, or TXT', file=sys.stderr)\n return\n with open(violations_outfile, 'w') as f:\n f.write('Level%sMessage\\n' % separator)\n for level, messages in results.items():\n for m in messages:\n f.write('%s%s%s\\n' % (level.upper(), separator, m))\n\n\nif __name__ == '__main__':\n main(sys.argv)\n", "path": "util/validate-metadata.py"}]} |
gh_patches_debug_226 | rasdani/github-patches | git_diff | mars-project__mars-126 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Implement __array__ protocol for Tensor
**Is your feature request related to a problem? Please describe.**
By now, Mars tensor does not implement `__array__` protocol, so if `numpy.asarray` is called, will not get the right result.
**Describe the solution you'd like**
Call `execute` inside `__array__` function.
**Additional context**
Consider the [`__array_function__` protocol ](https://www.numpy.org/neps/nep-0018-array-function-protocol.html) also.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `mars/tensor/core.py`
Content:
```
1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3 # Copyright 1999-2018 Alibaba Group Holding Ltd.
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16
17
18 import itertools
19 from operator import attrgetter, mul
20 from weakref import WeakKeyDictionary, ref
21 from collections import Iterable
22 import threading
23
24 import numpy as np
25
26 from ..core import Entity
27 from ..compat import builtins, reduce
28 from ..graph import DAG
29 from ..tiles import Tilesable, handler
30 from ..serialize import SerializableWithKey, ValueType, ProviderType, \
31 ListField, TupleField, DictField, DataTypeField, KeyField, BoolField
32 from ..utils import AttributeDict, on_serialize_shape, on_deserialize_shape, tokenize
33 from .expressions.utils import get_chunk_slices
34
35
36 class ChunkData(SerializableWithKey):
37 __slots__ = '__weakref__',
38
39 # required fields
40 _shape = TupleField('shape', ValueType.int64,
41 on_serialize=on_serialize_shape, on_deserialize=on_deserialize_shape)
42 _op = KeyField('op') # store key of operand here
43 # optional fields
44 _dtype = DataTypeField('dtype')
45 _index = TupleField('index', ValueType.uint32)
46 _cached = BoolField('cached')
47 _composed = ListField('composed', ValueType.reference('self'))
48 _params = DictField('params', key_type=ValueType.string, on_deserialize=AttributeDict)
49
50 def __init__(self, *args, **kwargs):
51 extras = AttributeDict((k, kwargs.pop(k)) for k in set(kwargs) - set(self.__slots__))
52 kwargs['_params'] = kwargs.pop('_params', extras)
53 super(ChunkData, self).__init__(*args, **kwargs)
54
55 def __repr__(self):
56 return 'Chunk <op={0}, key={1}>'.format(self.op.__class__.__name__, self.key)
57
58 @classmethod
59 def cls(cls, provider):
60 if provider.type == ProviderType.protobuf:
61 from ..serialize.protos.chunk_pb2 import ChunkDef
62 return ChunkDef
63 return super(ChunkData, cls).cls(provider)
64
65 @property
66 def shape(self):
67 return getattr(self, '_shape', None)
68
69 @property
70 def ndim(self):
71 return len(self.shape)
72
73 @property
74 def index(self):
75 return getattr(self, '_index', None)
76
77 @property
78 def op(self):
79 try:
80 return self._op
81 except AttributeError:
82 return None
83
84 @property
85 def cached(self):
86 return getattr(self, '_cached', None)
87
88 @property
89 def inputs(self):
90 return self.op.inputs
91
92 @inputs.setter
93 def inputs(self, new_inputs):
94 self.op.inputs = new_inputs
95
96 @property
97 def dtype(self):
98 return getattr(self, '_dtype', None) or self.op.dtype
99
100 @property
101 def nbytes(self):
102 return np.prod(self.shape) * self.dtype.itemsize
103
104 @property
105 def composed(self):
106 return getattr(self, '_composed', None)
107
108 @property
109 def device(self):
110 return self.op.device
111
112 def is_sparse(self):
113 return self.op.is_sparse()
114
115 issparse = is_sparse
116
117 def update_key(self):
118 object.__setattr__(self, '_key', tokenize(
119 type(self), *(getattr(self, k, None) for k in self.__slots__ if k != '_index')))
120
121
122 class Chunk(Entity):
123 __slots__ = ()
124 _allow_data_type_ = (ChunkData,)
125
126
127 class TensorData(SerializableWithKey, Tilesable):
128 __slots__ = '__weakref__', '_siblings', '_cix'
129 _no_copy_attrs_ = SerializableWithKey._no_copy_attrs_ | {'_cix'}
130
131 # required fields
132 _shape = TupleField('shape', ValueType.int64,
133 on_serialize=on_serialize_shape, on_deserialize=on_deserialize_shape)
134 _dtype = DataTypeField('dtype')
135 _op = KeyField('op')
136 # optional fields
137 # `nsplits` means the sizes of chunks for each dimension
138 _nsplits = TupleField('nsplits', ValueType.tuple(ValueType.uint64))
139 _chunks = ListField('chunks', ValueType.reference(Chunk))
140 _params = DictField('params', key_type=ValueType.string, on_deserialize=AttributeDict)
141
142 def __init__(self, *args, **kwargs):
143 extras = AttributeDict((k, kwargs.pop(k)) for k in set(kwargs) - set(self.__slots__))
144 kwargs['_params'] = kwargs.pop('_params', extras)
145 if '_nsplits' in kwargs:
146 kwargs['_nsplits'] = tuple(tuple(s) for s in kwargs['_nsplits'])
147
148 super(TensorData, self).__init__(*args, **kwargs)
149
150 if hasattr(self, '_chunks') and self._chunks:
151 self._chunks = sorted(self._chunks, key=attrgetter('index'))
152
153 @classmethod
154 def cls(cls, provider):
155 if provider.type == ProviderType.protobuf:
156 from ..serialize.protos.tensor_pb2 import TensorDef
157 return TensorDef
158 return super(TensorData, cls).cls(provider)
159
160 def __repr__(self):
161 return 'Tensor <op={0}, key={1}>'.format(self.op.__class__.__name__, self.key)
162
163 @property
164 def shape(self):
165 if hasattr(self, '_shape') and self._shape is not None:
166 return self._shape
167 if hasattr(self, '_nsplits') and self._nsplits is not None:
168 self._shape = tuple(builtins.sum(nsplit) for nsplit in self._nsplits)
169 return self._shape
170
171 def _update_shape(self, new_shape):
172 self._shape = new_shape
173
174 @property
175 def ndim(self):
176 return len(self.shape)
177
178 def __len__(self):
179 try:
180 return self.shape[0]
181 except IndexError:
182 if build_mode().is_build_mode:
183 return 0
184 raise TypeError('len() of unsized object')
185
186 @property
187 def nbytes(self):
188 return np.prod(self.shape) * self.dtype.itemsize
189
190 @property
191 def chunk_shape(self):
192 if hasattr(self, '_nsplits') and self._nsplits is not None:
193 return tuple(map(len, self._nsplits))
194
195 @property
196 def chunks(self):
197 return getattr(self, '_chunks', None)
198
199 @property
200 def op(self):
201 return getattr(self, '_op', None)
202
203 @property
204 def nsplits(self):
205 return getattr(self, '_nsplits', None)
206
207 @nsplits.setter
208 def nsplits(self, new_nsplits):
209 self._nsplits = new_nsplits
210
211 @property
212 def size(self):
213 return np.prod(self.shape).item()
214
215 @property
216 def inputs(self):
217 return self.op.inputs or []
218
219 @inputs.setter
220 def inputs(self, new_inputs):
221 self.op.inputs = new_inputs
222
223 @property
224 def dtype(self):
225 return getattr(self, '_dtype', None) or self.op.dtype
226
227 @property
228 def params(self):
229 return self._params
230
231 @property
232 def real(self):
233 from .expressions.arithmetic import real
234 return real(self)
235
236 @property
237 def imag(self):
238 from .expressions.arithmetic import imag
239 return imag(self)
240
241 def get_chunk_slices(self, idx):
242 return get_chunk_slices(self.nsplits, idx)
243
244 def is_coarse(self):
245 return not hasattr(self, '_chunks') or self._chunks is None or len(self._chunks) == 0
246
247 def is_scalar(self):
248 return self.ndim == 0
249
250 isscalar = is_scalar
251
252 def is_sparse(self):
253 return self.op.is_sparse()
254
255 issparse = is_sparse
256
257 def tosparse(self):
258 if self.issparse():
259 return self
260
261 from .expressions.datasource import fromdense
262 return fromdense(self)
263
264 def todense(self):
265 if not self.issparse():
266 return self
267
268 from .expressions.datasource import fromsparse
269 return fromsparse(self)
270
271 @property
272 def cix(self):
273 if self.ndim == 0:
274 return ChunksIndexer(self)
275
276 try:
277 if getattr(self, '_cix', None) is None:
278 self._cix = ChunksIndexer(self)
279 return self._cix
280 except (TypeError, ValueError):
281 return ChunksIndexer(self)
282
283 def tiles(self):
284 return handler.tiles(self)
285
286 def single_tiles(self):
287 return handler.single_tiles(self)
288
289 def build_graph(self, graph=None, cls=DAG, tiled=False, compose=True):
290 if tiled and self.is_coarse():
291 self.tiles()
292
293 graph = graph if graph is not None else cls()
294 keys = None
295
296 if tiled:
297 nodes = list(c.data for c in self.chunks)
298 keys = list(c.key for c in self.chunks)
299 else:
300 nodes = list(self.op.outputs)
301 visited = set()
302 while len(nodes) > 0:
303 chunk = nodes.pop()
304 visited.add(chunk)
305 if not graph.contains(chunk):
306 graph.add_node(chunk)
307 children = chunk.inputs or []
308 for c in children:
309 if not graph.contains(c):
310 graph.add_node(c)
311 if not graph.has_successor(c, chunk):
312 graph.add_edge(c, chunk)
313 nodes.extend([c for c in itertools.chain(*[inp.op.outputs for inp in chunk.inputs or []])
314 if c not in visited])
315 if tiled and compose:
316 graph.compose(keys=keys)
317 return graph
318
319 def transpose(self, *axes):
320 """
321 Returns a view of the tensor with axes transposed.
322
323 For a 1-D tensor, this has no effect. (To change between column and
324 row vectors, first cast the 1-D tensor into a matrix object.)
325 For a 2-D tensor, this is the usual matrix transpose.
326 For an n-D tensor, if axes are given, their order indicates how the
327 axes are permuted (see Examples). If axes are not provided and
328 ``a.shape = (i[0], i[1], ... i[n-2], i[n-1])``, then
329 ``a.transpose().shape = (i[n-1], i[n-2], ... i[1], i[0])``.
330
331 Parameters
332 ----------
333 axes : None, tuple of ints, or `n` ints
334
335 * None or no argument: reverses the order of the axes.
336
337 * tuple of ints: `i` in the `j`-th place in the tuple means `a`'s
338 `i`-th axis becomes `a.transpose()`'s `j`-th axis.
339
340 * `n` ints: same as an n-tuple of the same ints (this form is
341 intended simply as a "convenience" alternative to the tuple form)
342
343 Returns
344 -------
345 out : Tensor
346 View of `a`, with axes suitably permuted.
347
348 See Also
349 --------
350 Tensor.T : Tensor property returning the tensor transposed.
351
352 Examples
353 --------
354 >>> import mars.tensor as mt
355
356 >>> a = mt.array([[1, 2], [3, 4]])
357 >>> a.execute()
358 array([[1, 2],
359 [3, 4]])
360 >>> a.transpose().execute()
361 array([[1, 3],
362 [2, 4]])
363 >>> a.transpose((1, 0))
364 array([[1, 3],
365 [2, 4]])
366 >>> a.transpose(1, 0).execute()
367 array([[1, 3],
368 [2, 4]])
369 """
370 from .expressions.base import transpose
371
372 if len(axes) == 1 and isinstance(axes[0], Iterable):
373 axes = axes[0]
374
375 return transpose(self, axes)
376
377 @property
378 def T(self):
379 """
380 Same as self.transpose(), except that self is returned if
381 self.ndim < 2.
382
383 Examples
384 --------
385 >>> import mars.tensor as mt
386
387 >>> x = mt.array([[1.,2.],[3.,4.]])
388 >>> x.execute()
389 array([[ 1., 2.],
390 [ 3., 4.]])
391 >>> x.T.execute()
392 array([[ 1., 3.],
393 [ 2., 4.]])
394 >>> x = mt.array([1.,2.,3.,4.])
395 >>> x.execute()
396 array([ 1., 2., 3., 4.])
397 >>> x.T.execute()
398 array([ 1., 2., 3., 4.])
399 """
400 return self.transpose()
401
402 def reshape(self, shape, *shapes):
403 """
404 Returns a tensor containing the same data with a new shape.
405
406 Refer to `mt.reshape` for full documentation.
407
408 See Also
409 --------
410 mt.reshape : equivalent function
411
412 Notes
413 -----
414 Unlike the free function `mt.reshape`, this method on `Tensor` allows
415 the elements of the shape parameter to be passed in as separate arguments.
416 For example, ``a.reshape(10, 11)`` is equivalent to
417 ``a.reshape((10, 11))``.
418 """
419 from .expressions.reshape import reshape
420
421 if isinstance(shape, Iterable):
422 shape = tuple(shape)
423 else:
424 shape = (shape,)
425 shape += shapes
426
427 return reshape(self, shape)
428
429 def ravel(self):
430 """
431 Return a flattened tensor.
432
433 Refer to `mt.ravel` for full documentation.
434
435 See Also
436 --------
437 mt.ravel : equivalent function
438 """
439 from .expressions.base import ravel
440
441 return ravel(self)
442
443 flatten = ravel
444
445 def _equals(self, o):
446 return self is o
447
448 def execute(self, session=None, **kw):
449 from ..session import Session
450
451 if session is None:
452 session = Session.default_or_local()
453 return session.run(self, **kw)
454
455 def _set_execute_session(self, session):
456 _cleaner.register(self, session)
457
458 _execute_session = property(fset=_set_execute_session)
459
460 def visualize(self, graph_attrs=None, node_attrs=None, **kw):
461 from graphviz import Source
462
463 g = self.build_graph(**kw)
464 dot = g.to_dot(graph_attrs=graph_attrs, node_attrs=node_attrs)
465
466 return Source(dot)
467
468
469 class ExecutableTuple(tuple):
470 def execute(self, session=None, **kw):
471 from ..session import Session
472
473 if session is None:
474 session = Session.default_or_local()
475 return session.run(*self, **kw)
476
477
478 class ChunksIndexer(object):
479 __slots__ = '_tensor',
480
481 def __init__(self, tensor):
482 self._tensor = tensor
483
484 def __getitem__(self, item):
485 if isinstance(item, tuple):
486 if len(item) == 0 and self._tensor.is_scalar():
487 return self._tensor.chunks[0]
488 elif all(np.issubdtype(type(it), np.integer) for it in item):
489 if len(item) != self._tensor.ndim:
490 raise ValueError('Cannot get tensor chunk by %s, expect length %d' % (
491 item, self._tensor.ndim))
492
493 s = self._tensor.chunk_shape
494 item = tuple(i if i >= 0 else i + s for i, s in zip(item, s))
495 idx = sum(idx * reduce(mul, s[i+1:], 1) for i, idx
496 in zip(itertools.count(0), item))
497 return self._tensor._chunks[idx]
498
499 raise ValueError('Cannot get tensor chunk by {0}'.format(item))
500
501
502 class Tensor(Entity):
503 __slots__ = ()
504 _allow_data_type_ = (TensorData,)
505
506 def __len__(self):
507 return len(self._data)
508
509 def copy(self):
510 return Tensor(self._data)
511
512 def tiles(self):
513 return handler.tiles(self)
514
515 def single_tiles(self):
516 return handler.single_tiles(self)
517
518 @property
519 def shape(self):
520 return self.data.shape
521
522 @shape.setter
523 def shape(self, new_shape):
524 self._data = self._data.reshape(new_shape).data
525
526 def _update_shape(self, new_shape):
527 self._data._update_shape(new_shape)
528
529 @property
530 def real(self):
531 return self.data.real
532
533 @real.setter
534 def real(self, new_real):
535 from .expressions.arithmetic.setreal import set_real
536
537 self._data = set_real(self._data, new_real).data
538
539 @property
540 def imag(self):
541 return self.data.imag
542
543 @imag.setter
544 def imag(self, new_imag):
545 from .expressions.arithmetic.setimag import set_imag
546
547 self._data = set_imag(self._data, new_imag).data
548
549
550 class SparseTensor(Tensor):
551 __slots__ = ()
552
553
554 TENSOR_TYPE = (Tensor, TensorData)
555 CHUNK_TYPE = (Chunk, ChunkData)
556
557 _threading_local = threading.local()
558
559
560 class _TensorSession(object):
561 def __init__(self, tensor, session):
562 key = tensor.key, tensor.id
563
564 def cb(_, sess=ref(session)):
565 s = sess()
566 if s:
567 s.decref(key)
568 self._tensor = ref(tensor, cb)
569
570
571 class _TensorCleaner(object):
572 def __init__(self):
573 self._tensor_to_sessions = WeakKeyDictionary()
574
575 def register(self, tensor, session):
576 with build_mode():
577 self._tensor_to_sessions[tensor] = _TensorSession(tensor, session)
578
579
580 # we don't use __del__ to decref because a tensor holds an op,
581 # and op's outputs contains the tensor, so a circular references exists
582 _cleaner = _TensorCleaner()
583
584
585 class BuildMode(object):
586 def __init__(self):
587 self.is_build_mode = False
588 self._old_mode = None
589
590 def __enter__(self):
591 if self._old_mode is None:
592 # check to prevent nested enter and exit
593 self._old_mode = self.is_build_mode
594 self.is_build_mode = True
595
596 def __exit__(self, *_):
597 if self._old_mode is not None:
598 self.is_build_mode = self._old_mode
599 self._old_mode = None
600
601
602 def build_mode():
603 ret = getattr(_threading_local, 'build_mode', None)
604 if ret is None:
605 ret = BuildMode()
606 _threading_local.build_mode = ret
607
608 return ret
609
```
--- 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/mars/tensor/core.py b/mars/tensor/core.py
--- a/mars/tensor/core.py
+++ b/mars/tensor/core.py
@@ -546,6 +546,9 @@
self._data = set_imag(self._data, new_imag).data
+ def __array__(self, dtype=None):
+ return np.asarray(self.execute(), dtype=dtype)
+
class SparseTensor(Tensor):
__slots__ = ()
| {"golden_diff": "diff --git a/mars/tensor/core.py b/mars/tensor/core.py\n--- a/mars/tensor/core.py\n+++ b/mars/tensor/core.py\n@@ -546,6 +546,9 @@\n \n self._data = set_imag(self._data, new_imag).data\n \n+ def __array__(self, dtype=None):\n+ return np.asarray(self.execute(), dtype=dtype)\n+\n \n class SparseTensor(Tensor):\n __slots__ = ()\n", "issue": "Implement __array__ protocol for Tensor\n**Is your feature request related to a problem? Please describe.**\r\n\r\nBy now, Mars tensor does not implement `__array__` protocol, so if `numpy.asarray` is called, will not get the right result.\r\n\r\n**Describe the solution you'd like**\r\n\r\nCall `execute` inside `__array__` function.\r\n\r\n**Additional context**\r\n\r\nConsider the [`__array_function__` protocol ](https://www.numpy.org/neps/nep-0018-array-function-protocol.html) also.\n", "before_files": [{"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n# Copyright 1999-2018 Alibaba Group Holding Ltd.\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\nimport itertools\nfrom operator import attrgetter, mul\nfrom weakref import WeakKeyDictionary, ref\nfrom collections import Iterable\nimport threading\n\nimport numpy as np\n\nfrom ..core import Entity\nfrom ..compat import builtins, reduce\nfrom ..graph import DAG\nfrom ..tiles import Tilesable, handler\nfrom ..serialize import SerializableWithKey, ValueType, ProviderType, \\\n ListField, TupleField, DictField, DataTypeField, KeyField, BoolField\nfrom ..utils import AttributeDict, on_serialize_shape, on_deserialize_shape, tokenize\nfrom .expressions.utils import get_chunk_slices\n\n\nclass ChunkData(SerializableWithKey):\n __slots__ = '__weakref__',\n\n # required fields\n _shape = TupleField('shape', ValueType.int64,\n on_serialize=on_serialize_shape, on_deserialize=on_deserialize_shape)\n _op = KeyField('op') # store key of operand here\n # optional fields\n _dtype = DataTypeField('dtype')\n _index = TupleField('index', ValueType.uint32)\n _cached = BoolField('cached')\n _composed = ListField('composed', ValueType.reference('self'))\n _params = DictField('params', key_type=ValueType.string, on_deserialize=AttributeDict)\n\n def __init__(self, *args, **kwargs):\n extras = AttributeDict((k, kwargs.pop(k)) for k in set(kwargs) - set(self.__slots__))\n kwargs['_params'] = kwargs.pop('_params', extras)\n super(ChunkData, self).__init__(*args, **kwargs)\n\n def __repr__(self):\n return 'Chunk <op={0}, key={1}>'.format(self.op.__class__.__name__, self.key)\n\n @classmethod\n def cls(cls, provider):\n if provider.type == ProviderType.protobuf:\n from ..serialize.protos.chunk_pb2 import ChunkDef\n return ChunkDef\n return super(ChunkData, cls).cls(provider)\n\n @property\n def shape(self):\n return getattr(self, '_shape', None)\n\n @property\n def ndim(self):\n return len(self.shape)\n\n @property\n def index(self):\n return getattr(self, '_index', None)\n\n @property\n def op(self):\n try:\n return self._op\n except AttributeError:\n return None\n\n @property\n def cached(self):\n return getattr(self, '_cached', None)\n\n @property\n def inputs(self):\n return self.op.inputs\n\n @inputs.setter\n def inputs(self, new_inputs):\n self.op.inputs = new_inputs\n\n @property\n def dtype(self):\n return getattr(self, '_dtype', None) or self.op.dtype\n\n @property\n def nbytes(self):\n return np.prod(self.shape) * self.dtype.itemsize\n\n @property\n def composed(self):\n return getattr(self, '_composed', None)\n\n @property\n def device(self):\n return self.op.device\n\n def is_sparse(self):\n return self.op.is_sparse()\n\n issparse = is_sparse\n\n def update_key(self):\n object.__setattr__(self, '_key', tokenize(\n type(self), *(getattr(self, k, None) for k in self.__slots__ if k != '_index')))\n\n\nclass Chunk(Entity):\n __slots__ = ()\n _allow_data_type_ = (ChunkData,)\n\n\nclass TensorData(SerializableWithKey, Tilesable):\n __slots__ = '__weakref__', '_siblings', '_cix'\n _no_copy_attrs_ = SerializableWithKey._no_copy_attrs_ | {'_cix'}\n\n # required fields\n _shape = TupleField('shape', ValueType.int64,\n on_serialize=on_serialize_shape, on_deserialize=on_deserialize_shape)\n _dtype = DataTypeField('dtype')\n _op = KeyField('op')\n # optional fields\n # `nsplits` means the sizes of chunks for each dimension\n _nsplits = TupleField('nsplits', ValueType.tuple(ValueType.uint64))\n _chunks = ListField('chunks', ValueType.reference(Chunk))\n _params = DictField('params', key_type=ValueType.string, on_deserialize=AttributeDict)\n\n def __init__(self, *args, **kwargs):\n extras = AttributeDict((k, kwargs.pop(k)) for k in set(kwargs) - set(self.__slots__))\n kwargs['_params'] = kwargs.pop('_params', extras)\n if '_nsplits' in kwargs:\n kwargs['_nsplits'] = tuple(tuple(s) for s in kwargs['_nsplits'])\n\n super(TensorData, self).__init__(*args, **kwargs)\n\n if hasattr(self, '_chunks') and self._chunks:\n self._chunks = sorted(self._chunks, key=attrgetter('index'))\n\n @classmethod\n def cls(cls, provider):\n if provider.type == ProviderType.protobuf:\n from ..serialize.protos.tensor_pb2 import TensorDef\n return TensorDef\n return super(TensorData, cls).cls(provider)\n\n def __repr__(self):\n return 'Tensor <op={0}, key={1}>'.format(self.op.__class__.__name__, self.key)\n\n @property\n def shape(self):\n if hasattr(self, '_shape') and self._shape is not None:\n return self._shape\n if hasattr(self, '_nsplits') and self._nsplits is not None:\n self._shape = tuple(builtins.sum(nsplit) for nsplit in self._nsplits)\n return self._shape\n\n def _update_shape(self, new_shape):\n self._shape = new_shape\n\n @property\n def ndim(self):\n return len(self.shape)\n\n def __len__(self):\n try:\n return self.shape[0]\n except IndexError:\n if build_mode().is_build_mode:\n return 0\n raise TypeError('len() of unsized object')\n\n @property\n def nbytes(self):\n return np.prod(self.shape) * self.dtype.itemsize\n\n @property\n def chunk_shape(self):\n if hasattr(self, '_nsplits') and self._nsplits is not None:\n return tuple(map(len, self._nsplits))\n\n @property\n def chunks(self):\n return getattr(self, '_chunks', None)\n\n @property\n def op(self):\n return getattr(self, '_op', None)\n\n @property\n def nsplits(self):\n return getattr(self, '_nsplits', None)\n\n @nsplits.setter\n def nsplits(self, new_nsplits):\n self._nsplits = new_nsplits\n\n @property\n def size(self):\n return np.prod(self.shape).item()\n\n @property\n def inputs(self):\n return self.op.inputs or []\n\n @inputs.setter\n def inputs(self, new_inputs):\n self.op.inputs = new_inputs\n\n @property\n def dtype(self):\n return getattr(self, '_dtype', None) or self.op.dtype\n\n @property\n def params(self):\n return self._params\n\n @property\n def real(self):\n from .expressions.arithmetic import real\n return real(self)\n\n @property\n def imag(self):\n from .expressions.arithmetic import imag\n return imag(self)\n\n def get_chunk_slices(self, idx):\n return get_chunk_slices(self.nsplits, idx)\n\n def is_coarse(self):\n return not hasattr(self, '_chunks') or self._chunks is None or len(self._chunks) == 0\n\n def is_scalar(self):\n return self.ndim == 0\n\n isscalar = is_scalar\n\n def is_sparse(self):\n return self.op.is_sparse()\n\n issparse = is_sparse\n\n def tosparse(self):\n if self.issparse():\n return self\n\n from .expressions.datasource import fromdense\n return fromdense(self)\n\n def todense(self):\n if not self.issparse():\n return self\n\n from .expressions.datasource import fromsparse\n return fromsparse(self)\n\n @property\n def cix(self):\n if self.ndim == 0:\n return ChunksIndexer(self)\n\n try:\n if getattr(self, '_cix', None) is None:\n self._cix = ChunksIndexer(self)\n return self._cix\n except (TypeError, ValueError):\n return ChunksIndexer(self)\n\n def tiles(self):\n return handler.tiles(self)\n\n def single_tiles(self):\n return handler.single_tiles(self)\n\n def build_graph(self, graph=None, cls=DAG, tiled=False, compose=True):\n if tiled and self.is_coarse():\n self.tiles()\n\n graph = graph if graph is not None else cls()\n keys = None\n\n if tiled:\n nodes = list(c.data for c in self.chunks)\n keys = list(c.key for c in self.chunks)\n else:\n nodes = list(self.op.outputs)\n visited = set()\n while len(nodes) > 0:\n chunk = nodes.pop()\n visited.add(chunk)\n if not graph.contains(chunk):\n graph.add_node(chunk)\n children = chunk.inputs or []\n for c in children:\n if not graph.contains(c):\n graph.add_node(c)\n if not graph.has_successor(c, chunk):\n graph.add_edge(c, chunk)\n nodes.extend([c for c in itertools.chain(*[inp.op.outputs for inp in chunk.inputs or []])\n if c not in visited])\n if tiled and compose:\n graph.compose(keys=keys)\n return graph\n\n def transpose(self, *axes):\n \"\"\"\n Returns a view of the tensor with axes transposed.\n\n For a 1-D tensor, this has no effect. (To change between column and\n row vectors, first cast the 1-D tensor into a matrix object.)\n For a 2-D tensor, this is the usual matrix transpose.\n For an n-D tensor, if axes are given, their order indicates how the\n axes are permuted (see Examples). If axes are not provided and\n ``a.shape = (i[0], i[1], ... i[n-2], i[n-1])``, then\n ``a.transpose().shape = (i[n-1], i[n-2], ... i[1], i[0])``.\n\n Parameters\n ----------\n axes : None, tuple of ints, or `n` ints\n\n * None or no argument: reverses the order of the axes.\n\n * tuple of ints: `i` in the `j`-th place in the tuple means `a`'s\n `i`-th axis becomes `a.transpose()`'s `j`-th axis.\n\n * `n` ints: same as an n-tuple of the same ints (this form is\n intended simply as a \"convenience\" alternative to the tuple form)\n\n Returns\n -------\n out : Tensor\n View of `a`, with axes suitably permuted.\n\n See Also\n --------\n Tensor.T : Tensor property returning the tensor transposed.\n\n Examples\n --------\n >>> import mars.tensor as mt\n\n >>> a = mt.array([[1, 2], [3, 4]])\n >>> a.execute()\n array([[1, 2],\n [3, 4]])\n >>> a.transpose().execute()\n array([[1, 3],\n [2, 4]])\n >>> a.transpose((1, 0))\n array([[1, 3],\n [2, 4]])\n >>> a.transpose(1, 0).execute()\n array([[1, 3],\n [2, 4]])\n \"\"\"\n from .expressions.base import transpose\n\n if len(axes) == 1 and isinstance(axes[0], Iterable):\n axes = axes[0]\n\n return transpose(self, axes)\n\n @property\n def T(self):\n \"\"\"\n Same as self.transpose(), except that self is returned if\n self.ndim < 2.\n\n Examples\n --------\n >>> import mars.tensor as mt\n\n >>> x = mt.array([[1.,2.],[3.,4.]])\n >>> x.execute()\n array([[ 1., 2.],\n [ 3., 4.]])\n >>> x.T.execute()\n array([[ 1., 3.],\n [ 2., 4.]])\n >>> x = mt.array([1.,2.,3.,4.])\n >>> x.execute()\n array([ 1., 2., 3., 4.])\n >>> x.T.execute()\n array([ 1., 2., 3., 4.])\n \"\"\"\n return self.transpose()\n\n def reshape(self, shape, *shapes):\n \"\"\"\n Returns a tensor containing the same data with a new shape.\n\n Refer to `mt.reshape` for full documentation.\n\n See Also\n --------\n mt.reshape : equivalent function\n\n Notes\n -----\n Unlike the free function `mt.reshape`, this method on `Tensor` allows\n the elements of the shape parameter to be passed in as separate arguments.\n For example, ``a.reshape(10, 11)`` is equivalent to\n ``a.reshape((10, 11))``.\n \"\"\"\n from .expressions.reshape import reshape\n\n if isinstance(shape, Iterable):\n shape = tuple(shape)\n else:\n shape = (shape,)\n shape += shapes\n\n return reshape(self, shape)\n\n def ravel(self):\n \"\"\"\n Return a flattened tensor.\n\n Refer to `mt.ravel` for full documentation.\n\n See Also\n --------\n mt.ravel : equivalent function\n \"\"\"\n from .expressions.base import ravel\n\n return ravel(self)\n\n flatten = ravel\n\n def _equals(self, o):\n return self is o\n\n def execute(self, session=None, **kw):\n from ..session import Session\n\n if session is None:\n session = Session.default_or_local()\n return session.run(self, **kw)\n\n def _set_execute_session(self, session):\n _cleaner.register(self, session)\n\n _execute_session = property(fset=_set_execute_session)\n\n def visualize(self, graph_attrs=None, node_attrs=None, **kw):\n from graphviz import Source\n\n g = self.build_graph(**kw)\n dot = g.to_dot(graph_attrs=graph_attrs, node_attrs=node_attrs)\n\n return Source(dot)\n\n\nclass ExecutableTuple(tuple):\n def execute(self, session=None, **kw):\n from ..session import Session\n\n if session is None:\n session = Session.default_or_local()\n return session.run(*self, **kw)\n\n\nclass ChunksIndexer(object):\n __slots__ = '_tensor',\n\n def __init__(self, tensor):\n self._tensor = tensor\n\n def __getitem__(self, item):\n if isinstance(item, tuple):\n if len(item) == 0 and self._tensor.is_scalar():\n return self._tensor.chunks[0]\n elif all(np.issubdtype(type(it), np.integer) for it in item):\n if len(item) != self._tensor.ndim:\n raise ValueError('Cannot get tensor chunk by %s, expect length %d' % (\n item, self._tensor.ndim))\n\n s = self._tensor.chunk_shape\n item = tuple(i if i >= 0 else i + s for i, s in zip(item, s))\n idx = sum(idx * reduce(mul, s[i+1:], 1) for i, idx\n in zip(itertools.count(0), item))\n return self._tensor._chunks[idx]\n\n raise ValueError('Cannot get tensor chunk by {0}'.format(item))\n\n\nclass Tensor(Entity):\n __slots__ = ()\n _allow_data_type_ = (TensorData,)\n\n def __len__(self):\n return len(self._data)\n\n def copy(self):\n return Tensor(self._data)\n\n def tiles(self):\n return handler.tiles(self)\n\n def single_tiles(self):\n return handler.single_tiles(self)\n\n @property\n def shape(self):\n return self.data.shape\n\n @shape.setter\n def shape(self, new_shape):\n self._data = self._data.reshape(new_shape).data\n\n def _update_shape(self, new_shape):\n self._data._update_shape(new_shape)\n\n @property\n def real(self):\n return self.data.real\n\n @real.setter\n def real(self, new_real):\n from .expressions.arithmetic.setreal import set_real\n\n self._data = set_real(self._data, new_real).data\n\n @property\n def imag(self):\n return self.data.imag\n\n @imag.setter\n def imag(self, new_imag):\n from .expressions.arithmetic.setimag import set_imag\n\n self._data = set_imag(self._data, new_imag).data\n\n\nclass SparseTensor(Tensor):\n __slots__ = ()\n\n\nTENSOR_TYPE = (Tensor, TensorData)\nCHUNK_TYPE = (Chunk, ChunkData)\n\n_threading_local = threading.local()\n\n\nclass _TensorSession(object):\n def __init__(self, tensor, session):\n key = tensor.key, tensor.id\n\n def cb(_, sess=ref(session)):\n s = sess()\n if s:\n s.decref(key)\n self._tensor = ref(tensor, cb)\n\n\nclass _TensorCleaner(object):\n def __init__(self):\n self._tensor_to_sessions = WeakKeyDictionary()\n\n def register(self, tensor, session):\n with build_mode():\n self._tensor_to_sessions[tensor] = _TensorSession(tensor, session)\n\n\n# we don't use __del__ to decref because a tensor holds an op,\n# and op's outputs contains the tensor, so a circular references exists\n_cleaner = _TensorCleaner()\n\n\nclass BuildMode(object):\n def __init__(self):\n self.is_build_mode = False\n self._old_mode = None\n\n def __enter__(self):\n if self._old_mode is None:\n # check to prevent nested enter and exit\n self._old_mode = self.is_build_mode\n self.is_build_mode = True\n\n def __exit__(self, *_):\n if self._old_mode is not None:\n self.is_build_mode = self._old_mode\n self._old_mode = None\n\n\ndef build_mode():\n ret = getattr(_threading_local, 'build_mode', None)\n if ret is None:\n ret = BuildMode()\n _threading_local.build_mode = ret\n\n return ret\n", "path": "mars/tensor/core.py"}], "after_files": [{"content": "#!/usr/bin/env python\n# -*- coding: utf-8 -*-\n# Copyright 1999-2018 Alibaba Group Holding Ltd.\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\nimport itertools\nfrom operator import attrgetter, mul\nfrom weakref import WeakKeyDictionary, ref\nfrom collections import Iterable\nimport threading\n\nimport numpy as np\n\nfrom ..core import Entity\nfrom ..compat import builtins, reduce\nfrom ..graph import DAG\nfrom ..tiles import Tilesable, handler\nfrom ..serialize import SerializableWithKey, ValueType, ProviderType, \\\n ListField, TupleField, DictField, DataTypeField, KeyField, BoolField\nfrom ..utils import AttributeDict, on_serialize_shape, on_deserialize_shape, tokenize\nfrom .expressions.utils import get_chunk_slices\n\n\nclass ChunkData(SerializableWithKey):\n __slots__ = '__weakref__',\n\n # required fields\n _shape = TupleField('shape', ValueType.int64,\n on_serialize=on_serialize_shape, on_deserialize=on_deserialize_shape)\n _op = KeyField('op') # store key of operand here\n # optional fields\n _dtype = DataTypeField('dtype')\n _index = TupleField('index', ValueType.uint32)\n _cached = BoolField('cached')\n _composed = ListField('composed', ValueType.reference('self'))\n _params = DictField('params', key_type=ValueType.string, on_deserialize=AttributeDict)\n\n def __init__(self, *args, **kwargs):\n extras = AttributeDict((k, kwargs.pop(k)) for k in set(kwargs) - set(self.__slots__))\n kwargs['_params'] = kwargs.pop('_params', extras)\n super(ChunkData, self).__init__(*args, **kwargs)\n\n def __repr__(self):\n return 'Chunk <op={0}, key={1}>'.format(self.op.__class__.__name__, self.key)\n\n @classmethod\n def cls(cls, provider):\n if provider.type == ProviderType.protobuf:\n from ..serialize.protos.chunk_pb2 import ChunkDef\n return ChunkDef\n return super(ChunkData, cls).cls(provider)\n\n @property\n def shape(self):\n return getattr(self, '_shape', None)\n\n @property\n def ndim(self):\n return len(self.shape)\n\n @property\n def index(self):\n return getattr(self, '_index', None)\n\n @property\n def op(self):\n try:\n return self._op\n except AttributeError:\n return None\n\n @property\n def cached(self):\n return getattr(self, '_cached', None)\n\n @property\n def inputs(self):\n return self.op.inputs\n\n @inputs.setter\n def inputs(self, new_inputs):\n self.op.inputs = new_inputs\n\n @property\n def dtype(self):\n return getattr(self, '_dtype', None) or self.op.dtype\n\n @property\n def nbytes(self):\n return np.prod(self.shape) * self.dtype.itemsize\n\n @property\n def composed(self):\n return getattr(self, '_composed', None)\n\n @property\n def device(self):\n return self.op.device\n\n def is_sparse(self):\n return self.op.is_sparse()\n\n issparse = is_sparse\n\n def update_key(self):\n object.__setattr__(self, '_key', tokenize(\n type(self), *(getattr(self, k, None) for k in self.__slots__ if k != '_index')))\n\n\nclass Chunk(Entity):\n __slots__ = ()\n _allow_data_type_ = (ChunkData,)\n\n\nclass TensorData(SerializableWithKey, Tilesable):\n __slots__ = '__weakref__', '_siblings', '_cix'\n _no_copy_attrs_ = SerializableWithKey._no_copy_attrs_ | {'_cix'}\n\n # required fields\n _shape = TupleField('shape', ValueType.int64,\n on_serialize=on_serialize_shape, on_deserialize=on_deserialize_shape)\n _dtype = DataTypeField('dtype')\n _op = KeyField('op')\n # optional fields\n # `nsplits` means the sizes of chunks for each dimension\n _nsplits = TupleField('nsplits', ValueType.tuple(ValueType.uint64))\n _chunks = ListField('chunks', ValueType.reference(Chunk))\n _params = DictField('params', key_type=ValueType.string, on_deserialize=AttributeDict)\n\n def __init__(self, *args, **kwargs):\n extras = AttributeDict((k, kwargs.pop(k)) for k in set(kwargs) - set(self.__slots__))\n kwargs['_params'] = kwargs.pop('_params', extras)\n if '_nsplits' in kwargs:\n kwargs['_nsplits'] = tuple(tuple(s) for s in kwargs['_nsplits'])\n\n super(TensorData, self).__init__(*args, **kwargs)\n\n if hasattr(self, '_chunks') and self._chunks:\n self._chunks = sorted(self._chunks, key=attrgetter('index'))\n\n @classmethod\n def cls(cls, provider):\n if provider.type == ProviderType.protobuf:\n from ..serialize.protos.tensor_pb2 import TensorDef\n return TensorDef\n return super(TensorData, cls).cls(provider)\n\n def __repr__(self):\n return 'Tensor <op={0}, key={1}>'.format(self.op.__class__.__name__, self.key)\n\n @property\n def shape(self):\n if hasattr(self, '_shape') and self._shape is not None:\n return self._shape\n if hasattr(self, '_nsplits') and self._nsplits is not None:\n self._shape = tuple(builtins.sum(nsplit) for nsplit in self._nsplits)\n return self._shape\n\n def _update_shape(self, new_shape):\n self._shape = new_shape\n\n @property\n def ndim(self):\n return len(self.shape)\n\n def __len__(self):\n try:\n return self.shape[0]\n except IndexError:\n if build_mode().is_build_mode:\n return 0\n raise TypeError('len() of unsized object')\n\n @property\n def nbytes(self):\n return np.prod(self.shape) * self.dtype.itemsize\n\n @property\n def chunk_shape(self):\n if hasattr(self, '_nsplits') and self._nsplits is not None:\n return tuple(map(len, self._nsplits))\n\n @property\n def chunks(self):\n return getattr(self, '_chunks', None)\n\n @property\n def op(self):\n return getattr(self, '_op', None)\n\n @property\n def nsplits(self):\n return getattr(self, '_nsplits', None)\n\n @nsplits.setter\n def nsplits(self, new_nsplits):\n self._nsplits = new_nsplits\n\n @property\n def size(self):\n return np.prod(self.shape).item()\n\n @property\n def inputs(self):\n return self.op.inputs or []\n\n @inputs.setter\n def inputs(self, new_inputs):\n self.op.inputs = new_inputs\n\n @property\n def dtype(self):\n return getattr(self, '_dtype', None) or self.op.dtype\n\n @property\n def params(self):\n return self._params\n\n @property\n def real(self):\n from .expressions.arithmetic import real\n return real(self)\n\n @property\n def imag(self):\n from .expressions.arithmetic import imag\n return imag(self)\n\n def get_chunk_slices(self, idx):\n return get_chunk_slices(self.nsplits, idx)\n\n def is_coarse(self):\n return not hasattr(self, '_chunks') or self._chunks is None or len(self._chunks) == 0\n\n def is_scalar(self):\n return self.ndim == 0\n\n isscalar = is_scalar\n\n def is_sparse(self):\n return self.op.is_sparse()\n\n issparse = is_sparse\n\n def tosparse(self):\n if self.issparse():\n return self\n\n from .expressions.datasource import fromdense\n return fromdense(self)\n\n def todense(self):\n if not self.issparse():\n return self\n\n from .expressions.datasource import fromsparse\n return fromsparse(self)\n\n @property\n def cix(self):\n if self.ndim == 0:\n return ChunksIndexer(self)\n\n try:\n if getattr(self, '_cix', None) is None:\n self._cix = ChunksIndexer(self)\n return self._cix\n except (TypeError, ValueError):\n return ChunksIndexer(self)\n\n def tiles(self):\n return handler.tiles(self)\n\n def single_tiles(self):\n return handler.single_tiles(self)\n\n def build_graph(self, graph=None, cls=DAG, tiled=False, compose=True):\n if tiled and self.is_coarse():\n self.tiles()\n\n graph = graph if graph is not None else cls()\n keys = None\n\n if tiled:\n nodes = list(c.data for c in self.chunks)\n keys = list(c.key for c in self.chunks)\n else:\n nodes = list(self.op.outputs)\n visited = set()\n while len(nodes) > 0:\n chunk = nodes.pop()\n visited.add(chunk)\n if not graph.contains(chunk):\n graph.add_node(chunk)\n children = chunk.inputs or []\n for c in children:\n if not graph.contains(c):\n graph.add_node(c)\n if not graph.has_successor(c, chunk):\n graph.add_edge(c, chunk)\n nodes.extend([c for c in itertools.chain(*[inp.op.outputs for inp in chunk.inputs or []])\n if c not in visited])\n if tiled and compose:\n graph.compose(keys=keys)\n return graph\n\n def transpose(self, *axes):\n \"\"\"\n Returns a view of the tensor with axes transposed.\n\n For a 1-D tensor, this has no effect. (To change between column and\n row vectors, first cast the 1-D tensor into a matrix object.)\n For a 2-D tensor, this is the usual matrix transpose.\n For an n-D tensor, if axes are given, their order indicates how the\n axes are permuted (see Examples). If axes are not provided and\n ``a.shape = (i[0], i[1], ... i[n-2], i[n-1])``, then\n ``a.transpose().shape = (i[n-1], i[n-2], ... i[1], i[0])``.\n\n Parameters\n ----------\n axes : None, tuple of ints, or `n` ints\n\n * None or no argument: reverses the order of the axes.\n\n * tuple of ints: `i` in the `j`-th place in the tuple means `a`'s\n `i`-th axis becomes `a.transpose()`'s `j`-th axis.\n\n * `n` ints: same as an n-tuple of the same ints (this form is\n intended simply as a \"convenience\" alternative to the tuple form)\n\n Returns\n -------\n out : Tensor\n View of `a`, with axes suitably permuted.\n\n See Also\n --------\n Tensor.T : Tensor property returning the tensor transposed.\n\n Examples\n --------\n >>> import mars.tensor as mt\n\n >>> a = mt.array([[1, 2], [3, 4]])\n >>> a.execute()\n array([[1, 2],\n [3, 4]])\n >>> a.transpose().execute()\n array([[1, 3],\n [2, 4]])\n >>> a.transpose((1, 0))\n array([[1, 3],\n [2, 4]])\n >>> a.transpose(1, 0).execute()\n array([[1, 3],\n [2, 4]])\n \"\"\"\n from .expressions.base import transpose\n\n if len(axes) == 1 and isinstance(axes[0], Iterable):\n axes = axes[0]\n\n return transpose(self, axes)\n\n @property\n def T(self):\n \"\"\"\n Same as self.transpose(), except that self is returned if\n self.ndim < 2.\n\n Examples\n --------\n >>> import mars.tensor as mt\n\n >>> x = mt.array([[1.,2.],[3.,4.]])\n >>> x.execute()\n array([[ 1., 2.],\n [ 3., 4.]])\n >>> x.T.execute()\n array([[ 1., 3.],\n [ 2., 4.]])\n >>> x = mt.array([1.,2.,3.,4.])\n >>> x.execute()\n array([ 1., 2., 3., 4.])\n >>> x.T.execute()\n array([ 1., 2., 3., 4.])\n \"\"\"\n return self.transpose()\n\n def reshape(self, shape, *shapes):\n \"\"\"\n Returns a tensor containing the same data with a new shape.\n\n Refer to `mt.reshape` for full documentation.\n\n See Also\n --------\n mt.reshape : equivalent function\n\n Notes\n -----\n Unlike the free function `mt.reshape`, this method on `Tensor` allows\n the elements of the shape parameter to be passed in as separate arguments.\n For example, ``a.reshape(10, 11)`` is equivalent to\n ``a.reshape((10, 11))``.\n \"\"\"\n from .expressions.reshape import reshape\n\n if isinstance(shape, Iterable):\n shape = tuple(shape)\n else:\n shape = (shape,)\n shape += shapes\n\n return reshape(self, shape)\n\n def ravel(self):\n \"\"\"\n Return a flattened tensor.\n\n Refer to `mt.ravel` for full documentation.\n\n See Also\n --------\n mt.ravel : equivalent function\n \"\"\"\n from .expressions.base import ravel\n\n return ravel(self)\n\n flatten = ravel\n\n def _equals(self, o):\n return self is o\n\n def execute(self, session=None, **kw):\n from ..session import Session\n\n if session is None:\n session = Session.default_or_local()\n return session.run(self, **kw)\n\n def _set_execute_session(self, session):\n _cleaner.register(self, session)\n\n _execute_session = property(fset=_set_execute_session)\n\n def visualize(self, graph_attrs=None, node_attrs=None, **kw):\n from graphviz import Source\n\n g = self.build_graph(**kw)\n dot = g.to_dot(graph_attrs=graph_attrs, node_attrs=node_attrs)\n\n return Source(dot)\n\n\nclass ExecutableTuple(tuple):\n def execute(self, session=None, **kw):\n from ..session import Session\n\n if session is None:\n session = Session.default_or_local()\n return session.run(*self, **kw)\n\n\nclass ChunksIndexer(object):\n __slots__ = '_tensor',\n\n def __init__(self, tensor):\n self._tensor = tensor\n\n def __getitem__(self, item):\n if isinstance(item, tuple):\n if len(item) == 0 and self._tensor.is_scalar():\n return self._tensor.chunks[0]\n elif all(np.issubdtype(type(it), np.integer) for it in item):\n if len(item) != self._tensor.ndim:\n raise ValueError('Cannot get tensor chunk by %s, expect length %d' % (\n item, self._tensor.ndim))\n\n s = self._tensor.chunk_shape\n item = tuple(i if i >= 0 else i + s for i, s in zip(item, s))\n idx = sum(idx * reduce(mul, s[i+1:], 1) for i, idx\n in zip(itertools.count(0), item))\n return self._tensor._chunks[idx]\n\n raise ValueError('Cannot get tensor chunk by {0}'.format(item))\n\n\nclass Tensor(Entity):\n __slots__ = ()\n _allow_data_type_ = (TensorData,)\n\n def __len__(self):\n return len(self._data)\n\n def copy(self):\n return Tensor(self._data)\n\n def tiles(self):\n return handler.tiles(self)\n\n def single_tiles(self):\n return handler.single_tiles(self)\n\n @property\n def shape(self):\n return self.data.shape\n\n @shape.setter\n def shape(self, new_shape):\n self._data = self._data.reshape(new_shape).data\n\n def _update_shape(self, new_shape):\n self._data._update_shape(new_shape)\n\n @property\n def real(self):\n return self.data.real\n\n @real.setter\n def real(self, new_real):\n from .expressions.arithmetic.setreal import set_real\n\n self._data = set_real(self._data, new_real).data\n\n @property\n def imag(self):\n return self.data.imag\n\n @imag.setter\n def imag(self, new_imag):\n from .expressions.arithmetic.setimag import set_imag\n\n self._data = set_imag(self._data, new_imag).data\n\n def __array__(self, dtype=None):\n return np.asarray(self.execute(), dtype=dtype)\n\n\nclass SparseTensor(Tensor):\n __slots__ = ()\n\n\nTENSOR_TYPE = (Tensor, TensorData)\nCHUNK_TYPE = (Chunk, ChunkData)\n\n_threading_local = threading.local()\n\n\nclass _TensorSession(object):\n def __init__(self, tensor, session):\n key = tensor.key, tensor.id\n\n def cb(_, sess=ref(session)):\n s = sess()\n if s:\n s.decref(key)\n self._tensor = ref(tensor, cb)\n\n\nclass _TensorCleaner(object):\n def __init__(self):\n self._tensor_to_sessions = WeakKeyDictionary()\n\n def register(self, tensor, session):\n with build_mode():\n self._tensor_to_sessions[tensor] = _TensorSession(tensor, session)\n\n\n# we don't use __del__ to decref because a tensor holds an op,\n# and op's outputs contains the tensor, so a circular references exists\n_cleaner = _TensorCleaner()\n\n\nclass BuildMode(object):\n def __init__(self):\n self.is_build_mode = False\n self._old_mode = None\n\n def __enter__(self):\n if self._old_mode is None:\n # check to prevent nested enter and exit\n self._old_mode = self.is_build_mode\n self.is_build_mode = True\n\n def __exit__(self, *_):\n if self._old_mode is not None:\n self.is_build_mode = self._old_mode\n self._old_mode = None\n\n\ndef build_mode():\n ret = getattr(_threading_local, 'build_mode', None)\n if ret is None:\n ret = BuildMode()\n _threading_local.build_mode = ret\n\n return ret\n", "path": "mars/tensor/core.py"}]} |
gh_patches_debug_227 | rasdani/github-patches | git_diff | ivy-llc__ivy-16291 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
mish
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `ivy/functional/frontends/paddle/nn/functional/activation.py`
Content:
```
1 # local
2 import ivy
3 from ivy.func_wrapper import with_supported_dtypes
4 from ivy.functional.frontends.paddle.func_wrapper import to_ivy_arrays_and_back
5 from ivy.functional.frontends.paddle.tensor.math import tanh as paddle_tanh
6
7
8 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
9 @to_ivy_arrays_and_back
10 def selu(
11 x,
12 /,
13 *,
14 alpha=1.6732632423543772848170429916717,
15 scale=1.0507009873554804934193349852946,
16 name=None,
17 ):
18 if scale <= 1.0:
19 raise ValueError(f"The scale must be greater than 1.0. Received: {scale}.")
20
21 if alpha < 0:
22 raise ValueError(f"The alpha must be no less than zero. Received: {alpha}.")
23
24 ret = ivy.where(x > 0, x, alpha * ivy.expm1(x))
25 arr = scale * ret
26 return ivy.astype(arr, x.dtype)
27
28
29 tanh = paddle_tanh
30
31
32 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
33 @to_ivy_arrays_and_back
34 def hardshrink(x, threshold=0.5, name=None):
35 mask = ivy.logical_or(ivy.greater(x, threshold), ivy.less(x, -threshold))
36 return ivy.where(mask, x, 0.0)
37
38
39 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
40 @to_ivy_arrays_and_back
41 def hardswish(x, name=None):
42 relu6_val = ivy.relu6(ivy.add(x, 3))
43 ret = ivy.multiply(x, ivy.divide(relu6_val, 6))
44 return ret
45
46
47 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
48 @to_ivy_arrays_and_back
49 def hardtanh(
50 x,
51 /,
52 *,
53 min=-1.0,
54 max=1.0,
55 name=None,
56 ):
57 less = ivy.where(ivy.less(x, min), min, x)
58 ret = ivy.where(ivy.greater(x, max), max, less).astype(x.dtype)
59 return ret
60
61
62 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
63 @to_ivy_arrays_and_back
64 def gelu(x, approximate=False, name=None):
65 return ivy.gelu(x, approximate=approximate)
66
67
68 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
69 @to_ivy_arrays_and_back
70 def hardsigmoid(x, slope=0.1666667, offset=0.5, name=None):
71 ret = ivy.minimum(ivy.maximum(ivy.add(ivy.multiply(x, slope), offset), 0), 1)
72 return ret
73
74
75 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
76 @to_ivy_arrays_and_back
77 def relu6(x, name=None):
78 return ivy.relu6(x)
79
80
81 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
82 @to_ivy_arrays_and_back
83 def softshrink(
84 x,
85 /,
86 *,
87 threshold=0.5,
88 name=None,
89 ):
90 low = ivy.where(ivy.less(x, -threshold), ivy.add(x, threshold), 0)
91 up = ivy.where(ivy.greater(x, threshold), ivy.subtract(x, threshold), 0)
92 add = ivy.add(low, up)
93 return ivy.astype(add, x.dtype)
94
95
96 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
97 @to_ivy_arrays_and_back
98 def softsign(
99 x,
100 /,
101 *,
102 name=None,
103 ):
104 return ivy.divide(x, ivy.add(1, ivy.abs(x)))
105
106
107 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
108 @to_ivy_arrays_and_back
109 def log_softmax(x, axis=-1, dtype=None, name=None):
110 x = ivy.astype(x, dtype) if dtype else x
111 ret = ivy.log_softmax(x, axis=axis)
112 ret = ivy.astype(ret, dtype) if dtype else ret
113 return ret
114
115
116 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
117 @to_ivy_arrays_and_back
118 def prelu(x, weight, data_format="NCHW", name=None):
119 return ivy.add(ivy.maximum(0, x), ivy.multiply(weight, ivy.minimum(0, x)))
120
121
122 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
123 @to_ivy_arrays_and_back
124 def celu(
125 x,
126 /,
127 *,
128 alpha=1.0,
129 name=None,
130 ):
131 prod = alpha * (ivy.exp(x / alpha) - 1)
132 ret = ivy.maximum(0, x) + ivy.minimum(0, prod)
133 return ret
134
135
136 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
137 @to_ivy_arrays_and_back
138 def rrelu(
139 x,
140 /,
141 *,
142 lower=0.125,
143 upper=0.3333333333333333,
144 training=False,
145 name=None,
146 ):
147 if lower < 0 or lower > 1:
148 raise ValueError(
149 "The lower value must be no less than zero or greater than one. Received:"
150 f" {lower}."
151 )
152
153 if upper < lower:
154 raise ValueError(
155 "The upper value must be greater than lower value. Received: lower"
156 f" {lower}, upper {upper}."
157 )
158
159 if upper > 1:
160 raise ValueError(
161 f"The upper value must be no greater than one. Received: {upper}."
162 )
163
164 is_test = not training
165 if is_test:
166 add = lower + upper
167 ret = add * x * 0.5
168 out = ivy.where(x >= 0, x, ret)
169 return out.astype(x.dtype)
170 # else:
171 # ToDo implement a correctly after fixing ivy.random_uniform
172 # a = ivy.random_normal(low=lower, high=upper)
173 # ret = ivy.where(x >= 0, x, ivy.multiply(a, x))
174 # return ret.astype(x.dtype)
175
176
177 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
178 @to_ivy_arrays_and_back
179 def tanhshrink(
180 x,
181 /,
182 *,
183 name=None,
184 ):
185 return ivy.subtract(x, ivy.tanh(x))
186
187
188 @with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
189 @to_ivy_arrays_and_back
190 def relu_(x, name=None):
191 ret = ivy.relu(x)
192 ivy.inplace_update(x, ret)
193 return x
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/ivy/functional/frontends/paddle/nn/functional/activation.py b/ivy/functional/frontends/paddle/nn/functional/activation.py
--- a/ivy/functional/frontends/paddle/nn/functional/activation.py
+++ b/ivy/functional/frontends/paddle/nn/functional/activation.py
@@ -191,3 +191,9 @@
ret = ivy.relu(x)
ivy.inplace_update(x, ret)
return x
+
+
+@with_supported_dtypes({"2.4.2 and below": ("float32", "float64")}, "paddle")
+@to_ivy_arrays_and_back
+def mish(x, name=None):
+ return ivy.mish(x)
| {"golden_diff": "diff --git a/ivy/functional/frontends/paddle/nn/functional/activation.py b/ivy/functional/frontends/paddle/nn/functional/activation.py\n--- a/ivy/functional/frontends/paddle/nn/functional/activation.py\n+++ b/ivy/functional/frontends/paddle/nn/functional/activation.py\n@@ -191,3 +191,9 @@\n ret = ivy.relu(x)\n ivy.inplace_update(x, ret)\n return x\n+\n+\n+@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n+@to_ivy_arrays_and_back\n+def mish(x, name=None):\n+ return ivy.mish(x)\n", "issue": "mish\n\n", "before_files": [{"content": "# local\nimport ivy\nfrom ivy.func_wrapper import with_supported_dtypes\nfrom ivy.functional.frontends.paddle.func_wrapper import to_ivy_arrays_and_back\nfrom ivy.functional.frontends.paddle.tensor.math import tanh as paddle_tanh\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef selu(\n x,\n /,\n *,\n alpha=1.6732632423543772848170429916717,\n scale=1.0507009873554804934193349852946,\n name=None,\n):\n if scale <= 1.0:\n raise ValueError(f\"The scale must be greater than 1.0. Received: {scale}.\")\n\n if alpha < 0:\n raise ValueError(f\"The alpha must be no less than zero. Received: {alpha}.\")\n\n ret = ivy.where(x > 0, x, alpha * ivy.expm1(x))\n arr = scale * ret\n return ivy.astype(arr, x.dtype)\n\n\ntanh = paddle_tanh\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef hardshrink(x, threshold=0.5, name=None):\n mask = ivy.logical_or(ivy.greater(x, threshold), ivy.less(x, -threshold))\n return ivy.where(mask, x, 0.0)\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef hardswish(x, name=None):\n relu6_val = ivy.relu6(ivy.add(x, 3))\n ret = ivy.multiply(x, ivy.divide(relu6_val, 6))\n return ret\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef hardtanh(\n x,\n /,\n *,\n min=-1.0,\n max=1.0,\n name=None,\n):\n less = ivy.where(ivy.less(x, min), min, x)\n ret = ivy.where(ivy.greater(x, max), max, less).astype(x.dtype)\n return ret\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef gelu(x, approximate=False, name=None):\n return ivy.gelu(x, approximate=approximate)\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef hardsigmoid(x, slope=0.1666667, offset=0.5, name=None):\n ret = ivy.minimum(ivy.maximum(ivy.add(ivy.multiply(x, slope), offset), 0), 1)\n return ret\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef relu6(x, name=None):\n return ivy.relu6(x)\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef softshrink(\n x,\n /,\n *,\n threshold=0.5,\n name=None,\n):\n low = ivy.where(ivy.less(x, -threshold), ivy.add(x, threshold), 0)\n up = ivy.where(ivy.greater(x, threshold), ivy.subtract(x, threshold), 0)\n add = ivy.add(low, up)\n return ivy.astype(add, x.dtype)\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef softsign(\n x,\n /,\n *,\n name=None,\n):\n return ivy.divide(x, ivy.add(1, ivy.abs(x)))\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef log_softmax(x, axis=-1, dtype=None, name=None):\n x = ivy.astype(x, dtype) if dtype else x\n ret = ivy.log_softmax(x, axis=axis)\n ret = ivy.astype(ret, dtype) if dtype else ret\n return ret\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef prelu(x, weight, data_format=\"NCHW\", name=None):\n return ivy.add(ivy.maximum(0, x), ivy.multiply(weight, ivy.minimum(0, x)))\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef celu(\n x,\n /,\n *,\n alpha=1.0,\n name=None,\n):\n prod = alpha * (ivy.exp(x / alpha) - 1)\n ret = ivy.maximum(0, x) + ivy.minimum(0, prod)\n return ret\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef rrelu(\n x,\n /,\n *,\n lower=0.125,\n upper=0.3333333333333333,\n training=False,\n name=None,\n):\n if lower < 0 or lower > 1:\n raise ValueError(\n \"The lower value must be no less than zero or greater than one. Received:\"\n f\" {lower}.\"\n )\n\n if upper < lower:\n raise ValueError(\n \"The upper value must be greater than lower value. Received: lower\"\n f\" {lower}, upper {upper}.\"\n )\n\n if upper > 1:\n raise ValueError(\n f\"The upper value must be no greater than one. Received: {upper}.\"\n )\n\n is_test = not training\n if is_test:\n add = lower + upper\n ret = add * x * 0.5\n out = ivy.where(x >= 0, x, ret)\n return out.astype(x.dtype)\n # else:\n # ToDo implement a correctly after fixing ivy.random_uniform\n # a = ivy.random_normal(low=lower, high=upper)\n # ret = ivy.where(x >= 0, x, ivy.multiply(a, x))\n # return ret.astype(x.dtype)\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef tanhshrink(\n x,\n /,\n *,\n name=None,\n):\n return ivy.subtract(x, ivy.tanh(x))\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef relu_(x, name=None):\n ret = ivy.relu(x)\n ivy.inplace_update(x, ret)\n return x\n", "path": "ivy/functional/frontends/paddle/nn/functional/activation.py"}], "after_files": [{"content": "# local\nimport ivy\nfrom ivy.func_wrapper import with_supported_dtypes\nfrom ivy.functional.frontends.paddle.func_wrapper import to_ivy_arrays_and_back\nfrom ivy.functional.frontends.paddle.tensor.math import tanh as paddle_tanh\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef selu(\n x,\n /,\n *,\n alpha=1.6732632423543772848170429916717,\n scale=1.0507009873554804934193349852946,\n name=None,\n):\n if scale <= 1.0:\n raise ValueError(f\"The scale must be greater than 1.0. Received: {scale}.\")\n\n if alpha < 0:\n raise ValueError(f\"The alpha must be no less than zero. Received: {alpha}.\")\n\n ret = ivy.where(x > 0, x, alpha * ivy.expm1(x))\n arr = scale * ret\n return ivy.astype(arr, x.dtype)\n\n\ntanh = paddle_tanh\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef hardshrink(x, threshold=0.5, name=None):\n mask = ivy.logical_or(ivy.greater(x, threshold), ivy.less(x, -threshold))\n return ivy.where(mask, x, 0.0)\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef hardswish(x, name=None):\n relu6_val = ivy.relu6(ivy.add(x, 3))\n ret = ivy.multiply(x, ivy.divide(relu6_val, 6))\n return ret\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef hardtanh(\n x,\n /,\n *,\n min=-1.0,\n max=1.0,\n name=None,\n):\n less = ivy.where(ivy.less(x, min), min, x)\n ret = ivy.where(ivy.greater(x, max), max, less).astype(x.dtype)\n return ret\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef gelu(x, approximate=False, name=None):\n return ivy.gelu(x, approximate=approximate)\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef hardsigmoid(x, slope=0.1666667, offset=0.5, name=None):\n ret = ivy.minimum(ivy.maximum(ivy.add(ivy.multiply(x, slope), offset), 0), 1)\n return ret\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef relu6(x, name=None):\n return ivy.relu6(x)\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef softshrink(\n x,\n /,\n *,\n threshold=0.5,\n name=None,\n):\n low = ivy.where(ivy.less(x, -threshold), ivy.add(x, threshold), 0)\n up = ivy.where(ivy.greater(x, threshold), ivy.subtract(x, threshold), 0)\n add = ivy.add(low, up)\n return ivy.astype(add, x.dtype)\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef softsign(\n x,\n /,\n *,\n name=None,\n):\n return ivy.divide(x, ivy.add(1, ivy.abs(x)))\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef log_softmax(x, axis=-1, dtype=None, name=None):\n x = ivy.astype(x, dtype) if dtype else x\n ret = ivy.log_softmax(x, axis=axis)\n ret = ivy.astype(ret, dtype) if dtype else ret\n return ret\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef prelu(x, weight, data_format=\"NCHW\", name=None):\n return ivy.add(ivy.maximum(0, x), ivy.multiply(weight, ivy.minimum(0, x)))\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef celu(\n x,\n /,\n *,\n alpha=1.0,\n name=None,\n):\n prod = alpha * (ivy.exp(x / alpha) - 1)\n ret = ivy.maximum(0, x) + ivy.minimum(0, prod)\n return ret\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef rrelu(\n x,\n /,\n *,\n lower=0.125,\n upper=0.3333333333333333,\n training=False,\n name=None,\n):\n if lower < 0 or lower > 1:\n raise ValueError(\n \"The lower value must be no less than zero or greater than one. Received:\"\n f\" {lower}.\"\n )\n\n if upper < lower:\n raise ValueError(\n \"The upper value must be greater than lower value. Received: lower\"\n f\" {lower}, upper {upper}.\"\n )\n\n if upper > 1:\n raise ValueError(\n f\"The upper value must be no greater than one. Received: {upper}.\"\n )\n\n is_test = not training\n if is_test:\n add = lower + upper\n ret = add * x * 0.5\n out = ivy.where(x >= 0, x, ret)\n return out.astype(x.dtype)\n # else:\n # ToDo implement a correctly after fixing ivy.random_uniform\n # a = ivy.random_normal(low=lower, high=upper)\n # ret = ivy.where(x >= 0, x, ivy.multiply(a, x))\n # return ret.astype(x.dtype)\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef tanhshrink(\n x,\n /,\n *,\n name=None,\n):\n return ivy.subtract(x, ivy.tanh(x))\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef relu_(x, name=None):\n ret = ivy.relu(x)\n ivy.inplace_update(x, ret)\n return x\n\n\n@with_supported_dtypes({\"2.4.2 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef mish(x, name=None):\n return ivy.mish(x)\n", "path": "ivy/functional/frontends/paddle/nn/functional/activation.py"}]} |
gh_patches_debug_228 | rasdani/github-patches | git_diff | paperless-ngx__paperless-ngx-2371 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[Bug] Websockets do not respect subpath
### Discussed in https://github.com/paperless-ngx/paperless-ngx/discussions/2236
<div type='discussions-op-text'>
<sup>Originally posted by **davidgiga1993** December 21, 2022</sup>
I migrated from paprless-ng to paperless-ngx and the websocket connection isn't working anymore:
```
WebSocket connection to 'wss://home.dev-core.org/paperless/ws/status/' failed:
```
The server returns status code 500.
I'm using `/paperless` as path and configured it according to the [documentation](https://docs.paperless-ngx.com/configuration/#hosting-and-security)
```
PAPERLESS_FORCE_SCRIPT_NAME=/paperless
PAPERLESS_STATIC_URL=/paperless/static/
PAPERLESS_MEDIA_URL=/paperless/media/
PAPERLESS_URL=https://my-domain.com
```
my nginx config hasn't changed since and worked fine before:
```
proxy_set_header Host $host;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-Host $http_host;
proxy_set_header X-Forwarded-Uri $request_uri;
proxy_set_header X-Forwarded-Ssl on;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header X-Real-IP $remote_addr;
client_body_buffer_size 128k;
proxy_next_upstream error timeout;
proxy_redirect http:// $scheme://;
proxy_http_version 1.1;
proxy_cache_bypass $cookie_session;
proxy_no_cache $cookie_session;
proxy_buffers 64 256k;
# Allow websockets
proxy_cache_bypass $http_upgrade;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
real_ip_header X-Forwarded-For;
real_ip_recursive on;
send_timeout 5m;
proxy_read_timeout 360;
proxy_send_timeout 360;
proxy_connect_timeout 360;
```
It looks like paperless ngx isn't using the context path for the websockets - here is a test using curl. The first request (with the correct path) returns `500`, the second one without any context path returns correctly `403`
```
nas paperless # curl -i -N -H "Connection: Upgrade" -H "Upgrade: websocket" -H "Host: my-domain.com" -H "Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==" -H "Sec-WebSocket-Version: 13" localhost:8000/paperless/ws/status/
HTTP/1.1 500 Internal Server Error
content-type: text/plain; charset=utf-8
content-length: 21
connection: close
Internal Server Error#
nas paperless # curl -i -N -H "Connection: Upgrade" -H "Upgrade: websocket" -H "Host: my-domain.com" -H "Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==" -H "Sec-WebSocket-Version: 13" localhost:8000/ws/status/
HTTP/1.1 403 Forbidden
Date: Sun, 11 Dec 2022 10:03:35 GMT
Server: Python/3.9 websockets/10.4
Content-Length: 0
Content-Type: text/plain
Connection: close
```
any ideas? Anything else I should test?
</div>
--- 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/paperless/urls.py`
Content:
```
1 from django.conf import settings
2 from django.conf.urls import include
3 from django.contrib import admin
4 from django.contrib.auth.decorators import login_required
5 from django.urls import path
6 from django.urls import re_path
7 from django.utils.translation import gettext_lazy as _
8 from django.views.decorators.csrf import csrf_exempt
9 from django.views.generic import RedirectView
10 from documents.views import AcknowledgeTasksView
11 from documents.views import BulkDownloadView
12 from documents.views import BulkEditView
13 from documents.views import CorrespondentViewSet
14 from documents.views import DocumentTypeViewSet
15 from documents.views import IndexView
16 from documents.views import LogViewSet
17 from documents.views import PostDocumentView
18 from documents.views import RemoteVersionView
19 from documents.views import SavedViewViewSet
20 from documents.views import SearchAutoCompleteView
21 from documents.views import SelectionDataView
22 from documents.views import StatisticsView
23 from documents.views import StoragePathViewSet
24 from documents.views import TagViewSet
25 from documents.views import TasksViewSet
26 from documents.views import UiSettingsView
27 from documents.views import UnifiedSearchViewSet
28 from paperless.consumers import StatusConsumer
29 from paperless.views import FaviconView
30 from paperless_mail.views import MailAccountViewSet
31 from paperless_mail.views import MailRuleViewSet
32 from rest_framework.authtoken import views
33 from rest_framework.routers import DefaultRouter
34
35 api_router = DefaultRouter()
36 api_router.register(r"correspondents", CorrespondentViewSet)
37 api_router.register(r"document_types", DocumentTypeViewSet)
38 api_router.register(r"documents", UnifiedSearchViewSet)
39 api_router.register(r"logs", LogViewSet, basename="logs")
40 api_router.register(r"tags", TagViewSet)
41 api_router.register(r"saved_views", SavedViewViewSet)
42 api_router.register(r"storage_paths", StoragePathViewSet)
43 api_router.register(r"tasks", TasksViewSet, basename="tasks")
44 api_router.register(r"mail_accounts", MailAccountViewSet)
45 api_router.register(r"mail_rules", MailRuleViewSet)
46
47
48 urlpatterns = [
49 re_path(
50 r"^api/",
51 include(
52 [
53 re_path(
54 r"^auth/",
55 include(
56 ("rest_framework.urls", "rest_framework"),
57 namespace="rest_framework",
58 ),
59 ),
60 re_path(
61 r"^search/autocomplete/",
62 SearchAutoCompleteView.as_view(),
63 name="autocomplete",
64 ),
65 re_path(r"^statistics/", StatisticsView.as_view(), name="statistics"),
66 re_path(
67 r"^documents/post_document/",
68 PostDocumentView.as_view(),
69 name="post_document",
70 ),
71 re_path(
72 r"^documents/bulk_edit/",
73 BulkEditView.as_view(),
74 name="bulk_edit",
75 ),
76 re_path(
77 r"^documents/selection_data/",
78 SelectionDataView.as_view(),
79 name="selection_data",
80 ),
81 re_path(
82 r"^documents/bulk_download/",
83 BulkDownloadView.as_view(),
84 name="bulk_download",
85 ),
86 re_path(
87 r"^remote_version/",
88 RemoteVersionView.as_view(),
89 name="remoteversion",
90 ),
91 re_path(
92 r"^ui_settings/",
93 UiSettingsView.as_view(),
94 name="ui_settings",
95 ),
96 re_path(
97 r"^acknowledge_tasks/",
98 AcknowledgeTasksView.as_view(),
99 name="acknowledge_tasks",
100 ),
101 path("token/", views.obtain_auth_token),
102 ]
103 + api_router.urls,
104 ),
105 ),
106 re_path(r"^favicon.ico$", FaviconView.as_view(), name="favicon"),
107 re_path(r"admin/", admin.site.urls),
108 re_path(
109 r"^fetch/",
110 include(
111 [
112 re_path(
113 r"^doc/(?P<pk>\d+)$",
114 RedirectView.as_view(
115 url=settings.BASE_URL + "api/documents/%(pk)s/download/",
116 ),
117 ),
118 re_path(
119 r"^thumb/(?P<pk>\d+)$",
120 RedirectView.as_view(
121 url=settings.BASE_URL + "api/documents/%(pk)s/thumb/",
122 ),
123 ),
124 re_path(
125 r"^preview/(?P<pk>\d+)$",
126 RedirectView.as_view(
127 url=settings.BASE_URL + "api/documents/%(pk)s/preview/",
128 ),
129 ),
130 ],
131 ),
132 ),
133 re_path(
134 r"^push$",
135 csrf_exempt(
136 RedirectView.as_view(
137 url=settings.BASE_URL + "api/documents/post_document/",
138 ),
139 ),
140 ),
141 # Frontend assets TODO: this is pretty bad, but it works.
142 path(
143 "assets/<path:path>",
144 RedirectView.as_view(
145 url=settings.STATIC_URL + "frontend/en-US/assets/%(path)s",
146 ),
147 ),
148 # TODO: with localization, this is even worse! :/
149 # login, logout
150 path("accounts/", include("django.contrib.auth.urls")),
151 # Root of the Frontent
152 re_path(r".*", login_required(IndexView.as_view()), name="base"),
153 ]
154
155
156 websocket_urlpatterns = [
157 re_path(r"ws/status/$", StatusConsumer.as_asgi()),
158 ]
159
160 # Text in each page's <h1> (and above login form).
161 admin.site.site_header = "Paperless-ngx"
162 # Text at the end of each page's <title>.
163 admin.site.site_title = "Paperless-ngx"
164 # Text at the top of the admin index page.
165 admin.site.index_title = _("Paperless-ngx administration")
166
```
--- 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/paperless/urls.py b/src/paperless/urls.py
--- a/src/paperless/urls.py
+++ b/src/paperless/urls.py
@@ -154,7 +154,7 @@
websocket_urlpatterns = [
- re_path(r"ws/status/$", StatusConsumer.as_asgi()),
+ path(settings.BASE_URL.lstrip("/") + "ws/status/", StatusConsumer.as_asgi()),
]
# Text in each page's <h1> (and above login form).
| {"golden_diff": "diff --git a/src/paperless/urls.py b/src/paperless/urls.py\n--- a/src/paperless/urls.py\n+++ b/src/paperless/urls.py\n@@ -154,7 +154,7 @@\n \n \n websocket_urlpatterns = [\n- re_path(r\"ws/status/$\", StatusConsumer.as_asgi()),\n+ path(settings.BASE_URL.lstrip(\"/\") + \"ws/status/\", StatusConsumer.as_asgi()),\n ]\n \n # Text in each page's <h1> (and above login form).\n", "issue": "[Bug] Websockets do not respect subpath\n### Discussed in https://github.com/paperless-ngx/paperless-ngx/discussions/2236\r\n\r\n<div type='discussions-op-text'>\r\n\r\n<sup>Originally posted by **davidgiga1993** December 21, 2022</sup>\r\nI migrated from paprless-ng to paperless-ngx and the websocket connection isn't working anymore:\r\n```\r\nWebSocket connection to 'wss://home.dev-core.org/paperless/ws/status/' failed:\r\n```\r\nThe server returns status code 500.\r\n\r\nI'm using `/paperless` as path and configured it according to the [documentation](https://docs.paperless-ngx.com/configuration/#hosting-and-security)\r\n```\r\nPAPERLESS_FORCE_SCRIPT_NAME=/paperless\r\nPAPERLESS_STATIC_URL=/paperless/static/\r\nPAPERLESS_MEDIA_URL=/paperless/media/\r\n\r\nPAPERLESS_URL=https://my-domain.com\r\n```\r\n\r\nmy nginx config hasn't changed since and worked fine before:\r\n```\r\nproxy_set_header Host $host;\r\nproxy_set_header X-Forwarded-Proto $scheme;\r\nproxy_set_header X-Forwarded-Host $http_host;\r\nproxy_set_header X-Forwarded-Uri $request_uri;\r\nproxy_set_header X-Forwarded-Ssl on;\r\nproxy_set_header X-Forwarded-For $remote_addr;\r\nproxy_set_header X-Real-IP $remote_addr;\r\n\r\nclient_body_buffer_size 128k;\r\nproxy_next_upstream error timeout;\r\nproxy_redirect http:// $scheme://;\r\nproxy_http_version 1.1;\r\nproxy_cache_bypass $cookie_session;\r\nproxy_no_cache $cookie_session;\r\nproxy_buffers 64 256k;\r\n\r\n# Allow websockets\r\nproxy_cache_bypass $http_upgrade;\r\nproxy_set_header Upgrade $http_upgrade;\r\nproxy_set_header Connection \"upgrade\";\r\n\r\nreal_ip_header X-Forwarded-For;\r\nreal_ip_recursive on;\r\n\r\nsend_timeout 5m;\r\nproxy_read_timeout 360;\r\nproxy_send_timeout 360;\r\nproxy_connect_timeout 360;\r\n```\r\n\r\nIt looks like paperless ngx isn't using the context path for the websockets - here is a test using curl. The first request (with the correct path) returns `500`, the second one without any context path returns correctly `403`\r\n```\r\nnas paperless # curl -i -N -H \"Connection: Upgrade\" -H \"Upgrade: websocket\" -H \"Host: my-domain.com\" -H \"Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\" -H \"Sec-WebSocket-Version: 13\" localhost:8000/paperless/ws/status/\r\nHTTP/1.1 500 Internal Server Error\r\ncontent-type: text/plain; charset=utf-8\r\ncontent-length: 21\r\nconnection: close\r\n\r\nInternal Server Error#\r\nnas paperless # curl -i -N -H \"Connection: Upgrade\" -H \"Upgrade: websocket\" -H \"Host: my-domain.com\" -H \"Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\" -H \"Sec-WebSocket-Version: 13\" localhost:8000/ws/status/\r\nHTTP/1.1 403 Forbidden\r\nDate: Sun, 11 Dec 2022 10:03:35 GMT\r\nServer: Python/3.9 websockets/10.4\r\nContent-Length: 0\r\nContent-Type: text/plain\r\nConnection: close\r\n```\r\n\r\nany ideas? Anything else I should test?\r\n </div>\n", "before_files": [{"content": "from django.conf import settings\nfrom django.conf.urls import include\nfrom django.contrib import admin\nfrom django.contrib.auth.decorators import login_required\nfrom django.urls import path\nfrom django.urls import re_path\nfrom django.utils.translation import gettext_lazy as _\nfrom django.views.decorators.csrf import csrf_exempt\nfrom django.views.generic import RedirectView\nfrom documents.views import AcknowledgeTasksView\nfrom documents.views import BulkDownloadView\nfrom documents.views import BulkEditView\nfrom documents.views import CorrespondentViewSet\nfrom documents.views import DocumentTypeViewSet\nfrom documents.views import IndexView\nfrom documents.views import LogViewSet\nfrom documents.views import PostDocumentView\nfrom documents.views import RemoteVersionView\nfrom documents.views import SavedViewViewSet\nfrom documents.views import SearchAutoCompleteView\nfrom documents.views import SelectionDataView\nfrom documents.views import StatisticsView\nfrom documents.views import StoragePathViewSet\nfrom documents.views import TagViewSet\nfrom documents.views import TasksViewSet\nfrom documents.views import UiSettingsView\nfrom documents.views import UnifiedSearchViewSet\nfrom paperless.consumers import StatusConsumer\nfrom paperless.views import FaviconView\nfrom paperless_mail.views import MailAccountViewSet\nfrom paperless_mail.views import MailRuleViewSet\nfrom rest_framework.authtoken import views\nfrom rest_framework.routers import DefaultRouter\n\napi_router = DefaultRouter()\napi_router.register(r\"correspondents\", CorrespondentViewSet)\napi_router.register(r\"document_types\", DocumentTypeViewSet)\napi_router.register(r\"documents\", UnifiedSearchViewSet)\napi_router.register(r\"logs\", LogViewSet, basename=\"logs\")\napi_router.register(r\"tags\", TagViewSet)\napi_router.register(r\"saved_views\", SavedViewViewSet)\napi_router.register(r\"storage_paths\", StoragePathViewSet)\napi_router.register(r\"tasks\", TasksViewSet, basename=\"tasks\")\napi_router.register(r\"mail_accounts\", MailAccountViewSet)\napi_router.register(r\"mail_rules\", MailRuleViewSet)\n\n\nurlpatterns = [\n re_path(\n r\"^api/\",\n include(\n [\n re_path(\n r\"^auth/\",\n include(\n (\"rest_framework.urls\", \"rest_framework\"),\n namespace=\"rest_framework\",\n ),\n ),\n re_path(\n r\"^search/autocomplete/\",\n SearchAutoCompleteView.as_view(),\n name=\"autocomplete\",\n ),\n re_path(r\"^statistics/\", StatisticsView.as_view(), name=\"statistics\"),\n re_path(\n r\"^documents/post_document/\",\n PostDocumentView.as_view(),\n name=\"post_document\",\n ),\n re_path(\n r\"^documents/bulk_edit/\",\n BulkEditView.as_view(),\n name=\"bulk_edit\",\n ),\n re_path(\n r\"^documents/selection_data/\",\n SelectionDataView.as_view(),\n name=\"selection_data\",\n ),\n re_path(\n r\"^documents/bulk_download/\",\n BulkDownloadView.as_view(),\n name=\"bulk_download\",\n ),\n re_path(\n r\"^remote_version/\",\n RemoteVersionView.as_view(),\n name=\"remoteversion\",\n ),\n re_path(\n r\"^ui_settings/\",\n UiSettingsView.as_view(),\n name=\"ui_settings\",\n ),\n re_path(\n r\"^acknowledge_tasks/\",\n AcknowledgeTasksView.as_view(),\n name=\"acknowledge_tasks\",\n ),\n path(\"token/\", views.obtain_auth_token),\n ]\n + api_router.urls,\n ),\n ),\n re_path(r\"^favicon.ico$\", FaviconView.as_view(), name=\"favicon\"),\n re_path(r\"admin/\", admin.site.urls),\n re_path(\n r\"^fetch/\",\n include(\n [\n re_path(\n r\"^doc/(?P<pk>\\d+)$\",\n RedirectView.as_view(\n url=settings.BASE_URL + \"api/documents/%(pk)s/download/\",\n ),\n ),\n re_path(\n r\"^thumb/(?P<pk>\\d+)$\",\n RedirectView.as_view(\n url=settings.BASE_URL + \"api/documents/%(pk)s/thumb/\",\n ),\n ),\n re_path(\n r\"^preview/(?P<pk>\\d+)$\",\n RedirectView.as_view(\n url=settings.BASE_URL + \"api/documents/%(pk)s/preview/\",\n ),\n ),\n ],\n ),\n ),\n re_path(\n r\"^push$\",\n csrf_exempt(\n RedirectView.as_view(\n url=settings.BASE_URL + \"api/documents/post_document/\",\n ),\n ),\n ),\n # Frontend assets TODO: this is pretty bad, but it works.\n path(\n \"assets/<path:path>\",\n RedirectView.as_view(\n url=settings.STATIC_URL + \"frontend/en-US/assets/%(path)s\",\n ),\n ),\n # TODO: with localization, this is even worse! :/\n # login, logout\n path(\"accounts/\", include(\"django.contrib.auth.urls\")),\n # Root of the Frontent\n re_path(r\".*\", login_required(IndexView.as_view()), name=\"base\"),\n]\n\n\nwebsocket_urlpatterns = [\n re_path(r\"ws/status/$\", StatusConsumer.as_asgi()),\n]\n\n# Text in each page's <h1> (and above login form).\nadmin.site.site_header = \"Paperless-ngx\"\n# Text at the end of each page's <title>.\nadmin.site.site_title = \"Paperless-ngx\"\n# Text at the top of the admin index page.\nadmin.site.index_title = _(\"Paperless-ngx administration\")\n", "path": "src/paperless/urls.py"}], "after_files": [{"content": "from django.conf import settings\nfrom django.conf.urls import include\nfrom django.contrib import admin\nfrom django.contrib.auth.decorators import login_required\nfrom django.urls import path\nfrom django.urls import re_path\nfrom django.utils.translation import gettext_lazy as _\nfrom django.views.decorators.csrf import csrf_exempt\nfrom django.views.generic import RedirectView\nfrom documents.views import AcknowledgeTasksView\nfrom documents.views import BulkDownloadView\nfrom documents.views import BulkEditView\nfrom documents.views import CorrespondentViewSet\nfrom documents.views import DocumentTypeViewSet\nfrom documents.views import IndexView\nfrom documents.views import LogViewSet\nfrom documents.views import PostDocumentView\nfrom documents.views import RemoteVersionView\nfrom documents.views import SavedViewViewSet\nfrom documents.views import SearchAutoCompleteView\nfrom documents.views import SelectionDataView\nfrom documents.views import StatisticsView\nfrom documents.views import StoragePathViewSet\nfrom documents.views import TagViewSet\nfrom documents.views import TasksViewSet\nfrom documents.views import UiSettingsView\nfrom documents.views import UnifiedSearchViewSet\nfrom paperless.consumers import StatusConsumer\nfrom paperless.views import FaviconView\nfrom paperless_mail.views import MailAccountViewSet\nfrom paperless_mail.views import MailRuleViewSet\nfrom rest_framework.authtoken import views\nfrom rest_framework.routers import DefaultRouter\n\napi_router = DefaultRouter()\napi_router.register(r\"correspondents\", CorrespondentViewSet)\napi_router.register(r\"document_types\", DocumentTypeViewSet)\napi_router.register(r\"documents\", UnifiedSearchViewSet)\napi_router.register(r\"logs\", LogViewSet, basename=\"logs\")\napi_router.register(r\"tags\", TagViewSet)\napi_router.register(r\"saved_views\", SavedViewViewSet)\napi_router.register(r\"storage_paths\", StoragePathViewSet)\napi_router.register(r\"tasks\", TasksViewSet, basename=\"tasks\")\napi_router.register(r\"mail_accounts\", MailAccountViewSet)\napi_router.register(r\"mail_rules\", MailRuleViewSet)\n\n\nurlpatterns = [\n re_path(\n r\"^api/\",\n include(\n [\n re_path(\n r\"^auth/\",\n include(\n (\"rest_framework.urls\", \"rest_framework\"),\n namespace=\"rest_framework\",\n ),\n ),\n re_path(\n r\"^search/autocomplete/\",\n SearchAutoCompleteView.as_view(),\n name=\"autocomplete\",\n ),\n re_path(r\"^statistics/\", StatisticsView.as_view(), name=\"statistics\"),\n re_path(\n r\"^documents/post_document/\",\n PostDocumentView.as_view(),\n name=\"post_document\",\n ),\n re_path(\n r\"^documents/bulk_edit/\",\n BulkEditView.as_view(),\n name=\"bulk_edit\",\n ),\n re_path(\n r\"^documents/selection_data/\",\n SelectionDataView.as_view(),\n name=\"selection_data\",\n ),\n re_path(\n r\"^documents/bulk_download/\",\n BulkDownloadView.as_view(),\n name=\"bulk_download\",\n ),\n re_path(\n r\"^remote_version/\",\n RemoteVersionView.as_view(),\n name=\"remoteversion\",\n ),\n re_path(\n r\"^ui_settings/\",\n UiSettingsView.as_view(),\n name=\"ui_settings\",\n ),\n re_path(\n r\"^acknowledge_tasks/\",\n AcknowledgeTasksView.as_view(),\n name=\"acknowledge_tasks\",\n ),\n path(\"token/\", views.obtain_auth_token),\n ]\n + api_router.urls,\n ),\n ),\n re_path(r\"^favicon.ico$\", FaviconView.as_view(), name=\"favicon\"),\n re_path(r\"admin/\", admin.site.urls),\n re_path(\n r\"^fetch/\",\n include(\n [\n re_path(\n r\"^doc/(?P<pk>\\d+)$\",\n RedirectView.as_view(\n url=settings.BASE_URL + \"api/documents/%(pk)s/download/\",\n ),\n ),\n re_path(\n r\"^thumb/(?P<pk>\\d+)$\",\n RedirectView.as_view(\n url=settings.BASE_URL + \"api/documents/%(pk)s/thumb/\",\n ),\n ),\n re_path(\n r\"^preview/(?P<pk>\\d+)$\",\n RedirectView.as_view(\n url=settings.BASE_URL + \"api/documents/%(pk)s/preview/\",\n ),\n ),\n ],\n ),\n ),\n re_path(\n r\"^push$\",\n csrf_exempt(\n RedirectView.as_view(\n url=settings.BASE_URL + \"api/documents/post_document/\",\n ),\n ),\n ),\n # Frontend assets TODO: this is pretty bad, but it works.\n path(\n \"assets/<path:path>\",\n RedirectView.as_view(\n url=settings.STATIC_URL + \"frontend/en-US/assets/%(path)s\",\n ),\n ),\n # TODO: with localization, this is even worse! :/\n # login, logout\n path(\"accounts/\", include(\"django.contrib.auth.urls\")),\n # Root of the Frontent\n re_path(r\".*\", login_required(IndexView.as_view()), name=\"base\"),\n]\n\n\nwebsocket_urlpatterns = [\n path(settings.BASE_URL.lstrip(\"/\") + \"ws/status/\", StatusConsumer.as_asgi()),\n]\n\n# Text in each page's <h1> (and above login form).\nadmin.site.site_header = \"Paperless-ngx\"\n# Text at the end of each page's <title>.\nadmin.site.site_title = \"Paperless-ngx\"\n# Text at the top of the admin index page.\nadmin.site.index_title = _(\"Paperless-ngx administration\")\n", "path": "src/paperless/urls.py"}]} |
gh_patches_debug_229 | rasdani/github-patches | git_diff | marshmallow-code__webargs-385 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Fix compatibility with Falcon 2.0
Tests are currently failing when Falcon 2.0.0 is installed.
--- 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 # -*- coding: utf-8 -*-
2 import sys
3 import re
4 from setuptools import setup, find_packages
5
6 INSTALL_REQUIRES = ["marshmallow>=2.15.2"]
7 if sys.version_info[0] < 3:
8 INSTALL_REQUIRES.append("simplejson>=2.1.0")
9
10 FRAMEWORKS = [
11 "Flask>=0.12.2",
12 "Django>=1.11.16",
13 "bottle>=0.12.13",
14 "tornado>=4.5.2",
15 "pyramid>=1.9.1",
16 "webapp2>=3.0.0b1",
17 "falcon>=1.4.0",
18 'aiohttp>=3.0.0; python_version >= "3.5"',
19 ]
20 EXTRAS_REQUIRE = {
21 "frameworks": FRAMEWORKS,
22 "tests": [
23 "pytest",
24 "mock",
25 "webtest==2.0.32",
26 'webtest-aiohttp==2.0.0; python_version >= "3.5"',
27 'pytest-aiohttp>=0.3.0; python_version >= "3.5"',
28 ]
29 + FRAMEWORKS,
30 "lint": [
31 'mypy==0.650; python_version >= "3.5"',
32 "flake8==3.6.0",
33 'flake8-bugbear==18.8.0; python_version >= "3.5"',
34 "pre-commit==1.13.0",
35 ],
36 }
37 EXTRAS_REQUIRE["dev"] = EXTRAS_REQUIRE["tests"] + EXTRAS_REQUIRE["lint"] + ["tox"]
38
39
40 def find_version(fname):
41 """Attempts to find the version number in the file names fname.
42 Raises RuntimeError if not found.
43 """
44 version = ""
45 with open(fname, "r") as fp:
46 reg = re.compile(r'__version__ = [\'"]([^\'"]*)[\'"]')
47 for line in fp:
48 m = reg.match(line)
49 if m:
50 version = m.group(1)
51 break
52 if not version:
53 raise RuntimeError("Cannot find version information")
54 return version
55
56
57 def read(fname):
58 with open(fname) as fp:
59 content = fp.read()
60 return content
61
62
63 setup(
64 name="webargs",
65 version=find_version("src/webargs/__init__.py"),
66 description=(
67 "Declarative parsing and validation of HTTP request objects, "
68 "with built-in support for popular web frameworks, including "
69 "Flask, Django, Bottle, Tornado, Pyramid, webapp2, Falcon, and aiohttp."
70 ),
71 long_description=read("README.rst"),
72 author="Steven Loria",
73 author_email="[email protected]",
74 url="https://github.com/marshmallow-code/webargs",
75 packages=find_packages("src"),
76 package_dir={"": "src"},
77 install_requires=INSTALL_REQUIRES,
78 extras_require=EXTRAS_REQUIRE,
79 license="MIT",
80 zip_safe=False,
81 keywords=(
82 "webargs",
83 "http",
84 "flask",
85 "django",
86 "bottle",
87 "tornado",
88 "aiohttp",
89 "webapp2",
90 "request",
91 "arguments",
92 "validation",
93 "parameters",
94 "rest",
95 "api",
96 "marshmallow",
97 ),
98 classifiers=[
99 "Development Status :: 5 - Production/Stable",
100 "Intended Audience :: Developers",
101 "License :: OSI Approved :: MIT License",
102 "Natural Language :: English",
103 "Programming Language :: Python :: 2",
104 "Programming Language :: Python :: 2.7",
105 "Programming Language :: Python :: 3",
106 "Programming Language :: Python :: 3.5",
107 "Programming Language :: Python :: 3.6",
108 "Programming Language :: Python :: 3.7",
109 "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
110 "Topic :: Internet :: WWW/HTTP :: WSGI :: Application",
111 ],
112 test_suite="tests",
113 project_urls={
114 "Changelog": "https://webargs.readthedocs.io/en/latest/changelog.html",
115 "Issues": "https://github.com/marshmallow-code/webargs/issues",
116 "Funding": "https://opencollective.com/marshmallow",
117 "Tidelift": "https://tidelift.com/subscription/pkg/pypi-webargs?utm_source=pypi-marshmallow&utm_medium=pypi", # noqa
118 },
119 )
120
```
--- 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
@@ -14,7 +14,7 @@
"tornado>=4.5.2",
"pyramid>=1.9.1",
"webapp2>=3.0.0b1",
- "falcon>=1.4.0",
+ "falcon>=1.4.0,<2.0",
'aiohttp>=3.0.0; python_version >= "3.5"',
]
EXTRAS_REQUIRE = {
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -14,7 +14,7 @@\n \"tornado>=4.5.2\",\n \"pyramid>=1.9.1\",\n \"webapp2>=3.0.0b1\",\n- \"falcon>=1.4.0\",\n+ \"falcon>=1.4.0,<2.0\",\n 'aiohttp>=3.0.0; python_version >= \"3.5\"',\n ]\n EXTRAS_REQUIRE = {\n", "issue": "Fix compatibility with Falcon 2.0\nTests are currently failing when Falcon 2.0.0 is installed.\n", "before_files": [{"content": "# -*- coding: utf-8 -*-\nimport sys\nimport re\nfrom setuptools import setup, find_packages\n\nINSTALL_REQUIRES = [\"marshmallow>=2.15.2\"]\nif sys.version_info[0] < 3:\n INSTALL_REQUIRES.append(\"simplejson>=2.1.0\")\n\nFRAMEWORKS = [\n \"Flask>=0.12.2\",\n \"Django>=1.11.16\",\n \"bottle>=0.12.13\",\n \"tornado>=4.5.2\",\n \"pyramid>=1.9.1\",\n \"webapp2>=3.0.0b1\",\n \"falcon>=1.4.0\",\n 'aiohttp>=3.0.0; python_version >= \"3.5\"',\n]\nEXTRAS_REQUIRE = {\n \"frameworks\": FRAMEWORKS,\n \"tests\": [\n \"pytest\",\n \"mock\",\n \"webtest==2.0.32\",\n 'webtest-aiohttp==2.0.0; python_version >= \"3.5\"',\n 'pytest-aiohttp>=0.3.0; python_version >= \"3.5\"',\n ]\n + FRAMEWORKS,\n \"lint\": [\n 'mypy==0.650; python_version >= \"3.5\"',\n \"flake8==3.6.0\",\n 'flake8-bugbear==18.8.0; python_version >= \"3.5\"',\n \"pre-commit==1.13.0\",\n ],\n}\nEXTRAS_REQUIRE[\"dev\"] = EXTRAS_REQUIRE[\"tests\"] + EXTRAS_REQUIRE[\"lint\"] + [\"tox\"]\n\n\ndef find_version(fname):\n \"\"\"Attempts to find the version number in the file names fname.\n Raises RuntimeError if not found.\n \"\"\"\n version = \"\"\n with open(fname, \"r\") as fp:\n reg = re.compile(r'__version__ = [\\'\"]([^\\'\"]*)[\\'\"]')\n for line in fp:\n m = reg.match(line)\n if m:\n version = m.group(1)\n break\n if not version:\n raise RuntimeError(\"Cannot find version information\")\n return version\n\n\ndef read(fname):\n with open(fname) as fp:\n content = fp.read()\n return content\n\n\nsetup(\n name=\"webargs\",\n version=find_version(\"src/webargs/__init__.py\"),\n description=(\n \"Declarative parsing and validation of HTTP request objects, \"\n \"with built-in support for popular web frameworks, including \"\n \"Flask, Django, Bottle, Tornado, Pyramid, webapp2, Falcon, and aiohttp.\"\n ),\n long_description=read(\"README.rst\"),\n author=\"Steven Loria\",\n author_email=\"[email protected]\",\n url=\"https://github.com/marshmallow-code/webargs\",\n packages=find_packages(\"src\"),\n package_dir={\"\": \"src\"},\n install_requires=INSTALL_REQUIRES,\n extras_require=EXTRAS_REQUIRE,\n license=\"MIT\",\n zip_safe=False,\n keywords=(\n \"webargs\",\n \"http\",\n \"flask\",\n \"django\",\n \"bottle\",\n \"tornado\",\n \"aiohttp\",\n \"webapp2\",\n \"request\",\n \"arguments\",\n \"validation\",\n \"parameters\",\n \"rest\",\n \"api\",\n \"marshmallow\",\n ),\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: MIT License\",\n \"Natural Language :: English\",\n \"Programming Language :: Python :: 2\",\n \"Programming Language :: Python :: 2.7\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Topic :: Internet :: WWW/HTTP :: Dynamic Content\",\n \"Topic :: Internet :: WWW/HTTP :: WSGI :: Application\",\n ],\n test_suite=\"tests\",\n project_urls={\n \"Changelog\": \"https://webargs.readthedocs.io/en/latest/changelog.html\",\n \"Issues\": \"https://github.com/marshmallow-code/webargs/issues\",\n \"Funding\": \"https://opencollective.com/marshmallow\",\n \"Tidelift\": \"https://tidelift.com/subscription/pkg/pypi-webargs?utm_source=pypi-marshmallow&utm_medium=pypi\", # noqa\n },\n)\n", "path": "setup.py"}], "after_files": [{"content": "# -*- coding: utf-8 -*-\nimport sys\nimport re\nfrom setuptools import setup, find_packages\n\nINSTALL_REQUIRES = [\"marshmallow>=2.15.2\"]\nif sys.version_info[0] < 3:\n INSTALL_REQUIRES.append(\"simplejson>=2.1.0\")\n\nFRAMEWORKS = [\n \"Flask>=0.12.2\",\n \"Django>=1.11.16\",\n \"bottle>=0.12.13\",\n \"tornado>=4.5.2\",\n \"pyramid>=1.9.1\",\n \"webapp2>=3.0.0b1\",\n \"falcon>=1.4.0,<2.0\",\n 'aiohttp>=3.0.0; python_version >= \"3.5\"',\n]\nEXTRAS_REQUIRE = {\n \"frameworks\": FRAMEWORKS,\n \"tests\": [\n \"pytest\",\n \"mock\",\n \"webtest==2.0.32\",\n 'webtest-aiohttp==2.0.0; python_version >= \"3.5\"',\n 'pytest-aiohttp>=0.3.0; python_version >= \"3.5\"',\n ]\n + FRAMEWORKS,\n \"lint\": [\n 'mypy==0.650; python_version >= \"3.5\"',\n \"flake8==3.6.0\",\n 'flake8-bugbear==18.8.0; python_version >= \"3.5\"',\n \"pre-commit==1.13.0\",\n ],\n}\nEXTRAS_REQUIRE[\"dev\"] = EXTRAS_REQUIRE[\"tests\"] + EXTRAS_REQUIRE[\"lint\"] + [\"tox\"]\n\n\ndef find_version(fname):\n \"\"\"Attempts to find the version number in the file names fname.\n Raises RuntimeError if not found.\n \"\"\"\n version = \"\"\n with open(fname, \"r\") as fp:\n reg = re.compile(r'__version__ = [\\'\"]([^\\'\"]*)[\\'\"]')\n for line in fp:\n m = reg.match(line)\n if m:\n version = m.group(1)\n break\n if not version:\n raise RuntimeError(\"Cannot find version information\")\n return version\n\n\ndef read(fname):\n with open(fname) as fp:\n content = fp.read()\n return content\n\n\nsetup(\n name=\"webargs\",\n version=find_version(\"src/webargs/__init__.py\"),\n description=(\n \"Declarative parsing and validation of HTTP request objects, \"\n \"with built-in support for popular web frameworks, including \"\n \"Flask, Django, Bottle, Tornado, Pyramid, webapp2, Falcon, and aiohttp.\"\n ),\n long_description=read(\"README.rst\"),\n author=\"Steven Loria\",\n author_email=\"[email protected]\",\n url=\"https://github.com/marshmallow-code/webargs\",\n packages=find_packages(\"src\"),\n package_dir={\"\": \"src\"},\n install_requires=INSTALL_REQUIRES,\n extras_require=EXTRAS_REQUIRE,\n license=\"MIT\",\n zip_safe=False,\n keywords=(\n \"webargs\",\n \"http\",\n \"flask\",\n \"django\",\n \"bottle\",\n \"tornado\",\n \"aiohttp\",\n \"webapp2\",\n \"request\",\n \"arguments\",\n \"validation\",\n \"parameters\",\n \"rest\",\n \"api\",\n \"marshmallow\",\n ),\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Intended Audience :: Developers\",\n \"License :: OSI Approved :: MIT License\",\n \"Natural Language :: English\",\n \"Programming Language :: Python :: 2\",\n \"Programming Language :: Python :: 2.7\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Topic :: Internet :: WWW/HTTP :: Dynamic Content\",\n \"Topic :: Internet :: WWW/HTTP :: WSGI :: Application\",\n ],\n test_suite=\"tests\",\n project_urls={\n \"Changelog\": \"https://webargs.readthedocs.io/en/latest/changelog.html\",\n \"Issues\": \"https://github.com/marshmallow-code/webargs/issues\",\n \"Funding\": \"https://opencollective.com/marshmallow\",\n \"Tidelift\": \"https://tidelift.com/subscription/pkg/pypi-webargs?utm_source=pypi-marshmallow&utm_medium=pypi\", # noqa\n },\n)\n", "path": "setup.py"}]} |
gh_patches_debug_230 | rasdani/github-patches | git_diff | AnalogJ__lexicon-164 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Namecheap support not optional
Unlike route53 or softlayer and unlike what setup.py suggests, the namecheap provider is not optional in 2.1.17.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `lexicon/providers/namecheap.py`
Content:
```
1 from __future__ import absolute_import
2 from __future__ import print_function
3
4 import logging
5
6 import namecheap
7
8 from .base import Provider as BaseProvider
9
10 logger = logging.getLogger(__name__)
11
12
13 def ProviderParser(subparser):
14 subparser.add_argument(
15 '--auth-token',
16 help='specify api token used to authenticate'
17 )
18 subparser.add_argument(
19 '--auth-username',
20 help='specify email address used to authenticate'
21 )
22 # FIXME What is the client IP used for?
23 subparser.add_argument(
24 '--auth-client-ip',
25 help='Client IP address to send to Namecheap API calls',
26 default='127.0.0.1'
27 )
28 subparser.add_argument(
29 '--auth-sandbox',
30 help='Whether to use the sandbox server',
31 action='store_true'
32 )
33
34 class Provider(BaseProvider):
35
36 def __init__(self, options, engine_overrides=None):
37 super(Provider, self).__init__(options, engine_overrides)
38 self.options = options
39 self.client = namecheap.Api(
40 ApiUser=options.get('auth_username',''),
41 ApiKey=options.get('auth_token',''),
42 UserName=options.get('auth_username',''),
43 ClientIP=options.get('auth_client_ip',''),
44 sandbox=options.get('auth_sandbox', False),
45 debug=False
46 )
47 self.domain = self.options['domain']
48 self.domain_id = None
49
50 def authenticate(self):
51 try:
52 domain_names = [x['Name'] for x in self.client.domains_getList()]
53 except namecheap.ApiError:
54 raise Exception('Authentication failed')
55 if self.domain not in domain_names:
56 raise Exception('The domain {} is not controlled by this Namecheap '
57 'account'.format(self.domain))
58 # FIXME What is this for?
59 self.domain_id = self.domain
60
61 # Create record. If record already exists with the same content, do nothing
62 def create_record(self, type, name, content):
63 record = {
64 # required
65 'Type': type,
66 'Name': self._relative_name(name),
67 'Address': content
68 }
69 # logger.debug('create_record: %s', 'id' in payload)
70 # return 'id' in payload
71 self.client.domains_dns_addHost(self.domain, record)
72 return True
73
74 # List all records. Return an empty list if no records found.
75 # type, name and content are used to filter records.
76 # If possible filter during the query, otherwise filter after response is
77 # received.
78 def list_records(self, type=None, name=None, content=None, id=None):
79
80
81 records = []
82 raw_records = self.client.domains_dns_getHosts(self.domain)
83 for record in raw_records:
84 records.append(self._convert_to_lexicon(record))
85
86 if id:
87 records = [record for record in records if record['id'] == id]
88 if type:
89 records = [record for record in records if record['type'] == type]
90 if name:
91 if name.endswith('.'):
92 name = name[:-1]
93 records = [record for record in records if name in record['name'] ]
94 if content:
95 records = [record for record in records if record['content'].lower() == content.lower()]
96
97 logger.debug('list_records: %s', records)
98 return records
99
100 # Create or update a record.
101 def update_record(self, identifier, type=None, name=None, content=None):
102 # Delete record if it exists
103 self.delete_record(identifier, type, name, content)
104 return self.create_record(type, name, content)
105
106 # Delete an existing record.
107 # If record does not exist, do nothing.
108 def delete_record(self, identifier=None, type=None, name=None, content=None):
109
110 record = self.list_records(type=type, name=name, content=content, id=identifier)
111 if record:
112 self.client.domains_dns_delHost(self.domain, self._convert_to_namecheap(record[0]))
113 return True
114 else:
115 return False
116
117 def _convert_to_namecheap(self, record):
118 """ converts from lexicon format record to namecheap format record,
119 suitable to sending through the api to namecheap"""
120
121 name = record['name']
122 if name.endswith('.'):
123 name = name[:-1]
124
125 short_name = name[:name.find(self.domain)-1]
126 processed_record = {
127 'Type': record['type'],
128 'Name': short_name,
129 'TTL': record['ttl'],
130 'Address': record['content'],
131 'HostId': record['id']
132 }
133
134 return processed_record
135
136 def _convert_to_lexicon(self, record):
137 """ converts from namecheap raw record format to lexicon format record
138 """
139
140 name = record['Name']
141 if self.domain not in name:
142 name = "{}.{}".format(name,self.domain)
143
144 processed_record = {
145 'type': record['Type'],
146 'name': '{0}.{1}'.format(record['Name'], self.domain),
147 'ttl': record['TTL'],
148 'content': record['Address'],
149 'id': record['HostId']
150 }
151
152 return processed_record
153
```
--- 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/lexicon/providers/namecheap.py b/lexicon/providers/namecheap.py
--- a/lexicon/providers/namecheap.py
+++ b/lexicon/providers/namecheap.py
@@ -3,10 +3,14 @@
import logging
-import namecheap
from .base import Provider as BaseProvider
+try:
+ import namecheap #optional dep
+except ImportError:
+ pass
+
logger = logging.getLogger(__name__)
| {"golden_diff": "diff --git a/lexicon/providers/namecheap.py b/lexicon/providers/namecheap.py\n--- a/lexicon/providers/namecheap.py\n+++ b/lexicon/providers/namecheap.py\n@@ -3,10 +3,14 @@\n \n import logging\n \n-import namecheap\n \n from .base import Provider as BaseProvider\n \n+try:\n+ import namecheap #optional dep\n+except ImportError:\n+ pass\n+\n logger = logging.getLogger(__name__)\n", "issue": "Namecheap support not optional\nUnlike route53 or softlayer and unlike what setup.py suggests, the namecheap provider is not optional in 2.1.17.\n", "before_files": [{"content": "from __future__ import absolute_import\nfrom __future__ import print_function\n\nimport logging\n\nimport namecheap\n\nfrom .base import Provider as BaseProvider\n\nlogger = logging.getLogger(__name__)\n\n\ndef ProviderParser(subparser):\n subparser.add_argument(\n '--auth-token',\n help='specify api token used to authenticate'\n )\n subparser.add_argument(\n '--auth-username',\n help='specify email address used to authenticate'\n )\n # FIXME What is the client IP used for?\n subparser.add_argument(\n '--auth-client-ip',\n help='Client IP address to send to Namecheap API calls',\n default='127.0.0.1'\n )\n subparser.add_argument(\n '--auth-sandbox',\n help='Whether to use the sandbox server',\n action='store_true'\n )\n\nclass Provider(BaseProvider):\n\n def __init__(self, options, engine_overrides=None):\n super(Provider, self).__init__(options, engine_overrides)\n self.options = options\n self.client = namecheap.Api(\n ApiUser=options.get('auth_username',''),\n ApiKey=options.get('auth_token',''),\n UserName=options.get('auth_username',''),\n ClientIP=options.get('auth_client_ip',''),\n sandbox=options.get('auth_sandbox', False),\n debug=False\n )\n self.domain = self.options['domain']\n self.domain_id = None\n\n def authenticate(self):\n try:\n domain_names = [x['Name'] for x in self.client.domains_getList()]\n except namecheap.ApiError:\n raise Exception('Authentication failed')\n if self.domain not in domain_names:\n raise Exception('The domain {} is not controlled by this Namecheap '\n 'account'.format(self.domain))\n # FIXME What is this for?\n self.domain_id = self.domain\n\n # Create record. If record already exists with the same content, do nothing\n def create_record(self, type, name, content):\n record = {\n # required\n 'Type': type,\n 'Name': self._relative_name(name),\n 'Address': content\n }\n # logger.debug('create_record: %s', 'id' in payload)\n # return 'id' in payload\n self.client.domains_dns_addHost(self.domain, record)\n return True\n\n # List all records. Return an empty list if no records found.\n # type, name and content are used to filter records.\n # If possible filter during the query, otherwise filter after response is\n # received.\n def list_records(self, type=None, name=None, content=None, id=None):\n\n\n records = []\n raw_records = self.client.domains_dns_getHosts(self.domain)\n for record in raw_records:\n records.append(self._convert_to_lexicon(record))\n\n if id:\n records = [record for record in records if record['id'] == id]\n if type:\n records = [record for record in records if record['type'] == type]\n if name:\n if name.endswith('.'):\n name = name[:-1]\n records = [record for record in records if name in record['name'] ]\n if content:\n records = [record for record in records if record['content'].lower() == content.lower()]\n\n logger.debug('list_records: %s', records)\n return records\n\n # Create or update a record.\n def update_record(self, identifier, type=None, name=None, content=None):\n # Delete record if it exists\n self.delete_record(identifier, type, name, content)\n return self.create_record(type, name, content)\n\n # Delete an existing record.\n # If record does not exist, do nothing.\n def delete_record(self, identifier=None, type=None, name=None, content=None):\n\n record = self.list_records(type=type, name=name, content=content, id=identifier)\n if record:\n self.client.domains_dns_delHost(self.domain, self._convert_to_namecheap(record[0]))\n return True\n else:\n return False\n\n def _convert_to_namecheap(self, record):\n \"\"\" converts from lexicon format record to namecheap format record,\n suitable to sending through the api to namecheap\"\"\"\n\n name = record['name']\n if name.endswith('.'):\n name = name[:-1]\n\n short_name = name[:name.find(self.domain)-1]\n processed_record = {\n 'Type': record['type'],\n 'Name': short_name,\n 'TTL': record['ttl'],\n 'Address': record['content'],\n 'HostId': record['id']\n }\n\n return processed_record\n\n def _convert_to_lexicon(self, record):\n \"\"\" converts from namecheap raw record format to lexicon format record\n \"\"\"\n\n name = record['Name']\n if self.domain not in name:\n name = \"{}.{}\".format(name,self.domain)\n\n processed_record = {\n 'type': record['Type'],\n 'name': '{0}.{1}'.format(record['Name'], self.domain),\n 'ttl': record['TTL'],\n 'content': record['Address'],\n 'id': record['HostId']\n }\n\n return processed_record\n", "path": "lexicon/providers/namecheap.py"}], "after_files": [{"content": "from __future__ import absolute_import\nfrom __future__ import print_function\n\nimport logging\n\n\nfrom .base import Provider as BaseProvider\n\ntry:\n import namecheap #optional dep\nexcept ImportError:\n pass\n\nlogger = logging.getLogger(__name__)\n\n\ndef ProviderParser(subparser):\n subparser.add_argument(\n '--auth-token',\n help='specify api token used to authenticate'\n )\n subparser.add_argument(\n '--auth-username',\n help='specify email address used to authenticate'\n )\n # FIXME What is the client IP used for?\n subparser.add_argument(\n '--auth-client-ip',\n help='Client IP address to send to Namecheap API calls',\n default='127.0.0.1'\n )\n subparser.add_argument(\n '--auth-sandbox',\n help='Whether to use the sandbox server',\n action='store_true'\n )\n\nclass Provider(BaseProvider):\n\n def __init__(self, options, engine_overrides=None):\n super(Provider, self).__init__(options, engine_overrides)\n self.options = options\n self.client = namecheap.Api(\n ApiUser=options.get('auth_username',''),\n ApiKey=options.get('auth_token',''),\n UserName=options.get('auth_username',''),\n ClientIP=options.get('auth_client_ip',''),\n sandbox=options.get('auth_sandbox', False),\n debug=False\n )\n self.domain = self.options['domain']\n self.domain_id = None\n\n def authenticate(self):\n try:\n domain_names = [x['Name'] for x in self.client.domains_getList()]\n except namecheap.ApiError:\n raise Exception('Authentication failed')\n if self.domain not in domain_names:\n raise Exception('The domain {} is not controlled by this Namecheap '\n 'account'.format(self.domain))\n # FIXME What is this for?\n self.domain_id = self.domain\n\n # Create record. If record already exists with the same content, do nothing\n def create_record(self, type, name, content):\n record = {\n # required\n 'Type': type,\n 'Name': self._relative_name(name),\n 'Address': content\n }\n # logger.debug('create_record: %s', 'id' in payload)\n # return 'id' in payload\n self.client.domains_dns_addHost(self.domain, record)\n return True\n\n # List all records. Return an empty list if no records found.\n # type, name and content are used to filter records.\n # If possible filter during the query, otherwise filter after response is\n # received.\n def list_records(self, type=None, name=None, content=None, id=None):\n\n\n records = []\n raw_records = self.client.domains_dns_getHosts(self.domain)\n for record in raw_records:\n records.append(self._convert_to_lexicon(record))\n\n if id:\n records = [record for record in records if record['id'] == id]\n if type:\n records = [record for record in records if record['type'] == type]\n if name:\n if name.endswith('.'):\n name = name[:-1]\n records = [record for record in records if name in record['name'] ]\n if content:\n records = [record for record in records if record['content'].lower() == content.lower()]\n\n logger.debug('list_records: %s', records)\n return records\n\n # Create or update a record.\n def update_record(self, identifier, type=None, name=None, content=None):\n # Delete record if it exists\n self.delete_record(identifier, type, name, content)\n return self.create_record(type, name, content)\n\n # Delete an existing record.\n # If record does not exist, do nothing.\n def delete_record(self, identifier=None, type=None, name=None, content=None):\n\n record = self.list_records(type=type, name=name, content=content, id=identifier)\n if record:\n self.client.domains_dns_delHost(self.domain, self._convert_to_namecheap(record[0]))\n return True\n else:\n return False\n\n def _convert_to_namecheap(self, record):\n \"\"\" converts from lexicon format record to namecheap format record,\n suitable to sending through the api to namecheap\"\"\"\n\n name = record['name']\n if name.endswith('.'):\n name = name[:-1]\n\n short_name = name[:name.find(self.domain)-1]\n processed_record = {\n 'Type': record['type'],\n 'Name': short_name,\n 'TTL': record['ttl'],\n 'Address': record['content'],\n 'HostId': record['id']\n }\n\n return processed_record\n\n def _convert_to_lexicon(self, record):\n \"\"\" converts from namecheap raw record format to lexicon format record\n \"\"\"\n\n name = record['Name']\n if self.domain not in name:\n name = \"{}.{}\".format(name,self.domain)\n\n processed_record = {\n 'type': record['Type'],\n 'name': '{0}.{1}'.format(record['Name'], self.domain),\n 'ttl': record['TTL'],\n 'content': record['Address'],\n 'id': record['HostId']\n }\n\n return processed_record\n", "path": "lexicon/providers/namecheap.py"}]} |
gh_patches_debug_231 | rasdani/github-patches | git_diff | ivy-llc__ivy-19479 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
__lshift__
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `ivy/functional/frontends/numpy/ndarray/ndarray.py`
Content:
```
1 # global
2
3 # local
4 import ivy
5 import ivy.functional.frontends.numpy as np_frontend
6 from ivy.functional.frontends.numpy.func_wrapper import _to_ivy_array
7
8
9 class ndarray:
10 def __init__(self, shape, dtype="float32", order=None, _init_overload=False):
11 if isinstance(dtype, np_frontend.dtype):
12 dtype = dtype.ivy_dtype
13
14 # in thise case shape is actually the desired array
15 if _init_overload:
16 self._ivy_array = (
17 ivy.array(shape) if not isinstance(shape, ivy.Array) else shape
18 )
19 else:
20 self._ivy_array = ivy.empty(shape=shape, dtype=dtype)
21
22 ivy.utils.assertions.check_elem_in_list(
23 order,
24 ["C", "F", None],
25 message="order must be one of 'C', 'F'",
26 )
27 if order == "F":
28 self._f_contiguous = True
29 else:
30 self._f_contiguous = False
31
32 def __repr__(self):
33 return str(self.ivy_array.__repr__()).replace(
34 "ivy.array", "ivy.frontends.numpy.ndarray"
35 )
36
37 # Properties #
38 # ---------- #
39
40 @property
41 def ivy_array(self):
42 return self._ivy_array
43
44 @property
45 def T(self):
46 return np_frontend.transpose(self)
47
48 @property
49 def shape(self):
50 return self.ivy_array.shape
51
52 @property
53 def size(self):
54 return self.ivy_array.size
55
56 @property
57 def dtype(self):
58 return self.ivy_array.dtype
59
60 @property
61 def ndim(self):
62 return len(self.shape)
63
64 @property
65 def flat(self):
66 self = self.flatten()
67 return self
68
69 # Setters #
70 # --------#
71
72 @ivy_array.setter
73 def ivy_array(self, array):
74 self._ivy_array = (
75 ivy.array(array) if not isinstance(array, ivy.Array) else array
76 )
77
78 # Instance Methods #
79 # ---------------- #
80
81 def astype(self, dtype, order="K", casting="unsafe", subok=True, copy=True):
82 ivy.utils.assertions.check_elem_in_list(
83 order,
84 ["C", "F", "A", "K"],
85 message="order must be one of 'C', 'F', or 'A'",
86 )
87 if copy and self._f_contiguous:
88 ret = np_frontend.array(self.ivy_array, order="F")
89 else:
90 ret = np_frontend.array(self.ivy_array) if copy else self
91
92 dtype = np_frontend.to_ivy_dtype(dtype)
93 if np_frontend.can_cast(ret, dtype, casting=casting):
94 ret.ivy_array = ret.ivy_array.astype(dtype)
95 else:
96 raise ivy.utils.exceptions.IvyException(
97 f"Cannot cast array data from dtype('{ret.ivy_array.dtype}')"
98 f" to dtype('{dtype}') according to the rule '{casting}'"
99 )
100 if order == "F":
101 ret._f_contiguous = True
102 elif order == "C":
103 ret._f_contiguous = False
104 return ret
105
106 def argmax(
107 self,
108 /,
109 *,
110 axis=None,
111 out=None,
112 keepdims=False,
113 ):
114 return np_frontend.argmax(
115 self,
116 axis=axis,
117 out=out,
118 keepdims=keepdims,
119 )
120
121 def reshape(self, newshape, /, *, order="C"):
122 ivy.utils.assertions.check_elem_in_list(
123 order,
124 ["C", "F", "A"],
125 message="order must be one of 'C', 'F', or 'A'",
126 )
127 if (order == "A" and self._f_contiguous) or order == "F":
128 return np_frontend.reshape(self, newshape, order="F")
129 else:
130 return np_frontend.reshape(self, newshape, order="C")
131
132 def resize(self, newshape, /, *, refcheck=True):
133 return np_frontend.resize(self, newshape, refcheck)
134
135 def transpose(self, axes, /):
136 if axes and isinstance(axes[0], tuple):
137 axes = axes[0]
138 return np_frontend.transpose(self, axes=axes)
139
140 def swapaxes(self, axis1, axis2, /):
141 return np_frontend.swapaxes(self, axis1, axis2)
142
143 def all(self, axis=None, out=None, keepdims=False, *, where=True):
144 return np_frontend.all(self, axis, out, keepdims, where=where)
145
146 def any(self, axis=None, out=None, keepdims=False, *, where=True):
147 return np_frontend.any(self, axis, out, keepdims, where=where)
148
149 def argsort(self, *, axis=-1, kind=None, order=None):
150 return np_frontend.argsort(self, axis=axis, kind=kind, order=order)
151
152 def mean(self, *, axis=None, dtype=None, out=None, keepdims=False, where=True):
153 return np_frontend.mean(
154 self,
155 axis=axis,
156 dtype=dtype,
157 out=out,
158 keepdims=keepdims,
159 where=where,
160 )
161
162 def min(self, *, axis=None, out=None, keepdims=False, initial=None, where=True):
163 return np_frontend.amin(
164 self,
165 axis=axis,
166 out=out,
167 keepdims=keepdims,
168 initial=initial,
169 where=where,
170 )
171
172 def max(self, *, axis=None, out=None, keepdims=False, initial=None, where=True):
173 return np_frontend.amax(
174 self,
175 axis=axis,
176 out=out,
177 keepdims=keepdims,
178 initial=initial,
179 where=where,
180 )
181
182 def argmin(
183 self,
184 /,
185 *,
186 axis=None,
187 keepdims=False,
188 out=None,
189 ):
190 return np_frontend.argmin(
191 self,
192 axis=axis,
193 keepdims=keepdims,
194 out=out,
195 )
196
197 def clip(
198 self,
199 min,
200 max,
201 /,
202 out=None,
203 *,
204 where=True,
205 casting="same_kind",
206 order="K",
207 dtype=None,
208 subok=True,
209 ):
210 return np_frontend.clip(
211 self,
212 min,
213 max,
214 out=out,
215 where=where,
216 casting=casting,
217 order=order,
218 dtype=dtype,
219 subok=subok,
220 )
221
222 def compress(self, condition, axis=None, out=None):
223 return np_frontend.compress(
224 condition=condition,
225 a=self,
226 axis=axis,
227 out=out,
228 )
229
230 def conj(
231 self,
232 /,
233 out=None,
234 *,
235 where=True,
236 casting="same_kind",
237 order="K",
238 dtype=None,
239 subok=True,
240 ):
241 return np_frontend.conj(
242 self.ivy_array,
243 out=out,
244 where=where,
245 casting=casting,
246 order=order,
247 dtype=dtype,
248 subok=subok,
249 )
250
251 def cumprod(self, *, axis=None, dtype=None, out=None):
252 return np_frontend.cumprod(
253 self,
254 axis=axis,
255 dtype=dtype,
256 out=out,
257 )
258
259 def cumsum(self, *, axis=None, dtype=None, out=None):
260 return np_frontend.cumsum(
261 self,
262 axis=axis,
263 dtype=dtype,
264 out=out,
265 )
266
267 def dot(self, b, out=None):
268 return np_frontend.dot(self, b, out=out)
269
270 def diagonal(self, *, offset=0, axis1=0, axis2=1):
271 return np_frontend.diagonal(
272 self,
273 offset=offset,
274 axis1=axis1,
275 axis2=axis2,
276 )
277
278 def sort(self, *, axis=-1, kind=None, order=None):
279 return np_frontend.sort(self, axis=axis, kind=kind, order=order)
280
281 def copy(self, order="C"):
282 return np_frontend.copy(self, order=order)
283
284 def nonzero(
285 self,
286 ):
287 return np_frontend.nonzero(self)[0]
288
289 def ravel(self, order="C"):
290 ivy.utils.assertions.check_elem_in_list(
291 order,
292 ["C", "F", "A", "K"],
293 message="order must be one of 'C', 'F', 'A', or 'K'",
294 )
295 if (order in ["K", "A"] and self._f_contiguous) or order == "F":
296 return np_frontend.ravel(self, order="F")
297 else:
298 return np_frontend.ravel(self, order="C")
299
300 def flatten(self, order="C"):
301 ivy.utils.assertions.check_elem_in_list(
302 order,
303 ["C", "F", "A", "K"],
304 message="order must be one of 'C', 'F', 'A', or 'K'",
305 )
306 if (order in ["K", "A"] and self._f_contiguous) or order == "F":
307 return np_frontend.ravel(self, order="F")
308 else:
309 return np_frontend.ravel(self, order="C")
310
311 def fill(self, num):
312 return np_frontend.fill(self, num)
313
314 def repeat(self, repeats, axis=None):
315 return np_frontend.repeat(self, repeats, axis=axis)
316
317 def searchsorted(self, v, side="left", sorter=None):
318 return np_frontend.searchsorted(self, v, side=side, sorter=sorter)
319
320 def squeeze(self, axis=None):
321 return np_frontend.squeeze(self, axis=axis)
322
323 def std(
324 self, axis=None, dtype=None, out=None, ddof=0, keepdims=False, *, where=True
325 ):
326 return np_frontend.std(
327 self,
328 axis=axis,
329 dtype=dtype,
330 out=out,
331 ddof=ddof,
332 keepdims=keepdims,
333 where=where,
334 )
335
336 def tobytes(self, order="C") -> bytes:
337 return np_frontend.tobytes(self, order=order)
338
339 def tostring(self, order="C") -> bytes:
340 return np_frontend.tobytes(self.data, order=order)
341
342 def prod(
343 self,
344 *,
345 axis=None,
346 dtype=None,
347 out=None,
348 keepdims=False,
349 initial=None,
350 where=True,
351 ):
352 return np_frontend.prod(
353 self,
354 axis=axis,
355 dtype=dtype,
356 keepdims=keepdims,
357 initial=initial,
358 where=where,
359 out=out,
360 )
361
362 def tofile(self, fid, /, sep="", format_="%s"):
363 if self.ndim == 0:
364 string = str(self)
365 else:
366 string = sep.join([str(item) for item in self.tolist()])
367 with open(fid, "w") as f:
368 f.write(string)
369
370 def tolist(self) -> list:
371 return self._ivy_array.to_list()
372
373 def view(self):
374 return np_frontend.reshape(self, tuple(self.shape))
375
376 def __add__(self, value, /):
377 return np_frontend.add(self, value)
378
379 def __radd__(self, value, /):
380 return np_frontend.add(self, value)
381
382 def __sub__(self, value, /):
383 return np_frontend.subtract(self, value)
384
385 def __mul__(self, value, /):
386 return np_frontend.multiply(self, value)
387
388 def __rmul__(self, value, /):
389 return np_frontend.multiply(value, self)
390
391 def __truediv__(self, value, /):
392 return np_frontend.true_divide(self, value)
393
394 def __floordiv__(self, value, /):
395 return np_frontend.floor_divide(self, value)
396
397 def __rtruediv__(self, value, /):
398 return np_frontend.true_divide(value, self)
399
400 def __pow__(self, value, /):
401 return np_frontend.power(self, value)
402
403 def __and__(self, value, /):
404 return np_frontend.logical_and(self, value)
405
406 def __or__(self, value, /):
407 return np_frontend.logical_or(self, value)
408
409 def __xor__(self, value, /):
410 return np_frontend.logical_xor(self, value)
411
412 def __matmul__(self, value, /):
413 return np_frontend.matmul(self, value)
414
415 def __copy__(
416 self,
417 ):
418 return np_frontend.copy(self)
419
420 def __deepcopy__(self, memo, /):
421 return self.ivy_array.__deepcopy__(memo)
422
423 def __neg__(
424 self,
425 ):
426 return np_frontend.negative(self)
427
428 def __pos__(
429 self,
430 ):
431 return np_frontend.positive(self)
432
433 def __bool__(
434 self,
435 ):
436 if isinstance(self.ivy_array, int):
437 return self.ivy_array != 0
438
439 temp = ivy.squeeze(ivy.asarray(self.ivy_array), axis=None)
440 shape = ivy.shape(temp)
441 if shape:
442 raise ValueError(
443 "The truth value of an array with more than one element is ambiguous. "
444 "Use a.any() or a.all()"
445 )
446
447 return temp != 0
448
449 def __ne__(self, value, /):
450 return np_frontend.not_equal(self, value)
451
452 def __len__(self):
453 return len(self.ivy_array)
454
455 def __eq__(self, value, /):
456 return np_frontend.equal(self, value)
457
458 def __ge__(self, value, /):
459 return np_frontend.greater_equal(self, value)
460
461 def __gt__(self, value, /):
462 return np_frontend.greater(self, value)
463
464 def __le__(self, value, /):
465 return np_frontend.less_equal(self, value)
466
467 def __lt__(self, value, /):
468 return np_frontend.less(self, value)
469
470 def __int__(
471 self,
472 ):
473 return ivy.to_scalar(ivy.reshape(self.ivy_array, (-1,)).astype(ivy.int64))
474
475 def __float__(
476 self,
477 ):
478 return ivy.to_scalar(ivy.reshape(self.ivy_array, (-1,)).astype(ivy.float64))
479
480 def __complex__(
481 self,
482 ):
483 return ivy.to_scalar(ivy.reshape(self.ivy_array, (-1,)).astype(ivy.complex128))
484
485 def __contains__(self, key, /):
486 return key in ivy.reshape(self.ivy_array, -1)
487
488 def __iadd__(self, value, /):
489 return np_frontend.add(self, value, out=self)
490
491 def __isub__(self, value, /):
492 return np_frontend.subtract(self, value, out=self)
493
494 def __imul__(self, value, /):
495 return np_frontend.multiply(self, value, out=self)
496
497 def __itruediv__(self, value, /):
498 return np_frontend.true_divide(self, value, out=self)
499
500 def __ifloordiv__(self, value, /):
501 return np_frontend.floor_divide(self, value, out=self)
502
503 def __ipow__(self, value, /):
504 return np_frontend.power(self, value, out=self)
505
506 def __iand__(self, value, /):
507 return np_frontend.logical_and(self, value, out=self)
508
509 def __ior__(self, value, /):
510 return np_frontend.logical_or(self, value, out=self)
511
512 def __ixor__(self, value, /):
513 return np_frontend.logical_xor(self, value, out=self)
514
515 def __imod__(self, value, /):
516 return np_frontend.mod(self, value, out=self)
517
518 def __invert__(self, /):
519 return ivy.bitwise_invert(self.ivy_array)
520
521 def __abs__(self):
522 return np_frontend.absolute(self)
523
524 def __array__(self, dtype=None, /):
525 if not dtype:
526 return self
527 return np_frontend.array(self, dtype=dtype)
528
529 def __array_wrap__(self, array, context=None, /):
530 if context is None:
531 return np_frontend.array(array)
532 else:
533 return np_frontend.asarray(self)
534
535 def __getitem__(self, key, /):
536 ivy_args = ivy.nested_map([self, key], _to_ivy_array)
537 ret = ivy.get_item(*ivy_args)
538 return np_frontend.ndarray(ret, _init_overload=True)
539
540 def __setitem__(self, key, value, /):
541 key, value = ivy.nested_map([key, value], _to_ivy_array)
542 self.ivy_array[key] = value
543
544 def __iter__(self):
545 if self.ndim == 0:
546 raise TypeError("iteration over a 0-d ndarray not supported")
547 for i in range(self.shape[0]):
548 yield self[i]
549
550 def __mod__(self, value, /):
551 return np_frontend.mod(self, value, out=self)
552
553 def ptp(self, *, axis=None, out=None, keepdims=False):
554 xmax = self.max(axis=axis, out=out, keepdims=keepdims)
555 xmin = self.min(axis=axis, out=out, keepdims=keepdims)
556 return np_frontend.subtract(xmax, xmin)
557
558 def __rshift__(self, value, /):
559 return ivy.bitwise_right_shift(self.ivy_array, value)
560
```
--- 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/ivy/functional/frontends/numpy/ndarray/ndarray.py b/ivy/functional/frontends/numpy/ndarray/ndarray.py
--- a/ivy/functional/frontends/numpy/ndarray/ndarray.py
+++ b/ivy/functional/frontends/numpy/ndarray/ndarray.py
@@ -557,3 +557,6 @@
def __rshift__(self, value, /):
return ivy.bitwise_right_shift(self.ivy_array, value)
+
+ def __lshift__(self, value, /):
+ return ivy.bitwise_left_shift(self.ivy_array, value)
| {"golden_diff": "diff --git a/ivy/functional/frontends/numpy/ndarray/ndarray.py b/ivy/functional/frontends/numpy/ndarray/ndarray.py\n--- a/ivy/functional/frontends/numpy/ndarray/ndarray.py\n+++ b/ivy/functional/frontends/numpy/ndarray/ndarray.py\n@@ -557,3 +557,6 @@\n \n def __rshift__(self, value, /):\n return ivy.bitwise_right_shift(self.ivy_array, value)\n+\n+ def __lshift__(self, value, /):\n+ return ivy.bitwise_left_shift(self.ivy_array, value)\n", "issue": "__lshift__\n\n", "before_files": [{"content": "# global\n\n# local\nimport ivy\nimport ivy.functional.frontends.numpy as np_frontend\nfrom ivy.functional.frontends.numpy.func_wrapper import _to_ivy_array\n\n\nclass ndarray:\n def __init__(self, shape, dtype=\"float32\", order=None, _init_overload=False):\n if isinstance(dtype, np_frontend.dtype):\n dtype = dtype.ivy_dtype\n\n # in thise case shape is actually the desired array\n if _init_overload:\n self._ivy_array = (\n ivy.array(shape) if not isinstance(shape, ivy.Array) else shape\n )\n else:\n self._ivy_array = ivy.empty(shape=shape, dtype=dtype)\n\n ivy.utils.assertions.check_elem_in_list(\n order,\n [\"C\", \"F\", None],\n message=\"order must be one of 'C', 'F'\",\n )\n if order == \"F\":\n self._f_contiguous = True\n else:\n self._f_contiguous = False\n\n def __repr__(self):\n return str(self.ivy_array.__repr__()).replace(\n \"ivy.array\", \"ivy.frontends.numpy.ndarray\"\n )\n\n # Properties #\n # ---------- #\n\n @property\n def ivy_array(self):\n return self._ivy_array\n\n @property\n def T(self):\n return np_frontend.transpose(self)\n\n @property\n def shape(self):\n return self.ivy_array.shape\n\n @property\n def size(self):\n return self.ivy_array.size\n\n @property\n def dtype(self):\n return self.ivy_array.dtype\n\n @property\n def ndim(self):\n return len(self.shape)\n\n @property\n def flat(self):\n self = self.flatten()\n return self\n\n # Setters #\n # --------#\n\n @ivy_array.setter\n def ivy_array(self, array):\n self._ivy_array = (\n ivy.array(array) if not isinstance(array, ivy.Array) else array\n )\n\n # Instance Methods #\n # ---------------- #\n\n def astype(self, dtype, order=\"K\", casting=\"unsafe\", subok=True, copy=True):\n ivy.utils.assertions.check_elem_in_list(\n order,\n [\"C\", \"F\", \"A\", \"K\"],\n message=\"order must be one of 'C', 'F', or 'A'\",\n )\n if copy and self._f_contiguous:\n ret = np_frontend.array(self.ivy_array, order=\"F\")\n else:\n ret = np_frontend.array(self.ivy_array) if copy else self\n\n dtype = np_frontend.to_ivy_dtype(dtype)\n if np_frontend.can_cast(ret, dtype, casting=casting):\n ret.ivy_array = ret.ivy_array.astype(dtype)\n else:\n raise ivy.utils.exceptions.IvyException(\n f\"Cannot cast array data from dtype('{ret.ivy_array.dtype}')\"\n f\" to dtype('{dtype}') according to the rule '{casting}'\"\n )\n if order == \"F\":\n ret._f_contiguous = True\n elif order == \"C\":\n ret._f_contiguous = False\n return ret\n\n def argmax(\n self,\n /,\n *,\n axis=None,\n out=None,\n keepdims=False,\n ):\n return np_frontend.argmax(\n self,\n axis=axis,\n out=out,\n keepdims=keepdims,\n )\n\n def reshape(self, newshape, /, *, order=\"C\"):\n ivy.utils.assertions.check_elem_in_list(\n order,\n [\"C\", \"F\", \"A\"],\n message=\"order must be one of 'C', 'F', or 'A'\",\n )\n if (order == \"A\" and self._f_contiguous) or order == \"F\":\n return np_frontend.reshape(self, newshape, order=\"F\")\n else:\n return np_frontend.reshape(self, newshape, order=\"C\")\n\n def resize(self, newshape, /, *, refcheck=True):\n return np_frontend.resize(self, newshape, refcheck)\n\n def transpose(self, axes, /):\n if axes and isinstance(axes[0], tuple):\n axes = axes[0]\n return np_frontend.transpose(self, axes=axes)\n\n def swapaxes(self, axis1, axis2, /):\n return np_frontend.swapaxes(self, axis1, axis2)\n\n def all(self, axis=None, out=None, keepdims=False, *, where=True):\n return np_frontend.all(self, axis, out, keepdims, where=where)\n\n def any(self, axis=None, out=None, keepdims=False, *, where=True):\n return np_frontend.any(self, axis, out, keepdims, where=where)\n\n def argsort(self, *, axis=-1, kind=None, order=None):\n return np_frontend.argsort(self, axis=axis, kind=kind, order=order)\n\n def mean(self, *, axis=None, dtype=None, out=None, keepdims=False, where=True):\n return np_frontend.mean(\n self,\n axis=axis,\n dtype=dtype,\n out=out,\n keepdims=keepdims,\n where=where,\n )\n\n def min(self, *, axis=None, out=None, keepdims=False, initial=None, where=True):\n return np_frontend.amin(\n self,\n axis=axis,\n out=out,\n keepdims=keepdims,\n initial=initial,\n where=where,\n )\n\n def max(self, *, axis=None, out=None, keepdims=False, initial=None, where=True):\n return np_frontend.amax(\n self,\n axis=axis,\n out=out,\n keepdims=keepdims,\n initial=initial,\n where=where,\n )\n\n def argmin(\n self,\n /,\n *,\n axis=None,\n keepdims=False,\n out=None,\n ):\n return np_frontend.argmin(\n self,\n axis=axis,\n keepdims=keepdims,\n out=out,\n )\n\n def clip(\n self,\n min,\n max,\n /,\n out=None,\n *,\n where=True,\n casting=\"same_kind\",\n order=\"K\",\n dtype=None,\n subok=True,\n ):\n return np_frontend.clip(\n self,\n min,\n max,\n out=out,\n where=where,\n casting=casting,\n order=order,\n dtype=dtype,\n subok=subok,\n )\n\n def compress(self, condition, axis=None, out=None):\n return np_frontend.compress(\n condition=condition,\n a=self,\n axis=axis,\n out=out,\n )\n\n def conj(\n self,\n /,\n out=None,\n *,\n where=True,\n casting=\"same_kind\",\n order=\"K\",\n dtype=None,\n subok=True,\n ):\n return np_frontend.conj(\n self.ivy_array,\n out=out,\n where=where,\n casting=casting,\n order=order,\n dtype=dtype,\n subok=subok,\n )\n\n def cumprod(self, *, axis=None, dtype=None, out=None):\n return np_frontend.cumprod(\n self,\n axis=axis,\n dtype=dtype,\n out=out,\n )\n\n def cumsum(self, *, axis=None, dtype=None, out=None):\n return np_frontend.cumsum(\n self,\n axis=axis,\n dtype=dtype,\n out=out,\n )\n\n def dot(self, b, out=None):\n return np_frontend.dot(self, b, out=out)\n\n def diagonal(self, *, offset=0, axis1=0, axis2=1):\n return np_frontend.diagonal(\n self,\n offset=offset,\n axis1=axis1,\n axis2=axis2,\n )\n\n def sort(self, *, axis=-1, kind=None, order=None):\n return np_frontend.sort(self, axis=axis, kind=kind, order=order)\n\n def copy(self, order=\"C\"):\n return np_frontend.copy(self, order=order)\n\n def nonzero(\n self,\n ):\n return np_frontend.nonzero(self)[0]\n\n def ravel(self, order=\"C\"):\n ivy.utils.assertions.check_elem_in_list(\n order,\n [\"C\", \"F\", \"A\", \"K\"],\n message=\"order must be one of 'C', 'F', 'A', or 'K'\",\n )\n if (order in [\"K\", \"A\"] and self._f_contiguous) or order == \"F\":\n return np_frontend.ravel(self, order=\"F\")\n else:\n return np_frontend.ravel(self, order=\"C\")\n\n def flatten(self, order=\"C\"):\n ivy.utils.assertions.check_elem_in_list(\n order,\n [\"C\", \"F\", \"A\", \"K\"],\n message=\"order must be one of 'C', 'F', 'A', or 'K'\",\n )\n if (order in [\"K\", \"A\"] and self._f_contiguous) or order == \"F\":\n return np_frontend.ravel(self, order=\"F\")\n else:\n return np_frontend.ravel(self, order=\"C\")\n\n def fill(self, num):\n return np_frontend.fill(self, num)\n\n def repeat(self, repeats, axis=None):\n return np_frontend.repeat(self, repeats, axis=axis)\n\n def searchsorted(self, v, side=\"left\", sorter=None):\n return np_frontend.searchsorted(self, v, side=side, sorter=sorter)\n\n def squeeze(self, axis=None):\n return np_frontend.squeeze(self, axis=axis)\n\n def std(\n self, axis=None, dtype=None, out=None, ddof=0, keepdims=False, *, where=True\n ):\n return np_frontend.std(\n self,\n axis=axis,\n dtype=dtype,\n out=out,\n ddof=ddof,\n keepdims=keepdims,\n where=where,\n )\n\n def tobytes(self, order=\"C\") -> bytes:\n return np_frontend.tobytes(self, order=order)\n\n def tostring(self, order=\"C\") -> bytes:\n return np_frontend.tobytes(self.data, order=order)\n\n def prod(\n self,\n *,\n axis=None,\n dtype=None,\n out=None,\n keepdims=False,\n initial=None,\n where=True,\n ):\n return np_frontend.prod(\n self,\n axis=axis,\n dtype=dtype,\n keepdims=keepdims,\n initial=initial,\n where=where,\n out=out,\n )\n\n def tofile(self, fid, /, sep=\"\", format_=\"%s\"):\n if self.ndim == 0:\n string = str(self)\n else:\n string = sep.join([str(item) for item in self.tolist()])\n with open(fid, \"w\") as f:\n f.write(string)\n\n def tolist(self) -> list:\n return self._ivy_array.to_list()\n\n def view(self):\n return np_frontend.reshape(self, tuple(self.shape))\n\n def __add__(self, value, /):\n return np_frontend.add(self, value)\n\n def __radd__(self, value, /):\n return np_frontend.add(self, value)\n\n def __sub__(self, value, /):\n return np_frontend.subtract(self, value)\n\n def __mul__(self, value, /):\n return np_frontend.multiply(self, value)\n\n def __rmul__(self, value, /):\n return np_frontend.multiply(value, self)\n\n def __truediv__(self, value, /):\n return np_frontend.true_divide(self, value)\n\n def __floordiv__(self, value, /):\n return np_frontend.floor_divide(self, value)\n\n def __rtruediv__(self, value, /):\n return np_frontend.true_divide(value, self)\n\n def __pow__(self, value, /):\n return np_frontend.power(self, value)\n\n def __and__(self, value, /):\n return np_frontend.logical_and(self, value)\n\n def __or__(self, value, /):\n return np_frontend.logical_or(self, value)\n\n def __xor__(self, value, /):\n return np_frontend.logical_xor(self, value)\n\n def __matmul__(self, value, /):\n return np_frontend.matmul(self, value)\n\n def __copy__(\n self,\n ):\n return np_frontend.copy(self)\n\n def __deepcopy__(self, memo, /):\n return self.ivy_array.__deepcopy__(memo)\n\n def __neg__(\n self,\n ):\n return np_frontend.negative(self)\n\n def __pos__(\n self,\n ):\n return np_frontend.positive(self)\n\n def __bool__(\n self,\n ):\n if isinstance(self.ivy_array, int):\n return self.ivy_array != 0\n\n temp = ivy.squeeze(ivy.asarray(self.ivy_array), axis=None)\n shape = ivy.shape(temp)\n if shape:\n raise ValueError(\n \"The truth value of an array with more than one element is ambiguous. \"\n \"Use a.any() or a.all()\"\n )\n\n return temp != 0\n\n def __ne__(self, value, /):\n return np_frontend.not_equal(self, value)\n\n def __len__(self):\n return len(self.ivy_array)\n\n def __eq__(self, value, /):\n return np_frontend.equal(self, value)\n\n def __ge__(self, value, /):\n return np_frontend.greater_equal(self, value)\n\n def __gt__(self, value, /):\n return np_frontend.greater(self, value)\n\n def __le__(self, value, /):\n return np_frontend.less_equal(self, value)\n\n def __lt__(self, value, /):\n return np_frontend.less(self, value)\n\n def __int__(\n self,\n ):\n return ivy.to_scalar(ivy.reshape(self.ivy_array, (-1,)).astype(ivy.int64))\n\n def __float__(\n self,\n ):\n return ivy.to_scalar(ivy.reshape(self.ivy_array, (-1,)).astype(ivy.float64))\n\n def __complex__(\n self,\n ):\n return ivy.to_scalar(ivy.reshape(self.ivy_array, (-1,)).astype(ivy.complex128))\n\n def __contains__(self, key, /):\n return key in ivy.reshape(self.ivy_array, -1)\n\n def __iadd__(self, value, /):\n return np_frontend.add(self, value, out=self)\n\n def __isub__(self, value, /):\n return np_frontend.subtract(self, value, out=self)\n\n def __imul__(self, value, /):\n return np_frontend.multiply(self, value, out=self)\n\n def __itruediv__(self, value, /):\n return np_frontend.true_divide(self, value, out=self)\n\n def __ifloordiv__(self, value, /):\n return np_frontend.floor_divide(self, value, out=self)\n\n def __ipow__(self, value, /):\n return np_frontend.power(self, value, out=self)\n\n def __iand__(self, value, /):\n return np_frontend.logical_and(self, value, out=self)\n\n def __ior__(self, value, /):\n return np_frontend.logical_or(self, value, out=self)\n\n def __ixor__(self, value, /):\n return np_frontend.logical_xor(self, value, out=self)\n\n def __imod__(self, value, /):\n return np_frontend.mod(self, value, out=self)\n\n def __invert__(self, /):\n return ivy.bitwise_invert(self.ivy_array)\n\n def __abs__(self):\n return np_frontend.absolute(self)\n\n def __array__(self, dtype=None, /):\n if not dtype:\n return self\n return np_frontend.array(self, dtype=dtype)\n\n def __array_wrap__(self, array, context=None, /):\n if context is None:\n return np_frontend.array(array)\n else:\n return np_frontend.asarray(self)\n\n def __getitem__(self, key, /):\n ivy_args = ivy.nested_map([self, key], _to_ivy_array)\n ret = ivy.get_item(*ivy_args)\n return np_frontend.ndarray(ret, _init_overload=True)\n\n def __setitem__(self, key, value, /):\n key, value = ivy.nested_map([key, value], _to_ivy_array)\n self.ivy_array[key] = value\n\n def __iter__(self):\n if self.ndim == 0:\n raise TypeError(\"iteration over a 0-d ndarray not supported\")\n for i in range(self.shape[0]):\n yield self[i]\n\n def __mod__(self, value, /):\n return np_frontend.mod(self, value, out=self)\n\n def ptp(self, *, axis=None, out=None, keepdims=False):\n xmax = self.max(axis=axis, out=out, keepdims=keepdims)\n xmin = self.min(axis=axis, out=out, keepdims=keepdims)\n return np_frontend.subtract(xmax, xmin)\n\n def __rshift__(self, value, /):\n return ivy.bitwise_right_shift(self.ivy_array, value)\n", "path": "ivy/functional/frontends/numpy/ndarray/ndarray.py"}], "after_files": [{"content": "# global\n\n# local\nimport ivy\nimport ivy.functional.frontends.numpy as np_frontend\nfrom ivy.functional.frontends.numpy.func_wrapper import _to_ivy_array\n\n\nclass ndarray:\n def __init__(self, shape, dtype=\"float32\", order=None, _init_overload=False):\n if isinstance(dtype, np_frontend.dtype):\n dtype = dtype.ivy_dtype\n\n # in thise case shape is actually the desired array\n if _init_overload:\n self._ivy_array = (\n ivy.array(shape) if not isinstance(shape, ivy.Array) else shape\n )\n else:\n self._ivy_array = ivy.empty(shape=shape, dtype=dtype)\n\n ivy.utils.assertions.check_elem_in_list(\n order,\n [\"C\", \"F\", None],\n message=\"order must be one of 'C', 'F'\",\n )\n if order == \"F\":\n self._f_contiguous = True\n else:\n self._f_contiguous = False\n\n def __repr__(self):\n return str(self.ivy_array.__repr__()).replace(\n \"ivy.array\", \"ivy.frontends.numpy.ndarray\"\n )\n\n # Properties #\n # ---------- #\n\n @property\n def ivy_array(self):\n return self._ivy_array\n\n @property\n def T(self):\n return np_frontend.transpose(self)\n\n @property\n def shape(self):\n return self.ivy_array.shape\n\n @property\n def size(self):\n return self.ivy_array.size\n\n @property\n def dtype(self):\n return self.ivy_array.dtype\n\n @property\n def ndim(self):\n return len(self.shape)\n\n @property\n def flat(self):\n self = self.flatten()\n return self\n\n # Setters #\n # --------#\n\n @ivy_array.setter\n def ivy_array(self, array):\n self._ivy_array = (\n ivy.array(array) if not isinstance(array, ivy.Array) else array\n )\n\n # Instance Methods #\n # ---------------- #\n\n def astype(self, dtype, order=\"K\", casting=\"unsafe\", subok=True, copy=True):\n ivy.utils.assertions.check_elem_in_list(\n order,\n [\"C\", \"F\", \"A\", \"K\"],\n message=\"order must be one of 'C', 'F', or 'A'\",\n )\n if copy and self._f_contiguous:\n ret = np_frontend.array(self.ivy_array, order=\"F\")\n else:\n ret = np_frontend.array(self.ivy_array) if copy else self\n\n dtype = np_frontend.to_ivy_dtype(dtype)\n if np_frontend.can_cast(ret, dtype, casting=casting):\n ret.ivy_array = ret.ivy_array.astype(dtype)\n else:\n raise ivy.utils.exceptions.IvyException(\n f\"Cannot cast array data from dtype('{ret.ivy_array.dtype}')\"\n f\" to dtype('{dtype}') according to the rule '{casting}'\"\n )\n if order == \"F\":\n ret._f_contiguous = True\n elif order == \"C\":\n ret._f_contiguous = False\n return ret\n\n def argmax(\n self,\n /,\n *,\n axis=None,\n out=None,\n keepdims=False,\n ):\n return np_frontend.argmax(\n self,\n axis=axis,\n out=out,\n keepdims=keepdims,\n )\n\n def reshape(self, newshape, /, *, order=\"C\"):\n ivy.utils.assertions.check_elem_in_list(\n order,\n [\"C\", \"F\", \"A\"],\n message=\"order must be one of 'C', 'F', or 'A'\",\n )\n if (order == \"A\" and self._f_contiguous) or order == \"F\":\n return np_frontend.reshape(self, newshape, order=\"F\")\n else:\n return np_frontend.reshape(self, newshape, order=\"C\")\n\n def resize(self, newshape, /, *, refcheck=True):\n return np_frontend.resize(self, newshape, refcheck)\n\n def transpose(self, axes, /):\n if axes and isinstance(axes[0], tuple):\n axes = axes[0]\n return np_frontend.transpose(self, axes=axes)\n\n def swapaxes(self, axis1, axis2, /):\n return np_frontend.swapaxes(self, axis1, axis2)\n\n def all(self, axis=None, out=None, keepdims=False, *, where=True):\n return np_frontend.all(self, axis, out, keepdims, where=where)\n\n def any(self, axis=None, out=None, keepdims=False, *, where=True):\n return np_frontend.any(self, axis, out, keepdims, where=where)\n\n def argsort(self, *, axis=-1, kind=None, order=None):\n return np_frontend.argsort(self, axis=axis, kind=kind, order=order)\n\n def mean(self, *, axis=None, dtype=None, out=None, keepdims=False, where=True):\n return np_frontend.mean(\n self,\n axis=axis,\n dtype=dtype,\n out=out,\n keepdims=keepdims,\n where=where,\n )\n\n def min(self, *, axis=None, out=None, keepdims=False, initial=None, where=True):\n return np_frontend.amin(\n self,\n axis=axis,\n out=out,\n keepdims=keepdims,\n initial=initial,\n where=where,\n )\n\n def max(self, *, axis=None, out=None, keepdims=False, initial=None, where=True):\n return np_frontend.amax(\n self,\n axis=axis,\n out=out,\n keepdims=keepdims,\n initial=initial,\n where=where,\n )\n\n def argmin(\n self,\n /,\n *,\n axis=None,\n keepdims=False,\n out=None,\n ):\n return np_frontend.argmin(\n self,\n axis=axis,\n keepdims=keepdims,\n out=out,\n )\n\n def clip(\n self,\n min,\n max,\n /,\n out=None,\n *,\n where=True,\n casting=\"same_kind\",\n order=\"K\",\n dtype=None,\n subok=True,\n ):\n return np_frontend.clip(\n self,\n min,\n max,\n out=out,\n where=where,\n casting=casting,\n order=order,\n dtype=dtype,\n subok=subok,\n )\n\n def compress(self, condition, axis=None, out=None):\n return np_frontend.compress(\n condition=condition,\n a=self,\n axis=axis,\n out=out,\n )\n\n def conj(\n self,\n /,\n out=None,\n *,\n where=True,\n casting=\"same_kind\",\n order=\"K\",\n dtype=None,\n subok=True,\n ):\n return np_frontend.conj(\n self.ivy_array,\n out=out,\n where=where,\n casting=casting,\n order=order,\n dtype=dtype,\n subok=subok,\n )\n\n def cumprod(self, *, axis=None, dtype=None, out=None):\n return np_frontend.cumprod(\n self,\n axis=axis,\n dtype=dtype,\n out=out,\n )\n\n def cumsum(self, *, axis=None, dtype=None, out=None):\n return np_frontend.cumsum(\n self,\n axis=axis,\n dtype=dtype,\n out=out,\n )\n\n def dot(self, b, out=None):\n return np_frontend.dot(self, b, out=out)\n\n def diagonal(self, *, offset=0, axis1=0, axis2=1):\n return np_frontend.diagonal(\n self,\n offset=offset,\n axis1=axis1,\n axis2=axis2,\n )\n\n def sort(self, *, axis=-1, kind=None, order=None):\n return np_frontend.sort(self, axis=axis, kind=kind, order=order)\n\n def copy(self, order=\"C\"):\n return np_frontend.copy(self, order=order)\n\n def nonzero(\n self,\n ):\n return np_frontend.nonzero(self)[0]\n\n def ravel(self, order=\"C\"):\n ivy.utils.assertions.check_elem_in_list(\n order,\n [\"C\", \"F\", \"A\", \"K\"],\n message=\"order must be one of 'C', 'F', 'A', or 'K'\",\n )\n if (order in [\"K\", \"A\"] and self._f_contiguous) or order == \"F\":\n return np_frontend.ravel(self, order=\"F\")\n else:\n return np_frontend.ravel(self, order=\"C\")\n\n def flatten(self, order=\"C\"):\n ivy.utils.assertions.check_elem_in_list(\n order,\n [\"C\", \"F\", \"A\", \"K\"],\n message=\"order must be one of 'C', 'F', 'A', or 'K'\",\n )\n if (order in [\"K\", \"A\"] and self._f_contiguous) or order == \"F\":\n return np_frontend.ravel(self, order=\"F\")\n else:\n return np_frontend.ravel(self, order=\"C\")\n\n def fill(self, num):\n return np_frontend.fill(self, num)\n\n def repeat(self, repeats, axis=None):\n return np_frontend.repeat(self, repeats, axis=axis)\n\n def searchsorted(self, v, side=\"left\", sorter=None):\n return np_frontend.searchsorted(self, v, side=side, sorter=sorter)\n\n def squeeze(self, axis=None):\n return np_frontend.squeeze(self, axis=axis)\n\n def std(\n self, axis=None, dtype=None, out=None, ddof=0, keepdims=False, *, where=True\n ):\n return np_frontend.std(\n self,\n axis=axis,\n dtype=dtype,\n out=out,\n ddof=ddof,\n keepdims=keepdims,\n where=where,\n )\n\n def tobytes(self, order=\"C\") -> bytes:\n return np_frontend.tobytes(self, order=order)\n\n def tostring(self, order=\"C\") -> bytes:\n return np_frontend.tobytes(self.data, order=order)\n\n def prod(\n self,\n *,\n axis=None,\n dtype=None,\n out=None,\n keepdims=False,\n initial=None,\n where=True,\n ):\n return np_frontend.prod(\n self,\n axis=axis,\n dtype=dtype,\n keepdims=keepdims,\n initial=initial,\n where=where,\n out=out,\n )\n\n def tofile(self, fid, /, sep=\"\", format_=\"%s\"):\n if self.ndim == 0:\n string = str(self)\n else:\n string = sep.join([str(item) for item in self.tolist()])\n with open(fid, \"w\") as f:\n f.write(string)\n\n def tolist(self) -> list:\n return self._ivy_array.to_list()\n\n def view(self):\n return np_frontend.reshape(self, tuple(self.shape))\n\n def __add__(self, value, /):\n return np_frontend.add(self, value)\n\n def __radd__(self, value, /):\n return np_frontend.add(self, value)\n\n def __sub__(self, value, /):\n return np_frontend.subtract(self, value)\n\n def __mul__(self, value, /):\n return np_frontend.multiply(self, value)\n\n def __rmul__(self, value, /):\n return np_frontend.multiply(value, self)\n\n def __truediv__(self, value, /):\n return np_frontend.true_divide(self, value)\n\n def __floordiv__(self, value, /):\n return np_frontend.floor_divide(self, value)\n\n def __rtruediv__(self, value, /):\n return np_frontend.true_divide(value, self)\n\n def __pow__(self, value, /):\n return np_frontend.power(self, value)\n\n def __and__(self, value, /):\n return np_frontend.logical_and(self, value)\n\n def __or__(self, value, /):\n return np_frontend.logical_or(self, value)\n\n def __xor__(self, value, /):\n return np_frontend.logical_xor(self, value)\n\n def __matmul__(self, value, /):\n return np_frontend.matmul(self, value)\n\n def __copy__(\n self,\n ):\n return np_frontend.copy(self)\n\n def __deepcopy__(self, memo, /):\n return self.ivy_array.__deepcopy__(memo)\n\n def __neg__(\n self,\n ):\n return np_frontend.negative(self)\n\n def __pos__(\n self,\n ):\n return np_frontend.positive(self)\n\n def __bool__(\n self,\n ):\n if isinstance(self.ivy_array, int):\n return self.ivy_array != 0\n\n temp = ivy.squeeze(ivy.asarray(self.ivy_array), axis=None)\n shape = ivy.shape(temp)\n if shape:\n raise ValueError(\n \"The truth value of an array with more than one element is ambiguous. \"\n \"Use a.any() or a.all()\"\n )\n\n return temp != 0\n\n def __ne__(self, value, /):\n return np_frontend.not_equal(self, value)\n\n def __len__(self):\n return len(self.ivy_array)\n\n def __eq__(self, value, /):\n return np_frontend.equal(self, value)\n\n def __ge__(self, value, /):\n return np_frontend.greater_equal(self, value)\n\n def __gt__(self, value, /):\n return np_frontend.greater(self, value)\n\n def __le__(self, value, /):\n return np_frontend.less_equal(self, value)\n\n def __lt__(self, value, /):\n return np_frontend.less(self, value)\n\n def __int__(\n self,\n ):\n return ivy.to_scalar(ivy.reshape(self.ivy_array, (-1,)).astype(ivy.int64))\n\n def __float__(\n self,\n ):\n return ivy.to_scalar(ivy.reshape(self.ivy_array, (-1,)).astype(ivy.float64))\n\n def __complex__(\n self,\n ):\n return ivy.to_scalar(ivy.reshape(self.ivy_array, (-1,)).astype(ivy.complex128))\n\n def __contains__(self, key, /):\n return key in ivy.reshape(self.ivy_array, -1)\n\n def __iadd__(self, value, /):\n return np_frontend.add(self, value, out=self)\n\n def __isub__(self, value, /):\n return np_frontend.subtract(self, value, out=self)\n\n def __imul__(self, value, /):\n return np_frontend.multiply(self, value, out=self)\n\n def __itruediv__(self, value, /):\n return np_frontend.true_divide(self, value, out=self)\n\n def __ifloordiv__(self, value, /):\n return np_frontend.floor_divide(self, value, out=self)\n\n def __ipow__(self, value, /):\n return np_frontend.power(self, value, out=self)\n\n def __iand__(self, value, /):\n return np_frontend.logical_and(self, value, out=self)\n\n def __ior__(self, value, /):\n return np_frontend.logical_or(self, value, out=self)\n\n def __ixor__(self, value, /):\n return np_frontend.logical_xor(self, value, out=self)\n\n def __imod__(self, value, /):\n return np_frontend.mod(self, value, out=self)\n\n def __invert__(self, /):\n return ivy.bitwise_invert(self.ivy_array)\n\n def __abs__(self):\n return np_frontend.absolute(self)\n\n def __array__(self, dtype=None, /):\n if not dtype:\n return self\n return np_frontend.array(self, dtype=dtype)\n\n def __array_wrap__(self, array, context=None, /):\n if context is None:\n return np_frontend.array(array)\n else:\n return np_frontend.asarray(self)\n\n def __getitem__(self, key, /):\n ivy_args = ivy.nested_map([self, key], _to_ivy_array)\n ret = ivy.get_item(*ivy_args)\n return np_frontend.ndarray(ret, _init_overload=True)\n\n def __setitem__(self, key, value, /):\n key, value = ivy.nested_map([key, value], _to_ivy_array)\n self.ivy_array[key] = value\n\n def __iter__(self):\n if self.ndim == 0:\n raise TypeError(\"iteration over a 0-d ndarray not supported\")\n for i in range(self.shape[0]):\n yield self[i]\n\n def __mod__(self, value, /):\n return np_frontend.mod(self, value, out=self)\n\n def ptp(self, *, axis=None, out=None, keepdims=False):\n xmax = self.max(axis=axis, out=out, keepdims=keepdims)\n xmin = self.min(axis=axis, out=out, keepdims=keepdims)\n return np_frontend.subtract(xmax, xmin)\n\n def __rshift__(self, value, /):\n return ivy.bitwise_right_shift(self.ivy_array, value)\n\n def __lshift__(self, value, /):\n return ivy.bitwise_left_shift(self.ivy_array, value)\n", "path": "ivy/functional/frontends/numpy/ndarray/ndarray.py"}]} |
gh_patches_debug_232 | rasdani/github-patches | git_diff | facebookresearch__CompilerGym-364 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Required license headers missing
## 🐛 Bug
```
https://github.com/facebookresearch/CompilerGym/blob/development/www/demo_api.py:
The first 16 lines of 'www/demo_api.py' do not contain the patterns:
(Facebook, Inc(\.|,)? and its affiliates)|([0-9]{4}-present(\.|,)? Facebook)|([0-9]{4}(\.|,)? Facebook)
Copyright
https://github.com/facebookresearch/CompilerGym/blob/development/www/frontends/compiler_gym/src/App.test.js:
The first 16 lines of 'www/frontends/compiler_gym/src/App.test.js' do not contain the patterns:
(Facebook, Inc(\.|,)? and its affiliates)|([0-9]{4}-present(\.|,)? Facebook)|([0-9]{4}(\.|,)? Facebook)
Copyright
https://github.com/facebookresearch/CompilerGym/blob/development/www/frontends/compiler_gym/src/index.js:
The first 16 lines of 'www/frontends/compiler_gym/src/index.js' do not contain the patterns:
(Facebook, Inc(\.|,)? and its affiliates)|([0-9]{4}-present(\.|,)? Facebook)|([0-9]{4}(\.|,)? Facebook)
Copyright
https://github.com/facebookresearch/CompilerGym/blob/development/www/frontends/compiler_gym/src/reportWebVitals.js:
The first 16 lines of 'www/frontends/compiler_gym/src/reportWebVitals.js' do not contain the patterns:
(Facebook, Inc(\.|,)? and its affiliates)|([0-9]{4}-present(\.|,)? Facebook)|([0-9]{4}(\.|,)? Facebook)
Copyright
https://github.com/facebookresearch/CompilerGym/blob/development/www/frontends/compiler_gym/src/setupTests.js:
The first 16 lines of 'www/frontends/compiler_gym/src/setupTests.js' do not contain the patterns:
(Facebook, Inc(\.|,)? and its affiliates)|([0-9]{4}-present(\.|,)? Facebook)|([0-9]{4}(\.|,)? Facebook)
Copyright
https://github.com/facebookresearch/CompilerGym/blob/development/www/frontends/compiler_gym/src/assets/scss/custom.scss:
The first 16 lines of 'www/frontends/compiler_gym/src/assets/scss/custom.scss' do not contain the patterns:
(Facebook, Inc(\.|,)? and its affiliates)|([0-9]{4}-present(\.|,)? Facebook)|([0-9]{4}(\.|,)? Facebook)
Copyright
```
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `www/www.py`
Content:
```
1 """A CompilerGym API and web frontend.
2
3 This exposes an API with five operations:
4
5 1. describe() -> dict (/api/v3/describe)
6
7 Describe the CompilerGym interface. This generates a list of action
8 names and their numeric values, a list of benchmark datasets and the
9 benchmarks within them, and a list of reward spaces.
10
11 2. start(reward, actions, benchmark) -> session_id, state[]
12 (/api/v3/start/<reward>/<actions>/<benchmark>)
13
14 Start a session. This would happen when the user navigates to the page
15 in their web browser. One tab = one session. Takes a reward space name,
16 a list of actions, and a benchmark URI as inputs. If no actions are to
17 be performed, use "-". Returns a numeric session ID (this probably isn't
18 the right way of doing things but I don't know any better :-) ). Also
19 returns a list of states, which is the set of things we want to
20 visualize to represent the current environment state. There is an
21 initial state, and then one state for each action.
22
23 3. step(session_id, actions) -> state[] (/api/v3/<session_id>/<actions>)
24
25 Run a list of actions and produce a list of states, replacing the old
26 ones.
27
28 4. undo(session_id, n) -> state (/api/v3/<session_id>/undo/<n>)
29
30 Undo `n` previous actions, returning the previous state.
31
32 5. stop(session_id) (/api/v3/stop/<session_id>)
33
34 End a session. This would be when the user closes the tab / disconnects.
35
36 To run this script, install the python dependencies using:
37
38 pip install flask compiler_gym pydantic
39
40 Then launch it by running, in this directory:
41
42 FLASK_APP=demo_api.py flask run
43
44 Interact with the API through GET requests, such as using curl. A "describe"
45 endpoint provides details on teh available actions, benchmarks, and rewards.:
46
47 $ curl -s localhost:5000/api/v3/describe | jq
48 {
49 "actions": {
50 "-adce": 1,
51 ...
52 "-tailcallelim": 122
53 },
54 "benchmarks": {
55 "benchmark://anghabench-v1": [
56 "8cc/extr_buffer.c_buf_append",
57 ...
58 "8cc/extr_buffer.c_quote_cstring_len"
59 ],
60 "benchmark://blas-v0": [
61 ...
62 ],
63 "benchmark://cbench-v1": [
64 "adpcm",
65 ...
66 "jpeg-c"
67 ],
68 ...
69 },
70 "rewards": [
71 "IrInstructionCount",
72 ...
73 "ObjectTextSizeOz"
74 ]
75 }
76
77 To start a session, specify a reward space and a benchmark. Note that this
78 requires URL-encoding the benchmark name as it contains slashes. e.g. to start a
79 new session using reward IrInstructionCountOz and benchmark
80 "benchmark://cbench-v1/qsort":
81
82 $ curl -s localhost:5000/api/v3/start/IrInstructionCountOz/benchmark%3A%2F%2Fcbench-v1%2Fqsort | jq
83 {
84 "session_id": 0,
85 "states": [
86 {
87 "autophase": {
88 "ArgsPhi": 10,
89 ...
90 "twoSuccessor": 31
91 },
92 "commandline": "opt input.bc -o output.bc",
93 "done": false,
94 "instcount": {
95 "AShrCount": 0,
96 "AddCount": 9,
97 ...
98 "ZExtCount": 15
99 },
100 "ir": "; ModuleID = '-'\nsource_filename = \"-\"\ntarget ...",
101 "reward": 0
102 }
103 ]
104 }
105
106 That "state" dict contains the things that we would want to visualize in the
107 GUI. Our session ID is 0, lets take a step in this session using action "10":
108
109 $ curl -s localhost:5000/api/v3/step/0/10 | jq
110 {
111 "states": [
112 {
113 "autophase": {
114 "ArgsPhi": 2,
115 ..,
116 "twoSuccessor": 29
117 },
118 "commandline": "opt -simplifycfg input.bc -o output.bc",
119 "done": false,
120 "instcount": {
121 "AShrCount": 0,
122 ...
123 "ZExtCount": 15
124 },
125 "ir": "; ModuleID = '-'\nsource_filename = \"-\"\ntarget ...",
126 "reward": 0.06501547987616099
127 }
128 ]
129 }
130
131 Notice that the state dict has changed. Some of the numbers in the "autophase"
132 and "instcount" feature dictionary have changed, there is a reward value, and
133 the commandline now includes the flag needed to run action "10" (which turned
134 out to be the "-simplifycfg" flag).
135
136 We could carry on taking steps, or just end the session:
137
138 $ curl -s localhost:5000/api/v3/stop/0
139 """
140 import logging
141 import os
142 import sys
143 from itertools import islice
144 from pathlib import Path
145 from threading import Lock, Thread
146 from time import sleep, time
147 from typing import Dict, List, Tuple
148
149 from flask import Flask, jsonify, send_file
150 from flask_cors import CORS
151 from pydantic import BaseModel
152
153 import compiler_gym
154 from compiler_gym import CompilerEnv
155 from compiler_gym.util.truncate import truncate
156
157 app = Flask("compiler_gym")
158 CORS(app)
159
160
161 resource_dir: Path = (Path(__file__).parent / "frontends/compiler_gym/build").absolute()
162
163 logger = logging.getLogger(__name__)
164
165
166 class StateToVisualize(BaseModel):
167 """Encapsulates everything we want to visualize in the frontend. This
168 will change from step to step.
169 """
170
171 # This summarizes the sequence of actions that the user has selected so far:
172 commandline: str
173
174 # If the compiler environment dies, crashes, or encounters some
175 # unrecoverable error, this "done" flag is set. At this point the user d
176 # should start a new session.
177 done: bool
178
179 # Observations that we would like to visualize. This list will grow over
180 # time to include graphs and 2-D matrices:
181 ir: str
182 instcount: Dict[str, int]
183 autophase: Dict[str, int]
184
185 # The reward signal measures how "good" the previous action was. Over time
186 # the sequence of actions that produces the highest cumulative reward is the
187 # best:
188 reward: float
189
190
191 class Session(BaseModel):
192 states: List[Tuple[CompilerEnv, StateToVisualize]]
193 last_use: float # As returned by time().
194
195 def close(self):
196 for env, _ in self.states:
197 env.close()
198
199 class Config:
200 arbitrary_types_allowed = True
201
202
203 # A set of sessions that are in use, keyed by a numeric session ID. Each session
204 # is represented by a list of (environment, state) tuples, whether the
205 # environment is a CompilerGym environment and the state is a StateToVisualize.
206 # Initially, a session consists of a single (environment, state) tuple. When an
207 # action is taken, this generates a new (environment, state) tuple that is
208 # appended the session list. In this way, undoing an operation is as simple as
209 # popping the most recent (environment, state) tuple from the list.
210 sessions: Dict[int, Session] = {}
211 sessions_lock = Lock()
212
213
214 def compute_state(env: CompilerEnv, actions: List[int]) -> StateToVisualize:
215 """Apply a list of actions and produce a new state to visualize."""
216 # This is where we get the compiler environment to do its thing, and compute
217 # for us all of the features that we would like to visualize.
218 (ir, instcount, autophase), (reward,), done, _ = env.raw_step(
219 actions=actions,
220 observations=[
221 env.observation.spaces["Ir"],
222 env.observation.spaces["InstCountDict"],
223 env.observation.spaces["AutophaseDict"],
224 ],
225 rewards=[env.reward_space],
226 )
227 return StateToVisualize(
228 commandline=env.commandline(),
229 done=done,
230 ir=truncate(ir, max_line_len=250, max_lines=1024),
231 instcount=instcount,
232 autophase=autophase,
233 reward=reward,
234 )
235
236
237 @app.route("/api/v3/describe")
238 def describe():
239 with compiler_gym.make("llvm-v0") as env:
240 env.reset()
241 return jsonify(
242 {
243 # A mapping from dataset name to benchmark name. To generate a full
244 # benchmark URI, join the two values with a '/'. E.g. given a benchmark
245 # "qsort" in the dataset "benchmark://cbench-v1", the full URI is
246 # "benchmark://cbench-v1/qsort".
247 "benchmarks": {
248 dataset.name: list(
249 islice(
250 (
251 x[len(dataset.name) + 1 :]
252 for x in dataset.benchmark_uris()
253 ),
254 10,
255 )
256 )
257 for dataset in env.datasets
258 },
259 # A mapping from the name of an action to the numeric value. This
260 # numeric value is what is passed as argument to the step() function.
261 "actions": {k: v for v, k in enumerate(env.action_space.flags)},
262 # A list of reward space names. You select the reward space to use
263 # during start().
264 "rewards": sorted(list(env.reward.spaces.keys())),
265 }
266 )
267
268
269 @app.route("/api/v3/start/<reward>/<actions>/<path:benchmark>")
270 def start(reward: str, actions: str, benchmark: str):
271 env = compiler_gym.make("llvm-v0", benchmark=benchmark)
272 env.reward_space = reward
273 env.reset()
274 state = compute_state(env, [])
275 with sessions_lock:
276 session_id = len(sessions)
277 session = Session(states=[(env, state)], last_use=time())
278 sessions[session_id] = session
279
280 # Accept an optional comma-separated list of actions to compute and return.
281 if actions != "-":
282 step(session_id, actions)
283
284 return jsonify(
285 {
286 "session_id": session_id,
287 "states": [state.dict() for _, state in session.states],
288 }
289 )
290
291
292 @app.route("/api/v3/stop/<session_id>")
293 def stop(session_id: int):
294 session_id = int(session_id)
295
296 session = sessions[session_id]
297 session.close()
298 with sessions_lock:
299 del sessions[session_id]
300
301 return jsonify({"session_id": session_id})
302
303
304 @app.route("/api/v3/step/<session_id>/<actions>")
305 def step(session_id: int, actions: str):
306 session_id = int(session_id)
307
308 state_dicts = []
309 session = sessions[session_id]
310 for action in [int(a) for a in actions.split(",")]:
311 new_env = session.states[-1][0].fork()
312 new_state = compute_state(new_env, [action])
313 session.states.append((new_env, new_state))
314 state_dicts.append(new_state.dict())
315
316 session.last_use = time()
317 return jsonify({"states": state_dicts})
318
319
320 @app.route("/api/v3/undo/<session_id>/<n>")
321 def undo(session_id: int, n: int):
322 session_id = int(session_id)
323 n = int(n)
324
325 session = sessions[session_id]
326 for _ in range(n):
327 env, _ = session.states.pop()
328 env.close()
329 _, old_state = session[-1]
330
331 session.last_use = time()
332 return jsonify({"state": old_state.dict()})
333
334
335 def idle_session_watchdog(ttl_seconds: int = 1200):
336 """Background thread to perform periodic garbage collection of sessions
337 that haven't been used in `ttl_seconds` seconds.
338 """
339 while True:
340 session_ids_to_remove = []
341 for session_id, session in sessions.items():
342 if session.last_use + ttl_seconds < time():
343 session_ids_to_remove.append(session_id)
344 with sessions_lock:
345 for session_id in session_ids_to_remove:
346 sessions[session_id].close()
347 del sessions[session_id]
348 logger.info("Garbage collected %d sessions", len(session_ids_to_remove))
349 sleep(ttl_seconds)
350
351
352 # Web endpoints.
353
354
355 @app.route("/")
356 def index_resource():
357 return send_file(resource_dir / "index.html")
358
359
360 @app.route("/<path>")
361 def root_resource(path: str):
362 return send_file(resource_dir / path)
363
364
365 @app.route("/static/css/<path>")
366 def css_resource(path: str):
367 return send_file(resource_dir / "static/css/" / path)
368
369
370 @app.route("/static/js/<path>")
371 def js_resource(path: str):
372 return send_file(resource_dir / "static/js/" / path)
373
374
375 if __name__ == "__main__":
376 logger.setLevel(logging.DEBUG)
377 handler = logging.StreamHandler(sys.stderr)
378 handler.setLevel(logging.DEBUG)
379 formatter = logging.Formatter(
380 "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
381 )
382 handler.setFormatter(formatter)
383 logger.addHandler(handler)
384
385 logger.info("Serving from %s", resource_dir)
386 Thread(target=idle_session_watchdog).start()
387 app.run(port=int(os.environ.get("PORT", "5000")))
388
```
--- 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/www/www.py b/www/www.py
--- a/www/www.py
+++ b/www/www.py
@@ -1,3 +1,7 @@
+# Copyright (c) Facebook, Inc. and its affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
"""A CompilerGym API and web frontend.
This exposes an API with five operations:
| {"golden_diff": "diff --git a/www/www.py b/www/www.py\n--- a/www/www.py\n+++ b/www/www.py\n@@ -1,3 +1,7 @@\n+# Copyright (c) Facebook, Inc. and its affiliates.\n+#\n+# This source code is licensed under the MIT license found in the\n+# LICENSE file in the root directory of this source tree.\n \"\"\"A CompilerGym API and web frontend.\n \n This exposes an API with five operations:\n", "issue": "Required license headers missing\n## \ud83d\udc1b Bug\r\n\r\n```\r\nhttps://github.com/facebookresearch/CompilerGym/blob/development/www/demo_api.py:\r\nThe first 16 lines of 'www/demo_api.py' do not contain the patterns:\r\n\t(Facebook, Inc(\\.|,)? and its affiliates)|([0-9]{4}-present(\\.|,)? Facebook)|([0-9]{4}(\\.|,)? Facebook)\r\n\tCopyright\r\n\r\nhttps://github.com/facebookresearch/CompilerGym/blob/development/www/frontends/compiler_gym/src/App.test.js:\r\nThe first 16 lines of 'www/frontends/compiler_gym/src/App.test.js' do not contain the patterns:\r\n\t(Facebook, Inc(\\.|,)? and its affiliates)|([0-9]{4}-present(\\.|,)? Facebook)|([0-9]{4}(\\.|,)? Facebook)\r\n\tCopyright\r\n\r\nhttps://github.com/facebookresearch/CompilerGym/blob/development/www/frontends/compiler_gym/src/index.js:\r\nThe first 16 lines of 'www/frontends/compiler_gym/src/index.js' do not contain the patterns:\r\n\t(Facebook, Inc(\\.|,)? and its affiliates)|([0-9]{4}-present(\\.|,)? Facebook)|([0-9]{4}(\\.|,)? Facebook)\r\n\tCopyright\r\n\r\nhttps://github.com/facebookresearch/CompilerGym/blob/development/www/frontends/compiler_gym/src/reportWebVitals.js:\r\nThe first 16 lines of 'www/frontends/compiler_gym/src/reportWebVitals.js' do not contain the patterns:\r\n\t(Facebook, Inc(\\.|,)? and its affiliates)|([0-9]{4}-present(\\.|,)? Facebook)|([0-9]{4}(\\.|,)? Facebook)\r\n\tCopyright\r\n\r\nhttps://github.com/facebookresearch/CompilerGym/blob/development/www/frontends/compiler_gym/src/setupTests.js:\r\nThe first 16 lines of 'www/frontends/compiler_gym/src/setupTests.js' do not contain the patterns:\r\n\t(Facebook, Inc(\\.|,)? and its affiliates)|([0-9]{4}-present(\\.|,)? Facebook)|([0-9]{4}(\\.|,)? Facebook)\r\n\tCopyright\r\n\r\nhttps://github.com/facebookresearch/CompilerGym/blob/development/www/frontends/compiler_gym/src/assets/scss/custom.scss:\r\nThe first 16 lines of 'www/frontends/compiler_gym/src/assets/scss/custom.scss' do not contain the patterns:\r\n\t(Facebook, Inc(\\.|,)? and its affiliates)|([0-9]{4}-present(\\.|,)? Facebook)|([0-9]{4}(\\.|,)? Facebook)\r\n\tCopyright\r\n```\n", "before_files": [{"content": "\"\"\"A CompilerGym API and web frontend.\n\nThis exposes an API with five operations:\n\n 1. describe() -> dict (/api/v3/describe)\n\n Describe the CompilerGym interface. This generates a list of action\n names and their numeric values, a list of benchmark datasets and the\n benchmarks within them, and a list of reward spaces.\n\n 2. start(reward, actions, benchmark) -> session_id, state[]\n (/api/v3/start/<reward>/<actions>/<benchmark>)\n\n Start a session. This would happen when the user navigates to the page\n in their web browser. One tab = one session. Takes a reward space name,\n a list of actions, and a benchmark URI as inputs. If no actions are to\n be performed, use \"-\". Returns a numeric session ID (this probably isn't\n the right way of doing things but I don't know any better :-) ). Also\n returns a list of states, which is the set of things we want to\n visualize to represent the current environment state. There is an\n initial state, and then one state for each action.\n\n 3. step(session_id, actions) -> state[] (/api/v3/<session_id>/<actions>)\n\n Run a list of actions and produce a list of states, replacing the old\n ones.\n\n 4. undo(session_id, n) -> state (/api/v3/<session_id>/undo/<n>)\n\n Undo `n` previous actions, returning the previous state.\n\n 5. stop(session_id) (/api/v3/stop/<session_id>)\n\n End a session. This would be when the user closes the tab / disconnects.\n\nTo run this script, install the python dependencies using:\n\n pip install flask compiler_gym pydantic\n\nThen launch it by running, in this directory:\n\n FLASK_APP=demo_api.py flask run\n\nInteract with the API through GET requests, such as using curl. A \"describe\"\nendpoint provides details on teh available actions, benchmarks, and rewards.:\n\n $ curl -s localhost:5000/api/v3/describe | jq\n {\n \"actions\": {\n \"-adce\": 1,\n ...\n \"-tailcallelim\": 122\n },\n \"benchmarks\": {\n \"benchmark://anghabench-v1\": [\n \"8cc/extr_buffer.c_buf_append\",\n ...\n \"8cc/extr_buffer.c_quote_cstring_len\"\n ],\n \"benchmark://blas-v0\": [\n ...\n ],\n \"benchmark://cbench-v1\": [\n \"adpcm\",\n ...\n \"jpeg-c\"\n ],\n ...\n },\n \"rewards\": [\n \"IrInstructionCount\",\n ...\n \"ObjectTextSizeOz\"\n ]\n }\n\nTo start a session, specify a reward space and a benchmark. Note that this\nrequires URL-encoding the benchmark name as it contains slashes. e.g. to start a\nnew session using reward IrInstructionCountOz and benchmark\n\"benchmark://cbench-v1/qsort\":\n\n $ curl -s localhost:5000/api/v3/start/IrInstructionCountOz/benchmark%3A%2F%2Fcbench-v1%2Fqsort | jq\n {\n \"session_id\": 0,\n \"states\": [\n {\n \"autophase\": {\n \"ArgsPhi\": 10,\n ...\n \"twoSuccessor\": 31\n },\n \"commandline\": \"opt input.bc -o output.bc\",\n \"done\": false,\n \"instcount\": {\n \"AShrCount\": 0,\n \"AddCount\": 9,\n ...\n \"ZExtCount\": 15\n },\n \"ir\": \"; ModuleID = '-'\\nsource_filename = \\\"-\\\"\\ntarget ...\",\n \"reward\": 0\n }\n ]\n }\n\nThat \"state\" dict contains the things that we would want to visualize in the\nGUI. Our session ID is 0, lets take a step in this session using action \"10\":\n\n $ curl -s localhost:5000/api/v3/step/0/10 | jq\n {\n \"states\": [\n {\n \"autophase\": {\n \"ArgsPhi\": 2,\n ..,\n \"twoSuccessor\": 29\n },\n \"commandline\": \"opt -simplifycfg input.bc -o output.bc\",\n \"done\": false,\n \"instcount\": {\n \"AShrCount\": 0,\n ...\n \"ZExtCount\": 15\n },\n \"ir\": \"; ModuleID = '-'\\nsource_filename = \\\"-\\\"\\ntarget ...\",\n \"reward\": 0.06501547987616099\n }\n ]\n }\n\nNotice that the state dict has changed. Some of the numbers in the \"autophase\"\nand \"instcount\" feature dictionary have changed, there is a reward value, and\nthe commandline now includes the flag needed to run action \"10\" (which turned\nout to be the \"-simplifycfg\" flag).\n\nWe could carry on taking steps, or just end the session:\n\n $ curl -s localhost:5000/api/v3/stop/0\n\"\"\"\nimport logging\nimport os\nimport sys\nfrom itertools import islice\nfrom pathlib import Path\nfrom threading import Lock, Thread\nfrom time import sleep, time\nfrom typing import Dict, List, Tuple\n\nfrom flask import Flask, jsonify, send_file\nfrom flask_cors import CORS\nfrom pydantic import BaseModel\n\nimport compiler_gym\nfrom compiler_gym import CompilerEnv\nfrom compiler_gym.util.truncate import truncate\n\napp = Flask(\"compiler_gym\")\nCORS(app)\n\n\nresource_dir: Path = (Path(__file__).parent / \"frontends/compiler_gym/build\").absolute()\n\nlogger = logging.getLogger(__name__)\n\n\nclass StateToVisualize(BaseModel):\n \"\"\"Encapsulates everything we want to visualize in the frontend. This\n will change from step to step.\n \"\"\"\n\n # This summarizes the sequence of actions that the user has selected so far:\n commandline: str\n\n # If the compiler environment dies, crashes, or encounters some\n # unrecoverable error, this \"done\" flag is set. At this point the user d\n # should start a new session.\n done: bool\n\n # Observations that we would like to visualize. This list will grow over\n # time to include graphs and 2-D matrices:\n ir: str\n instcount: Dict[str, int]\n autophase: Dict[str, int]\n\n # The reward signal measures how \"good\" the previous action was. Over time\n # the sequence of actions that produces the highest cumulative reward is the\n # best:\n reward: float\n\n\nclass Session(BaseModel):\n states: List[Tuple[CompilerEnv, StateToVisualize]]\n last_use: float # As returned by time().\n\n def close(self):\n for env, _ in self.states:\n env.close()\n\n class Config:\n arbitrary_types_allowed = True\n\n\n# A set of sessions that are in use, keyed by a numeric session ID. Each session\n# is represented by a list of (environment, state) tuples, whether the\n# environment is a CompilerGym environment and the state is a StateToVisualize.\n# Initially, a session consists of a single (environment, state) tuple. When an\n# action is taken, this generates a new (environment, state) tuple that is\n# appended the session list. In this way, undoing an operation is as simple as\n# popping the most recent (environment, state) tuple from the list.\nsessions: Dict[int, Session] = {}\nsessions_lock = Lock()\n\n\ndef compute_state(env: CompilerEnv, actions: List[int]) -> StateToVisualize:\n \"\"\"Apply a list of actions and produce a new state to visualize.\"\"\"\n # This is where we get the compiler environment to do its thing, and compute\n # for us all of the features that we would like to visualize.\n (ir, instcount, autophase), (reward,), done, _ = env.raw_step(\n actions=actions,\n observations=[\n env.observation.spaces[\"Ir\"],\n env.observation.spaces[\"InstCountDict\"],\n env.observation.spaces[\"AutophaseDict\"],\n ],\n rewards=[env.reward_space],\n )\n return StateToVisualize(\n commandline=env.commandline(),\n done=done,\n ir=truncate(ir, max_line_len=250, max_lines=1024),\n instcount=instcount,\n autophase=autophase,\n reward=reward,\n )\n\n\[email protected](\"/api/v3/describe\")\ndef describe():\n with compiler_gym.make(\"llvm-v0\") as env:\n env.reset()\n return jsonify(\n {\n # A mapping from dataset name to benchmark name. To generate a full\n # benchmark URI, join the two values with a '/'. E.g. given a benchmark\n # \"qsort\" in the dataset \"benchmark://cbench-v1\", the full URI is\n # \"benchmark://cbench-v1/qsort\".\n \"benchmarks\": {\n dataset.name: list(\n islice(\n (\n x[len(dataset.name) + 1 :]\n for x in dataset.benchmark_uris()\n ),\n 10,\n )\n )\n for dataset in env.datasets\n },\n # A mapping from the name of an action to the numeric value. This\n # numeric value is what is passed as argument to the step() function.\n \"actions\": {k: v for v, k in enumerate(env.action_space.flags)},\n # A list of reward space names. You select the reward space to use\n # during start().\n \"rewards\": sorted(list(env.reward.spaces.keys())),\n }\n )\n\n\[email protected](\"/api/v3/start/<reward>/<actions>/<path:benchmark>\")\ndef start(reward: str, actions: str, benchmark: str):\n env = compiler_gym.make(\"llvm-v0\", benchmark=benchmark)\n env.reward_space = reward\n env.reset()\n state = compute_state(env, [])\n with sessions_lock:\n session_id = len(sessions)\n session = Session(states=[(env, state)], last_use=time())\n sessions[session_id] = session\n\n # Accept an optional comma-separated list of actions to compute and return.\n if actions != \"-\":\n step(session_id, actions)\n\n return jsonify(\n {\n \"session_id\": session_id,\n \"states\": [state.dict() for _, state in session.states],\n }\n )\n\n\[email protected](\"/api/v3/stop/<session_id>\")\ndef stop(session_id: int):\n session_id = int(session_id)\n\n session = sessions[session_id]\n session.close()\n with sessions_lock:\n del sessions[session_id]\n\n return jsonify({\"session_id\": session_id})\n\n\[email protected](\"/api/v3/step/<session_id>/<actions>\")\ndef step(session_id: int, actions: str):\n session_id = int(session_id)\n\n state_dicts = []\n session = sessions[session_id]\n for action in [int(a) for a in actions.split(\",\")]:\n new_env = session.states[-1][0].fork()\n new_state = compute_state(new_env, [action])\n session.states.append((new_env, new_state))\n state_dicts.append(new_state.dict())\n\n session.last_use = time()\n return jsonify({\"states\": state_dicts})\n\n\[email protected](\"/api/v3/undo/<session_id>/<n>\")\ndef undo(session_id: int, n: int):\n session_id = int(session_id)\n n = int(n)\n\n session = sessions[session_id]\n for _ in range(n):\n env, _ = session.states.pop()\n env.close()\n _, old_state = session[-1]\n\n session.last_use = time()\n return jsonify({\"state\": old_state.dict()})\n\n\ndef idle_session_watchdog(ttl_seconds: int = 1200):\n \"\"\"Background thread to perform periodic garbage collection of sessions\n that haven't been used in `ttl_seconds` seconds.\n \"\"\"\n while True:\n session_ids_to_remove = []\n for session_id, session in sessions.items():\n if session.last_use + ttl_seconds < time():\n session_ids_to_remove.append(session_id)\n with sessions_lock:\n for session_id in session_ids_to_remove:\n sessions[session_id].close()\n del sessions[session_id]\n logger.info(\"Garbage collected %d sessions\", len(session_ids_to_remove))\n sleep(ttl_seconds)\n\n\n# Web endpoints.\n\n\[email protected](\"/\")\ndef index_resource():\n return send_file(resource_dir / \"index.html\")\n\n\[email protected](\"/<path>\")\ndef root_resource(path: str):\n return send_file(resource_dir / path)\n\n\[email protected](\"/static/css/<path>\")\ndef css_resource(path: str):\n return send_file(resource_dir / \"static/css/\" / path)\n\n\[email protected](\"/static/js/<path>\")\ndef js_resource(path: str):\n return send_file(resource_dir / \"static/js/\" / path)\n\n\nif __name__ == \"__main__\":\n logger.setLevel(logging.DEBUG)\n handler = logging.StreamHandler(sys.stderr)\n handler.setLevel(logging.DEBUG)\n formatter = logging.Formatter(\n \"%(asctime)s - %(name)s - %(levelname)s - %(message)s\"\n )\n handler.setFormatter(formatter)\n logger.addHandler(handler)\n\n logger.info(\"Serving from %s\", resource_dir)\n Thread(target=idle_session_watchdog).start()\n app.run(port=int(os.environ.get(\"PORT\", \"5000\")))\n", "path": "www/www.py"}], "after_files": [{"content": "# Copyright (c) Facebook, Inc. and its affiliates.\n#\n# This source code is licensed under the MIT license found in the\n# LICENSE file in the root directory of this source tree.\n\"\"\"A CompilerGym API and web frontend.\n\nThis exposes an API with five operations:\n\n 1. describe() -> dict (/api/v3/describe)\n\n Describe the CompilerGym interface. This generates a list of action\n names and their numeric values, a list of benchmark datasets and the\n benchmarks within them, and a list of reward spaces.\n\n 2. start(reward, actions, benchmark) -> session_id, state[]\n (/api/v3/start/<reward>/<actions>/<benchmark>)\n\n Start a session. This would happen when the user navigates to the page\n in their web browser. One tab = one session. Takes a reward space name,\n a list of actions, and a benchmark URI as inputs. If no actions are to\n be performed, use \"-\". Returns a numeric session ID (this probably isn't\n the right way of doing things but I don't know any better :-) ). Also\n returns a list of states, which is the set of things we want to\n visualize to represent the current environment state. There is an\n initial state, and then one state for each action.\n\n 3. step(session_id, actions) -> state[] (/api/v3/<session_id>/<actions>)\n\n Run a list of actions and produce a list of states, replacing the old\n ones.\n\n 4. undo(session_id, n) -> state (/api/v3/<session_id>/undo/<n>)\n\n Undo `n` previous actions, returning the previous state.\n\n 5. stop(session_id) (/api/v3/stop/<session_id>)\n\n End a session. This would be when the user closes the tab / disconnects.\n\nTo run this script, install the python dependencies using:\n\n pip install flask compiler_gym pydantic\n\nThen launch it by running, in this directory:\n\n FLASK_APP=demo_api.py flask run\n\nInteract with the API through GET requests, such as using curl. A \"describe\"\nendpoint provides details on teh available actions, benchmarks, and rewards.:\n\n $ curl -s localhost:5000/api/v3/describe | jq\n {\n \"actions\": {\n \"-adce\": 1,\n ...\n \"-tailcallelim\": 122\n },\n \"benchmarks\": {\n \"benchmark://anghabench-v1\": [\n \"8cc/extr_buffer.c_buf_append\",\n ...\n \"8cc/extr_buffer.c_quote_cstring_len\"\n ],\n \"benchmark://blas-v0\": [\n ...\n ],\n \"benchmark://cbench-v1\": [\n \"adpcm\",\n ...\n \"jpeg-c\"\n ],\n ...\n },\n \"rewards\": [\n \"IrInstructionCount\",\n ...\n \"ObjectTextSizeOz\"\n ]\n }\n\nTo start a session, specify a reward space and a benchmark. Note that this\nrequires URL-encoding the benchmark name as it contains slashes. e.g. to start a\nnew session using reward IrInstructionCountOz and benchmark\n\"benchmark://cbench-v1/qsort\":\n\n $ curl -s localhost:5000/api/v3/start/IrInstructionCountOz/benchmark%3A%2F%2Fcbench-v1%2Fqsort | jq\n {\n \"session_id\": 0,\n \"states\": [\n {\n \"autophase\": {\n \"ArgsPhi\": 10,\n ...\n \"twoSuccessor\": 31\n },\n \"commandline\": \"opt input.bc -o output.bc\",\n \"done\": false,\n \"instcount\": {\n \"AShrCount\": 0,\n \"AddCount\": 9,\n ...\n \"ZExtCount\": 15\n },\n \"ir\": \"; ModuleID = '-'\\nsource_filename = \\\"-\\\"\\ntarget ...\",\n \"reward\": 0\n }\n ]\n }\n\nThat \"state\" dict contains the things that we would want to visualize in the\nGUI. Our session ID is 0, lets take a step in this session using action \"10\":\n\n $ curl -s localhost:5000/api/v3/step/0/10 | jq\n {\n \"states\": [\n {\n \"autophase\": {\n \"ArgsPhi\": 2,\n ..,\n \"twoSuccessor\": 29\n },\n \"commandline\": \"opt -simplifycfg input.bc -o output.bc\",\n \"done\": false,\n \"instcount\": {\n \"AShrCount\": 0,\n ...\n \"ZExtCount\": 15\n },\n \"ir\": \"; ModuleID = '-'\\nsource_filename = \\\"-\\\"\\ntarget ...\",\n \"reward\": 0.06501547987616099\n }\n ]\n }\n\nNotice that the state dict has changed. Some of the numbers in the \"autophase\"\nand \"instcount\" feature dictionary have changed, there is a reward value, and\nthe commandline now includes the flag needed to run action \"10\" (which turned\nout to be the \"-simplifycfg\" flag).\n\nWe could carry on taking steps, or just end the session:\n\n $ curl -s localhost:5000/api/v3/stop/0\n\"\"\"\nimport logging\nimport os\nimport sys\nfrom itertools import islice\nfrom pathlib import Path\nfrom threading import Lock, Thread\nfrom time import sleep, time\nfrom typing import Dict, List, Tuple\n\nfrom flask import Flask, jsonify, send_file\nfrom flask_cors import CORS\nfrom pydantic import BaseModel\n\nimport compiler_gym\nfrom compiler_gym import CompilerEnv\nfrom compiler_gym.util.truncate import truncate\n\napp = Flask(\"compiler_gym\")\nCORS(app)\n\n\nresource_dir: Path = (Path(__file__).parent / \"frontends/compiler_gym/build\").absolute()\n\nlogger = logging.getLogger(__name__)\n\n\nclass StateToVisualize(BaseModel):\n \"\"\"Encapsulates everything we want to visualize in the frontend. This\n will change from step to step.\n \"\"\"\n\n # This summarizes the sequence of actions that the user has selected so far:\n commandline: str\n\n # If the compiler environment dies, crashes, or encounters some\n # unrecoverable error, this \"done\" flag is set. At this point the user d\n # should start a new session.\n done: bool\n\n # Observations that we would like to visualize. This list will grow over\n # time to include graphs and 2-D matrices:\n ir: str\n instcount: Dict[str, int]\n autophase: Dict[str, int]\n\n # The reward signal measures how \"good\" the previous action was. Over time\n # the sequence of actions that produces the highest cumulative reward is the\n # best:\n reward: float\n\n\nclass Session(BaseModel):\n states: List[Tuple[CompilerEnv, StateToVisualize]]\n last_use: float # As returned by time().\n\n def close(self):\n for env, _ in self.states:\n env.close()\n\n class Config:\n arbitrary_types_allowed = True\n\n\n# A set of sessions that are in use, keyed by a numeric session ID. Each session\n# is represented by a list of (environment, state) tuples, whether the\n# environment is a CompilerGym environment and the state is a StateToVisualize.\n# Initially, a session consists of a single (environment, state) tuple. When an\n# action is taken, this generates a new (environment, state) tuple that is\n# appended the session list. In this way, undoing an operation is as simple as\n# popping the most recent (environment, state) tuple from the list.\nsessions: Dict[int, Session] = {}\nsessions_lock = Lock()\n\n\ndef compute_state(env: CompilerEnv, actions: List[int]) -> StateToVisualize:\n \"\"\"Apply a list of actions and produce a new state to visualize.\"\"\"\n # This is where we get the compiler environment to do its thing, and compute\n # for us all of the features that we would like to visualize.\n (ir, instcount, autophase), (reward,), done, _ = env.raw_step(\n actions=actions,\n observations=[\n env.observation.spaces[\"Ir\"],\n env.observation.spaces[\"InstCountDict\"],\n env.observation.spaces[\"AutophaseDict\"],\n ],\n rewards=[env.reward_space],\n )\n return StateToVisualize(\n commandline=env.commandline(),\n done=done,\n ir=truncate(ir, max_line_len=250, max_lines=1024),\n instcount=instcount,\n autophase=autophase,\n reward=reward,\n )\n\n\[email protected](\"/api/v3/describe\")\ndef describe():\n with compiler_gym.make(\"llvm-v0\") as env:\n env.reset()\n return jsonify(\n {\n # A mapping from dataset name to benchmark name. To generate a full\n # benchmark URI, join the two values with a '/'. E.g. given a benchmark\n # \"qsort\" in the dataset \"benchmark://cbench-v1\", the full URI is\n # \"benchmark://cbench-v1/qsort\".\n \"benchmarks\": {\n dataset.name: list(\n islice(\n (\n x[len(dataset.name) + 1 :]\n for x in dataset.benchmark_uris()\n ),\n 10,\n )\n )\n for dataset in env.datasets\n },\n # A mapping from the name of an action to the numeric value. This\n # numeric value is what is passed as argument to the step() function.\n \"actions\": {k: v for v, k in enumerate(env.action_space.flags)},\n # A list of reward space names. You select the reward space to use\n # during start().\n \"rewards\": sorted(list(env.reward.spaces.keys())),\n }\n )\n\n\[email protected](\"/api/v3/start/<reward>/<actions>/<path:benchmark>\")\ndef start(reward: str, actions: str, benchmark: str):\n env = compiler_gym.make(\"llvm-v0\", benchmark=benchmark)\n env.reward_space = reward\n env.reset()\n state = compute_state(env, [])\n with sessions_lock:\n session_id = len(sessions)\n session = Session(states=[(env, state)], last_use=time())\n sessions[session_id] = session\n\n # Accept an optional comma-separated list of actions to compute and return.\n if actions != \"-\":\n step(session_id, actions)\n\n return jsonify(\n {\n \"session_id\": session_id,\n \"states\": [state.dict() for _, state in session.states],\n }\n )\n\n\[email protected](\"/api/v3/stop/<session_id>\")\ndef stop(session_id: int):\n session_id = int(session_id)\n\n session = sessions[session_id]\n session.close()\n with sessions_lock:\n del sessions[session_id]\n\n return jsonify({\"session_id\": session_id})\n\n\[email protected](\"/api/v3/step/<session_id>/<actions>\")\ndef step(session_id: int, actions: str):\n session_id = int(session_id)\n\n state_dicts = []\n session = sessions[session_id]\n for action in [int(a) for a in actions.split(\",\")]:\n new_env = session.states[-1][0].fork()\n new_state = compute_state(new_env, [action])\n session.states.append((new_env, new_state))\n state_dicts.append(new_state.dict())\n\n session.last_use = time()\n return jsonify({\"states\": state_dicts})\n\n\[email protected](\"/api/v3/undo/<session_id>/<n>\")\ndef undo(session_id: int, n: int):\n session_id = int(session_id)\n n = int(n)\n\n session = sessions[session_id]\n for _ in range(n):\n env, _ = session.states.pop()\n env.close()\n _, old_state = session[-1]\n\n session.last_use = time()\n return jsonify({\"state\": old_state.dict()})\n\n\ndef idle_session_watchdog(ttl_seconds: int = 1200):\n \"\"\"Background thread to perform periodic garbage collection of sessions\n that haven't been used in `ttl_seconds` seconds.\n \"\"\"\n while True:\n session_ids_to_remove = []\n for session_id, session in sessions.items():\n if session.last_use + ttl_seconds < time():\n session_ids_to_remove.append(session_id)\n with sessions_lock:\n for session_id in session_ids_to_remove:\n sessions[session_id].close()\n del sessions[session_id]\n logger.info(\"Garbage collected %d sessions\", len(session_ids_to_remove))\n sleep(ttl_seconds)\n\n\n# Web endpoints.\n\n\[email protected](\"/\")\ndef index_resource():\n return send_file(resource_dir / \"index.html\")\n\n\[email protected](\"/<path>\")\ndef root_resource(path: str):\n return send_file(resource_dir / path)\n\n\[email protected](\"/static/css/<path>\")\ndef css_resource(path: str):\n return send_file(resource_dir / \"static/css/\" / path)\n\n\[email protected](\"/static/js/<path>\")\ndef js_resource(path: str):\n return send_file(resource_dir / \"static/js/\" / path)\n\n\nif __name__ == \"__main__\":\n logger.setLevel(logging.DEBUG)\n handler = logging.StreamHandler(sys.stderr)\n handler.setLevel(logging.DEBUG)\n formatter = logging.Formatter(\n \"%(asctime)s - %(name)s - %(levelname)s - %(message)s\"\n )\n handler.setFormatter(formatter)\n logger.addHandler(handler)\n\n logger.info(\"Serving from %s\", resource_dir)\n Thread(target=idle_session_watchdog).start()\n app.run(port=int(os.environ.get(\"PORT\", \"5000\")))\n", "path": "www/www.py"}]} |
gh_patches_debug_233 | rasdani/github-patches | git_diff | ibis-project__ibis-8929 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
bug: RisingWave race condition (?) where table returns before data is loaded
### What happened?
wanted to show off using RisingWave, and first needed to load in some data. separate issue that `to_pyarrow()` doesn't work in place of `to_pandas()` here, but that's also an issue in Postgres
surprisingly though, when the table is created it is first empty -- after some time (probably less than a second in this case) the data seems to be populated
after `just up risingwave`:
```python
[ins] In [1]: import ibis
[ins] In [2]: ibis.options.interactive = True
[ins] In [3]: con = ibis.risingwave.connect(host="localhost", port=4566, database="dev", user="postgres")
[ins] In [4]: t = ibis.examples.penguins.fetch()
[nav] In [5]: t = con.create_table("penguins", t.to_pandas(), overwrite=True)
[ins] In [6]: t
Out[6]:
┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━┓
┃ species ┃ island ┃ bill_length_mm ┃ bill_depth_mm ┃ flipper_length_mm ┃ body_mass_g ┃ … ┃
┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━┩
│ string │ string │ float64 │ float64 │ float64 │ float64 │ … │
└──────────────────────┴──────────────────────┴──────────────────────┴──────────────────────┴──────────────────────┴──────────────────────┴───┘
[ins] In [7]: t
Out[7]:
┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━┓
┃ species ┃ island ┃ bill_length_mm ┃ bill_depth_mm ┃ flipper_length_mm ┃ body_mass_g ┃ … ┃
┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━┩
│ string │ string │ float64 │ float64 │ float64 │ float64 │ … │
└──────────────────────┴──────────────────────┴──────────────────────┴──────────────────────┴──────────────────────┴──────────────────────┴───┘
[ins] In [8]: t
Out[8]:
┏━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━┓
┃ species ┃ island ┃ bill_length_mm ┃ bill_depth_mm ┃ flipper_length_mm ┃ body_mass_g ┃ sex ┃ year ┃
┡━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━┩
│ string │ string │ float64 │ float64 │ float64 │ float64 │ string │ int64 │
├───────────┼───────────┼────────────────┼───────────────┼───────────────────┼─────────────┼────────┼───────┤
│ Gentoo │ Biscoe │ 50.5 │ 15.9 │ 225.0 │ 5400.0 │ male │ 2008 │
│ Chinstrap │ Dream │ 52.2 │ 18.8 │ 197.0 │ 3450.0 │ male │ 2009 │
│ Adelie │ Dream │ 33.1 │ 16.1 │ 178.0 │ 2900.0 │ female │ 2008 │
│ Adelie │ Torgersen │ 40.6 │ 19.0 │ 199.0 │ 4000.0 │ male │ 2009 │
│ Gentoo │ Biscoe │ 50.1 │ 15.0 │ 225.0 │ 5000.0 │ male │ 2008 │
│ Gentoo │ Biscoe │ 48.7 │ 14.1 │ 210.0 │ 4450.0 │ female │ 2007 │
│ Gentoo │ Biscoe │ 45.0 │ 15.4 │ 220.0 │ 5050.0 │ male │ 2008 │
│ Gentoo │ Biscoe │ 44.9 │ 13.8 │ 212.0 │ 4750.0 │ female │ 2009 │
│ Adelie │ Dream │ 37.5 │ 18.5 │ 199.0 │ 4475.0 │ male │ 2009 │
│ Adelie │ Dream │ 38.1 │ 17.6 │ 187.0 │ 3425.0 │ female │ 2009 │
│ … │ … │ … │ … │ … │ … │ … │ … │
└───────────┴───────────┴────────────────┴───────────────┴───────────────────┴─────────────┴────────┴───────┘
```
### What version of ibis are you using?
main
### What backend(s) are you using, if any?
RisingWave
### Relevant log output
```sh
n/a
```
### 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/backends/risingwave/__init__.py`
Content:
```
1 """Risingwave backend."""
2
3 from __future__ import annotations
4
5 from functools import partial
6 from itertools import repeat
7 from operator import itemgetter
8 from typing import TYPE_CHECKING
9
10 import psycopg2
11 import sqlglot as sg
12 import sqlglot.expressions as sge
13 from psycopg2 import extras
14
15 import ibis
16 import ibis.common.exceptions as com
17 import ibis.expr.operations as ops
18 import ibis.expr.types as ir
19 from ibis import util
20 from ibis.backends.postgres import Backend as PostgresBackend
21 from ibis.backends.risingwave.compiler import RisingwaveCompiler
22 from ibis.util import experimental
23
24 if TYPE_CHECKING:
25 import pandas as pd
26 import pyarrow as pa
27
28
29 def data_and_encode_format(data_format, encode_format, encode_properties):
30 res = ""
31 if data_format is not None:
32 res = res + " FORMAT " + data_format.upper()
33 if encode_format is not None:
34 res = res + " ENCODE " + encode_format.upper()
35 if encode_properties is not None:
36 res = res + " " + format_properties(encode_properties)
37 return res
38
39
40 def format_properties(props):
41 tokens = []
42 for k, v in props.items():
43 tokens.append(f"{k}='{v}'")
44 return "( {} ) ".format(", ".join(tokens))
45
46
47 class Backend(PostgresBackend):
48 name = "risingwave"
49 compiler = RisingwaveCompiler()
50 supports_python_udfs = False
51
52 def do_connect(
53 self,
54 host: str | None = None,
55 user: str | None = None,
56 password: str | None = None,
57 port: int = 5432,
58 database: str | None = None,
59 schema: str | None = None,
60 ) -> None:
61 """Create an Ibis client connected to RisingWave database.
62
63 Parameters
64 ----------
65 host
66 Hostname
67 user
68 Username
69 password
70 Password
71 port
72 Port number
73 database
74 Database to connect to
75 schema
76 RisingWave schema to use. If `None`, use the default `search_path`.
77
78 Examples
79 --------
80 >>> import os
81 >>> import getpass
82 >>> import ibis
83 >>> host = os.environ.get("IBIS_TEST_RISINGWAVE_HOST", "localhost")
84 >>> user = os.environ.get("IBIS_TEST_RISINGWAVE_USER", getpass.getuser())
85 >>> password = os.environ.get("IBIS_TEST_RISINGWAVE_PASSWORD")
86 >>> database = os.environ.get("IBIS_TEST_RISINGWAVE_DATABASE", "dev")
87 >>> con = connect(database=database, host=host, user=user, password=password)
88 >>> con.list_tables() # doctest: +ELLIPSIS
89 [...]
90 >>> t = con.table("functional_alltypes")
91 >>> t
92 RisingwaveTable[table]
93 name: functional_alltypes
94 schema:
95 id : int32
96 bool_col : boolean
97 tinyint_col : int16
98 smallint_col : int16
99 int_col : int32
100 bigint_col : int64
101 float_col : float32
102 double_col : float64
103 date_string_col : string
104 string_col : string
105 timestamp_col : timestamp
106 year : int32
107 month : int32
108
109 """
110
111 self.con = psycopg2.connect(
112 host=host,
113 port=port,
114 user=user,
115 password=password,
116 database=database,
117 options=(f"-csearch_path={schema}" * (schema is not None)) or None,
118 )
119
120 with self.begin() as cur:
121 cur.execute("SET TIMEZONE = UTC")
122
123 def create_table(
124 self,
125 name: str,
126 obj: pd.DataFrame | pa.Table | ir.Table | None = None,
127 *,
128 schema: ibis.Schema | None = None,
129 database: str | None = None,
130 temp: bool = False,
131 overwrite: bool = False,
132 # TODO(Kexiang): add `append only`
133 connector_properties: dict | None = None,
134 data_format: str | None = None,
135 encode_format: str | None = None,
136 encode_properties: dict | None = None,
137 ):
138 """Create a table in Risingwave.
139
140 Parameters
141 ----------
142 name
143 Name of the table to create
144 obj
145 The data with which to populate the table; optional, but at least
146 one of `obj` or `schema` must be specified
147 schema
148 The schema of the table to create; optional, but at least one of
149 `obj` or `schema` must be specified
150 database
151 The name of the database in which to create the table; if not
152 passed, the current database is used.
153 temp
154 Create a temporary table
155 overwrite
156 If `True`, replace the table if it already exists, otherwise fail
157 if the table exists
158 connector_properties
159 The properties of the sink connector, providing the connector settings to push to the downstream data sink.
160 Refer https://docs.risingwave.com/docs/current/data-delivery/ for the required properties of different data sink.
161 data_format
162 The data format for the new source, e.g., "PLAIN". data_format and encode_format must be specified at the same time.
163 encode_format
164 The encode format for the new source, e.g., "JSON". data_format and encode_format must be specified at the same time.
165 encode_properties
166 The properties of encode format, providing information like schema registry url. Refer https://docs.risingwave.com/docs/current/sql-create-source/ for more details.
167
168 Returns
169 -------
170 Table
171 Table expression
172 """
173 if obj is None and schema is None:
174 raise ValueError("Either `obj` or `schema` must be specified")
175
176 if connector_properties is not None and (
177 encode_format is None or data_format is None
178 ):
179 raise com.UnsupportedOperationError(
180 "When creating tables with connector, both encode_format and data_format are required"
181 )
182
183 properties = []
184
185 if temp:
186 raise com.UnsupportedOperationError(
187 f"Creating temp tables is not supported by {self.name}"
188 )
189
190 if obj is not None:
191 if not isinstance(obj, ir.Expr):
192 table = ibis.memtable(obj)
193 else:
194 table = obj
195
196 self._run_pre_execute_hooks(table)
197
198 query = self._to_sqlglot(table)
199 else:
200 query = None
201
202 column_defs = [
203 sge.ColumnDef(
204 this=sg.to_identifier(colname, quoted=self.compiler.quoted),
205 kind=self.compiler.type_mapper.from_ibis(typ),
206 constraints=(
207 None
208 if typ.nullable
209 else [sge.ColumnConstraint(kind=sge.NotNullColumnConstraint())]
210 ),
211 )
212 for colname, typ in (schema or table.schema()).items()
213 ]
214
215 if overwrite:
216 temp_name = util.gen_name(f"{self.name}_table")
217 else:
218 temp_name = name
219
220 table = sg.table(temp_name, db=database, quoted=self.compiler.quoted)
221 target = sge.Schema(this=table, expressions=column_defs)
222
223 if connector_properties is None:
224 create_stmt = sge.Create(
225 kind="TABLE",
226 this=target,
227 properties=sge.Properties(expressions=properties),
228 )
229 else:
230 create_stmt = sge.Create(
231 kind="TABLE",
232 this=target,
233 properties=sge.Properties(
234 expressions=sge.Properties.from_dict(connector_properties)
235 ),
236 )
237 create_stmt = create_stmt.sql(self.dialect) + data_and_encode_format(
238 data_format, encode_format, encode_properties
239 )
240
241 this = sg.table(name, db=database, quoted=self.compiler.quoted)
242 with self._safe_raw_sql(create_stmt) as cur:
243 if query is not None:
244 insert_stmt = sge.Insert(this=table, expression=query).sql(self.dialect)
245 cur.execute(insert_stmt)
246
247 if overwrite:
248 self.drop_table(name, database=database, force=True)
249 cur.execute(
250 f"ALTER TABLE {table.sql(self.dialect)} RENAME TO {this.sql(self.dialect)}"
251 )
252
253 if schema is None:
254 return self.table(name, database=database)
255
256 # preserve the input schema if it was provided
257 return ops.DatabaseTable(
258 name, schema=schema, source=self, namespace=ops.Namespace(database=database)
259 ).to_expr()
260
261 def _register_in_memory_table(self, op: ops.InMemoryTable) -> None:
262 schema = op.schema
263 if null_columns := [col for col, dtype in schema.items() if dtype.is_null()]:
264 raise com.IbisTypeError(
265 f"{self.name} cannot yet reliably handle `null` typed columns; "
266 f"got null typed columns: {null_columns}"
267 )
268
269 # only register if we haven't already done so
270 if (name := op.name) not in self.list_tables():
271 quoted = self.compiler.quoted
272 column_defs = [
273 sg.exp.ColumnDef(
274 this=sg.to_identifier(colname, quoted=quoted),
275 kind=self.compiler.type_mapper.from_ibis(typ),
276 constraints=(
277 None
278 if typ.nullable
279 else [
280 sg.exp.ColumnConstraint(
281 kind=sg.exp.NotNullColumnConstraint()
282 )
283 ]
284 ),
285 )
286 for colname, typ in schema.items()
287 ]
288
289 create_stmt = sg.exp.Create(
290 kind="TABLE",
291 this=sg.exp.Schema(
292 this=sg.to_identifier(name, quoted=quoted), expressions=column_defs
293 ),
294 )
295 create_stmt_sql = create_stmt.sql(self.dialect)
296
297 columns = schema.keys()
298 df = op.data.to_frame()
299 data = df.itertuples(index=False)
300 cols = ", ".join(
301 ident.sql(self.dialect)
302 for ident in map(partial(sg.to_identifier, quoted=quoted), columns)
303 )
304 specs = ", ".join(repeat("%s", len(columns)))
305 table = sg.table(name, quoted=quoted)
306 sql = f"INSERT INTO {table.sql(self.dialect)} ({cols}) VALUES ({specs})"
307 with self.begin() as cur:
308 cur.execute(create_stmt_sql)
309 extras.execute_batch(cur, sql, data, 128)
310
311 def list_databases(
312 self, *, like: str | None = None, catalog: str | None = None
313 ) -> list[str]:
314 dbs = "SHOW SCHEMAS"
315
316 with self._safe_raw_sql(dbs) as cur:
317 databases = list(map(itemgetter(0), cur))
318
319 return self._filter_with_like(databases, like)
320
321 @experimental
322 def create_materialized_view(
323 self,
324 name: str,
325 obj: ir.Table,
326 *,
327 database: str | None = None,
328 overwrite: bool = False,
329 ) -> ir.Table:
330 """Create a materialized view. Materialized views can be accessed like a normal table.
331
332 Parameters
333 ----------
334 name
335 Materialized view name to Create.
336 obj
337 The select statement to materialize.
338 database
339 Name of the database where the view exists, if not the default
340 overwrite
341 Whether to overwrite the existing materialized view with the same name
342
343 Returns
344 -------
345 Table
346 Table expression
347 """
348 if overwrite:
349 temp_name = util.gen_name(f"{self.name}_table")
350 else:
351 temp_name = name
352
353 table = sg.table(temp_name, db=database, quoted=self.compiler.quoted)
354
355 create_stmt = sge.Create(
356 this=table,
357 kind="MATERIALIZED VIEW",
358 expression=self.compile(obj),
359 )
360 self._register_in_memory_tables(obj)
361
362 with self._safe_raw_sql(create_stmt) as cur:
363 if overwrite:
364 target = sg.table(name, db=database).sql(self.dialect)
365
366 self.drop_materialized_view(target, database=database, force=True)
367
368 cur.execute(
369 f"ALTER MATERIALIZED VIEW {table.sql(self.dialect)} RENAME TO {target}"
370 )
371
372 return self.table(name, database=database)
373
374 def drop_materialized_view(
375 self,
376 name: str,
377 *,
378 database: str | None = None,
379 force: bool = False,
380 ) -> None:
381 """Drop a materialized view.
382
383 Parameters
384 ----------
385 name
386 Materialized view name to drop.
387 database
388 Name of the database where the view exists, if not the default.
389 force
390 If `False`, an exception is raised if the view does not exist.
391 """
392 src = sge.Drop(
393 this=sg.table(name, db=database, quoted=self.compiler.quoted),
394 kind="MATERIALIZED VIEW",
395 exists=force,
396 )
397 with self._safe_raw_sql(src):
398 pass
399
400 def create_source(
401 self,
402 name: str,
403 schema: ibis.Schema,
404 *,
405 database: str | None = None,
406 connector_properties: dict,
407 data_format: str,
408 encode_format: str,
409 encode_properties: dict | None = None,
410 ) -> ir.Table:
411 """Creating a source.
412
413 Parameters
414 ----------
415 name
416 Source name to Create.
417 schema
418 The schema for the new Source.
419 database
420 Name of the database where the source exists, if not the default.
421 connector_properties
422 The properties of the source connector, providing the connector settings to access the upstream data source.
423 Refer https://docs.risingwave.com/docs/current/data-ingestion/ for the required properties of different data source.
424 data_format
425 The data format for the new source, e.g., "PLAIN". data_format and encode_format must be specified at the same time.
426 encode_format
427 The encode format for the new source, e.g., "JSON". data_format and encode_format must be specified at the same time.
428 encode_properties
429 The properties of encode format, providing information like schema registry url. Refer https://docs.risingwave.com/docs/current/sql-create-source/ for more details.
430
431 Returns
432 -------
433 Table
434 Table expression
435 """
436 column_defs = [
437 sge.ColumnDef(
438 this=sg.to_identifier(colname, quoted=self.compiler.quoted),
439 kind=self.compiler.type_mapper.from_ibis(typ),
440 constraints=(
441 None
442 if typ.nullable
443 else [sge.ColumnConstraint(kind=sge.NotNullColumnConstraint())]
444 ),
445 )
446 for colname, typ in schema.items()
447 ]
448
449 table = sg.table(name, db=database, quoted=self.compiler.quoted)
450 target = sge.Schema(this=table, expressions=column_defs)
451
452 create_stmt = sge.Create(
453 kind="SOURCE",
454 this=target,
455 properties=sge.Properties(
456 expressions=sge.Properties.from_dict(connector_properties)
457 ),
458 )
459
460 create_stmt = create_stmt.sql(self.dialect) + data_and_encode_format(
461 data_format, encode_format, encode_properties
462 )
463
464 with self._safe_raw_sql(create_stmt):
465 pass
466
467 return self.table(name, database=database)
468
469 def drop_source(
470 self,
471 name: str,
472 *,
473 database: str | None = None,
474 force: bool = False,
475 ) -> None:
476 """Drop a Source.
477
478 Parameters
479 ----------
480 name
481 Source name to drop.
482 database
483 Name of the database where the view exists, if not the default.
484 force
485 If `False`, an exception is raised if the source does not exist.
486 """
487 src = sge.Drop(
488 this=sg.table(name, db=database, quoted=self.compiler.quoted),
489 kind="SOURCE",
490 exists=force,
491 )
492 with self._safe_raw_sql(src):
493 pass
494
495 def create_sink(
496 self,
497 name: str,
498 sink_from: str | None = None,
499 connector_properties: dict | None = None,
500 *,
501 obj: ir.Table | None = None,
502 database: str | None = None,
503 data_format: str | None = None,
504 encode_format: str | None = None,
505 encode_properties: dict | None = None,
506 ) -> None:
507 """Creating a sink.
508
509 Parameters
510 ----------
511 name
512 Sink name to Create.
513 sink_from
514 The table or materialized view name to sink from. Only one of `sink_from` or `obj` can be
515 provided.
516 connector_properties
517 The properties of the sink connector, providing the connector settings to push to the downstream data sink.
518 Refer https://docs.risingwave.com/docs/current/data-delivery/ for the required properties of different data sink.
519 obj
520 An Ibis table expression that will be used to extract the schema and the data of the new table. Only one of `sink_from` or `obj` can be provided.
521 database
522 Name of the database where the source exists, if not the default.
523 data_format
524 The data format for the new source, e.g., "PLAIN". data_format and encode_format must be specified at the same time.
525 encode_format
526 The encode format for the new source, e.g., "JSON". data_format and encode_format must be specified at the same time.
527 encode_properties
528 The properties of encode format, providing information like schema registry url. Refer https://docs.risingwave.com/docs/current/sql-create-source/ for more details.
529 """
530 table = sg.table(name, db=database, quoted=self.compiler.quoted)
531 if sink_from is None and obj is None:
532 raise ValueError("Either `sink_from` or `obj` must be specified")
533 if sink_from is not None and obj is not None:
534 raise ValueError("Only one of `sink_from` or `obj` can be specified")
535
536 if (encode_format is None) != (data_format is None):
537 raise com.UnsupportedArgumentError(
538 "When creating sinks, both encode_format and data_format must be provided, or neither should be"
539 )
540
541 if sink_from is not None:
542 create_stmt = f"CREATE SINK {table.sql(self.dialect)} FROM {sink_from}"
543 else:
544 create_stmt = sge.Create(
545 this=table,
546 kind="SINK",
547 expression=self.compile(obj),
548 ).sql(self.dialect)
549 create_stmt = (
550 create_stmt
551 + " WITH "
552 + format_properties(connector_properties)
553 + data_and_encode_format(data_format, encode_format, encode_properties)
554 )
555 with self._safe_raw_sql(create_stmt):
556 pass
557
558 def drop_sink(
559 self,
560 name: str,
561 *,
562 database: str | None = None,
563 force: bool = False,
564 ) -> None:
565 """Drop a Sink.
566
567 Parameters
568 ----------
569 name
570 Sink name to drop.
571 database
572 Name of the database where the view exists, if not the default.
573 force
574 If `False`, an exception is raised if the source does not exist.
575 """
576 src = sge.Drop(
577 this=sg.table(name, db=database, quoted=self.compiler.quoted),
578 kind="SINK",
579 exists=force,
580 )
581 with self._safe_raw_sql(src):
582 pass
583
```
--- 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/backends/risingwave/__init__.py b/ibis/backends/risingwave/__init__.py
--- a/ibis/backends/risingwave/__init__.py
+++ b/ibis/backends/risingwave/__init__.py
@@ -119,6 +119,7 @@
with self.begin() as cur:
cur.execute("SET TIMEZONE = UTC")
+ cur.execute("SET RW_IMPLICIT_FLUSH TO true;")
def create_table(
self,
| {"golden_diff": "diff --git a/ibis/backends/risingwave/__init__.py b/ibis/backends/risingwave/__init__.py\n--- a/ibis/backends/risingwave/__init__.py\n+++ b/ibis/backends/risingwave/__init__.py\n@@ -119,6 +119,7 @@\n \n with self.begin() as cur:\n cur.execute(\"SET TIMEZONE = UTC\")\n+ cur.execute(\"SET RW_IMPLICIT_FLUSH TO true;\")\n \n def create_table(\n self,\n", "issue": "bug: RisingWave race condition (?) where table returns before data is loaded\n### What happened?\n\nwanted to show off using RisingWave, and first needed to load in some data. separate issue that `to_pyarrow()` doesn't work in place of `to_pandas()` here, but that's also an issue in Postgres\r\n\r\nsurprisingly though, when the table is created it is first empty -- after some time (probably less than a second in this case) the data seems to be populated\r\n\r\nafter `just up risingwave`:\r\n\r\n```python\r\n[ins] In [1]: import ibis\r\n\r\n[ins] In [2]: ibis.options.interactive = True\r\n\r\n[ins] In [3]: con = ibis.risingwave.connect(host=\"localhost\", port=4566, database=\"dev\", user=\"postgres\")\r\n\r\n[ins] In [4]: t = ibis.examples.penguins.fetch()\r\n\r\n[nav] In [5]: t = con.create_table(\"penguins\", t.to_pandas(), overwrite=True)\r\n\r\n[ins] In [6]: t\r\nOut[6]:\r\n\u250f\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2513\r\n\u2503 species \u2503 island \u2503 bill_length_mm \u2503 bill_depth_mm \u2503 flipper_length_mm \u2503 body_mass_g \u2503 \u2026 \u2503\r\n\u2521\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2529\r\n\u2502 string \u2502 string \u2502 float64 \u2502 float64 \u2502 float64 \u2502 float64 \u2502 \u2026 \u2502\r\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2518\r\n\r\n[ins] In [7]: t\r\nOut[7]:\r\n\u250f\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2513\r\n\u2503 species \u2503 island \u2503 bill_length_mm \u2503 bill_depth_mm \u2503 flipper_length_mm \u2503 body_mass_g \u2503 \u2026 \u2503\r\n\u2521\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2529\r\n\u2502 string \u2502 string \u2502 float64 \u2502 float64 \u2502 float64 \u2502 float64 \u2502 \u2026 \u2502\r\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2518\r\n\r\n[ins] In [8]: t\r\nOut[8]:\r\n\u250f\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2513\r\n\u2503 species \u2503 island \u2503 bill_length_mm \u2503 bill_depth_mm \u2503 flipper_length_mm \u2503 body_mass_g \u2503 sex \u2503 year \u2503\r\n\u2521\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2529\r\n\u2502 string \u2502 string \u2502 float64 \u2502 float64 \u2502 float64 \u2502 float64 \u2502 string \u2502 int64 \u2502\r\n\u251c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524\r\n\u2502 Gentoo \u2502 Biscoe \u2502 50.5 \u2502 15.9 \u2502 225.0 \u2502 5400.0 \u2502 male \u2502 2008 \u2502\r\n\u2502 Chinstrap \u2502 Dream \u2502 52.2 \u2502 18.8 \u2502 197.0 \u2502 3450.0 \u2502 male \u2502 2009 \u2502\r\n\u2502 Adelie \u2502 Dream \u2502 33.1 \u2502 16.1 \u2502 178.0 \u2502 2900.0 \u2502 female \u2502 2008 \u2502\r\n\u2502 Adelie \u2502 Torgersen \u2502 40.6 \u2502 19.0 \u2502 199.0 \u2502 4000.0 \u2502 male \u2502 2009 \u2502\r\n\u2502 Gentoo \u2502 Biscoe \u2502 50.1 \u2502 15.0 \u2502 225.0 \u2502 5000.0 \u2502 male \u2502 2008 \u2502\r\n\u2502 Gentoo \u2502 Biscoe \u2502 48.7 \u2502 14.1 \u2502 210.0 \u2502 4450.0 \u2502 female \u2502 2007 \u2502\r\n\u2502 Gentoo \u2502 Biscoe \u2502 45.0 \u2502 15.4 \u2502 220.0 \u2502 5050.0 \u2502 male \u2502 2008 \u2502\r\n\u2502 Gentoo \u2502 Biscoe \u2502 44.9 \u2502 13.8 \u2502 212.0 \u2502 4750.0 \u2502 female \u2502 2009 \u2502\r\n\u2502 Adelie \u2502 Dream \u2502 37.5 \u2502 18.5 \u2502 199.0 \u2502 4475.0 \u2502 male \u2502 2009 \u2502\r\n\u2502 Adelie \u2502 Dream \u2502 38.1 \u2502 17.6 \u2502 187.0 \u2502 3425.0 \u2502 female \u2502 2009 \u2502\r\n\u2502 \u2026 \u2502 \u2026 \u2502 \u2026 \u2502 \u2026 \u2502 \u2026 \u2502 \u2026 \u2502 \u2026 \u2502 \u2026 \u2502\r\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\r\n```\n\n### What version of ibis are you using?\n\nmain\n\n### What backend(s) are you using, if any?\n\nRisingWave\n\n### Relevant log output\n\n```sh\nn/a\n```\n\n\n### Code of Conduct\n\n- [X] I agree to follow this project's Code of Conduct\n", "before_files": [{"content": "\"\"\"Risingwave backend.\"\"\"\n\nfrom __future__ import annotations\n\nfrom functools import partial\nfrom itertools import repeat\nfrom operator import itemgetter\nfrom typing import TYPE_CHECKING\n\nimport psycopg2\nimport sqlglot as sg\nimport sqlglot.expressions as sge\nfrom psycopg2 import extras\n\nimport ibis\nimport ibis.common.exceptions as com\nimport ibis.expr.operations as ops\nimport ibis.expr.types as ir\nfrom ibis import util\nfrom ibis.backends.postgres import Backend as PostgresBackend\nfrom ibis.backends.risingwave.compiler import RisingwaveCompiler\nfrom ibis.util import experimental\n\nif TYPE_CHECKING:\n import pandas as pd\n import pyarrow as pa\n\n\ndef data_and_encode_format(data_format, encode_format, encode_properties):\n res = \"\"\n if data_format is not None:\n res = res + \" FORMAT \" + data_format.upper()\n if encode_format is not None:\n res = res + \" ENCODE \" + encode_format.upper()\n if encode_properties is not None:\n res = res + \" \" + format_properties(encode_properties)\n return res\n\n\ndef format_properties(props):\n tokens = []\n for k, v in props.items():\n tokens.append(f\"{k}='{v}'\")\n return \"( {} ) \".format(\", \".join(tokens))\n\n\nclass Backend(PostgresBackend):\n name = \"risingwave\"\n compiler = RisingwaveCompiler()\n supports_python_udfs = False\n\n def do_connect(\n self,\n host: str | None = None,\n user: str | None = None,\n password: str | None = None,\n port: int = 5432,\n database: str | None = None,\n schema: str | None = None,\n ) -> None:\n \"\"\"Create an Ibis client connected to RisingWave database.\n\n Parameters\n ----------\n host\n Hostname\n user\n Username\n password\n Password\n port\n Port number\n database\n Database to connect to\n schema\n RisingWave schema to use. If `None`, use the default `search_path`.\n\n Examples\n --------\n >>> import os\n >>> import getpass\n >>> import ibis\n >>> host = os.environ.get(\"IBIS_TEST_RISINGWAVE_HOST\", \"localhost\")\n >>> user = os.environ.get(\"IBIS_TEST_RISINGWAVE_USER\", getpass.getuser())\n >>> password = os.environ.get(\"IBIS_TEST_RISINGWAVE_PASSWORD\")\n >>> database = os.environ.get(\"IBIS_TEST_RISINGWAVE_DATABASE\", \"dev\")\n >>> con = connect(database=database, host=host, user=user, password=password)\n >>> con.list_tables() # doctest: +ELLIPSIS\n [...]\n >>> t = con.table(\"functional_alltypes\")\n >>> t\n RisingwaveTable[table]\n name: functional_alltypes\n schema:\n id : int32\n bool_col : boolean\n tinyint_col : int16\n smallint_col : int16\n int_col : int32\n bigint_col : int64\n float_col : float32\n double_col : float64\n date_string_col : string\n string_col : string\n timestamp_col : timestamp\n year : int32\n month : int32\n\n \"\"\"\n\n self.con = psycopg2.connect(\n host=host,\n port=port,\n user=user,\n password=password,\n database=database,\n options=(f\"-csearch_path={schema}\" * (schema is not None)) or None,\n )\n\n with self.begin() as cur:\n cur.execute(\"SET TIMEZONE = UTC\")\n\n def create_table(\n self,\n name: str,\n obj: pd.DataFrame | pa.Table | ir.Table | None = None,\n *,\n schema: ibis.Schema | None = None,\n database: str | None = None,\n temp: bool = False,\n overwrite: bool = False,\n # TODO(Kexiang): add `append only`\n connector_properties: dict | None = None,\n data_format: str | None = None,\n encode_format: str | None = None,\n encode_properties: dict | None = None,\n ):\n \"\"\"Create a table in Risingwave.\n\n Parameters\n ----------\n name\n Name of the table to create\n obj\n The data with which to populate the table; optional, but at least\n one of `obj` or `schema` must be specified\n schema\n The schema of the table to create; optional, but at least one of\n `obj` or `schema` must be specified\n database\n The name of the database in which to create the table; if not\n passed, the current database is used.\n temp\n Create a temporary table\n overwrite\n If `True`, replace the table if it already exists, otherwise fail\n if the table exists\n connector_properties\n The properties of the sink connector, providing the connector settings to push to the downstream data sink.\n Refer https://docs.risingwave.com/docs/current/data-delivery/ for the required properties of different data sink.\n data_format\n The data format for the new source, e.g., \"PLAIN\". data_format and encode_format must be specified at the same time.\n encode_format\n The encode format for the new source, e.g., \"JSON\". data_format and encode_format must be specified at the same time.\n encode_properties\n The properties of encode format, providing information like schema registry url. Refer https://docs.risingwave.com/docs/current/sql-create-source/ for more details.\n\n Returns\n -------\n Table\n Table expression\n \"\"\"\n if obj is None and schema is None:\n raise ValueError(\"Either `obj` or `schema` must be specified\")\n\n if connector_properties is not None and (\n encode_format is None or data_format is None\n ):\n raise com.UnsupportedOperationError(\n \"When creating tables with connector, both encode_format and data_format are required\"\n )\n\n properties = []\n\n if temp:\n raise com.UnsupportedOperationError(\n f\"Creating temp tables is not supported by {self.name}\"\n )\n\n if obj is not None:\n if not isinstance(obj, ir.Expr):\n table = ibis.memtable(obj)\n else:\n table = obj\n\n self._run_pre_execute_hooks(table)\n\n query = self._to_sqlglot(table)\n else:\n query = None\n\n column_defs = [\n sge.ColumnDef(\n this=sg.to_identifier(colname, quoted=self.compiler.quoted),\n kind=self.compiler.type_mapper.from_ibis(typ),\n constraints=(\n None\n if typ.nullable\n else [sge.ColumnConstraint(kind=sge.NotNullColumnConstraint())]\n ),\n )\n for colname, typ in (schema or table.schema()).items()\n ]\n\n if overwrite:\n temp_name = util.gen_name(f\"{self.name}_table\")\n else:\n temp_name = name\n\n table = sg.table(temp_name, db=database, quoted=self.compiler.quoted)\n target = sge.Schema(this=table, expressions=column_defs)\n\n if connector_properties is None:\n create_stmt = sge.Create(\n kind=\"TABLE\",\n this=target,\n properties=sge.Properties(expressions=properties),\n )\n else:\n create_stmt = sge.Create(\n kind=\"TABLE\",\n this=target,\n properties=sge.Properties(\n expressions=sge.Properties.from_dict(connector_properties)\n ),\n )\n create_stmt = create_stmt.sql(self.dialect) + data_and_encode_format(\n data_format, encode_format, encode_properties\n )\n\n this = sg.table(name, db=database, quoted=self.compiler.quoted)\n with self._safe_raw_sql(create_stmt) as cur:\n if query is not None:\n insert_stmt = sge.Insert(this=table, expression=query).sql(self.dialect)\n cur.execute(insert_stmt)\n\n if overwrite:\n self.drop_table(name, database=database, force=True)\n cur.execute(\n f\"ALTER TABLE {table.sql(self.dialect)} RENAME TO {this.sql(self.dialect)}\"\n )\n\n if schema is None:\n return self.table(name, database=database)\n\n # preserve the input schema if it was provided\n return ops.DatabaseTable(\n name, schema=schema, source=self, namespace=ops.Namespace(database=database)\n ).to_expr()\n\n def _register_in_memory_table(self, op: ops.InMemoryTable) -> None:\n schema = op.schema\n if null_columns := [col for col, dtype in schema.items() if dtype.is_null()]:\n raise com.IbisTypeError(\n f\"{self.name} cannot yet reliably handle `null` typed columns; \"\n f\"got null typed columns: {null_columns}\"\n )\n\n # only register if we haven't already done so\n if (name := op.name) not in self.list_tables():\n quoted = self.compiler.quoted\n column_defs = [\n sg.exp.ColumnDef(\n this=sg.to_identifier(colname, quoted=quoted),\n kind=self.compiler.type_mapper.from_ibis(typ),\n constraints=(\n None\n if typ.nullable\n else [\n sg.exp.ColumnConstraint(\n kind=sg.exp.NotNullColumnConstraint()\n )\n ]\n ),\n )\n for colname, typ in schema.items()\n ]\n\n create_stmt = sg.exp.Create(\n kind=\"TABLE\",\n this=sg.exp.Schema(\n this=sg.to_identifier(name, quoted=quoted), expressions=column_defs\n ),\n )\n create_stmt_sql = create_stmt.sql(self.dialect)\n\n columns = schema.keys()\n df = op.data.to_frame()\n data = df.itertuples(index=False)\n cols = \", \".join(\n ident.sql(self.dialect)\n for ident in map(partial(sg.to_identifier, quoted=quoted), columns)\n )\n specs = \", \".join(repeat(\"%s\", len(columns)))\n table = sg.table(name, quoted=quoted)\n sql = f\"INSERT INTO {table.sql(self.dialect)} ({cols}) VALUES ({specs})\"\n with self.begin() as cur:\n cur.execute(create_stmt_sql)\n extras.execute_batch(cur, sql, data, 128)\n\n def list_databases(\n self, *, like: str | None = None, catalog: str | None = None\n ) -> list[str]:\n dbs = \"SHOW SCHEMAS\"\n\n with self._safe_raw_sql(dbs) as cur:\n databases = list(map(itemgetter(0), cur))\n\n return self._filter_with_like(databases, like)\n\n @experimental\n def create_materialized_view(\n self,\n name: str,\n obj: ir.Table,\n *,\n database: str | None = None,\n overwrite: bool = False,\n ) -> ir.Table:\n \"\"\"Create a materialized view. Materialized views can be accessed like a normal table.\n\n Parameters\n ----------\n name\n Materialized view name to Create.\n obj\n The select statement to materialize.\n database\n Name of the database where the view exists, if not the default\n overwrite\n Whether to overwrite the existing materialized view with the same name\n\n Returns\n -------\n Table\n Table expression\n \"\"\"\n if overwrite:\n temp_name = util.gen_name(f\"{self.name}_table\")\n else:\n temp_name = name\n\n table = sg.table(temp_name, db=database, quoted=self.compiler.quoted)\n\n create_stmt = sge.Create(\n this=table,\n kind=\"MATERIALIZED VIEW\",\n expression=self.compile(obj),\n )\n self._register_in_memory_tables(obj)\n\n with self._safe_raw_sql(create_stmt) as cur:\n if overwrite:\n target = sg.table(name, db=database).sql(self.dialect)\n\n self.drop_materialized_view(target, database=database, force=True)\n\n cur.execute(\n f\"ALTER MATERIALIZED VIEW {table.sql(self.dialect)} RENAME TO {target}\"\n )\n\n return self.table(name, database=database)\n\n def drop_materialized_view(\n self,\n name: str,\n *,\n database: str | None = None,\n force: bool = False,\n ) -> None:\n \"\"\"Drop a materialized view.\n\n Parameters\n ----------\n name\n Materialized view name to drop.\n database\n Name of the database where the view exists, if not the default.\n force\n If `False`, an exception is raised if the view does not exist.\n \"\"\"\n src = sge.Drop(\n this=sg.table(name, db=database, quoted=self.compiler.quoted),\n kind=\"MATERIALIZED VIEW\",\n exists=force,\n )\n with self._safe_raw_sql(src):\n pass\n\n def create_source(\n self,\n name: str,\n schema: ibis.Schema,\n *,\n database: str | None = None,\n connector_properties: dict,\n data_format: str,\n encode_format: str,\n encode_properties: dict | None = None,\n ) -> ir.Table:\n \"\"\"Creating a source.\n\n Parameters\n ----------\n name\n Source name to Create.\n schema\n The schema for the new Source.\n database\n Name of the database where the source exists, if not the default.\n connector_properties\n The properties of the source connector, providing the connector settings to access the upstream data source.\n Refer https://docs.risingwave.com/docs/current/data-ingestion/ for the required properties of different data source.\n data_format\n The data format for the new source, e.g., \"PLAIN\". data_format and encode_format must be specified at the same time.\n encode_format\n The encode format for the new source, e.g., \"JSON\". data_format and encode_format must be specified at the same time.\n encode_properties\n The properties of encode format, providing information like schema registry url. Refer https://docs.risingwave.com/docs/current/sql-create-source/ for more details.\n\n Returns\n -------\n Table\n Table expression\n \"\"\"\n column_defs = [\n sge.ColumnDef(\n this=sg.to_identifier(colname, quoted=self.compiler.quoted),\n kind=self.compiler.type_mapper.from_ibis(typ),\n constraints=(\n None\n if typ.nullable\n else [sge.ColumnConstraint(kind=sge.NotNullColumnConstraint())]\n ),\n )\n for colname, typ in schema.items()\n ]\n\n table = sg.table(name, db=database, quoted=self.compiler.quoted)\n target = sge.Schema(this=table, expressions=column_defs)\n\n create_stmt = sge.Create(\n kind=\"SOURCE\",\n this=target,\n properties=sge.Properties(\n expressions=sge.Properties.from_dict(connector_properties)\n ),\n )\n\n create_stmt = create_stmt.sql(self.dialect) + data_and_encode_format(\n data_format, encode_format, encode_properties\n )\n\n with self._safe_raw_sql(create_stmt):\n pass\n\n return self.table(name, database=database)\n\n def drop_source(\n self,\n name: str,\n *,\n database: str | None = None,\n force: bool = False,\n ) -> None:\n \"\"\"Drop a Source.\n\n Parameters\n ----------\n name\n Source name to drop.\n database\n Name of the database where the view exists, if not the default.\n force\n If `False`, an exception is raised if the source does not exist.\n \"\"\"\n src = sge.Drop(\n this=sg.table(name, db=database, quoted=self.compiler.quoted),\n kind=\"SOURCE\",\n exists=force,\n )\n with self._safe_raw_sql(src):\n pass\n\n def create_sink(\n self,\n name: str,\n sink_from: str | None = None,\n connector_properties: dict | None = None,\n *,\n obj: ir.Table | None = None,\n database: str | None = None,\n data_format: str | None = None,\n encode_format: str | None = None,\n encode_properties: dict | None = None,\n ) -> None:\n \"\"\"Creating a sink.\n\n Parameters\n ----------\n name\n Sink name to Create.\n sink_from\n The table or materialized view name to sink from. Only one of `sink_from` or `obj` can be\n provided.\n connector_properties\n The properties of the sink connector, providing the connector settings to push to the downstream data sink.\n Refer https://docs.risingwave.com/docs/current/data-delivery/ for the required properties of different data sink.\n obj\n An Ibis table expression that will be used to extract the schema and the data of the new table. Only one of `sink_from` or `obj` can be provided.\n database\n Name of the database where the source exists, if not the default.\n data_format\n The data format for the new source, e.g., \"PLAIN\". data_format and encode_format must be specified at the same time.\n encode_format\n The encode format for the new source, e.g., \"JSON\". data_format and encode_format must be specified at the same time.\n encode_properties\n The properties of encode format, providing information like schema registry url. Refer https://docs.risingwave.com/docs/current/sql-create-source/ for more details.\n \"\"\"\n table = sg.table(name, db=database, quoted=self.compiler.quoted)\n if sink_from is None and obj is None:\n raise ValueError(\"Either `sink_from` or `obj` must be specified\")\n if sink_from is not None and obj is not None:\n raise ValueError(\"Only one of `sink_from` or `obj` can be specified\")\n\n if (encode_format is None) != (data_format is None):\n raise com.UnsupportedArgumentError(\n \"When creating sinks, both encode_format and data_format must be provided, or neither should be\"\n )\n\n if sink_from is not None:\n create_stmt = f\"CREATE SINK {table.sql(self.dialect)} FROM {sink_from}\"\n else:\n create_stmt = sge.Create(\n this=table,\n kind=\"SINK\",\n expression=self.compile(obj),\n ).sql(self.dialect)\n create_stmt = (\n create_stmt\n + \" WITH \"\n + format_properties(connector_properties)\n + data_and_encode_format(data_format, encode_format, encode_properties)\n )\n with self._safe_raw_sql(create_stmt):\n pass\n\n def drop_sink(\n self,\n name: str,\n *,\n database: str | None = None,\n force: bool = False,\n ) -> None:\n \"\"\"Drop a Sink.\n\n Parameters\n ----------\n name\n Sink name to drop.\n database\n Name of the database where the view exists, if not the default.\n force\n If `False`, an exception is raised if the source does not exist.\n \"\"\"\n src = sge.Drop(\n this=sg.table(name, db=database, quoted=self.compiler.quoted),\n kind=\"SINK\",\n exists=force,\n )\n with self._safe_raw_sql(src):\n pass\n", "path": "ibis/backends/risingwave/__init__.py"}], "after_files": [{"content": "\"\"\"Risingwave backend.\"\"\"\n\nfrom __future__ import annotations\n\nfrom functools import partial\nfrom itertools import repeat\nfrom operator import itemgetter\nfrom typing import TYPE_CHECKING\n\nimport psycopg2\nimport sqlglot as sg\nimport sqlglot.expressions as sge\nfrom psycopg2 import extras\n\nimport ibis\nimport ibis.common.exceptions as com\nimport ibis.expr.operations as ops\nimport ibis.expr.types as ir\nfrom ibis import util\nfrom ibis.backends.postgres import Backend as PostgresBackend\nfrom ibis.backends.risingwave.compiler import RisingwaveCompiler\nfrom ibis.util import experimental\n\nif TYPE_CHECKING:\n import pandas as pd\n import pyarrow as pa\n\n\ndef data_and_encode_format(data_format, encode_format, encode_properties):\n res = \"\"\n if data_format is not None:\n res = res + \" FORMAT \" + data_format.upper()\n if encode_format is not None:\n res = res + \" ENCODE \" + encode_format.upper()\n if encode_properties is not None:\n res = res + \" \" + format_properties(encode_properties)\n return res\n\n\ndef format_properties(props):\n tokens = []\n for k, v in props.items():\n tokens.append(f\"{k}='{v}'\")\n return \"( {} ) \".format(\", \".join(tokens))\n\n\nclass Backend(PostgresBackend):\n name = \"risingwave\"\n compiler = RisingwaveCompiler()\n supports_python_udfs = False\n\n def do_connect(\n self,\n host: str | None = None,\n user: str | None = None,\n password: str | None = None,\n port: int = 5432,\n database: str | None = None,\n schema: str | None = None,\n ) -> None:\n \"\"\"Create an Ibis client connected to RisingWave database.\n\n Parameters\n ----------\n host\n Hostname\n user\n Username\n password\n Password\n port\n Port number\n database\n Database to connect to\n schema\n RisingWave schema to use. If `None`, use the default `search_path`.\n\n Examples\n --------\n >>> import os\n >>> import getpass\n >>> import ibis\n >>> host = os.environ.get(\"IBIS_TEST_RISINGWAVE_HOST\", \"localhost\")\n >>> user = os.environ.get(\"IBIS_TEST_RISINGWAVE_USER\", getpass.getuser())\n >>> password = os.environ.get(\"IBIS_TEST_RISINGWAVE_PASSWORD\")\n >>> database = os.environ.get(\"IBIS_TEST_RISINGWAVE_DATABASE\", \"dev\")\n >>> con = connect(database=database, host=host, user=user, password=password)\n >>> con.list_tables() # doctest: +ELLIPSIS\n [...]\n >>> t = con.table(\"functional_alltypes\")\n >>> t\n RisingwaveTable[table]\n name: functional_alltypes\n schema:\n id : int32\n bool_col : boolean\n tinyint_col : int16\n smallint_col : int16\n int_col : int32\n bigint_col : int64\n float_col : float32\n double_col : float64\n date_string_col : string\n string_col : string\n timestamp_col : timestamp\n year : int32\n month : int32\n\n \"\"\"\n\n self.con = psycopg2.connect(\n host=host,\n port=port,\n user=user,\n password=password,\n database=database,\n options=(f\"-csearch_path={schema}\" * (schema is not None)) or None,\n )\n\n with self.begin() as cur:\n cur.execute(\"SET TIMEZONE = UTC\")\n cur.execute(\"SET RW_IMPLICIT_FLUSH TO true;\")\n\n def create_table(\n self,\n name: str,\n obj: pd.DataFrame | pa.Table | ir.Table | None = None,\n *,\n schema: ibis.Schema | None = None,\n database: str | None = None,\n temp: bool = False,\n overwrite: bool = False,\n # TODO(Kexiang): add `append only`\n connector_properties: dict | None = None,\n data_format: str | None = None,\n encode_format: str | None = None,\n encode_properties: dict | None = None,\n ):\n \"\"\"Create a table in Risingwave.\n\n Parameters\n ----------\n name\n Name of the table to create\n obj\n The data with which to populate the table; optional, but at least\n one of `obj` or `schema` must be specified\n schema\n The schema of the table to create; optional, but at least one of\n `obj` or `schema` must be specified\n database\n The name of the database in which to create the table; if not\n passed, the current database is used.\n temp\n Create a temporary table\n overwrite\n If `True`, replace the table if it already exists, otherwise fail\n if the table exists\n connector_properties\n The properties of the sink connector, providing the connector settings to push to the downstream data sink.\n Refer https://docs.risingwave.com/docs/current/data-delivery/ for the required properties of different data sink.\n data_format\n The data format for the new source, e.g., \"PLAIN\". data_format and encode_format must be specified at the same time.\n encode_format\n The encode format for the new source, e.g., \"JSON\". data_format and encode_format must be specified at the same time.\n encode_properties\n The properties of encode format, providing information like schema registry url. Refer https://docs.risingwave.com/docs/current/sql-create-source/ for more details.\n\n Returns\n -------\n Table\n Table expression\n \"\"\"\n if obj is None and schema is None:\n raise ValueError(\"Either `obj` or `schema` must be specified\")\n\n if connector_properties is not None and (\n encode_format is None or data_format is None\n ):\n raise com.UnsupportedOperationError(\n \"When creating tables with connector, both encode_format and data_format are required\"\n )\n\n properties = []\n\n if temp:\n raise com.UnsupportedOperationError(\n f\"Creating temp tables is not supported by {self.name}\"\n )\n\n if obj is not None:\n if not isinstance(obj, ir.Expr):\n table = ibis.memtable(obj)\n else:\n table = obj\n\n self._run_pre_execute_hooks(table)\n\n query = self._to_sqlglot(table)\n else:\n query = None\n\n column_defs = [\n sge.ColumnDef(\n this=sg.to_identifier(colname, quoted=self.compiler.quoted),\n kind=self.compiler.type_mapper.from_ibis(typ),\n constraints=(\n None\n if typ.nullable\n else [sge.ColumnConstraint(kind=sge.NotNullColumnConstraint())]\n ),\n )\n for colname, typ in (schema or table.schema()).items()\n ]\n\n if overwrite:\n temp_name = util.gen_name(f\"{self.name}_table\")\n else:\n temp_name = name\n\n table = sg.table(temp_name, db=database, quoted=self.compiler.quoted)\n target = sge.Schema(this=table, expressions=column_defs)\n\n if connector_properties is None:\n create_stmt = sge.Create(\n kind=\"TABLE\",\n this=target,\n properties=sge.Properties(expressions=properties),\n )\n else:\n create_stmt = sge.Create(\n kind=\"TABLE\",\n this=target,\n properties=sge.Properties(\n expressions=sge.Properties.from_dict(connector_properties)\n ),\n )\n create_stmt = create_stmt.sql(self.dialect) + data_and_encode_format(\n data_format, encode_format, encode_properties\n )\n\n this = sg.table(name, db=database, quoted=self.compiler.quoted)\n with self._safe_raw_sql(create_stmt) as cur:\n if query is not None:\n insert_stmt = sge.Insert(this=table, expression=query).sql(self.dialect)\n cur.execute(insert_stmt)\n\n if overwrite:\n self.drop_table(name, database=database, force=True)\n cur.execute(\n f\"ALTER TABLE {table.sql(self.dialect)} RENAME TO {this.sql(self.dialect)}\"\n )\n\n if schema is None:\n return self.table(name, database=database)\n\n # preserve the input schema if it was provided\n return ops.DatabaseTable(\n name, schema=schema, source=self, namespace=ops.Namespace(database=database)\n ).to_expr()\n\n def _register_in_memory_table(self, op: ops.InMemoryTable) -> None:\n schema = op.schema\n if null_columns := [col for col, dtype in schema.items() if dtype.is_null()]:\n raise com.IbisTypeError(\n f\"{self.name} cannot yet reliably handle `null` typed columns; \"\n f\"got null typed columns: {null_columns}\"\n )\n\n # only register if we haven't already done so\n if (name := op.name) not in self.list_tables():\n quoted = self.compiler.quoted\n column_defs = [\n sg.exp.ColumnDef(\n this=sg.to_identifier(colname, quoted=quoted),\n kind=self.compiler.type_mapper.from_ibis(typ),\n constraints=(\n None\n if typ.nullable\n else [\n sg.exp.ColumnConstraint(\n kind=sg.exp.NotNullColumnConstraint()\n )\n ]\n ),\n )\n for colname, typ in schema.items()\n ]\n\n create_stmt = sg.exp.Create(\n kind=\"TABLE\",\n this=sg.exp.Schema(\n this=sg.to_identifier(name, quoted=quoted), expressions=column_defs\n ),\n )\n create_stmt_sql = create_stmt.sql(self.dialect)\n\n columns = schema.keys()\n df = op.data.to_frame()\n data = df.itertuples(index=False)\n cols = \", \".join(\n ident.sql(self.dialect)\n for ident in map(partial(sg.to_identifier, quoted=quoted), columns)\n )\n specs = \", \".join(repeat(\"%s\", len(columns)))\n table = sg.table(name, quoted=quoted)\n sql = f\"INSERT INTO {table.sql(self.dialect)} ({cols}) VALUES ({specs})\"\n with self.begin() as cur:\n cur.execute(create_stmt_sql)\n extras.execute_batch(cur, sql, data, 128)\n\n def list_databases(\n self, *, like: str | None = None, catalog: str | None = None\n ) -> list[str]:\n dbs = \"SHOW SCHEMAS\"\n\n with self._safe_raw_sql(dbs) as cur:\n databases = list(map(itemgetter(0), cur))\n\n return self._filter_with_like(databases, like)\n\n @experimental\n def create_materialized_view(\n self,\n name: str,\n obj: ir.Table,\n *,\n database: str | None = None,\n overwrite: bool = False,\n ) -> ir.Table:\n \"\"\"Create a materialized view. Materialized views can be accessed like a normal table.\n\n Parameters\n ----------\n name\n Materialized view name to Create.\n obj\n The select statement to materialize.\n database\n Name of the database where the view exists, if not the default\n overwrite\n Whether to overwrite the existing materialized view with the same name\n\n Returns\n -------\n Table\n Table expression\n \"\"\"\n if overwrite:\n temp_name = util.gen_name(f\"{self.name}_table\")\n else:\n temp_name = name\n\n table = sg.table(temp_name, db=database, quoted=self.compiler.quoted)\n\n create_stmt = sge.Create(\n this=table,\n kind=\"MATERIALIZED VIEW\",\n expression=self.compile(obj),\n )\n self._register_in_memory_tables(obj)\n\n with self._safe_raw_sql(create_stmt) as cur:\n if overwrite:\n target = sg.table(name, db=database).sql(self.dialect)\n\n self.drop_materialized_view(target, database=database, force=True)\n\n cur.execute(\n f\"ALTER MATERIALIZED VIEW {table.sql(self.dialect)} RENAME TO {target}\"\n )\n\n return self.table(name, database=database)\n\n def drop_materialized_view(\n self,\n name: str,\n *,\n database: str | None = None,\n force: bool = False,\n ) -> None:\n \"\"\"Drop a materialized view.\n\n Parameters\n ----------\n name\n Materialized view name to drop.\n database\n Name of the database where the view exists, if not the default.\n force\n If `False`, an exception is raised if the view does not exist.\n \"\"\"\n src = sge.Drop(\n this=sg.table(name, db=database, quoted=self.compiler.quoted),\n kind=\"MATERIALIZED VIEW\",\n exists=force,\n )\n with self._safe_raw_sql(src):\n pass\n\n def create_source(\n self,\n name: str,\n schema: ibis.Schema,\n *,\n database: str | None = None,\n connector_properties: dict,\n data_format: str,\n encode_format: str,\n encode_properties: dict | None = None,\n ) -> ir.Table:\n \"\"\"Creating a source.\n\n Parameters\n ----------\n name\n Source name to Create.\n schema\n The schema for the new Source.\n database\n Name of the database where the source exists, if not the default.\n connector_properties\n The properties of the source connector, providing the connector settings to access the upstream data source.\n Refer https://docs.risingwave.com/docs/current/data-ingestion/ for the required properties of different data source.\n data_format\n The data format for the new source, e.g., \"PLAIN\". data_format and encode_format must be specified at the same time.\n encode_format\n The encode format for the new source, e.g., \"JSON\". data_format and encode_format must be specified at the same time.\n encode_properties\n The properties of encode format, providing information like schema registry url. Refer https://docs.risingwave.com/docs/current/sql-create-source/ for more details.\n\n Returns\n -------\n Table\n Table expression\n \"\"\"\n column_defs = [\n sge.ColumnDef(\n this=sg.to_identifier(colname, quoted=self.compiler.quoted),\n kind=self.compiler.type_mapper.from_ibis(typ),\n constraints=(\n None\n if typ.nullable\n else [sge.ColumnConstraint(kind=sge.NotNullColumnConstraint())]\n ),\n )\n for colname, typ in schema.items()\n ]\n\n table = sg.table(name, db=database, quoted=self.compiler.quoted)\n target = sge.Schema(this=table, expressions=column_defs)\n\n create_stmt = sge.Create(\n kind=\"SOURCE\",\n this=target,\n properties=sge.Properties(\n expressions=sge.Properties.from_dict(connector_properties)\n ),\n )\n\n create_stmt = create_stmt.sql(self.dialect) + data_and_encode_format(\n data_format, encode_format, encode_properties\n )\n\n with self._safe_raw_sql(create_stmt):\n pass\n\n return self.table(name, database=database)\n\n def drop_source(\n self,\n name: str,\n *,\n database: str | None = None,\n force: bool = False,\n ) -> None:\n \"\"\"Drop a Source.\n\n Parameters\n ----------\n name\n Source name to drop.\n database\n Name of the database where the view exists, if not the default.\n force\n If `False`, an exception is raised if the source does not exist.\n \"\"\"\n src = sge.Drop(\n this=sg.table(name, db=database, quoted=self.compiler.quoted),\n kind=\"SOURCE\",\n exists=force,\n )\n with self._safe_raw_sql(src):\n pass\n\n def create_sink(\n self,\n name: str,\n sink_from: str | None = None,\n connector_properties: dict | None = None,\n *,\n obj: ir.Table | None = None,\n database: str | None = None,\n data_format: str | None = None,\n encode_format: str | None = None,\n encode_properties: dict | None = None,\n ) -> None:\n \"\"\"Creating a sink.\n\n Parameters\n ----------\n name\n Sink name to Create.\n sink_from\n The table or materialized view name to sink from. Only one of `sink_from` or `obj` can be\n provided.\n connector_properties\n The properties of the sink connector, providing the connector settings to push to the downstream data sink.\n Refer https://docs.risingwave.com/docs/current/data-delivery/ for the required properties of different data sink.\n obj\n An Ibis table expression that will be used to extract the schema and the data of the new table. Only one of `sink_from` or `obj` can be provided.\n database\n Name of the database where the source exists, if not the default.\n data_format\n The data format for the new source, e.g., \"PLAIN\". data_format and encode_format must be specified at the same time.\n encode_format\n The encode format for the new source, e.g., \"JSON\". data_format and encode_format must be specified at the same time.\n encode_properties\n The properties of encode format, providing information like schema registry url. Refer https://docs.risingwave.com/docs/current/sql-create-source/ for more details.\n \"\"\"\n table = sg.table(name, db=database, quoted=self.compiler.quoted)\n if sink_from is None and obj is None:\n raise ValueError(\"Either `sink_from` or `obj` must be specified\")\n if sink_from is not None and obj is not None:\n raise ValueError(\"Only one of `sink_from` or `obj` can be specified\")\n\n if (encode_format is None) != (data_format is None):\n raise com.UnsupportedArgumentError(\n \"When creating sinks, both encode_format and data_format must be provided, or neither should be\"\n )\n\n if sink_from is not None:\n create_stmt = f\"CREATE SINK {table.sql(self.dialect)} FROM {sink_from}\"\n else:\n create_stmt = sge.Create(\n this=table,\n kind=\"SINK\",\n expression=self.compile(obj),\n ).sql(self.dialect)\n create_stmt = (\n create_stmt\n + \" WITH \"\n + format_properties(connector_properties)\n + data_and_encode_format(data_format, encode_format, encode_properties)\n )\n with self._safe_raw_sql(create_stmt):\n pass\n\n def drop_sink(\n self,\n name: str,\n *,\n database: str | None = None,\n force: bool = False,\n ) -> None:\n \"\"\"Drop a Sink.\n\n Parameters\n ----------\n name\n Sink name to drop.\n database\n Name of the database where the view exists, if not the default.\n force\n If `False`, an exception is raised if the source does not exist.\n \"\"\"\n src = sge.Drop(\n this=sg.table(name, db=database, quoted=self.compiler.quoted),\n kind=\"SINK\",\n exists=force,\n )\n with self._safe_raw_sql(src):\n pass\n", "path": "ibis/backends/risingwave/__init__.py"}]} |
gh_patches_debug_234 | rasdani/github-patches | git_diff | pymodbus-dev__pymodbus-411 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Use pycryptodome instead of pycrypto.
<!--
Please use the Pymodbus gitter channel at https://gitter.im/pymodbus_dev/Lobby or Stack Overflow(tag [pymodbus](https://stackoverflow.com/questions/tagged/pymodbus) for
support questions.
Before opening a new issue, make sure you do the following:
* check that your issue isn't already filed: https://github.com/riptideio/pymodbus/issues
* prepare a short, runnable example that reproduce the issue with the latest development version of Pymodbus
-->
### Versions
* Python: 2.7.12
* OS: Ubuntu 18.04
* Pymodbus: 2.1.0 [twisted]
* Modbus Hardware (if used):
### Pymodbus Specific
* Server: tcp - async
### Description
I am trying to use Mod bus server on TCP protocol, but when I installed pymodbus and I saw it's installed pycrypto, which is deprecated and dead software.
I already have installed pycryptodome in my application, which is a conflict with pycrypto,
we can't have both pycrypto and pycryptodome at the same time,
Can we have pymodbus[twisted] release which can use pycryptodome instead of pycrypto?
--- 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 """
3 Installs pymodbus using distutils
4
5 Run:
6 python setup.py install
7 to install the package from the source archive.
8
9 For information about setuptools
10 http://peak.telecommunity.com/DevCenter/setuptools#new-and-changed-setup-keywords
11 """
12
13 # --------------------------------------------------------------------------- #
14 # initialization
15 # --------------------------------------------------------------------------- #
16 try: # if not installed, install and proceed
17 from setuptools import setup, find_packages
18 except ImportError:
19 from ez_setup import use_setuptools
20 use_setuptools()
21 from setuptools import setup, find_packages
22
23 try:
24 from setup_commands import command_classes
25 except ImportError:
26 command_classes={}
27 from pymodbus import __version__, __author__, __maintainer__
28
29 with open('requirements.txt') as reqs:
30 install_requires = [
31 line for line in reqs.read().split('\n')
32 if (line and not line.startswith('--'))
33 ]
34 install_requires.append("pyserial >= 3.4")
35 # --------------------------------------------------------------------------- #
36 # configuration
37 # --------------------------------------------------------------------------- #
38 setup(
39 name="pymodbus",
40 version=__version__,
41 description="A fully featured modbus protocol stack in python",
42 long_description="""
43 Pymodbus aims to be a fully implemented modbus protocol stack
44 implemented using twisted/asyncio/tornado.
45 Its orignal goal was to allow simulation of thousands of modbus devices
46 on a single machine for monitoring software testing.
47 """,
48 classifiers=[
49 'Development Status :: 4 - Beta',
50 'Environment :: Console',
51 'Environment :: X11 Applications :: GTK',
52 'Framework :: Twisted',
53 'Intended Audience :: Developers',
54 'License :: OSI Approved :: BSD License',
55 'Operating System :: POSIX :: Linux',
56 'Operating System :: Unix',
57 'Programming Language :: Python',
58 'Topic :: System :: Networking',
59 'Topic :: Utilities'
60 ],
61 keywords='modbus, twisted, scada',
62 author=__author__,
63 author_email='[email protected]',
64 maintainer=__maintainer__,
65 maintainer_email='[email protected]',
66 url='https://github.com/riptideio/pymodbus/',
67 license='BSD',
68 packages=find_packages(exclude=['examples', 'test']),
69 exclude_package_data={'': ['examples', 'test', 'tools', 'doc']},
70 py_modules=['ez_setup'],
71 platforms=['Linux', 'Mac OS X', 'Win'],
72 include_package_data=True,
73 zip_safe=True,
74 install_requires=install_requires,
75 extras_require={
76 'quality': [
77 'coverage >= 3.5.3',
78 'nose >= 1.2.1',
79 'mock >= 1.0.0',
80 'pep8 >= 1.3.3'
81 ],
82 'documents': ['sphinx >= 1.1.3',
83 'sphinx_rtd_theme',
84 'humanfriendly'],
85 'twisted': [
86 'twisted >= 12.2.0',
87 'pyasn1 >= 0.1.4',
88 'pycrypto >= 2.6'
89 ],
90 'tornado': [
91 'tornado >= 4.5.3'
92 ],
93 'repl': [
94 'click>=6.7',
95 'prompt-toolkit==2.0.4',
96 'pygments==2.2.0'
97 ]
98 },
99 entry_points={
100 'console_scripts': ['pymodbus.console=pymodbus.repl.main:main'],
101 },
102 test_suite='nose.collector',
103 cmdclass=command_classes,
104 )
105
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/setup.py b/setup.py
--- a/setup.py
+++ b/setup.py
@@ -85,7 +85,6 @@
'twisted': [
'twisted >= 12.2.0',
'pyasn1 >= 0.1.4',
- 'pycrypto >= 2.6'
],
'tornado': [
'tornado >= 4.5.3'
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -85,7 +85,6 @@\n 'twisted': [\n 'twisted >= 12.2.0',\n 'pyasn1 >= 0.1.4',\n- 'pycrypto >= 2.6'\n ],\n 'tornado': [\n 'tornado >= 4.5.3'\n", "issue": "Use pycryptodome instead of pycrypto.\n<!--\r\nPlease use the Pymodbus gitter channel at https://gitter.im/pymodbus_dev/Lobby or Stack Overflow(tag [pymodbus](https://stackoverflow.com/questions/tagged/pymodbus) for\r\nsupport questions.\r\n\r\nBefore opening a new issue, make sure you do the following:\r\n * check that your issue isn't already filed: https://github.com/riptideio/pymodbus/issues\r\n * prepare a short, runnable example that reproduce the issue with the latest development version of Pymodbus\r\n-->\r\n\r\n### Versions\r\n\r\n* Python: 2.7.12\r\n* OS: Ubuntu 18.04\r\n* Pymodbus: 2.1.0 [twisted]\r\n* Modbus Hardware (if used): \r\n\r\n### Pymodbus Specific\r\n* Server: tcp - async\r\n\r\n### Description\r\n\r\nI am trying to use Mod bus server on TCP protocol, but when I installed pymodbus and I saw it's installed pycrypto, which is deprecated and dead software. \r\n\r\nI already have installed pycryptodome in my application, which is a conflict with pycrypto, \r\nwe can't have both pycrypto and pycryptodome at the same time,\r\n\r\nCan we have pymodbus[twisted] release which can use pycryptodome instead of pycrypto?\n", "before_files": [{"content": "#!/usr/bin/env python\n\"\"\"\nInstalls pymodbus using distutils\n\nRun:\n python setup.py install\nto install the package from the source archive.\n\nFor information about setuptools\nhttp://peak.telecommunity.com/DevCenter/setuptools#new-and-changed-setup-keywords\n\"\"\"\n\n# --------------------------------------------------------------------------- #\n# initialization\n# --------------------------------------------------------------------------- #\ntry: # if not installed, install and proceed\n from setuptools import setup, find_packages\nexcept ImportError:\n from ez_setup import use_setuptools\n use_setuptools()\n from setuptools import setup, find_packages\n\ntry:\n from setup_commands import command_classes\nexcept ImportError:\n command_classes={}\nfrom pymodbus import __version__, __author__, __maintainer__\n\nwith open('requirements.txt') as reqs:\n install_requires = [\n line for line in reqs.read().split('\\n')\n if (line and not line.startswith('--'))\n ]\n install_requires.append(\"pyserial >= 3.4\")\n# --------------------------------------------------------------------------- #\n# configuration\n# --------------------------------------------------------------------------- #\nsetup(\n name=\"pymodbus\",\n version=__version__,\n description=\"A fully featured modbus protocol stack in python\",\n long_description=\"\"\"\n Pymodbus aims to be a fully implemented modbus protocol stack \n implemented using twisted/asyncio/tornado. \n Its orignal goal was to allow simulation of thousands of modbus devices\n on a single machine for monitoring software testing.\n \"\"\",\n classifiers=[\n 'Development Status :: 4 - Beta',\n 'Environment :: Console',\n 'Environment :: X11 Applications :: GTK',\n 'Framework :: Twisted',\n 'Intended Audience :: Developers',\n 'License :: OSI Approved :: BSD License',\n 'Operating System :: POSIX :: Linux',\n 'Operating System :: Unix',\n 'Programming Language :: Python',\n 'Topic :: System :: Networking',\n 'Topic :: Utilities'\n ],\n keywords='modbus, twisted, scada',\n author=__author__,\n author_email='[email protected]',\n maintainer=__maintainer__,\n maintainer_email='[email protected]',\n url='https://github.com/riptideio/pymodbus/',\n license='BSD',\n packages=find_packages(exclude=['examples', 'test']),\n exclude_package_data={'': ['examples', 'test', 'tools', 'doc']},\n py_modules=['ez_setup'],\n platforms=['Linux', 'Mac OS X', 'Win'],\n include_package_data=True,\n zip_safe=True,\n install_requires=install_requires,\n extras_require={\n 'quality': [\n 'coverage >= 3.5.3',\n 'nose >= 1.2.1',\n 'mock >= 1.0.0',\n 'pep8 >= 1.3.3'\n ],\n 'documents': ['sphinx >= 1.1.3',\n 'sphinx_rtd_theme',\n 'humanfriendly'],\n 'twisted': [\n 'twisted >= 12.2.0',\n 'pyasn1 >= 0.1.4',\n 'pycrypto >= 2.6'\n ],\n 'tornado': [\n 'tornado >= 4.5.3'\n ],\n 'repl': [\n 'click>=6.7',\n 'prompt-toolkit==2.0.4',\n 'pygments==2.2.0'\n ]\n },\n entry_points={\n 'console_scripts': ['pymodbus.console=pymodbus.repl.main:main'],\n },\n test_suite='nose.collector',\n cmdclass=command_classes,\n)\n\n", "path": "setup.py"}], "after_files": [{"content": "#!/usr/bin/env python\n\"\"\"\nInstalls pymodbus using distutils\n\nRun:\n python setup.py install\nto install the package from the source archive.\n\nFor information about setuptools\nhttp://peak.telecommunity.com/DevCenter/setuptools#new-and-changed-setup-keywords\n\"\"\"\n\n# --------------------------------------------------------------------------- #\n# initialization\n# --------------------------------------------------------------------------- #\ntry: # if not installed, install and proceed\n from setuptools import setup, find_packages\nexcept ImportError:\n from ez_setup import use_setuptools\n use_setuptools()\n from setuptools import setup, find_packages\n\ntry:\n from setup_commands import command_classes\nexcept ImportError:\n command_classes={}\nfrom pymodbus import __version__, __author__, __maintainer__\n\nwith open('requirements.txt') as reqs:\n install_requires = [\n line for line in reqs.read().split('\\n')\n if (line and not line.startswith('--'))\n ]\n install_requires.append(\"pyserial >= 3.4\")\n# --------------------------------------------------------------------------- #\n# configuration\n# --------------------------------------------------------------------------- #\nsetup(\n name=\"pymodbus\",\n version=__version__,\n description=\"A fully featured modbus protocol stack in python\",\n long_description=\"\"\"\n Pymodbus aims to be a fully implemented modbus protocol stack \n implemented using twisted/asyncio/tornado. \n Its orignal goal was to allow simulation of thousands of modbus devices\n on a single machine for monitoring software testing.\n \"\"\",\n classifiers=[\n 'Development Status :: 4 - Beta',\n 'Environment :: Console',\n 'Environment :: X11 Applications :: GTK',\n 'Framework :: Twisted',\n 'Intended Audience :: Developers',\n 'License :: OSI Approved :: BSD License',\n 'Operating System :: POSIX :: Linux',\n 'Operating System :: Unix',\n 'Programming Language :: Python',\n 'Topic :: System :: Networking',\n 'Topic :: Utilities'\n ],\n keywords='modbus, twisted, scada',\n author=__author__,\n author_email='[email protected]',\n maintainer=__maintainer__,\n maintainer_email='[email protected]',\n url='https://github.com/riptideio/pymodbus/',\n license='BSD',\n packages=find_packages(exclude=['examples', 'test']),\n exclude_package_data={'': ['examples', 'test', 'tools', 'doc']},\n py_modules=['ez_setup'],\n platforms=['Linux', 'Mac OS X', 'Win'],\n include_package_data=True,\n zip_safe=True,\n install_requires=install_requires,\n extras_require={\n 'quality': [\n 'coverage >= 3.5.3',\n 'nose >= 1.2.1',\n 'mock >= 1.0.0',\n 'pep8 >= 1.3.3'\n ],\n 'documents': ['sphinx >= 1.1.3',\n 'sphinx_rtd_theme',\n 'humanfriendly'],\n 'twisted': [\n 'twisted >= 12.2.0',\n 'pyasn1 >= 0.1.4',\n ],\n 'tornado': [\n 'tornado >= 4.5.3'\n ],\n 'repl': [\n 'click>=6.7',\n 'prompt-toolkit==2.0.4',\n 'pygments==2.2.0'\n ]\n },\n entry_points={\n 'console_scripts': ['pymodbus.console=pymodbus.repl.main:main'],\n },\n test_suite='nose.collector',\n cmdclass=command_classes,\n)\n\n", "path": "setup.py"}]} |
gh_patches_debug_235 | rasdani/github-patches | git_diff | psychopy__psychopy-3812 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Feature request: Report the component name and routine of disabled components in Alert 4305
PsychoPy reports [an alert](https://psychopy.org/alerts/4305.html) when a component in the experiment is disabled. However, this alert doesn't tell you what component is disabled. It can be quite difficult to find the disabled component, aside from going through and manually checking every component. It would be a useful feature if this alert also included the name and routine of the disable component.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `psychopy/alerts/alerttools.py`
Content:
```
1 import ast
2 import re
3
4 from numpy import array
5 from esprima import parseScript
6
7 from psychopy.tools import monitorunittools
8 from psychopy.alerts._alerts import alert
9 from psychopy.visual.textbox2.fontmanager import FontManager
10
11 fontMGR = FontManager()
12
13 class TestWin(object):
14 """
15 Creates a false window with necessary attributes for converting component
16 Parameters to pixels.
17 """
18 def __init__(self, exp):
19 self.useRetina = True
20 self.exp = exp
21 self.monitor = self.exp.settings.monitor
22 winSize = self.exp.settings.params['Window size (pixels)'].val
23
24 if winSize and isinstance(winSize, str):
25 self.size = ast.literal_eval(winSize)
26 elif winSize and (isinstance(winSize, list) or isinstance(winSize, tuple)):
27 self.size = winSize
28 else:
29 self.size = (1024, 768)
30
31 def validDuration(t, hz, toleranceFrames=0.01):
32 """Test whether this is a possible time duration given the frame rate"""
33 # best not to use mod operator for floats. e.g. 0.5%0.01 gives 0.00999
34 # (due to a float round error?)
35 # nFrames = t*hz so test if round(nFrames)==nFrames but with a tolerance
36 nFrames = float(t) * hz # t might not be float if given as "0.5"?
37 return abs(nFrames - round(nFrames)) < toleranceFrames
38
39
40 def convertParamToPix(value, win, units):
41 """
42 Convert value to numpy array
43 Parameters
44 ----------
45 value : str, int, float, list, tuple
46 Parameter value to be converted to pixels
47 win : TestWin object
48 A false window with necessary attributes for converting component
49 parameters to pixels
50 units : str
51 Screen units
52
53 Returns
54 -------
55 numpy array
56 Parameter converted to pixels in numpy array
57 """
58 if isinstance(value, str):
59 value = array(ast.literal_eval(value))
60 else:
61 value = array(value)
62 return monitorunittools.convertToPix(value, array([0, 0]), units=units, win=win) * 2
63
64
65 def testFloat(val):
66 """
67 Test value for float.
68 Used to detect use of variables, strings and none types, which cannot be checked.
69 """
70 try:
71 return type(float(val)) == float
72 except Exception:
73 return False
74
75
76 def testSize(component, win, units):
77 """
78 Runs size testing for component
79
80 Parameters
81 ----------
82 component: Component
83 The component used for size testing
84 win : TestWin object
85 Used for testing component size in bounds
86 units : str`
87 Screen units
88 """
89 if 'size' not in component.params:
90 return
91
92 try:
93 size = convertParamToPix(component.params['size'].val, win, units)
94 except Exception: # Use of variables fails check
95 return
96
97 # Test X
98 if size[0] > win.size[0]:
99 alert(2115, component, {'dimension': 'X'})
100 # Test Y
101 if size[1] > win.size[1]:
102 alert(2115, component, {'dimension': 'Y'})
103
104 # Test if smaller than 1 pixel (X dimension)
105 if size[0] < 1:
106 alert(2120, component, {'dimension': 'X'})
107 # Test if smaller than 1 pixel (Y dimension)
108 if size[1] < 1:
109 alert(2120, component, {'dimension': 'Y'})
110
111 def testPos(component, win, units):
112 """
113 Runs position testing for component
114
115 Parameters
116 ----------
117 component: Component
118 The component used for size testing
119 win : TestWin object
120 Used for testing component position in bounds
121 units : str`
122 Screen units
123 """
124 if 'pos' not in component.params:
125 return
126
127 try:
128 pos = convertParamToPix(component.params['pos'].val, win, units)
129 except Exception: # Use of variables fails check
130 return
131
132 # Test X position
133 if abs(pos[0]) > win.size[0]:
134 alert(2155, component, {'dimension': 'X'})
135 # Test Y position
136 if abs(pos[1]) > win.size[1]:
137 alert(2155, component, {'dimension': 'Y'})
138
139 def testStartEndTiming(component):
140 """
141 Tests stimuli starts before end time.
142
143 Parameters
144 ----------
145 component: Component
146 The component used for size testing
147 """
148
149 if "startType" not in component.params or "stopType" not in component.params :
150 return
151
152 if (component.params['startType'] not in ["time (s)", "frame N"]
153 or component.params['stopType'] not in ["time (s)", "frame N"]):
154 return
155
156 start = {'type': component.params['startType'].val, 'val' : component.params['startVal'].val}
157 stop = {'type': component.params['stopType'].val, 'val' : component.params['stopVal'].val}
158
159 # Check for string / variable
160 if not all([testFloat(start['val']), testFloat(stop['val'])]):
161 return
162
163 if [start['type'], stop['type']] == ["time (s)", "time (s)"]:
164 if float(start['val']) > float(stop['val']):
165 alert(4105, component, {'type': 'time'})
166 if [start['type'], stop['type']] == ["frame N", "frame N"]:
167 if int(float(start['val'])) > int(float(stop['val'].strip())):
168 alert(4105, component, {'type': 'frame'})
169
170 def testAchievableVisualOnsetOffset(component):
171 """Test whether start and end times are less than 1 screen refresh.
172 """
173
174 if component.type not in ["Text", "Aperture", "Dots", "EnvGrating", "Form",
175 "Grating", "Image", "Movie", "NoiseStim", "Polygon"]:
176 return
177
178 if "startType" not in component.params or "stopType" not in component.params:
179 return
180
181 startVal = component.params['startVal'].val
182 stopVal = component.params['stopVal'].val
183
184 if testFloat(startVal):
185 if component.params['startType'] == "time (s)":
186 # Test times are greater than 1 screen refresh for 60Hz and 100Hz monitors
187 if not float.is_integer(float(startVal)) and float(startVal) < 1.0 / 60:
188 alert(3110, component, {'type': 'start', 'time': startVal, 'Hz': 60})
189 if not float.is_integer(float(startVal)) and float(startVal) < 1.0 / 100:
190 alert(3110, component, {'type': 'start', 'time': startVal, 'Hz': 100})
191
192 if testFloat(stopVal):
193 if component.params['stopType'] == "duration (s)":
194 # Test times are greater than 1 screen refresh for 60Hz and 100Hz monitors
195 if not float.is_integer(float(stopVal)) and float(stopVal) < 1.0 / 60:
196 alert(3110, component, {'type': 'stop', 'time': stopVal, 'Hz': 60})
197 if not float.is_integer(float(stopVal)) and float(stopVal) < 1.0 / 100:
198 alert(3110, component, {'type': 'stop', 'time': stopVal, 'Hz': 100})
199
200 def testValidVisualStimTiming(component):
201 """Test whether visual stimuli presented accurately for times requested,
202 relative to screen refresh rate of 60 and 100Hz monitors.
203 """
204 if component.type not in ["Text", "Aperture", "Dots", "EnvGrating", "Form",
205 "Grating", "Image", "Movie", "NoiseStim", "Polygon"]:
206 return
207
208 if "startType" not in component.params or "stopType" not in component.params:
209 return
210
211 # Check for string / variable
212 startVal = component.params['startVal'].val
213 stopVal = component.params['stopVal'].val
214
215 if testFloat(startVal):
216 if component.params['startType'] == "time (s)":
217 # Test times are valid multiples of screen refresh for 60Hz and 100Hz monitors
218 if not validDuration(startVal, 60):
219 alert(3115, component, {'type': 'start', 'time': startVal, 'Hz': 60})
220
221 if testFloat(stopVal):
222 if component.params['stopType'] == "duration (s)":
223 # Test times are valid multiples of screen refresh for 60Hz and 100Hz monitors
224 if not validDuration(stopVal, 60):
225 alert(3115, component, {'type': 'stop', 'time': stopVal, 'Hz': 60})
226
227 def testFramesAsInt(component):
228 """
229 Test whole numbers are used for frames.
230 """
231
232 if "startType" not in component.params or "stopType" not in component.params :
233 return
234
235 startVal = component.params['startVal'].val
236 stopVal = component.params['stopVal'].val
237
238 if testFloat(startVal):
239 if component.params['startType'] in ["frame N", "duration (frames)"]:
240 # Test frames are whole numbers
241 if not float.is_integer(float(startVal)):
242 alert(4115, component, {'type': 'start', 'frameType': component.params['startType']})
243
244 if testFloat(stopVal):
245 if component.params['stopType'] in ["frame N", "duration (frames)"]:
246 # Test frames are whole numbers
247 if not float.is_integer(float(stopVal)):
248 alert(4115, component, {'type': 'stop', 'frameType': component.params['stopType']})
249
250 def testDisabled(component):
251 """
252 Tests whether a component is enabled.
253
254 Parameters
255 ----------
256 component: Component
257 The component used for testing
258 """
259 if "disabled" not in component.params:
260 return
261
262 if component.params['disabled'].val:
263 alert(4305, component)
264
265 def testFont(component):
266 """
267 Tests whether font is stored locally or whether it needs to be retrieved from Google Fonts
268
269 Parameters
270 ----------
271 component: Component
272 The component used for testing
273 """
274 if 'font' in component.params:
275 fontInfo = fontMGR.getFontsMatching(component.params['font'].val, fallback=False)
276 if not fontInfo:
277 alert(4320, strFields={'param': component.params['font']})
278
279 def testDollarSyntax(component):
280 """
281 Tests that use of dollar signs in Builder components to denote literal interpretation are used correctly
282
283 Parameters
284 ----------
285 component: Component
286 The component used for testing
287 """
288 valid = {}
289 for (key, param) in component.params.items():
290 if not param.dollarSyntax()[0]:
291 alert(4315, strFields={'component': component, 'param': param})
292 return valid
293
294 def checkPythonSyntax(component, tab):
295 """
296 Checks each Python code component tabs for syntax errors.
297 Note, catalogue message is formatted using a dict that contains:
298 {
299 'codeTab': The code component tab as string,
300 'code': The code containing the error,
301 'lineNumber': The line number of error as string
302 }
303
304 Parameters
305 ----------
306 component: Component
307 The code component being tested
308 tab: str
309 The name of the code component tab being tested
310 """
311 try:
312 compile(str(component.params[tab].val), "path", 'exec')
313 except Exception as err:
314 strFields = {'codeTab': tab, 'lineNumber': err.lineno, 'code': err.text}
315 # Dont sent traceback because strFields gives better localisation of error
316 alert(4205, component, strFields)
317
318 def checkJavaScriptSyntax(component, tab):
319 """
320 Checks each JS code component tabs for syntax errors.
321 Note, catalogue message is formatted using a dict that contains:
322 {
323 'codeTab': The code component tab as string,
324 'lineNumber': The line number and error msg as string
325 }
326
327 Parameters
328 ----------
329 component: Component
330 The code component being tested
331 tab: str
332 The name of the code component tab being tested
333 """
334 try:
335 parseScript(str(component.params[tab].val))
336 except Exception as err:
337 strFields = {'codeTab': tab, 'lineNumber': err.message}
338 # Dont sent traceback because strFields gives better localisation of error
339 alert(4210, component, strFields)
340
```
--- 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/psychopy/alerts/alerttools.py b/psychopy/alerts/alerttools.py
--- a/psychopy/alerts/alerttools.py
+++ b/psychopy/alerts/alerttools.py
@@ -260,7 +260,7 @@
return
if component.params['disabled'].val:
- alert(4305, component)
+ alert(4305, component, strFields={'name': component.params['name']})
def testFont(component):
"""
| {"golden_diff": "diff --git a/psychopy/alerts/alerttools.py b/psychopy/alerts/alerttools.py\n--- a/psychopy/alerts/alerttools.py\n+++ b/psychopy/alerts/alerttools.py\n@@ -260,7 +260,7 @@\n return\n \n if component.params['disabled'].val:\n- alert(4305, component)\n+ alert(4305, component, strFields={'name': component.params['name']})\n \n def testFont(component):\n \"\"\"\n", "issue": "Feature request: Report the component name and routine of disabled components in Alert 4305\nPsychoPy reports [an alert](https://psychopy.org/alerts/4305.html) when a component in the experiment is disabled. However, this alert doesn't tell you what component is disabled. It can be quite difficult to find the disabled component, aside from going through and manually checking every component. It would be a useful feature if this alert also included the name and routine of the disable component.\n", "before_files": [{"content": "import ast\nimport re\n\nfrom numpy import array\nfrom esprima import parseScript\n\nfrom psychopy.tools import monitorunittools\nfrom psychopy.alerts._alerts import alert\nfrom psychopy.visual.textbox2.fontmanager import FontManager\n\nfontMGR = FontManager()\n\nclass TestWin(object):\n \"\"\"\n Creates a false window with necessary attributes for converting component\n Parameters to pixels.\n \"\"\"\n def __init__(self, exp):\n self.useRetina = True\n self.exp = exp\n self.monitor = self.exp.settings.monitor\n winSize = self.exp.settings.params['Window size (pixels)'].val\n\n if winSize and isinstance(winSize, str):\n self.size = ast.literal_eval(winSize)\n elif winSize and (isinstance(winSize, list) or isinstance(winSize, tuple)):\n self.size = winSize\n else:\n self.size = (1024, 768)\n\ndef validDuration(t, hz, toleranceFrames=0.01):\n \"\"\"Test whether this is a possible time duration given the frame rate\"\"\"\n # best not to use mod operator for floats. e.g. 0.5%0.01 gives 0.00999\n # (due to a float round error?)\n # nFrames = t*hz so test if round(nFrames)==nFrames but with a tolerance\n nFrames = float(t) * hz # t might not be float if given as \"0.5\"?\n return abs(nFrames - round(nFrames)) < toleranceFrames\n\n\ndef convertParamToPix(value, win, units):\n \"\"\"\n Convert value to numpy array\n Parameters\n ----------\n value : str, int, float, list, tuple\n Parameter value to be converted to pixels\n win : TestWin object\n A false window with necessary attributes for converting component\n parameters to pixels\n units : str\n Screen units\n\n Returns\n -------\n numpy array\n Parameter converted to pixels in numpy array\n \"\"\"\n if isinstance(value, str):\n value = array(ast.literal_eval(value))\n else:\n value = array(value)\n return monitorunittools.convertToPix(value, array([0, 0]), units=units, win=win) * 2\n\n\ndef testFloat(val):\n \"\"\"\n Test value for float.\n Used to detect use of variables, strings and none types, which cannot be checked.\n \"\"\"\n try:\n return type(float(val)) == float\n except Exception:\n return False\n\n\ndef testSize(component, win, units):\n \"\"\"\n Runs size testing for component\n\n Parameters\n ----------\n component: Component\n The component used for size testing\n win : TestWin object\n Used for testing component size in bounds\n units : str`\n Screen units\n \"\"\"\n if 'size' not in component.params:\n return\n\n try:\n size = convertParamToPix(component.params['size'].val, win, units)\n except Exception: # Use of variables fails check\n return\n\n # Test X\n if size[0] > win.size[0]:\n alert(2115, component, {'dimension': 'X'})\n # Test Y\n if size[1] > win.size[1]:\n alert(2115, component, {'dimension': 'Y'})\n\n # Test if smaller than 1 pixel (X dimension)\n if size[0] < 1:\n alert(2120, component, {'dimension': 'X'})\n # Test if smaller than 1 pixel (Y dimension)\n if size[1] < 1:\n alert(2120, component, {'dimension': 'Y'})\n\ndef testPos(component, win, units):\n \"\"\"\n Runs position testing for component\n\n Parameters\n ----------\n component: Component\n The component used for size testing\n win : TestWin object\n Used for testing component position in bounds\n units : str`\n Screen units\n \"\"\"\n if 'pos' not in component.params:\n return\n\n try:\n pos = convertParamToPix(component.params['pos'].val, win, units)\n except Exception: # Use of variables fails check\n return\n\n # Test X position\n if abs(pos[0]) > win.size[0]:\n alert(2155, component, {'dimension': 'X'})\n # Test Y position\n if abs(pos[1]) > win.size[1]:\n alert(2155, component, {'dimension': 'Y'})\n\ndef testStartEndTiming(component):\n \"\"\"\n Tests stimuli starts before end time.\n\n Parameters\n ----------\n component: Component\n The component used for size testing\n \"\"\"\n\n if \"startType\" not in component.params or \"stopType\" not in component.params :\n return\n\n if (component.params['startType'] not in [\"time (s)\", \"frame N\"]\n or component.params['stopType'] not in [\"time (s)\", \"frame N\"]):\n return\n\n start = {'type': component.params['startType'].val, 'val' : component.params['startVal'].val}\n stop = {'type': component.params['stopType'].val, 'val' : component.params['stopVal'].val}\n\n # Check for string / variable\n if not all([testFloat(start['val']), testFloat(stop['val'])]):\n return\n\n if [start['type'], stop['type']] == [\"time (s)\", \"time (s)\"]:\n if float(start['val']) > float(stop['val']):\n alert(4105, component, {'type': 'time'})\n if [start['type'], stop['type']] == [\"frame N\", \"frame N\"]:\n if int(float(start['val'])) > int(float(stop['val'].strip())):\n alert(4105, component, {'type': 'frame'})\n\ndef testAchievableVisualOnsetOffset(component):\n \"\"\"Test whether start and end times are less than 1 screen refresh.\n \"\"\"\n\n if component.type not in [\"Text\", \"Aperture\", \"Dots\", \"EnvGrating\", \"Form\",\n \"Grating\", \"Image\", \"Movie\", \"NoiseStim\", \"Polygon\"]:\n return\n\n if \"startType\" not in component.params or \"stopType\" not in component.params:\n return\n\n startVal = component.params['startVal'].val\n stopVal = component.params['stopVal'].val\n\n if testFloat(startVal):\n if component.params['startType'] == \"time (s)\":\n # Test times are greater than 1 screen refresh for 60Hz and 100Hz monitors\n if not float.is_integer(float(startVal)) and float(startVal) < 1.0 / 60:\n alert(3110, component, {'type': 'start', 'time': startVal, 'Hz': 60})\n if not float.is_integer(float(startVal)) and float(startVal) < 1.0 / 100:\n alert(3110, component, {'type': 'start', 'time': startVal, 'Hz': 100})\n\n if testFloat(stopVal):\n if component.params['stopType'] == \"duration (s)\":\n # Test times are greater than 1 screen refresh for 60Hz and 100Hz monitors\n if not float.is_integer(float(stopVal)) and float(stopVal) < 1.0 / 60:\n alert(3110, component, {'type': 'stop', 'time': stopVal, 'Hz': 60})\n if not float.is_integer(float(stopVal)) and float(stopVal) < 1.0 / 100:\n alert(3110, component, {'type': 'stop', 'time': stopVal, 'Hz': 100})\n\ndef testValidVisualStimTiming(component):\n \"\"\"Test whether visual stimuli presented accurately for times requested,\n relative to screen refresh rate of 60 and 100Hz monitors.\n \"\"\"\n if component.type not in [\"Text\", \"Aperture\", \"Dots\", \"EnvGrating\", \"Form\",\n \"Grating\", \"Image\", \"Movie\", \"NoiseStim\", \"Polygon\"]:\n return\n\n if \"startType\" not in component.params or \"stopType\" not in component.params:\n return\n\n # Check for string / variable\n startVal = component.params['startVal'].val\n stopVal = component.params['stopVal'].val\n\n if testFloat(startVal):\n if component.params['startType'] == \"time (s)\":\n # Test times are valid multiples of screen refresh for 60Hz and 100Hz monitors\n if not validDuration(startVal, 60):\n alert(3115, component, {'type': 'start', 'time': startVal, 'Hz': 60})\n\n if testFloat(stopVal):\n if component.params['stopType'] == \"duration (s)\":\n # Test times are valid multiples of screen refresh for 60Hz and 100Hz monitors\n if not validDuration(stopVal, 60):\n alert(3115, component, {'type': 'stop', 'time': stopVal, 'Hz': 60})\n\ndef testFramesAsInt(component):\n \"\"\"\n Test whole numbers are used for frames.\n \"\"\"\n\n if \"startType\" not in component.params or \"stopType\" not in component.params :\n return\n\n startVal = component.params['startVal'].val\n stopVal = component.params['stopVal'].val\n\n if testFloat(startVal):\n if component.params['startType'] in [\"frame N\", \"duration (frames)\"]:\n # Test frames are whole numbers\n if not float.is_integer(float(startVal)):\n alert(4115, component, {'type': 'start', 'frameType': component.params['startType']})\n\n if testFloat(stopVal):\n if component.params['stopType'] in [\"frame N\", \"duration (frames)\"]:\n # Test frames are whole numbers\n if not float.is_integer(float(stopVal)):\n alert(4115, component, {'type': 'stop', 'frameType': component.params['stopType']})\n\ndef testDisabled(component):\n \"\"\"\n Tests whether a component is enabled.\n\n Parameters\n ----------\n component: Component\n The component used for testing\n \"\"\"\n if \"disabled\" not in component.params:\n return\n\n if component.params['disabled'].val:\n alert(4305, component)\n\ndef testFont(component):\n \"\"\"\n Tests whether font is stored locally or whether it needs to be retrieved from Google Fonts\n\n Parameters\n ----------\n component: Component\n The component used for testing\n \"\"\"\n if 'font' in component.params:\n fontInfo = fontMGR.getFontsMatching(component.params['font'].val, fallback=False)\n if not fontInfo:\n alert(4320, strFields={'param': component.params['font']})\n\ndef testDollarSyntax(component):\n \"\"\"\n Tests that use of dollar signs in Builder components to denote literal interpretation are used correctly\n\n Parameters\n ----------\n component: Component\n The component used for testing\n \"\"\"\n valid = {}\n for (key, param) in component.params.items():\n if not param.dollarSyntax()[0]:\n alert(4315, strFields={'component': component, 'param': param})\n return valid\n\ndef checkPythonSyntax(component, tab):\n \"\"\"\n Checks each Python code component tabs for syntax errors.\n Note, catalogue message is formatted using a dict that contains:\n {\n 'codeTab': The code component tab as string,\n 'code': The code containing the error,\n 'lineNumber': The line number of error as string\n }\n\n Parameters\n ----------\n component: Component\n The code component being tested\n tab: str\n The name of the code component tab being tested\n \"\"\"\n try:\n compile(str(component.params[tab].val), \"path\", 'exec')\n except Exception as err:\n strFields = {'codeTab': tab, 'lineNumber': err.lineno, 'code': err.text}\n # Dont sent traceback because strFields gives better localisation of error\n alert(4205, component, strFields)\n\ndef checkJavaScriptSyntax(component, tab):\n \"\"\"\n Checks each JS code component tabs for syntax errors.\n Note, catalogue message is formatted using a dict that contains:\n {\n 'codeTab': The code component tab as string,\n 'lineNumber': The line number and error msg as string\n }\n\n Parameters\n ----------\n component: Component\n The code component being tested\n tab: str\n The name of the code component tab being tested\n \"\"\"\n try:\n parseScript(str(component.params[tab].val))\n except Exception as err:\n strFields = {'codeTab': tab, 'lineNumber': err.message}\n # Dont sent traceback because strFields gives better localisation of error\n alert(4210, component, strFields)\n", "path": "psychopy/alerts/alerttools.py"}], "after_files": [{"content": "import ast\nimport re\n\nfrom numpy import array\nfrom esprima import parseScript\n\nfrom psychopy.tools import monitorunittools\nfrom psychopy.alerts._alerts import alert\nfrom psychopy.visual.textbox2.fontmanager import FontManager\n\nfontMGR = FontManager()\n\nclass TestWin(object):\n \"\"\"\n Creates a false window with necessary attributes for converting component\n Parameters to pixels.\n \"\"\"\n def __init__(self, exp):\n self.useRetina = True\n self.exp = exp\n self.monitor = self.exp.settings.monitor\n winSize = self.exp.settings.params['Window size (pixels)'].val\n\n if winSize and isinstance(winSize, str):\n self.size = ast.literal_eval(winSize)\n elif winSize and (isinstance(winSize, list) or isinstance(winSize, tuple)):\n self.size = winSize\n else:\n self.size = (1024, 768)\n\ndef validDuration(t, hz, toleranceFrames=0.01):\n \"\"\"Test whether this is a possible time duration given the frame rate\"\"\"\n # best not to use mod operator for floats. e.g. 0.5%0.01 gives 0.00999\n # (due to a float round error?)\n # nFrames = t*hz so test if round(nFrames)==nFrames but with a tolerance\n nFrames = float(t) * hz # t might not be float if given as \"0.5\"?\n return abs(nFrames - round(nFrames)) < toleranceFrames\n\n\ndef convertParamToPix(value, win, units):\n \"\"\"\n Convert value to numpy array\n Parameters\n ----------\n value : str, int, float, list, tuple\n Parameter value to be converted to pixels\n win : TestWin object\n A false window with necessary attributes for converting component\n parameters to pixels\n units : str\n Screen units\n\n Returns\n -------\n numpy array\n Parameter converted to pixels in numpy array\n \"\"\"\n if isinstance(value, str):\n value = array(ast.literal_eval(value))\n else:\n value = array(value)\n return monitorunittools.convertToPix(value, array([0, 0]), units=units, win=win) * 2\n\n\ndef testFloat(val):\n \"\"\"\n Test value for float.\n Used to detect use of variables, strings and none types, which cannot be checked.\n \"\"\"\n try:\n return type(float(val)) == float\n except Exception:\n return False\n\n\ndef testSize(component, win, units):\n \"\"\"\n Runs size testing for component\n\n Parameters\n ----------\n component: Component\n The component used for size testing\n win : TestWin object\n Used for testing component size in bounds\n units : str`\n Screen units\n \"\"\"\n if 'size' not in component.params:\n return\n\n try:\n size = convertParamToPix(component.params['size'].val, win, units)\n except Exception: # Use of variables fails check\n return\n\n # Test X\n if size[0] > win.size[0]:\n alert(2115, component, {'dimension': 'X'})\n # Test Y\n if size[1] > win.size[1]:\n alert(2115, component, {'dimension': 'Y'})\n\n # Test if smaller than 1 pixel (X dimension)\n if size[0] < 1:\n alert(2120, component, {'dimension': 'X'})\n # Test if smaller than 1 pixel (Y dimension)\n if size[1] < 1:\n alert(2120, component, {'dimension': 'Y'})\n\ndef testPos(component, win, units):\n \"\"\"\n Runs position testing for component\n\n Parameters\n ----------\n component: Component\n The component used for size testing\n win : TestWin object\n Used for testing component position in bounds\n units : str`\n Screen units\n \"\"\"\n if 'pos' not in component.params:\n return\n\n try:\n pos = convertParamToPix(component.params['pos'].val, win, units)\n except Exception: # Use of variables fails check\n return\n\n # Test X position\n if abs(pos[0]) > win.size[0]:\n alert(2155, component, {'dimension': 'X'})\n # Test Y position\n if abs(pos[1]) > win.size[1]:\n alert(2155, component, {'dimension': 'Y'})\n\ndef testStartEndTiming(component):\n \"\"\"\n Tests stimuli starts before end time.\n\n Parameters\n ----------\n component: Component\n The component used for size testing\n \"\"\"\n\n if \"startType\" not in component.params or \"stopType\" not in component.params :\n return\n\n if (component.params['startType'] not in [\"time (s)\", \"frame N\"]\n or component.params['stopType'] not in [\"time (s)\", \"frame N\"]):\n return\n\n start = {'type': component.params['startType'].val, 'val' : component.params['startVal'].val}\n stop = {'type': component.params['stopType'].val, 'val' : component.params['stopVal'].val}\n\n # Check for string / variable\n if not all([testFloat(start['val']), testFloat(stop['val'])]):\n return\n\n if [start['type'], stop['type']] == [\"time (s)\", \"time (s)\"]:\n if float(start['val']) > float(stop['val']):\n alert(4105, component, {'type': 'time'})\n if [start['type'], stop['type']] == [\"frame N\", \"frame N\"]:\n if int(float(start['val'])) > int(float(stop['val'].strip())):\n alert(4105, component, {'type': 'frame'})\n\ndef testAchievableVisualOnsetOffset(component):\n \"\"\"Test whether start and end times are less than 1 screen refresh.\n \"\"\"\n\n if component.type not in [\"Text\", \"Aperture\", \"Dots\", \"EnvGrating\", \"Form\",\n \"Grating\", \"Image\", \"Movie\", \"NoiseStim\", \"Polygon\"]:\n return\n\n if \"startType\" not in component.params or \"stopType\" not in component.params:\n return\n\n startVal = component.params['startVal'].val\n stopVal = component.params['stopVal'].val\n\n if testFloat(startVal):\n if component.params['startType'] == \"time (s)\":\n # Test times are greater than 1 screen refresh for 60Hz and 100Hz monitors\n if not float.is_integer(float(startVal)) and float(startVal) < 1.0 / 60:\n alert(3110, component, {'type': 'start', 'time': startVal, 'Hz': 60})\n if not float.is_integer(float(startVal)) and float(startVal) < 1.0 / 100:\n alert(3110, component, {'type': 'start', 'time': startVal, 'Hz': 100})\n\n if testFloat(stopVal):\n if component.params['stopType'] == \"duration (s)\":\n # Test times are greater than 1 screen refresh for 60Hz and 100Hz monitors\n if not float.is_integer(float(stopVal)) and float(stopVal) < 1.0 / 60:\n alert(3110, component, {'type': 'stop', 'time': stopVal, 'Hz': 60})\n if not float.is_integer(float(stopVal)) and float(stopVal) < 1.0 / 100:\n alert(3110, component, {'type': 'stop', 'time': stopVal, 'Hz': 100})\n\ndef testValidVisualStimTiming(component):\n \"\"\"Test whether visual stimuli presented accurately for times requested,\n relative to screen refresh rate of 60 and 100Hz monitors.\n \"\"\"\n if component.type not in [\"Text\", \"Aperture\", \"Dots\", \"EnvGrating\", \"Form\",\n \"Grating\", \"Image\", \"Movie\", \"NoiseStim\", \"Polygon\"]:\n return\n\n if \"startType\" not in component.params or \"stopType\" not in component.params:\n return\n\n # Check for string / variable\n startVal = component.params['startVal'].val\n stopVal = component.params['stopVal'].val\n\n if testFloat(startVal):\n if component.params['startType'] == \"time (s)\":\n # Test times are valid multiples of screen refresh for 60Hz and 100Hz monitors\n if not validDuration(startVal, 60):\n alert(3115, component, {'type': 'start', 'time': startVal, 'Hz': 60})\n\n if testFloat(stopVal):\n if component.params['stopType'] == \"duration (s)\":\n # Test times are valid multiples of screen refresh for 60Hz and 100Hz monitors\n if not validDuration(stopVal, 60):\n alert(3115, component, {'type': 'stop', 'time': stopVal, 'Hz': 60})\n\ndef testFramesAsInt(component):\n \"\"\"\n Test whole numbers are used for frames.\n \"\"\"\n\n if \"startType\" not in component.params or \"stopType\" not in component.params :\n return\n\n startVal = component.params['startVal'].val\n stopVal = component.params['stopVal'].val\n\n if testFloat(startVal):\n if component.params['startType'] in [\"frame N\", \"duration (frames)\"]:\n # Test frames are whole numbers\n if not float.is_integer(float(startVal)):\n alert(4115, component, {'type': 'start', 'frameType': component.params['startType']})\n\n if testFloat(stopVal):\n if component.params['stopType'] in [\"frame N\", \"duration (frames)\"]:\n # Test frames are whole numbers\n if not float.is_integer(float(stopVal)):\n alert(4115, component, {'type': 'stop', 'frameType': component.params['stopType']})\n\ndef testDisabled(component):\n \"\"\"\n Tests whether a component is enabled.\n\n Parameters\n ----------\n component: Component\n The component used for testing\n \"\"\"\n if \"disabled\" not in component.params:\n return\n\n if component.params['disabled'].val:\n alert(4305, component, strFields={'name': component.params['name']})\n\ndef testFont(component):\n \"\"\"\n Tests whether font is stored locally or whether it needs to be retrieved from Google Fonts\n\n Parameters\n ----------\n component: Component\n The component used for testing\n \"\"\"\n if 'font' in component.params:\n fontInfo = fontMGR.getFontsMatching(component.params['font'].val, fallback=False)\n if not fontInfo:\n alert(4320, strFields={'param': component.params['font']})\n\ndef testDollarSyntax(component):\n \"\"\"\n Tests that use of dollar signs in Builder components to denote literal interpretation are used correctly\n\n Parameters\n ----------\n component: Component\n The component used for testing\n \"\"\"\n valid = {}\n for (key, param) in component.params.items():\n if not param.dollarSyntax()[0]:\n alert(4315, strFields={'component': component, 'param': param})\n return valid\n\ndef checkPythonSyntax(component, tab):\n \"\"\"\n Checks each Python code component tabs for syntax errors.\n Note, catalogue message is formatted using a dict that contains:\n {\n 'codeTab': The code component tab as string,\n 'code': The code containing the error,\n 'lineNumber': The line number of error as string\n }\n\n Parameters\n ----------\n component: Component\n The code component being tested\n tab: str\n The name of the code component tab being tested\n \"\"\"\n try:\n compile(str(component.params[tab].val), \"path\", 'exec')\n except Exception as err:\n strFields = {'codeTab': tab, 'lineNumber': err.lineno, 'code': err.text}\n # Dont sent traceback because strFields gives better localisation of error\n alert(4205, component, strFields)\n\ndef checkJavaScriptSyntax(component, tab):\n \"\"\"\n Checks each JS code component tabs for syntax errors.\n Note, catalogue message is formatted using a dict that contains:\n {\n 'codeTab': The code component tab as string,\n 'lineNumber': The line number and error msg as string\n }\n\n Parameters\n ----------\n component: Component\n The code component being tested\n tab: str\n The name of the code component tab being tested\n \"\"\"\n try:\n parseScript(str(component.params[tab].val))\n except Exception as err:\n strFields = {'codeTab': tab, 'lineNumber': err.message}\n # Dont sent traceback because strFields gives better localisation of error\n alert(4210, component, strFields)\n", "path": "psychopy/alerts/alerttools.py"}]} |
gh_patches_debug_236 | rasdani/github-patches | git_diff | cython__cython-4942 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[BUG] Annotated attributes of cclass are not supporting pointers
<!--
**PLEASE READ THIS FIRST:**
- Do not use the bug and feature tracker for support requests. Use the `cython-users` mailing list instead.
- Did you search for similar issues already? Please do, it helps to save us precious time that we otherwise could not invest into development.
- Did you try the latest master branch or pre-release? It might already have what you want to report. Also see the [Changelog](https://github.com/cython/cython/blob/master/CHANGES.rst) regarding recent changes.
-->
**Describe the bug**
The compilation is failing, when attribute of cclass is declared using annotated type containing pointer.
**To Reproduce**
Following code:
```python
import cython
@cython.cclass
class Foo:
a: cython.pointer(cython.int)
def bar(self):
self.a = cython.NULL
```
fails during compilation with error:
```
$ cython -3 test.py
Error compiling Cython file:
------------------------------------------------------------
...
@cython.cclass
class Foo:
a: cython.pointer(cython.int)
def bar(self):
self.a = cython.NULL
^
------------------------------------------------------------
test.py:8:23: Cannot convert 'void *' to Python object
```
**Expected behavior**
Compilation should be successfull.
**Environment (please complete the following information):**
- OS: Linux
- Python version: Python 3.9.2
- Cython version: master
**Additional context**
When `declare()` statement or `cython.p_int` type is used, compilation is successful:
```python
import cython
@cython.cclass
class Foo:
a = cython.declare(cython.pointer(cython.int))
def bar(self):
self.a = cython.NULL
```
```python
import cython
@cython.cclass
class Foo:
a: cython.p_int
def bar(self):
self.a = cython.NULL
```
--- 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/examples/tutorial/clibraries/queue.py`
Content:
```
1 from cython.cimports import cqueue
2
3 @cython.cclass
4 class Queue:
5 _c_queue = cython.declare(cython.pointer(cqueue.Queue))
6
7 def __cinit__(self):
8 self._c_queue = cqueue.queue_new()
9
```
--- 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/examples/tutorial/clibraries/queue.py b/docs/examples/tutorial/clibraries/queue.py
--- a/docs/examples/tutorial/clibraries/queue.py
+++ b/docs/examples/tutorial/clibraries/queue.py
@@ -2,7 +2,7 @@
@cython.cclass
class Queue:
- _c_queue = cython.declare(cython.pointer(cqueue.Queue))
+ _c_queue: cython.pointer(cqueue.Queue)
def __cinit__(self):
self._c_queue = cqueue.queue_new()
| {"golden_diff": "diff --git a/docs/examples/tutorial/clibraries/queue.py b/docs/examples/tutorial/clibraries/queue.py\n--- a/docs/examples/tutorial/clibraries/queue.py\n+++ b/docs/examples/tutorial/clibraries/queue.py\n@@ -2,7 +2,7 @@\n \n @cython.cclass\n class Queue:\n- _c_queue = cython.declare(cython.pointer(cqueue.Queue))\n+ _c_queue: cython.pointer(cqueue.Queue)\n \n def __cinit__(self):\n self._c_queue = cqueue.queue_new()\n", "issue": "[BUG] Annotated attributes of cclass are not supporting pointers\n<!--\r\n**PLEASE READ THIS FIRST:**\r\n- Do not use the bug and feature tracker for support requests. Use the `cython-users` mailing list instead.\r\n- Did you search for similar issues already? Please do, it helps to save us precious time that we otherwise could not invest into development.\r\n- Did you try the latest master branch or pre-release? It might already have what you want to report. Also see the [Changelog](https://github.com/cython/cython/blob/master/CHANGES.rst) regarding recent changes.\r\n-->\r\n\r\n**Describe the bug**\r\nThe compilation is failing, when attribute of cclass is declared using annotated type containing pointer.\r\n\r\n**To Reproduce**\r\nFollowing code:\r\n```python\r\nimport cython\r\n\r\[email protected]\r\nclass Foo:\r\n a: cython.pointer(cython.int)\r\n\r\n def bar(self):\r\n self.a = cython.NULL\r\n```\r\nfails during compilation with error:\r\n```\r\n$ cython -3 test.py\r\n\r\nError compiling Cython file:\r\n------------------------------------------------------------\r\n...\r\[email protected]\r\nclass Foo:\r\n a: cython.pointer(cython.int)\r\n\r\n def bar(self):\r\n self.a = cython.NULL\r\n ^\r\n------------------------------------------------------------\r\n\r\ntest.py:8:23: Cannot convert 'void *' to Python object\r\n```\r\n\r\n**Expected behavior**\r\nCompilation should be successfull.\r\n\r\n**Environment (please complete the following information):**\r\n - OS: Linux\r\n - Python version: Python 3.9.2\r\n - Cython version: master\r\n\r\n**Additional context**\r\nWhen `declare()` statement or `cython.p_int` type is used, compilation is successful:\r\n\r\n```python\r\nimport cython\r\n\r\[email protected]\r\nclass Foo:\r\n a = cython.declare(cython.pointer(cython.int))\r\n\r\n def bar(self):\r\n self.a = cython.NULL\r\n```\r\n\r\n```python\r\nimport cython\r\n\r\[email protected]\r\nclass Foo:\r\n a: cython.p_int\r\n\r\n def bar(self):\r\n self.a = cython.NULL\r\n```\r\n\n", "before_files": [{"content": "from cython.cimports import cqueue\n\[email protected]\nclass Queue:\n _c_queue = cython.declare(cython.pointer(cqueue.Queue))\n\n def __cinit__(self):\n self._c_queue = cqueue.queue_new()\n", "path": "docs/examples/tutorial/clibraries/queue.py"}], "after_files": [{"content": "from cython.cimports import cqueue\n\[email protected]\nclass Queue:\n _c_queue: cython.pointer(cqueue.Queue)\n\n def __cinit__(self):\n self._c_queue = cqueue.queue_new()\n", "path": "docs/examples/tutorial/clibraries/queue.py"}]} |
gh_patches_debug_237 | rasdani/github-patches | git_diff | kornia__kornia-1861 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Bugs when using RandomRGBShift
### Describe the bug
When running RandomRGBShift augmentation on gpus I came across this error
```
File "/usr/local/lib/python3.8/dist-packages/kornia/augmentation/_2d/intensity/random_rgb_shift.py", line 100, in apply_transform
return shift_rgb(inp, params['r_shift'], params['g_shift'], params['b_shift'])
File "/usr/local/lib/python3.8/dist-packages/kornia/enhance/shift_rgb.py", line 17, in shift_rgb
shifted = (image + torch.Tensor(shifts).view(1, 3, 1, 1).to(image)).clamp_(min=0, max=1)
ValueError: only one element tensors can be converted to Python scalars
```
after checking the code I think the problem is that
```
shifts = [params['r_shift'], params['g_shift'], params['b_shift']]
shifted = (image + torch.Tensor(shifts).view(1, 3, 1, 1).to(image)).clamp_(min=0, max=1)
```
and also I am not sure about `.view(1,3,1,1)` shouldn't it be `.view(-1,3,1,1)`
### Reproduction steps
```bash
1. setting up RandomRGBShift augmentation
2. Using RandomRGBShift augmentation with gpus and batchsize > 1
```
### Expected behavior
```
File "/usr/local/lib/python3.8/dist-packages/kornia/augmentation/_2d/intensity/random_rgb_shift.py", line 100, in apply_transform
return shift_rgb(inp, params['r_shift'], params['g_shift'], params['b_shift'])
File "/usr/local/lib/python3.8/dist-packages/kornia/enhance/shift_rgb.py", line 17, in shift_rgb
shifted = (image + torch.Tensor(shifts).view(1, 3, 1, 1).to(image)).clamp_(min=0, max=1)
ValueError: only one element tensors can be converted to Python scalars
```
### Environment
```shell
- PyTorch Version : 1.10
- Linux
- How you installed PyTorch (`pip`):
- Python version: 3.8
- cuda:11.3.0-cudnn8
```
### 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: `kornia/enhance/shift_rgb.py`
Content:
```
1 import torch
2
3 from kornia.testing import KORNIA_CHECK_IS_COLOR, KORNIA_CHECK_IS_TENSOR
4
5
6 def shift_rgb(image: torch.Tensor, r_shift: torch.Tensor, g_shift: torch.Tensor, b_shift: torch.Tensor) -> torch.Tensor:
7 """Shift rgb channels.
8
9 Shift each image's channel by either r_shift for red, g_shift for green and b_shift for blue channels.
10 """
11
12 KORNIA_CHECK_IS_TENSOR(image)
13 KORNIA_CHECK_IS_COLOR(image, f"with shape {image.shape}")
14
15 shifts = [r_shift, g_shift, b_shift]
16
17 shifted = (image + torch.Tensor(shifts).view(1, 3, 1, 1).to(image)).clamp_(min=0, max=1)
18
19 return shifted
20
```
--- 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/kornia/enhance/shift_rgb.py b/kornia/enhance/shift_rgb.py
--- a/kornia/enhance/shift_rgb.py
+++ b/kornia/enhance/shift_rgb.py
@@ -14,6 +14,6 @@
shifts = [r_shift, g_shift, b_shift]
- shifted = (image + torch.Tensor(shifts).view(1, 3, 1, 1).to(image)).clamp_(min=0, max=1)
+ shifted = (image + torch.stack(shifts).view(-1, 3, 1, 1).to(image)).clamp_(min=0, max=1)
return shifted
| {"golden_diff": "diff --git a/kornia/enhance/shift_rgb.py b/kornia/enhance/shift_rgb.py\n--- a/kornia/enhance/shift_rgb.py\n+++ b/kornia/enhance/shift_rgb.py\n@@ -14,6 +14,6 @@\n \n shifts = [r_shift, g_shift, b_shift]\n \n- shifted = (image + torch.Tensor(shifts).view(1, 3, 1, 1).to(image)).clamp_(min=0, max=1)\n+ shifted = (image + torch.stack(shifts).view(-1, 3, 1, 1).to(image)).clamp_(min=0, max=1)\n \n return shifted\n", "issue": "Bugs when using RandomRGBShift\n### Describe the bug\r\n\r\nWhen running RandomRGBShift augmentation on gpus I came across this error \r\n\r\n```\r\n File \"/usr/local/lib/python3.8/dist-packages/kornia/augmentation/_2d/intensity/random_rgb_shift.py\", line 100, in apply_transform\r\n return shift_rgb(inp, params['r_shift'], params['g_shift'], params['b_shift'])\r\n File \"/usr/local/lib/python3.8/dist-packages/kornia/enhance/shift_rgb.py\", line 17, in shift_rgb\r\n shifted = (image + torch.Tensor(shifts).view(1, 3, 1, 1).to(image)).clamp_(min=0, max=1)\r\nValueError: only one element tensors can be converted to Python scalars\r\n```\r\nafter checking the code I think the problem is that \r\n```\r\nshifts = [params['r_shift'], params['g_shift'], params['b_shift']]\r\nshifted = (image + torch.Tensor(shifts).view(1, 3, 1, 1).to(image)).clamp_(min=0, max=1)\r\n```\r\nand also I am not sure about `.view(1,3,1,1)` shouldn't it be `.view(-1,3,1,1)`\r\n\r\n### Reproduction steps\r\n\r\n```bash\r\n1. setting up RandomRGBShift augmentation\r\n2. Using RandomRGBShift augmentation with gpus and batchsize > 1\r\n```\r\n\r\n\r\n### Expected behavior\r\n\r\n```\r\n File \"/usr/local/lib/python3.8/dist-packages/kornia/augmentation/_2d/intensity/random_rgb_shift.py\", line 100, in apply_transform\r\n return shift_rgb(inp, params['r_shift'], params['g_shift'], params['b_shift'])\r\n File \"/usr/local/lib/python3.8/dist-packages/kornia/enhance/shift_rgb.py\", line 17, in shift_rgb\r\n shifted = (image + torch.Tensor(shifts).view(1, 3, 1, 1).to(image)).clamp_(min=0, max=1)\r\nValueError: only one element tensors can be converted to Python scalars\r\n```\r\n\r\n### Environment\r\n\r\n```shell\r\n- PyTorch Version : 1.10\r\n- Linux\r\n- How you installed PyTorch (`pip`):\r\n- Python version: 3.8\r\n- cuda:11.3.0-cudnn8\r\n```\r\n\r\n\r\n### Additional context\r\n\r\n_No response_\n", "before_files": [{"content": "import torch\n\nfrom kornia.testing import KORNIA_CHECK_IS_COLOR, KORNIA_CHECK_IS_TENSOR\n\n\ndef shift_rgb(image: torch.Tensor, r_shift: torch.Tensor, g_shift: torch.Tensor, b_shift: torch.Tensor) -> torch.Tensor:\n \"\"\"Shift rgb channels.\n\n Shift each image's channel by either r_shift for red, g_shift for green and b_shift for blue channels.\n \"\"\"\n\n KORNIA_CHECK_IS_TENSOR(image)\n KORNIA_CHECK_IS_COLOR(image, f\"with shape {image.shape}\")\n\n shifts = [r_shift, g_shift, b_shift]\n\n shifted = (image + torch.Tensor(shifts).view(1, 3, 1, 1).to(image)).clamp_(min=0, max=1)\n\n return shifted\n", "path": "kornia/enhance/shift_rgb.py"}], "after_files": [{"content": "import torch\n\nfrom kornia.testing import KORNIA_CHECK_IS_COLOR, KORNIA_CHECK_IS_TENSOR\n\n\ndef shift_rgb(image: torch.Tensor, r_shift: torch.Tensor, g_shift: torch.Tensor, b_shift: torch.Tensor) -> torch.Tensor:\n \"\"\"Shift rgb channels.\n\n Shift each image's channel by either r_shift for red, g_shift for green and b_shift for blue channels.\n \"\"\"\n\n KORNIA_CHECK_IS_TENSOR(image)\n KORNIA_CHECK_IS_COLOR(image, f\"with shape {image.shape}\")\n\n shifts = [r_shift, g_shift, b_shift]\n\n shifted = (image + torch.stack(shifts).view(-1, 3, 1, 1).to(image)).clamp_(min=0, max=1)\n\n return shifted\n", "path": "kornia/enhance/shift_rgb.py"}]} |
gh_patches_debug_238 | rasdani/github-patches | git_diff | mkdocs__mkdocs-1329 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Provide length of TableOfContents
Currently, you can only iter over `TableOfContents`. I would like to know the length of 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: `mkdocs/toc.py`
Content:
```
1 # coding: utf-8
2
3 """
4 Deals with generating the per-page table of contents.
5
6 For the sake of simplicity we use an existing markdown extension to generate
7 an HTML table of contents, and then parse that into the underlying data.
8
9 The steps we take to generate a table of contents are:
10
11 * Pre-process the markdown, injecting a [TOC] marker.
12 * Generate HTML from markdown.
13 * Post-process the HTML, spliting the content and the table of contents.
14 * Parse table of contents HTML into the underlying data structure.
15 """
16
17 from __future__ import unicode_literals
18
19 try: # pragma: no cover
20 from html.parser import HTMLParser # noqa
21 except ImportError: # pragma: no cover
22 from HTMLParser import HTMLParser # noqa
23
24
25 class TableOfContents(object):
26 """
27 Represents the table of contents for a given page.
28 """
29 def __init__(self, html):
30 self.items = _parse_html_table_of_contents(html)
31
32 def __iter__(self):
33 return iter(self.items)
34
35 def __str__(self):
36 return ''.join([str(item) for item in self])
37
38
39 class AnchorLink(object):
40 """
41 A single entry in the table of contents.
42 """
43 def __init__(self, title, url):
44 self.title, self.url = title, url
45 self.children = []
46
47 def __str__(self):
48 return self.indent_print()
49
50 def indent_print(self, depth=0):
51 indent = ' ' * depth
52 ret = '%s%s - %s\n' % (indent, self.title, self.url)
53 for item in self.children:
54 ret += item.indent_print(depth + 1)
55 return ret
56
57
58 class TOCParser(HTMLParser):
59
60 def __init__(self):
61 HTMLParser.__init__(self)
62 self.links = []
63
64 self.in_anchor = False
65 self.attrs = None
66 self.title = ''
67
68 # Prior to Python3.4 no convert_charrefs keyword existed.
69 # However, in Python3.5 the default was changed to True.
70 # We need the False behavior in all versions but can only
71 # set it if it exists.
72 if hasattr(self, 'convert_charrefs'):
73 self.convert_charrefs = False
74
75 def handle_starttag(self, tag, attrs):
76
77 if not self.in_anchor:
78 if tag == 'a':
79 self.in_anchor = True
80 self.attrs = dict(attrs)
81
82 def handle_endtag(self, tag):
83 if tag == 'a':
84 self.in_anchor = False
85
86 def handle_data(self, data):
87
88 if self.in_anchor:
89 self.title += data
90
91 def handle_charref(self, ref):
92 self.handle_entityref("#" + ref)
93
94 def handle_entityref(self, ref):
95 self.handle_data("&%s;" % ref)
96
97
98 def _parse_html_table_of_contents(html):
99 """
100 Given a table of contents string that has been automatically generated by
101 the markdown library, parse it into a tree of AnchorLink instances.
102
103 Returns a list of all the parent AnchorLink instances.
104 """
105 lines = html.splitlines()[2:-2]
106 parents = []
107 ret = []
108 for line in lines:
109 parser = TOCParser()
110 parser.feed(line)
111 if parser.title:
112 try:
113 href = parser.attrs['href']
114 except KeyError:
115 continue
116 title = parser.title
117 nav = AnchorLink(title, href)
118 # Add the item to its parent if required. If it is a topmost
119 # item then instead append it to our return value.
120 if parents:
121 parents[-1].children.append(nav)
122 else:
123 ret.append(nav)
124 # If this item has children, store it as the current parent
125 if line.endswith('<ul>'):
126 parents.append(nav)
127 elif line.startswith('</ul>'):
128 if parents:
129 parents.pop()
130
131 # For the table of contents, always mark the first element as active
132 if ret:
133 ret[0].active = True
134
135 return ret
136
```
--- 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/mkdocs/toc.py b/mkdocs/toc.py
--- a/mkdocs/toc.py
+++ b/mkdocs/toc.py
@@ -32,6 +32,9 @@
def __iter__(self):
return iter(self.items)
+ def __len__(self):
+ return len(self.items)
+
def __str__(self):
return ''.join([str(item) for item in self])
| {"golden_diff": "diff --git a/mkdocs/toc.py b/mkdocs/toc.py\n--- a/mkdocs/toc.py\n+++ b/mkdocs/toc.py\n@@ -32,6 +32,9 @@\n def __iter__(self):\n return iter(self.items)\n \n+ def __len__(self):\n+ return len(self.items)\n+\n def __str__(self):\n return ''.join([str(item) for item in self])\n", "issue": "Provide length of TableOfContents\nCurrently, you can only iter over `TableOfContents`. I would like to know the length of it.\n", "before_files": [{"content": "# coding: utf-8\n\n\"\"\"\nDeals with generating the per-page table of contents.\n\nFor the sake of simplicity we use an existing markdown extension to generate\nan HTML table of contents, and then parse that into the underlying data.\n\nThe steps we take to generate a table of contents are:\n\n* Pre-process the markdown, injecting a [TOC] marker.\n* Generate HTML from markdown.\n* Post-process the HTML, spliting the content and the table of contents.\n* Parse table of contents HTML into the underlying data structure.\n\"\"\"\n\nfrom __future__ import unicode_literals\n\ntry: # pragma: no cover\n from html.parser import HTMLParser # noqa\nexcept ImportError: # pragma: no cover\n from HTMLParser import HTMLParser # noqa\n\n\nclass TableOfContents(object):\n \"\"\"\n Represents the table of contents for a given page.\n \"\"\"\n def __init__(self, html):\n self.items = _parse_html_table_of_contents(html)\n\n def __iter__(self):\n return iter(self.items)\n\n def __str__(self):\n return ''.join([str(item) for item in self])\n\n\nclass AnchorLink(object):\n \"\"\"\n A single entry in the table of contents.\n \"\"\"\n def __init__(self, title, url):\n self.title, self.url = title, url\n self.children = []\n\n def __str__(self):\n return self.indent_print()\n\n def indent_print(self, depth=0):\n indent = ' ' * depth\n ret = '%s%s - %s\\n' % (indent, self.title, self.url)\n for item in self.children:\n ret += item.indent_print(depth + 1)\n return ret\n\n\nclass TOCParser(HTMLParser):\n\n def __init__(self):\n HTMLParser.__init__(self)\n self.links = []\n\n self.in_anchor = False\n self.attrs = None\n self.title = ''\n\n # Prior to Python3.4 no convert_charrefs keyword existed.\n # However, in Python3.5 the default was changed to True.\n # We need the False behavior in all versions but can only\n # set it if it exists.\n if hasattr(self, 'convert_charrefs'):\n self.convert_charrefs = False\n\n def handle_starttag(self, tag, attrs):\n\n if not self.in_anchor:\n if tag == 'a':\n self.in_anchor = True\n self.attrs = dict(attrs)\n\n def handle_endtag(self, tag):\n if tag == 'a':\n self.in_anchor = False\n\n def handle_data(self, data):\n\n if self.in_anchor:\n self.title += data\n\n def handle_charref(self, ref):\n self.handle_entityref(\"#\" + ref)\n\n def handle_entityref(self, ref):\n self.handle_data(\"&%s;\" % ref)\n\n\ndef _parse_html_table_of_contents(html):\n \"\"\"\n Given a table of contents string that has been automatically generated by\n the markdown library, parse it into a tree of AnchorLink instances.\n\n Returns a list of all the parent AnchorLink instances.\n \"\"\"\n lines = html.splitlines()[2:-2]\n parents = []\n ret = []\n for line in lines:\n parser = TOCParser()\n parser.feed(line)\n if parser.title:\n try:\n href = parser.attrs['href']\n except KeyError:\n continue\n title = parser.title\n nav = AnchorLink(title, href)\n # Add the item to its parent if required. If it is a topmost\n # item then instead append it to our return value.\n if parents:\n parents[-1].children.append(nav)\n else:\n ret.append(nav)\n # If this item has children, store it as the current parent\n if line.endswith('<ul>'):\n parents.append(nav)\n elif line.startswith('</ul>'):\n if parents:\n parents.pop()\n\n # For the table of contents, always mark the first element as active\n if ret:\n ret[0].active = True\n\n return ret\n", "path": "mkdocs/toc.py"}], "after_files": [{"content": "# coding: utf-8\n\n\"\"\"\nDeals with generating the per-page table of contents.\n\nFor the sake of simplicity we use an existing markdown extension to generate\nan HTML table of contents, and then parse that into the underlying data.\n\nThe steps we take to generate a table of contents are:\n\n* Pre-process the markdown, injecting a [TOC] marker.\n* Generate HTML from markdown.\n* Post-process the HTML, spliting the content and the table of contents.\n* Parse table of contents HTML into the underlying data structure.\n\"\"\"\n\nfrom __future__ import unicode_literals\n\ntry: # pragma: no cover\n from html.parser import HTMLParser # noqa\nexcept ImportError: # pragma: no cover\n from HTMLParser import HTMLParser # noqa\n\n\nclass TableOfContents(object):\n \"\"\"\n Represents the table of contents for a given page.\n \"\"\"\n def __init__(self, html):\n self.items = _parse_html_table_of_contents(html)\n\n def __iter__(self):\n return iter(self.items)\n\n def __len__(self):\n return len(self.items)\n\n def __str__(self):\n return ''.join([str(item) for item in self])\n\n\nclass AnchorLink(object):\n \"\"\"\n A single entry in the table of contents.\n \"\"\"\n def __init__(self, title, url):\n self.title, self.url = title, url\n self.children = []\n\n def __str__(self):\n return self.indent_print()\n\n def indent_print(self, depth=0):\n indent = ' ' * depth\n ret = '%s%s - %s\\n' % (indent, self.title, self.url)\n for item in self.children:\n ret += item.indent_print(depth + 1)\n return ret\n\n\nclass TOCParser(HTMLParser):\n\n def __init__(self):\n HTMLParser.__init__(self)\n self.links = []\n\n self.in_anchor = False\n self.attrs = None\n self.title = ''\n\n # Prior to Python3.4 no convert_charrefs keyword existed.\n # However, in Python3.5 the default was changed to True.\n # We need the False behavior in all versions but can only\n # set it if it exists.\n if hasattr(self, 'convert_charrefs'):\n self.convert_charrefs = False\n\n def handle_starttag(self, tag, attrs):\n\n if not self.in_anchor:\n if tag == 'a':\n self.in_anchor = True\n self.attrs = dict(attrs)\n\n def handle_endtag(self, tag):\n if tag == 'a':\n self.in_anchor = False\n\n def handle_data(self, data):\n\n if self.in_anchor:\n self.title += data\n\n def handle_charref(self, ref):\n self.handle_entityref(\"#\" + ref)\n\n def handle_entityref(self, ref):\n self.handle_data(\"&%s;\" % ref)\n\n\ndef _parse_html_table_of_contents(html):\n \"\"\"\n Given a table of contents string that has been automatically generated by\n the markdown library, parse it into a tree of AnchorLink instances.\n\n Returns a list of all the parent AnchorLink instances.\n \"\"\"\n lines = html.splitlines()[2:-2]\n parents = []\n ret = []\n for line in lines:\n parser = TOCParser()\n parser.feed(line)\n if parser.title:\n try:\n href = parser.attrs['href']\n except KeyError:\n continue\n title = parser.title\n nav = AnchorLink(title, href)\n # Add the item to its parent if required. If it is a topmost\n # item then instead append it to our return value.\n if parents:\n parents[-1].children.append(nav)\n else:\n ret.append(nav)\n # If this item has children, store it as the current parent\n if line.endswith('<ul>'):\n parents.append(nav)\n elif line.startswith('</ul>'):\n if parents:\n parents.pop()\n\n # For the table of contents, always mark the first element as active\n if ret:\n ret[0].active = True\n\n return ret\n", "path": "mkdocs/toc.py"}]} |
gh_patches_debug_239 | rasdani/github-patches | git_diff | ManimCommunity__manim-1296 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Nondeterministic build failures in `Tex('The horse does not eat cucumber salad.')`
## Description of bug / unexpected behavior
<!-- Add a clear and concise description of the problem you encountered. -->
As I've been figuring out the test coverage toolset for Manim, I've done quite a lot of automated builds on a copied (not forked) repository (https://github.com/MrMallIronmaker/manim-cov/). For some reason, occasionally one of the Ubuntu builds fails while I've been playing around with coverage settings. Whether it's 3.7, 3.8, or 3.9 is apparently random.
All of them fail in the Tex doctest.
## Expected behavior
It should pass the test.
## How to reproduce the issue
<!-- Provide a piece of code illustrating the undesired behavior. -->
<details><summary>Code for reproducing the problem</summary>
In theory the problematic code is here:
```py
Tex('The horse does not eat cucumber salad.')
```
However, I've not been able to replicate this issue
</details>
## Additional media files
<!-- Paste in the files manim produced on rendering the code above. Note that GitHub doesn't allow posting videos, so you may need to convert it to a GIF or use the `-i` rendering option. -->
<details><summary>Build output</summary>
```
Run poetry run pytest --cov-append --doctest-modules manim
poetry run pytest --cov-append --doctest-modules manim
shell: /usr/bin/bash -e {0}
env:
POETRY_VIRTUALENVS_CREATE: false
pythonLocation: /opt/hostedtoolcache/Python/3.8.8/x64
LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.8.8/x64/lib
Skipping virtualenv creation, as specified in config file.
============================= test session starts ==============================
platform linux -- Python 3.8.8, pytest-6.2.2, py-1.10.0, pluggy-0.13.1
rootdir: /home/runner/work/manim-cov/manim-cov, configfile: pyproject.toml
plugins: cov-2.11.1
collected 30 items
manim/_config/__init__.py . [ 3%]
manim/_config/utils.py ..
## Logs
<details><summary>Terminal output</summary>
<!-- Add "-v DEBUG" when calling manim to generate more detailed logs -->
```
PASTE HERE OR PROVIDE LINK TO https://pastebin.com/ OR SIMILAR
```
<!-- Insert screenshots here (only when absolutely necessary, we prefer copy/pasted output!) -->
</details>
## System specifications
<details><summary>System Details</summary>
- OS (with version, e.g Windows 10 v2004 or macOS 10.15 (Catalina)):
- RAM:
- Python version (`python/py/python3 --version`):
- Installed modules (provide output from `pip list`):
```
PASTE HERE
```
</details>
<details><summary>LaTeX details</summary>
+ LaTeX distribution (e.g. TeX Live 2020):
+ Installed LaTeX packages:
<!-- output of `tlmgr list --only-installed` for TeX Live or a screenshot of the Packages page for MikTeX -->
</details>
<details><summary>FFMPEG</summary>
Output of `ffmpeg -version`:
```
PASTE HERE
```
</details>
## Additional comments
<!-- Add further context that you think might be relevant for this issue here. -->
[ 10%]
manim/animation/animation.py . [ 13%]
manim/mobject/geometry.py ......... [ 43%]
manim/mobject/mobject.py ...... [ 63%]
manim/mobject/svg/tex_mobject.py ..F [ 73%]
manim/mobject/svg/text_mobject.py ... [ 83%]
manim/mobject/types/vectorized_mobject.py .... [ 96%]
manim/utils/color.py . [100%]
=================================== FAILURES ===================================
_________________ [doctest] manim.mobject.svg.tex_mobject.Tex __________________
491 A string compiled with LaTeX in normal mode.
492
493 Tests
494 -----
495
496 Check whether writing a LaTeX string works::
497
498 >>> Tex('The horse does not eat cucumber salad.')
UNEXPECTED EXCEPTION: IndexError('list index out of range')
Traceback (most recent call last):
File "/opt/hostedtoolcache/Python/3.8.8/x64/lib/python3.8/doctest.py", line 1336, in __run
exec(compile(example.source, filename, "single",
File "<doctest manim.mobject.svg.tex_mobject.Tex[0]>", line 1, in <module>
File "/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/tex_mobject.py", line 506, in __init__
MathTex.__init__(
File "/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/tex_mobject.py", line 392, in __init__
self.break_up_by_substrings()
File "/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/tex_mobject.py", line 434, in break_up_by_substrings
sub_tex_mob.move_to(self.submobjects[last_submob_index], RIGHT)
IndexError: list index out of range
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/tex_mobject.py:498: UnexpectedException
----------------------------- Captured stdout call -----------------------------
INFO Writing "The horse does not tex_file_writing.py:81
eat cucumber salad." to medi
a/Tex/3ecc83aec1683253.tex
------------------------------ Captured log call -------------------------------
INFO manim:tex_file_writing.py:81 Writing "The horse does not eat cucumber salad." to media/Tex/3ecc83aec1683253.tex
=============================== warnings summary ===============================
manim/mobject/mobject.py::manim.mobject.mobject.Mobject.set
<doctest manim.mobject.mobject.Mobject.set[1]>:1: DeprecationWarning: This method is not guaranteed to stay around. Please prefer setting the attribute normally or with Mobject.set().
manim/mobject/mobject.py::manim.mobject.mobject.Mobject.set
<doctest manim.mobject.mobject.Mobject.set[2]>:1: DeprecationWarning: This method is not guaranteed to stay around. Please prefer getting the attribute normally.
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-84, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-104, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-101, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-111, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-114, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-115, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-100, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-110, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-116, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-97, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-99, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-117, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-109, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-98, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-108, which is not recognized
warnings.warn(warning_text)
manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-46, which is not recognized
warnings.warn(warning_text)
-- Docs: https://docs.pytest.org/en/stable/warnings.html
----------- coverage: platform linux, python 3.8.8-final-0 -----------
Coverage XML written to file coverage.xml
=========================== short test summary info ============================
FAILED manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex
================== 1 failed, 29 passed, 18 warnings in 6.56s ===================
Error: Process completed with exit code 1.
```
</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: `manim/utils/tex.py`
Content:
```
1 """Utilities for processing LaTeX templates."""
2
3 __all__ = [
4 "TexTemplate",
5 "TexTemplateFromFile",
6 ]
7
8 import copy
9 import re
10
11
12 class TexTemplate:
13 """TeX templates are used for creating Tex() and MathTex() objects.
14
15 Parameters
16 ----------
17 tex_compiler : Optional[:class:`str`], optional
18 The TeX compiler to be used, e.g. ``latex``, ``pdflatex`` or ``lualatex``
19 output_format : Optional[:class:`str`], optional
20 The output format resulting from compilation, e.g. ``.dvi`` or ``.pdf``
21 documentclass : Optional[:class:`str`], optional
22 The command defining the documentclass, e.g. ``\\documentclass[preview]{standalone}``
23 preamble : Optional[:class:`str`], optional
24 The document's preamble, i.e. the part between ``\\documentclass`` and ``\\begin{document}``
25 placeholder_text : Optional[:class:`str`], optional
26 Text in the document that will be replaced by the expression to be rendered
27 post_doc_commands : Optional[:class:`str`], optional
28 Text (definitions, commands) to be inserted at right after ``\\begin{document}``, e.g. ``\\boldmath``
29
30 Attributes
31 ----------
32 tex_compiler : :class:`str`
33 The TeX compiler to be used, e.g. ``latex``, ``pdflatex`` or ``lualatex``
34 output_format : :class:`str`
35 The output format resulting from compilation, e.g. ``.dvi`` or ``.pdf``
36 documentclass : :class:`str`
37 The command defining the documentclass, e.g. ``\\documentclass[preview]{standalone}``
38 preamble : :class:`str`
39 The document's preample, i.e. the part between ``\\documentclass`` and ``\\begin{document}``
40 placeholder_text : :class:`str`
41 Text in the document that will be replaced by the expression to be rendered
42 post_doc_commands : :class:`str`
43 Text (definitions, commands) to be inserted at right after ``\\begin{document}``, e.g. ``\\boldmath``
44 """
45
46 default_documentclass = r"\documentclass[preview]{standalone}"
47 default_preamble = r"""
48 \usepackage[english]{babel}
49 \usepackage[utf8]{inputenc}
50 \usepackage[T1]{fontenc}
51 \usepackage{amsmath}
52 \usepackage{amssymb}
53 \usepackage{dsfont}
54 \usepackage{setspace}
55 \usepackage{tipa}
56 \usepackage{relsize}
57 \usepackage{textcomp}
58 \usepackage{mathrsfs}
59 \usepackage{calligra}
60 \usepackage{wasysym}
61 \usepackage{ragged2e}
62 \usepackage{physics}
63 \usepackage{xcolor}
64 \usepackage{microtype}
65 \DisableLigatures{encoding = *, family = * }
66 \linespread{1}
67 """
68 default_placeholder_text = "YourTextHere"
69 default_tex_compiler = "latex"
70 default_output_format = ".dvi"
71 default_post_doc_commands = ""
72
73 def __init__(
74 self,
75 tex_compiler=None,
76 output_format=None,
77 documentclass=None,
78 preamble=None,
79 placeholder_text=None,
80 post_doc_commands=None,
81 **kwargs,
82 ):
83 self.tex_compiler = (
84 tex_compiler
85 if tex_compiler is not None
86 else TexTemplate.default_tex_compiler
87 )
88 self.output_format = (
89 output_format
90 if output_format is not None
91 else TexTemplate.default_output_format
92 )
93 self.documentclass = (
94 documentclass
95 if documentclass is not None
96 else TexTemplate.default_documentclass
97 )
98 self.preamble = (
99 preamble if preamble is not None else TexTemplate.default_preamble
100 )
101 self.placeholder_text = (
102 placeholder_text
103 if placeholder_text is not None
104 else TexTemplate.default_placeholder_text
105 )
106 self.post_doc_commands = (
107 post_doc_commands
108 if post_doc_commands is not None
109 else TexTemplate.default_post_doc_commands
110 )
111 self._rebuild()
112
113 def _rebuild(self):
114 """Rebuilds the entire TeX template text from ``\\documentclass`` to ``\\end{document}`` according to all settings and choices."""
115 self.body = (
116 self.documentclass
117 + "\n"
118 + self.preamble
119 + "\n"
120 + r"\begin{document}"
121 + "\n"
122 + self.post_doc_commands
123 + "\n"
124 + self.placeholder_text
125 + "\n"
126 + "\n"
127 + r"\end{document}"
128 + "\n"
129 )
130
131 def add_to_preamble(self, txt, prepend=False):
132 """Adds stuff to the TeX template's preamble (e.g. definitions, packages). Text can be inserted at the beginning or at the end of the preamble.
133
134 Parameters
135 ----------
136 txt : :class:`string`
137 String containing the text to be added, e.g. ``\\usepackage{hyperref}``
138 prepend : Optional[:class:`bool`], optional
139 Whether the text should be added at the beginning of the preample, i.e. right after ``\\documentclass``. Default is to add it at the end of the preample, i.e. right before ``\\begin{document}``
140 """
141 if prepend:
142 self.preamble = txt + "\n" + self.preamble
143 else:
144 self.preamble += "\n" + txt
145 self._rebuild()
146
147 def add_to_document(self, txt):
148 """Adds txt to the TeX template just after \\begin{document}, e.g. ``\\boldmath``
149
150 Parameters
151 ----------
152 txt : :class:`str`
153 String containing the text to be added.
154 """
155 self.post_doc_commands += "\n" + txt + "\n"
156 self._rebuild()
157
158 def get_texcode_for_expression(self, expression):
159 """Inserts expression verbatim into TeX template.
160
161 Parameters
162 ----------
163 expression : :class:`str`
164 The string containing the expression to be typeset, e.g. ``$\\sqrt{2}$``
165
166 Returns
167 -------
168 :class:`str`
169 LaTeX code based on current template, containing the given ``expression`` and ready for typesetting
170 """
171 return self.body.replace(self.placeholder_text, expression)
172
173 def _texcode_for_environment(self, environment):
174 """Processes the tex_environment string to return the correct ``\\begin{environment}[extra]{extra}`` and
175 ``\\end{environment}`` strings
176
177 Parameters
178 ----------
179 environment : :class:`str`
180 The tex_environment as a string. Acceptable formats include:
181 ``{align*}``, ``align*``, ``{tabular}[t]{cccl}``, ``tabular}{cccl``, ``\\begin{tabular}[t]{cccl}``.
182
183 Returns
184 -------
185 Tuple[:class:`str`, :class:`str`]
186 A pair of strings representing the opening and closing of the tex environment, e.g.
187 ``\\begin{tabular}{cccl}`` and ``\\end{tabular}``
188 """
189
190 # If the environment starts with \begin, remove it
191 if environment[0:6] == r"\begin":
192 environment = environment[6:]
193
194 # If environment begins with { strip it
195 if environment[0] == r"{":
196 environment = environment[1:]
197
198 # The \begin command takes everything and closes with a brace
199 begin = r"\begin{" + environment
200 if (
201 begin[-1] != r"}" and begin[-1] != r"]"
202 ): # If it doesn't end on } or ], assume missing }
203 begin += r"}"
204
205 # While the \end command terminates at the first closing brace
206 split_at_brace = re.split(r"}", environment, 1)
207 end = r"\end{" + split_at_brace[0] + r"}"
208
209 return begin, end
210
211 def get_texcode_for_expression_in_env(self, expression, environment):
212 r"""Inserts expression into TeX template wrapped in \begin{environemnt} and \end{environment}
213
214 Parameters
215 ----------
216 expression : :class:`str`
217 The string containing the expression to be typeset, e.g. ``$\\sqrt{2}$``
218 environment : :class:`str`
219 The string containing the environment in which the expression should be typeset, e.g. ``align*``
220
221 Returns
222 -------
223 :class:`str`
224 LaTeX code based on template, containing the given expression inside its environment, ready for typesetting
225 """
226 begin, end = self._texcode_for_environment(environment)
227 return self.body.replace(self.placeholder_text, f"{begin}\n{expression}\n{end}")
228
229 def copy(self) -> "TexTemplate":
230 return copy.deepcopy(self)
231
232
233 class TexTemplateFromFile(TexTemplate):
234 """A TexTemplate object created from a template file (default: tex_template.tex)
235
236 Parameters
237 ----------
238 tex_compiler : Optional[:class:`str`], optional
239 The TeX compiler to be used, e.g. ``latex``, ``pdflatex`` or ``lualatex``
240 output_format : Optional[:class:`str`], optional
241 The output format resulting from compilation, e.g. ``.dvi`` or ``.pdf``
242 documentclass : Optional[:class:`str`], optional
243 The command defining the documentclass, e.g. ``\\documentclass[preview]{standalone}``
244 preamble : Optional[:class:`str`], optional
245 The document's preamble, i.e. the part between ``\\documentclass`` and ``\\begin{document}``
246 placeholder_text : Optional[:class:`str`], optional
247 Text in the document that will be replaced by the expression to be rendered
248 post_doc_commands : Optional[:class:`str`], optional
249 Text (definitions, commands) to be inserted at right after ``\\begin{document}``, e.g. ``\\boldmath``
250 kwargs : :class:`str`
251 The kwargs specified can only be strings.
252
253 Other Parameters
254 ----------------
255 tex_filename : Optional[:class:`str`], optional
256 Path to a valid TeX template file
257
258 Attributes
259 ----------
260 template_file : :class:`str`
261 Path to a valid TeX template file
262 body : :class:`str`
263 Content of the TeX template file
264 tex_compiler : :class:`str`
265 The TeX compiler to be used, e.g. ``latex``, ``pdflatex`` or ``lualatex``
266 output_format : :class:`str`
267 The output format resulting from compilation, e.g. ``.dvi`` or ``.pdf``
268 """
269
270 def __init__(self, **kwargs):
271 self.template_file = kwargs.pop("tex_filename", "tex_template.tex")
272 super().__init__(**kwargs)
273
274 def _rebuild(self):
275 with open(self.template_file, "r") as infile:
276 self.body = infile.read()
277
278 def file_not_mutable(self):
279 raise Exception("Cannot modify TexTemplate when using a template file.")
280
281 def add_to_preamble(self, txt, prepend=False):
282 self.file_not_mutable()
283
284 def add_to_document(self, txt):
285 self.file_not_mutable()
286
```
--- 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/manim/utils/tex.py b/manim/utils/tex.py
--- a/manim/utils/tex.py
+++ b/manim/utils/tex.py
@@ -48,6 +48,7 @@
\usepackage[english]{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
+\usepackage{lmodern}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{dsfont}
| {"golden_diff": "diff --git a/manim/utils/tex.py b/manim/utils/tex.py\n--- a/manim/utils/tex.py\n+++ b/manim/utils/tex.py\n@@ -48,6 +48,7 @@\n \\usepackage[english]{babel}\n \\usepackage[utf8]{inputenc}\n \\usepackage[T1]{fontenc}\n+\\usepackage{lmodern}\n \\usepackage{amsmath}\n \\usepackage{amssymb}\n \\usepackage{dsfont}\n", "issue": "Nondeterministic build failures in `Tex('The horse does not eat cucumber salad.')`\n## Description of bug / unexpected behavior\r\n<!-- Add a clear and concise description of the problem you encountered. -->\r\n\r\nAs I've been figuring out the test coverage toolset for Manim, I've done quite a lot of automated builds on a copied (not forked) repository (https://github.com/MrMallIronmaker/manim-cov/). For some reason, occasionally one of the Ubuntu builds fails while I've been playing around with coverage settings. Whether it's 3.7, 3.8, or 3.9 is apparently random.\r\n\r\nAll of them fail in the Tex doctest.\r\n\r\n\r\n## Expected behavior\r\nIt should pass the test.\r\n\r\n\r\n## How to reproduce the issue\r\n<!-- Provide a piece of code illustrating the undesired behavior. -->\r\n\r\n<details><summary>Code for reproducing the problem</summary>\r\nIn theory the problematic code is here:\r\n```py\r\nTex('The horse does not eat cucumber salad.')\r\n```\r\n\r\nHowever, I've not been able to replicate this issue \r\n\r\n</details>\r\n\r\n\r\n## Additional media files\r\n<!-- Paste in the files manim produced on rendering the code above. Note that GitHub doesn't allow posting videos, so you may need to convert it to a GIF or use the `-i` rendering option. -->\r\n\r\n<details><summary>Build output</summary>\r\n\r\n```\r\nRun poetry run pytest --cov-append --doctest-modules manim\r\n poetry run pytest --cov-append --doctest-modules manim\r\n shell: /usr/bin/bash -e {0}\r\n env:\r\n POETRY_VIRTUALENVS_CREATE: false\r\n pythonLocation: /opt/hostedtoolcache/Python/3.8.8/x64\r\n LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.8.8/x64/lib\r\nSkipping virtualenv creation, as specified in config file.\r\n============================= test session starts ==============================\r\nplatform linux -- Python 3.8.8, pytest-6.2.2, py-1.10.0, pluggy-0.13.1\r\nrootdir: /home/runner/work/manim-cov/manim-cov, configfile: pyproject.toml\r\nplugins: cov-2.11.1\r\ncollected 30 items\r\n\r\nmanim/_config/__init__.py . [ 3%]\r\nmanim/_config/utils.py .. \r\n## Logs\r\n<details><summary>Terminal output</summary>\r\n<!-- Add \"-v DEBUG\" when calling manim to generate more detailed logs -->\r\n\r\n```\r\nPASTE HERE OR PROVIDE LINK TO https://pastebin.com/ OR SIMILAR\r\n```\r\n\r\n<!-- Insert screenshots here (only when absolutely necessary, we prefer copy/pasted output!) -->\r\n\r\n</details>\r\n\r\n\r\n## System specifications\r\n\r\n<details><summary>System Details</summary>\r\n\r\n- OS (with version, e.g Windows 10 v2004 or macOS 10.15 (Catalina)):\r\n- RAM:\r\n- Python version (`python/py/python3 --version`):\r\n- Installed modules (provide output from `pip list`):\r\n```\r\nPASTE HERE\r\n```\r\n\r\n</details>\r\n\r\n<details><summary>LaTeX details</summary>\r\n\r\n+ LaTeX distribution (e.g. TeX Live 2020):\r\n+ Installed LaTeX packages:\r\n<!-- output of `tlmgr list --only-installed` for TeX Live or a screenshot of the Packages page for MikTeX -->\r\n</details>\r\n\r\n<details><summary>FFMPEG</summary>\r\n\r\nOutput of `ffmpeg -version`:\r\n\r\n```\r\nPASTE HERE\r\n```\r\n</details>\r\n\r\n## Additional comments\r\n<!-- Add further context that you think might be relevant for this issue here. -->\r\n [ 10%]\r\nmanim/animation/animation.py . [ 13%]\r\nmanim/mobject/geometry.py ......... [ 43%]\r\nmanim/mobject/mobject.py ...... [ 63%]\r\nmanim/mobject/svg/tex_mobject.py ..F [ 73%]\r\nmanim/mobject/svg/text_mobject.py ... [ 83%]\r\nmanim/mobject/types/vectorized_mobject.py .... [ 96%]\r\nmanim/utils/color.py . [100%]\r\n\r\n=================================== FAILURES ===================================\r\n_________________ [doctest] manim.mobject.svg.tex_mobject.Tex __________________\r\n491 A string compiled with LaTeX in normal mode.\r\n492 \r\n493 Tests\r\n494 -----\r\n495 \r\n496 Check whether writing a LaTeX string works::\r\n497 \r\n498 >>> Tex('The horse does not eat cucumber salad.')\r\nUNEXPECTED EXCEPTION: IndexError('list index out of range')\r\nTraceback (most recent call last):\r\n File \"/opt/hostedtoolcache/Python/3.8.8/x64/lib/python3.8/doctest.py\", line 1336, in __run\r\n exec(compile(example.source, filename, \"single\",\r\n File \"<doctest manim.mobject.svg.tex_mobject.Tex[0]>\", line 1, in <module>\r\n File \"/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/tex_mobject.py\", line 506, in __init__\r\n MathTex.__init__(\r\n File \"/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/tex_mobject.py\", line 392, in __init__\r\n self.break_up_by_substrings()\r\n File \"/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/tex_mobject.py\", line 434, in break_up_by_substrings\r\n sub_tex_mob.move_to(self.submobjects[last_submob_index], RIGHT)\r\nIndexError: list index out of range\r\n/home/runner/work/manim-cov/manim-cov/manim/mobject/svg/tex_mobject.py:498: UnexpectedException\r\n----------------------------- Captured stdout call -----------------------------\r\n INFO Writing \"The horse does not tex_file_writing.py:81\r\n eat cucumber salad.\" to medi \r\n a/Tex/3ecc83aec1683253.tex \r\n------------------------------ Captured log call -------------------------------\r\nINFO manim:tex_file_writing.py:81 Writing \"The horse does not eat cucumber salad.\" to media/Tex/3ecc83aec1683253.tex\r\n=============================== warnings summary ===============================\r\nmanim/mobject/mobject.py::manim.mobject.mobject.Mobject.set\r\n <doctest manim.mobject.mobject.Mobject.set[1]>:1: DeprecationWarning: This method is not guaranteed to stay around. Please prefer setting the attribute normally or with Mobject.set().\r\n\r\nmanim/mobject/mobject.py::manim.mobject.mobject.Mobject.set\r\n <doctest manim.mobject.mobject.Mobject.set[2]>:1: DeprecationWarning: This method is not guaranteed to stay around. Please prefer getting the attribute normally.\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-84, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-104, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-101, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-111, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-114, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-115, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-100, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-110, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-116, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-97, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-99, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-117, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-109, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-98, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-108, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\nmanim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n /home/runner/work/manim-cov/manim-cov/manim/mobject/svg/svg_mobject.py:261: UserWarning: media/Tex/3ecc83aec1683253.svg contains a reference to id #g0-46, which is not recognized\r\n warnings.warn(warning_text)\r\n\r\n-- Docs: https://docs.pytest.org/en/stable/warnings.html\r\n\r\n----------- coverage: platform linux, python 3.8.8-final-0 -----------\r\nCoverage XML written to file coverage.xml\r\n\r\n=========================== short test summary info ============================\r\nFAILED manim/mobject/svg/tex_mobject.py::manim.mobject.svg.tex_mobject.Tex\r\n================== 1 failed, 29 passed, 18 warnings in 6.56s ===================\r\nError: Process completed with exit code 1.\r\n```\r\n\r\n</details>\n", "before_files": [{"content": "\"\"\"Utilities for processing LaTeX templates.\"\"\"\n\n__all__ = [\n \"TexTemplate\",\n \"TexTemplateFromFile\",\n]\n\nimport copy\nimport re\n\n\nclass TexTemplate:\n \"\"\"TeX templates are used for creating Tex() and MathTex() objects.\n\n Parameters\n ----------\n tex_compiler : Optional[:class:`str`], optional\n The TeX compiler to be used, e.g. ``latex``, ``pdflatex`` or ``lualatex``\n output_format : Optional[:class:`str`], optional\n The output format resulting from compilation, e.g. ``.dvi`` or ``.pdf``\n documentclass : Optional[:class:`str`], optional\n The command defining the documentclass, e.g. ``\\\\documentclass[preview]{standalone}``\n preamble : Optional[:class:`str`], optional\n The document's preamble, i.e. the part between ``\\\\documentclass`` and ``\\\\begin{document}``\n placeholder_text : Optional[:class:`str`], optional\n Text in the document that will be replaced by the expression to be rendered\n post_doc_commands : Optional[:class:`str`], optional\n Text (definitions, commands) to be inserted at right after ``\\\\begin{document}``, e.g. ``\\\\boldmath``\n\n Attributes\n ----------\n tex_compiler : :class:`str`\n The TeX compiler to be used, e.g. ``latex``, ``pdflatex`` or ``lualatex``\n output_format : :class:`str`\n The output format resulting from compilation, e.g. ``.dvi`` or ``.pdf``\n documentclass : :class:`str`\n The command defining the documentclass, e.g. ``\\\\documentclass[preview]{standalone}``\n preamble : :class:`str`\n The document's preample, i.e. the part between ``\\\\documentclass`` and ``\\\\begin{document}``\n placeholder_text : :class:`str`\n Text in the document that will be replaced by the expression to be rendered\n post_doc_commands : :class:`str`\n Text (definitions, commands) to be inserted at right after ``\\\\begin{document}``, e.g. ``\\\\boldmath``\n \"\"\"\n\n default_documentclass = r\"\\documentclass[preview]{standalone}\"\n default_preamble = r\"\"\"\n\\usepackage[english]{babel}\n\\usepackage[utf8]{inputenc}\n\\usepackage[T1]{fontenc}\n\\usepackage{amsmath}\n\\usepackage{amssymb}\n\\usepackage{dsfont}\n\\usepackage{setspace}\n\\usepackage{tipa}\n\\usepackage{relsize}\n\\usepackage{textcomp}\n\\usepackage{mathrsfs}\n\\usepackage{calligra}\n\\usepackage{wasysym}\n\\usepackage{ragged2e}\n\\usepackage{physics}\n\\usepackage{xcolor}\n\\usepackage{microtype}\n\\DisableLigatures{encoding = *, family = * }\n\\linespread{1}\n\"\"\"\n default_placeholder_text = \"YourTextHere\"\n default_tex_compiler = \"latex\"\n default_output_format = \".dvi\"\n default_post_doc_commands = \"\"\n\n def __init__(\n self,\n tex_compiler=None,\n output_format=None,\n documentclass=None,\n preamble=None,\n placeholder_text=None,\n post_doc_commands=None,\n **kwargs,\n ):\n self.tex_compiler = (\n tex_compiler\n if tex_compiler is not None\n else TexTemplate.default_tex_compiler\n )\n self.output_format = (\n output_format\n if output_format is not None\n else TexTemplate.default_output_format\n )\n self.documentclass = (\n documentclass\n if documentclass is not None\n else TexTemplate.default_documentclass\n )\n self.preamble = (\n preamble if preamble is not None else TexTemplate.default_preamble\n )\n self.placeholder_text = (\n placeholder_text\n if placeholder_text is not None\n else TexTemplate.default_placeholder_text\n )\n self.post_doc_commands = (\n post_doc_commands\n if post_doc_commands is not None\n else TexTemplate.default_post_doc_commands\n )\n self._rebuild()\n\n def _rebuild(self):\n \"\"\"Rebuilds the entire TeX template text from ``\\\\documentclass`` to ``\\\\end{document}`` according to all settings and choices.\"\"\"\n self.body = (\n self.documentclass\n + \"\\n\"\n + self.preamble\n + \"\\n\"\n + r\"\\begin{document}\"\n + \"\\n\"\n + self.post_doc_commands\n + \"\\n\"\n + self.placeholder_text\n + \"\\n\"\n + \"\\n\"\n + r\"\\end{document}\"\n + \"\\n\"\n )\n\n def add_to_preamble(self, txt, prepend=False):\n \"\"\"Adds stuff to the TeX template's preamble (e.g. definitions, packages). Text can be inserted at the beginning or at the end of the preamble.\n\n Parameters\n ----------\n txt : :class:`string`\n String containing the text to be added, e.g. ``\\\\usepackage{hyperref}``\n prepend : Optional[:class:`bool`], optional\n Whether the text should be added at the beginning of the preample, i.e. right after ``\\\\documentclass``. Default is to add it at the end of the preample, i.e. right before ``\\\\begin{document}``\n \"\"\"\n if prepend:\n self.preamble = txt + \"\\n\" + self.preamble\n else:\n self.preamble += \"\\n\" + txt\n self._rebuild()\n\n def add_to_document(self, txt):\n \"\"\"Adds txt to the TeX template just after \\\\begin{document}, e.g. ``\\\\boldmath``\n\n Parameters\n ----------\n txt : :class:`str`\n String containing the text to be added.\n \"\"\"\n self.post_doc_commands += \"\\n\" + txt + \"\\n\"\n self._rebuild()\n\n def get_texcode_for_expression(self, expression):\n \"\"\"Inserts expression verbatim into TeX template.\n\n Parameters\n ----------\n expression : :class:`str`\n The string containing the expression to be typeset, e.g. ``$\\\\sqrt{2}$``\n\n Returns\n -------\n :class:`str`\n LaTeX code based on current template, containing the given ``expression`` and ready for typesetting\n \"\"\"\n return self.body.replace(self.placeholder_text, expression)\n\n def _texcode_for_environment(self, environment):\n \"\"\"Processes the tex_environment string to return the correct ``\\\\begin{environment}[extra]{extra}`` and\n ``\\\\end{environment}`` strings\n\n Parameters\n ----------\n environment : :class:`str`\n The tex_environment as a string. Acceptable formats include:\n ``{align*}``, ``align*``, ``{tabular}[t]{cccl}``, ``tabular}{cccl``, ``\\\\begin{tabular}[t]{cccl}``.\n\n Returns\n -------\n Tuple[:class:`str`, :class:`str`]\n A pair of strings representing the opening and closing of the tex environment, e.g.\n ``\\\\begin{tabular}{cccl}`` and ``\\\\end{tabular}``\n \"\"\"\n\n # If the environment starts with \\begin, remove it\n if environment[0:6] == r\"\\begin\":\n environment = environment[6:]\n\n # If environment begins with { strip it\n if environment[0] == r\"{\":\n environment = environment[1:]\n\n # The \\begin command takes everything and closes with a brace\n begin = r\"\\begin{\" + environment\n if (\n begin[-1] != r\"}\" and begin[-1] != r\"]\"\n ): # If it doesn't end on } or ], assume missing }\n begin += r\"}\"\n\n # While the \\end command terminates at the first closing brace\n split_at_brace = re.split(r\"}\", environment, 1)\n end = r\"\\end{\" + split_at_brace[0] + r\"}\"\n\n return begin, end\n\n def get_texcode_for_expression_in_env(self, expression, environment):\n r\"\"\"Inserts expression into TeX template wrapped in \\begin{environemnt} and \\end{environment}\n\n Parameters\n ----------\n expression : :class:`str`\n The string containing the expression to be typeset, e.g. ``$\\\\sqrt{2}$``\n environment : :class:`str`\n The string containing the environment in which the expression should be typeset, e.g. ``align*``\n\n Returns\n -------\n :class:`str`\n LaTeX code based on template, containing the given expression inside its environment, ready for typesetting\n \"\"\"\n begin, end = self._texcode_for_environment(environment)\n return self.body.replace(self.placeholder_text, f\"{begin}\\n{expression}\\n{end}\")\n\n def copy(self) -> \"TexTemplate\":\n return copy.deepcopy(self)\n\n\nclass TexTemplateFromFile(TexTemplate):\n \"\"\"A TexTemplate object created from a template file (default: tex_template.tex)\n\n Parameters\n ----------\n tex_compiler : Optional[:class:`str`], optional\n The TeX compiler to be used, e.g. ``latex``, ``pdflatex`` or ``lualatex``\n output_format : Optional[:class:`str`], optional\n The output format resulting from compilation, e.g. ``.dvi`` or ``.pdf``\n documentclass : Optional[:class:`str`], optional\n The command defining the documentclass, e.g. ``\\\\documentclass[preview]{standalone}``\n preamble : Optional[:class:`str`], optional\n The document's preamble, i.e. the part between ``\\\\documentclass`` and ``\\\\begin{document}``\n placeholder_text : Optional[:class:`str`], optional\n Text in the document that will be replaced by the expression to be rendered\n post_doc_commands : Optional[:class:`str`], optional\n Text (definitions, commands) to be inserted at right after ``\\\\begin{document}``, e.g. ``\\\\boldmath``\n kwargs : :class:`str`\n The kwargs specified can only be strings.\n\n Other Parameters\n ----------------\n tex_filename : Optional[:class:`str`], optional\n Path to a valid TeX template file\n\n Attributes\n ----------\n template_file : :class:`str`\n Path to a valid TeX template file\n body : :class:`str`\n Content of the TeX template file\n tex_compiler : :class:`str`\n The TeX compiler to be used, e.g. ``latex``, ``pdflatex`` or ``lualatex``\n output_format : :class:`str`\n The output format resulting from compilation, e.g. ``.dvi`` or ``.pdf``\n \"\"\"\n\n def __init__(self, **kwargs):\n self.template_file = kwargs.pop(\"tex_filename\", \"tex_template.tex\")\n super().__init__(**kwargs)\n\n def _rebuild(self):\n with open(self.template_file, \"r\") as infile:\n self.body = infile.read()\n\n def file_not_mutable(self):\n raise Exception(\"Cannot modify TexTemplate when using a template file.\")\n\n def add_to_preamble(self, txt, prepend=False):\n self.file_not_mutable()\n\n def add_to_document(self, txt):\n self.file_not_mutable()\n", "path": "manim/utils/tex.py"}], "after_files": [{"content": "\"\"\"Utilities for processing LaTeX templates.\"\"\"\n\n__all__ = [\n \"TexTemplate\",\n \"TexTemplateFromFile\",\n]\n\nimport copy\nimport re\n\n\nclass TexTemplate:\n \"\"\"TeX templates are used for creating Tex() and MathTex() objects.\n\n Parameters\n ----------\n tex_compiler : Optional[:class:`str`], optional\n The TeX compiler to be used, e.g. ``latex``, ``pdflatex`` or ``lualatex``\n output_format : Optional[:class:`str`], optional\n The output format resulting from compilation, e.g. ``.dvi`` or ``.pdf``\n documentclass : Optional[:class:`str`], optional\n The command defining the documentclass, e.g. ``\\\\documentclass[preview]{standalone}``\n preamble : Optional[:class:`str`], optional\n The document's preamble, i.e. the part between ``\\\\documentclass`` and ``\\\\begin{document}``\n placeholder_text : Optional[:class:`str`], optional\n Text in the document that will be replaced by the expression to be rendered\n post_doc_commands : Optional[:class:`str`], optional\n Text (definitions, commands) to be inserted at right after ``\\\\begin{document}``, e.g. ``\\\\boldmath``\n\n Attributes\n ----------\n tex_compiler : :class:`str`\n The TeX compiler to be used, e.g. ``latex``, ``pdflatex`` or ``lualatex``\n output_format : :class:`str`\n The output format resulting from compilation, e.g. ``.dvi`` or ``.pdf``\n documentclass : :class:`str`\n The command defining the documentclass, e.g. ``\\\\documentclass[preview]{standalone}``\n preamble : :class:`str`\n The document's preample, i.e. the part between ``\\\\documentclass`` and ``\\\\begin{document}``\n placeholder_text : :class:`str`\n Text in the document that will be replaced by the expression to be rendered\n post_doc_commands : :class:`str`\n Text (definitions, commands) to be inserted at right after ``\\\\begin{document}``, e.g. ``\\\\boldmath``\n \"\"\"\n\n default_documentclass = r\"\\documentclass[preview]{standalone}\"\n default_preamble = r\"\"\"\n\\usepackage[english]{babel}\n\\usepackage[utf8]{inputenc}\n\\usepackage[T1]{fontenc}\n\\usepackage{lmodern}\n\\usepackage{amsmath}\n\\usepackage{amssymb}\n\\usepackage{dsfont}\n\\usepackage{setspace}\n\\usepackage{tipa}\n\\usepackage{relsize}\n\\usepackage{textcomp}\n\\usepackage{mathrsfs}\n\\usepackage{calligra}\n\\usepackage{wasysym}\n\\usepackage{ragged2e}\n\\usepackage{physics}\n\\usepackage{xcolor}\n\\usepackage{microtype}\n\\DisableLigatures{encoding = *, family = * }\n\\linespread{1}\n\"\"\"\n default_placeholder_text = \"YourTextHere\"\n default_tex_compiler = \"latex\"\n default_output_format = \".dvi\"\n default_post_doc_commands = \"\"\n\n def __init__(\n self,\n tex_compiler=None,\n output_format=None,\n documentclass=None,\n preamble=None,\n placeholder_text=None,\n post_doc_commands=None,\n **kwargs,\n ):\n self.tex_compiler = (\n tex_compiler\n if tex_compiler is not None\n else TexTemplate.default_tex_compiler\n )\n self.output_format = (\n output_format\n if output_format is not None\n else TexTemplate.default_output_format\n )\n self.documentclass = (\n documentclass\n if documentclass is not None\n else TexTemplate.default_documentclass\n )\n self.preamble = (\n preamble if preamble is not None else TexTemplate.default_preamble\n )\n self.placeholder_text = (\n placeholder_text\n if placeholder_text is not None\n else TexTemplate.default_placeholder_text\n )\n self.post_doc_commands = (\n post_doc_commands\n if post_doc_commands is not None\n else TexTemplate.default_post_doc_commands\n )\n self._rebuild()\n\n def _rebuild(self):\n \"\"\"Rebuilds the entire TeX template text from ``\\\\documentclass`` to ``\\\\end{document}`` according to all settings and choices.\"\"\"\n self.body = (\n self.documentclass\n + \"\\n\"\n + self.preamble\n + \"\\n\"\n + r\"\\begin{document}\"\n + \"\\n\"\n + self.post_doc_commands\n + \"\\n\"\n + self.placeholder_text\n + \"\\n\"\n + \"\\n\"\n + r\"\\end{document}\"\n + \"\\n\"\n )\n\n def add_to_preamble(self, txt, prepend=False):\n \"\"\"Adds stuff to the TeX template's preamble (e.g. definitions, packages). Text can be inserted at the beginning or at the end of the preamble.\n\n Parameters\n ----------\n txt : :class:`string`\n String containing the text to be added, e.g. ``\\\\usepackage{hyperref}``\n prepend : Optional[:class:`bool`], optional\n Whether the text should be added at the beginning of the preample, i.e. right after ``\\\\documentclass``. Default is to add it at the end of the preample, i.e. right before ``\\\\begin{document}``\n \"\"\"\n if prepend:\n self.preamble = txt + \"\\n\" + self.preamble\n else:\n self.preamble += \"\\n\" + txt\n self._rebuild()\n\n def add_to_document(self, txt):\n \"\"\"Adds txt to the TeX template just after \\\\begin{document}, e.g. ``\\\\boldmath``\n\n Parameters\n ----------\n txt : :class:`str`\n String containing the text to be added.\n \"\"\"\n self.post_doc_commands += \"\\n\" + txt + \"\\n\"\n self._rebuild()\n\n def get_texcode_for_expression(self, expression):\n \"\"\"Inserts expression verbatim into TeX template.\n\n Parameters\n ----------\n expression : :class:`str`\n The string containing the expression to be typeset, e.g. ``$\\\\sqrt{2}$``\n\n Returns\n -------\n :class:`str`\n LaTeX code based on current template, containing the given ``expression`` and ready for typesetting\n \"\"\"\n return self.body.replace(self.placeholder_text, expression)\n\n def _texcode_for_environment(self, environment):\n \"\"\"Processes the tex_environment string to return the correct ``\\\\begin{environment}[extra]{extra}`` and\n ``\\\\end{environment}`` strings\n\n Parameters\n ----------\n environment : :class:`str`\n The tex_environment as a string. Acceptable formats include:\n ``{align*}``, ``align*``, ``{tabular}[t]{cccl}``, ``tabular}{cccl``, ``\\\\begin{tabular}[t]{cccl}``.\n\n Returns\n -------\n Tuple[:class:`str`, :class:`str`]\n A pair of strings representing the opening and closing of the tex environment, e.g.\n ``\\\\begin{tabular}{cccl}`` and ``\\\\end{tabular}``\n \"\"\"\n\n # If the environment starts with \\begin, remove it\n if environment[0:6] == r\"\\begin\":\n environment = environment[6:]\n\n # If environment begins with { strip it\n if environment[0] == r\"{\":\n environment = environment[1:]\n\n # The \\begin command takes everything and closes with a brace\n begin = r\"\\begin{\" + environment\n if (\n begin[-1] != r\"}\" and begin[-1] != r\"]\"\n ): # If it doesn't end on } or ], assume missing }\n begin += r\"}\"\n\n # While the \\end command terminates at the first closing brace\n split_at_brace = re.split(r\"}\", environment, 1)\n end = r\"\\end{\" + split_at_brace[0] + r\"}\"\n\n return begin, end\n\n def get_texcode_for_expression_in_env(self, expression, environment):\n r\"\"\"Inserts expression into TeX template wrapped in \\begin{environemnt} and \\end{environment}\n\n Parameters\n ----------\n expression : :class:`str`\n The string containing the expression to be typeset, e.g. ``$\\\\sqrt{2}$``\n environment : :class:`str`\n The string containing the environment in which the expression should be typeset, e.g. ``align*``\n\n Returns\n -------\n :class:`str`\n LaTeX code based on template, containing the given expression inside its environment, ready for typesetting\n \"\"\"\n begin, end = self._texcode_for_environment(environment)\n return self.body.replace(self.placeholder_text, f\"{begin}\\n{expression}\\n{end}\")\n\n def copy(self) -> \"TexTemplate\":\n return copy.deepcopy(self)\n\n\nclass TexTemplateFromFile(TexTemplate):\n \"\"\"A TexTemplate object created from a template file (default: tex_template.tex)\n\n Parameters\n ----------\n tex_compiler : Optional[:class:`str`], optional\n The TeX compiler to be used, e.g. ``latex``, ``pdflatex`` or ``lualatex``\n output_format : Optional[:class:`str`], optional\n The output format resulting from compilation, e.g. ``.dvi`` or ``.pdf``\n documentclass : Optional[:class:`str`], optional\n The command defining the documentclass, e.g. ``\\\\documentclass[preview]{standalone}``\n preamble : Optional[:class:`str`], optional\n The document's preamble, i.e. the part between ``\\\\documentclass`` and ``\\\\begin{document}``\n placeholder_text : Optional[:class:`str`], optional\n Text in the document that will be replaced by the expression to be rendered\n post_doc_commands : Optional[:class:`str`], optional\n Text (definitions, commands) to be inserted at right after ``\\\\begin{document}``, e.g. ``\\\\boldmath``\n kwargs : :class:`str`\n The kwargs specified can only be strings.\n\n Other Parameters\n ----------------\n tex_filename : Optional[:class:`str`], optional\n Path to a valid TeX template file\n\n Attributes\n ----------\n template_file : :class:`str`\n Path to a valid TeX template file\n body : :class:`str`\n Content of the TeX template file\n tex_compiler : :class:`str`\n The TeX compiler to be used, e.g. ``latex``, ``pdflatex`` or ``lualatex``\n output_format : :class:`str`\n The output format resulting from compilation, e.g. ``.dvi`` or ``.pdf``\n \"\"\"\n\n def __init__(self, **kwargs):\n self.template_file = kwargs.pop(\"tex_filename\", \"tex_template.tex\")\n super().__init__(**kwargs)\n\n def _rebuild(self):\n with open(self.template_file, \"r\") as infile:\n self.body = infile.read()\n\n def file_not_mutable(self):\n raise Exception(\"Cannot modify TexTemplate when using a template file.\")\n\n def add_to_preamble(self, txt, prepend=False):\n self.file_not_mutable()\n\n def add_to_document(self, txt):\n self.file_not_mutable()\n", "path": "manim/utils/tex.py"}]} |
gh_patches_debug_240 | rasdani/github-patches | git_diff | holoviz__panel-4047 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Make it easy and useful to use the VideoStream
I've never seen any showcases of the `VideoStream` in Panel. As Panel can update relatively quickly via Tornado and websockets it should be the best data app framework for Video. And with `panel convert` even better.
But there are lot of issues
- There are no inspirational examples out there
- When you try out you run into several issues
- The VideoStream transfers a high resolution image
- The VideoStream transfers a .png base64 data url. It is slow to work with in Pillow and other frameworks. JPEG is much faster to load and transform
- You need to be able to convert from base64 to PIL.Image for using Pillow and np.ndarray for using scikit-learn etc. This might be easy for experienced data vision people. But for beginners this is so hard.
To make it easier for Panel users to get started and create something useful. I propose we add an example to the Gallery that people can use for inspiration. We can use the example to identify and solve any performance issues.
The example should end up being easy to understand and use + super performant.
## Additional Context
[Yuichiro](https://twitter.com/whitphx) has done some really amazing work to make this possible in Streamlit. We should be able to find inspiration and make something at least as awesome. See https://edit.share.stlite.net/?sampleAppId=realtime_image_processing
[](https://twitter.com/whitphx/status/1583708572063772675?s=20&t=lZLbNEIl7LQpVWu1RyNEiQ)
--- 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 import json
3 import os
4 import shutil
5 import sys
6
7 import pyct.build
8
9 from setuptools import find_packages, setup
10 from setuptools.command.develop import develop
11 from setuptools.command.install import install
12 from setuptools.command.sdist import sdist
13
14 PANEL_LITE_BUILD = 'PANEL_LITE' in os.environ
15
16
17 def get_setup_version(reponame):
18 """
19 Helper to get the current version from either git describe or the
20 .version file (if available).
21 """
22 basepath = os.path.split(__file__)[0]
23 version_file_path = os.path.join(basepath, reponame, '.version')
24 try:
25 from param import version
26 except Exception:
27 version = None
28 if version is not None:
29 return version.Version.setup_version(basepath, reponame, archive_commit="$Format:%h$")
30 else:
31 print("WARNING: param>=1.6.0 unavailable. If you are installing a package, "
32 "this warning can safely be ignored. If you are creating a package or "
33 "otherwise operating in a git repository, you should install param>=1.6.0.")
34 return json.load(open(version_file_path, 'r'))['version_string']
35
36
37 def _build_paneljs():
38 from bokeh.ext import build
39
40 from panel.compiler import bundle_resources
41 print("Building custom models:")
42 panel_dir = os.path.join(os.path.dirname(__file__), "panel")
43 build(panel_dir)
44 print("Bundling custom model resources:")
45 bundle_resources()
46 if sys.platform != "win32":
47 # npm can cause non-blocking stdout; so reset it just in case
48 import fcntl
49 flags = fcntl.fcntl(sys.stdout, fcntl.F_GETFL)
50 fcntl.fcntl(sys.stdout, fcntl.F_SETFL, flags&~os.O_NONBLOCK)
51
52
53 class CustomDevelopCommand(develop):
54 """Custom installation for development mode."""
55
56 def run(self):
57 if not PANEL_LITE_BUILD:
58 _build_paneljs()
59 develop.run(self)
60
61
62 class CustomInstallCommand(install):
63 """Custom installation for install mode."""
64
65 def run(self):
66 if not PANEL_LITE_BUILD:
67 _build_paneljs()
68 install.run(self)
69
70
71 class CustomSdistCommand(sdist):
72 """Custom installation for sdist mode."""
73
74 def run(self):
75 if not PANEL_LITE_BUILD:
76 _build_paneljs()
77 sdist.run(self)
78
79
80 _COMMANDS = {
81 'develop': CustomDevelopCommand,
82 'install': CustomInstallCommand,
83 'sdist': CustomSdistCommand,
84 }
85
86 try:
87 from wheel.bdist_wheel import bdist_wheel
88
89 class CustomBdistWheelCommand(bdist_wheel):
90 """Custom bdist_wheel command to force cancelling qiskit-terra wheel
91 creation."""
92
93 def run(self):
94 """Do nothing so the command intentionally fails."""
95 if not PANEL_LITE_BUILD:
96 _build_paneljs()
97 bdist_wheel.run(self)
98
99 _COMMANDS['bdist_wheel'] = CustomBdistWheelCommand
100 except Exception:
101 pass
102
103 ########## dependencies ##########
104
105 install_requires = [
106 'bokeh >=2.4.0,<2.5.0',
107 'param >=1.12.0',
108 'pyviz_comms >=0.7.4',
109 'markdown',
110 'requests',
111 'tqdm >=4.48.0',
112 'pyct >=0.4.4',
113 'bleach',
114 'setuptools >=42',
115 'typing_extensions',
116 ]
117
118 _recommended = [
119 'jupyterlab',
120 'holoviews >1.14.1',
121 'matplotlib',
122 'pillow',
123 'plotly'
124 ]
125
126 _tests = [
127 # Test dependencies
128 'flake8',
129 'parameterized',
130 'pytest',
131 'nbval',
132 'flaky',
133 'pytest-xdist',
134 'pytest-cov',
135 'pre-commit',
136 'psutil',
137 # Libraries tested in unit tests
138 'folium',
139 'ipympl',
140 'scipy',
141 'twine',
142 'pandas >=1.3',
143 'ipython >=7.0',
144 'holoviews',
145 'diskcache',
146 'markdown-it-py',
147 'ipyvuetify',
148 'reacton',
149 # Added lxml temporarily as installing pyechars or idom on Python 3.11
150 # via pip tries to build it and fails. To be removed.
151 'lxml',
152 'numpy <1.24', # Avoid VTK test fail
153 ]
154
155 _ui = [
156 'playwright',
157 'pytest-playwright'
158 ]
159
160 extras_require = {
161 'examples': [
162 'hvplot',
163 'plotly >=4.0',
164 'altair',
165 'streamz',
166 'vega_datasets',
167 'vtk ==9.0.1',
168 'scikit-learn',
169 'datashader',
170 'jupyter_bokeh >=3.0.2',
171 'django <4',
172 'channels',
173 'pyvista<0.33',
174 'ipywidgets',
175 'ipywidgets_bokeh',
176 'ipyvolume',
177 'ipyleaflet',
178 'ipympl',
179 'folium',
180 'xarray',
181 'pyinstrument >=4.0',
182 'aiohttp',
183 'croniter',
184 'graphviz',
185 'networkx >=2.5',
186 'pygraphviz',
187 'seaborn',
188 'pydeck',
189 'graphviz',
190 'lxml',
191 'python-graphviz',
192 'xgboost',
193 'ipyvuetify',
194 'reacton'
195 ],
196 'tests': _tests,
197 'recommended': _recommended,
198 'doc': _recommended + [
199 'nbsite >=0.7.2rc2',
200 'pydata-sphinx-theme <=0.9.0',
201 'sphinx-copybutton',
202 'sphinx-design',
203 ],
204 'ui': _ui
205 }
206
207 extras_require['all'] = sorted(set(sum(extras_require.values(), [])))
208
209 # Superset of what's in pyproject.toml (includes non-python
210 # dependencies). Also, pyproject.toml isn't supported by all tools
211 # anyway (e.g. older versions of pip, or conda - which also supports
212 # non-python dependencies). Note that setup_requires isn't used
213 # because it doesn't work well with pip.
214 extras_require['build'] = [
215 'param >=1.9.2',
216 'pyct >=0.4.4',
217 'setuptools >=42',
218 'bokeh >=2.4.3,<2.5.0',
219 'pyviz_comms >=0.7.4',
220 'requests',
221 'packaging',
222 'bleach',
223 'tqdm >=4.48.0',
224 ]
225
226 setup_args = dict(
227 name='panel',
228 version=get_setup_version("panel"),
229 description='A high level app and dashboarding solution for Python.',
230 long_description=open('README.md').read() if os.path.isfile('README.md') else 'Consult README.md',
231 long_description_content_type="text/markdown",
232 author="HoloViz",
233 author_email="[email protected]",
234 maintainer="HoloViz",
235 maintainer_email="[email protected]",
236 platforms=['Windows', 'Mac OS X', 'Linux'],
237 license='BSD',
238 url='http://panel.holoviz.org',
239 project_urls={
240 'Source': 'https://github.com/holoviz/panel',
241 },
242 cmdclass=_COMMANDS,
243 packages=find_packages(),
244 include_package_data=True,
245 data_files=[
246 # like `jupyter serverextension enable --sys-prefix`
247 (
248 "etc/jupyter/jupyter_notebook_config.d",
249 ["jupyter-config/jupyter_notebook_config.d/panel-client-jupyter.json"],
250 ),
251 # like `jupyter server extension enable --sys-prefix`
252 (
253 "etc/jupyter/jupyter_server_config.d",
254 ["jupyter-config/jupyter_server_config.d/panel-client-jupyter.json"],
255 ),
256 ],
257 classifiers=[
258 "License :: OSI Approved :: BSD License",
259 "Development Status :: 5 - Production/Stable",
260 "Programming Language :: Python :: 3",
261 "Programming Language :: Python :: 3.7",
262 "Programming Language :: Python :: 3.8",
263 "Programming Language :: Python :: 3.9",
264 "Programming Language :: Python :: 3.10",
265 "Programming Language :: Python :: 3.11",
266 "Operating System :: OS Independent",
267 "Intended Audience :: Developers",
268 "Intended Audience :: Science/Research",
269 "Intended Audience :: Financial and Insurance Industry",
270 "Intended Audience :: Healthcare Industry",
271 "Intended Audience :: Information Technology",
272 "Intended Audience :: Legal Industry",
273 "Intended Audience :: Other Audience",
274 "Intended Audience :: Science/Research",
275 "Natural Language :: English",
276 "Topic :: Scientific/Engineering",
277 "Topic :: Scientific/Engineering :: Visualization",
278 "Topic :: Scientific/Engineering :: Information Analysis",
279 "Topic :: Office/Business",
280 "Topic :: Office/Business :: Financial",
281 "Topic :: Software Development :: Libraries"],
282 python_requires=">=3.7",
283 entry_points={
284 'console_scripts': [
285 'panel = panel.command:main'
286 ]
287 },
288 install_requires=install_requires,
289 extras_require=extras_require,
290 tests_require=extras_require['tests']
291 )
292
293 def clean_js_version(version):
294 version = version.replace('-', '')
295 for dev in ('a', 'b', 'rc'):
296 version = version.replace(dev+'.', dev)
297 return version
298
299 if __name__ == "__main__":
300 example_path = os.path.join(os.path.dirname(os.path.abspath(__file__)),
301 'panel', 'examples')
302
303 if 'develop' not in sys.argv and 'egg_info' not in sys.argv:
304 pyct.build.examples(example_path, __file__, force=True)
305
306 version = setup_args['version']
307 if 'post' not in version:
308 with open('./panel/package.json') as f:
309 package_json = json.load(f)
310 js_version = package_json['version']
311 version = version.split('+')[0]
312 if any(dev in version for dev in ('a', 'b', 'rc')) and not '-' in js_version:
313 raise ValueError(f"panel.js dev versions ({js_version}) must "
314 "must separate dev suffix with a dash, e.g. "
315 "v1.0.0rc1 should be v1.0.0-rc.1.")
316 if version != 'None' and version != clean_js_version(js_version):
317 raise ValueError(f"panel.js version ({js_version}) does not match "
318 f"panel version ({version}). Cannot build release.")
319
320 setup(**setup_args)
321
322 if os.path.isdir(example_path):
323 shutil.rmtree(example_path)
324
```
--- 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
@@ -191,7 +191,8 @@
'python-graphviz',
'xgboost',
'ipyvuetify',
- 'reacton'
+ 'reacton',
+ 'scikit-image',
],
'tests': _tests,
'recommended': _recommended,
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -191,7 +191,8 @@\n 'python-graphviz',\n 'xgboost',\n 'ipyvuetify',\n- 'reacton'\n+ 'reacton',\n+ 'scikit-image',\n ],\n 'tests': _tests,\n 'recommended': _recommended,\n", "issue": "Make it easy and useful to use the VideoStream\nI've never seen any showcases of the `VideoStream` in Panel. As Panel can update relatively quickly via Tornado and websockets it should be the best data app framework for Video. And with `panel convert` even better.\r\n\r\nBut there are lot of issues\r\n\r\n- There are no inspirational examples out there\r\n- When you try out you run into several issues\r\n - The VideoStream transfers a high resolution image\r\n - The VideoStream transfers a .png base64 data url. It is slow to work with in Pillow and other frameworks. JPEG is much faster to load and transform\r\n - You need to be able to convert from base64 to PIL.Image for using Pillow and np.ndarray for using scikit-learn etc. This might be easy for experienced data vision people. But for beginners this is so hard.\r\n\r\nTo make it easier for Panel users to get started and create something useful. I propose we add an example to the Gallery that people can use for inspiration. We can use the example to identify and solve any performance issues.\r\n\r\nThe example should end up being easy to understand and use + super performant.\r\n\r\n## Additional Context\r\n\r\n[Yuichiro](https://twitter.com/whitphx) has done some really amazing work to make this possible in Streamlit. We should be able to find inspiration and make something at least as awesome. See https://edit.share.stlite.net/?sampleAppId=realtime_image_processing\r\n\r\n[](https://twitter.com/whitphx/status/1583708572063772675?s=20&t=lZLbNEIl7LQpVWu1RyNEiQ)\n", "before_files": [{"content": "#!/usr/bin/env python\nimport json\nimport os\nimport shutil\nimport sys\n\nimport pyct.build\n\nfrom setuptools import find_packages, setup\nfrom setuptools.command.develop import develop\nfrom setuptools.command.install import install\nfrom setuptools.command.sdist import sdist\n\nPANEL_LITE_BUILD = 'PANEL_LITE' in os.environ\n\n\ndef get_setup_version(reponame):\n \"\"\"\n Helper to get the current version from either git describe or the\n .version file (if available).\n \"\"\"\n basepath = os.path.split(__file__)[0]\n version_file_path = os.path.join(basepath, reponame, '.version')\n try:\n from param import version\n except Exception:\n version = None\n if version is not None:\n return version.Version.setup_version(basepath, reponame, archive_commit=\"$Format:%h$\")\n else:\n print(\"WARNING: param>=1.6.0 unavailable. If you are installing a package, \"\n \"this warning can safely be ignored. If you are creating a package or \"\n \"otherwise operating in a git repository, you should install param>=1.6.0.\")\n return json.load(open(version_file_path, 'r'))['version_string']\n\n\ndef _build_paneljs():\n from bokeh.ext import build\n\n from panel.compiler import bundle_resources\n print(\"Building custom models:\")\n panel_dir = os.path.join(os.path.dirname(__file__), \"panel\")\n build(panel_dir)\n print(\"Bundling custom model resources:\")\n bundle_resources()\n if sys.platform != \"win32\":\n # npm can cause non-blocking stdout; so reset it just in case\n import fcntl\n flags = fcntl.fcntl(sys.stdout, fcntl.F_GETFL)\n fcntl.fcntl(sys.stdout, fcntl.F_SETFL, flags&~os.O_NONBLOCK)\n\n\nclass CustomDevelopCommand(develop):\n \"\"\"Custom installation for development mode.\"\"\"\n\n def run(self):\n if not PANEL_LITE_BUILD:\n _build_paneljs()\n develop.run(self)\n\n\nclass CustomInstallCommand(install):\n \"\"\"Custom installation for install mode.\"\"\"\n\n def run(self):\n if not PANEL_LITE_BUILD:\n _build_paneljs()\n install.run(self)\n\n\nclass CustomSdistCommand(sdist):\n \"\"\"Custom installation for sdist mode.\"\"\"\n\n def run(self):\n if not PANEL_LITE_BUILD:\n _build_paneljs()\n sdist.run(self)\n\n\n_COMMANDS = {\n 'develop': CustomDevelopCommand,\n 'install': CustomInstallCommand,\n 'sdist': CustomSdistCommand,\n}\n\ntry:\n from wheel.bdist_wheel import bdist_wheel\n\n class CustomBdistWheelCommand(bdist_wheel):\n \"\"\"Custom bdist_wheel command to force cancelling qiskit-terra wheel\n creation.\"\"\"\n\n def run(self):\n \"\"\"Do nothing so the command intentionally fails.\"\"\"\n if not PANEL_LITE_BUILD:\n _build_paneljs()\n bdist_wheel.run(self)\n\n _COMMANDS['bdist_wheel'] = CustomBdistWheelCommand\nexcept Exception:\n pass\n\n########## dependencies ##########\n\ninstall_requires = [\n 'bokeh >=2.4.0,<2.5.0',\n 'param >=1.12.0',\n 'pyviz_comms >=0.7.4',\n 'markdown',\n 'requests',\n 'tqdm >=4.48.0',\n 'pyct >=0.4.4',\n 'bleach',\n 'setuptools >=42',\n 'typing_extensions',\n]\n\n_recommended = [\n 'jupyterlab',\n 'holoviews >1.14.1',\n 'matplotlib',\n 'pillow',\n 'plotly'\n]\n\n_tests = [\n # Test dependencies\n 'flake8',\n 'parameterized',\n 'pytest',\n 'nbval',\n 'flaky',\n 'pytest-xdist',\n 'pytest-cov',\n 'pre-commit',\n 'psutil',\n # Libraries tested in unit tests\n 'folium',\n 'ipympl',\n 'scipy',\n 'twine',\n 'pandas >=1.3',\n 'ipython >=7.0',\n 'holoviews',\n 'diskcache',\n 'markdown-it-py',\n 'ipyvuetify',\n 'reacton',\n # Added lxml temporarily as installing pyechars or idom on Python 3.11\n # via pip tries to build it and fails. To be removed.\n 'lxml',\n 'numpy <1.24', # Avoid VTK test fail\n]\n\n_ui = [\n 'playwright',\n 'pytest-playwright'\n]\n\nextras_require = {\n 'examples': [\n 'hvplot',\n 'plotly >=4.0',\n 'altair',\n 'streamz',\n 'vega_datasets',\n 'vtk ==9.0.1',\n 'scikit-learn',\n 'datashader',\n 'jupyter_bokeh >=3.0.2',\n 'django <4',\n 'channels',\n 'pyvista<0.33',\n 'ipywidgets',\n 'ipywidgets_bokeh',\n 'ipyvolume',\n 'ipyleaflet',\n 'ipympl',\n 'folium',\n 'xarray',\n 'pyinstrument >=4.0',\n 'aiohttp',\n 'croniter',\n 'graphviz',\n 'networkx >=2.5',\n 'pygraphviz',\n 'seaborn',\n 'pydeck',\n 'graphviz',\n 'lxml',\n 'python-graphviz',\n 'xgboost',\n 'ipyvuetify',\n 'reacton'\n ],\n 'tests': _tests,\n 'recommended': _recommended,\n 'doc': _recommended + [\n 'nbsite >=0.7.2rc2',\n 'pydata-sphinx-theme <=0.9.0',\n 'sphinx-copybutton',\n 'sphinx-design',\n ],\n 'ui': _ui\n}\n\nextras_require['all'] = sorted(set(sum(extras_require.values(), [])))\n\n# Superset of what's in pyproject.toml (includes non-python\n# dependencies). Also, pyproject.toml isn't supported by all tools\n# anyway (e.g. older versions of pip, or conda - which also supports\n# non-python dependencies). Note that setup_requires isn't used\n# because it doesn't work well with pip.\nextras_require['build'] = [\n 'param >=1.9.2',\n 'pyct >=0.4.4',\n 'setuptools >=42',\n 'bokeh >=2.4.3,<2.5.0',\n 'pyviz_comms >=0.7.4',\n 'requests',\n 'packaging',\n 'bleach',\n 'tqdm >=4.48.0',\n]\n\nsetup_args = dict(\n name='panel',\n version=get_setup_version(\"panel\"),\n description='A high level app and dashboarding solution for Python.',\n long_description=open('README.md').read() if os.path.isfile('README.md') else 'Consult README.md',\n long_description_content_type=\"text/markdown\",\n author=\"HoloViz\",\n author_email=\"[email protected]\",\n maintainer=\"HoloViz\",\n maintainer_email=\"[email protected]\",\n platforms=['Windows', 'Mac OS X', 'Linux'],\n license='BSD',\n url='http://panel.holoviz.org',\n project_urls={\n 'Source': 'https://github.com/holoviz/panel',\n },\n cmdclass=_COMMANDS,\n packages=find_packages(),\n include_package_data=True,\n data_files=[\n # like `jupyter serverextension enable --sys-prefix`\n (\n \"etc/jupyter/jupyter_notebook_config.d\",\n [\"jupyter-config/jupyter_notebook_config.d/panel-client-jupyter.json\"],\n ),\n # like `jupyter server extension enable --sys-prefix`\n (\n \"etc/jupyter/jupyter_server_config.d\",\n [\"jupyter-config/jupyter_server_config.d/panel-client-jupyter.json\"],\n ),\n ],\n classifiers=[\n \"License :: OSI Approved :: BSD License\",\n \"Development Status :: 5 - Production/Stable\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\",\n \"Programming Language :: Python :: 3.10\",\n \"Programming Language :: Python :: 3.11\",\n \"Operating System :: OS Independent\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: Science/Research\",\n \"Intended Audience :: Financial and Insurance Industry\",\n \"Intended Audience :: Healthcare Industry\",\n \"Intended Audience :: Information Technology\",\n \"Intended Audience :: Legal Industry\",\n \"Intended Audience :: Other Audience\",\n \"Intended Audience :: Science/Research\",\n \"Natural Language :: English\",\n \"Topic :: Scientific/Engineering\",\n \"Topic :: Scientific/Engineering :: Visualization\",\n \"Topic :: Scientific/Engineering :: Information Analysis\",\n \"Topic :: Office/Business\",\n \"Topic :: Office/Business :: Financial\",\n \"Topic :: Software Development :: Libraries\"],\n python_requires=\">=3.7\",\n entry_points={\n 'console_scripts': [\n 'panel = panel.command:main'\n ]\n },\n install_requires=install_requires,\n extras_require=extras_require,\n tests_require=extras_require['tests']\n)\n\ndef clean_js_version(version):\n version = version.replace('-', '')\n for dev in ('a', 'b', 'rc'):\n version = version.replace(dev+'.', dev)\n return version\n\nif __name__ == \"__main__\":\n example_path = os.path.join(os.path.dirname(os.path.abspath(__file__)),\n 'panel', 'examples')\n\n if 'develop' not in sys.argv and 'egg_info' not in sys.argv:\n pyct.build.examples(example_path, __file__, force=True)\n\n version = setup_args['version']\n if 'post' not in version:\n with open('./panel/package.json') as f:\n package_json = json.load(f)\n js_version = package_json['version']\n version = version.split('+')[0]\n if any(dev in version for dev in ('a', 'b', 'rc')) and not '-' in js_version:\n raise ValueError(f\"panel.js dev versions ({js_version}) must \"\n \"must separate dev suffix with a dash, e.g. \"\n \"v1.0.0rc1 should be v1.0.0-rc.1.\")\n if version != 'None' and version != clean_js_version(js_version):\n raise ValueError(f\"panel.js version ({js_version}) does not match \"\n f\"panel version ({version}). Cannot build release.\")\n\n setup(**setup_args)\n\n if os.path.isdir(example_path):\n shutil.rmtree(example_path)\n", "path": "setup.py"}], "after_files": [{"content": "#!/usr/bin/env python\nimport json\nimport os\nimport shutil\nimport sys\n\nimport pyct.build\n\nfrom setuptools import find_packages, setup\nfrom setuptools.command.develop import develop\nfrom setuptools.command.install import install\nfrom setuptools.command.sdist import sdist\n\nPANEL_LITE_BUILD = 'PANEL_LITE' in os.environ\n\n\ndef get_setup_version(reponame):\n \"\"\"\n Helper to get the current version from either git describe or the\n .version file (if available).\n \"\"\"\n basepath = os.path.split(__file__)[0]\n version_file_path = os.path.join(basepath, reponame, '.version')\n try:\n from param import version\n except Exception:\n version = None\n if version is not None:\n return version.Version.setup_version(basepath, reponame, archive_commit=\"$Format:%h$\")\n else:\n print(\"WARNING: param>=1.6.0 unavailable. If you are installing a package, \"\n \"this warning can safely be ignored. If you are creating a package or \"\n \"otherwise operating in a git repository, you should install param>=1.6.0.\")\n return json.load(open(version_file_path, 'r'))['version_string']\n\n\ndef _build_paneljs():\n from bokeh.ext import build\n\n from panel.compiler import bundle_resources\n print(\"Building custom models:\")\n panel_dir = os.path.join(os.path.dirname(__file__), \"panel\")\n build(panel_dir)\n print(\"Bundling custom model resources:\")\n bundle_resources()\n if sys.platform != \"win32\":\n # npm can cause non-blocking stdout; so reset it just in case\n import fcntl\n flags = fcntl.fcntl(sys.stdout, fcntl.F_GETFL)\n fcntl.fcntl(sys.stdout, fcntl.F_SETFL, flags&~os.O_NONBLOCK)\n\n\nclass CustomDevelopCommand(develop):\n \"\"\"Custom installation for development mode.\"\"\"\n\n def run(self):\n if not PANEL_LITE_BUILD:\n _build_paneljs()\n develop.run(self)\n\n\nclass CustomInstallCommand(install):\n \"\"\"Custom installation for install mode.\"\"\"\n\n def run(self):\n if not PANEL_LITE_BUILD:\n _build_paneljs()\n install.run(self)\n\n\nclass CustomSdistCommand(sdist):\n \"\"\"Custom installation for sdist mode.\"\"\"\n\n def run(self):\n if not PANEL_LITE_BUILD:\n _build_paneljs()\n sdist.run(self)\n\n\n_COMMANDS = {\n 'develop': CustomDevelopCommand,\n 'install': CustomInstallCommand,\n 'sdist': CustomSdistCommand,\n}\n\ntry:\n from wheel.bdist_wheel import bdist_wheel\n\n class CustomBdistWheelCommand(bdist_wheel):\n \"\"\"Custom bdist_wheel command to force cancelling qiskit-terra wheel\n creation.\"\"\"\n\n def run(self):\n \"\"\"Do nothing so the command intentionally fails.\"\"\"\n if not PANEL_LITE_BUILD:\n _build_paneljs()\n bdist_wheel.run(self)\n\n _COMMANDS['bdist_wheel'] = CustomBdistWheelCommand\nexcept Exception:\n pass\n\n########## dependencies ##########\n\ninstall_requires = [\n 'bokeh >=2.4.0,<2.5.0',\n 'param >=1.12.0',\n 'pyviz_comms >=0.7.4',\n 'markdown',\n 'requests',\n 'tqdm >=4.48.0',\n 'pyct >=0.4.4',\n 'bleach',\n 'setuptools >=42',\n 'typing_extensions',\n]\n\n_recommended = [\n 'jupyterlab',\n 'holoviews >1.14.1',\n 'matplotlib',\n 'pillow',\n 'plotly'\n]\n\n_tests = [\n # Test dependencies\n 'flake8',\n 'parameterized',\n 'pytest',\n 'nbval',\n 'flaky',\n 'pytest-xdist',\n 'pytest-cov',\n 'pre-commit',\n 'psutil',\n # Libraries tested in unit tests\n 'folium',\n 'ipympl',\n 'scipy',\n 'twine',\n 'pandas >=1.3',\n 'ipython >=7.0',\n 'holoviews',\n 'diskcache',\n 'markdown-it-py',\n 'ipyvuetify',\n 'reacton',\n # Added lxml temporarily as installing pyechars or idom on Python 3.11\n # via pip tries to build it and fails. To be removed.\n 'lxml',\n 'numpy <1.24', # Avoid VTK test fail\n]\n\n_ui = [\n 'playwright',\n 'pytest-playwright'\n]\n\nextras_require = {\n 'examples': [\n 'hvplot',\n 'plotly >=4.0',\n 'altair',\n 'streamz',\n 'vega_datasets',\n 'vtk ==9.0.1',\n 'scikit-learn',\n 'datashader',\n 'jupyter_bokeh >=3.0.2',\n 'django <4',\n 'channels',\n 'pyvista<0.33',\n 'ipywidgets',\n 'ipywidgets_bokeh',\n 'ipyvolume',\n 'ipyleaflet',\n 'ipympl',\n 'folium',\n 'xarray',\n 'pyinstrument >=4.0',\n 'aiohttp',\n 'croniter',\n 'graphviz',\n 'networkx >=2.5',\n 'pygraphviz',\n 'seaborn',\n 'pydeck',\n 'graphviz',\n 'lxml',\n 'python-graphviz',\n 'xgboost',\n 'ipyvuetify',\n 'reacton',\n 'scikit-image',\n ],\n 'tests': _tests,\n 'recommended': _recommended,\n 'doc': _recommended + [\n 'nbsite >=0.7.2rc2',\n 'pydata-sphinx-theme <=0.9.0',\n 'sphinx-copybutton',\n 'sphinx-design',\n ],\n 'ui': _ui\n}\n\nextras_require['all'] = sorted(set(sum(extras_require.values(), [])))\n\n# Superset of what's in pyproject.toml (includes non-python\n# dependencies). Also, pyproject.toml isn't supported by all tools\n# anyway (e.g. older versions of pip, or conda - which also supports\n# non-python dependencies). Note that setup_requires isn't used\n# because it doesn't work well with pip.\nextras_require['build'] = [\n 'param >=1.9.2',\n 'pyct >=0.4.4',\n 'setuptools >=42',\n 'bokeh >=2.4.3,<2.5.0',\n 'pyviz_comms >=0.7.4',\n 'requests',\n 'packaging',\n 'bleach',\n 'tqdm >=4.48.0',\n]\n\nsetup_args = dict(\n name='panel',\n version=get_setup_version(\"panel\"),\n description='A high level app and dashboarding solution for Python.',\n long_description=open('README.md').read() if os.path.isfile('README.md') else 'Consult README.md',\n long_description_content_type=\"text/markdown\",\n author=\"HoloViz\",\n author_email=\"[email protected]\",\n maintainer=\"HoloViz\",\n maintainer_email=\"[email protected]\",\n platforms=['Windows', 'Mac OS X', 'Linux'],\n license='BSD',\n url='http://panel.holoviz.org',\n project_urls={\n 'Source': 'https://github.com/holoviz/panel',\n },\n cmdclass=_COMMANDS,\n packages=find_packages(),\n include_package_data=True,\n data_files=[\n # like `jupyter serverextension enable --sys-prefix`\n (\n \"etc/jupyter/jupyter_notebook_config.d\",\n [\"jupyter-config/jupyter_notebook_config.d/panel-client-jupyter.json\"],\n ),\n # like `jupyter server extension enable --sys-prefix`\n (\n \"etc/jupyter/jupyter_server_config.d\",\n [\"jupyter-config/jupyter_server_config.d/panel-client-jupyter.json\"],\n ),\n ],\n classifiers=[\n \"License :: OSI Approved :: BSD License\",\n \"Development Status :: 5 - Production/Stable\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\",\n \"Programming Language :: Python :: 3.10\",\n \"Programming Language :: Python :: 3.11\",\n \"Operating System :: OS Independent\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: Science/Research\",\n \"Intended Audience :: Financial and Insurance Industry\",\n \"Intended Audience :: Healthcare Industry\",\n \"Intended Audience :: Information Technology\",\n \"Intended Audience :: Legal Industry\",\n \"Intended Audience :: Other Audience\",\n \"Intended Audience :: Science/Research\",\n \"Natural Language :: English\",\n \"Topic :: Scientific/Engineering\",\n \"Topic :: Scientific/Engineering :: Visualization\",\n \"Topic :: Scientific/Engineering :: Information Analysis\",\n \"Topic :: Office/Business\",\n \"Topic :: Office/Business :: Financial\",\n \"Topic :: Software Development :: Libraries\"],\n python_requires=\">=3.7\",\n entry_points={\n 'console_scripts': [\n 'panel = panel.command:main'\n ]\n },\n install_requires=install_requires,\n extras_require=extras_require,\n tests_require=extras_require['tests']\n)\n\ndef clean_js_version(version):\n version = version.replace('-', '')\n for dev in ('a', 'b', 'rc'):\n version = version.replace(dev+'.', dev)\n return version\n\nif __name__ == \"__main__\":\n example_path = os.path.join(os.path.dirname(os.path.abspath(__file__)),\n 'panel', 'examples')\n\n if 'develop' not in sys.argv and 'egg_info' not in sys.argv:\n pyct.build.examples(example_path, __file__, force=True)\n\n version = setup_args['version']\n if 'post' not in version:\n with open('./panel/package.json') as f:\n package_json = json.load(f)\n js_version = package_json['version']\n version = version.split('+')[0]\n if any(dev in version for dev in ('a', 'b', 'rc')) and not '-' in js_version:\n raise ValueError(f\"panel.js dev versions ({js_version}) must \"\n \"must separate dev suffix with a dash, e.g. \"\n \"v1.0.0rc1 should be v1.0.0-rc.1.\")\n if version != 'None' and version != clean_js_version(js_version):\n raise ValueError(f\"panel.js version ({js_version}) does not match \"\n f\"panel version ({version}). Cannot build release.\")\n\n setup(**setup_args)\n\n if os.path.isdir(example_path):\n shutil.rmtree(example_path)\n", "path": "setup.py"}]} |
gh_patches_debug_241 | rasdani/github-patches | git_diff | pydantic__pydantic-2170 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
KeyError when having same Inner Class name in different Outer Class
### Checks
* [x] I added a descriptive title to this issue
* [x] I have searched (google, github) for similar issues and couldn't find anything
* [x] I have read and followed [the docs](https://pydantic-docs.helpmanual.io/) and still think this is a bug
<!-- Sorry to sound so draconian, but every second saved replying to issues is time spend improving pydantic :-) -->
# Bug
Output of `python -c "import pydantic.utils; print(pydantic.utils.version_info())"`:
```
pydantic version: 1.5.1
pydantic compiled: True
install path: C:\Users\Dell\AppData\Local\Programs\Python\Python37\Lib\site-packages\pydantic
python version: 3.7.2 (tags/v3.7.2:9a3ffc0492, Dec 23 2018, 23:09:28) [MSC v.1916 64 bit (AMD64)]
platform: Windows-10-10.0.18362-SP0
optional deps. installed: ['typing-extensions']
```
---
First of all, pydantic is awesome and super useful! Kudos to all the contributors! However, an error occurred when I was accessing the `/openapi.json` endpoint when I was testing out my FastAPI server.
The response models are located in the models.py file which looks like this.
```py
# models.py
from pydantic import BaseModel
from typing import List
class AModel(BaseModel):
class _InnerClass(BaseModel):
error_code: str = "012345"
errors: List[_InnerClass] = _InnerClass()
class BModel(BaseModel):
class _InnerClass(BaseModel):
error_code: str = "123456"
errors: List[_InnerClass] = _InnerClass()
```
The FastAPI server file looks like this.
```py
# main.pyimport models
from fastapi import FastAPI
app = FastAPI()
@app.get("/A", response_model=models.AModel)
async def ARoute():
return models.AModel()
@app.get("/B", response_model=models.BModel)
async def BRoute():
return models.BModel()
```
When I run the command `uvicorn main:app` and accessed the route `/openapi.json` the following traceback is returned:
```shell
Traceback (most recent call last):
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\uvicorn\protocols\http\h11_impl.py", line 384, in run_asgi
result = await app(self.scope, self.receive, self.send)
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\uvicorn\middleware\proxy_headers.py", line 45, in __call__
return await self.app(scope, receive, send)
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\fastapi\applications.py", line 190, in __call__
await super().__call__(scope, receive, send)
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\starlette\applications.py", line 111, in __call__
await self.middleware_stack(scope, receive, send)
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\starlette\middleware\errors.py", line 181, in __call__
raise exc from None
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\starlette\middleware\errors.py", line 159, in __call__
await self.app(scope, receive, _send)
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\starlette\exceptions.py", line 82, in __call__
raise exc from None
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\starlette\exceptions.py", line 71, in __call__
await self.app(scope, receive, sender)
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\starlette\routing.py", line 566, in __call__
await route.handle(scope, receive, send)
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\starlette\routing.py", line 227, in handle
await self.app(scope, receive, send)
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\starlette\routing.py", line 41, in app
response = await func(request)
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\fastapi\applications.py", line 143, in openapi
return JSONResponse(self.openapi())
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\fastapi\applications.py", line 128, in openapi
servers=self.servers,
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\fastapi\openapi\utils.py", line 350, in get_openapi
flat_models=flat_models, model_name_map=model_name_map # type: ignore
File "c:\users\dell\appdata\local\programs\python\python37\lib\site-packages\fastapi\utils.py", line 26, in get_model_definitions
model, model_name_map=model_name_map, ref_prefix=REF_PREFIX # type: ignore
File "pydantic\schema.py", line 455, in pydantic.schema.model_process_schema
File "pydantic\schema.py", line 491, in pydantic.schema.model_type_schema
File "pydantic\schema.py", line 185, in pydantic.schema.field_schema
File "pydantic\schema.py", line 372, in pydantic.schema.field_type_schema
File "pydantic\schema.py", line 614, in pydantic.schema.field_singleton_schema
File "pydantic\schema.py", line 539, in pydantic.schema.field_singleton_sub_fields_schema
File "pydantic\schema.py", line 412, in pydantic.schema.field_type_schema
File "pydantic\schema.py", line 665, in pydantic.schema.field_singleton_schema
KeyError: <class 'models.AModel._InnerClass'>
```
I temporarily solved the issue by editing the `get_long_model_name` function in [file](https://github.com/samuelcolvin/pydantic/blob/master/pydantic/schema.py) of my local copy to use model.\_\_qualname\_\_ (only for python 3.3+) instead of model.\_\_name\_\_:
```py
...
def get_long_model_name(model: Type['BaseModel']) -> str:
return f'{model.__module__}__{model.__qualname__}'.replace('.', '__')
...
```
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `pydantic/schema.py`
Content:
```
1 import re
2 import warnings
3 from datetime import date, datetime, time, timedelta
4 from decimal import Decimal
5 from enum import Enum
6 from ipaddress import IPv4Address, IPv4Interface, IPv4Network, IPv6Address, IPv6Interface, IPv6Network
7 from pathlib import Path
8 from typing import (
9 TYPE_CHECKING,
10 Any,
11 Callable,
12 Dict,
13 FrozenSet,
14 Iterable,
15 List,
16 Optional,
17 Pattern,
18 Sequence,
19 Set,
20 Tuple,
21 Type,
22 TypeVar,
23 Union,
24 cast,
25 )
26 from uuid import UUID
27
28 from .fields import (
29 SHAPE_FROZENSET,
30 SHAPE_ITERABLE,
31 SHAPE_LIST,
32 SHAPE_MAPPING,
33 SHAPE_SEQUENCE,
34 SHAPE_SET,
35 SHAPE_SINGLETON,
36 SHAPE_TUPLE,
37 SHAPE_TUPLE_ELLIPSIS,
38 FieldInfo,
39 ModelField,
40 )
41 from .json import pydantic_encoder
42 from .networks import AnyUrl, EmailStr
43 from .types import (
44 ConstrainedDecimal,
45 ConstrainedFloat,
46 ConstrainedInt,
47 ConstrainedList,
48 ConstrainedSet,
49 ConstrainedStr,
50 SecretBytes,
51 SecretStr,
52 conbytes,
53 condecimal,
54 confloat,
55 conint,
56 conlist,
57 conset,
58 constr,
59 )
60 from .typing import (
61 NONE_TYPES,
62 ForwardRef,
63 Literal,
64 get_args,
65 get_origin,
66 is_callable_type,
67 is_literal_type,
68 literal_values,
69 )
70 from .utils import ROOT_KEY, get_model, lenient_issubclass, sequence_like
71
72 if TYPE_CHECKING:
73 from .dataclasses import Dataclass # noqa: F401
74 from .main import BaseModel # noqa: F401
75
76 default_prefix = '#/definitions/'
77 default_ref_template = '#/definitions/{model}'
78
79 TypeModelOrEnum = Union[Type['BaseModel'], Type[Enum]]
80 TypeModelSet = Set[TypeModelOrEnum]
81
82
83 def schema(
84 models: Sequence[Union[Type['BaseModel'], Type['Dataclass']]],
85 *,
86 by_alias: bool = True,
87 title: Optional[str] = None,
88 description: Optional[str] = None,
89 ref_prefix: Optional[str] = None,
90 ref_template: str = default_ref_template,
91 ) -> Dict[str, Any]:
92 """
93 Process a list of models and generate a single JSON Schema with all of them defined in the ``definitions``
94 top-level JSON key, including their sub-models.
95
96 :param models: a list of models to include in the generated JSON Schema
97 :param by_alias: generate the schemas using the aliases defined, if any
98 :param title: title for the generated schema that includes the definitions
99 :param description: description for the generated schema
100 :param ref_prefix: the JSON Pointer prefix for schema references with ``$ref``, if None, will be set to the
101 default of ``#/definitions/``. Update it if you want the schemas to reference the definitions somewhere
102 else, e.g. for OpenAPI use ``#/components/schemas/``. The resulting generated schemas will still be at the
103 top-level key ``definitions``, so you can extract them from there. But all the references will have the set
104 prefix.
105 :param ref_template: Use a ``string.format()`` template for ``$ref`` instead of a prefix. This can be useful
106 for references that cannot be represented by ``ref_prefix`` such as a definition stored in another file. For
107 a sibling json file in a ``/schemas`` directory use ``"/schemas/${model}.json#"``.
108 :return: dict with the JSON Schema with a ``definitions`` top-level key including the schema definitions for
109 the models and sub-models passed in ``models``.
110 """
111 clean_models = [get_model(model) for model in models]
112 flat_models = get_flat_models_from_models(clean_models)
113 model_name_map = get_model_name_map(flat_models)
114 definitions = {}
115 output_schema: Dict[str, Any] = {}
116 if title:
117 output_schema['title'] = title
118 if description:
119 output_schema['description'] = description
120 for model in clean_models:
121 m_schema, m_definitions, m_nested_models = model_process_schema(
122 model,
123 by_alias=by_alias,
124 model_name_map=model_name_map,
125 ref_prefix=ref_prefix,
126 ref_template=ref_template,
127 )
128 definitions.update(m_definitions)
129 model_name = model_name_map[model]
130 definitions[model_name] = m_schema
131 if definitions:
132 output_schema['definitions'] = definitions
133 return output_schema
134
135
136 def model_schema(
137 model: Union[Type['BaseModel'], Type['Dataclass']],
138 by_alias: bool = True,
139 ref_prefix: Optional[str] = None,
140 ref_template: str = default_ref_template,
141 ) -> Dict[str, Any]:
142 """
143 Generate a JSON Schema for one model. With all the sub-models defined in the ``definitions`` top-level
144 JSON key.
145
146 :param model: a Pydantic model (a class that inherits from BaseModel)
147 :param by_alias: generate the schemas using the aliases defined, if any
148 :param ref_prefix: the JSON Pointer prefix for schema references with ``$ref``, if None, will be set to the
149 default of ``#/definitions/``. Update it if you want the schemas to reference the definitions somewhere
150 else, e.g. for OpenAPI use ``#/components/schemas/``. The resulting generated schemas will still be at the
151 top-level key ``definitions``, so you can extract them from there. But all the references will have the set
152 prefix.
153 :param ref_template: Use a ``string.format()`` template for ``$ref`` instead of a prefix. This can be useful for
154 references that cannot be represented by ``ref_prefix`` such as a definition stored in another file. For a
155 sibling json file in a ``/schemas`` directory use ``"/schemas/${model}.json#"``.
156 :return: dict with the JSON Schema for the passed ``model``
157 """
158 model = get_model(model)
159 flat_models = get_flat_models_from_model(model)
160 model_name_map = get_model_name_map(flat_models)
161 model_name = model_name_map[model]
162 m_schema, m_definitions, nested_models = model_process_schema(
163 model, by_alias=by_alias, model_name_map=model_name_map, ref_prefix=ref_prefix, ref_template=ref_template
164 )
165 if model_name in nested_models:
166 # model_name is in Nested models, it has circular references
167 m_definitions[model_name] = m_schema
168 m_schema = get_schema_ref(model_name, ref_prefix, ref_template, False)
169 if m_definitions:
170 m_schema.update({'definitions': m_definitions})
171 return m_schema
172
173
174 def get_field_info_schema(field: ModelField) -> Tuple[Dict[str, Any], bool]:
175 schema_overrides = False
176
177 # If no title is explicitly set, we don't set title in the schema for enums.
178 # The behaviour is the same as `BaseModel` reference, where the default title
179 # is in the definitions part of the schema.
180 schema: Dict[str, Any] = {}
181 if field.field_info.title or not lenient_issubclass(field.type_, Enum):
182 schema['title'] = field.field_info.title or field.alias.title().replace('_', ' ')
183
184 if field.field_info.title:
185 schema_overrides = True
186
187 if field.field_info.description:
188 schema['description'] = field.field_info.description
189 schema_overrides = True
190
191 if not field.required and not field.field_info.const and field.default is not None:
192 schema['default'] = encode_default(field.default)
193 schema_overrides = True
194
195 return schema, schema_overrides
196
197
198 def field_schema(
199 field: ModelField,
200 *,
201 by_alias: bool = True,
202 model_name_map: Dict[TypeModelOrEnum, str],
203 ref_prefix: Optional[str] = None,
204 ref_template: str = default_ref_template,
205 known_models: TypeModelSet = None,
206 ) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:
207 """
208 Process a Pydantic field and return a tuple with a JSON Schema for it as the first item.
209 Also return a dictionary of definitions with models as keys and their schemas as values. If the passed field
210 is a model and has sub-models, and those sub-models don't have overrides (as ``title``, ``default``, etc), they
211 will be included in the definitions and referenced in the schema instead of included recursively.
212
213 :param field: a Pydantic ``ModelField``
214 :param by_alias: use the defined alias (if any) in the returned schema
215 :param model_name_map: used to generate the JSON Schema references to other models included in the definitions
216 :param ref_prefix: the JSON Pointer prefix to use for references to other schemas, if None, the default of
217 #/definitions/ will be used
218 :param ref_template: Use a ``string.format()`` template for ``$ref`` instead of a prefix. This can be useful for
219 references that cannot be represented by ``ref_prefix`` such as a definition stored in another file. For a
220 sibling json file in a ``/schemas`` directory use ``"/schemas/${model}.json#"``.
221 :param known_models: used to solve circular references
222 :return: tuple of the schema for this field and additional definitions
223 """
224 s, schema_overrides = get_field_info_schema(field)
225
226 validation_schema = get_field_schema_validations(field)
227 if validation_schema:
228 s.update(validation_schema)
229 schema_overrides = True
230
231 f_schema, f_definitions, f_nested_models = field_type_schema(
232 field,
233 by_alias=by_alias,
234 model_name_map=model_name_map,
235 schema_overrides=schema_overrides,
236 ref_prefix=ref_prefix,
237 ref_template=ref_template,
238 known_models=known_models or set(),
239 )
240 # $ref will only be returned when there are no schema_overrides
241 if '$ref' in f_schema:
242 return f_schema, f_definitions, f_nested_models
243 else:
244 s.update(f_schema)
245 return s, f_definitions, f_nested_models
246
247
248 numeric_types = (int, float, Decimal)
249 _str_types_attrs: Tuple[Tuple[str, Union[type, Tuple[type, ...]], str], ...] = (
250 ('max_length', numeric_types, 'maxLength'),
251 ('min_length', numeric_types, 'minLength'),
252 ('regex', str, 'pattern'),
253 )
254
255 _numeric_types_attrs: Tuple[Tuple[str, Union[type, Tuple[type, ...]], str], ...] = (
256 ('gt', numeric_types, 'exclusiveMinimum'),
257 ('lt', numeric_types, 'exclusiveMaximum'),
258 ('ge', numeric_types, 'minimum'),
259 ('le', numeric_types, 'maximum'),
260 ('multiple_of', numeric_types, 'multipleOf'),
261 )
262
263
264 def get_field_schema_validations(field: ModelField) -> Dict[str, Any]:
265 """
266 Get the JSON Schema validation keywords for a ``field`` with an annotation of
267 a Pydantic ``FieldInfo`` with validation arguments.
268 """
269 f_schema: Dict[str, Any] = {}
270
271 if lenient_issubclass(field.type_, Enum):
272 # schema is already updated by `enum_process_schema`; just update with field extra
273 if field.field_info.extra:
274 f_schema.update(field.field_info.extra)
275 return f_schema
276
277 if lenient_issubclass(field.type_, (str, bytes)):
278 for attr_name, t, keyword in _str_types_attrs:
279 attr = getattr(field.field_info, attr_name, None)
280 if isinstance(attr, t):
281 f_schema[keyword] = attr
282 if lenient_issubclass(field.type_, numeric_types) and not issubclass(field.type_, bool):
283 for attr_name, t, keyword in _numeric_types_attrs:
284 attr = getattr(field.field_info, attr_name, None)
285 if isinstance(attr, t):
286 f_schema[keyword] = attr
287 if field.field_info is not None and field.field_info.const:
288 f_schema['const'] = field.default
289 if field.field_info.extra:
290 f_schema.update(field.field_info.extra)
291 modify_schema = getattr(field.outer_type_, '__modify_schema__', None)
292 if modify_schema:
293 modify_schema(f_schema)
294 return f_schema
295
296
297 def get_model_name_map(unique_models: TypeModelSet) -> Dict[TypeModelOrEnum, str]:
298 """
299 Process a set of models and generate unique names for them to be used as keys in the JSON Schema
300 definitions. By default the names are the same as the class name. But if two models in different Python
301 modules have the same name (e.g. "users.Model" and "items.Model"), the generated names will be
302 based on the Python module path for those conflicting models to prevent name collisions.
303
304 :param unique_models: a Python set of models
305 :return: dict mapping models to names
306 """
307 name_model_map = {}
308 conflicting_names: Set[str] = set()
309 for model in unique_models:
310 model_name = normalize_name(model.__name__)
311 if model_name in conflicting_names:
312 model_name = get_long_model_name(model)
313 name_model_map[model_name] = model
314 elif model_name in name_model_map:
315 conflicting_names.add(model_name)
316 conflicting_model = name_model_map.pop(model_name)
317 name_model_map[get_long_model_name(conflicting_model)] = conflicting_model
318 name_model_map[get_long_model_name(model)] = model
319 else:
320 name_model_map[model_name] = model
321 return {v: k for k, v in name_model_map.items()}
322
323
324 def get_flat_models_from_model(model: Type['BaseModel'], known_models: TypeModelSet = None) -> TypeModelSet:
325 """
326 Take a single ``model`` and generate a set with itself and all the sub-models in the tree. I.e. if you pass
327 model ``Foo`` (subclass of Pydantic ``BaseModel``) as ``model``, and it has a field of type ``Bar`` (also
328 subclass of ``BaseModel``) and that model ``Bar`` has a field of type ``Baz`` (also subclass of ``BaseModel``),
329 the return value will be ``set([Foo, Bar, Baz])``.
330
331 :param model: a Pydantic ``BaseModel`` subclass
332 :param known_models: used to solve circular references
333 :return: a set with the initial model and all its sub-models
334 """
335 known_models = known_models or set()
336 flat_models: TypeModelSet = set()
337 flat_models.add(model)
338 known_models |= flat_models
339 fields = cast(Sequence[ModelField], model.__fields__.values())
340 flat_models |= get_flat_models_from_fields(fields, known_models=known_models)
341 return flat_models
342
343
344 def get_flat_models_from_field(field: ModelField, known_models: TypeModelSet) -> TypeModelSet:
345 """
346 Take a single Pydantic ``ModelField`` (from a model) that could have been declared as a sublcass of BaseModel
347 (so, it could be a submodel), and generate a set with its model and all the sub-models in the tree.
348 I.e. if you pass a field that was declared to be of type ``Foo`` (subclass of BaseModel) as ``field``, and that
349 model ``Foo`` has a field of type ``Bar`` (also subclass of ``BaseModel``) and that model ``Bar`` has a field of
350 type ``Baz`` (also subclass of ``BaseModel``), the return value will be ``set([Foo, Bar, Baz])``.
351
352 :param field: a Pydantic ``ModelField``
353 :param known_models: used to solve circular references
354 :return: a set with the model used in the declaration for this field, if any, and all its sub-models
355 """
356 from .dataclasses import dataclass, is_builtin_dataclass
357 from .main import BaseModel # noqa: F811
358
359 flat_models: TypeModelSet = set()
360
361 # Handle dataclass-based models
362 if is_builtin_dataclass(field.type_):
363 field.type_ = dataclass(field.type_)
364 field_type = field.type_
365 if lenient_issubclass(getattr(field_type, '__pydantic_model__', None), BaseModel):
366 field_type = field_type.__pydantic_model__
367 if field.sub_fields:
368 flat_models |= get_flat_models_from_fields(field.sub_fields, known_models=known_models)
369 elif lenient_issubclass(field_type, BaseModel) and field_type not in known_models:
370 flat_models |= get_flat_models_from_model(field_type, known_models=known_models)
371 elif lenient_issubclass(field_type, Enum):
372 flat_models.add(field_type)
373 return flat_models
374
375
376 def get_flat_models_from_fields(fields: Sequence[ModelField], known_models: TypeModelSet) -> TypeModelSet:
377 """
378 Take a list of Pydantic ``ModelField``s (from a model) that could have been declared as sublcasses of ``BaseModel``
379 (so, any of them could be a submodel), and generate a set with their models and all the sub-models in the tree.
380 I.e. if you pass a the fields of a model ``Foo`` (subclass of ``BaseModel``) as ``fields``, and on of them has a
381 field of type ``Bar`` (also subclass of ``BaseModel``) and that model ``Bar`` has a field of type ``Baz`` (also
382 subclass of ``BaseModel``), the return value will be ``set([Foo, Bar, Baz])``.
383
384 :param fields: a list of Pydantic ``ModelField``s
385 :param known_models: used to solve circular references
386 :return: a set with any model declared in the fields, and all their sub-models
387 """
388 flat_models: TypeModelSet = set()
389 for field in fields:
390 flat_models |= get_flat_models_from_field(field, known_models=known_models)
391 return flat_models
392
393
394 def get_flat_models_from_models(models: Sequence[Type['BaseModel']]) -> TypeModelSet:
395 """
396 Take a list of ``models`` and generate a set with them and all their sub-models in their trees. I.e. if you pass
397 a list of two models, ``Foo`` and ``Bar``, both subclasses of Pydantic ``BaseModel`` as models, and ``Bar`` has
398 a field of type ``Baz`` (also subclass of ``BaseModel``), the return value will be ``set([Foo, Bar, Baz])``.
399 """
400 flat_models: TypeModelSet = set()
401 for model in models:
402 flat_models |= get_flat_models_from_model(model)
403 return flat_models
404
405
406 def get_long_model_name(model: TypeModelOrEnum) -> str:
407 return f'{model.__module__}__{model.__name__}'.replace('.', '__')
408
409
410 def field_type_schema(
411 field: ModelField,
412 *,
413 by_alias: bool,
414 model_name_map: Dict[TypeModelOrEnum, str],
415 ref_template: str,
416 schema_overrides: bool = False,
417 ref_prefix: Optional[str] = None,
418 known_models: TypeModelSet,
419 ) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:
420 """
421 Used by ``field_schema()``, you probably should be using that function.
422
423 Take a single ``field`` and generate the schema for its type only, not including additional
424 information as title, etc. Also return additional schema definitions, from sub-models.
425 """
426 definitions = {}
427 nested_models: Set[str] = set()
428 f_schema: Dict[str, Any]
429 if field.shape in {SHAPE_LIST, SHAPE_TUPLE_ELLIPSIS, SHAPE_SEQUENCE, SHAPE_SET, SHAPE_FROZENSET, SHAPE_ITERABLE}:
430 items_schema, f_definitions, f_nested_models = field_singleton_schema(
431 field,
432 by_alias=by_alias,
433 model_name_map=model_name_map,
434 ref_prefix=ref_prefix,
435 ref_template=ref_template,
436 known_models=known_models,
437 )
438 definitions.update(f_definitions)
439 nested_models.update(f_nested_models)
440 f_schema = {'type': 'array', 'items': items_schema}
441 if field.shape in {SHAPE_SET, SHAPE_FROZENSET}:
442 f_schema['uniqueItems'] = True
443
444 elif field.shape == SHAPE_MAPPING:
445 f_schema = {'type': 'object'}
446 key_field = cast(ModelField, field.key_field)
447 regex = getattr(key_field.type_, 'regex', None)
448 items_schema, f_definitions, f_nested_models = field_singleton_schema(
449 field,
450 by_alias=by_alias,
451 model_name_map=model_name_map,
452 ref_prefix=ref_prefix,
453 ref_template=ref_template,
454 known_models=known_models,
455 )
456 definitions.update(f_definitions)
457 nested_models.update(f_nested_models)
458 if regex:
459 # Dict keys have a regex pattern
460 # items_schema might be a schema or empty dict, add it either way
461 f_schema['patternProperties'] = {regex.pattern: items_schema}
462 elif items_schema:
463 # The dict values are not simply Any, so they need a schema
464 f_schema['additionalProperties'] = items_schema
465 elif field.shape == SHAPE_TUPLE:
466 sub_schema = []
467 sub_fields = cast(List[ModelField], field.sub_fields)
468 for sf in sub_fields:
469 sf_schema, sf_definitions, sf_nested_models = field_type_schema(
470 sf,
471 by_alias=by_alias,
472 model_name_map=model_name_map,
473 ref_prefix=ref_prefix,
474 ref_template=ref_template,
475 known_models=known_models,
476 )
477 definitions.update(sf_definitions)
478 nested_models.update(sf_nested_models)
479 sub_schema.append(sf_schema)
480 if len(sub_schema) == 1:
481 sub_schema = sub_schema[0] # type: ignore
482 f_schema = {'type': 'array', 'items': sub_schema}
483 else:
484 assert field.shape == SHAPE_SINGLETON, field.shape
485 f_schema, f_definitions, f_nested_models = field_singleton_schema(
486 field,
487 by_alias=by_alias,
488 model_name_map=model_name_map,
489 schema_overrides=schema_overrides,
490 ref_prefix=ref_prefix,
491 ref_template=ref_template,
492 known_models=known_models,
493 )
494 definitions.update(f_definitions)
495 nested_models.update(f_nested_models)
496
497 # check field type to avoid repeated calls to the same __modify_schema__ method
498 if field.type_ != field.outer_type_:
499 modify_schema = getattr(field.outer_type_, '__modify_schema__', None)
500 if modify_schema:
501 modify_schema(f_schema)
502 return f_schema, definitions, nested_models
503
504
505 def model_process_schema(
506 model: TypeModelOrEnum,
507 *,
508 by_alias: bool = True,
509 model_name_map: Dict[TypeModelOrEnum, str],
510 ref_prefix: Optional[str] = None,
511 ref_template: str = default_ref_template,
512 known_models: TypeModelSet = None,
513 ) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:
514 """
515 Used by ``model_schema()``, you probably should be using that function.
516
517 Take a single ``model`` and generate its schema. Also return additional schema definitions, from sub-models. The
518 sub-models of the returned schema will be referenced, but their definitions will not be included in the schema. All
519 the definitions are returned as the second value.
520 """
521 from inspect import getdoc, signature
522
523 known_models = known_models or set()
524 if lenient_issubclass(model, Enum):
525 model = cast(Type[Enum], model)
526 s = enum_process_schema(model)
527 return s, {}, set()
528 model = cast(Type['BaseModel'], model)
529 s = {'title': model.__config__.title or model.__name__}
530 doc = getdoc(model)
531 if doc:
532 s['description'] = doc
533 known_models.add(model)
534 m_schema, m_definitions, nested_models = model_type_schema(
535 model,
536 by_alias=by_alias,
537 model_name_map=model_name_map,
538 ref_prefix=ref_prefix,
539 ref_template=ref_template,
540 known_models=known_models,
541 )
542 s.update(m_schema)
543 schema_extra = model.__config__.schema_extra
544 if callable(schema_extra):
545 if len(signature(schema_extra).parameters) == 1:
546 schema_extra(s)
547 else:
548 schema_extra(s, model)
549 else:
550 s.update(schema_extra)
551 return s, m_definitions, nested_models
552
553
554 def model_type_schema(
555 model: Type['BaseModel'],
556 *,
557 by_alias: bool,
558 model_name_map: Dict[TypeModelOrEnum, str],
559 ref_template: str,
560 ref_prefix: Optional[str] = None,
561 known_models: TypeModelSet,
562 ) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:
563 """
564 You probably should be using ``model_schema()``, this function is indirectly used by that function.
565
566 Take a single ``model`` and generate the schema for its type only, not including additional
567 information as title, etc. Also return additional schema definitions, from sub-models.
568 """
569 properties = {}
570 required = []
571 definitions: Dict[str, Any] = {}
572 nested_models: Set[str] = set()
573 for k, f in model.__fields__.items():
574 try:
575 f_schema, f_definitions, f_nested_models = field_schema(
576 f,
577 by_alias=by_alias,
578 model_name_map=model_name_map,
579 ref_prefix=ref_prefix,
580 ref_template=ref_template,
581 known_models=known_models,
582 )
583 except SkipField as skip:
584 warnings.warn(skip.message, UserWarning)
585 continue
586 definitions.update(f_definitions)
587 nested_models.update(f_nested_models)
588 if by_alias:
589 properties[f.alias] = f_schema
590 if f.required:
591 required.append(f.alias)
592 else:
593 properties[k] = f_schema
594 if f.required:
595 required.append(k)
596 if ROOT_KEY in properties:
597 out_schema = properties[ROOT_KEY]
598 out_schema['title'] = model.__config__.title or model.__name__
599 else:
600 out_schema = {'type': 'object', 'properties': properties}
601 if required:
602 out_schema['required'] = required
603 if model.__config__.extra == 'forbid':
604 out_schema['additionalProperties'] = False
605 return out_schema, definitions, nested_models
606
607
608 def enum_process_schema(enum: Type[Enum]) -> Dict[str, Any]:
609 """
610 Take a single `enum` and generate its schema.
611
612 This is similar to the `model_process_schema` function, but applies to ``Enum`` objects.
613 """
614 from inspect import getdoc
615
616 schema: Dict[str, Any] = {
617 'title': enum.__name__,
618 # Python assigns all enums a default docstring value of 'An enumeration', so
619 # all enums will have a description field even if not explicitly provided.
620 'description': getdoc(enum),
621 # Add enum values and the enum field type to the schema.
622 'enum': [item.value for item in cast(Iterable[Enum], enum)],
623 }
624
625 add_field_type_to_schema(enum, schema)
626
627 modify_schema = getattr(enum, '__modify_schema__', None)
628 if modify_schema:
629 modify_schema(schema)
630
631 return schema
632
633
634 def field_singleton_sub_fields_schema(
635 sub_fields: Sequence[ModelField],
636 *,
637 by_alias: bool,
638 model_name_map: Dict[TypeModelOrEnum, str],
639 ref_template: str,
640 schema_overrides: bool = False,
641 ref_prefix: Optional[str] = None,
642 known_models: TypeModelSet,
643 ) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:
644 """
645 This function is indirectly used by ``field_schema()``, you probably should be using that function.
646
647 Take a list of Pydantic ``ModelField`` from the declaration of a type with parameters, and generate their
648 schema. I.e., fields used as "type parameters", like ``str`` and ``int`` in ``Tuple[str, int]``.
649 """
650 definitions = {}
651 nested_models: Set[str] = set()
652 if len(sub_fields) == 1:
653 return field_type_schema(
654 sub_fields[0],
655 by_alias=by_alias,
656 model_name_map=model_name_map,
657 schema_overrides=schema_overrides,
658 ref_prefix=ref_prefix,
659 ref_template=ref_template,
660 known_models=known_models,
661 )
662 else:
663 sub_field_schemas = []
664 for sf in sub_fields:
665 sub_schema, sub_definitions, sub_nested_models = field_type_schema(
666 sf,
667 by_alias=by_alias,
668 model_name_map=model_name_map,
669 schema_overrides=schema_overrides,
670 ref_prefix=ref_prefix,
671 ref_template=ref_template,
672 known_models=known_models,
673 )
674 definitions.update(sub_definitions)
675 if schema_overrides and 'allOf' in sub_schema:
676 # if the sub_field is a referenced schema we only need the referenced
677 # object. Otherwise we will end up with several allOf inside anyOf.
678 # See https://github.com/samuelcolvin/pydantic/issues/1209
679 sub_schema = sub_schema['allOf'][0]
680 sub_field_schemas.append(sub_schema)
681 nested_models.update(sub_nested_models)
682 return {'anyOf': sub_field_schemas}, definitions, nested_models
683
684
685 # Order is important, e.g. subclasses of str must go before str
686 # this is used only for standard library types, custom types should use __modify_schema__ instead
687 field_class_to_schema: Tuple[Tuple[Any, Dict[str, Any]], ...] = (
688 (Path, {'type': 'string', 'format': 'path'}),
689 (datetime, {'type': 'string', 'format': 'date-time'}),
690 (date, {'type': 'string', 'format': 'date'}),
691 (time, {'type': 'string', 'format': 'time'}),
692 (timedelta, {'type': 'number', 'format': 'time-delta'}),
693 (IPv4Network, {'type': 'string', 'format': 'ipv4network'}),
694 (IPv6Network, {'type': 'string', 'format': 'ipv6network'}),
695 (IPv4Interface, {'type': 'string', 'format': 'ipv4interface'}),
696 (IPv6Interface, {'type': 'string', 'format': 'ipv6interface'}),
697 (IPv4Address, {'type': 'string', 'format': 'ipv4'}),
698 (IPv6Address, {'type': 'string', 'format': 'ipv6'}),
699 (Pattern, {'type': 'string', 'format': 'regex'}),
700 (str, {'type': 'string'}),
701 (bytes, {'type': 'string', 'format': 'binary'}),
702 (bool, {'type': 'boolean'}),
703 (int, {'type': 'integer'}),
704 (float, {'type': 'number'}),
705 (Decimal, {'type': 'number'}),
706 (UUID, {'type': 'string', 'format': 'uuid'}),
707 (dict, {'type': 'object'}),
708 (list, {'type': 'array', 'items': {}}),
709 (tuple, {'type': 'array', 'items': {}}),
710 (set, {'type': 'array', 'items': {}, 'uniqueItems': True}),
711 (frozenset, {'type': 'array', 'items': {}, 'uniqueItems': True}),
712 )
713
714 json_scheme = {'type': 'string', 'format': 'json-string'}
715
716
717 def add_field_type_to_schema(field_type: Any, schema: Dict[str, Any]) -> None:
718 """
719 Update the given `schema` with the type-specific metadata for the given `field_type`.
720
721 This function looks through `field_class_to_schema` for a class that matches the given `field_type`,
722 and then modifies the given `schema` with the information from that type.
723 """
724 for type_, t_schema in field_class_to_schema:
725 # Fallback for `typing.Pattern` as it is not a valid class
726 if lenient_issubclass(field_type, type_) or field_type is type_ is Pattern:
727 schema.update(t_schema)
728 break
729
730
731 def get_schema_ref(name: str, ref_prefix: Optional[str], ref_template: str, schema_overrides: bool) -> Dict[str, Any]:
732 if ref_prefix:
733 schema_ref = {'$ref': ref_prefix + name}
734 else:
735 schema_ref = {'$ref': ref_template.format(model=name)}
736 return {'allOf': [schema_ref]} if schema_overrides else schema_ref
737
738
739 def field_singleton_schema( # noqa: C901 (ignore complexity)
740 field: ModelField,
741 *,
742 by_alias: bool,
743 model_name_map: Dict[TypeModelOrEnum, str],
744 ref_template: str,
745 schema_overrides: bool = False,
746 ref_prefix: Optional[str] = None,
747 known_models: TypeModelSet,
748 ) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:
749 """
750 This function is indirectly used by ``field_schema()``, you should probably be using that function.
751
752 Take a single Pydantic ``ModelField``, and return its schema and any additional definitions from sub-models.
753 """
754 from .main import BaseModel # noqa: F811
755
756 definitions: Dict[str, Any] = {}
757 nested_models: Set[str] = set()
758 if field.sub_fields:
759 return field_singleton_sub_fields_schema(
760 field.sub_fields,
761 by_alias=by_alias,
762 model_name_map=model_name_map,
763 schema_overrides=schema_overrides,
764 ref_prefix=ref_prefix,
765 ref_template=ref_template,
766 known_models=known_models,
767 )
768 if field.type_ is Any or field.type_.__class__ == TypeVar:
769 return {}, definitions, nested_models # no restrictions
770 if field.type_ in NONE_TYPES:
771 return {'type': 'null'}, definitions, nested_models
772 if is_callable_type(field.type_):
773 raise SkipField(f'Callable {field.name} was excluded from schema since JSON schema has no equivalent type.')
774 f_schema: Dict[str, Any] = {}
775 if field.field_info is not None and field.field_info.const:
776 f_schema['const'] = field.default
777 field_type = field.type_
778 if is_literal_type(field_type):
779 values = literal_values(field_type)
780 if len(values) > 1:
781 return field_schema(
782 multivalue_literal_field_for_schema(values, field),
783 by_alias=by_alias,
784 model_name_map=model_name_map,
785 ref_prefix=ref_prefix,
786 ref_template=ref_template,
787 known_models=known_models,
788 )
789 literal_value = values[0]
790 field_type = literal_value.__class__
791 f_schema['const'] = literal_value
792
793 if lenient_issubclass(field_type, Enum):
794 enum_name = model_name_map[field_type]
795 f_schema, schema_overrides = get_field_info_schema(field)
796 f_schema.update(get_schema_ref(enum_name, ref_prefix, ref_template, schema_overrides))
797 definitions[enum_name] = enum_process_schema(field_type)
798 else:
799 add_field_type_to_schema(field_type, f_schema)
800
801 modify_schema = getattr(field_type, '__modify_schema__', None)
802 if modify_schema:
803 modify_schema(f_schema)
804
805 if f_schema:
806 return f_schema, definitions, nested_models
807
808 # Handle dataclass-based models
809 if lenient_issubclass(getattr(field_type, '__pydantic_model__', None), BaseModel):
810 field_type = field_type.__pydantic_model__
811
812 if issubclass(field_type, BaseModel):
813 model_name = model_name_map[field_type]
814 if field_type not in known_models:
815 sub_schema, sub_definitions, sub_nested_models = model_process_schema(
816 field_type,
817 by_alias=by_alias,
818 model_name_map=model_name_map,
819 ref_prefix=ref_prefix,
820 ref_template=ref_template,
821 known_models=known_models,
822 )
823 definitions.update(sub_definitions)
824 definitions[model_name] = sub_schema
825 nested_models.update(sub_nested_models)
826 else:
827 nested_models.add(model_name)
828 schema_ref = get_schema_ref(model_name, ref_prefix, ref_template, schema_overrides)
829 return schema_ref, definitions, nested_models
830
831 raise ValueError(f'Value not declarable with JSON Schema, field: {field}')
832
833
834 def multivalue_literal_field_for_schema(values: Tuple[Any, ...], field: ModelField) -> ModelField:
835 return ModelField(
836 name=field.name,
837 type_=Union[tuple(Literal[value] for value in values)], # type: ignore
838 class_validators=field.class_validators,
839 model_config=field.model_config,
840 default=field.default,
841 required=field.required,
842 alias=field.alias,
843 field_info=field.field_info,
844 )
845
846
847 def encode_default(dft: Any) -> Any:
848 if isinstance(dft, (int, float, str)):
849 return dft
850 elif sequence_like(dft):
851 t = dft.__class__
852 return t(encode_default(v) for v in dft)
853 elif isinstance(dft, dict):
854 return {encode_default(k): encode_default(v) for k, v in dft.items()}
855 elif dft is None:
856 return None
857 else:
858 return pydantic_encoder(dft)
859
860
861 _map_types_constraint: Dict[Any, Callable[..., type]] = {int: conint, float: confloat, Decimal: condecimal}
862 _field_constraints = {
863 'min_length',
864 'max_length',
865 'regex',
866 'gt',
867 'lt',
868 'ge',
869 'le',
870 'multiple_of',
871 'min_items',
872 'max_items',
873 }
874
875
876 def get_annotation_from_field_info(annotation: Any, field_info: FieldInfo, field_name: str) -> Type[Any]: # noqa: C901
877 """
878 Get an annotation with validation implemented for numbers and strings based on the field_info.
879
880 :param annotation: an annotation from a field specification, as ``str``, ``ConstrainedStr``
881 :param field_info: an instance of FieldInfo, possibly with declarations for validations and JSON Schema
882 :param field_name: name of the field for use in error messages
883 :return: the same ``annotation`` if unmodified or a new annotation with validation in place
884 """
885 constraints = {f for f in _field_constraints if getattr(field_info, f) is not None}
886 if not constraints:
887 return annotation
888 used_constraints: Set[str] = set()
889
890 def go(type_: Any) -> Type[Any]:
891 if (
892 is_literal_type(annotation)
893 or isinstance(type_, ForwardRef)
894 or lenient_issubclass(type_, (ConstrainedList, ConstrainedSet))
895 ):
896 return type_
897 origin = get_origin(type_)
898 if origin is not None:
899 args: Tuple[Any, ...] = get_args(type_)
900 if any(isinstance(a, ForwardRef) for a in args):
901 # forward refs cause infinite recursion below
902 return type_
903
904 if origin is Union:
905 return Union[tuple(go(a) for a in args)] # type: ignore
906
907 if issubclass(origin, List) and (field_info.min_items is not None or field_info.max_items is not None):
908 used_constraints.update({'min_items', 'max_items'})
909 return conlist(go(args[0]), min_items=field_info.min_items, max_items=field_info.max_items)
910
911 if issubclass(origin, Set) and (field_info.min_items is not None or field_info.max_items is not None):
912 used_constraints.update({'min_items', 'max_items'})
913 return conset(go(args[0]), min_items=field_info.min_items, max_items=field_info.max_items)
914
915 for t in (Tuple, List, Set, FrozenSet, Sequence):
916 if issubclass(origin, t): # type: ignore
917 return t[tuple(go(a) for a in args)] # type: ignore
918
919 if issubclass(origin, Dict):
920 return Dict[args[0], go(args[1])] # type: ignore
921
922 attrs: Optional[Tuple[str, ...]] = None
923 constraint_func: Optional[Callable[..., type]] = None
924 if isinstance(type_, type):
925 if issubclass(type_, (SecretStr, SecretBytes)):
926 attrs = ('max_length', 'min_length')
927
928 def constraint_func(**kwargs: Any) -> Type[Any]:
929 return type(type_.__name__, (type_,), kwargs)
930
931 elif issubclass(type_, str) and not issubclass(type_, (EmailStr, AnyUrl, ConstrainedStr)):
932 attrs = ('max_length', 'min_length', 'regex')
933 constraint_func = constr
934 elif issubclass(type_, bytes):
935 attrs = ('max_length', 'min_length', 'regex')
936 constraint_func = conbytes
937 elif issubclass(type_, numeric_types) and not issubclass(
938 type_, (ConstrainedInt, ConstrainedFloat, ConstrainedDecimal, ConstrainedList, ConstrainedSet, bool)
939 ):
940 # Is numeric type
941 attrs = ('gt', 'lt', 'ge', 'le', 'multiple_of')
942 numeric_type = next(t for t in numeric_types if issubclass(type_, t)) # pragma: no branch
943 constraint_func = _map_types_constraint[numeric_type]
944
945 if attrs:
946 used_constraints.update(set(attrs))
947 kwargs = {
948 attr_name: attr
949 for attr_name, attr in ((attr_name, getattr(field_info, attr_name)) for attr_name in attrs)
950 if attr is not None
951 }
952 if kwargs:
953 constraint_func = cast(Callable[..., type], constraint_func)
954 return constraint_func(**kwargs)
955 return type_
956
957 ans = go(annotation)
958
959 unused_constraints = constraints - used_constraints
960 if unused_constraints:
961 raise ValueError(
962 f'On field "{field_name}" the following field constraints are set but not enforced: '
963 f'{", ".join(unused_constraints)}. '
964 f'\nFor more details see https://pydantic-docs.helpmanual.io/usage/schema/#unenforced-field-constraints'
965 )
966
967 return ans
968
969
970 def normalize_name(name: str) -> str:
971 """
972 Normalizes the given name. This can be applied to either a model *or* enum.
973 """
974 return re.sub(r'[^a-zA-Z0-9.\-_]', '_', name)
975
976
977 class SkipField(Exception):
978 """
979 Utility exception used to exclude fields from schema.
980 """
981
982 def __init__(self, message: str) -> None:
983 self.message = message
984
```
--- 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/pydantic/schema.py b/pydantic/schema.py
--- a/pydantic/schema.py
+++ b/pydantic/schema.py
@@ -404,7 +404,7 @@
def get_long_model_name(model: TypeModelOrEnum) -> str:
- return f'{model.__module__}__{model.__name__}'.replace('.', '__')
+ return f'{model.__module__}__{model.__qualname__}'.replace('.', '__')
def field_type_schema(
| {"golden_diff": "diff --git a/pydantic/schema.py b/pydantic/schema.py\n--- a/pydantic/schema.py\n+++ b/pydantic/schema.py\n@@ -404,7 +404,7 @@\n \n \n def get_long_model_name(model: TypeModelOrEnum) -> str:\n- return f'{model.__module__}__{model.__name__}'.replace('.', '__')\n+ return f'{model.__module__}__{model.__qualname__}'.replace('.', '__')\n \n \n def field_type_schema(\n", "issue": "KeyError when having same Inner Class name in different Outer Class\n### Checks\r\n\r\n* [x] I added a descriptive title to this issue\r\n* [x] I have searched (google, github) for similar issues and couldn't find anything\r\n* [x] I have read and followed [the docs](https://pydantic-docs.helpmanual.io/) and still think this is a bug\r\n\r\n<!-- Sorry to sound so draconian, but every second saved replying to issues is time spend improving pydantic :-) -->\r\n\r\n# Bug\r\n\r\nOutput of `python -c \"import pydantic.utils; print(pydantic.utils.version_info())\"`:\r\n```\r\n pydantic version: 1.5.1\r\n pydantic compiled: True\r\n install path: C:\\Users\\Dell\\AppData\\Local\\Programs\\Python\\Python37\\Lib\\site-packages\\pydantic\r\n python version: 3.7.2 (tags/v3.7.2:9a3ffc0492, Dec 23 2018, 23:09:28) [MSC v.1916 64 bit (AMD64)]\r\n platform: Windows-10-10.0.18362-SP0\r\n optional deps. installed: ['typing-extensions']\r\n```\r\n---\r\nFirst of all, pydantic is awesome and super useful! Kudos to all the contributors! However, an error occurred when I was accessing the `/openapi.json` endpoint when I was testing out my FastAPI server. \r\nThe response models are located in the models.py file which looks like this.\r\n```py\r\n# models.py\r\nfrom pydantic import BaseModel\r\nfrom typing import List\r\n\r\nclass AModel(BaseModel):\r\n class _InnerClass(BaseModel):\r\n error_code: str = \"012345\"\r\n \r\n errors: List[_InnerClass] = _InnerClass()\r\n\r\nclass BModel(BaseModel):\r\n class _InnerClass(BaseModel):\r\n error_code: str = \"123456\"\r\n \r\n errors: List[_InnerClass] = _InnerClass()\r\n```\r\nThe FastAPI server file looks like this.\r\n```py\r\n# main.pyimport models\r\nfrom fastapi import FastAPI\r\n\r\napp = FastAPI()\r\n\r\[email protected](\"/A\", response_model=models.AModel)\r\nasync def ARoute():\r\n return models.AModel()\r\n\r\n\r\[email protected](\"/B\", response_model=models.BModel)\r\nasync def BRoute():\r\n return models.BModel()\r\n```\r\nWhen I run the command `uvicorn main:app` and accessed the route `/openapi.json` the following traceback is returned:\r\n```shell\r\nTraceback (most recent call last):\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\uvicorn\\protocols\\http\\h11_impl.py\", line 384, in run_asgi\r\n result = await app(self.scope, self.receive, self.send)\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\uvicorn\\middleware\\proxy_headers.py\", line 45, in __call__\r\n return await self.app(scope, receive, send)\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\fastapi\\applications.py\", line 190, in __call__\r\n await super().__call__(scope, receive, send)\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\starlette\\applications.py\", line 111, in __call__\r\n await self.middleware_stack(scope, receive, send)\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\starlette\\middleware\\errors.py\", line 181, in __call__\r\n raise exc from None\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\starlette\\middleware\\errors.py\", line 159, in __call__\r\n await self.app(scope, receive, _send)\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\starlette\\exceptions.py\", line 82, in __call__\r\n raise exc from None\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\starlette\\exceptions.py\", line 71, in __call__\r\n await self.app(scope, receive, sender)\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\starlette\\routing.py\", line 566, in __call__\r\n await route.handle(scope, receive, send)\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\starlette\\routing.py\", line 227, in handle\r\n await self.app(scope, receive, send)\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\starlette\\routing.py\", line 41, in app\r\n response = await func(request)\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\fastapi\\applications.py\", line 143, in openapi\r\n return JSONResponse(self.openapi())\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\fastapi\\applications.py\", line 128, in openapi\r\n servers=self.servers,\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\fastapi\\openapi\\utils.py\", line 350, in get_openapi\r\n flat_models=flat_models, model_name_map=model_name_map # type: ignore\r\n File \"c:\\users\\dell\\appdata\\local\\programs\\python\\python37\\lib\\site-packages\\fastapi\\utils.py\", line 26, in get_model_definitions\r\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX # type: ignore\r\n File \"pydantic\\schema.py\", line 455, in pydantic.schema.model_process_schema\r\n File \"pydantic\\schema.py\", line 491, in pydantic.schema.model_type_schema\r\n File \"pydantic\\schema.py\", line 185, in pydantic.schema.field_schema\r\n File \"pydantic\\schema.py\", line 372, in pydantic.schema.field_type_schema\r\n File \"pydantic\\schema.py\", line 614, in pydantic.schema.field_singleton_schema\r\n File \"pydantic\\schema.py\", line 539, in pydantic.schema.field_singleton_sub_fields_schema\r\n File \"pydantic\\schema.py\", line 412, in pydantic.schema.field_type_schema\r\n File \"pydantic\\schema.py\", line 665, in pydantic.schema.field_singleton_schema\r\nKeyError: <class 'models.AModel._InnerClass'>\r\n```\r\nI temporarily solved the issue by editing the `get_long_model_name` function in [file](https://github.com/samuelcolvin/pydantic/blob/master/pydantic/schema.py) of my local copy to use model.\\_\\_qualname\\_\\_ (only for python 3.3+) instead of model.\\_\\_name\\_\\_:\r\n```py\r\n...\r\ndef get_long_model_name(model: Type['BaseModel']) -> str:\r\n return f'{model.__module__}__{model.__qualname__}'.replace('.', '__')\r\n...\r\n```\n", "before_files": [{"content": "import re\nimport warnings\nfrom datetime import date, datetime, time, timedelta\nfrom decimal import Decimal\nfrom enum import Enum\nfrom ipaddress import IPv4Address, IPv4Interface, IPv4Network, IPv6Address, IPv6Interface, IPv6Network\nfrom pathlib import Path\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Callable,\n Dict,\n FrozenSet,\n Iterable,\n List,\n Optional,\n Pattern,\n Sequence,\n Set,\n Tuple,\n Type,\n TypeVar,\n Union,\n cast,\n)\nfrom uuid import UUID\n\nfrom .fields import (\n SHAPE_FROZENSET,\n SHAPE_ITERABLE,\n SHAPE_LIST,\n SHAPE_MAPPING,\n SHAPE_SEQUENCE,\n SHAPE_SET,\n SHAPE_SINGLETON,\n SHAPE_TUPLE,\n SHAPE_TUPLE_ELLIPSIS,\n FieldInfo,\n ModelField,\n)\nfrom .json import pydantic_encoder\nfrom .networks import AnyUrl, EmailStr\nfrom .types import (\n ConstrainedDecimal,\n ConstrainedFloat,\n ConstrainedInt,\n ConstrainedList,\n ConstrainedSet,\n ConstrainedStr,\n SecretBytes,\n SecretStr,\n conbytes,\n condecimal,\n confloat,\n conint,\n conlist,\n conset,\n constr,\n)\nfrom .typing import (\n NONE_TYPES,\n ForwardRef,\n Literal,\n get_args,\n get_origin,\n is_callable_type,\n is_literal_type,\n literal_values,\n)\nfrom .utils import ROOT_KEY, get_model, lenient_issubclass, sequence_like\n\nif TYPE_CHECKING:\n from .dataclasses import Dataclass # noqa: F401\n from .main import BaseModel # noqa: F401\n\ndefault_prefix = '#/definitions/'\ndefault_ref_template = '#/definitions/{model}'\n\nTypeModelOrEnum = Union[Type['BaseModel'], Type[Enum]]\nTypeModelSet = Set[TypeModelOrEnum]\n\n\ndef schema(\n models: Sequence[Union[Type['BaseModel'], Type['Dataclass']]],\n *,\n by_alias: bool = True,\n title: Optional[str] = None,\n description: Optional[str] = None,\n ref_prefix: Optional[str] = None,\n ref_template: str = default_ref_template,\n) -> Dict[str, Any]:\n \"\"\"\n Process a list of models and generate a single JSON Schema with all of them defined in the ``definitions``\n top-level JSON key, including their sub-models.\n\n :param models: a list of models to include in the generated JSON Schema\n :param by_alias: generate the schemas using the aliases defined, if any\n :param title: title for the generated schema that includes the definitions\n :param description: description for the generated schema\n :param ref_prefix: the JSON Pointer prefix for schema references with ``$ref``, if None, will be set to the\n default of ``#/definitions/``. Update it if you want the schemas to reference the definitions somewhere\n else, e.g. for OpenAPI use ``#/components/schemas/``. The resulting generated schemas will still be at the\n top-level key ``definitions``, so you can extract them from there. But all the references will have the set\n prefix.\n :param ref_template: Use a ``string.format()`` template for ``$ref`` instead of a prefix. This can be useful\n for references that cannot be represented by ``ref_prefix`` such as a definition stored in another file. For\n a sibling json file in a ``/schemas`` directory use ``\"/schemas/${model}.json#\"``.\n :return: dict with the JSON Schema with a ``definitions`` top-level key including the schema definitions for\n the models and sub-models passed in ``models``.\n \"\"\"\n clean_models = [get_model(model) for model in models]\n flat_models = get_flat_models_from_models(clean_models)\n model_name_map = get_model_name_map(flat_models)\n definitions = {}\n output_schema: Dict[str, Any] = {}\n if title:\n output_schema['title'] = title\n if description:\n output_schema['description'] = description\n for model in clean_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model,\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n if definitions:\n output_schema['definitions'] = definitions\n return output_schema\n\n\ndef model_schema(\n model: Union[Type['BaseModel'], Type['Dataclass']],\n by_alias: bool = True,\n ref_prefix: Optional[str] = None,\n ref_template: str = default_ref_template,\n) -> Dict[str, Any]:\n \"\"\"\n Generate a JSON Schema for one model. With all the sub-models defined in the ``definitions`` top-level\n JSON key.\n\n :param model: a Pydantic model (a class that inherits from BaseModel)\n :param by_alias: generate the schemas using the aliases defined, if any\n :param ref_prefix: the JSON Pointer prefix for schema references with ``$ref``, if None, will be set to the\n default of ``#/definitions/``. Update it if you want the schemas to reference the definitions somewhere\n else, e.g. for OpenAPI use ``#/components/schemas/``. The resulting generated schemas will still be at the\n top-level key ``definitions``, so you can extract them from there. But all the references will have the set\n prefix.\n :param ref_template: Use a ``string.format()`` template for ``$ref`` instead of a prefix. This can be useful for\n references that cannot be represented by ``ref_prefix`` such as a definition stored in another file. For a\n sibling json file in a ``/schemas`` directory use ``\"/schemas/${model}.json#\"``.\n :return: dict with the JSON Schema for the passed ``model``\n \"\"\"\n model = get_model(model)\n flat_models = get_flat_models_from_model(model)\n model_name_map = get_model_name_map(flat_models)\n model_name = model_name_map[model]\n m_schema, m_definitions, nested_models = model_process_schema(\n model, by_alias=by_alias, model_name_map=model_name_map, ref_prefix=ref_prefix, ref_template=ref_template\n )\n if model_name in nested_models:\n # model_name is in Nested models, it has circular references\n m_definitions[model_name] = m_schema\n m_schema = get_schema_ref(model_name, ref_prefix, ref_template, False)\n if m_definitions:\n m_schema.update({'definitions': m_definitions})\n return m_schema\n\n\ndef get_field_info_schema(field: ModelField) -> Tuple[Dict[str, Any], bool]:\n schema_overrides = False\n\n # If no title is explicitly set, we don't set title in the schema for enums.\n # The behaviour is the same as `BaseModel` reference, where the default title\n # is in the definitions part of the schema.\n schema: Dict[str, Any] = {}\n if field.field_info.title or not lenient_issubclass(field.type_, Enum):\n schema['title'] = field.field_info.title or field.alias.title().replace('_', ' ')\n\n if field.field_info.title:\n schema_overrides = True\n\n if field.field_info.description:\n schema['description'] = field.field_info.description\n schema_overrides = True\n\n if not field.required and not field.field_info.const and field.default is not None:\n schema['default'] = encode_default(field.default)\n schema_overrides = True\n\n return schema, schema_overrides\n\n\ndef field_schema(\n field: ModelField,\n *,\n by_alias: bool = True,\n model_name_map: Dict[TypeModelOrEnum, str],\n ref_prefix: Optional[str] = None,\n ref_template: str = default_ref_template,\n known_models: TypeModelSet = None,\n) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:\n \"\"\"\n Process a Pydantic field and return a tuple with a JSON Schema for it as the first item.\n Also return a dictionary of definitions with models as keys and their schemas as values. If the passed field\n is a model and has sub-models, and those sub-models don't have overrides (as ``title``, ``default``, etc), they\n will be included in the definitions and referenced in the schema instead of included recursively.\n\n :param field: a Pydantic ``ModelField``\n :param by_alias: use the defined alias (if any) in the returned schema\n :param model_name_map: used to generate the JSON Schema references to other models included in the definitions\n :param ref_prefix: the JSON Pointer prefix to use for references to other schemas, if None, the default of\n #/definitions/ will be used\n :param ref_template: Use a ``string.format()`` template for ``$ref`` instead of a prefix. This can be useful for\n references that cannot be represented by ``ref_prefix`` such as a definition stored in another file. For a\n sibling json file in a ``/schemas`` directory use ``\"/schemas/${model}.json#\"``.\n :param known_models: used to solve circular references\n :return: tuple of the schema for this field and additional definitions\n \"\"\"\n s, schema_overrides = get_field_info_schema(field)\n\n validation_schema = get_field_schema_validations(field)\n if validation_schema:\n s.update(validation_schema)\n schema_overrides = True\n\n f_schema, f_definitions, f_nested_models = field_type_schema(\n field,\n by_alias=by_alias,\n model_name_map=model_name_map,\n schema_overrides=schema_overrides,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models or set(),\n )\n # $ref will only be returned when there are no schema_overrides\n if '$ref' in f_schema:\n return f_schema, f_definitions, f_nested_models\n else:\n s.update(f_schema)\n return s, f_definitions, f_nested_models\n\n\nnumeric_types = (int, float, Decimal)\n_str_types_attrs: Tuple[Tuple[str, Union[type, Tuple[type, ...]], str], ...] = (\n ('max_length', numeric_types, 'maxLength'),\n ('min_length', numeric_types, 'minLength'),\n ('regex', str, 'pattern'),\n)\n\n_numeric_types_attrs: Tuple[Tuple[str, Union[type, Tuple[type, ...]], str], ...] = (\n ('gt', numeric_types, 'exclusiveMinimum'),\n ('lt', numeric_types, 'exclusiveMaximum'),\n ('ge', numeric_types, 'minimum'),\n ('le', numeric_types, 'maximum'),\n ('multiple_of', numeric_types, 'multipleOf'),\n)\n\n\ndef get_field_schema_validations(field: ModelField) -> Dict[str, Any]:\n \"\"\"\n Get the JSON Schema validation keywords for a ``field`` with an annotation of\n a Pydantic ``FieldInfo`` with validation arguments.\n \"\"\"\n f_schema: Dict[str, Any] = {}\n\n if lenient_issubclass(field.type_, Enum):\n # schema is already updated by `enum_process_schema`; just update with field extra\n if field.field_info.extra:\n f_schema.update(field.field_info.extra)\n return f_schema\n\n if lenient_issubclass(field.type_, (str, bytes)):\n for attr_name, t, keyword in _str_types_attrs:\n attr = getattr(field.field_info, attr_name, None)\n if isinstance(attr, t):\n f_schema[keyword] = attr\n if lenient_issubclass(field.type_, numeric_types) and not issubclass(field.type_, bool):\n for attr_name, t, keyword in _numeric_types_attrs:\n attr = getattr(field.field_info, attr_name, None)\n if isinstance(attr, t):\n f_schema[keyword] = attr\n if field.field_info is not None and field.field_info.const:\n f_schema['const'] = field.default\n if field.field_info.extra:\n f_schema.update(field.field_info.extra)\n modify_schema = getattr(field.outer_type_, '__modify_schema__', None)\n if modify_schema:\n modify_schema(f_schema)\n return f_schema\n\n\ndef get_model_name_map(unique_models: TypeModelSet) -> Dict[TypeModelOrEnum, str]:\n \"\"\"\n Process a set of models and generate unique names for them to be used as keys in the JSON Schema\n definitions. By default the names are the same as the class name. But if two models in different Python\n modules have the same name (e.g. \"users.Model\" and \"items.Model\"), the generated names will be\n based on the Python module path for those conflicting models to prevent name collisions.\n\n :param unique_models: a Python set of models\n :return: dict mapping models to names\n \"\"\"\n name_model_map = {}\n conflicting_names: Set[str] = set()\n for model in unique_models:\n model_name = normalize_name(model.__name__)\n if model_name in conflicting_names:\n model_name = get_long_model_name(model)\n name_model_map[model_name] = model\n elif model_name in name_model_map:\n conflicting_names.add(model_name)\n conflicting_model = name_model_map.pop(model_name)\n name_model_map[get_long_model_name(conflicting_model)] = conflicting_model\n name_model_map[get_long_model_name(model)] = model\n else:\n name_model_map[model_name] = model\n return {v: k for k, v in name_model_map.items()}\n\n\ndef get_flat_models_from_model(model: Type['BaseModel'], known_models: TypeModelSet = None) -> TypeModelSet:\n \"\"\"\n Take a single ``model`` and generate a set with itself and all the sub-models in the tree. I.e. if you pass\n model ``Foo`` (subclass of Pydantic ``BaseModel``) as ``model``, and it has a field of type ``Bar`` (also\n subclass of ``BaseModel``) and that model ``Bar`` has a field of type ``Baz`` (also subclass of ``BaseModel``),\n the return value will be ``set([Foo, Bar, Baz])``.\n\n :param model: a Pydantic ``BaseModel`` subclass\n :param known_models: used to solve circular references\n :return: a set with the initial model and all its sub-models\n \"\"\"\n known_models = known_models or set()\n flat_models: TypeModelSet = set()\n flat_models.add(model)\n known_models |= flat_models\n fields = cast(Sequence[ModelField], model.__fields__.values())\n flat_models |= get_flat_models_from_fields(fields, known_models=known_models)\n return flat_models\n\n\ndef get_flat_models_from_field(field: ModelField, known_models: TypeModelSet) -> TypeModelSet:\n \"\"\"\n Take a single Pydantic ``ModelField`` (from a model) that could have been declared as a sublcass of BaseModel\n (so, it could be a submodel), and generate a set with its model and all the sub-models in the tree.\n I.e. if you pass a field that was declared to be of type ``Foo`` (subclass of BaseModel) as ``field``, and that\n model ``Foo`` has a field of type ``Bar`` (also subclass of ``BaseModel``) and that model ``Bar`` has a field of\n type ``Baz`` (also subclass of ``BaseModel``), the return value will be ``set([Foo, Bar, Baz])``.\n\n :param field: a Pydantic ``ModelField``\n :param known_models: used to solve circular references\n :return: a set with the model used in the declaration for this field, if any, and all its sub-models\n \"\"\"\n from .dataclasses import dataclass, is_builtin_dataclass\n from .main import BaseModel # noqa: F811\n\n flat_models: TypeModelSet = set()\n\n # Handle dataclass-based models\n if is_builtin_dataclass(field.type_):\n field.type_ = dataclass(field.type_)\n field_type = field.type_\n if lenient_issubclass(getattr(field_type, '__pydantic_model__', None), BaseModel):\n field_type = field_type.__pydantic_model__\n if field.sub_fields:\n flat_models |= get_flat_models_from_fields(field.sub_fields, known_models=known_models)\n elif lenient_issubclass(field_type, BaseModel) and field_type not in known_models:\n flat_models |= get_flat_models_from_model(field_type, known_models=known_models)\n elif lenient_issubclass(field_type, Enum):\n flat_models.add(field_type)\n return flat_models\n\n\ndef get_flat_models_from_fields(fields: Sequence[ModelField], known_models: TypeModelSet) -> TypeModelSet:\n \"\"\"\n Take a list of Pydantic ``ModelField``s (from a model) that could have been declared as sublcasses of ``BaseModel``\n (so, any of them could be a submodel), and generate a set with their models and all the sub-models in the tree.\n I.e. if you pass a the fields of a model ``Foo`` (subclass of ``BaseModel``) as ``fields``, and on of them has a\n field of type ``Bar`` (also subclass of ``BaseModel``) and that model ``Bar`` has a field of type ``Baz`` (also\n subclass of ``BaseModel``), the return value will be ``set([Foo, Bar, Baz])``.\n\n :param fields: a list of Pydantic ``ModelField``s\n :param known_models: used to solve circular references\n :return: a set with any model declared in the fields, and all their sub-models\n \"\"\"\n flat_models: TypeModelSet = set()\n for field in fields:\n flat_models |= get_flat_models_from_field(field, known_models=known_models)\n return flat_models\n\n\ndef get_flat_models_from_models(models: Sequence[Type['BaseModel']]) -> TypeModelSet:\n \"\"\"\n Take a list of ``models`` and generate a set with them and all their sub-models in their trees. I.e. if you pass\n a list of two models, ``Foo`` and ``Bar``, both subclasses of Pydantic ``BaseModel`` as models, and ``Bar`` has\n a field of type ``Baz`` (also subclass of ``BaseModel``), the return value will be ``set([Foo, Bar, Baz])``.\n \"\"\"\n flat_models: TypeModelSet = set()\n for model in models:\n flat_models |= get_flat_models_from_model(model)\n return flat_models\n\n\ndef get_long_model_name(model: TypeModelOrEnum) -> str:\n return f'{model.__module__}__{model.__name__}'.replace('.', '__')\n\n\ndef field_type_schema(\n field: ModelField,\n *,\n by_alias: bool,\n model_name_map: Dict[TypeModelOrEnum, str],\n ref_template: str,\n schema_overrides: bool = False,\n ref_prefix: Optional[str] = None,\n known_models: TypeModelSet,\n) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:\n \"\"\"\n Used by ``field_schema()``, you probably should be using that function.\n\n Take a single ``field`` and generate the schema for its type only, not including additional\n information as title, etc. Also return additional schema definitions, from sub-models.\n \"\"\"\n definitions = {}\n nested_models: Set[str] = set()\n f_schema: Dict[str, Any]\n if field.shape in {SHAPE_LIST, SHAPE_TUPLE_ELLIPSIS, SHAPE_SEQUENCE, SHAPE_SET, SHAPE_FROZENSET, SHAPE_ITERABLE}:\n items_schema, f_definitions, f_nested_models = field_singleton_schema(\n field,\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n definitions.update(f_definitions)\n nested_models.update(f_nested_models)\n f_schema = {'type': 'array', 'items': items_schema}\n if field.shape in {SHAPE_SET, SHAPE_FROZENSET}:\n f_schema['uniqueItems'] = True\n\n elif field.shape == SHAPE_MAPPING:\n f_schema = {'type': 'object'}\n key_field = cast(ModelField, field.key_field)\n regex = getattr(key_field.type_, 'regex', None)\n items_schema, f_definitions, f_nested_models = field_singleton_schema(\n field,\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n definitions.update(f_definitions)\n nested_models.update(f_nested_models)\n if regex:\n # Dict keys have a regex pattern\n # items_schema might be a schema or empty dict, add it either way\n f_schema['patternProperties'] = {regex.pattern: items_schema}\n elif items_schema:\n # The dict values are not simply Any, so they need a schema\n f_schema['additionalProperties'] = items_schema\n elif field.shape == SHAPE_TUPLE:\n sub_schema = []\n sub_fields = cast(List[ModelField], field.sub_fields)\n for sf in sub_fields:\n sf_schema, sf_definitions, sf_nested_models = field_type_schema(\n sf,\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n definitions.update(sf_definitions)\n nested_models.update(sf_nested_models)\n sub_schema.append(sf_schema)\n if len(sub_schema) == 1:\n sub_schema = sub_schema[0] # type: ignore\n f_schema = {'type': 'array', 'items': sub_schema}\n else:\n assert field.shape == SHAPE_SINGLETON, field.shape\n f_schema, f_definitions, f_nested_models = field_singleton_schema(\n field,\n by_alias=by_alias,\n model_name_map=model_name_map,\n schema_overrides=schema_overrides,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n definitions.update(f_definitions)\n nested_models.update(f_nested_models)\n\n # check field type to avoid repeated calls to the same __modify_schema__ method\n if field.type_ != field.outer_type_:\n modify_schema = getattr(field.outer_type_, '__modify_schema__', None)\n if modify_schema:\n modify_schema(f_schema)\n return f_schema, definitions, nested_models\n\n\ndef model_process_schema(\n model: TypeModelOrEnum,\n *,\n by_alias: bool = True,\n model_name_map: Dict[TypeModelOrEnum, str],\n ref_prefix: Optional[str] = None,\n ref_template: str = default_ref_template,\n known_models: TypeModelSet = None,\n) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:\n \"\"\"\n Used by ``model_schema()``, you probably should be using that function.\n\n Take a single ``model`` and generate its schema. Also return additional schema definitions, from sub-models. The\n sub-models of the returned schema will be referenced, but their definitions will not be included in the schema. All\n the definitions are returned as the second value.\n \"\"\"\n from inspect import getdoc, signature\n\n known_models = known_models or set()\n if lenient_issubclass(model, Enum):\n model = cast(Type[Enum], model)\n s = enum_process_schema(model)\n return s, {}, set()\n model = cast(Type['BaseModel'], model)\n s = {'title': model.__config__.title or model.__name__}\n doc = getdoc(model)\n if doc:\n s['description'] = doc\n known_models.add(model)\n m_schema, m_definitions, nested_models = model_type_schema(\n model,\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n s.update(m_schema)\n schema_extra = model.__config__.schema_extra\n if callable(schema_extra):\n if len(signature(schema_extra).parameters) == 1:\n schema_extra(s)\n else:\n schema_extra(s, model)\n else:\n s.update(schema_extra)\n return s, m_definitions, nested_models\n\n\ndef model_type_schema(\n model: Type['BaseModel'],\n *,\n by_alias: bool,\n model_name_map: Dict[TypeModelOrEnum, str],\n ref_template: str,\n ref_prefix: Optional[str] = None,\n known_models: TypeModelSet,\n) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:\n \"\"\"\n You probably should be using ``model_schema()``, this function is indirectly used by that function.\n\n Take a single ``model`` and generate the schema for its type only, not including additional\n information as title, etc. Also return additional schema definitions, from sub-models.\n \"\"\"\n properties = {}\n required = []\n definitions: Dict[str, Any] = {}\n nested_models: Set[str] = set()\n for k, f in model.__fields__.items():\n try:\n f_schema, f_definitions, f_nested_models = field_schema(\n f,\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n except SkipField as skip:\n warnings.warn(skip.message, UserWarning)\n continue\n definitions.update(f_definitions)\n nested_models.update(f_nested_models)\n if by_alias:\n properties[f.alias] = f_schema\n if f.required:\n required.append(f.alias)\n else:\n properties[k] = f_schema\n if f.required:\n required.append(k)\n if ROOT_KEY in properties:\n out_schema = properties[ROOT_KEY]\n out_schema['title'] = model.__config__.title or model.__name__\n else:\n out_schema = {'type': 'object', 'properties': properties}\n if required:\n out_schema['required'] = required\n if model.__config__.extra == 'forbid':\n out_schema['additionalProperties'] = False\n return out_schema, definitions, nested_models\n\n\ndef enum_process_schema(enum: Type[Enum]) -> Dict[str, Any]:\n \"\"\"\n Take a single `enum` and generate its schema.\n\n This is similar to the `model_process_schema` function, but applies to ``Enum`` objects.\n \"\"\"\n from inspect import getdoc\n\n schema: Dict[str, Any] = {\n 'title': enum.__name__,\n # Python assigns all enums a default docstring value of 'An enumeration', so\n # all enums will have a description field even if not explicitly provided.\n 'description': getdoc(enum),\n # Add enum values and the enum field type to the schema.\n 'enum': [item.value for item in cast(Iterable[Enum], enum)],\n }\n\n add_field_type_to_schema(enum, schema)\n\n modify_schema = getattr(enum, '__modify_schema__', None)\n if modify_schema:\n modify_schema(schema)\n\n return schema\n\n\ndef field_singleton_sub_fields_schema(\n sub_fields: Sequence[ModelField],\n *,\n by_alias: bool,\n model_name_map: Dict[TypeModelOrEnum, str],\n ref_template: str,\n schema_overrides: bool = False,\n ref_prefix: Optional[str] = None,\n known_models: TypeModelSet,\n) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:\n \"\"\"\n This function is indirectly used by ``field_schema()``, you probably should be using that function.\n\n Take a list of Pydantic ``ModelField`` from the declaration of a type with parameters, and generate their\n schema. I.e., fields used as \"type parameters\", like ``str`` and ``int`` in ``Tuple[str, int]``.\n \"\"\"\n definitions = {}\n nested_models: Set[str] = set()\n if len(sub_fields) == 1:\n return field_type_schema(\n sub_fields[0],\n by_alias=by_alias,\n model_name_map=model_name_map,\n schema_overrides=schema_overrides,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n else:\n sub_field_schemas = []\n for sf in sub_fields:\n sub_schema, sub_definitions, sub_nested_models = field_type_schema(\n sf,\n by_alias=by_alias,\n model_name_map=model_name_map,\n schema_overrides=schema_overrides,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n definitions.update(sub_definitions)\n if schema_overrides and 'allOf' in sub_schema:\n # if the sub_field is a referenced schema we only need the referenced\n # object. Otherwise we will end up with several allOf inside anyOf.\n # See https://github.com/samuelcolvin/pydantic/issues/1209\n sub_schema = sub_schema['allOf'][0]\n sub_field_schemas.append(sub_schema)\n nested_models.update(sub_nested_models)\n return {'anyOf': sub_field_schemas}, definitions, nested_models\n\n\n# Order is important, e.g. subclasses of str must go before str\n# this is used only for standard library types, custom types should use __modify_schema__ instead\nfield_class_to_schema: Tuple[Tuple[Any, Dict[str, Any]], ...] = (\n (Path, {'type': 'string', 'format': 'path'}),\n (datetime, {'type': 'string', 'format': 'date-time'}),\n (date, {'type': 'string', 'format': 'date'}),\n (time, {'type': 'string', 'format': 'time'}),\n (timedelta, {'type': 'number', 'format': 'time-delta'}),\n (IPv4Network, {'type': 'string', 'format': 'ipv4network'}),\n (IPv6Network, {'type': 'string', 'format': 'ipv6network'}),\n (IPv4Interface, {'type': 'string', 'format': 'ipv4interface'}),\n (IPv6Interface, {'type': 'string', 'format': 'ipv6interface'}),\n (IPv4Address, {'type': 'string', 'format': 'ipv4'}),\n (IPv6Address, {'type': 'string', 'format': 'ipv6'}),\n (Pattern, {'type': 'string', 'format': 'regex'}),\n (str, {'type': 'string'}),\n (bytes, {'type': 'string', 'format': 'binary'}),\n (bool, {'type': 'boolean'}),\n (int, {'type': 'integer'}),\n (float, {'type': 'number'}),\n (Decimal, {'type': 'number'}),\n (UUID, {'type': 'string', 'format': 'uuid'}),\n (dict, {'type': 'object'}),\n (list, {'type': 'array', 'items': {}}),\n (tuple, {'type': 'array', 'items': {}}),\n (set, {'type': 'array', 'items': {}, 'uniqueItems': True}),\n (frozenset, {'type': 'array', 'items': {}, 'uniqueItems': True}),\n)\n\njson_scheme = {'type': 'string', 'format': 'json-string'}\n\n\ndef add_field_type_to_schema(field_type: Any, schema: Dict[str, Any]) -> None:\n \"\"\"\n Update the given `schema` with the type-specific metadata for the given `field_type`.\n\n This function looks through `field_class_to_schema` for a class that matches the given `field_type`,\n and then modifies the given `schema` with the information from that type.\n \"\"\"\n for type_, t_schema in field_class_to_schema:\n # Fallback for `typing.Pattern` as it is not a valid class\n if lenient_issubclass(field_type, type_) or field_type is type_ is Pattern:\n schema.update(t_schema)\n break\n\n\ndef get_schema_ref(name: str, ref_prefix: Optional[str], ref_template: str, schema_overrides: bool) -> Dict[str, Any]:\n if ref_prefix:\n schema_ref = {'$ref': ref_prefix + name}\n else:\n schema_ref = {'$ref': ref_template.format(model=name)}\n return {'allOf': [schema_ref]} if schema_overrides else schema_ref\n\n\ndef field_singleton_schema( # noqa: C901 (ignore complexity)\n field: ModelField,\n *,\n by_alias: bool,\n model_name_map: Dict[TypeModelOrEnum, str],\n ref_template: str,\n schema_overrides: bool = False,\n ref_prefix: Optional[str] = None,\n known_models: TypeModelSet,\n) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:\n \"\"\"\n This function is indirectly used by ``field_schema()``, you should probably be using that function.\n\n Take a single Pydantic ``ModelField``, and return its schema and any additional definitions from sub-models.\n \"\"\"\n from .main import BaseModel # noqa: F811\n\n definitions: Dict[str, Any] = {}\n nested_models: Set[str] = set()\n if field.sub_fields:\n return field_singleton_sub_fields_schema(\n field.sub_fields,\n by_alias=by_alias,\n model_name_map=model_name_map,\n schema_overrides=schema_overrides,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n if field.type_ is Any or field.type_.__class__ == TypeVar:\n return {}, definitions, nested_models # no restrictions\n if field.type_ in NONE_TYPES:\n return {'type': 'null'}, definitions, nested_models\n if is_callable_type(field.type_):\n raise SkipField(f'Callable {field.name} was excluded from schema since JSON schema has no equivalent type.')\n f_schema: Dict[str, Any] = {}\n if field.field_info is not None and field.field_info.const:\n f_schema['const'] = field.default\n field_type = field.type_\n if is_literal_type(field_type):\n values = literal_values(field_type)\n if len(values) > 1:\n return field_schema(\n multivalue_literal_field_for_schema(values, field),\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n literal_value = values[0]\n field_type = literal_value.__class__\n f_schema['const'] = literal_value\n\n if lenient_issubclass(field_type, Enum):\n enum_name = model_name_map[field_type]\n f_schema, schema_overrides = get_field_info_schema(field)\n f_schema.update(get_schema_ref(enum_name, ref_prefix, ref_template, schema_overrides))\n definitions[enum_name] = enum_process_schema(field_type)\n else:\n add_field_type_to_schema(field_type, f_schema)\n\n modify_schema = getattr(field_type, '__modify_schema__', None)\n if modify_schema:\n modify_schema(f_schema)\n\n if f_schema:\n return f_schema, definitions, nested_models\n\n # Handle dataclass-based models\n if lenient_issubclass(getattr(field_type, '__pydantic_model__', None), BaseModel):\n field_type = field_type.__pydantic_model__\n\n if issubclass(field_type, BaseModel):\n model_name = model_name_map[field_type]\n if field_type not in known_models:\n sub_schema, sub_definitions, sub_nested_models = model_process_schema(\n field_type,\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n definitions.update(sub_definitions)\n definitions[model_name] = sub_schema\n nested_models.update(sub_nested_models)\n else:\n nested_models.add(model_name)\n schema_ref = get_schema_ref(model_name, ref_prefix, ref_template, schema_overrides)\n return schema_ref, definitions, nested_models\n\n raise ValueError(f'Value not declarable with JSON Schema, field: {field}')\n\n\ndef multivalue_literal_field_for_schema(values: Tuple[Any, ...], field: ModelField) -> ModelField:\n return ModelField(\n name=field.name,\n type_=Union[tuple(Literal[value] for value in values)], # type: ignore\n class_validators=field.class_validators,\n model_config=field.model_config,\n default=field.default,\n required=field.required,\n alias=field.alias,\n field_info=field.field_info,\n )\n\n\ndef encode_default(dft: Any) -> Any:\n if isinstance(dft, (int, float, str)):\n return dft\n elif sequence_like(dft):\n t = dft.__class__\n return t(encode_default(v) for v in dft)\n elif isinstance(dft, dict):\n return {encode_default(k): encode_default(v) for k, v in dft.items()}\n elif dft is None:\n return None\n else:\n return pydantic_encoder(dft)\n\n\n_map_types_constraint: Dict[Any, Callable[..., type]] = {int: conint, float: confloat, Decimal: condecimal}\n_field_constraints = {\n 'min_length',\n 'max_length',\n 'regex',\n 'gt',\n 'lt',\n 'ge',\n 'le',\n 'multiple_of',\n 'min_items',\n 'max_items',\n}\n\n\ndef get_annotation_from_field_info(annotation: Any, field_info: FieldInfo, field_name: str) -> Type[Any]: # noqa: C901\n \"\"\"\n Get an annotation with validation implemented for numbers and strings based on the field_info.\n\n :param annotation: an annotation from a field specification, as ``str``, ``ConstrainedStr``\n :param field_info: an instance of FieldInfo, possibly with declarations for validations and JSON Schema\n :param field_name: name of the field for use in error messages\n :return: the same ``annotation`` if unmodified or a new annotation with validation in place\n \"\"\"\n constraints = {f for f in _field_constraints if getattr(field_info, f) is not None}\n if not constraints:\n return annotation\n used_constraints: Set[str] = set()\n\n def go(type_: Any) -> Type[Any]:\n if (\n is_literal_type(annotation)\n or isinstance(type_, ForwardRef)\n or lenient_issubclass(type_, (ConstrainedList, ConstrainedSet))\n ):\n return type_\n origin = get_origin(type_)\n if origin is not None:\n args: Tuple[Any, ...] = get_args(type_)\n if any(isinstance(a, ForwardRef) for a in args):\n # forward refs cause infinite recursion below\n return type_\n\n if origin is Union:\n return Union[tuple(go(a) for a in args)] # type: ignore\n\n if issubclass(origin, List) and (field_info.min_items is not None or field_info.max_items is not None):\n used_constraints.update({'min_items', 'max_items'})\n return conlist(go(args[0]), min_items=field_info.min_items, max_items=field_info.max_items)\n\n if issubclass(origin, Set) and (field_info.min_items is not None or field_info.max_items is not None):\n used_constraints.update({'min_items', 'max_items'})\n return conset(go(args[0]), min_items=field_info.min_items, max_items=field_info.max_items)\n\n for t in (Tuple, List, Set, FrozenSet, Sequence):\n if issubclass(origin, t): # type: ignore\n return t[tuple(go(a) for a in args)] # type: ignore\n\n if issubclass(origin, Dict):\n return Dict[args[0], go(args[1])] # type: ignore\n\n attrs: Optional[Tuple[str, ...]] = None\n constraint_func: Optional[Callable[..., type]] = None\n if isinstance(type_, type):\n if issubclass(type_, (SecretStr, SecretBytes)):\n attrs = ('max_length', 'min_length')\n\n def constraint_func(**kwargs: Any) -> Type[Any]:\n return type(type_.__name__, (type_,), kwargs)\n\n elif issubclass(type_, str) and not issubclass(type_, (EmailStr, AnyUrl, ConstrainedStr)):\n attrs = ('max_length', 'min_length', 'regex')\n constraint_func = constr\n elif issubclass(type_, bytes):\n attrs = ('max_length', 'min_length', 'regex')\n constraint_func = conbytes\n elif issubclass(type_, numeric_types) and not issubclass(\n type_, (ConstrainedInt, ConstrainedFloat, ConstrainedDecimal, ConstrainedList, ConstrainedSet, bool)\n ):\n # Is numeric type\n attrs = ('gt', 'lt', 'ge', 'le', 'multiple_of')\n numeric_type = next(t for t in numeric_types if issubclass(type_, t)) # pragma: no branch\n constraint_func = _map_types_constraint[numeric_type]\n\n if attrs:\n used_constraints.update(set(attrs))\n kwargs = {\n attr_name: attr\n for attr_name, attr in ((attr_name, getattr(field_info, attr_name)) for attr_name in attrs)\n if attr is not None\n }\n if kwargs:\n constraint_func = cast(Callable[..., type], constraint_func)\n return constraint_func(**kwargs)\n return type_\n\n ans = go(annotation)\n\n unused_constraints = constraints - used_constraints\n if unused_constraints:\n raise ValueError(\n f'On field \"{field_name}\" the following field constraints are set but not enforced: '\n f'{\", \".join(unused_constraints)}. '\n f'\\nFor more details see https://pydantic-docs.helpmanual.io/usage/schema/#unenforced-field-constraints'\n )\n\n return ans\n\n\ndef normalize_name(name: str) -> str:\n \"\"\"\n Normalizes the given name. This can be applied to either a model *or* enum.\n \"\"\"\n return re.sub(r'[^a-zA-Z0-9.\\-_]', '_', name)\n\n\nclass SkipField(Exception):\n \"\"\"\n Utility exception used to exclude fields from schema.\n \"\"\"\n\n def __init__(self, message: str) -> None:\n self.message = message\n", "path": "pydantic/schema.py"}], "after_files": [{"content": "import re\nimport warnings\nfrom datetime import date, datetime, time, timedelta\nfrom decimal import Decimal\nfrom enum import Enum\nfrom ipaddress import IPv4Address, IPv4Interface, IPv4Network, IPv6Address, IPv6Interface, IPv6Network\nfrom pathlib import Path\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Callable,\n Dict,\n FrozenSet,\n Iterable,\n List,\n Optional,\n Pattern,\n Sequence,\n Set,\n Tuple,\n Type,\n TypeVar,\n Union,\n cast,\n)\nfrom uuid import UUID\n\nfrom .fields import (\n SHAPE_FROZENSET,\n SHAPE_ITERABLE,\n SHAPE_LIST,\n SHAPE_MAPPING,\n SHAPE_SEQUENCE,\n SHAPE_SET,\n SHAPE_SINGLETON,\n SHAPE_TUPLE,\n SHAPE_TUPLE_ELLIPSIS,\n FieldInfo,\n ModelField,\n)\nfrom .json import pydantic_encoder\nfrom .networks import AnyUrl, EmailStr\nfrom .types import (\n ConstrainedDecimal,\n ConstrainedFloat,\n ConstrainedInt,\n ConstrainedList,\n ConstrainedSet,\n ConstrainedStr,\n SecretBytes,\n SecretStr,\n conbytes,\n condecimal,\n confloat,\n conint,\n conlist,\n conset,\n constr,\n)\nfrom .typing import (\n NONE_TYPES,\n ForwardRef,\n Literal,\n get_args,\n get_origin,\n is_callable_type,\n is_literal_type,\n literal_values,\n)\nfrom .utils import ROOT_KEY, get_model, lenient_issubclass, sequence_like\n\nif TYPE_CHECKING:\n from .dataclasses import Dataclass # noqa: F401\n from .main import BaseModel # noqa: F401\n\ndefault_prefix = '#/definitions/'\ndefault_ref_template = '#/definitions/{model}'\n\nTypeModelOrEnum = Union[Type['BaseModel'], Type[Enum]]\nTypeModelSet = Set[TypeModelOrEnum]\n\n\ndef schema(\n models: Sequence[Union[Type['BaseModel'], Type['Dataclass']]],\n *,\n by_alias: bool = True,\n title: Optional[str] = None,\n description: Optional[str] = None,\n ref_prefix: Optional[str] = None,\n ref_template: str = default_ref_template,\n) -> Dict[str, Any]:\n \"\"\"\n Process a list of models and generate a single JSON Schema with all of them defined in the ``definitions``\n top-level JSON key, including their sub-models.\n\n :param models: a list of models to include in the generated JSON Schema\n :param by_alias: generate the schemas using the aliases defined, if any\n :param title: title for the generated schema that includes the definitions\n :param description: description for the generated schema\n :param ref_prefix: the JSON Pointer prefix for schema references with ``$ref``, if None, will be set to the\n default of ``#/definitions/``. Update it if you want the schemas to reference the definitions somewhere\n else, e.g. for OpenAPI use ``#/components/schemas/``. The resulting generated schemas will still be at the\n top-level key ``definitions``, so you can extract them from there. But all the references will have the set\n prefix.\n :param ref_template: Use a ``string.format()`` template for ``$ref`` instead of a prefix. This can be useful\n for references that cannot be represented by ``ref_prefix`` such as a definition stored in another file. For\n a sibling json file in a ``/schemas`` directory use ``\"/schemas/${model}.json#\"``.\n :return: dict with the JSON Schema with a ``definitions`` top-level key including the schema definitions for\n the models and sub-models passed in ``models``.\n \"\"\"\n clean_models = [get_model(model) for model in models]\n flat_models = get_flat_models_from_models(clean_models)\n model_name_map = get_model_name_map(flat_models)\n definitions = {}\n output_schema: Dict[str, Any] = {}\n if title:\n output_schema['title'] = title\n if description:\n output_schema['description'] = description\n for model in clean_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model,\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n if definitions:\n output_schema['definitions'] = definitions\n return output_schema\n\n\ndef model_schema(\n model: Union[Type['BaseModel'], Type['Dataclass']],\n by_alias: bool = True,\n ref_prefix: Optional[str] = None,\n ref_template: str = default_ref_template,\n) -> Dict[str, Any]:\n \"\"\"\n Generate a JSON Schema for one model. With all the sub-models defined in the ``definitions`` top-level\n JSON key.\n\n :param model: a Pydantic model (a class that inherits from BaseModel)\n :param by_alias: generate the schemas using the aliases defined, if any\n :param ref_prefix: the JSON Pointer prefix for schema references with ``$ref``, if None, will be set to the\n default of ``#/definitions/``. Update it if you want the schemas to reference the definitions somewhere\n else, e.g. for OpenAPI use ``#/components/schemas/``. The resulting generated schemas will still be at the\n top-level key ``definitions``, so you can extract them from there. But all the references will have the set\n prefix.\n :param ref_template: Use a ``string.format()`` template for ``$ref`` instead of a prefix. This can be useful for\n references that cannot be represented by ``ref_prefix`` such as a definition stored in another file. For a\n sibling json file in a ``/schemas`` directory use ``\"/schemas/${model}.json#\"``.\n :return: dict with the JSON Schema for the passed ``model``\n \"\"\"\n model = get_model(model)\n flat_models = get_flat_models_from_model(model)\n model_name_map = get_model_name_map(flat_models)\n model_name = model_name_map[model]\n m_schema, m_definitions, nested_models = model_process_schema(\n model, by_alias=by_alias, model_name_map=model_name_map, ref_prefix=ref_prefix, ref_template=ref_template\n )\n if model_name in nested_models:\n # model_name is in Nested models, it has circular references\n m_definitions[model_name] = m_schema\n m_schema = get_schema_ref(model_name, ref_prefix, ref_template, False)\n if m_definitions:\n m_schema.update({'definitions': m_definitions})\n return m_schema\n\n\ndef get_field_info_schema(field: ModelField) -> Tuple[Dict[str, Any], bool]:\n schema_overrides = False\n\n # If no title is explicitly set, we don't set title in the schema for enums.\n # The behaviour is the same as `BaseModel` reference, where the default title\n # is in the definitions part of the schema.\n schema: Dict[str, Any] = {}\n if field.field_info.title or not lenient_issubclass(field.type_, Enum):\n schema['title'] = field.field_info.title or field.alias.title().replace('_', ' ')\n\n if field.field_info.title:\n schema_overrides = True\n\n if field.field_info.description:\n schema['description'] = field.field_info.description\n schema_overrides = True\n\n if not field.required and not field.field_info.const and field.default is not None:\n schema['default'] = encode_default(field.default)\n schema_overrides = True\n\n return schema, schema_overrides\n\n\ndef field_schema(\n field: ModelField,\n *,\n by_alias: bool = True,\n model_name_map: Dict[TypeModelOrEnum, str],\n ref_prefix: Optional[str] = None,\n ref_template: str = default_ref_template,\n known_models: TypeModelSet = None,\n) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:\n \"\"\"\n Process a Pydantic field and return a tuple with a JSON Schema for it as the first item.\n Also return a dictionary of definitions with models as keys and their schemas as values. If the passed field\n is a model and has sub-models, and those sub-models don't have overrides (as ``title``, ``default``, etc), they\n will be included in the definitions and referenced in the schema instead of included recursively.\n\n :param field: a Pydantic ``ModelField``\n :param by_alias: use the defined alias (if any) in the returned schema\n :param model_name_map: used to generate the JSON Schema references to other models included in the definitions\n :param ref_prefix: the JSON Pointer prefix to use for references to other schemas, if None, the default of\n #/definitions/ will be used\n :param ref_template: Use a ``string.format()`` template for ``$ref`` instead of a prefix. This can be useful for\n references that cannot be represented by ``ref_prefix`` such as a definition stored in another file. For a\n sibling json file in a ``/schemas`` directory use ``\"/schemas/${model}.json#\"``.\n :param known_models: used to solve circular references\n :return: tuple of the schema for this field and additional definitions\n \"\"\"\n s, schema_overrides = get_field_info_schema(field)\n\n validation_schema = get_field_schema_validations(field)\n if validation_schema:\n s.update(validation_schema)\n schema_overrides = True\n\n f_schema, f_definitions, f_nested_models = field_type_schema(\n field,\n by_alias=by_alias,\n model_name_map=model_name_map,\n schema_overrides=schema_overrides,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models or set(),\n )\n # $ref will only be returned when there are no schema_overrides\n if '$ref' in f_schema:\n return f_schema, f_definitions, f_nested_models\n else:\n s.update(f_schema)\n return s, f_definitions, f_nested_models\n\n\nnumeric_types = (int, float, Decimal)\n_str_types_attrs: Tuple[Tuple[str, Union[type, Tuple[type, ...]], str], ...] = (\n ('max_length', numeric_types, 'maxLength'),\n ('min_length', numeric_types, 'minLength'),\n ('regex', str, 'pattern'),\n)\n\n_numeric_types_attrs: Tuple[Tuple[str, Union[type, Tuple[type, ...]], str], ...] = (\n ('gt', numeric_types, 'exclusiveMinimum'),\n ('lt', numeric_types, 'exclusiveMaximum'),\n ('ge', numeric_types, 'minimum'),\n ('le', numeric_types, 'maximum'),\n ('multiple_of', numeric_types, 'multipleOf'),\n)\n\n\ndef get_field_schema_validations(field: ModelField) -> Dict[str, Any]:\n \"\"\"\n Get the JSON Schema validation keywords for a ``field`` with an annotation of\n a Pydantic ``FieldInfo`` with validation arguments.\n \"\"\"\n f_schema: Dict[str, Any] = {}\n\n if lenient_issubclass(field.type_, Enum):\n # schema is already updated by `enum_process_schema`; just update with field extra\n if field.field_info.extra:\n f_schema.update(field.field_info.extra)\n return f_schema\n\n if lenient_issubclass(field.type_, (str, bytes)):\n for attr_name, t, keyword in _str_types_attrs:\n attr = getattr(field.field_info, attr_name, None)\n if isinstance(attr, t):\n f_schema[keyword] = attr\n if lenient_issubclass(field.type_, numeric_types) and not issubclass(field.type_, bool):\n for attr_name, t, keyword in _numeric_types_attrs:\n attr = getattr(field.field_info, attr_name, None)\n if isinstance(attr, t):\n f_schema[keyword] = attr\n if field.field_info is not None and field.field_info.const:\n f_schema['const'] = field.default\n if field.field_info.extra:\n f_schema.update(field.field_info.extra)\n modify_schema = getattr(field.outer_type_, '__modify_schema__', None)\n if modify_schema:\n modify_schema(f_schema)\n return f_schema\n\n\ndef get_model_name_map(unique_models: TypeModelSet) -> Dict[TypeModelOrEnum, str]:\n \"\"\"\n Process a set of models and generate unique names for them to be used as keys in the JSON Schema\n definitions. By default the names are the same as the class name. But if two models in different Python\n modules have the same name (e.g. \"users.Model\" and \"items.Model\"), the generated names will be\n based on the Python module path for those conflicting models to prevent name collisions.\n\n :param unique_models: a Python set of models\n :return: dict mapping models to names\n \"\"\"\n name_model_map = {}\n conflicting_names: Set[str] = set()\n for model in unique_models:\n model_name = normalize_name(model.__name__)\n if model_name in conflicting_names:\n model_name = get_long_model_name(model)\n name_model_map[model_name] = model\n elif model_name in name_model_map:\n conflicting_names.add(model_name)\n conflicting_model = name_model_map.pop(model_name)\n name_model_map[get_long_model_name(conflicting_model)] = conflicting_model\n name_model_map[get_long_model_name(model)] = model\n else:\n name_model_map[model_name] = model\n return {v: k for k, v in name_model_map.items()}\n\n\ndef get_flat_models_from_model(model: Type['BaseModel'], known_models: TypeModelSet = None) -> TypeModelSet:\n \"\"\"\n Take a single ``model`` and generate a set with itself and all the sub-models in the tree. I.e. if you pass\n model ``Foo`` (subclass of Pydantic ``BaseModel``) as ``model``, and it has a field of type ``Bar`` (also\n subclass of ``BaseModel``) and that model ``Bar`` has a field of type ``Baz`` (also subclass of ``BaseModel``),\n the return value will be ``set([Foo, Bar, Baz])``.\n\n :param model: a Pydantic ``BaseModel`` subclass\n :param known_models: used to solve circular references\n :return: a set with the initial model and all its sub-models\n \"\"\"\n known_models = known_models or set()\n flat_models: TypeModelSet = set()\n flat_models.add(model)\n known_models |= flat_models\n fields = cast(Sequence[ModelField], model.__fields__.values())\n flat_models |= get_flat_models_from_fields(fields, known_models=known_models)\n return flat_models\n\n\ndef get_flat_models_from_field(field: ModelField, known_models: TypeModelSet) -> TypeModelSet:\n \"\"\"\n Take a single Pydantic ``ModelField`` (from a model) that could have been declared as a sublcass of BaseModel\n (so, it could be a submodel), and generate a set with its model and all the sub-models in the tree.\n I.e. if you pass a field that was declared to be of type ``Foo`` (subclass of BaseModel) as ``field``, and that\n model ``Foo`` has a field of type ``Bar`` (also subclass of ``BaseModel``) and that model ``Bar`` has a field of\n type ``Baz`` (also subclass of ``BaseModel``), the return value will be ``set([Foo, Bar, Baz])``.\n\n :param field: a Pydantic ``ModelField``\n :param known_models: used to solve circular references\n :return: a set with the model used in the declaration for this field, if any, and all its sub-models\n \"\"\"\n from .dataclasses import dataclass, is_builtin_dataclass\n from .main import BaseModel # noqa: F811\n\n flat_models: TypeModelSet = set()\n\n # Handle dataclass-based models\n if is_builtin_dataclass(field.type_):\n field.type_ = dataclass(field.type_)\n field_type = field.type_\n if lenient_issubclass(getattr(field_type, '__pydantic_model__', None), BaseModel):\n field_type = field_type.__pydantic_model__\n if field.sub_fields:\n flat_models |= get_flat_models_from_fields(field.sub_fields, known_models=known_models)\n elif lenient_issubclass(field_type, BaseModel) and field_type not in known_models:\n flat_models |= get_flat_models_from_model(field_type, known_models=known_models)\n elif lenient_issubclass(field_type, Enum):\n flat_models.add(field_type)\n return flat_models\n\n\ndef get_flat_models_from_fields(fields: Sequence[ModelField], known_models: TypeModelSet) -> TypeModelSet:\n \"\"\"\n Take a list of Pydantic ``ModelField``s (from a model) that could have been declared as sublcasses of ``BaseModel``\n (so, any of them could be a submodel), and generate a set with their models and all the sub-models in the tree.\n I.e. if you pass a the fields of a model ``Foo`` (subclass of ``BaseModel``) as ``fields``, and on of them has a\n field of type ``Bar`` (also subclass of ``BaseModel``) and that model ``Bar`` has a field of type ``Baz`` (also\n subclass of ``BaseModel``), the return value will be ``set([Foo, Bar, Baz])``.\n\n :param fields: a list of Pydantic ``ModelField``s\n :param known_models: used to solve circular references\n :return: a set with any model declared in the fields, and all their sub-models\n \"\"\"\n flat_models: TypeModelSet = set()\n for field in fields:\n flat_models |= get_flat_models_from_field(field, known_models=known_models)\n return flat_models\n\n\ndef get_flat_models_from_models(models: Sequence[Type['BaseModel']]) -> TypeModelSet:\n \"\"\"\n Take a list of ``models`` and generate a set with them and all their sub-models in their trees. I.e. if you pass\n a list of two models, ``Foo`` and ``Bar``, both subclasses of Pydantic ``BaseModel`` as models, and ``Bar`` has\n a field of type ``Baz`` (also subclass of ``BaseModel``), the return value will be ``set([Foo, Bar, Baz])``.\n \"\"\"\n flat_models: TypeModelSet = set()\n for model in models:\n flat_models |= get_flat_models_from_model(model)\n return flat_models\n\n\ndef get_long_model_name(model: TypeModelOrEnum) -> str:\n return f'{model.__module__}__{model.__qualname__}'.replace('.', '__')\n\n\ndef field_type_schema(\n field: ModelField,\n *,\n by_alias: bool,\n model_name_map: Dict[TypeModelOrEnum, str],\n ref_template: str,\n schema_overrides: bool = False,\n ref_prefix: Optional[str] = None,\n known_models: TypeModelSet,\n) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:\n \"\"\"\n Used by ``field_schema()``, you probably should be using that function.\n\n Take a single ``field`` and generate the schema for its type only, not including additional\n information as title, etc. Also return additional schema definitions, from sub-models.\n \"\"\"\n definitions = {}\n nested_models: Set[str] = set()\n f_schema: Dict[str, Any]\n if field.shape in {SHAPE_LIST, SHAPE_TUPLE_ELLIPSIS, SHAPE_SEQUENCE, SHAPE_SET, SHAPE_FROZENSET, SHAPE_ITERABLE}:\n items_schema, f_definitions, f_nested_models = field_singleton_schema(\n field,\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n definitions.update(f_definitions)\n nested_models.update(f_nested_models)\n f_schema = {'type': 'array', 'items': items_schema}\n if field.shape in {SHAPE_SET, SHAPE_FROZENSET}:\n f_schema['uniqueItems'] = True\n\n elif field.shape == SHAPE_MAPPING:\n f_schema = {'type': 'object'}\n key_field = cast(ModelField, field.key_field)\n regex = getattr(key_field.type_, 'regex', None)\n items_schema, f_definitions, f_nested_models = field_singleton_schema(\n field,\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n definitions.update(f_definitions)\n nested_models.update(f_nested_models)\n if regex:\n # Dict keys have a regex pattern\n # items_schema might be a schema or empty dict, add it either way\n f_schema['patternProperties'] = {regex.pattern: items_schema}\n elif items_schema:\n # The dict values are not simply Any, so they need a schema\n f_schema['additionalProperties'] = items_schema\n elif field.shape == SHAPE_TUPLE:\n sub_schema = []\n sub_fields = cast(List[ModelField], field.sub_fields)\n for sf in sub_fields:\n sf_schema, sf_definitions, sf_nested_models = field_type_schema(\n sf,\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n definitions.update(sf_definitions)\n nested_models.update(sf_nested_models)\n sub_schema.append(sf_schema)\n if len(sub_schema) == 1:\n sub_schema = sub_schema[0] # type: ignore\n f_schema = {'type': 'array', 'items': sub_schema}\n else:\n assert field.shape == SHAPE_SINGLETON, field.shape\n f_schema, f_definitions, f_nested_models = field_singleton_schema(\n field,\n by_alias=by_alias,\n model_name_map=model_name_map,\n schema_overrides=schema_overrides,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n definitions.update(f_definitions)\n nested_models.update(f_nested_models)\n\n # check field type to avoid repeated calls to the same __modify_schema__ method\n if field.type_ != field.outer_type_:\n modify_schema = getattr(field.outer_type_, '__modify_schema__', None)\n if modify_schema:\n modify_schema(f_schema)\n return f_schema, definitions, nested_models\n\n\ndef model_process_schema(\n model: TypeModelOrEnum,\n *,\n by_alias: bool = True,\n model_name_map: Dict[TypeModelOrEnum, str],\n ref_prefix: Optional[str] = None,\n ref_template: str = default_ref_template,\n known_models: TypeModelSet = None,\n) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:\n \"\"\"\n Used by ``model_schema()``, you probably should be using that function.\n\n Take a single ``model`` and generate its schema. Also return additional schema definitions, from sub-models. The\n sub-models of the returned schema will be referenced, but their definitions will not be included in the schema. All\n the definitions are returned as the second value.\n \"\"\"\n from inspect import getdoc, signature\n\n known_models = known_models or set()\n if lenient_issubclass(model, Enum):\n model = cast(Type[Enum], model)\n s = enum_process_schema(model)\n return s, {}, set()\n model = cast(Type['BaseModel'], model)\n s = {'title': model.__config__.title or model.__name__}\n doc = getdoc(model)\n if doc:\n s['description'] = doc\n known_models.add(model)\n m_schema, m_definitions, nested_models = model_type_schema(\n model,\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n s.update(m_schema)\n schema_extra = model.__config__.schema_extra\n if callable(schema_extra):\n if len(signature(schema_extra).parameters) == 1:\n schema_extra(s)\n else:\n schema_extra(s, model)\n else:\n s.update(schema_extra)\n return s, m_definitions, nested_models\n\n\ndef model_type_schema(\n model: Type['BaseModel'],\n *,\n by_alias: bool,\n model_name_map: Dict[TypeModelOrEnum, str],\n ref_template: str,\n ref_prefix: Optional[str] = None,\n known_models: TypeModelSet,\n) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:\n \"\"\"\n You probably should be using ``model_schema()``, this function is indirectly used by that function.\n\n Take a single ``model`` and generate the schema for its type only, not including additional\n information as title, etc. Also return additional schema definitions, from sub-models.\n \"\"\"\n properties = {}\n required = []\n definitions: Dict[str, Any] = {}\n nested_models: Set[str] = set()\n for k, f in model.__fields__.items():\n try:\n f_schema, f_definitions, f_nested_models = field_schema(\n f,\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n except SkipField as skip:\n warnings.warn(skip.message, UserWarning)\n continue\n definitions.update(f_definitions)\n nested_models.update(f_nested_models)\n if by_alias:\n properties[f.alias] = f_schema\n if f.required:\n required.append(f.alias)\n else:\n properties[k] = f_schema\n if f.required:\n required.append(k)\n if ROOT_KEY in properties:\n out_schema = properties[ROOT_KEY]\n out_schema['title'] = model.__config__.title or model.__name__\n else:\n out_schema = {'type': 'object', 'properties': properties}\n if required:\n out_schema['required'] = required\n if model.__config__.extra == 'forbid':\n out_schema['additionalProperties'] = False\n return out_schema, definitions, nested_models\n\n\ndef enum_process_schema(enum: Type[Enum]) -> Dict[str, Any]:\n \"\"\"\n Take a single `enum` and generate its schema.\n\n This is similar to the `model_process_schema` function, but applies to ``Enum`` objects.\n \"\"\"\n from inspect import getdoc\n\n schema: Dict[str, Any] = {\n 'title': enum.__name__,\n # Python assigns all enums a default docstring value of 'An enumeration', so\n # all enums will have a description field even if not explicitly provided.\n 'description': getdoc(enum),\n # Add enum values and the enum field type to the schema.\n 'enum': [item.value for item in cast(Iterable[Enum], enum)],\n }\n\n add_field_type_to_schema(enum, schema)\n\n modify_schema = getattr(enum, '__modify_schema__', None)\n if modify_schema:\n modify_schema(schema)\n\n return schema\n\n\ndef field_singleton_sub_fields_schema(\n sub_fields: Sequence[ModelField],\n *,\n by_alias: bool,\n model_name_map: Dict[TypeModelOrEnum, str],\n ref_template: str,\n schema_overrides: bool = False,\n ref_prefix: Optional[str] = None,\n known_models: TypeModelSet,\n) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:\n \"\"\"\n This function is indirectly used by ``field_schema()``, you probably should be using that function.\n\n Take a list of Pydantic ``ModelField`` from the declaration of a type with parameters, and generate their\n schema. I.e., fields used as \"type parameters\", like ``str`` and ``int`` in ``Tuple[str, int]``.\n \"\"\"\n definitions = {}\n nested_models: Set[str] = set()\n if len(sub_fields) == 1:\n return field_type_schema(\n sub_fields[0],\n by_alias=by_alias,\n model_name_map=model_name_map,\n schema_overrides=schema_overrides,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n else:\n sub_field_schemas = []\n for sf in sub_fields:\n sub_schema, sub_definitions, sub_nested_models = field_type_schema(\n sf,\n by_alias=by_alias,\n model_name_map=model_name_map,\n schema_overrides=schema_overrides,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n definitions.update(sub_definitions)\n if schema_overrides and 'allOf' in sub_schema:\n # if the sub_field is a referenced schema we only need the referenced\n # object. Otherwise we will end up with several allOf inside anyOf.\n # See https://github.com/samuelcolvin/pydantic/issues/1209\n sub_schema = sub_schema['allOf'][0]\n sub_field_schemas.append(sub_schema)\n nested_models.update(sub_nested_models)\n return {'anyOf': sub_field_schemas}, definitions, nested_models\n\n\n# Order is important, e.g. subclasses of str must go before str\n# this is used only for standard library types, custom types should use __modify_schema__ instead\nfield_class_to_schema: Tuple[Tuple[Any, Dict[str, Any]], ...] = (\n (Path, {'type': 'string', 'format': 'path'}),\n (datetime, {'type': 'string', 'format': 'date-time'}),\n (date, {'type': 'string', 'format': 'date'}),\n (time, {'type': 'string', 'format': 'time'}),\n (timedelta, {'type': 'number', 'format': 'time-delta'}),\n (IPv4Network, {'type': 'string', 'format': 'ipv4network'}),\n (IPv6Network, {'type': 'string', 'format': 'ipv6network'}),\n (IPv4Interface, {'type': 'string', 'format': 'ipv4interface'}),\n (IPv6Interface, {'type': 'string', 'format': 'ipv6interface'}),\n (IPv4Address, {'type': 'string', 'format': 'ipv4'}),\n (IPv6Address, {'type': 'string', 'format': 'ipv6'}),\n (Pattern, {'type': 'string', 'format': 'regex'}),\n (str, {'type': 'string'}),\n (bytes, {'type': 'string', 'format': 'binary'}),\n (bool, {'type': 'boolean'}),\n (int, {'type': 'integer'}),\n (float, {'type': 'number'}),\n (Decimal, {'type': 'number'}),\n (UUID, {'type': 'string', 'format': 'uuid'}),\n (dict, {'type': 'object'}),\n (list, {'type': 'array', 'items': {}}),\n (tuple, {'type': 'array', 'items': {}}),\n (set, {'type': 'array', 'items': {}, 'uniqueItems': True}),\n (frozenset, {'type': 'array', 'items': {}, 'uniqueItems': True}),\n)\n\njson_scheme = {'type': 'string', 'format': 'json-string'}\n\n\ndef add_field_type_to_schema(field_type: Any, schema: Dict[str, Any]) -> None:\n \"\"\"\n Update the given `schema` with the type-specific metadata for the given `field_type`.\n\n This function looks through `field_class_to_schema` for a class that matches the given `field_type`,\n and then modifies the given `schema` with the information from that type.\n \"\"\"\n for type_, t_schema in field_class_to_schema:\n # Fallback for `typing.Pattern` as it is not a valid class\n if lenient_issubclass(field_type, type_) or field_type is type_ is Pattern:\n schema.update(t_schema)\n break\n\n\ndef get_schema_ref(name: str, ref_prefix: Optional[str], ref_template: str, schema_overrides: bool) -> Dict[str, Any]:\n if ref_prefix:\n schema_ref = {'$ref': ref_prefix + name}\n else:\n schema_ref = {'$ref': ref_template.format(model=name)}\n return {'allOf': [schema_ref]} if schema_overrides else schema_ref\n\n\ndef field_singleton_schema( # noqa: C901 (ignore complexity)\n field: ModelField,\n *,\n by_alias: bool,\n model_name_map: Dict[TypeModelOrEnum, str],\n ref_template: str,\n schema_overrides: bool = False,\n ref_prefix: Optional[str] = None,\n known_models: TypeModelSet,\n) -> Tuple[Dict[str, Any], Dict[str, Any], Set[str]]:\n \"\"\"\n This function is indirectly used by ``field_schema()``, you should probably be using that function.\n\n Take a single Pydantic ``ModelField``, and return its schema and any additional definitions from sub-models.\n \"\"\"\n from .main import BaseModel # noqa: F811\n\n definitions: Dict[str, Any] = {}\n nested_models: Set[str] = set()\n if field.sub_fields:\n return field_singleton_sub_fields_schema(\n field.sub_fields,\n by_alias=by_alias,\n model_name_map=model_name_map,\n schema_overrides=schema_overrides,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n if field.type_ is Any or field.type_.__class__ == TypeVar:\n return {}, definitions, nested_models # no restrictions\n if field.type_ in NONE_TYPES:\n return {'type': 'null'}, definitions, nested_models\n if is_callable_type(field.type_):\n raise SkipField(f'Callable {field.name} was excluded from schema since JSON schema has no equivalent type.')\n f_schema: Dict[str, Any] = {}\n if field.field_info is not None and field.field_info.const:\n f_schema['const'] = field.default\n field_type = field.type_\n if is_literal_type(field_type):\n values = literal_values(field_type)\n if len(values) > 1:\n return field_schema(\n multivalue_literal_field_for_schema(values, field),\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n literal_value = values[0]\n field_type = literal_value.__class__\n f_schema['const'] = literal_value\n\n if lenient_issubclass(field_type, Enum):\n enum_name = model_name_map[field_type]\n f_schema, schema_overrides = get_field_info_schema(field)\n f_schema.update(get_schema_ref(enum_name, ref_prefix, ref_template, schema_overrides))\n definitions[enum_name] = enum_process_schema(field_type)\n else:\n add_field_type_to_schema(field_type, f_schema)\n\n modify_schema = getattr(field_type, '__modify_schema__', None)\n if modify_schema:\n modify_schema(f_schema)\n\n if f_schema:\n return f_schema, definitions, nested_models\n\n # Handle dataclass-based models\n if lenient_issubclass(getattr(field_type, '__pydantic_model__', None), BaseModel):\n field_type = field_type.__pydantic_model__\n\n if issubclass(field_type, BaseModel):\n model_name = model_name_map[field_type]\n if field_type not in known_models:\n sub_schema, sub_definitions, sub_nested_models = model_process_schema(\n field_type,\n by_alias=by_alias,\n model_name_map=model_name_map,\n ref_prefix=ref_prefix,\n ref_template=ref_template,\n known_models=known_models,\n )\n definitions.update(sub_definitions)\n definitions[model_name] = sub_schema\n nested_models.update(sub_nested_models)\n else:\n nested_models.add(model_name)\n schema_ref = get_schema_ref(model_name, ref_prefix, ref_template, schema_overrides)\n return schema_ref, definitions, nested_models\n\n raise ValueError(f'Value not declarable with JSON Schema, field: {field}')\n\n\ndef multivalue_literal_field_for_schema(values: Tuple[Any, ...], field: ModelField) -> ModelField:\n return ModelField(\n name=field.name,\n type_=Union[tuple(Literal[value] for value in values)], # type: ignore\n class_validators=field.class_validators,\n model_config=field.model_config,\n default=field.default,\n required=field.required,\n alias=field.alias,\n field_info=field.field_info,\n )\n\n\ndef encode_default(dft: Any) -> Any:\n if isinstance(dft, (int, float, str)):\n return dft\n elif sequence_like(dft):\n t = dft.__class__\n return t(encode_default(v) for v in dft)\n elif isinstance(dft, dict):\n return {encode_default(k): encode_default(v) for k, v in dft.items()}\n elif dft is None:\n return None\n else:\n return pydantic_encoder(dft)\n\n\n_map_types_constraint: Dict[Any, Callable[..., type]] = {int: conint, float: confloat, Decimal: condecimal}\n_field_constraints = {\n 'min_length',\n 'max_length',\n 'regex',\n 'gt',\n 'lt',\n 'ge',\n 'le',\n 'multiple_of',\n 'min_items',\n 'max_items',\n}\n\n\ndef get_annotation_from_field_info(annotation: Any, field_info: FieldInfo, field_name: str) -> Type[Any]: # noqa: C901\n \"\"\"\n Get an annotation with validation implemented for numbers and strings based on the field_info.\n\n :param annotation: an annotation from a field specification, as ``str``, ``ConstrainedStr``\n :param field_info: an instance of FieldInfo, possibly with declarations for validations and JSON Schema\n :param field_name: name of the field for use in error messages\n :return: the same ``annotation`` if unmodified or a new annotation with validation in place\n \"\"\"\n constraints = {f for f in _field_constraints if getattr(field_info, f) is not None}\n if not constraints:\n return annotation\n used_constraints: Set[str] = set()\n\n def go(type_: Any) -> Type[Any]:\n if (\n is_literal_type(annotation)\n or isinstance(type_, ForwardRef)\n or lenient_issubclass(type_, (ConstrainedList, ConstrainedSet))\n ):\n return type_\n origin = get_origin(type_)\n if origin is not None:\n args: Tuple[Any, ...] = get_args(type_)\n if any(isinstance(a, ForwardRef) for a in args):\n # forward refs cause infinite recursion below\n return type_\n\n if origin is Union:\n return Union[tuple(go(a) for a in args)] # type: ignore\n\n if issubclass(origin, List) and (field_info.min_items is not None or field_info.max_items is not None):\n used_constraints.update({'min_items', 'max_items'})\n return conlist(go(args[0]), min_items=field_info.min_items, max_items=field_info.max_items)\n\n if issubclass(origin, Set) and (field_info.min_items is not None or field_info.max_items is not None):\n used_constraints.update({'min_items', 'max_items'})\n return conset(go(args[0]), min_items=field_info.min_items, max_items=field_info.max_items)\n\n for t in (Tuple, List, Set, FrozenSet, Sequence):\n if issubclass(origin, t): # type: ignore\n return t[tuple(go(a) for a in args)] # type: ignore\n\n if issubclass(origin, Dict):\n return Dict[args[0], go(args[1])] # type: ignore\n\n attrs: Optional[Tuple[str, ...]] = None\n constraint_func: Optional[Callable[..., type]] = None\n if isinstance(type_, type):\n if issubclass(type_, (SecretStr, SecretBytes)):\n attrs = ('max_length', 'min_length')\n\n def constraint_func(**kwargs: Any) -> Type[Any]:\n return type(type_.__name__, (type_,), kwargs)\n\n elif issubclass(type_, str) and not issubclass(type_, (EmailStr, AnyUrl, ConstrainedStr)):\n attrs = ('max_length', 'min_length', 'regex')\n constraint_func = constr\n elif issubclass(type_, bytes):\n attrs = ('max_length', 'min_length', 'regex')\n constraint_func = conbytes\n elif issubclass(type_, numeric_types) and not issubclass(\n type_, (ConstrainedInt, ConstrainedFloat, ConstrainedDecimal, ConstrainedList, ConstrainedSet, bool)\n ):\n # Is numeric type\n attrs = ('gt', 'lt', 'ge', 'le', 'multiple_of')\n numeric_type = next(t for t in numeric_types if issubclass(type_, t)) # pragma: no branch\n constraint_func = _map_types_constraint[numeric_type]\n\n if attrs:\n used_constraints.update(set(attrs))\n kwargs = {\n attr_name: attr\n for attr_name, attr in ((attr_name, getattr(field_info, attr_name)) for attr_name in attrs)\n if attr is not None\n }\n if kwargs:\n constraint_func = cast(Callable[..., type], constraint_func)\n return constraint_func(**kwargs)\n return type_\n\n ans = go(annotation)\n\n unused_constraints = constraints - used_constraints\n if unused_constraints:\n raise ValueError(\n f'On field \"{field_name}\" the following field constraints are set but not enforced: '\n f'{\", \".join(unused_constraints)}. '\n f'\\nFor more details see https://pydantic-docs.helpmanual.io/usage/schema/#unenforced-field-constraints'\n )\n\n return ans\n\n\ndef normalize_name(name: str) -> str:\n \"\"\"\n Normalizes the given name. This can be applied to either a model *or* enum.\n \"\"\"\n return re.sub(r'[^a-zA-Z0-9.\\-_]', '_', name)\n\n\nclass SkipField(Exception):\n \"\"\"\n Utility exception used to exclude fields from schema.\n \"\"\"\n\n def __init__(self, message: str) -> None:\n self.message = message\n", "path": "pydantic/schema.py"}]} |
gh_patches_debug_242 | rasdani/github-patches | git_diff | talonhub__community-978 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
please map both comma and coma to , for now in keys.py
coma being recognized instead of comma comes up a lot for conformer b-series
I think for now we should bind both comma and coma as , in keys.py
and revisit if a future model sorts out the difference 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: `code/keys.py`
Content:
```
1 from talon import Context, Module, actions, app
2
3 default_alphabet = "air bat cap drum each fine gust harp sit jury crunch look made near odd pit quench red sun trap urge vest whale plex yank zip".split(
4 " "
5 )
6 letters_string = "abcdefghijklmnopqrstuvwxyz"
7
8 default_digits = "zero one two three four five six seven eight nine".split(" ")
9 numbers = [str(i) for i in range(10)]
10 default_f_digits = (
11 "one two three four five six seven eight nine ten eleven twelve".split(" ")
12 )
13
14 mod = Module()
15 mod.list("letter", desc="The spoken phonetic alphabet")
16 mod.list("symbol_key", desc="All symbols from the keyboard")
17 mod.list("arrow_key", desc="All arrow keys")
18 mod.list("number_key", desc="All number keys")
19 mod.list("modifier_key", desc="All modifier keys")
20 mod.list("function_key", desc="All function keys")
21 mod.list("special_key", desc="All special keys")
22 mod.list("punctuation", desc="words for inserting punctuation into text")
23
24
25 @mod.capture(rule="{self.modifier_key}+")
26 def modifiers(m) -> str:
27 "One or more modifier keys"
28 return "-".join(m.modifier_key_list)
29
30
31 @mod.capture(rule="{self.arrow_key}")
32 def arrow_key(m) -> str:
33 "One directional arrow key"
34 return m.arrow_key
35
36
37 @mod.capture(rule="<self.arrow_key>+")
38 def arrow_keys(m) -> str:
39 "One or more arrow keys separated by a space"
40 return str(m)
41
42
43 @mod.capture(rule="{self.number_key}")
44 def number_key(m) -> str:
45 "One number key"
46 return m.number_key
47
48
49 @mod.capture(rule="{self.letter}")
50 def letter(m) -> str:
51 "One letter key"
52 return m.letter
53
54
55 @mod.capture(rule="{self.special_key}")
56 def special_key(m) -> str:
57 "One special key"
58 return m.special_key
59
60
61 @mod.capture(rule="{self.symbol_key}")
62 def symbol_key(m) -> str:
63 "One symbol key"
64 return m.symbol_key
65
66
67 @mod.capture(rule="{self.function_key}")
68 def function_key(m) -> str:
69 "One function key"
70 return m.function_key
71
72
73 @mod.capture(rule="( <self.letter> | <self.number_key> | <self.symbol_key> )")
74 def any_alphanumeric_key(m) -> str:
75 "any alphanumeric key"
76 return str(m)
77
78
79 @mod.capture(
80 rule="( <self.letter> | <self.number_key> | <self.symbol_key> "
81 "| <self.arrow_key> | <self.function_key> | <self.special_key> )"
82 )
83 def unmodified_key(m) -> str:
84 "A single key with no modifiers"
85 return str(m)
86
87
88 @mod.capture(rule="{self.modifier_key}* <self.unmodified_key>")
89 def key(m) -> str:
90 "A single key with optional modifiers"
91 try:
92 mods = m.modifier_key_list
93 except AttributeError:
94 mods = []
95 return "-".join(mods + [m.unmodified_key])
96
97
98 @mod.capture(rule="<self.key>+")
99 def keys(m) -> str:
100 "A sequence of one or more keys with optional modifiers"
101 return " ".join(m.key_list)
102
103
104 @mod.capture(rule="{self.letter}+")
105 def letters(m) -> str:
106 "Multiple letter keys"
107 return "".join(m.letter_list)
108
109
110 ctx = Context()
111 modifier_keys = {
112 # If you find 'alt' is often misrecognized, try using 'alter'.
113 "alt": "alt", #'alter': 'alt',
114 "control": "ctrl", #'troll': 'ctrl',
115 "shift": "shift", #'sky': 'shift',
116 "super": "super",
117 }
118 if app.platform == "mac":
119 modifier_keys["command"] = "cmd"
120 modifier_keys["option"] = "alt"
121 ctx.lists["self.modifier_key"] = modifier_keys
122 alphabet = dict(zip(default_alphabet, letters_string))
123 ctx.lists["self.letter"] = alphabet
124
125 # `punctuation_words` is for words you want available BOTH in dictation and as key names in command mode.
126 # `symbol_key_words` is for key names that should be available in command mode, but NOT during dictation.
127 punctuation_words = {
128 # TODO: I'm not sure why we need these, I think it has something to do with
129 # Dragon. Possibly it has been fixed by later improvements to talon? -rntz
130 "`": "`",
131 ",": ",", # <== these things
132 "back tick": "`",
133 "grave": "`",
134 "comma": ",",
135 "period": ".",
136 "full stop": ".",
137 "semicolon": ";",
138 "colon": ":",
139 "forward slash": "/",
140 "question mark": "?",
141 "exclamation mark": "!",
142 "exclamation point": "!",
143 "asterisk": "*",
144 "hash sign": "#",
145 "number sign": "#",
146 "percent sign": "%",
147 "at sign": "@",
148 "and sign": "&",
149 "ampersand": "&",
150 # Currencies
151 "dollar sign": "$",
152 "pound sign": "£",
153 }
154 symbol_key_words = {
155 "dot": ".",
156 "point": ".",
157 "quote": "'",
158 "question": "?",
159 "apostrophe": "'",
160 "L square": "[",
161 "left square": "[",
162 "square": "[",
163 "R square": "]",
164 "right square": "]",
165 "slash": "/",
166 "backslash": "\\",
167 "minus": "-",
168 "dash": "-",
169 "equals": "=",
170 "plus": "+",
171 "tilde": "~",
172 "bang": "!",
173 "down score": "_",
174 "underscore": "_",
175 "paren": "(",
176 "L paren": "(",
177 "left paren": "(",
178 "R paren": ")",
179 "right paren": ")",
180 "brace": "{",
181 "left brace": "{",
182 "brack": "{",
183 "bracket": "{",
184 "left bracket": "{",
185 "r brace": "}",
186 "right brace": "}",
187 "r brack": "}",
188 "r bracket": "}",
189 "right bracket": "}",
190 "angle": "<",
191 "left angle": "<",
192 "less than": "<",
193 "rangle": ">",
194 "R angle": ">",
195 "right angle": ">",
196 "greater than": ">",
197 "star": "*",
198 "hash": "#",
199 "percent": "%",
200 "caret": "^",
201 "amper": "&",
202 "pipe": "|",
203 "dubquote": '"',
204 "double quote": '"',
205 # Currencies
206 "dollar": "$",
207 "pound": "£",
208 }
209
210 # make punctuation words also included in {user.symbol_keys}
211 symbol_key_words.update(punctuation_words)
212 ctx.lists["self.punctuation"] = punctuation_words
213 ctx.lists["self.symbol_key"] = symbol_key_words
214 ctx.lists["self.number_key"] = dict(zip(default_digits, numbers))
215 ctx.lists["self.arrow_key"] = {
216 "down": "down",
217 "left": "left",
218 "right": "right",
219 "up": "up",
220 }
221
222 simple_keys = [
223 "end",
224 "enter",
225 "escape",
226 "home",
227 "insert",
228 "pagedown",
229 "pageup",
230 "space",
231 "tab",
232 ]
233
234 alternate_keys = {
235 "wipe": "backspace",
236 "delete": "backspace",
237 #'junk': 'backspace',
238 "forward delete": "delete",
239 "page up": "pageup",
240 "page down": "pagedown",
241 }
242 # mac apparently doesn't have the menu key.
243 if app.platform in ("windows", "linux"):
244 alternate_keys["menu key"] = "menu"
245 alternate_keys["print screen"] = "printscr"
246
247 special_keys = {k: k for k in simple_keys}
248 special_keys.update(alternate_keys)
249 ctx.lists["self.special_key"] = special_keys
250 ctx.lists["self.function_key"] = {
251 f"F {default_f_digits[i]}": f"f{i + 1}" for i in range(12)
252 }
253
254
255 @mod.action_class
256 class Actions:
257 def move_cursor(s: str):
258 """Given a sequence of directions, eg. 'left left up', moves the cursor accordingly using edit.{left,right,up,down}."""
259 for d in s.split():
260 if d in ("left", "right", "up", "down"):
261 getattr(actions.edit, d)()
262 else:
263 raise RuntimeError(f"invalid arrow key: {d}")
264
```
--- 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/code/keys.py b/code/keys.py
--- a/code/keys.py
+++ b/code/keys.py
@@ -132,6 +132,8 @@
"back tick": "`",
"grave": "`",
"comma": ",",
+ # Workaround for issue with conformer b-series; see #946
+ "coma": ",",
"period": ".",
"full stop": ".",
"semicolon": ";",
| {"golden_diff": "diff --git a/code/keys.py b/code/keys.py\n--- a/code/keys.py\n+++ b/code/keys.py\n@@ -132,6 +132,8 @@\n \"back tick\": \"`\",\n \"grave\": \"`\",\n \"comma\": \",\",\n+ # Workaround for issue with conformer b-series; see #946\n+ \"coma\": \",\",\n \"period\": \".\",\n \"full stop\": \".\",\n \"semicolon\": \";\",\n", "issue": "please map both comma and coma to , for now in keys.py\ncoma being recognized instead of comma comes up a lot for conformer b-series\r\nI think for now we should bind both comma and coma as , in keys.py\r\nand revisit if a future model sorts out the difference better\n", "before_files": [{"content": "from talon import Context, Module, actions, app\n\ndefault_alphabet = \"air bat cap drum each fine gust harp sit jury crunch look made near odd pit quench red sun trap urge vest whale plex yank zip\".split(\n \" \"\n)\nletters_string = \"abcdefghijklmnopqrstuvwxyz\"\n\ndefault_digits = \"zero one two three four five six seven eight nine\".split(\" \")\nnumbers = [str(i) for i in range(10)]\ndefault_f_digits = (\n \"one two three four five six seven eight nine ten eleven twelve\".split(\" \")\n)\n\nmod = Module()\nmod.list(\"letter\", desc=\"The spoken phonetic alphabet\")\nmod.list(\"symbol_key\", desc=\"All symbols from the keyboard\")\nmod.list(\"arrow_key\", desc=\"All arrow keys\")\nmod.list(\"number_key\", desc=\"All number keys\")\nmod.list(\"modifier_key\", desc=\"All modifier keys\")\nmod.list(\"function_key\", desc=\"All function keys\")\nmod.list(\"special_key\", desc=\"All special keys\")\nmod.list(\"punctuation\", desc=\"words for inserting punctuation into text\")\n\n\[email protected](rule=\"{self.modifier_key}+\")\ndef modifiers(m) -> str:\n \"One or more modifier keys\"\n return \"-\".join(m.modifier_key_list)\n\n\[email protected](rule=\"{self.arrow_key}\")\ndef arrow_key(m) -> str:\n \"One directional arrow key\"\n return m.arrow_key\n\n\[email protected](rule=\"<self.arrow_key>+\")\ndef arrow_keys(m) -> str:\n \"One or more arrow keys separated by a space\"\n return str(m)\n\n\[email protected](rule=\"{self.number_key}\")\ndef number_key(m) -> str:\n \"One number key\"\n return m.number_key\n\n\[email protected](rule=\"{self.letter}\")\ndef letter(m) -> str:\n \"One letter key\"\n return m.letter\n\n\[email protected](rule=\"{self.special_key}\")\ndef special_key(m) -> str:\n \"One special key\"\n return m.special_key\n\n\[email protected](rule=\"{self.symbol_key}\")\ndef symbol_key(m) -> str:\n \"One symbol key\"\n return m.symbol_key\n\n\[email protected](rule=\"{self.function_key}\")\ndef function_key(m) -> str:\n \"One function key\"\n return m.function_key\n\n\[email protected](rule=\"( <self.letter> | <self.number_key> | <self.symbol_key> )\")\ndef any_alphanumeric_key(m) -> str:\n \"any alphanumeric key\"\n return str(m)\n\n\[email protected](\n rule=\"( <self.letter> | <self.number_key> | <self.symbol_key> \"\n \"| <self.arrow_key> | <self.function_key> | <self.special_key> )\"\n)\ndef unmodified_key(m) -> str:\n \"A single key with no modifiers\"\n return str(m)\n\n\[email protected](rule=\"{self.modifier_key}* <self.unmodified_key>\")\ndef key(m) -> str:\n \"A single key with optional modifiers\"\n try:\n mods = m.modifier_key_list\n except AttributeError:\n mods = []\n return \"-\".join(mods + [m.unmodified_key])\n\n\[email protected](rule=\"<self.key>+\")\ndef keys(m) -> str:\n \"A sequence of one or more keys with optional modifiers\"\n return \" \".join(m.key_list)\n\n\[email protected](rule=\"{self.letter}+\")\ndef letters(m) -> str:\n \"Multiple letter keys\"\n return \"\".join(m.letter_list)\n\n\nctx = Context()\nmodifier_keys = {\n # If you find 'alt' is often misrecognized, try using 'alter'.\n \"alt\": \"alt\", #'alter': 'alt',\n \"control\": \"ctrl\", #'troll': 'ctrl',\n \"shift\": \"shift\", #'sky': 'shift',\n \"super\": \"super\",\n}\nif app.platform == \"mac\":\n modifier_keys[\"command\"] = \"cmd\"\n modifier_keys[\"option\"] = \"alt\"\nctx.lists[\"self.modifier_key\"] = modifier_keys\nalphabet = dict(zip(default_alphabet, letters_string))\nctx.lists[\"self.letter\"] = alphabet\n\n# `punctuation_words` is for words you want available BOTH in dictation and as key names in command mode.\n# `symbol_key_words` is for key names that should be available in command mode, but NOT during dictation.\npunctuation_words = {\n # TODO: I'm not sure why we need these, I think it has something to do with\n # Dragon. Possibly it has been fixed by later improvements to talon? -rntz\n \"`\": \"`\",\n \",\": \",\", # <== these things\n \"back tick\": \"`\",\n \"grave\": \"`\",\n \"comma\": \",\",\n \"period\": \".\",\n \"full stop\": \".\",\n \"semicolon\": \";\",\n \"colon\": \":\",\n \"forward slash\": \"/\",\n \"question mark\": \"?\",\n \"exclamation mark\": \"!\",\n \"exclamation point\": \"!\",\n \"asterisk\": \"*\",\n \"hash sign\": \"#\",\n \"number sign\": \"#\",\n \"percent sign\": \"%\",\n \"at sign\": \"@\",\n \"and sign\": \"&\",\n \"ampersand\": \"&\",\n # Currencies\n \"dollar sign\": \"$\",\n \"pound sign\": \"\u00a3\",\n}\nsymbol_key_words = {\n \"dot\": \".\",\n \"point\": \".\",\n \"quote\": \"'\",\n \"question\": \"?\",\n \"apostrophe\": \"'\",\n \"L square\": \"[\",\n \"left square\": \"[\",\n \"square\": \"[\",\n \"R square\": \"]\",\n \"right square\": \"]\",\n \"slash\": \"/\",\n \"backslash\": \"\\\\\",\n \"minus\": \"-\",\n \"dash\": \"-\",\n \"equals\": \"=\",\n \"plus\": \"+\",\n \"tilde\": \"~\",\n \"bang\": \"!\",\n \"down score\": \"_\",\n \"underscore\": \"_\",\n \"paren\": \"(\",\n \"L paren\": \"(\",\n \"left paren\": \"(\",\n \"R paren\": \")\",\n \"right paren\": \")\",\n \"brace\": \"{\",\n \"left brace\": \"{\",\n \"brack\": \"{\",\n \"bracket\": \"{\",\n \"left bracket\": \"{\",\n \"r brace\": \"}\",\n \"right brace\": \"}\",\n \"r brack\": \"}\",\n \"r bracket\": \"}\",\n \"right bracket\": \"}\",\n \"angle\": \"<\",\n \"left angle\": \"<\",\n \"less than\": \"<\",\n \"rangle\": \">\",\n \"R angle\": \">\",\n \"right angle\": \">\",\n \"greater than\": \">\",\n \"star\": \"*\",\n \"hash\": \"#\",\n \"percent\": \"%\",\n \"caret\": \"^\",\n \"amper\": \"&\",\n \"pipe\": \"|\",\n \"dubquote\": '\"',\n \"double quote\": '\"',\n # Currencies\n \"dollar\": \"$\",\n \"pound\": \"\u00a3\",\n}\n\n# make punctuation words also included in {user.symbol_keys}\nsymbol_key_words.update(punctuation_words)\nctx.lists[\"self.punctuation\"] = punctuation_words\nctx.lists[\"self.symbol_key\"] = symbol_key_words\nctx.lists[\"self.number_key\"] = dict(zip(default_digits, numbers))\nctx.lists[\"self.arrow_key\"] = {\n \"down\": \"down\",\n \"left\": \"left\",\n \"right\": \"right\",\n \"up\": \"up\",\n}\n\nsimple_keys = [\n \"end\",\n \"enter\",\n \"escape\",\n \"home\",\n \"insert\",\n \"pagedown\",\n \"pageup\",\n \"space\",\n \"tab\",\n]\n\nalternate_keys = {\n \"wipe\": \"backspace\",\n \"delete\": \"backspace\",\n #'junk': 'backspace',\n \"forward delete\": \"delete\",\n \"page up\": \"pageup\",\n \"page down\": \"pagedown\",\n}\n# mac apparently doesn't have the menu key.\nif app.platform in (\"windows\", \"linux\"):\n alternate_keys[\"menu key\"] = \"menu\"\n alternate_keys[\"print screen\"] = \"printscr\"\n\nspecial_keys = {k: k for k in simple_keys}\nspecial_keys.update(alternate_keys)\nctx.lists[\"self.special_key\"] = special_keys\nctx.lists[\"self.function_key\"] = {\n f\"F {default_f_digits[i]}\": f\"f{i + 1}\" for i in range(12)\n}\n\n\[email protected]_class\nclass Actions:\n def move_cursor(s: str):\n \"\"\"Given a sequence of directions, eg. 'left left up', moves the cursor accordingly using edit.{left,right,up,down}.\"\"\"\n for d in s.split():\n if d in (\"left\", \"right\", \"up\", \"down\"):\n getattr(actions.edit, d)()\n else:\n raise RuntimeError(f\"invalid arrow key: {d}\")\n", "path": "code/keys.py"}], "after_files": [{"content": "from talon import Context, Module, actions, app\n\ndefault_alphabet = \"air bat cap drum each fine gust harp sit jury crunch look made near odd pit quench red sun trap urge vest whale plex yank zip\".split(\n \" \"\n)\nletters_string = \"abcdefghijklmnopqrstuvwxyz\"\n\ndefault_digits = \"zero one two three four five six seven eight nine\".split(\" \")\nnumbers = [str(i) for i in range(10)]\ndefault_f_digits = (\n \"one two three four five six seven eight nine ten eleven twelve\".split(\" \")\n)\n\nmod = Module()\nmod.list(\"letter\", desc=\"The spoken phonetic alphabet\")\nmod.list(\"symbol_key\", desc=\"All symbols from the keyboard\")\nmod.list(\"arrow_key\", desc=\"All arrow keys\")\nmod.list(\"number_key\", desc=\"All number keys\")\nmod.list(\"modifier_key\", desc=\"All modifier keys\")\nmod.list(\"function_key\", desc=\"All function keys\")\nmod.list(\"special_key\", desc=\"All special keys\")\nmod.list(\"punctuation\", desc=\"words for inserting punctuation into text\")\n\n\[email protected](rule=\"{self.modifier_key}+\")\ndef modifiers(m) -> str:\n \"One or more modifier keys\"\n return \"-\".join(m.modifier_key_list)\n\n\[email protected](rule=\"{self.arrow_key}\")\ndef arrow_key(m) -> str:\n \"One directional arrow key\"\n return m.arrow_key\n\n\[email protected](rule=\"<self.arrow_key>+\")\ndef arrow_keys(m) -> str:\n \"One or more arrow keys separated by a space\"\n return str(m)\n\n\[email protected](rule=\"{self.number_key}\")\ndef number_key(m) -> str:\n \"One number key\"\n return m.number_key\n\n\[email protected](rule=\"{self.letter}\")\ndef letter(m) -> str:\n \"One letter key\"\n return m.letter\n\n\[email protected](rule=\"{self.special_key}\")\ndef special_key(m) -> str:\n \"One special key\"\n return m.special_key\n\n\[email protected](rule=\"{self.symbol_key}\")\ndef symbol_key(m) -> str:\n \"One symbol key\"\n return m.symbol_key\n\n\[email protected](rule=\"{self.function_key}\")\ndef function_key(m) -> str:\n \"One function key\"\n return m.function_key\n\n\[email protected](rule=\"( <self.letter> | <self.number_key> | <self.symbol_key> )\")\ndef any_alphanumeric_key(m) -> str:\n \"any alphanumeric key\"\n return str(m)\n\n\[email protected](\n rule=\"( <self.letter> | <self.number_key> | <self.symbol_key> \"\n \"| <self.arrow_key> | <self.function_key> | <self.special_key> )\"\n)\ndef unmodified_key(m) -> str:\n \"A single key with no modifiers\"\n return str(m)\n\n\[email protected](rule=\"{self.modifier_key}* <self.unmodified_key>\")\ndef key(m) -> str:\n \"A single key with optional modifiers\"\n try:\n mods = m.modifier_key_list\n except AttributeError:\n mods = []\n return \"-\".join(mods + [m.unmodified_key])\n\n\[email protected](rule=\"<self.key>+\")\ndef keys(m) -> str:\n \"A sequence of one or more keys with optional modifiers\"\n return \" \".join(m.key_list)\n\n\[email protected](rule=\"{self.letter}+\")\ndef letters(m) -> str:\n \"Multiple letter keys\"\n return \"\".join(m.letter_list)\n\n\nctx = Context()\nmodifier_keys = {\n # If you find 'alt' is often misrecognized, try using 'alter'.\n \"alt\": \"alt\", #'alter': 'alt',\n \"control\": \"ctrl\", #'troll': 'ctrl',\n \"shift\": \"shift\", #'sky': 'shift',\n \"super\": \"super\",\n}\nif app.platform == \"mac\":\n modifier_keys[\"command\"] = \"cmd\"\n modifier_keys[\"option\"] = \"alt\"\nctx.lists[\"self.modifier_key\"] = modifier_keys\nalphabet = dict(zip(default_alphabet, letters_string))\nctx.lists[\"self.letter\"] = alphabet\n\n# `punctuation_words` is for words you want available BOTH in dictation and as key names in command mode.\n# `symbol_key_words` is for key names that should be available in command mode, but NOT during dictation.\npunctuation_words = {\n # TODO: I'm not sure why we need these, I think it has something to do with\n # Dragon. Possibly it has been fixed by later improvements to talon? -rntz\n \"`\": \"`\",\n \",\": \",\", # <== these things\n \"back tick\": \"`\",\n \"grave\": \"`\",\n \"comma\": \",\",\n # Workaround for issue with conformer b-series; see #946\n \"coma\": \",\",\n \"period\": \".\",\n \"full stop\": \".\",\n \"semicolon\": \";\",\n \"colon\": \":\",\n \"forward slash\": \"/\",\n \"question mark\": \"?\",\n \"exclamation mark\": \"!\",\n \"exclamation point\": \"!\",\n \"asterisk\": \"*\",\n \"hash sign\": \"#\",\n \"number sign\": \"#\",\n \"percent sign\": \"%\",\n \"at sign\": \"@\",\n \"and sign\": \"&\",\n \"ampersand\": \"&\",\n # Currencies\n \"dollar sign\": \"$\",\n \"pound sign\": \"\u00a3\",\n}\nsymbol_key_words = {\n \"dot\": \".\",\n \"point\": \".\",\n \"quote\": \"'\",\n \"question\": \"?\",\n \"apostrophe\": \"'\",\n \"L square\": \"[\",\n \"left square\": \"[\",\n \"square\": \"[\",\n \"R square\": \"]\",\n \"right square\": \"]\",\n \"slash\": \"/\",\n \"backslash\": \"\\\\\",\n \"minus\": \"-\",\n \"dash\": \"-\",\n \"equals\": \"=\",\n \"plus\": \"+\",\n \"tilde\": \"~\",\n \"bang\": \"!\",\n \"down score\": \"_\",\n \"underscore\": \"_\",\n \"paren\": \"(\",\n \"L paren\": \"(\",\n \"left paren\": \"(\",\n \"R paren\": \")\",\n \"right paren\": \")\",\n \"brace\": \"{\",\n \"left brace\": \"{\",\n \"brack\": \"{\",\n \"bracket\": \"{\",\n \"left bracket\": \"{\",\n \"r brace\": \"}\",\n \"right brace\": \"}\",\n \"r brack\": \"}\",\n \"r bracket\": \"}\",\n \"right bracket\": \"}\",\n \"angle\": \"<\",\n \"left angle\": \"<\",\n \"less than\": \"<\",\n \"rangle\": \">\",\n \"R angle\": \">\",\n \"right angle\": \">\",\n \"greater than\": \">\",\n \"star\": \"*\",\n \"hash\": \"#\",\n \"percent\": \"%\",\n \"caret\": \"^\",\n \"amper\": \"&\",\n \"pipe\": \"|\",\n \"dubquote\": '\"',\n \"double quote\": '\"',\n # Currencies\n \"dollar\": \"$\",\n \"pound\": \"\u00a3\",\n}\n\n# make punctuation words also included in {user.symbol_keys}\nsymbol_key_words.update(punctuation_words)\nctx.lists[\"self.punctuation\"] = punctuation_words\nctx.lists[\"self.symbol_key\"] = symbol_key_words\nctx.lists[\"self.number_key\"] = dict(zip(default_digits, numbers))\nctx.lists[\"self.arrow_key\"] = {\n \"down\": \"down\",\n \"left\": \"left\",\n \"right\": \"right\",\n \"up\": \"up\",\n}\n\nsimple_keys = [\n \"end\",\n \"enter\",\n \"escape\",\n \"home\",\n \"insert\",\n \"pagedown\",\n \"pageup\",\n \"space\",\n \"tab\",\n]\n\nalternate_keys = {\n \"wipe\": \"backspace\",\n \"delete\": \"backspace\",\n #'junk': 'backspace',\n \"forward delete\": \"delete\",\n \"page up\": \"pageup\",\n \"page down\": \"pagedown\",\n}\n# mac apparently doesn't have the menu key.\nif app.platform in (\"windows\", \"linux\"):\n alternate_keys[\"menu key\"] = \"menu\"\n alternate_keys[\"print screen\"] = \"printscr\"\n\nspecial_keys = {k: k for k in simple_keys}\nspecial_keys.update(alternate_keys)\nctx.lists[\"self.special_key\"] = special_keys\nctx.lists[\"self.function_key\"] = {\n f\"F {default_f_digits[i]}\": f\"f{i + 1}\" for i in range(12)\n}\n\n\[email protected]_class\nclass Actions:\n def move_cursor(s: str):\n \"\"\"Given a sequence of directions, eg. 'left left up', moves the cursor accordingly using edit.{left,right,up,down}.\"\"\"\n for d in s.split():\n if d in (\"left\", \"right\", \"up\", \"down\"):\n getattr(actions.edit, d)()\n else:\n raise RuntimeError(f\"invalid arrow key: {d}\")\n", "path": "code/keys.py"}]} |
gh_patches_debug_243 | rasdani/github-patches | git_diff | PaddlePaddle__models-2832 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
icnet 存在的几个问题
[icnet](https://github.com/PaddlePaddle/models/tree/develop/PaddleCV/icnet)里存在诸多问题:
1.文档有误，--model_path="./cnkpnt/100"应该是--model_path="./chkpnt/100"
2.训练时没有输出中间过程信息，仅在最后输出几个loss信息
3.文档中给的预训练模型无法用于infer，能提供下训好的cnkpnt/100模型吗？
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `PaddleCV/icnet/train.py`
Content:
```
1 """Trainer for ICNet model."""
2 from __future__ import absolute_import
3 from __future__ import division
4 from __future__ import print_function
5 from icnet import icnet
6 import cityscape
7 import argparse
8 import functools
9 import sys
10 import os
11 import time
12 import paddle.fluid as fluid
13 import numpy as np
14 from utils import add_arguments, print_arguments, get_feeder_data, check_gpu
15 from paddle.fluid.layers.learning_rate_scheduler import _decay_step_counter
16 from paddle.fluid.initializer import init_on_cpu
17
18 if 'ce_mode' in os.environ:
19 np.random.seed(10)
20 fluid.default_startup_program().random_seed = 90
21
22 parser = argparse.ArgumentParser(description=__doc__)
23 add_arg = functools.partial(add_arguments, argparser=parser)
24 # yapf: disable
25 add_arg('batch_size', int, 16, "Minibatch size.")
26 add_arg('checkpoint_path', str, None, "Checkpoint svae path.")
27 add_arg('init_model', str, None, "Pretrain model path.")
28 add_arg('use_gpu', bool, True, "Whether use GPU to train.")
29 add_arg('random_mirror', bool, True, "Whether prepare by random mirror.")
30 add_arg('random_scaling', bool, True, "Whether prepare by random scaling.")
31 # yapf: enable
32
33 LAMBDA1 = 0.16
34 LAMBDA2 = 0.4
35 LAMBDA3 = 1.0
36 LEARNING_RATE = 0.003
37 POWER = 0.9
38 LOG_PERIOD = 100
39 CHECKPOINT_PERIOD = 100
40 TOTAL_STEP = 100
41
42 no_grad_set = []
43
44
45 def create_loss(predict, label, mask, num_classes):
46 predict = fluid.layers.transpose(predict, perm=[0, 2, 3, 1])
47 predict = fluid.layers.reshape(predict, shape=[-1, num_classes])
48 label = fluid.layers.reshape(label, shape=[-1, 1])
49 predict = fluid.layers.gather(predict, mask)
50 label = fluid.layers.gather(label, mask)
51 label = fluid.layers.cast(label, dtype="int64")
52 loss = fluid.layers.softmax_with_cross_entropy(predict, label)
53 no_grad_set.append(label.name)
54 return fluid.layers.reduce_mean(loss)
55
56
57 def poly_decay():
58 global_step = _decay_step_counter()
59 with init_on_cpu():
60 decayed_lr = LEARNING_RATE * (fluid.layers.pow(
61 (1 - global_step / TOTAL_STEP), POWER))
62 return decayed_lr
63
64
65 def train(args):
66 data_shape = cityscape.train_data_shape()
67 num_classes = cityscape.num_classes()
68 # define network
69 images = fluid.layers.data(name='image', shape=data_shape, dtype='float32')
70 label_sub1 = fluid.layers.data(name='label_sub1', shape=[1], dtype='int32')
71 label_sub2 = fluid.layers.data(name='label_sub2', shape=[1], dtype='int32')
72 label_sub4 = fluid.layers.data(name='label_sub4', shape=[1], dtype='int32')
73 mask_sub1 = fluid.layers.data(name='mask_sub1', shape=[-1], dtype='int32')
74 mask_sub2 = fluid.layers.data(name='mask_sub2', shape=[-1], dtype='int32')
75 mask_sub4 = fluid.layers.data(name='mask_sub4', shape=[-1], dtype='int32')
76
77 sub4_out, sub24_out, sub124_out = icnet(
78 images, num_classes, np.array(data_shape[1:]).astype("float32"))
79 loss_sub4 = create_loss(sub4_out, label_sub4, mask_sub4, num_classes)
80 loss_sub24 = create_loss(sub24_out, label_sub2, mask_sub2, num_classes)
81 loss_sub124 = create_loss(sub124_out, label_sub1, mask_sub1, num_classes)
82 reduced_loss = LAMBDA1 * loss_sub4 + LAMBDA2 * loss_sub24 + LAMBDA3 * loss_sub124
83
84 regularizer = fluid.regularizer.L2Decay(0.0001)
85 optimizer = fluid.optimizer.Momentum(
86 learning_rate=poly_decay(), momentum=0.9, regularization=regularizer)
87 _, params_grads = optimizer.minimize(reduced_loss, no_grad_set=no_grad_set)
88
89 # prepare environment
90 place = fluid.CPUPlace()
91 if args.use_gpu:
92 place = fluid.CUDAPlace(0)
93 exe = fluid.Executor(place)
94
95 exe.run(fluid.default_startup_program())
96
97 if args.init_model is not None:
98 print("load model from: %s" % args.init_model)
99
100 def if_exist(var):
101 return os.path.exists(os.path.join(args.init_model, var.name))
102
103 fluid.io.load_vars(exe, args.init_model, predicate=if_exist)
104
105 iter_id = 0
106 t_loss = 0.
107 sub4_loss = 0.
108 sub24_loss = 0.
109 sub124_loss = 0.
110 train_reader = cityscape.train(
111 args.batch_size, flip=args.random_mirror, scaling=args.random_scaling)
112 start_time = time.time()
113 while True:
114 # train a pass
115 for data in train_reader():
116 if iter_id > TOTAL_STEP:
117 end_time = time.time()
118 print("kpis train_duration %f" % (end_time - start_time))
119 return
120 iter_id += 1
121 results = exe.run(
122 feed=get_feeder_data(data, place),
123 fetch_list=[reduced_loss, loss_sub4, loss_sub24, loss_sub124])
124 t_loss += results[0]
125 sub4_loss += results[1]
126 sub24_loss += results[2]
127 sub124_loss += results[3]
128 # training log
129 if iter_id % LOG_PERIOD == 0:
130 print(
131 "Iter[%d]; train loss: %.3f; sub4_loss: %.3f; sub24_loss: %.3f; sub124_loss: %.3f"
132 % (iter_id, t_loss / LOG_PERIOD, sub4_loss / LOG_PERIOD,
133 sub24_loss / LOG_PERIOD, sub124_loss / LOG_PERIOD))
134 print("kpis train_cost %f" % (t_loss / LOG_PERIOD))
135
136 t_loss = 0.
137 sub4_loss = 0.
138 sub24_loss = 0.
139 sub124_loss = 0.
140 sys.stdout.flush()
141
142 if iter_id % CHECKPOINT_PERIOD == 0 and args.checkpoint_path is not None:
143 dir_name = args.checkpoint_path + "/" + str(iter_id)
144 fluid.io.save_persistables(exe, dirname=dir_name)
145 print("Saved checkpoint: %s" % (dir_name))
146
147
148 def main():
149 args = parser.parse_args()
150 print_arguments(args)
151 check_gpu(args.use_gpu)
152 train(args)
153
154
155 if __name__ == "__main__":
156 main()
157
```
--- 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/PaddleCV/icnet/train.py b/PaddleCV/icnet/train.py
--- a/PaddleCV/icnet/train.py
+++ b/PaddleCV/icnet/train.py
@@ -35,9 +35,11 @@
LAMBDA3 = 1.0
LEARNING_RATE = 0.003
POWER = 0.9
-LOG_PERIOD = 100
-CHECKPOINT_PERIOD = 100
-TOTAL_STEP = 100
+LOG_PERIOD = 1
+CHECKPOINT_PERIOD = 1000
+TOTAL_STEP = 60000
+if 'ce_mode' in os.environ:
+ TOTAL_STEP = 100
no_grad_set = []
| {"golden_diff": "diff --git a/PaddleCV/icnet/train.py b/PaddleCV/icnet/train.py\n--- a/PaddleCV/icnet/train.py\n+++ b/PaddleCV/icnet/train.py\n@@ -35,9 +35,11 @@\n LAMBDA3 = 1.0\n LEARNING_RATE = 0.003\n POWER = 0.9\n-LOG_PERIOD = 100\n-CHECKPOINT_PERIOD = 100\n-TOTAL_STEP = 100\n+LOG_PERIOD = 1\n+CHECKPOINT_PERIOD = 1000\n+TOTAL_STEP = 60000\n+if 'ce_mode' in os.environ:\n+ TOTAL_STEP = 100\n \n no_grad_set = []\n", "issue": "icnet \u5b58\u5728\u7684\u51e0\u4e2a\u95ee\u9898\n[icnet](https://github.com/PaddlePaddle/models/tree/develop/PaddleCV/icnet)\u91cc\u5b58\u5728\u8bf8\u591a\u95ee\u9898:\r\n1.\u6587\u6863\u6709\u8bef\uff0c--model_path=\"./cnkpnt/100\"\u5e94\u8be5\u662f--model_path=\"./chkpnt/100\"\r\n2.\u8bad\u7ec3\u65f6\u6ca1\u6709\u8f93\u51fa\u4e2d\u95f4\u8fc7\u7a0b\u4fe1\u606f\uff0c\u4ec5\u5728\u6700\u540e\u8f93\u51fa\u51e0\u4e2aloss\u4fe1\u606f\r\n3.\u6587\u6863\u4e2d\u7ed9\u7684\u9884\u8bad\u7ec3\u6a21\u578b\u65e0\u6cd5\u7528\u4e8einfer\uff0c\u80fd\u63d0\u4f9b\u4e0b\u8bad\u597d\u7684cnkpnt/100\u6a21\u578b\u5417\uff1f\n", "before_files": [{"content": "\"\"\"Trainer for ICNet model.\"\"\"\nfrom __future__ import absolute_import\nfrom __future__ import division\nfrom __future__ import print_function\nfrom icnet import icnet\nimport cityscape\nimport argparse\nimport functools\nimport sys\nimport os\nimport time\nimport paddle.fluid as fluid\nimport numpy as np\nfrom utils import add_arguments, print_arguments, get_feeder_data, check_gpu\nfrom paddle.fluid.layers.learning_rate_scheduler import _decay_step_counter\nfrom paddle.fluid.initializer import init_on_cpu\n\nif 'ce_mode' in os.environ:\n np.random.seed(10)\n fluid.default_startup_program().random_seed = 90\n\nparser = argparse.ArgumentParser(description=__doc__)\nadd_arg = functools.partial(add_arguments, argparser=parser)\n# yapf: disable\nadd_arg('batch_size', int, 16, \"Minibatch size.\")\nadd_arg('checkpoint_path', str, None, \"Checkpoint svae path.\")\nadd_arg('init_model', str, None, \"Pretrain model path.\")\nadd_arg('use_gpu', bool, True, \"Whether use GPU to train.\")\nadd_arg('random_mirror', bool, True, \"Whether prepare by random mirror.\")\nadd_arg('random_scaling', bool, True, \"Whether prepare by random scaling.\")\n# yapf: enable\n\nLAMBDA1 = 0.16\nLAMBDA2 = 0.4\nLAMBDA3 = 1.0\nLEARNING_RATE = 0.003\nPOWER = 0.9\nLOG_PERIOD = 100\nCHECKPOINT_PERIOD = 100\nTOTAL_STEP = 100\n\nno_grad_set = []\n\n\ndef create_loss(predict, label, mask, num_classes):\n predict = fluid.layers.transpose(predict, perm=[0, 2, 3, 1])\n predict = fluid.layers.reshape(predict, shape=[-1, num_classes])\n label = fluid.layers.reshape(label, shape=[-1, 1])\n predict = fluid.layers.gather(predict, mask)\n label = fluid.layers.gather(label, mask)\n label = fluid.layers.cast(label, dtype=\"int64\")\n loss = fluid.layers.softmax_with_cross_entropy(predict, label)\n no_grad_set.append(label.name)\n return fluid.layers.reduce_mean(loss)\n\n\ndef poly_decay():\n global_step = _decay_step_counter()\n with init_on_cpu():\n decayed_lr = LEARNING_RATE * (fluid.layers.pow(\n (1 - global_step / TOTAL_STEP), POWER))\n return decayed_lr\n\n\ndef train(args):\n data_shape = cityscape.train_data_shape()\n num_classes = cityscape.num_classes()\n # define network\n images = fluid.layers.data(name='image', shape=data_shape, dtype='float32')\n label_sub1 = fluid.layers.data(name='label_sub1', shape=[1], dtype='int32')\n label_sub2 = fluid.layers.data(name='label_sub2', shape=[1], dtype='int32')\n label_sub4 = fluid.layers.data(name='label_sub4', shape=[1], dtype='int32')\n mask_sub1 = fluid.layers.data(name='mask_sub1', shape=[-1], dtype='int32')\n mask_sub2 = fluid.layers.data(name='mask_sub2', shape=[-1], dtype='int32')\n mask_sub4 = fluid.layers.data(name='mask_sub4', shape=[-1], dtype='int32')\n\n sub4_out, sub24_out, sub124_out = icnet(\n images, num_classes, np.array(data_shape[1:]).astype(\"float32\"))\n loss_sub4 = create_loss(sub4_out, label_sub4, mask_sub4, num_classes)\n loss_sub24 = create_loss(sub24_out, label_sub2, mask_sub2, num_classes)\n loss_sub124 = create_loss(sub124_out, label_sub1, mask_sub1, num_classes)\n reduced_loss = LAMBDA1 * loss_sub4 + LAMBDA2 * loss_sub24 + LAMBDA3 * loss_sub124\n\n regularizer = fluid.regularizer.L2Decay(0.0001)\n optimizer = fluid.optimizer.Momentum(\n learning_rate=poly_decay(), momentum=0.9, regularization=regularizer)\n _, params_grads = optimizer.minimize(reduced_loss, no_grad_set=no_grad_set)\n\n # prepare environment\n place = fluid.CPUPlace()\n if args.use_gpu:\n place = fluid.CUDAPlace(0)\n exe = fluid.Executor(place)\n\n exe.run(fluid.default_startup_program())\n\n if args.init_model is not None:\n print(\"load model from: %s\" % args.init_model)\n\n def if_exist(var):\n return os.path.exists(os.path.join(args.init_model, var.name))\n\n fluid.io.load_vars(exe, args.init_model, predicate=if_exist)\n\n iter_id = 0\n t_loss = 0.\n sub4_loss = 0.\n sub24_loss = 0.\n sub124_loss = 0.\n train_reader = cityscape.train(\n args.batch_size, flip=args.random_mirror, scaling=args.random_scaling)\n start_time = time.time()\n while True:\n # train a pass\n for data in train_reader():\n if iter_id > TOTAL_STEP:\n end_time = time.time()\n print(\"kpis\ttrain_duration\t%f\" % (end_time - start_time))\n return\n iter_id += 1\n results = exe.run(\n feed=get_feeder_data(data, place),\n fetch_list=[reduced_loss, loss_sub4, loss_sub24, loss_sub124])\n t_loss += results[0]\n sub4_loss += results[1]\n sub24_loss += results[2]\n sub124_loss += results[3]\n # training log\n if iter_id % LOG_PERIOD == 0:\n print(\n \"Iter[%d]; train loss: %.3f; sub4_loss: %.3f; sub24_loss: %.3f; sub124_loss: %.3f\"\n % (iter_id, t_loss / LOG_PERIOD, sub4_loss / LOG_PERIOD,\n sub24_loss / LOG_PERIOD, sub124_loss / LOG_PERIOD))\n print(\"kpis\ttrain_cost\t%f\" % (t_loss / LOG_PERIOD))\n\n t_loss = 0.\n sub4_loss = 0.\n sub24_loss = 0.\n sub124_loss = 0.\n sys.stdout.flush()\n\n if iter_id % CHECKPOINT_PERIOD == 0 and args.checkpoint_path is not None:\n dir_name = args.checkpoint_path + \"/\" + str(iter_id)\n fluid.io.save_persistables(exe, dirname=dir_name)\n print(\"Saved checkpoint: %s\" % (dir_name))\n\n\ndef main():\n args = parser.parse_args()\n print_arguments(args)\n check_gpu(args.use_gpu)\n train(args)\n\n\nif __name__ == \"__main__\":\n main()\n", "path": "PaddleCV/icnet/train.py"}], "after_files": [{"content": "\"\"\"Trainer for ICNet model.\"\"\"\nfrom __future__ import absolute_import\nfrom __future__ import division\nfrom __future__ import print_function\nfrom icnet import icnet\nimport cityscape\nimport argparse\nimport functools\nimport sys\nimport os\nimport time\nimport paddle.fluid as fluid\nimport numpy as np\nfrom utils import add_arguments, print_arguments, get_feeder_data, check_gpu\nfrom paddle.fluid.layers.learning_rate_scheduler import _decay_step_counter\nfrom paddle.fluid.initializer import init_on_cpu\n\nif 'ce_mode' in os.environ:\n np.random.seed(10)\n fluid.default_startup_program().random_seed = 90\n\nparser = argparse.ArgumentParser(description=__doc__)\nadd_arg = functools.partial(add_arguments, argparser=parser)\n# yapf: disable\nadd_arg('batch_size', int, 16, \"Minibatch size.\")\nadd_arg('checkpoint_path', str, None, \"Checkpoint svae path.\")\nadd_arg('init_model', str, None, \"Pretrain model path.\")\nadd_arg('use_gpu', bool, True, \"Whether use GPU to train.\")\nadd_arg('random_mirror', bool, True, \"Whether prepare by random mirror.\")\nadd_arg('random_scaling', bool, True, \"Whether prepare by random scaling.\")\n# yapf: enable\n\nLAMBDA1 = 0.16\nLAMBDA2 = 0.4\nLAMBDA3 = 1.0\nLEARNING_RATE = 0.003\nPOWER = 0.9\nLOG_PERIOD = 1\nCHECKPOINT_PERIOD = 1000\nTOTAL_STEP = 60000\nif 'ce_mode' in os.environ:\n TOTAL_STEP = 100\n\nno_grad_set = []\n\n\ndef create_loss(predict, label, mask, num_classes):\n predict = fluid.layers.transpose(predict, perm=[0, 2, 3, 1])\n predict = fluid.layers.reshape(predict, shape=[-1, num_classes])\n label = fluid.layers.reshape(label, shape=[-1, 1])\n predict = fluid.layers.gather(predict, mask)\n label = fluid.layers.gather(label, mask)\n label = fluid.layers.cast(label, dtype=\"int64\")\n loss = fluid.layers.softmax_with_cross_entropy(predict, label)\n no_grad_set.append(label.name)\n return fluid.layers.reduce_mean(loss)\n\n\ndef poly_decay():\n global_step = _decay_step_counter()\n with init_on_cpu():\n decayed_lr = LEARNING_RATE * (fluid.layers.pow(\n (1 - global_step / TOTAL_STEP), POWER))\n return decayed_lr\n\n\ndef train(args):\n data_shape = cityscape.train_data_shape()\n num_classes = cityscape.num_classes()\n # define network\n images = fluid.layers.data(name='image', shape=data_shape, dtype='float32')\n label_sub1 = fluid.layers.data(name='label_sub1', shape=[1], dtype='int32')\n label_sub2 = fluid.layers.data(name='label_sub2', shape=[1], dtype='int32')\n label_sub4 = fluid.layers.data(name='label_sub4', shape=[1], dtype='int32')\n mask_sub1 = fluid.layers.data(name='mask_sub1', shape=[-1], dtype='int32')\n mask_sub2 = fluid.layers.data(name='mask_sub2', shape=[-1], dtype='int32')\n mask_sub4 = fluid.layers.data(name='mask_sub4', shape=[-1], dtype='int32')\n\n sub4_out, sub24_out, sub124_out = icnet(\n images, num_classes, np.array(data_shape[1:]).astype(\"float32\"))\n loss_sub4 = create_loss(sub4_out, label_sub4, mask_sub4, num_classes)\n loss_sub24 = create_loss(sub24_out, label_sub2, mask_sub2, num_classes)\n loss_sub124 = create_loss(sub124_out, label_sub1, mask_sub1, num_classes)\n reduced_loss = LAMBDA1 * loss_sub4 + LAMBDA2 * loss_sub24 + LAMBDA3 * loss_sub124\n\n regularizer = fluid.regularizer.L2Decay(0.0001)\n optimizer = fluid.optimizer.Momentum(\n learning_rate=poly_decay(), momentum=0.9, regularization=regularizer)\n _, params_grads = optimizer.minimize(reduced_loss, no_grad_set=no_grad_set)\n\n # prepare environment\n place = fluid.CPUPlace()\n if args.use_gpu:\n place = fluid.CUDAPlace(0)\n exe = fluid.Executor(place)\n\n exe.run(fluid.default_startup_program())\n\n if args.init_model is not None:\n print(\"load model from: %s\" % args.init_model)\n\n def if_exist(var):\n return os.path.exists(os.path.join(args.init_model, var.name))\n\n fluid.io.load_vars(exe, args.init_model, predicate=if_exist)\n\n iter_id = 0\n t_loss = 0.\n sub4_loss = 0.\n sub24_loss = 0.\n sub124_loss = 0.\n train_reader = cityscape.train(\n args.batch_size, flip=args.random_mirror, scaling=args.random_scaling)\n start_time = time.time()\n while True:\n # train a pass\n for data in train_reader():\n if iter_id > TOTAL_STEP:\n end_time = time.time()\n print(\"kpis\ttrain_duration\t%f\" % (end_time - start_time))\n return\n iter_id += 1\n results = exe.run(\n feed=get_feeder_data(data, place),\n fetch_list=[reduced_loss, loss_sub4, loss_sub24, loss_sub124])\n t_loss += results[0]\n sub4_loss += results[1]\n sub24_loss += results[2]\n sub124_loss += results[3]\n # training log\n if iter_id % LOG_PERIOD == 0:\n print(\n \"Iter[%d]; train loss: %.3f; sub4_loss: %.3f; sub24_loss: %.3f; sub124_loss: %.3f\"\n % (iter_id, t_loss / LOG_PERIOD, sub4_loss / LOG_PERIOD,\n sub24_loss / LOG_PERIOD, sub124_loss / LOG_PERIOD))\n print(\"kpis\ttrain_cost\t%f\" % (t_loss / LOG_PERIOD))\n\n t_loss = 0.\n sub4_loss = 0.\n sub24_loss = 0.\n sub124_loss = 0.\n sys.stdout.flush()\n\n if iter_id % CHECKPOINT_PERIOD == 0 and args.checkpoint_path is not None:\n dir_name = args.checkpoint_path + \"/\" + str(iter_id)\n fluid.io.save_persistables(exe, dirname=dir_name)\n print(\"Saved checkpoint: %s\" % (dir_name))\n\n\ndef main():\n args = parser.parse_args()\n print_arguments(args)\n check_gpu(args.use_gpu)\n train(args)\n\n\nif __name__ == \"__main__\":\n main()\n", "path": "PaddleCV/icnet/train.py"}]} |
gh_patches_debug_244 | rasdani/github-patches | git_diff | googleapis__google-cloud-python-3745 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Explicitly depend on setuptools
Context: #3295
We should explicitly depend on a minimum version of setuptools to get around problems installing our packages if setuptools is too old.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `core/setup.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 import os
16
17 from setuptools import find_packages
18 from setuptools import setup
19
20
21 PACKAGE_ROOT = os.path.abspath(os.path.dirname(__file__))
22
23 with open(os.path.join(PACKAGE_ROOT, 'README.rst')) as file_obj:
24 README = file_obj.read()
25
26 # NOTE: This is duplicated throughout and we should try to
27 # consolidate.
28 SETUP_BASE = {
29 'author': 'Google Cloud Platform',
30 'author_email': '[email protected]',
31 'scripts': [],
32 'url': 'https://github.com/GoogleCloudPlatform/google-cloud-python',
33 'license': 'Apache 2.0',
34 'platforms': 'Posix; MacOS X; Windows',
35 'include_package_data': True,
36 'zip_safe': False,
37 'classifiers': [
38 'Development Status :: 4 - Beta',
39 'Intended Audience :: Developers',
40 'License :: OSI Approved :: Apache Software License',
41 'Operating System :: OS Independent',
42 'Programming Language :: Python :: 2',
43 'Programming Language :: Python :: 2.7',
44 'Programming Language :: Python :: 3',
45 'Programming Language :: Python :: 3.4',
46 'Programming Language :: Python :: 3.5',
47 'Programming Language :: Python :: 3.6',
48 'Topic :: Internet',
49 ],
50 }
51
52
53 REQUIREMENTS = [
54 'googleapis-common-protos >= 1.3.4',
55 'protobuf >= 3.0.0',
56 'google-auth >= 0.4.0, < 2.0.0dev',
57 'requests >= 2.4.0, < 3.0.0dev',
58 'six',
59 'tenacity >= 4.0.0, <5.0.0dev'
60 ]
61
62 setup(
63 name='google-cloud-core',
64 version='0.26.0',
65 description='API Client library for Google Cloud: Core Helpers',
66 long_description=README,
67 namespace_packages=[
68 'google',
69 'google.cloud',
70 'google.api',
71 ],
72 packages=find_packages(exclude=('tests*',)),
73 install_requires=REQUIREMENTS,
74 **SETUP_BASE
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/core/setup.py b/core/setup.py
--- a/core/setup.py
+++ b/core/setup.py
@@ -55,6 +55,7 @@
'protobuf >= 3.0.0',
'google-auth >= 0.4.0, < 2.0.0dev',
'requests >= 2.4.0, < 3.0.0dev',
+ 'setuptools >= 34.0.0',
'six',
'tenacity >= 4.0.0, <5.0.0dev'
]
| {"golden_diff": "diff --git a/core/setup.py b/core/setup.py\n--- a/core/setup.py\n+++ b/core/setup.py\n@@ -55,6 +55,7 @@\n 'protobuf >= 3.0.0',\n 'google-auth >= 0.4.0, < 2.0.0dev',\n 'requests >= 2.4.0, < 3.0.0dev',\n+ 'setuptools >= 34.0.0',\n 'six',\n 'tenacity >= 4.0.0, <5.0.0dev'\n ]\n", "issue": "Explicitly depend on setuptools\nContext: #3295\r\n\r\nWe should explicitly depend on a minimum version of setuptools to get around problems installing our packages if setuptools is too old.\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\nimport os\n\nfrom setuptools import find_packages\nfrom setuptools import setup\n\n\nPACKAGE_ROOT = os.path.abspath(os.path.dirname(__file__))\n\nwith open(os.path.join(PACKAGE_ROOT, 'README.rst')) as file_obj:\n README = file_obj.read()\n\n# NOTE: This is duplicated throughout and we should try to\n# consolidate.\nSETUP_BASE = {\n 'author': 'Google Cloud Platform',\n 'author_email': '[email protected]',\n 'scripts': [],\n 'url': 'https://github.com/GoogleCloudPlatform/google-cloud-python',\n 'license': 'Apache 2.0',\n 'platforms': 'Posix; MacOS X; Windows',\n 'include_package_data': True,\n 'zip_safe': False,\n 'classifiers': [\n 'Development Status :: 4 - Beta',\n 'Intended Audience :: Developers',\n 'License :: OSI Approved :: Apache Software License',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python :: 2',\n 'Programming Language :: Python :: 2.7',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.4',\n 'Programming Language :: Python :: 3.5',\n 'Programming Language :: Python :: 3.6',\n 'Topic :: Internet',\n ],\n}\n\n\nREQUIREMENTS = [\n 'googleapis-common-protos >= 1.3.4',\n 'protobuf >= 3.0.0',\n 'google-auth >= 0.4.0, < 2.0.0dev',\n 'requests >= 2.4.0, < 3.0.0dev',\n 'six',\n 'tenacity >= 4.0.0, <5.0.0dev'\n]\n\nsetup(\n name='google-cloud-core',\n version='0.26.0',\n description='API Client library for Google Cloud: Core Helpers',\n long_description=README,\n namespace_packages=[\n 'google',\n 'google.cloud',\n 'google.api',\n ],\n packages=find_packages(exclude=('tests*',)),\n install_requires=REQUIREMENTS,\n **SETUP_BASE\n)\n", "path": "core/setup.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\nimport os\n\nfrom setuptools import find_packages\nfrom setuptools import setup\n\n\nPACKAGE_ROOT = os.path.abspath(os.path.dirname(__file__))\n\nwith open(os.path.join(PACKAGE_ROOT, 'README.rst')) as file_obj:\n README = file_obj.read()\n\n# NOTE: This is duplicated throughout and we should try to\n# consolidate.\nSETUP_BASE = {\n 'author': 'Google Cloud Platform',\n 'author_email': '[email protected]',\n 'scripts': [],\n 'url': 'https://github.com/GoogleCloudPlatform/google-cloud-python',\n 'license': 'Apache 2.0',\n 'platforms': 'Posix; MacOS X; Windows',\n 'include_package_data': True,\n 'zip_safe': False,\n 'classifiers': [\n 'Development Status :: 4 - Beta',\n 'Intended Audience :: Developers',\n 'License :: OSI Approved :: Apache Software License',\n 'Operating System :: OS Independent',\n 'Programming Language :: Python :: 2',\n 'Programming Language :: Python :: 2.7',\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.4',\n 'Programming Language :: Python :: 3.5',\n 'Programming Language :: Python :: 3.6',\n 'Topic :: Internet',\n ],\n}\n\n\nREQUIREMENTS = [\n 'googleapis-common-protos >= 1.3.4',\n 'protobuf >= 3.0.0',\n 'google-auth >= 0.4.0, < 2.0.0dev',\n 'requests >= 2.4.0, < 3.0.0dev',\n 'setuptools >= 34.0.0',\n 'six',\n 'tenacity >= 4.0.0, <5.0.0dev'\n]\n\nsetup(\n name='google-cloud-core',\n version='0.26.0',\n description='API Client library for Google Cloud: Core Helpers',\n long_description=README,\n namespace_packages=[\n 'google',\n 'google.cloud',\n 'google.api',\n ],\n packages=find_packages(exclude=('tests*',)),\n install_requires=REQUIREMENTS,\n **SETUP_BASE\n)\n", "path": "core/setup.py"}]} |
gh_patches_debug_245 | rasdani/github-patches | git_diff | dotkom__onlineweb4-1699 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
attendees_not_paid property is plain wrong
It returns all attendees who have paid instead. It is only used for sending out emails afaik.
https://github.com/dotKom/onlineweb4/blob/2347446f5bb66d202b7adecc9433a8e26fe3b0b4/apps/events/models.py#L450
IMO it should be something like `return list(self.attendees.filter(paid=False))` instead of simply adding a `not`,
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `apps/events/models.py`
Content:
```
1 # -*- coding: utf-8 -*-
2
3 from collections import OrderedDict
4 from datetime import datetime, timedelta
5 from functools import reduce
6
7 from django.conf import settings
8 from django.contrib.auth.models import Group
9 from django.contrib.contenttypes.models import ContentType
10 from django.core import validators
11 from django.db import models
12 from django.db.models import Case, Q, Value, When
13 from django.template.defaultfilters import slugify
14 from django.utils import timezone
15 from django.utils.translation import ugettext as _
16 from filebrowser.fields import FileBrowseField
17 from unidecode import unidecode
18
19 from apps.authentication.models import FIELD_OF_STUDY_CHOICES
20 from apps.companyprofile.models import Company
21 from apps.marks.models import get_expiration_date
22
23 User = settings.AUTH_USER_MODEL
24
25 TYPE_CHOICES = (
26 (1, 'Sosialt'),
27 (2, 'Bedriftspresentasjon'),
28 (3, 'Kurs'),
29 (4, 'Utflukt'),
30 (5, 'Ekskursjon'),
31 (6, 'Internt'),
32 (7, 'Annet')
33 )
34
35
36 # Managers
37
38 class EventOrderedByRegistration(models.Manager):
39 """
40 Order events by registration start if registration start is within 7 days of today.
41 """
42 def get_queryset(self):
43 now = timezone.now()
44 DELTA_FUTURE_SETTING = settings.OW4_SETTINGS.get('events').get('FEATURED_DAYS_FUTURE')
45 DELTA_PAST_SETTING = settings.OW4_SETTINGS.get('events').get('FEATURED_DAYS_PAST')
46 DAYS_BACK_DELTA = timezone.now() - timedelta(days=DELTA_PAST_SETTING)
47 DAYS_FORWARD_DELTA = timezone.now() + timedelta(days=DELTA_FUTURE_SETTING)
48
49 return super(EventOrderedByRegistration, self).get_queryset().\
50 annotate(registration_filtered=Case(
51 When(Q(event_end__gte=now) &
52 Q(attendance_event__registration_start__gte=DAYS_BACK_DELTA) &
53 Q(attendance_event__registration_start__lte=DAYS_FORWARD_DELTA),
54 then='attendance_event__registration_start'),
55 default='event_end',
56 output_field=models.DateTimeField()
57 )
58 ).annotate(is_today=Case(
59 When(event_end__date=now.date(),
60 then=Value(1)),
61 default=Value(0),
62 output_field=models.IntegerField()
63 )
64 ).order_by('-is_today', 'registration_filtered')
65
66
67 class Event(models.Model):
68 """
69 Base class for Event-objects.
70 """
71
72 IMAGE_FOLDER = "images/events"
73 IMAGE_EXTENSIONS = ['.jpg', '.jpeg', '.gif', '.png', '.tif', '.tiff']
74
75 # Managers
76 objects = models.Manager()
77 by_registration = EventOrderedByRegistration()
78
79 author = models.ForeignKey(User, related_name='oppretter')
80 title = models.CharField(_('tittel'), max_length=60)
81 event_start = models.DateTimeField(_('start-dato'))
82 event_end = models.DateTimeField(_('slutt-dato'))
83 location = models.CharField(_('lokasjon'), max_length=100)
84 ingress_short = models.CharField(_("kort ingress"), max_length=150,
85 validators=[validators.MinLengthValidator(25)])
86 ingress = models.TextField(_('ingress'), validators=[validators.MinLengthValidator(25)])
87 description = models.TextField(_('beskrivelse'), validators=[validators.MinLengthValidator(45)])
88 image = FileBrowseField(_("bilde"), max_length=200,
89 directory=IMAGE_FOLDER, extensions=IMAGE_EXTENSIONS, null=True, blank=True)
90 event_type = models.SmallIntegerField(_('type'), choices=TYPE_CHOICES, null=False)
91
92 def is_attendance_event(self):
93 """ Returns true if the event is an attendance event """
94 try:
95 return True if self.attendance_event else False
96 except AttendanceEvent.DoesNotExist:
97 return False
98
99 def images(self):
100 if not self.image:
101 return []
102 from apps.events.utils import find_image_versions
103 return find_image_versions(self)
104
105 # TODO move payment and feedback stuff to attendance event when dasboard is done
106
107 def feedback_users(self):
108 if self.is_attendance_event:
109 return [a.user for a in self.attendance_event.attendees.filter(attended=True)]
110 return []
111
112 def feedback_date(self):
113 return self.event_end
114
115 def feedback_title(self):
116 return self.title
117
118 def feedback_info(self):
119 info = OrderedDict()
120 if self.is_attendance_event():
121 info[_('Påmeldte')] = self.attendance_event.number_of_attendees
122 info[_('Oppmøtte')] = self.attendance_event.number_of_attendees - len(self.attendance_event.not_attended())
123 info[_('Venteliste')] = self.attendance_event.number_on_waitlist
124
125 return info
126
127 @property
128 def company_event(self):
129 try:
130 return CompanyEvent.objects.filter(event=self)
131 except CompanyEvent.DoesNotExist:
132 return None
133
134 def feedback_mail(self):
135 if self.event_type == 1 or self.event_type == 4: # Sosialt & Utflukt
136 return settings.EMAIL_ARRKOM
137 elif self.event_type == 2: # Bedpres
138 return settings.EMAIL_BEDKOM
139 elif self.event_type == 3: # Kurs
140 return settings.EMAIL_FAGKOM
141 elif self.event_type == 5: # Ekskursjon
142 return settings.EMAIL_EKSKOM
143 else:
144 return settings.DEFAULT_FROM_EMAIL
145
146 def can_display(self, user):
147 restriction = GroupRestriction.objects.filter(event=self)
148
149 if not restriction:
150 return True
151
152 if not user:
153 return False
154
155 groups = restriction[0].groups
156
157 # returns True if any of the users groups are in one of the accepted groups
158 return any(group in user.groups.all() for group in groups.all())
159
160 @property
161 def slug(self):
162 return slugify(unidecode(self.title))
163
164 @models.permalink
165 def get_absolute_url(self):
166 return 'events_details', None, {'event_id': self.id, 'event_slug': self.slug}
167
168 def __str__(self):
169 return self.title
170
171 class Meta:
172 verbose_name = _('arrangement')
173 verbose_name_plural = _('arrangement')
174 permissions = (
175 ('view_event', 'View Event'),
176 )
177
178
179 """
180 BEGIN ACCESS RESTRICTION --------------------------------------------------------------------------
181 """
182
183
184 class Rule(models.Model):
185 """
186 Super class for a rule object
187 """
188 offset = models.PositiveSmallIntegerField(_('utsettelse'), help_text=_('utsettelse oppgis i timer'), default=0)
189
190 def get_offset_time(self, time):
191 if type(time) is not datetime:
192 raise TypeError('time must be a datetime, not %s' % type(time))
193 else:
194 return time + timedelta(hours=self.offset)
195
196 def satisfied(self, user):
197 """ Checks if a user satisfies the rules """
198 return True
199
200 def __str__(self):
201 return 'Rule'
202
203 class Meta:
204 permissions = (
205 ('view_rule', 'View Rule'),
206 )
207
208
209 class FieldOfStudyRule(Rule):
210 field_of_study = models.SmallIntegerField(_('studieretning'), choices=FIELD_OF_STUDY_CHOICES)
211
212 def satisfied(self, user, registration_start):
213 """ Override method """
214
215 # If the user has the same FOS as this rule
216 if self.field_of_study == user.field_of_study:
217 offset_datetime = self.get_offset_time(registration_start)
218 # If the offset is in the past, it means you can attend even with the offset
219 if offset_datetime < timezone.now():
220 return {"status": True, "message": None, "status_code": 210}
221 # If there is no offset, the signup just hasn't started yet
222 elif self.offset == 0:
223 return {"status": False, "message": _("Påmeldingen er ikke åpnet enda."), "status_code": 402}
224 # In the last case there is a delayed signup
225 else:
226 return {"status": False, "message": _("Din studieretning har utsatt påmelding."),
227 "offset": offset_datetime, "status_code": 420}
228 return {
229 "status": False, "message":
230 _("Din studieretning er en annen enn de som har tilgang til dette arrangementet."), "status_code": 410}
231
232 def __str__(self):
233 if self.offset > 0:
234 time_unit = _('timer') if self.offset > 1 else _('time')
235 return _("%s etter %d %s") % (str(self.get_field_of_study_display()), self.offset, time_unit)
236 return str(self.get_field_of_study_display())
237
238 class Meta:
239 permissions = (
240 ('view_fieldofstudyrule', 'View FieldOfStudyRule'),
241 )
242
243
244 class GradeRule(Rule):
245 grade = models.SmallIntegerField(_('klassetrinn'), null=False)
246
247 def satisfied(self, user, registration_start):
248 """ Override method """
249
250 # If the user has the same FOS as this rule
251 if self.grade == user.year:
252 offset_datetime = self.get_offset_time(registration_start)
253 # If the offset is in the past, it means you can attend even with the offset
254 if offset_datetime < timezone.now():
255 return {"status": True, "message": None, "status_code": 211}
256 # If there is no offset, the signup just hasn't started yet
257 elif self.offset == 0:
258 return {"status": False, "message": _("Påmeldingen er ikke åpnet enda."), "status_code": 402}
259 # In the last case there is a delayed signup
260 else:
261 return {
262 "status": False, "message":
263 _("Ditt klassetrinn har utsatt påmelding."), "offset": offset_datetime, "status_code": 421}
264 return {
265 "status": False, "message":
266 _("Du er ikke i et klassetrinn som har tilgang til dette arrangementet."), "status_code": 411}
267
268 def __str__(self):
269 if self.offset > 0:
270 time_unit = _('timer') if self.offset > 1 else _('time')
271 return _("%s. klasse etter %d %s") % (self.grade, self.offset, time_unit)
272 return _("%s. klasse") % self.grade
273
274 class Meta:
275 permissions = (
276 ('view_graderule', 'View GradeRule'),
277 )
278
279
280 class UserGroupRule(Rule):
281 group = models.ForeignKey(Group, blank=False, null=False)
282
283 def satisfied(self, user, registration_start):
284 """ Override method """
285 if self.group in user.groups.all():
286 offset_datetime = self.get_offset_time(registration_start)
287 # If the offset is in the past, it means you can attend even with the offset
288 if offset_datetime < timezone.now():
289 return {"status": True, "message": None, "status_code": 212}
290 # If there is no offset, the signup just hasn't started yet
291 elif self.offset == 0:
292 return {"status": False, "message": _("Påmeldingen er ikke åpnet enda."), "status_code": 402}
293 # In the last case there is a delayed signup
294 else:
295 return {"status": False, "message": _("%s har utsatt påmelding.") % self.group,
296 "offset": offset_datetime, "status_code": 422}
297 return {
298 "status": False, "message":
299 _("Du er ikke i en brukergruppe som har tilgang til dette arrangmentet."), "status_code": 412}
300
301 def __str__(self):
302 if self.offset > 0:
303 time_unit = _('timer') if self.offset > 1 else _('time')
304 return _("%s etter %d %s") % (str(self.group), self.offset, time_unit)
305 return str(self.group)
306
307 class Meta:
308 permissions = (
309 ('view_usergrouprule', 'View UserGroupRule'),
310 )
311
312
313 class RuleBundle(models.Model):
314 """
315 Access restriction rule object
316 """
317 description = models.CharField(_('beskrivelse'), max_length=100, blank=True, null=True)
318 field_of_study_rules = models.ManyToManyField(FieldOfStudyRule, blank=True)
319 grade_rules = models.ManyToManyField(GradeRule, blank=True)
320 user_group_rules = models.ManyToManyField(UserGroupRule, blank=True)
321
322 def get_all_rules(self):
323 rules = []
324 rules.extend(self.field_of_study_rules.all())
325 rules.extend(self.grade_rules.all())
326 rules.extend(self.user_group_rules.all())
327 return rules
328
329 def get_rule_strings(self):
330 return [str(rule) for rule in self.get_all_rules()]
331
332 def satisfied(self, user, registration_start):
333
334 errors = []
335
336 for rule in self.get_all_rules():
337 response = rule.satisfied(user, registration_start)
338 if response['status']:
339 return [response]
340 else:
341 errors.append(response)
342
343 return errors
344
345 def __str__(self):
346 if self.description:
347 return self.description
348 elif self.get_rule_strings():
349 return ", ".join(self.get_rule_strings())
350 else:
351 return _("Tom rule bundle.")
352
353 class Meta:
354 permissions = (
355 ('view_rulebundle', 'View RuleBundle'),
356 )
357
358
359 """
360 END ACCESS RESTRICTION --------------------------------------------------------------------------
361 """
362
363
364 class Extras(models.Model):
365 """
366 Choices for events
367 """
368
369 choice = models.CharField('valg', max_length=69)
370 note = models.CharField('notat', max_length=200, blank=True, null=True)
371
372 def __str__(self):
373 return self.choice
374
375 class Meta:
376 verbose_name = _("ekstra valg")
377 verbose_name_plural = _("ekstra valg")
378 ordering = ['choice']
379
380
381 class AttendanceEvent(models.Model):
382 """
383 Events that require special considerations regarding attendance.
384 """
385 event = models.OneToOneField(
386 Event,
387 primary_key=True,
388 related_name='attendance_event')
389
390 max_capacity = models.PositiveIntegerField(_('maks-kapasitet'), null=False, blank=False)
391 waitlist = models.BooleanField(_('venteliste'), default=False)
392 guest_attendance = models.BooleanField(_('gjestepåmelding'), null=False, blank=False, default=False)
393 registration_start = models.DateTimeField(_('registrerings-start'), null=False, blank=False)
394 unattend_deadline = models.DateTimeField(_('avmeldings-frist'), null=False, blank=False)
395 registration_end = models.DateTimeField(_('registrerings-slutt'), null=False, blank=False)
396
397 # Automatic mark setting for not attending
398 automatically_set_marks = models.BooleanField(_('automatisk prikk'), default=False,
399 help_text=_('Påmeldte som ikke har møtt vil automatisk få prikk'))
400 marks_has_been_set = models.BooleanField(default=False)
401
402 # Access rules
403 rule_bundles = models.ManyToManyField(RuleBundle, blank=True)
404
405 # Extra choices
406 extras = models.ManyToManyField(Extras, blank=True)
407
408 @property
409 def has_reservation(self):
410 """ Returns whether this event has an attached reservation """
411 try:
412 return True if self.reserved_seats else False
413 except Reservation.DoesNotExist:
414 return False
415
416 @property
417 def has_extras(self):
418 return bool(self.extras.exists())
419
420 @property
421 def attendees_qs(self):
422 """ Queryset with all attendees not on waiting list """
423 return self.attendees.all()[:self.max_capacity - self.number_of_reserved_seats]
424
425 def not_attended(self):
426 """ Queryset with all attendees not attended """
427 # .filter does apperantly not work on sliced querysets
428 # return self.attendees_qs.filter(attended=False)
429
430 not_attended = []
431
432 for attendee in self.attendees_qs:
433 if not attendee.attended:
434 not_attended.append(attendee.user)
435
436 return not_attended
437
438 @property
439 def waitlist_qs(self):
440 """ Queryset with all attendees in waiting list """
441 return self.attendees.all()[self.max_capacity - self.number_of_reserved_seats:]
442
443 @property
444 def reservees_qs(self):
445 """ Queryset with all reserved seats which have been filled """
446 if self.has_reservation:
447 return self.reserved_seats.reservees.all()
448 return []
449
450 @property
451 def attendees_not_paid(self):
452 return [a for a in self.attendees_qs if a.paid]
453
454 @property
455 def number_of_attendees(self):
456 """ Count of all attendees not in waiting list """
457 # We need to use len() instead of .count() here, because of the prefetched event archive
458 return len(self.attendees_qs)
459
460 @property
461 def number_on_waitlist(self):
462 """ Count of all attendees on waiting list """
463 # We need to use len() instead of .count() here, because of the prefetched event archive
464 return len(self.waitlist_qs)
465
466 @property
467 def number_of_reserved_seats(self):
468 """
469 Total number of seats for this event that are reserved
470 """
471 return self.reserved_seats.seats if self.has_reservation else 0
472
473 @property
474 def number_of_reserved_seats_taken(self):
475 """
476 Returns number of reserved seats which have been filled
477 """
478 return self.reserved_seats.number_of_seats_taken if self.has_reservation else 0
479
480 @property
481 def number_of_seats_taken(self):
482 """
483 Returns the total amount of taken seats for an attendance_event.
484 """
485 # This includes all attendees + reserved seats for the event, if any.
486 # Always use the total number of reserved seats here, because they are not
487 # available for regular users to claim.
488 return self.number_of_attendees + self.number_of_reserved_seats
489
490 @property
491 def free_seats(self):
492 """
493 Integer representing the number of free seats for an event
494 """
495 return 0 if self.number_of_seats_taken == self.max_capacity else self.max_capacity - self.number_of_seats_taken
496
497 @property
498 def room_on_event(self):
499 """
500 Returns True if there are free seats or an open waiting list
501 """
502 return True if self.free_seats > 0 or self.waitlist else False
503
504 @property
505 def registration_open(self):
506 return timezone.now() < self.registration_start
507
508 def has_delayed_signup(self, user):
509 pass
510
511 def is_marked(self, user):
512 expiry_date = get_expiration_date(user)
513 return expiry_date and expiry_date > timezone.now().date()
514
515 def has_postponed_registration(self, user):
516 if not self.is_marked(user):
517 return False
518 expiry_date = get_expiration_date(user)
519 mark_offset = timedelta(days=1)
520 postponed_registration_start = self.registration_start + mark_offset
521
522 before_expiry = self.registration_start.date() < expiry_date
523
524 if postponed_registration_start > timezone.now() and before_expiry:
525 return postponed_registration_start
526
527 def is_suspended(self, user):
528 for suspension in user.get_active_suspensions():
529 if not suspension.expiration_date or suspension.expiration_date > timezone.now().date():
530 return True
531
532 return False
533
534 @property
535 def will_i_be_on_wait_list(self):
536 return True if self.free_seats == 0 and self.waitlist else False
537
538 @property
539 def waitlist_enabled(self):
540 return self.waitlist
541
542 def payment(self):
543 # Importing here to awoid circular dependency error
544 from apps.payment.models import Payment
545 try:
546 payment = Payment.objects.get(content_type=ContentType.objects.get_for_model(AttendanceEvent),
547 object_id=self.event.id)
548 except Payment.DoesNotExist:
549 payment = None
550
551 return payment
552
553 def notify_waiting_list(self, host, unattended_user=None, extra_capacity=1):
554 from apps.events.utils import handle_waitlist_bump # Imported here to avoid circular import
555 # Notify next user on waiting list
556 wait_list = self.waitlist_qs
557 if wait_list:
558 # Checking if user is on the wait list
559 on_wait_list = False
560 if unattended_user:
561 for waiting_user in wait_list:
562 if waiting_user.user == unattended_user:
563 on_wait_list = True
564 break
565 if not on_wait_list:
566 # Send mail to first user on waiting list
567 attendees = wait_list[:extra_capacity]
568
569 handle_waitlist_bump(self.event, host, attendees, self.payment())
570
571 def is_eligible_for_signup(self, user):
572 """
573 Checks if a user can attend a specific event
574 This method checks for:
575 Waitlist
576 Room on event
577 Rules
578 Marks
579 Suspension
580 @param User object
581 The returned dict contains a key called 'status_code'. These codes follow the HTTP
582 standard in terms of overlying scheme.
583 2XX = successful
584 4XX = client error (user related)
585 5XX = server error (event related)
586 These codes are meant as a debugging tool only. The eligibility checking is quite
587 extensive, and tracking where it's going wrong is much needed.
588 TODO:
589 Exception handling
590 """
591
592 response = {'status': False, 'message': '', 'status_code': None}
593
594 # Registration closed
595 if timezone.now() > self.registration_end:
596 response['message'] = _('Påmeldingen er ikke lenger åpen.')
597 response['status_code'] = 502
598 return response
599
600 # Room for me on the event?
601 if not self.room_on_event:
602 response['message'] = _("Det er ikke mer plass på dette arrangementet.")
603 response['status_code'] = 503
604 return response
605
606 #
607 # Offset calculations.
608 #
609
610 # Are there any rules preventing me from attending?
611 # This should be checked last of the offsets, because it can completely deny you access.
612 response = self.rules_satisfied(user)
613 if not response['status']:
614 if 'offset' not in response:
615 return response
616
617 # Do I have any marks that postpone my registration date?
618 response = self._check_marks(response, user)
619
620 # Return response if offset was set.
621 if 'offset' in response and response['offset'] > timezone.now():
622 return response
623
624 #
625 # Offset calculations end
626 #
627
628 # Registration not open
629 if timezone.now() < self.registration_start:
630 response['status'] = False
631 response['message'] = _('Påmeldingen har ikke åpnet enda.')
632 response['status_code'] = 501
633 return response
634
635 # Is suspended
636 if self.is_suspended(user):
637 response['status'] = False
638 response['message'] = _("Du er suspandert og kan ikke melde deg på.")
639 response['status_code'] = 402
640
641 return response
642
643 # Checks if the event is group restricted and if the user is in the right group
644 if not self.event.can_display(user):
645 response['status'] = False
646 response['message'] = _("Du har ikke tilgang til å melde deg på dette arrangementet.")
647 response['status_code'] = 403
648
649 return response
650
651 # No objections, set eligible.
652 response['status'] = True
653 return response
654
655 def _check_marks(self, response, user):
656 expiry_date = get_expiration_date(user)
657 if expiry_date and expiry_date > timezone.now().date():
658 # Offset is currently 1 day if you have marks, regardless of amount.
659 mark_offset = timedelta(days=1)
660 postponed_registration_start = self.registration_start + mark_offset
661
662 before_expiry = self.registration_start.date() < expiry_date
663
664 if postponed_registration_start > timezone.now() and before_expiry:
665 if 'offset' in response and response['offset'] < postponed_registration_start \
666 or 'offset' not in response:
667 response['status'] = False
668 response['status_code'] = 401
669 response['message'] = _("Din påmelding er utsatt grunnet prikker.")
670 response['offset'] = postponed_registration_start
671 return response
672
673 def _process_rulebundle_satisfaction_responses(self, responses):
674 # Put the smallest offset faaar into the future.
675 smallest_offset = timezone.now() + timedelta(days=365)
676 offset_response = {}
677 future_response = {}
678 errors = []
679
680 for response in responses:
681 if response['status']:
682 return response
683 elif 'offset' in response:
684 if response['offset'] < smallest_offset:
685 smallest_offset = response['offset']
686 offset_response = response
687 elif response['status_code'] == 402:
688 future_response = response
689 else:
690 errors.append(response)
691
692 if future_response:
693 return future_response
694 if smallest_offset > timezone.now() and offset_response:
695 return offset_response
696 if errors:
697 return errors[0]
698
699 def rules_satisfied(self, user):
700 """
701 Checks a user against rules applied to an attendance event
702 """
703 # If the event has guest attendance, allow absolutely anyone
704 if self.guest_attendance:
705 return {'status': True, 'status_code': 201}
706
707 # If the user is not a member, return False right away
708 # TODO check for guest list
709 if not user.is_member:
710 return {
711 'status': False, 'message':
712 _("Dette arrangementet er kun åpent for medlemmer."), 'status_code': 400}
713
714 # If there are no rule_bundles on this object, all members of Online are allowed.
715 if not self.rule_bundles.exists() and user.is_member:
716 return {'status': True, 'status_code': 200}
717
718 # Check all rule bundles
719 responses = []
720
721 # If one satisfies, return true, else append to the error list
722 for rule_bundle in self.rule_bundles.all():
723 responses.extend(rule_bundle.satisfied(user, self.registration_start))
724
725 return self._process_rulebundle_satisfaction_responses(responses)
726
727 def is_attendee(self, user):
728 return self.attendees.filter(user=user)
729
730 def is_on_waitlist(self, user):
731 return reduce(lambda x, y: x or y.user == user, self.waitlist_qs, False)
732
733 def what_place_is_user_on_wait_list(self, user):
734 if self.waitlist:
735 waitlist = self.waitlist_qs
736 if waitlist:
737 for attendee_object in waitlist:
738 if attendee_object.user == user:
739 return list(waitlist).index(attendee_object) + 1
740 return 0
741
742 def __str__(self):
743 return self.event.title
744
745 class Meta:
746 verbose_name = _('påmelding')
747 verbose_name_plural = _('påmeldinger')
748 permissions = (
749 ('view_attendanceevent', 'View AttendanceEvent'),
750 )
751
752
753 class CompanyEvent(models.Model):
754 """
755 Company relation to AttendanceEvent
756 """
757 company = models.ForeignKey(Company, verbose_name=_('bedrifter'))
758 event = models.ForeignKey(Event, verbose_name=_('arrangement'), related_name='companies')
759
760 class Meta:
761 verbose_name = _('bedrift')
762 verbose_name_plural = _('bedrifter')
763 permissions = (
764 ('view_companyevent', 'View CompanyEvent'),
765 )
766
767
768 class Attendee(models.Model):
769 """
770 User relation to AttendanceEvent.
771 """
772 event = models.ForeignKey(AttendanceEvent, related_name="attendees")
773 user = models.ForeignKey(User)
774
775 timestamp = models.DateTimeField(auto_now_add=True, editable=False)
776 attended = models.BooleanField(_('var tilstede'), default=False)
777 paid = models.BooleanField(_('har betalt'), default=False)
778 note = models.CharField(_('notat'), max_length=100, blank=True, default='')
779 extras = models.ForeignKey(Extras, blank=True, null=True)
780
781 def __str__(self):
782 return self.user.get_full_name()
783
784 def delete(self):
785 # Importing here to prevent circular dependencies
786 from apps.payment.models import PaymentDelay
787 try:
788 PaymentDelay.objects.filter(user=self.user, payment=self.event.payment()).delete()
789 except PaymentDelay.DoesNotExist:
790 # Do nothing
791 False
792
793 super(Attendee, self).delete()
794
795 class Meta:
796 ordering = ['timestamp']
797 unique_together = (('event', 'user'),)
798 permissions = (
799 ('view_attendee', 'View Attendee'),
800 )
801
802
803 class Reservation(models.Model):
804 attendance_event = models.OneToOneField(AttendanceEvent, related_name="reserved_seats")
805 seats = models.PositiveIntegerField("reserverte plasser", blank=False, null=False)
806
807 @property
808 def number_of_seats_taken(self):
809 return self.reservees.count()
810
811 def __str__(self):
812 return "Reservasjoner for %s" % self.attendance_event.event.title
813
814 class Meta:
815 verbose_name = _("reservasjon")
816 verbose_name_plural = _("reservasjoner")
817 permissions = (
818 ('view_reservation', 'View Reservation'),
819 )
820
821
822 class Reservee(models.Model):
823 """
824 Reservation entry
825 """
826 reservation = models.ForeignKey(Reservation, related_name='reservees')
827 # I 2014 var norges lengste navn på 69 tegn;
828 # julius andreas gimli arn macgyver chewbacka highlander elessar-jankov
829 name = models.CharField('navn', max_length=69)
830 note = models.CharField('notat', max_length=100)
831 allergies = models.CharField('allergier', max_length=200, blank=True, null=True)
832
833 def __str__(self):
834 return self.name
835
836 class Meta:
837 verbose_name = _("reservasjon")
838 verbose_name_plural = _("reservasjoner")
839 ordering = ['id']
840 permissions = (
841 ('view_reservee', 'View Reservee'),
842 )
843
844
845 class GroupRestriction(models.Model):
846 event = models.OneToOneField(
847 Event,
848 primary_key=True,
849 related_name='group_restriction')
850
851 groups = models.ManyToManyField(Group, blank=True,
852 help_text=_('Legg til de gruppene som skal ha tilgang til arrangementet'))
853
854 class Meta:
855 verbose_name = _("restriksjon")
856 verbose_name_plural = _("restriksjoner")
857 permissions = (
858 ('view_restriction', 'View Restriction'),
859 )
860
```
--- 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/apps/events/models.py b/apps/events/models.py
--- a/apps/events/models.py
+++ b/apps/events/models.py
@@ -449,7 +449,7 @@
@property
def attendees_not_paid(self):
- return [a for a in self.attendees_qs if a.paid]
+ return list(self.attendees.filter(paid=False))
@property
def number_of_attendees(self):
| {"golden_diff": "diff --git a/apps/events/models.py b/apps/events/models.py\n--- a/apps/events/models.py\n+++ b/apps/events/models.py\n@@ -449,7 +449,7 @@\n \n @property\n def attendees_not_paid(self):\n- return [a for a in self.attendees_qs if a.paid]\n+ return list(self.attendees.filter(paid=False))\n \n @property\n def number_of_attendees(self):\n", "issue": "attendees_not_paid property is plain wrong\nIt returns all attendees who have paid instead. It is only used for sending out emails afaik.\n\nhttps://github.com/dotKom/onlineweb4/blob/2347446f5bb66d202b7adecc9433a8e26fe3b0b4/apps/events/models.py#L450\n\nIMO it should be something like `return list(self.attendees.filter(paid=False))` instead of simply adding a `not`,\n\n", "before_files": [{"content": "# -*- coding: utf-8 -*-\n\nfrom collections import OrderedDict\nfrom datetime import datetime, timedelta\nfrom functools import reduce\n\nfrom django.conf import settings\nfrom django.contrib.auth.models import Group\nfrom django.contrib.contenttypes.models import ContentType\nfrom django.core import validators\nfrom django.db import models\nfrom django.db.models import Case, Q, Value, When\nfrom django.template.defaultfilters import slugify\nfrom django.utils import timezone\nfrom django.utils.translation import ugettext as _\nfrom filebrowser.fields import FileBrowseField\nfrom unidecode import unidecode\n\nfrom apps.authentication.models import FIELD_OF_STUDY_CHOICES\nfrom apps.companyprofile.models import Company\nfrom apps.marks.models import get_expiration_date\n\nUser = settings.AUTH_USER_MODEL\n\nTYPE_CHOICES = (\n (1, 'Sosialt'),\n (2, 'Bedriftspresentasjon'),\n (3, 'Kurs'),\n (4, 'Utflukt'),\n (5, 'Ekskursjon'),\n (6, 'Internt'),\n (7, 'Annet')\n)\n\n\n# Managers\n\nclass EventOrderedByRegistration(models.Manager):\n \"\"\"\n Order events by registration start if registration start is within 7 days of today.\n \"\"\"\n def get_queryset(self):\n now = timezone.now()\n DELTA_FUTURE_SETTING = settings.OW4_SETTINGS.get('events').get('FEATURED_DAYS_FUTURE')\n DELTA_PAST_SETTING = settings.OW4_SETTINGS.get('events').get('FEATURED_DAYS_PAST')\n DAYS_BACK_DELTA = timezone.now() - timedelta(days=DELTA_PAST_SETTING)\n DAYS_FORWARD_DELTA = timezone.now() + timedelta(days=DELTA_FUTURE_SETTING)\n\n return super(EventOrderedByRegistration, self).get_queryset().\\\n annotate(registration_filtered=Case(\n When(Q(event_end__gte=now) &\n Q(attendance_event__registration_start__gte=DAYS_BACK_DELTA) &\n Q(attendance_event__registration_start__lte=DAYS_FORWARD_DELTA),\n then='attendance_event__registration_start'),\n default='event_end',\n output_field=models.DateTimeField()\n )\n ).annotate(is_today=Case(\n When(event_end__date=now.date(),\n then=Value(1)),\n default=Value(0),\n output_field=models.IntegerField()\n )\n ).order_by('-is_today', 'registration_filtered')\n\n\nclass Event(models.Model):\n \"\"\"\n Base class for Event-objects.\n \"\"\"\n\n IMAGE_FOLDER = \"images/events\"\n IMAGE_EXTENSIONS = ['.jpg', '.jpeg', '.gif', '.png', '.tif', '.tiff']\n\n # Managers\n objects = models.Manager()\n by_registration = EventOrderedByRegistration()\n\n author = models.ForeignKey(User, related_name='oppretter')\n title = models.CharField(_('tittel'), max_length=60)\n event_start = models.DateTimeField(_('start-dato'))\n event_end = models.DateTimeField(_('slutt-dato'))\n location = models.CharField(_('lokasjon'), max_length=100)\n ingress_short = models.CharField(_(\"kort ingress\"), max_length=150,\n validators=[validators.MinLengthValidator(25)])\n ingress = models.TextField(_('ingress'), validators=[validators.MinLengthValidator(25)])\n description = models.TextField(_('beskrivelse'), validators=[validators.MinLengthValidator(45)])\n image = FileBrowseField(_(\"bilde\"), max_length=200,\n directory=IMAGE_FOLDER, extensions=IMAGE_EXTENSIONS, null=True, blank=True)\n event_type = models.SmallIntegerField(_('type'), choices=TYPE_CHOICES, null=False)\n\n def is_attendance_event(self):\n \"\"\" Returns true if the event is an attendance event \"\"\"\n try:\n return True if self.attendance_event else False\n except AttendanceEvent.DoesNotExist:\n return False\n\n def images(self):\n if not self.image:\n return []\n from apps.events.utils import find_image_versions\n return find_image_versions(self)\n\n # TODO move payment and feedback stuff to attendance event when dasboard is done\n\n def feedback_users(self):\n if self.is_attendance_event:\n return [a.user for a in self.attendance_event.attendees.filter(attended=True)]\n return []\n\n def feedback_date(self):\n return self.event_end\n\n def feedback_title(self):\n return self.title\n\n def feedback_info(self):\n info = OrderedDict()\n if self.is_attendance_event():\n info[_('P\u00e5meldte')] = self.attendance_event.number_of_attendees\n info[_('Oppm\u00f8tte')] = self.attendance_event.number_of_attendees - len(self.attendance_event.not_attended())\n info[_('Venteliste')] = self.attendance_event.number_on_waitlist\n\n return info\n\n @property\n def company_event(self):\n try:\n return CompanyEvent.objects.filter(event=self)\n except CompanyEvent.DoesNotExist:\n return None\n\n def feedback_mail(self):\n if self.event_type == 1 or self.event_type == 4: # Sosialt & Utflukt\n return settings.EMAIL_ARRKOM\n elif self.event_type == 2: # Bedpres\n return settings.EMAIL_BEDKOM\n elif self.event_type == 3: # Kurs\n return settings.EMAIL_FAGKOM\n elif self.event_type == 5: # Ekskursjon\n return settings.EMAIL_EKSKOM\n else:\n return settings.DEFAULT_FROM_EMAIL\n\n def can_display(self, user):\n restriction = GroupRestriction.objects.filter(event=self)\n\n if not restriction:\n return True\n\n if not user:\n return False\n\n groups = restriction[0].groups\n\n # returns True if any of the users groups are in one of the accepted groups\n return any(group in user.groups.all() for group in groups.all())\n\n @property\n def slug(self):\n return slugify(unidecode(self.title))\n\n @models.permalink\n def get_absolute_url(self):\n return 'events_details', None, {'event_id': self.id, 'event_slug': self.slug}\n\n def __str__(self):\n return self.title\n\n class Meta:\n verbose_name = _('arrangement')\n verbose_name_plural = _('arrangement')\n permissions = (\n ('view_event', 'View Event'),\n )\n\n\n\"\"\"\n BEGIN ACCESS RESTRICTION --------------------------------------------------------------------------\n\"\"\"\n\n\nclass Rule(models.Model):\n \"\"\"\n Super class for a rule object\n \"\"\"\n offset = models.PositiveSmallIntegerField(_('utsettelse'), help_text=_('utsettelse oppgis i timer'), default=0)\n\n def get_offset_time(self, time):\n if type(time) is not datetime:\n raise TypeError('time must be a datetime, not %s' % type(time))\n else:\n return time + timedelta(hours=self.offset)\n\n def satisfied(self, user):\n \"\"\" Checks if a user satisfies the rules \"\"\"\n return True\n\n def __str__(self):\n return 'Rule'\n\n class Meta:\n permissions = (\n ('view_rule', 'View Rule'),\n )\n\n\nclass FieldOfStudyRule(Rule):\n field_of_study = models.SmallIntegerField(_('studieretning'), choices=FIELD_OF_STUDY_CHOICES)\n\n def satisfied(self, user, registration_start):\n \"\"\" Override method \"\"\"\n\n # If the user has the same FOS as this rule\n if self.field_of_study == user.field_of_study:\n offset_datetime = self.get_offset_time(registration_start)\n # If the offset is in the past, it means you can attend even with the offset\n if offset_datetime < timezone.now():\n return {\"status\": True, \"message\": None, \"status_code\": 210}\n # If there is no offset, the signup just hasn't started yet\n elif self.offset == 0:\n return {\"status\": False, \"message\": _(\"P\u00e5meldingen er ikke \u00e5pnet enda.\"), \"status_code\": 402}\n # In the last case there is a delayed signup\n else:\n return {\"status\": False, \"message\": _(\"Din studieretning har utsatt p\u00e5melding.\"),\n \"offset\": offset_datetime, \"status_code\": 420}\n return {\n \"status\": False, \"message\":\n _(\"Din studieretning er en annen enn de som har tilgang til dette arrangementet.\"), \"status_code\": 410}\n\n def __str__(self):\n if self.offset > 0:\n time_unit = _('timer') if self.offset > 1 else _('time')\n return _(\"%s etter %d %s\") % (str(self.get_field_of_study_display()), self.offset, time_unit)\n return str(self.get_field_of_study_display())\n\n class Meta:\n permissions = (\n ('view_fieldofstudyrule', 'View FieldOfStudyRule'),\n )\n\n\nclass GradeRule(Rule):\n grade = models.SmallIntegerField(_('klassetrinn'), null=False)\n\n def satisfied(self, user, registration_start):\n \"\"\" Override method \"\"\"\n\n # If the user has the same FOS as this rule\n if self.grade == user.year:\n offset_datetime = self.get_offset_time(registration_start)\n # If the offset is in the past, it means you can attend even with the offset\n if offset_datetime < timezone.now():\n return {\"status\": True, \"message\": None, \"status_code\": 211}\n # If there is no offset, the signup just hasn't started yet\n elif self.offset == 0:\n return {\"status\": False, \"message\": _(\"P\u00e5meldingen er ikke \u00e5pnet enda.\"), \"status_code\": 402}\n # In the last case there is a delayed signup\n else:\n return {\n \"status\": False, \"message\":\n _(\"Ditt klassetrinn har utsatt p\u00e5melding.\"), \"offset\": offset_datetime, \"status_code\": 421}\n return {\n \"status\": False, \"message\":\n _(\"Du er ikke i et klassetrinn som har tilgang til dette arrangementet.\"), \"status_code\": 411}\n\n def __str__(self):\n if self.offset > 0:\n time_unit = _('timer') if self.offset > 1 else _('time')\n return _(\"%s. klasse etter %d %s\") % (self.grade, self.offset, time_unit)\n return _(\"%s. klasse\") % self.grade\n\n class Meta:\n permissions = (\n ('view_graderule', 'View GradeRule'),\n )\n\n\nclass UserGroupRule(Rule):\n group = models.ForeignKey(Group, blank=False, null=False)\n\n def satisfied(self, user, registration_start):\n \"\"\" Override method \"\"\"\n if self.group in user.groups.all():\n offset_datetime = self.get_offset_time(registration_start)\n # If the offset is in the past, it means you can attend even with the offset\n if offset_datetime < timezone.now():\n return {\"status\": True, \"message\": None, \"status_code\": 212}\n # If there is no offset, the signup just hasn't started yet\n elif self.offset == 0:\n return {\"status\": False, \"message\": _(\"P\u00e5meldingen er ikke \u00e5pnet enda.\"), \"status_code\": 402}\n # In the last case there is a delayed signup\n else:\n return {\"status\": False, \"message\": _(\"%s har utsatt p\u00e5melding.\") % self.group,\n \"offset\": offset_datetime, \"status_code\": 422}\n return {\n \"status\": False, \"message\":\n _(\"Du er ikke i en brukergruppe som har tilgang til dette arrangmentet.\"), \"status_code\": 412}\n\n def __str__(self):\n if self.offset > 0:\n time_unit = _('timer') if self.offset > 1 else _('time')\n return _(\"%s etter %d %s\") % (str(self.group), self.offset, time_unit)\n return str(self.group)\n\n class Meta:\n permissions = (\n ('view_usergrouprule', 'View UserGroupRule'),\n )\n\n\nclass RuleBundle(models.Model):\n \"\"\"\n Access restriction rule object\n \"\"\"\n description = models.CharField(_('beskrivelse'), max_length=100, blank=True, null=True)\n field_of_study_rules = models.ManyToManyField(FieldOfStudyRule, blank=True)\n grade_rules = models.ManyToManyField(GradeRule, blank=True)\n user_group_rules = models.ManyToManyField(UserGroupRule, blank=True)\n\n def get_all_rules(self):\n rules = []\n rules.extend(self.field_of_study_rules.all())\n rules.extend(self.grade_rules.all())\n rules.extend(self.user_group_rules.all())\n return rules\n\n def get_rule_strings(self):\n return [str(rule) for rule in self.get_all_rules()]\n\n def satisfied(self, user, registration_start):\n\n errors = []\n\n for rule in self.get_all_rules():\n response = rule.satisfied(user, registration_start)\n if response['status']:\n return [response]\n else:\n errors.append(response)\n\n return errors\n\n def __str__(self):\n if self.description:\n return self.description\n elif self.get_rule_strings():\n return \", \".join(self.get_rule_strings())\n else:\n return _(\"Tom rule bundle.\")\n\n class Meta:\n permissions = (\n ('view_rulebundle', 'View RuleBundle'),\n )\n\n\n\"\"\"\n END ACCESS RESTRICTION --------------------------------------------------------------------------\n\"\"\"\n\n\nclass Extras(models.Model):\n \"\"\"\n Choices for events\n \"\"\"\n\n choice = models.CharField('valg', max_length=69)\n note = models.CharField('notat', max_length=200, blank=True, null=True)\n\n def __str__(self):\n return self.choice\n\n class Meta:\n verbose_name = _(\"ekstra valg\")\n verbose_name_plural = _(\"ekstra valg\")\n ordering = ['choice']\n\n\nclass AttendanceEvent(models.Model):\n \"\"\"\n Events that require special considerations regarding attendance.\n \"\"\"\n event = models.OneToOneField(\n Event,\n primary_key=True,\n related_name='attendance_event')\n\n max_capacity = models.PositiveIntegerField(_('maks-kapasitet'), null=False, blank=False)\n waitlist = models.BooleanField(_('venteliste'), default=False)\n guest_attendance = models.BooleanField(_('gjestep\u00e5melding'), null=False, blank=False, default=False)\n registration_start = models.DateTimeField(_('registrerings-start'), null=False, blank=False)\n unattend_deadline = models.DateTimeField(_('avmeldings-frist'), null=False, blank=False)\n registration_end = models.DateTimeField(_('registrerings-slutt'), null=False, blank=False)\n\n # Automatic mark setting for not attending\n automatically_set_marks = models.BooleanField(_('automatisk prikk'), default=False,\n help_text=_('P\u00e5meldte som ikke har m\u00f8tt vil automatisk f\u00e5 prikk'))\n marks_has_been_set = models.BooleanField(default=False)\n\n # Access rules\n rule_bundles = models.ManyToManyField(RuleBundle, blank=True)\n\n # Extra choices\n extras = models.ManyToManyField(Extras, blank=True)\n\n @property\n def has_reservation(self):\n \"\"\" Returns whether this event has an attached reservation \"\"\"\n try:\n return True if self.reserved_seats else False\n except Reservation.DoesNotExist:\n return False\n\n @property\n def has_extras(self):\n return bool(self.extras.exists())\n\n @property\n def attendees_qs(self):\n \"\"\" Queryset with all attendees not on waiting list \"\"\"\n return self.attendees.all()[:self.max_capacity - self.number_of_reserved_seats]\n\n def not_attended(self):\n \"\"\" Queryset with all attendees not attended \"\"\"\n # .filter does apperantly not work on sliced querysets\n # return self.attendees_qs.filter(attended=False)\n\n not_attended = []\n\n for attendee in self.attendees_qs:\n if not attendee.attended:\n not_attended.append(attendee.user)\n\n return not_attended\n\n @property\n def waitlist_qs(self):\n \"\"\" Queryset with all attendees in waiting list \"\"\"\n return self.attendees.all()[self.max_capacity - self.number_of_reserved_seats:]\n\n @property\n def reservees_qs(self):\n \"\"\" Queryset with all reserved seats which have been filled \"\"\"\n if self.has_reservation:\n return self.reserved_seats.reservees.all()\n return []\n\n @property\n def attendees_not_paid(self):\n return [a for a in self.attendees_qs if a.paid]\n\n @property\n def number_of_attendees(self):\n \"\"\" Count of all attendees not in waiting list \"\"\"\n # We need to use len() instead of .count() here, because of the prefetched event archive\n return len(self.attendees_qs)\n\n @property\n def number_on_waitlist(self):\n \"\"\" Count of all attendees on waiting list \"\"\"\n # We need to use len() instead of .count() here, because of the prefetched event archive\n return len(self.waitlist_qs)\n\n @property\n def number_of_reserved_seats(self):\n \"\"\"\n Total number of seats for this event that are reserved\n \"\"\"\n return self.reserved_seats.seats if self.has_reservation else 0\n\n @property\n def number_of_reserved_seats_taken(self):\n \"\"\"\n Returns number of reserved seats which have been filled\n \"\"\"\n return self.reserved_seats.number_of_seats_taken if self.has_reservation else 0\n\n @property\n def number_of_seats_taken(self):\n \"\"\"\n Returns the total amount of taken seats for an attendance_event.\n \"\"\"\n # This includes all attendees + reserved seats for the event, if any.\n # Always use the total number of reserved seats here, because they are not\n # available for regular users to claim.\n return self.number_of_attendees + self.number_of_reserved_seats\n\n @property\n def free_seats(self):\n \"\"\"\n Integer representing the number of free seats for an event\n \"\"\"\n return 0 if self.number_of_seats_taken == self.max_capacity else self.max_capacity - self.number_of_seats_taken\n\n @property\n def room_on_event(self):\n \"\"\"\n Returns True if there are free seats or an open waiting list\n \"\"\"\n return True if self.free_seats > 0 or self.waitlist else False\n\n @property\n def registration_open(self):\n return timezone.now() < self.registration_start\n\n def has_delayed_signup(self, user):\n pass\n\n def is_marked(self, user):\n expiry_date = get_expiration_date(user)\n return expiry_date and expiry_date > timezone.now().date()\n\n def has_postponed_registration(self, user):\n if not self.is_marked(user):\n return False\n expiry_date = get_expiration_date(user)\n mark_offset = timedelta(days=1)\n postponed_registration_start = self.registration_start + mark_offset\n\n before_expiry = self.registration_start.date() < expiry_date\n\n if postponed_registration_start > timezone.now() and before_expiry:\n return postponed_registration_start\n\n def is_suspended(self, user):\n for suspension in user.get_active_suspensions():\n if not suspension.expiration_date or suspension.expiration_date > timezone.now().date():\n return True\n\n return False\n\n @property\n def will_i_be_on_wait_list(self):\n return True if self.free_seats == 0 and self.waitlist else False\n\n @property\n def waitlist_enabled(self):\n return self.waitlist\n\n def payment(self):\n # Importing here to awoid circular dependency error\n from apps.payment.models import Payment\n try:\n payment = Payment.objects.get(content_type=ContentType.objects.get_for_model(AttendanceEvent),\n object_id=self.event.id)\n except Payment.DoesNotExist:\n payment = None\n\n return payment\n\n def notify_waiting_list(self, host, unattended_user=None, extra_capacity=1):\n from apps.events.utils import handle_waitlist_bump # Imported here to avoid circular import\n # Notify next user on waiting list\n wait_list = self.waitlist_qs\n if wait_list:\n # Checking if user is on the wait list\n on_wait_list = False\n if unattended_user:\n for waiting_user in wait_list:\n if waiting_user.user == unattended_user:\n on_wait_list = True\n break\n if not on_wait_list:\n # Send mail to first user on waiting list\n attendees = wait_list[:extra_capacity]\n\n handle_waitlist_bump(self.event, host, attendees, self.payment())\n\n def is_eligible_for_signup(self, user):\n \"\"\"\n Checks if a user can attend a specific event\n This method checks for:\n Waitlist\n Room on event\n Rules\n Marks\n Suspension\n @param User object\n The returned dict contains a key called 'status_code'. These codes follow the HTTP\n standard in terms of overlying scheme.\n 2XX = successful\n 4XX = client error (user related)\n 5XX = server error (event related)\n These codes are meant as a debugging tool only. The eligibility checking is quite\n extensive, and tracking where it's going wrong is much needed.\n TODO:\n Exception handling\n \"\"\"\n\n response = {'status': False, 'message': '', 'status_code': None}\n\n # Registration closed\n if timezone.now() > self.registration_end:\n response['message'] = _('P\u00e5meldingen er ikke lenger \u00e5pen.')\n response['status_code'] = 502\n return response\n\n # Room for me on the event?\n if not self.room_on_event:\n response['message'] = _(\"Det er ikke mer plass p\u00e5 dette arrangementet.\")\n response['status_code'] = 503\n return response\n\n #\n # Offset calculations.\n #\n\n # Are there any rules preventing me from attending?\n # This should be checked last of the offsets, because it can completely deny you access.\n response = self.rules_satisfied(user)\n if not response['status']:\n if 'offset' not in response:\n return response\n\n # Do I have any marks that postpone my registration date?\n response = self._check_marks(response, user)\n\n # Return response if offset was set.\n if 'offset' in response and response['offset'] > timezone.now():\n return response\n\n #\n # Offset calculations end\n #\n\n # Registration not open\n if timezone.now() < self.registration_start:\n response['status'] = False\n response['message'] = _('P\u00e5meldingen har ikke \u00e5pnet enda.')\n response['status_code'] = 501\n return response\n\n # Is suspended\n if self.is_suspended(user):\n response['status'] = False\n response['message'] = _(\"Du er suspandert og kan ikke melde deg p\u00e5.\")\n response['status_code'] = 402\n\n return response\n\n # Checks if the event is group restricted and if the user is in the right group\n if not self.event.can_display(user):\n response['status'] = False\n response['message'] = _(\"Du har ikke tilgang til \u00e5 melde deg p\u00e5 dette arrangementet.\")\n response['status_code'] = 403\n\n return response\n\n # No objections, set eligible.\n response['status'] = True\n return response\n\n def _check_marks(self, response, user):\n expiry_date = get_expiration_date(user)\n if expiry_date and expiry_date > timezone.now().date():\n # Offset is currently 1 day if you have marks, regardless of amount.\n mark_offset = timedelta(days=1)\n postponed_registration_start = self.registration_start + mark_offset\n\n before_expiry = self.registration_start.date() < expiry_date\n\n if postponed_registration_start > timezone.now() and before_expiry:\n if 'offset' in response and response['offset'] < postponed_registration_start \\\n or 'offset' not in response:\n response['status'] = False\n response['status_code'] = 401\n response['message'] = _(\"Din p\u00e5melding er utsatt grunnet prikker.\")\n response['offset'] = postponed_registration_start\n return response\n\n def _process_rulebundle_satisfaction_responses(self, responses):\n # Put the smallest offset faaar into the future.\n smallest_offset = timezone.now() + timedelta(days=365)\n offset_response = {}\n future_response = {}\n errors = []\n\n for response in responses:\n if response['status']:\n return response\n elif 'offset' in response:\n if response['offset'] < smallest_offset:\n smallest_offset = response['offset']\n offset_response = response\n elif response['status_code'] == 402:\n future_response = response\n else:\n errors.append(response)\n\n if future_response:\n return future_response\n if smallest_offset > timezone.now() and offset_response:\n return offset_response\n if errors:\n return errors[0]\n\n def rules_satisfied(self, user):\n \"\"\"\n Checks a user against rules applied to an attendance event\n \"\"\"\n # If the event has guest attendance, allow absolutely anyone\n if self.guest_attendance:\n return {'status': True, 'status_code': 201}\n\n # If the user is not a member, return False right away\n # TODO check for guest list\n if not user.is_member:\n return {\n 'status': False, 'message':\n _(\"Dette arrangementet er kun \u00e5pent for medlemmer.\"), 'status_code': 400}\n\n # If there are no rule_bundles on this object, all members of Online are allowed.\n if not self.rule_bundles.exists() and user.is_member:\n return {'status': True, 'status_code': 200}\n\n # Check all rule bundles\n responses = []\n\n # If one satisfies, return true, else append to the error list\n for rule_bundle in self.rule_bundles.all():\n responses.extend(rule_bundle.satisfied(user, self.registration_start))\n\n return self._process_rulebundle_satisfaction_responses(responses)\n\n def is_attendee(self, user):\n return self.attendees.filter(user=user)\n\n def is_on_waitlist(self, user):\n return reduce(lambda x, y: x or y.user == user, self.waitlist_qs, False)\n\n def what_place_is_user_on_wait_list(self, user):\n if self.waitlist:\n waitlist = self.waitlist_qs\n if waitlist:\n for attendee_object in waitlist:\n if attendee_object.user == user:\n return list(waitlist).index(attendee_object) + 1\n return 0\n\n def __str__(self):\n return self.event.title\n\n class Meta:\n verbose_name = _('p\u00e5melding')\n verbose_name_plural = _('p\u00e5meldinger')\n permissions = (\n ('view_attendanceevent', 'View AttendanceEvent'),\n )\n\n\nclass CompanyEvent(models.Model):\n \"\"\"\n Company relation to AttendanceEvent\n \"\"\"\n company = models.ForeignKey(Company, verbose_name=_('bedrifter'))\n event = models.ForeignKey(Event, verbose_name=_('arrangement'), related_name='companies')\n\n class Meta:\n verbose_name = _('bedrift')\n verbose_name_plural = _('bedrifter')\n permissions = (\n ('view_companyevent', 'View CompanyEvent'),\n )\n\n\nclass Attendee(models.Model):\n \"\"\"\n User relation to AttendanceEvent.\n \"\"\"\n event = models.ForeignKey(AttendanceEvent, related_name=\"attendees\")\n user = models.ForeignKey(User)\n\n timestamp = models.DateTimeField(auto_now_add=True, editable=False)\n attended = models.BooleanField(_('var tilstede'), default=False)\n paid = models.BooleanField(_('har betalt'), default=False)\n note = models.CharField(_('notat'), max_length=100, blank=True, default='')\n extras = models.ForeignKey(Extras, blank=True, null=True)\n\n def __str__(self):\n return self.user.get_full_name()\n\n def delete(self):\n # Importing here to prevent circular dependencies\n from apps.payment.models import PaymentDelay\n try:\n PaymentDelay.objects.filter(user=self.user, payment=self.event.payment()).delete()\n except PaymentDelay.DoesNotExist:\n # Do nothing\n False\n\n super(Attendee, self).delete()\n\n class Meta:\n ordering = ['timestamp']\n unique_together = (('event', 'user'),)\n permissions = (\n ('view_attendee', 'View Attendee'),\n )\n\n\nclass Reservation(models.Model):\n attendance_event = models.OneToOneField(AttendanceEvent, related_name=\"reserved_seats\")\n seats = models.PositiveIntegerField(\"reserverte plasser\", blank=False, null=False)\n\n @property\n def number_of_seats_taken(self):\n return self.reservees.count()\n\n def __str__(self):\n return \"Reservasjoner for %s\" % self.attendance_event.event.title\n\n class Meta:\n verbose_name = _(\"reservasjon\")\n verbose_name_plural = _(\"reservasjoner\")\n permissions = (\n ('view_reservation', 'View Reservation'),\n )\n\n\nclass Reservee(models.Model):\n \"\"\"\n Reservation entry\n \"\"\"\n reservation = models.ForeignKey(Reservation, related_name='reservees')\n # I 2014 var norges lengste navn p\u00e5 69 tegn;\n # julius andreas gimli arn macgyver chewbacka highlander elessar-jankov\n name = models.CharField('navn', max_length=69)\n note = models.CharField('notat', max_length=100)\n allergies = models.CharField('allergier', max_length=200, blank=True, null=True)\n\n def __str__(self):\n return self.name\n\n class Meta:\n verbose_name = _(\"reservasjon\")\n verbose_name_plural = _(\"reservasjoner\")\n ordering = ['id']\n permissions = (\n ('view_reservee', 'View Reservee'),\n )\n\n\nclass GroupRestriction(models.Model):\n event = models.OneToOneField(\n Event,\n primary_key=True,\n related_name='group_restriction')\n\n groups = models.ManyToManyField(Group, blank=True,\n help_text=_('Legg til de gruppene som skal ha tilgang til arrangementet'))\n\n class Meta:\n verbose_name = _(\"restriksjon\")\n verbose_name_plural = _(\"restriksjoner\")\n permissions = (\n ('view_restriction', 'View Restriction'),\n )\n", "path": "apps/events/models.py"}], "after_files": [{"content": "# -*- coding: utf-8 -*-\n\nfrom collections import OrderedDict\nfrom datetime import datetime, timedelta\nfrom functools import reduce\n\nfrom django.conf import settings\nfrom django.contrib.auth.models import Group\nfrom django.contrib.contenttypes.models import ContentType\nfrom django.core import validators\nfrom django.db import models\nfrom django.db.models import Case, Q, Value, When\nfrom django.template.defaultfilters import slugify\nfrom django.utils import timezone\nfrom django.utils.translation import ugettext as _\nfrom filebrowser.fields import FileBrowseField\nfrom unidecode import unidecode\n\nfrom apps.authentication.models import FIELD_OF_STUDY_CHOICES\nfrom apps.companyprofile.models import Company\nfrom apps.marks.models import get_expiration_date\n\nUser = settings.AUTH_USER_MODEL\n\nTYPE_CHOICES = (\n (1, 'Sosialt'),\n (2, 'Bedriftspresentasjon'),\n (3, 'Kurs'),\n (4, 'Utflukt'),\n (5, 'Ekskursjon'),\n (6, 'Internt'),\n (7, 'Annet')\n)\n\n\n# Managers\n\nclass EventOrderedByRegistration(models.Manager):\n \"\"\"\n Order events by registration start if registration start is within 7 days of today.\n \"\"\"\n def get_queryset(self):\n now = timezone.now()\n DELTA_FUTURE_SETTING = settings.OW4_SETTINGS.get('events').get('FEATURED_DAYS_FUTURE')\n DELTA_PAST_SETTING = settings.OW4_SETTINGS.get('events').get('FEATURED_DAYS_PAST')\n DAYS_BACK_DELTA = timezone.now() - timedelta(days=DELTA_PAST_SETTING)\n DAYS_FORWARD_DELTA = timezone.now() + timedelta(days=DELTA_FUTURE_SETTING)\n\n return super(EventOrderedByRegistration, self).get_queryset().\\\n annotate(registration_filtered=Case(\n When(Q(event_end__gte=now) &\n Q(attendance_event__registration_start__gte=DAYS_BACK_DELTA) &\n Q(attendance_event__registration_start__lte=DAYS_FORWARD_DELTA),\n then='attendance_event__registration_start'),\n default='event_end',\n output_field=models.DateTimeField()\n )\n ).annotate(is_today=Case(\n When(event_end__date=now.date(),\n then=Value(1)),\n default=Value(0),\n output_field=models.IntegerField()\n )\n ).order_by('-is_today', 'registration_filtered')\n\n\nclass Event(models.Model):\n \"\"\"\n Base class for Event-objects.\n \"\"\"\n\n IMAGE_FOLDER = \"images/events\"\n IMAGE_EXTENSIONS = ['.jpg', '.jpeg', '.gif', '.png', '.tif', '.tiff']\n\n # Managers\n objects = models.Manager()\n by_registration = EventOrderedByRegistration()\n\n author = models.ForeignKey(User, related_name='oppretter')\n title = models.CharField(_('tittel'), max_length=60)\n event_start = models.DateTimeField(_('start-dato'))\n event_end = models.DateTimeField(_('slutt-dato'))\n location = models.CharField(_('lokasjon'), max_length=100)\n ingress_short = models.CharField(_(\"kort ingress\"), max_length=150,\n validators=[validators.MinLengthValidator(25)])\n ingress = models.TextField(_('ingress'), validators=[validators.MinLengthValidator(25)])\n description = models.TextField(_('beskrivelse'), validators=[validators.MinLengthValidator(45)])\n image = FileBrowseField(_(\"bilde\"), max_length=200,\n directory=IMAGE_FOLDER, extensions=IMAGE_EXTENSIONS, null=True, blank=True)\n event_type = models.SmallIntegerField(_('type'), choices=TYPE_CHOICES, null=False)\n\n def is_attendance_event(self):\n \"\"\" Returns true if the event is an attendance event \"\"\"\n try:\n return True if self.attendance_event else False\n except AttendanceEvent.DoesNotExist:\n return False\n\n def images(self):\n if not self.image:\n return []\n from apps.events.utils import find_image_versions\n return find_image_versions(self)\n\n # TODO move payment and feedback stuff to attendance event when dasboard is done\n\n def feedback_users(self):\n if self.is_attendance_event:\n return [a.user for a in self.attendance_event.attendees.filter(attended=True)]\n return []\n\n def feedback_date(self):\n return self.event_end\n\n def feedback_title(self):\n return self.title\n\n def feedback_info(self):\n info = OrderedDict()\n if self.is_attendance_event():\n info[_('P\u00e5meldte')] = self.attendance_event.number_of_attendees\n info[_('Oppm\u00f8tte')] = self.attendance_event.number_of_attendees - len(self.attendance_event.not_attended())\n info[_('Venteliste')] = self.attendance_event.number_on_waitlist\n\n return info\n\n @property\n def company_event(self):\n try:\n return CompanyEvent.objects.filter(event=self)\n except CompanyEvent.DoesNotExist:\n return None\n\n def feedback_mail(self):\n if self.event_type == 1 or self.event_type == 4: # Sosialt & Utflukt\n return settings.EMAIL_ARRKOM\n elif self.event_type == 2: # Bedpres\n return settings.EMAIL_BEDKOM\n elif self.event_type == 3: # Kurs\n return settings.EMAIL_FAGKOM\n elif self.event_type == 5: # Ekskursjon\n return settings.EMAIL_EKSKOM\n else:\n return settings.DEFAULT_FROM_EMAIL\n\n def can_display(self, user):\n restriction = GroupRestriction.objects.filter(event=self)\n\n if not restriction:\n return True\n\n if not user:\n return False\n\n groups = restriction[0].groups\n\n # returns True if any of the users groups are in one of the accepted groups\n return any(group in user.groups.all() for group in groups.all())\n\n @property\n def slug(self):\n return slugify(unidecode(self.title))\n\n @models.permalink\n def get_absolute_url(self):\n return 'events_details', None, {'event_id': self.id, 'event_slug': self.slug}\n\n def __str__(self):\n return self.title\n\n class Meta:\n verbose_name = _('arrangement')\n verbose_name_plural = _('arrangement')\n permissions = (\n ('view_event', 'View Event'),\n )\n\n\n\"\"\"\n BEGIN ACCESS RESTRICTION --------------------------------------------------------------------------\n\"\"\"\n\n\nclass Rule(models.Model):\n \"\"\"\n Super class for a rule object\n \"\"\"\n offset = models.PositiveSmallIntegerField(_('utsettelse'), help_text=_('utsettelse oppgis i timer'), default=0)\n\n def get_offset_time(self, time):\n if type(time) is not datetime:\n raise TypeError('time must be a datetime, not %s' % type(time))\n else:\n return time + timedelta(hours=self.offset)\n\n def satisfied(self, user):\n \"\"\" Checks if a user satisfies the rules \"\"\"\n return True\n\n def __str__(self):\n return 'Rule'\n\n class Meta:\n permissions = (\n ('view_rule', 'View Rule'),\n )\n\n\nclass FieldOfStudyRule(Rule):\n field_of_study = models.SmallIntegerField(_('studieretning'), choices=FIELD_OF_STUDY_CHOICES)\n\n def satisfied(self, user, registration_start):\n \"\"\" Override method \"\"\"\n\n # If the user has the same FOS as this rule\n if self.field_of_study == user.field_of_study:\n offset_datetime = self.get_offset_time(registration_start)\n # If the offset is in the past, it means you can attend even with the offset\n if offset_datetime < timezone.now():\n return {\"status\": True, \"message\": None, \"status_code\": 210}\n # If there is no offset, the signup just hasn't started yet\n elif self.offset == 0:\n return {\"status\": False, \"message\": _(\"P\u00e5meldingen er ikke \u00e5pnet enda.\"), \"status_code\": 402}\n # In the last case there is a delayed signup\n else:\n return {\"status\": False, \"message\": _(\"Din studieretning har utsatt p\u00e5melding.\"),\n \"offset\": offset_datetime, \"status_code\": 420}\n return {\n \"status\": False, \"message\":\n _(\"Din studieretning er en annen enn de som har tilgang til dette arrangementet.\"), \"status_code\": 410}\n\n def __str__(self):\n if self.offset > 0:\n time_unit = _('timer') if self.offset > 1 else _('time')\n return _(\"%s etter %d %s\") % (str(self.get_field_of_study_display()), self.offset, time_unit)\n return str(self.get_field_of_study_display())\n\n class Meta:\n permissions = (\n ('view_fieldofstudyrule', 'View FieldOfStudyRule'),\n )\n\n\nclass GradeRule(Rule):\n grade = models.SmallIntegerField(_('klassetrinn'), null=False)\n\n def satisfied(self, user, registration_start):\n \"\"\" Override method \"\"\"\n\n # If the user has the same FOS as this rule\n if self.grade == user.year:\n offset_datetime = self.get_offset_time(registration_start)\n # If the offset is in the past, it means you can attend even with the offset\n if offset_datetime < timezone.now():\n return {\"status\": True, \"message\": None, \"status_code\": 211}\n # If there is no offset, the signup just hasn't started yet\n elif self.offset == 0:\n return {\"status\": False, \"message\": _(\"P\u00e5meldingen er ikke \u00e5pnet enda.\"), \"status_code\": 402}\n # In the last case there is a delayed signup\n else:\n return {\n \"status\": False, \"message\":\n _(\"Ditt klassetrinn har utsatt p\u00e5melding.\"), \"offset\": offset_datetime, \"status_code\": 421}\n return {\n \"status\": False, \"message\":\n _(\"Du er ikke i et klassetrinn som har tilgang til dette arrangementet.\"), \"status_code\": 411}\n\n def __str__(self):\n if self.offset > 0:\n time_unit = _('timer') if self.offset > 1 else _('time')\n return _(\"%s. klasse etter %d %s\") % (self.grade, self.offset, time_unit)\n return _(\"%s. klasse\") % self.grade\n\n class Meta:\n permissions = (\n ('view_graderule', 'View GradeRule'),\n )\n\n\nclass UserGroupRule(Rule):\n group = models.ForeignKey(Group, blank=False, null=False)\n\n def satisfied(self, user, registration_start):\n \"\"\" Override method \"\"\"\n if self.group in user.groups.all():\n offset_datetime = self.get_offset_time(registration_start)\n # If the offset is in the past, it means you can attend even with the offset\n if offset_datetime < timezone.now():\n return {\"status\": True, \"message\": None, \"status_code\": 212}\n # If there is no offset, the signup just hasn't started yet\n elif self.offset == 0:\n return {\"status\": False, \"message\": _(\"P\u00e5meldingen er ikke \u00e5pnet enda.\"), \"status_code\": 402}\n # In the last case there is a delayed signup\n else:\n return {\"status\": False, \"message\": _(\"%s har utsatt p\u00e5melding.\") % self.group,\n \"offset\": offset_datetime, \"status_code\": 422}\n return {\n \"status\": False, \"message\":\n _(\"Du er ikke i en brukergruppe som har tilgang til dette arrangmentet.\"), \"status_code\": 412}\n\n def __str__(self):\n if self.offset > 0:\n time_unit = _('timer') if self.offset > 1 else _('time')\n return _(\"%s etter %d %s\") % (str(self.group), self.offset, time_unit)\n return str(self.group)\n\n class Meta:\n permissions = (\n ('view_usergrouprule', 'View UserGroupRule'),\n )\n\n\nclass RuleBundle(models.Model):\n \"\"\"\n Access restriction rule object\n \"\"\"\n description = models.CharField(_('beskrivelse'), max_length=100, blank=True, null=True)\n field_of_study_rules = models.ManyToManyField(FieldOfStudyRule, blank=True)\n grade_rules = models.ManyToManyField(GradeRule, blank=True)\n user_group_rules = models.ManyToManyField(UserGroupRule, blank=True)\n\n def get_all_rules(self):\n rules = []\n rules.extend(self.field_of_study_rules.all())\n rules.extend(self.grade_rules.all())\n rules.extend(self.user_group_rules.all())\n return rules\n\n def get_rule_strings(self):\n return [str(rule) for rule in self.get_all_rules()]\n\n def satisfied(self, user, registration_start):\n\n errors = []\n\n for rule in self.get_all_rules():\n response = rule.satisfied(user, registration_start)\n if response['status']:\n return [response]\n else:\n errors.append(response)\n\n return errors\n\n def __str__(self):\n if self.description:\n return self.description\n elif self.get_rule_strings():\n return \", \".join(self.get_rule_strings())\n else:\n return _(\"Tom rule bundle.\")\n\n class Meta:\n permissions = (\n ('view_rulebundle', 'View RuleBundle'),\n )\n\n\n\"\"\"\n END ACCESS RESTRICTION --------------------------------------------------------------------------\n\"\"\"\n\n\nclass Extras(models.Model):\n \"\"\"\n Choices for events\n \"\"\"\n\n choice = models.CharField('valg', max_length=69)\n note = models.CharField('notat', max_length=200, blank=True, null=True)\n\n def __str__(self):\n return self.choice\n\n class Meta:\n verbose_name = _(\"ekstra valg\")\n verbose_name_plural = _(\"ekstra valg\")\n ordering = ['choice']\n\n\nclass AttendanceEvent(models.Model):\n \"\"\"\n Events that require special considerations regarding attendance.\n \"\"\"\n event = models.OneToOneField(\n Event,\n primary_key=True,\n related_name='attendance_event')\n\n max_capacity = models.PositiveIntegerField(_('maks-kapasitet'), null=False, blank=False)\n waitlist = models.BooleanField(_('venteliste'), default=False)\n guest_attendance = models.BooleanField(_('gjestep\u00e5melding'), null=False, blank=False, default=False)\n registration_start = models.DateTimeField(_('registrerings-start'), null=False, blank=False)\n unattend_deadline = models.DateTimeField(_('avmeldings-frist'), null=False, blank=False)\n registration_end = models.DateTimeField(_('registrerings-slutt'), null=False, blank=False)\n\n # Automatic mark setting for not attending\n automatically_set_marks = models.BooleanField(_('automatisk prikk'), default=False,\n help_text=_('P\u00e5meldte som ikke har m\u00f8tt vil automatisk f\u00e5 prikk'))\n marks_has_been_set = models.BooleanField(default=False)\n\n # Access rules\n rule_bundles = models.ManyToManyField(RuleBundle, blank=True)\n\n # Extra choices\n extras = models.ManyToManyField(Extras, blank=True)\n\n @property\n def has_reservation(self):\n \"\"\" Returns whether this event has an attached reservation \"\"\"\n try:\n return True if self.reserved_seats else False\n except Reservation.DoesNotExist:\n return False\n\n @property\n def has_extras(self):\n return bool(self.extras.exists())\n\n @property\n def attendees_qs(self):\n \"\"\" Queryset with all attendees not on waiting list \"\"\"\n return self.attendees.all()[:self.max_capacity - self.number_of_reserved_seats]\n\n def not_attended(self):\n \"\"\" Queryset with all attendees not attended \"\"\"\n # .filter does apperantly not work on sliced querysets\n # return self.attendees_qs.filter(attended=False)\n\n not_attended = []\n\n for attendee in self.attendees_qs:\n if not attendee.attended:\n not_attended.append(attendee.user)\n\n return not_attended\n\n @property\n def waitlist_qs(self):\n \"\"\" Queryset with all attendees in waiting list \"\"\"\n return self.attendees.all()[self.max_capacity - self.number_of_reserved_seats:]\n\n @property\n def reservees_qs(self):\n \"\"\" Queryset with all reserved seats which have been filled \"\"\"\n if self.has_reservation:\n return self.reserved_seats.reservees.all()\n return []\n\n @property\n def attendees_not_paid(self):\n return list(self.attendees.filter(paid=False))\n\n @property\n def number_of_attendees(self):\n \"\"\" Count of all attendees not in waiting list \"\"\"\n # We need to use len() instead of .count() here, because of the prefetched event archive\n return len(self.attendees_qs)\n\n @property\n def number_on_waitlist(self):\n \"\"\" Count of all attendees on waiting list \"\"\"\n # We need to use len() instead of .count() here, because of the prefetched event archive\n return len(self.waitlist_qs)\n\n @property\n def number_of_reserved_seats(self):\n \"\"\"\n Total number of seats for this event that are reserved\n \"\"\"\n return self.reserved_seats.seats if self.has_reservation else 0\n\n @property\n def number_of_reserved_seats_taken(self):\n \"\"\"\n Returns number of reserved seats which have been filled\n \"\"\"\n return self.reserved_seats.number_of_seats_taken if self.has_reservation else 0\n\n @property\n def number_of_seats_taken(self):\n \"\"\"\n Returns the total amount of taken seats for an attendance_event.\n \"\"\"\n # This includes all attendees + reserved seats for the event, if any.\n # Always use the total number of reserved seats here, because they are not\n # available for regular users to claim.\n return self.number_of_attendees + self.number_of_reserved_seats\n\n @property\n def free_seats(self):\n \"\"\"\n Integer representing the number of free seats for an event\n \"\"\"\n return 0 if self.number_of_seats_taken == self.max_capacity else self.max_capacity - self.number_of_seats_taken\n\n @property\n def room_on_event(self):\n \"\"\"\n Returns True if there are free seats or an open waiting list\n \"\"\"\n return True if self.free_seats > 0 or self.waitlist else False\n\n @property\n def registration_open(self):\n return timezone.now() < self.registration_start\n\n def has_delayed_signup(self, user):\n pass\n\n def is_marked(self, user):\n expiry_date = get_expiration_date(user)\n return expiry_date and expiry_date > timezone.now().date()\n\n def has_postponed_registration(self, user):\n if not self.is_marked(user):\n return False\n expiry_date = get_expiration_date(user)\n mark_offset = timedelta(days=1)\n postponed_registration_start = self.registration_start + mark_offset\n\n before_expiry = self.registration_start.date() < expiry_date\n\n if postponed_registration_start > timezone.now() and before_expiry:\n return postponed_registration_start\n\n def is_suspended(self, user):\n for suspension in user.get_active_suspensions():\n if not suspension.expiration_date or suspension.expiration_date > timezone.now().date():\n return True\n\n return False\n\n @property\n def will_i_be_on_wait_list(self):\n return True if self.free_seats == 0 and self.waitlist else False\n\n @property\n def waitlist_enabled(self):\n return self.waitlist\n\n def payment(self):\n # Importing here to awoid circular dependency error\n from apps.payment.models import Payment\n try:\n payment = Payment.objects.get(content_type=ContentType.objects.get_for_model(AttendanceEvent),\n object_id=self.event.id)\n except Payment.DoesNotExist:\n payment = None\n\n return payment\n\n def notify_waiting_list(self, host, unattended_user=None, extra_capacity=1):\n from apps.events.utils import handle_waitlist_bump # Imported here to avoid circular import\n # Notify next user on waiting list\n wait_list = self.waitlist_qs\n if wait_list:\n # Checking if user is on the wait list\n on_wait_list = False\n if unattended_user:\n for waiting_user in wait_list:\n if waiting_user.user == unattended_user:\n on_wait_list = True\n break\n if not on_wait_list:\n # Send mail to first user on waiting list\n attendees = wait_list[:extra_capacity]\n\n handle_waitlist_bump(self.event, host, attendees, self.payment())\n\n def is_eligible_for_signup(self, user):\n \"\"\"\n Checks if a user can attend a specific event\n This method checks for:\n Waitlist\n Room on event\n Rules\n Marks\n Suspension\n @param User object\n The returned dict contains a key called 'status_code'. These codes follow the HTTP\n standard in terms of overlying scheme.\n 2XX = successful\n 4XX = client error (user related)\n 5XX = server error (event related)\n These codes are meant as a debugging tool only. The eligibility checking is quite\n extensive, and tracking where it's going wrong is much needed.\n TODO:\n Exception handling\n \"\"\"\n\n response = {'status': False, 'message': '', 'status_code': None}\n\n # Registration closed\n if timezone.now() > self.registration_end:\n response['message'] = _('P\u00e5meldingen er ikke lenger \u00e5pen.')\n response['status_code'] = 502\n return response\n\n # Room for me on the event?\n if not self.room_on_event:\n response['message'] = _(\"Det er ikke mer plass p\u00e5 dette arrangementet.\")\n response['status_code'] = 503\n return response\n\n #\n # Offset calculations.\n #\n\n # Are there any rules preventing me from attending?\n # This should be checked last of the offsets, because it can completely deny you access.\n response = self.rules_satisfied(user)\n if not response['status']:\n if 'offset' not in response:\n return response\n\n # Do I have any marks that postpone my registration date?\n response = self._check_marks(response, user)\n\n # Return response if offset was set.\n if 'offset' in response and response['offset'] > timezone.now():\n return response\n\n #\n # Offset calculations end\n #\n\n # Registration not open\n if timezone.now() < self.registration_start:\n response['status'] = False\n response['message'] = _('P\u00e5meldingen har ikke \u00e5pnet enda.')\n response['status_code'] = 501\n return response\n\n # Is suspended\n if self.is_suspended(user):\n response['status'] = False\n response['message'] = _(\"Du er suspandert og kan ikke melde deg p\u00e5.\")\n response['status_code'] = 402\n\n return response\n\n # Checks if the event is group restricted and if the user is in the right group\n if not self.event.can_display(user):\n response['status'] = False\n response['message'] = _(\"Du har ikke tilgang til \u00e5 melde deg p\u00e5 dette arrangementet.\")\n response['status_code'] = 403\n\n return response\n\n # No objections, set eligible.\n response['status'] = True\n return response\n\n def _check_marks(self, response, user):\n expiry_date = get_expiration_date(user)\n if expiry_date and expiry_date > timezone.now().date():\n # Offset is currently 1 day if you have marks, regardless of amount.\n mark_offset = timedelta(days=1)\n postponed_registration_start = self.registration_start + mark_offset\n\n before_expiry = self.registration_start.date() < expiry_date\n\n if postponed_registration_start > timezone.now() and before_expiry:\n if 'offset' in response and response['offset'] < postponed_registration_start \\\n or 'offset' not in response:\n response['status'] = False\n response['status_code'] = 401\n response['message'] = _(\"Din p\u00e5melding er utsatt grunnet prikker.\")\n response['offset'] = postponed_registration_start\n return response\n\n def _process_rulebundle_satisfaction_responses(self, responses):\n # Put the smallest offset faaar into the future.\n smallest_offset = timezone.now() + timedelta(days=365)\n offset_response = {}\n future_response = {}\n errors = []\n\n for response in responses:\n if response['status']:\n return response\n elif 'offset' in response:\n if response['offset'] < smallest_offset:\n smallest_offset = response['offset']\n offset_response = response\n elif response['status_code'] == 402:\n future_response = response\n else:\n errors.append(response)\n\n if future_response:\n return future_response\n if smallest_offset > timezone.now() and offset_response:\n return offset_response\n if errors:\n return errors[0]\n\n def rules_satisfied(self, user):\n \"\"\"\n Checks a user against rules applied to an attendance event\n \"\"\"\n # If the event has guest attendance, allow absolutely anyone\n if self.guest_attendance:\n return {'status': True, 'status_code': 201}\n\n # If the user is not a member, return False right away\n # TODO check for guest list\n if not user.is_member:\n return {\n 'status': False, 'message':\n _(\"Dette arrangementet er kun \u00e5pent for medlemmer.\"), 'status_code': 400}\n\n # If there are no rule_bundles on this object, all members of Online are allowed.\n if not self.rule_bundles.exists() and user.is_member:\n return {'status': True, 'status_code': 200}\n\n # Check all rule bundles\n responses = []\n\n # If one satisfies, return true, else append to the error list\n for rule_bundle in self.rule_bundles.all():\n responses.extend(rule_bundle.satisfied(user, self.registration_start))\n\n return self._process_rulebundle_satisfaction_responses(responses)\n\n def is_attendee(self, user):\n return self.attendees.filter(user=user)\n\n def is_on_waitlist(self, user):\n return reduce(lambda x, y: x or y.user == user, self.waitlist_qs, False)\n\n def what_place_is_user_on_wait_list(self, user):\n if self.waitlist:\n waitlist = self.waitlist_qs\n if waitlist:\n for attendee_object in waitlist:\n if attendee_object.user == user:\n return list(waitlist).index(attendee_object) + 1\n return 0\n\n def __str__(self):\n return self.event.title\n\n class Meta:\n verbose_name = _('p\u00e5melding')\n verbose_name_plural = _('p\u00e5meldinger')\n permissions = (\n ('view_attendanceevent', 'View AttendanceEvent'),\n )\n\n\nclass CompanyEvent(models.Model):\n \"\"\"\n Company relation to AttendanceEvent\n \"\"\"\n company = models.ForeignKey(Company, verbose_name=_('bedrifter'))\n event = models.ForeignKey(Event, verbose_name=_('arrangement'), related_name='companies')\n\n class Meta:\n verbose_name = _('bedrift')\n verbose_name_plural = _('bedrifter')\n permissions = (\n ('view_companyevent', 'View CompanyEvent'),\n )\n\n\nclass Attendee(models.Model):\n \"\"\"\n User relation to AttendanceEvent.\n \"\"\"\n event = models.ForeignKey(AttendanceEvent, related_name=\"attendees\")\n user = models.ForeignKey(User)\n\n timestamp = models.DateTimeField(auto_now_add=True, editable=False)\n attended = models.BooleanField(_('var tilstede'), default=False)\n paid = models.BooleanField(_('har betalt'), default=False)\n note = models.CharField(_('notat'), max_length=100, blank=True, default='')\n extras = models.ForeignKey(Extras, blank=True, null=True)\n\n def __str__(self):\n return self.user.get_full_name()\n\n def delete(self):\n # Importing here to prevent circular dependencies\n from apps.payment.models import PaymentDelay\n try:\n PaymentDelay.objects.filter(user=self.user, payment=self.event.payment()).delete()\n except PaymentDelay.DoesNotExist:\n # Do nothing\n False\n\n super(Attendee, self).delete()\n\n class Meta:\n ordering = ['timestamp']\n unique_together = (('event', 'user'),)\n permissions = (\n ('view_attendee', 'View Attendee'),\n )\n\n\nclass Reservation(models.Model):\n attendance_event = models.OneToOneField(AttendanceEvent, related_name=\"reserved_seats\")\n seats = models.PositiveIntegerField(\"reserverte plasser\", blank=False, null=False)\n\n @property\n def number_of_seats_taken(self):\n return self.reservees.count()\n\n def __str__(self):\n return \"Reservasjoner for %s\" % self.attendance_event.event.title\n\n class Meta:\n verbose_name = _(\"reservasjon\")\n verbose_name_plural = _(\"reservasjoner\")\n permissions = (\n ('view_reservation', 'View Reservation'),\n )\n\n\nclass Reservee(models.Model):\n \"\"\"\n Reservation entry\n \"\"\"\n reservation = models.ForeignKey(Reservation, related_name='reservees')\n # I 2014 var norges lengste navn p\u00e5 69 tegn;\n # julius andreas gimli arn macgyver chewbacka highlander elessar-jankov\n name = models.CharField('navn', max_length=69)\n note = models.CharField('notat', max_length=100)\n allergies = models.CharField('allergier', max_length=200, blank=True, null=True)\n\n def __str__(self):\n return self.name\n\n class Meta:\n verbose_name = _(\"reservasjon\")\n verbose_name_plural = _(\"reservasjoner\")\n ordering = ['id']\n permissions = (\n ('view_reservee', 'View Reservee'),\n )\n\n\nclass GroupRestriction(models.Model):\n event = models.OneToOneField(\n Event,\n primary_key=True,\n related_name='group_restriction')\n\n groups = models.ManyToManyField(Group, blank=True,\n help_text=_('Legg til de gruppene som skal ha tilgang til arrangementet'))\n\n class Meta:\n verbose_name = _(\"restriksjon\")\n verbose_name_plural = _(\"restriksjoner\")\n permissions = (\n ('view_restriction', 'View Restriction'),\n )\n", "path": "apps/events/models.py"}]} |
gh_patches_debug_246 | rasdani/github-patches | git_diff | sonic-net__sonic-utilities-1117 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[consutil] show/connect command failed due to global name 'ConfigDBConnector' is not defined
<!--
If you are reporting a new issue, make sure that we do not have any duplicates
already open. You can ensure this by searching the issue list for this
repository. If there is a duplicate, please close your issue and add a comment
to the existing issue instead.
If you suspect your issue is a bug, please edit your issue description to
include the BUG REPORT INFORMATION shown below. If you fail to provide this
information within 7 days, we cannot debug your issue and will close it. We
will, however, reopen it if you later provide the information.
For more information about reporting issues, see
https://github.com/Azure/SONiC/wiki#report-issues
---------------------------------------------------
GENERAL SUPPORT INFORMATION
---------------------------------------------------
The GitHub issue tracker is for bug reports and feature requests.
General support can be found at the following locations:
- SONiC Support Forums - https://groups.google.com/forum/#!forum/sonicproject
---------------------------------------------------
BUG REPORT INFORMATION
---------------------------------------------------
Use the commands below to provide key information from your environment:
You do NOT have to include this information if this is a FEATURE REQUEST
-->
**Description**
<!--
Briefly describe the problem you are having in a few paragraphs.
-->
An unexpected error thrown while executing `sudo consutil show` or `sudo consutil connect` command.
```bash
NameError: global name 'ConfigDBConnector' is not defined
```
**Steps to reproduce the issue**
1. Install newest image of SONiC
2. Execute `sudo consutil show` or `sudo consutil connect 1`
**Describe the results you received**
Output:
```bash
admin@sonic:~$ sudo consutil show
Traceback (most recent call last):
File "/usr/bin/consutil", line 12, in <module>
sys.exit(consutil())
File "/usr/lib/python2.7/dist-packages/click/core.py", line 764, in __call__
return self.main(*args, **kwargs)
File "/usr/lib/python2.7/dist-packages/click/core.py", line 717, in main
rv = self.invoke(ctx)
File "/usr/lib/python2.7/dist-packages/click/core.py", line 1137, in invoke
return _process_result(sub_ctx.command.invoke(sub_ctx))
File "/usr/lib/python2.7/dist-packages/click/core.py", line 956, in invoke
return ctx.invoke(self.callback, **ctx.params)
File "/usr/lib/python2.7/dist-packages/click/core.py", line 555, in invoke
return callback(*args, **kwargs)
File "/usr/lib/python2.7/dist-packages/consutil/main.py", line 43, in show
actBaud, confBaud, _ = getConnectionInfo(lineNum)
File "/usr/lib/python2.7/dist-packages/consutil/lib.py", line 98, in getConnectionInfo
config_db = ConfigDBConnector()
NameError: global name 'ConfigDBConnector' is not defined
admin@sonic:~$
admin@sonic:~$
admin@sonic:~$ sudo consutil connect 1
Traceback (most recent call last):
File "/usr/bin/consutil", line 12, in <module>
sys.exit(consutil())
File "/usr/lib/python2.7/dist-packages/click/core.py", line 764, in __call__
return self.main(*args, **kwargs)
File "/usr/lib/python2.7/dist-packages/click/core.py", line 717, in main
rv = self.invoke(ctx)
File "/usr/lib/python2.7/dist-packages/click/core.py", line 1137, in invoke
return _process_result(sub_ctx.command.invoke(sub_ctx))
File "/usr/lib/python2.7/dist-packages/click/core.py", line 956, in invoke
return ctx.invoke(self.callback, **ctx.params)
File "/usr/lib/python2.7/dist-packages/click/core.py", line 555, in invoke
return callback(*args, **kwargs)
File "/usr/lib/python2.7/dist-packages/consutil/main.py", line 79, in connect
actBaud, _, flowBool = getConnectionInfo(lineNumber)
File "/usr/lib/python2.7/dist-packages/consutil/lib.py", line 98, in getConnectionInfo
config_db = ConfigDBConnector()
NameError: global name 'ConfigDBConnector' is not defined
```
**Describe the results you expected**
For `sudo consutil show`, a table with line number/baud/... should be displayed without any error.
For `sudo consutil connect`, a console session should be attached or friendly error message will display if the line is busy.
**Additional information you deem important (e.g. issue happens only occasionally)**
Similar error found in another PR/Issue, maybe current issue and that issue are relating to some recent change? https://github.com/Azure/sonic-utilities/pull/1114
**Output of `show version`**
```
admin@sonic:~$ show version
SONiC Software Version: SONiC.dev_jika_cli01.0-0b4191fe
Distribution: Debian 10.5
Kernel: 4.19.0-9-2-amd64
Build commit: 0b4191fe
Build date: Fri Sep 11 07:36:01 UTC 2020
Built by: jika@jika-vm-01
Platform: x86_64-cel_e1031-r0
HwSKU: Celestica-E1031-T48S4
ASIC: broadcom
Serial Number: R0882B2F160615GD000006
Uptime: 11:41:37 up 1:29, 1 user, load average: 0.09, 0.67, 1.15
Docker images:
REPOSITORY TAG IMAGE ID SIZE
docker-teamd dev_jika_cli01.0-0b4191fe 06a9488f9400 390MB
docker-teamd latest 06a9488f9400 390MB
docker-nat dev_jika_cli01.0-0b4191fe 9adedebc9007 393MB
docker-nat latest 9adedebc9007 393MB
docker-router-advertiser dev_jika_cli01.0-0b4191fe 9bca9fa2d027 359MB
docker-router-advertiser latest 9bca9fa2d027 359MB
docker-platform-monitor dev_jika_cli01.0-0b4191fe 11092e178476 433MB
docker-platform-monitor latest 11092e178476 433MB
docker-lldp dev_jika_cli01.0-0b4191fe bdc853ee9542 387MB
docker-lldp latest bdc853ee9542 387MB
docker-dhcp-relay dev_jika_cli01.0-0b4191fe 787384652391 366MB
docker-dhcp-relay latest 787384652391 366MB
docker-database dev_jika_cli01.0-0b4191fe 08143a381945 359MB
docker-database latest 08143a381945 359MB
docker-orchagent dev_jika_cli01.0-0b4191fe 78b74caafb9b 404MB
docker-orchagent latest 78b74caafb9b 404MB
docker-sonic-telemetry dev_jika_cli01.0-0b4191fe cd5e957ea52a 429MB
docker-sonic-telemetry latest cd5e957ea52a 429MB
docker-sonic-mgmt-framework dev_jika_cli01.0-0b4191fe f91a73bd2111 486MB
docker-sonic-mgmt-framework latest f91a73bd2111 486MB
docker-fpm-frr dev_jika_cli01.0-0b4191fe b7a0da93271f 406MB
docker-fpm-frr latest b7a0da93271f 406MB
docker-sflow dev_jika_cli01.0-0b4191fe 60511099fae8 394MB
docker-sflow latest 60511099fae8 394MB
docker-snmp dev_jika_cli01.0-0b4191fe c3b585b7970f 399MB
docker-snmp latest c3b585b7970f 399MB
docker-syncd-brcm dev_jika_cli01.0-0b4191fe 64ac8a8a6401 447MB
docker-syncd-brcm latest 64ac8a8a6401 447MB
```
<!--
Also attach debug file produced by `sudo generate_dump`
-->
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `consutil/lib.py`
Content:
```
1 #!/usr/bin/env python
2 #
3 # lib.py
4 #
5 # Helper code for CLI for interacting with switches via console device
6 #
7
8 try:
9 import click
10 import re
11 import subprocess
12 import sys
13 except ImportError as e:
14 raise ImportError("%s - required module not found" % str(e))
15
16 DEVICE_PREFIX = "/dev/ttyUSB"
17
18 ERR_CMD = 1
19 ERR_DEV = 2
20
21 CONSOLE_PORT_TABLE = "CONSOLE_PORT"
22 BAUD_KEY = "baud_rate"
23 DEVICE_KEY = "remote_device"
24 FLOW_KEY = "flow_control"
25 DEFAULT_BAUD = "9600"
26
27 # QUIET == True => picocom will not output any messages, and pexpect will wait for console
28 # switch login or command line to let user interact with shell
29 # Downside: if console switch output ever does not match DEV_READY_MSG, program will think connection failed
30 # QUIET == False => picocom will output messages - welcome message is caught by pexpect, so successful
31 # connection will always lead to user interacting with shell
32 # Downside: at end of session, picocom will print exit message, exposing picocom to user
33 QUIET = False
34 DEV_READY_MSG = r"([Ll]ogin:|[Pp]assword:|[$>#])" # login prompt or command line prompt
35 TIMEOUT_SEC = 0.2
36
37 # runs command, exit if stderr is written to, returns stdout otherwise
38 # input: cmd (str), output: output of cmd (str)
39 def run_command(cmd):
40 proc = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
41 output = proc.stdout.read()
42 error = proc.stderr.read()
43 if error != "":
44 click.echo("Command resulted in error: {}".format(error))
45 sys.exit(ERR_CMD)
46 return output
47
48 # returns a sorted list of all devices (whose name matches DEVICE_PREFIX)
49 def getAllDevices():
50 cmd = "ls " + DEVICE_PREFIX + "*"
51 output = run_command(cmd)
52
53 devices = output.split('\n')
54 devices = list(filter(lambda dev: re.match(DEVICE_PREFIX + r"\d+", dev) != None, devices))
55 devices.sort(key=lambda dev: int(dev[len(DEVICE_PREFIX):]))
56
57 return devices
58
59 # exits if inputted line number does not correspond to a device
60 # input: linenum
61 def checkDevice(linenum):
62 devices = getAllDevices()
63 if DEVICE_PREFIX + str(linenum) not in devices:
64 click.echo("Line number {} does not exist".format(linenum))
65 sys.exit(ERR_DEV)
66
67 # returns a dictionary of busy devices and their info
68 # maps line number to (pid, process start time)
69 def getBusyDevices():
70 cmd = 'ps -eo pid,lstart,cmd | grep -E "(mini|pico)com"'
71 output = run_command(cmd)
72 processes = output.split('\n')
73
74 # matches any number of spaces then any number of digits
75 regexPid = r" *(\d+)"
76 # matches anything of form: Xxx Xxx ( 0)or(00) 00:00:00 0000
77 regexDate = r"([A-Z][a-z]{2} [A-Z][a-z]{2} [\d ]\d \d{2}:\d{2}:\d{2} \d{4})"
78 # matches any non-whitespace characters ending in minicom or picocom,
79 # then a space and any chars followed by /dev/ttyUSB<any digits>,
80 # then a space and any chars
81 regexCmd = r"\S*(?:(?:mini)|(?:pico))com .*" + DEVICE_PREFIX + r"(\d+)(?: .*)?"
82 regexProcess = re.compile(r"^"+regexPid+r" "+regexDate+r" "+regexCmd+r"$")
83
84 busyDevices = {}
85 for process in processes:
86 match = regexProcess.match(process)
87 if match != None:
88 pid = match.group(1)
89 date = match.group(2)
90 linenum_key = match.group(3)
91 busyDevices[linenum_key] = (pid, date)
92 return busyDevices
93
94 # returns actual baud rate, configured baud rate,
95 # and flow control settings of device corresponding to line number
96 # input: linenum (str), output: (actual baud (str), configured baud (str), flow control (bool))
97 def getConnectionInfo(linenum):
98 config_db = ConfigDBConnector()
99 config_db.connect()
100 entry = config_db.get_entry(CONSOLE_PORT_TABLE, str(linenum))
101
102 conf_baud = "-" if BAUD_KEY not in entry else entry[BAUD_KEY]
103 act_baud = DEFAULT_BAUD if conf_baud == "-" else conf_baud
104 flow_control = False
105 if FLOW_KEY in entry and entry[FLOW_KEY] == "1":
106 flow_control = True
107
108 return (act_baud, conf_baud, flow_control)
109
110 # returns the line number corresponding to target, or exits if line number cannot be found
111 # if deviceBool, interprets target as device name
112 # otherwise interprets target as line number
113 # input: target (str), deviceBool (bool), output: linenum (str)
114 def getLineNumber(target, deviceBool):
115 if not deviceBool:
116 return target
117
118 config_db = ConfigDBConnector()
119 config_db.connect()
120
121 devices = getAllDevices()
122 linenums = list(map(lambda dev: dev[len(DEVICE_PREFIX):], devices))
123
124 for linenum in linenums:
125 entry = config_db.get_entry(CONSOLE_PORT_TABLE, linenum)
126 if DEVICE_KEY in entry and entry[DEVICE_KEY] == target:
127 return linenum
128
129 click.echo("Device {} does not exist".format(target))
130 sys.exit(ERR_DEV)
131 return ""
132
```
--- 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/consutil/lib.py b/consutil/lib.py
--- a/consutil/lib.py
+++ b/consutil/lib.py
@@ -10,6 +10,7 @@
import re
import subprocess
import sys
+ from swsssdk import ConfigDBConnector
except ImportError as e:
raise ImportError("%s - required module not found" % str(e))
| {"golden_diff": "diff --git a/consutil/lib.py b/consutil/lib.py\n--- a/consutil/lib.py\n+++ b/consutil/lib.py\n@@ -10,6 +10,7 @@\n import re\n import subprocess\n import sys\n+ from swsssdk import ConfigDBConnector\n except ImportError as e:\n raise ImportError(\"%s - required module not found\" % str(e))\n", "issue": "[consutil] show/connect command failed due to global name 'ConfigDBConnector' is not defined\n<!--\r\nIf you are reporting a new issue, make sure that we do not have any duplicates\r\nalready open. You can ensure this by searching the issue list for this\r\nrepository. If there is a duplicate, please close your issue and add a comment\r\nto the existing issue instead.\r\n\r\nIf you suspect your issue is a bug, please edit your issue description to\r\ninclude the BUG REPORT INFORMATION shown below. If you fail to provide this\r\ninformation within 7 days, we cannot debug your issue and will close it. We\r\nwill, however, reopen it if you later provide the information.\r\n\r\nFor more information about reporting issues, see\r\nhttps://github.com/Azure/SONiC/wiki#report-issues\r\n\r\n---------------------------------------------------\r\nGENERAL SUPPORT INFORMATION\r\n---------------------------------------------------\r\n\r\nThe GitHub issue tracker is for bug reports and feature requests.\r\nGeneral support can be found at the following locations:\r\n\r\n- SONiC Support Forums - https://groups.google.com/forum/#!forum/sonicproject\r\n\r\n---------------------------------------------------\r\nBUG REPORT INFORMATION\r\n---------------------------------------------------\r\nUse the commands below to provide key information from your environment:\r\nYou do NOT have to include this information if this is a FEATURE REQUEST\r\n-->\r\n\r\n**Description**\r\n\r\n<!--\r\nBriefly describe the problem you are having in a few paragraphs.\r\n-->\r\n\r\nAn unexpected error thrown while executing `sudo consutil show` or `sudo consutil connect` command.\r\n```bash\r\nNameError: global name 'ConfigDBConnector' is not defined\r\n```\r\n\r\n**Steps to reproduce the issue**\r\n1. Install newest image of SONiC\r\n2. Execute `sudo consutil show` or `sudo consutil connect 1`\r\n\r\n**Describe the results you received**\r\nOutput:\r\n```bash\r\nadmin@sonic:~$ sudo consutil show\r\nTraceback (most recent call last):\r\n File \"/usr/bin/consutil\", line 12, in <module>\r\n sys.exit(consutil())\r\n File \"/usr/lib/python2.7/dist-packages/click/core.py\", line 764, in __call__\r\n return self.main(*args, **kwargs)\r\n File \"/usr/lib/python2.7/dist-packages/click/core.py\", line 717, in main\r\n rv = self.invoke(ctx)\r\n File \"/usr/lib/python2.7/dist-packages/click/core.py\", line 1137, in invoke\r\n return _process_result(sub_ctx.command.invoke(sub_ctx))\r\n File \"/usr/lib/python2.7/dist-packages/click/core.py\", line 956, in invoke\r\n return ctx.invoke(self.callback, **ctx.params)\r\n File \"/usr/lib/python2.7/dist-packages/click/core.py\", line 555, in invoke\r\n return callback(*args, **kwargs)\r\n File \"/usr/lib/python2.7/dist-packages/consutil/main.py\", line 43, in show\r\n actBaud, confBaud, _ = getConnectionInfo(lineNum)\r\n File \"/usr/lib/python2.7/dist-packages/consutil/lib.py\", line 98, in getConnectionInfo\r\n config_db = ConfigDBConnector()\r\nNameError: global name 'ConfigDBConnector' is not defined\r\nadmin@sonic:~$ \r\nadmin@sonic:~$ \r\nadmin@sonic:~$ sudo consutil connect 1\r\nTraceback (most recent call last):\r\n File \"/usr/bin/consutil\", line 12, in <module>\r\n sys.exit(consutil())\r\n File \"/usr/lib/python2.7/dist-packages/click/core.py\", line 764, in __call__\r\n return self.main(*args, **kwargs)\r\n File \"/usr/lib/python2.7/dist-packages/click/core.py\", line 717, in main\r\n rv = self.invoke(ctx)\r\n File \"/usr/lib/python2.7/dist-packages/click/core.py\", line 1137, in invoke\r\n return _process_result(sub_ctx.command.invoke(sub_ctx))\r\n File \"/usr/lib/python2.7/dist-packages/click/core.py\", line 956, in invoke\r\n return ctx.invoke(self.callback, **ctx.params)\r\n File \"/usr/lib/python2.7/dist-packages/click/core.py\", line 555, in invoke\r\n return callback(*args, **kwargs)\r\n File \"/usr/lib/python2.7/dist-packages/consutil/main.py\", line 79, in connect\r\n actBaud, _, flowBool = getConnectionInfo(lineNumber)\r\n File \"/usr/lib/python2.7/dist-packages/consutil/lib.py\", line 98, in getConnectionInfo\r\n config_db = ConfigDBConnector()\r\nNameError: global name 'ConfigDBConnector' is not defined\r\n```\r\n\r\n**Describe the results you expected**\r\nFor `sudo consutil show`, a table with line number/baud/... should be displayed without any error.\r\nFor `sudo consutil connect`, a console session should be attached or friendly error message will display if the line is busy.\r\n\r\n**Additional information you deem important (e.g. issue happens only occasionally)**\r\nSimilar error found in another PR/Issue, maybe current issue and that issue are relating to some recent change? https://github.com/Azure/sonic-utilities/pull/1114\r\n\r\n**Output of `show version`**\r\n\r\n```\r\nadmin@sonic:~$ show version\r\n\r\nSONiC Software Version: SONiC.dev_jika_cli01.0-0b4191fe\r\nDistribution: Debian 10.5\r\nKernel: 4.19.0-9-2-amd64\r\nBuild commit: 0b4191fe\r\nBuild date: Fri Sep 11 07:36:01 UTC 2020\r\nBuilt by: jika@jika-vm-01\r\n\r\nPlatform: x86_64-cel_e1031-r0\r\nHwSKU: Celestica-E1031-T48S4\r\nASIC: broadcom\r\nSerial Number: R0882B2F160615GD000006\r\nUptime: 11:41:37 up 1:29, 1 user, load average: 0.09, 0.67, 1.15\r\n\r\nDocker images:\r\nREPOSITORY TAG IMAGE ID SIZE\r\ndocker-teamd dev_jika_cli01.0-0b4191fe 06a9488f9400 390MB\r\ndocker-teamd latest 06a9488f9400 390MB\r\ndocker-nat dev_jika_cli01.0-0b4191fe 9adedebc9007 393MB\r\ndocker-nat latest 9adedebc9007 393MB\r\ndocker-router-advertiser dev_jika_cli01.0-0b4191fe 9bca9fa2d027 359MB\r\ndocker-router-advertiser latest 9bca9fa2d027 359MB\r\ndocker-platform-monitor dev_jika_cli01.0-0b4191fe 11092e178476 433MB\r\ndocker-platform-monitor latest 11092e178476 433MB\r\ndocker-lldp dev_jika_cli01.0-0b4191fe bdc853ee9542 387MB\r\ndocker-lldp latest bdc853ee9542 387MB\r\ndocker-dhcp-relay dev_jika_cli01.0-0b4191fe 787384652391 366MB\r\ndocker-dhcp-relay latest 787384652391 366MB\r\ndocker-database dev_jika_cli01.0-0b4191fe 08143a381945 359MB\r\ndocker-database latest 08143a381945 359MB\r\ndocker-orchagent dev_jika_cli01.0-0b4191fe 78b74caafb9b 404MB\r\ndocker-orchagent latest 78b74caafb9b 404MB\r\ndocker-sonic-telemetry dev_jika_cli01.0-0b4191fe cd5e957ea52a 429MB\r\ndocker-sonic-telemetry latest cd5e957ea52a 429MB\r\ndocker-sonic-mgmt-framework dev_jika_cli01.0-0b4191fe f91a73bd2111 486MB\r\ndocker-sonic-mgmt-framework latest f91a73bd2111 486MB\r\ndocker-fpm-frr dev_jika_cli01.0-0b4191fe b7a0da93271f 406MB\r\ndocker-fpm-frr latest b7a0da93271f 406MB\r\ndocker-sflow dev_jika_cli01.0-0b4191fe 60511099fae8 394MB\r\ndocker-sflow latest 60511099fae8 394MB\r\ndocker-snmp dev_jika_cli01.0-0b4191fe c3b585b7970f 399MB\r\ndocker-snmp latest c3b585b7970f 399MB\r\ndocker-syncd-brcm dev_jika_cli01.0-0b4191fe 64ac8a8a6401 447MB\r\ndocker-syncd-brcm latest 64ac8a8a6401 447MB\r\n```\r\n\r\n<!--\r\nAlso attach debug file produced by `sudo generate_dump`\r\n-->\r\n\r\n\n", "before_files": [{"content": "#!/usr/bin/env python\n#\n# lib.py\n#\n# Helper code for CLI for interacting with switches via console device\n#\n\ntry:\n import click\n import re\n import subprocess\n import sys\nexcept ImportError as e:\n raise ImportError(\"%s - required module not found\" % str(e))\n\nDEVICE_PREFIX = \"/dev/ttyUSB\"\n\nERR_CMD = 1\nERR_DEV = 2\n\nCONSOLE_PORT_TABLE = \"CONSOLE_PORT\"\nBAUD_KEY = \"baud_rate\"\nDEVICE_KEY = \"remote_device\"\nFLOW_KEY = \"flow_control\"\nDEFAULT_BAUD = \"9600\"\n\n# QUIET == True => picocom will not output any messages, and pexpect will wait for console\n# switch login or command line to let user interact with shell\n# Downside: if console switch output ever does not match DEV_READY_MSG, program will think connection failed\n# QUIET == False => picocom will output messages - welcome message is caught by pexpect, so successful\n# connection will always lead to user interacting with shell\n# Downside: at end of session, picocom will print exit message, exposing picocom to user\nQUIET = False\nDEV_READY_MSG = r\"([Ll]ogin:|[Pp]assword:|[$>#])\" # login prompt or command line prompt\nTIMEOUT_SEC = 0.2\n\n# runs command, exit if stderr is written to, returns stdout otherwise\n# input: cmd (str), output: output of cmd (str)\ndef run_command(cmd):\n proc = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)\n output = proc.stdout.read()\n error = proc.stderr.read()\n if error != \"\":\n click.echo(\"Command resulted in error: {}\".format(error))\n sys.exit(ERR_CMD)\n return output\n\n# returns a sorted list of all devices (whose name matches DEVICE_PREFIX)\ndef getAllDevices():\n cmd = \"ls \" + DEVICE_PREFIX + \"*\"\n output = run_command(cmd)\n\n devices = output.split('\\n')\n devices = list(filter(lambda dev: re.match(DEVICE_PREFIX + r\"\\d+\", dev) != None, devices))\n devices.sort(key=lambda dev: int(dev[len(DEVICE_PREFIX):]))\n\n return devices\n\n# exits if inputted line number does not correspond to a device\n# input: linenum\ndef checkDevice(linenum):\n devices = getAllDevices()\n if DEVICE_PREFIX + str(linenum) not in devices:\n click.echo(\"Line number {} does not exist\".format(linenum))\n sys.exit(ERR_DEV)\n\n# returns a dictionary of busy devices and their info\n# maps line number to (pid, process start time)\ndef getBusyDevices():\n cmd = 'ps -eo pid,lstart,cmd | grep -E \"(mini|pico)com\"'\n output = run_command(cmd)\n processes = output.split('\\n')\n\n # matches any number of spaces then any number of digits\n regexPid = r\" *(\\d+)\"\n # matches anything of form: Xxx Xxx ( 0)or(00) 00:00:00 0000\n regexDate = r\"([A-Z][a-z]{2} [A-Z][a-z]{2} [\\d ]\\d \\d{2}:\\d{2}:\\d{2} \\d{4})\"\n # matches any non-whitespace characters ending in minicom or picocom,\n # then a space and any chars followed by /dev/ttyUSB<any digits>,\n # then a space and any chars\n regexCmd = r\"\\S*(?:(?:mini)|(?:pico))com .*\" + DEVICE_PREFIX + r\"(\\d+)(?: .*)?\"\n regexProcess = re.compile(r\"^\"+regexPid+r\" \"+regexDate+r\" \"+regexCmd+r\"$\")\n\n busyDevices = {}\n for process in processes:\n match = regexProcess.match(process)\n if match != None:\n pid = match.group(1)\n date = match.group(2)\n linenum_key = match.group(3)\n busyDevices[linenum_key] = (pid, date)\n return busyDevices\n\n# returns actual baud rate, configured baud rate,\n# and flow control settings of device corresponding to line number\n# input: linenum (str), output: (actual baud (str), configured baud (str), flow control (bool))\ndef getConnectionInfo(linenum):\n config_db = ConfigDBConnector()\n config_db.connect()\n entry = config_db.get_entry(CONSOLE_PORT_TABLE, str(linenum))\n\n conf_baud = \"-\" if BAUD_KEY not in entry else entry[BAUD_KEY]\n act_baud = DEFAULT_BAUD if conf_baud == \"-\" else conf_baud\n flow_control = False\n if FLOW_KEY in entry and entry[FLOW_KEY] == \"1\":\n flow_control = True\n\n return (act_baud, conf_baud, flow_control)\n\n# returns the line number corresponding to target, or exits if line number cannot be found\n# if deviceBool, interprets target as device name\n# otherwise interprets target as line number\n# input: target (str), deviceBool (bool), output: linenum (str)\ndef getLineNumber(target, deviceBool):\n if not deviceBool:\n return target\n\n config_db = ConfigDBConnector()\n config_db.connect()\n\n devices = getAllDevices()\n linenums = list(map(lambda dev: dev[len(DEVICE_PREFIX):], devices))\n\n for linenum in linenums:\n entry = config_db.get_entry(CONSOLE_PORT_TABLE, linenum)\n if DEVICE_KEY in entry and entry[DEVICE_KEY] == target:\n return linenum\n\n click.echo(\"Device {} does not exist\".format(target))\n sys.exit(ERR_DEV)\n return \"\"\n", "path": "consutil/lib.py"}], "after_files": [{"content": "#!/usr/bin/env python\n#\n# lib.py\n#\n# Helper code for CLI for interacting with switches via console device\n#\n\ntry:\n import click\n import re\n import subprocess\n import sys\n from swsssdk import ConfigDBConnector\nexcept ImportError as e:\n raise ImportError(\"%s - required module not found\" % str(e))\n\nDEVICE_PREFIX = \"/dev/ttyUSB\"\n\nERR_CMD = 1\nERR_DEV = 2\n\nCONSOLE_PORT_TABLE = \"CONSOLE_PORT\"\nBAUD_KEY = \"baud_rate\"\nDEVICE_KEY = \"remote_device\"\nFLOW_KEY = \"flow_control\"\nDEFAULT_BAUD = \"9600\"\n\n# QUIET == True => picocom will not output any messages, and pexpect will wait for console\n# switch login or command line to let user interact with shell\n# Downside: if console switch output ever does not match DEV_READY_MSG, program will think connection failed\n# QUIET == False => picocom will output messages - welcome message is caught by pexpect, so successful\n# connection will always lead to user interacting with shell\n# Downside: at end of session, picocom will print exit message, exposing picocom to user\nQUIET = False\nDEV_READY_MSG = r\"([Ll]ogin:|[Pp]assword:|[$>#])\" # login prompt or command line prompt\nTIMEOUT_SEC = 0.2\n\n# runs command, exit if stderr is written to, returns stdout otherwise\n# input: cmd (str), output: output of cmd (str)\ndef run_command(cmd):\n proc = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)\n output = proc.stdout.read()\n error = proc.stderr.read()\n if error != \"\":\n click.echo(\"Command resulted in error: {}\".format(error))\n sys.exit(ERR_CMD)\n return output\n\n# returns a sorted list of all devices (whose name matches DEVICE_PREFIX)\ndef getAllDevices():\n cmd = \"ls \" + DEVICE_PREFIX + \"*\"\n output = run_command(cmd)\n\n devices = output.split('\\n')\n devices = list(filter(lambda dev: re.match(DEVICE_PREFIX + r\"\\d+\", dev) != None, devices))\n devices.sort(key=lambda dev: int(dev[len(DEVICE_PREFIX):]))\n\n return devices\n\n# exits if inputted line number does not correspond to a device\n# input: linenum\ndef checkDevice(linenum):\n devices = getAllDevices()\n if DEVICE_PREFIX + str(linenum) not in devices:\n click.echo(\"Line number {} does not exist\".format(linenum))\n sys.exit(ERR_DEV)\n\n# returns a dictionary of busy devices and their info\n# maps line number to (pid, process start time)\ndef getBusyDevices():\n cmd = 'ps -eo pid,lstart,cmd | grep -E \"(mini|pico)com\"'\n output = run_command(cmd)\n processes = output.split('\\n')\n\n # matches any number of spaces then any number of digits\n regexPid = r\" *(\\d+)\"\n # matches anything of form: Xxx Xxx ( 0)or(00) 00:00:00 0000\n regexDate = r\"([A-Z][a-z]{2} [A-Z][a-z]{2} [\\d ]\\d \\d{2}:\\d{2}:\\d{2} \\d{4})\"\n # matches any non-whitespace characters ending in minicom or picocom,\n # then a space and any chars followed by /dev/ttyUSB<any digits>,\n # then a space and any chars\n regexCmd = r\"\\S*(?:(?:mini)|(?:pico))com .*\" + DEVICE_PREFIX + r\"(\\d+)(?: .*)?\"\n regexProcess = re.compile(r\"^\"+regexPid+r\" \"+regexDate+r\" \"+regexCmd+r\"$\")\n\n busyDevices = {}\n for process in processes:\n match = regexProcess.match(process)\n if match != None:\n pid = match.group(1)\n date = match.group(2)\n linenum_key = match.group(3)\n busyDevices[linenum_key] = (pid, date)\n return busyDevices\n\n# returns actual baud rate, configured baud rate,\n# and flow control settings of device corresponding to line number\n# input: linenum (str), output: (actual baud (str), configured baud (str), flow control (bool))\ndef getConnectionInfo(linenum):\n config_db = ConfigDBConnector()\n config_db.connect()\n entry = config_db.get_entry(CONSOLE_PORT_TABLE, str(linenum))\n\n conf_baud = \"-\" if BAUD_KEY not in entry else entry[BAUD_KEY]\n act_baud = DEFAULT_BAUD if conf_baud == \"-\" else conf_baud\n flow_control = False\n if FLOW_KEY in entry and entry[FLOW_KEY] == \"1\":\n flow_control = True\n\n return (act_baud, conf_baud, flow_control)\n\n# returns the line number corresponding to target, or exits if line number cannot be found\n# if deviceBool, interprets target as device name\n# otherwise interprets target as line number\n# input: target (str), deviceBool (bool), output: linenum (str)\ndef getLineNumber(target, deviceBool):\n if not deviceBool:\n return target\n\n config_db = ConfigDBConnector()\n config_db.connect()\n\n devices = getAllDevices()\n linenums = list(map(lambda dev: dev[len(DEVICE_PREFIX):], devices))\n\n for linenum in linenums:\n entry = config_db.get_entry(CONSOLE_PORT_TABLE, linenum)\n if DEVICE_KEY in entry and entry[DEVICE_KEY] == target:\n return linenum\n\n click.echo(\"Device {} does not exist\".format(target))\n sys.exit(ERR_DEV)\n return \"\"\n", "path": "consutil/lib.py"}]} |
gh_patches_debug_247 | rasdani/github-patches | git_diff | pypa__cibuildwheel-1065 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[Docs] Example may accidentally be encouraging users to write invalid `pyproject.toml` files
### Description
Hi guys, first of all thank you for the amazing project (always good to remember).
While I was working on adding support for PEP 621 to setuptools, I noticed a series of users having problems with invalid `pyproject.toml` files. The common pattern seem to be a almost empty `[project]` table with only a `requires-python` field set, which is invalid according to PEP 621.
It took me some time to find the reason for this behaviour but I think it comes from:
https://cibuildwheel.readthedocs.io/en/stable/options/#requires-python
I suspect that the example and notes about the preferred way of setting the config has been encouraging users that are unaware of PEP 621 to write technically invalid `pyproject.toml` files.
Please note that this issue is not necessarily related to setuptools itself.
The existence of the `[project]` table in the `pyproject.toml` allows (according to the standard) the installer/builder/consumer program to treat the package differently (specially regarding `dynamic`).
I think it would be nice to at least add a note about this so users became aware of the implications of adding a `[project]` table.
### Build log
_No response_
### CI config
_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: `setup.py`
Content:
```
1 from setuptools import setup
2
3 extras = {
4 "docs": [
5 "mkdocs-include-markdown-plugin==2.8.0",
6 "mkdocs==1.0.4",
7 "pymdown-extensions",
8 "mkdocs-macros-plugin",
9 ],
10 "test": [
11 "jinja2",
12 "pytest>=6",
13 "pytest-timeout",
14 "pytest-xdist",
15 ],
16 "bin": [
17 "click",
18 "ghapi",
19 "pip-tools",
20 "pygithub",
21 "pyyaml",
22 "requests",
23 "rich>=9.6",
24 "packaging>=21.0",
25 ],
26 "mypy": [
27 "mypy>=0.901",
28 "types-jinja2",
29 "types-certifi",
30 "types-toml",
31 "types-jinja2",
32 "types-pyyaml",
33 "types-click",
34 "types-requests",
35 ],
36 }
37
38 extras["dev"] = [
39 *extras["mypy"],
40 *extras["test"],
41 *extras["bin"],
42 ]
43
44 extras["all"] = sum(extras.values(), [])
45
46 setup(extras_require=extras)
47
```
--- 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
@@ -4,6 +4,7 @@
"docs": [
"mkdocs-include-markdown-plugin==2.8.0",
"mkdocs==1.0.4",
+ "jinja2==3.0.3",
"pymdown-extensions",
"mkdocs-macros-plugin",
],
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -4,6 +4,7 @@\n \"docs\": [\n \"mkdocs-include-markdown-plugin==2.8.0\",\n \"mkdocs==1.0.4\",\n+ \"jinja2==3.0.3\",\n \"pymdown-extensions\",\n \"mkdocs-macros-plugin\",\n ],\n", "issue": "[Docs] Example may accidentally be encouraging users to write invalid `pyproject.toml` files\n### Description\r\n\r\nHi guys, first of all thank you for the amazing project (always good to remember).\r\n\r\nWhile I was working on adding support for PEP 621 to setuptools, I noticed a series of users having problems with invalid `pyproject.toml` files. The common pattern seem to be a almost empty `[project]` table with only a `requires-python` field set, which is invalid according to PEP 621.\r\n\r\nIt took me some time to find the reason for this behaviour but I think it comes from:\r\nhttps://cibuildwheel.readthedocs.io/en/stable/options/#requires-python\r\n\r\nI suspect that the example and notes about the preferred way of setting the config has been encouraging users that are unaware of PEP 621 to write technically invalid `pyproject.toml` files.\r\n\r\nPlease note that this issue is not necessarily related to setuptools itself.\r\nThe existence of the `[project]` table in the `pyproject.toml` allows (according to the standard) the installer/builder/consumer program to treat the package differently (specially regarding `dynamic`).\r\n\r\nI think it would be nice to at least add a note about this so users became aware of the implications of adding a `[project]` table.\r\n\r\n### Build log\r\n\r\n_No response_\r\n\r\n### CI config\r\n\r\n_No response_\n", "before_files": [{"content": "from setuptools import setup\n\nextras = {\n \"docs\": [\n \"mkdocs-include-markdown-plugin==2.8.0\",\n \"mkdocs==1.0.4\",\n \"pymdown-extensions\",\n \"mkdocs-macros-plugin\",\n ],\n \"test\": [\n \"jinja2\",\n \"pytest>=6\",\n \"pytest-timeout\",\n \"pytest-xdist\",\n ],\n \"bin\": [\n \"click\",\n \"ghapi\",\n \"pip-tools\",\n \"pygithub\",\n \"pyyaml\",\n \"requests\",\n \"rich>=9.6\",\n \"packaging>=21.0\",\n ],\n \"mypy\": [\n \"mypy>=0.901\",\n \"types-jinja2\",\n \"types-certifi\",\n \"types-toml\",\n \"types-jinja2\",\n \"types-pyyaml\",\n \"types-click\",\n \"types-requests\",\n ],\n}\n\nextras[\"dev\"] = [\n *extras[\"mypy\"],\n *extras[\"test\"],\n *extras[\"bin\"],\n]\n\nextras[\"all\"] = sum(extras.values(), [])\n\nsetup(extras_require=extras)\n", "path": "setup.py"}], "after_files": [{"content": "from setuptools import setup\n\nextras = {\n \"docs\": [\n \"mkdocs-include-markdown-plugin==2.8.0\",\n \"mkdocs==1.0.4\",\n \"jinja2==3.0.3\",\n \"pymdown-extensions\",\n \"mkdocs-macros-plugin\",\n ],\n \"test\": [\n \"jinja2\",\n \"pytest>=6\",\n \"pytest-timeout\",\n \"pytest-xdist\",\n ],\n \"bin\": [\n \"click\",\n \"ghapi\",\n \"pip-tools\",\n \"pygithub\",\n \"pyyaml\",\n \"requests\",\n \"rich>=9.6\",\n \"packaging>=21.0\",\n ],\n \"mypy\": [\n \"mypy>=0.901\",\n \"types-jinja2\",\n \"types-certifi\",\n \"types-toml\",\n \"types-jinja2\",\n \"types-pyyaml\",\n \"types-click\",\n \"types-requests\",\n ],\n}\n\nextras[\"dev\"] = [\n *extras[\"mypy\"],\n *extras[\"test\"],\n *extras[\"bin\"],\n]\n\nextras[\"all\"] = sum(extras.values(), [])\n\nsetup(extras_require=extras)\n", "path": "setup.py"}]} |
gh_patches_debug_248 | rasdani/github-patches | git_diff | cupy__cupy-6208 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Edge cases of compatibility in `numpy.eye()`
These are discovered when running hypothesis-based Array API tests. For now I am just documenting these discoveries. I do not know if they are something we'd like to fix -- I'd need more time to look into them.
Case 1:
```python
>>> np.eye(0, k=9223372036854775808, dtype=np.int8)
array([], shape=(0, 0), dtype=int8)
>>>
>>> cp.eye(0, k=9223372036854775808, dtype=np.int8)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/home/leof/dev/cupy_cuda114/cupy/_creation/basic.py", line 114, in eye
ret.diagonal(k)[:] = 1
File "cupy/_core/core.pyx", line 873, in cupy._core.core.ndarray.diagonal
cpdef ndarray diagonal(self, offset=0, axis1=0, axis2=1):
File "cupy/_core/core.pyx", line 881, in cupy._core.core.ndarray.diagonal
return _indexing._ndarray_diagonal(self, offset, axis1, axis2)
File "cupy/_core/_routines_indexing.pyx", line 218, in cupy._core._routines_indexing._ndarray_diagonal
return _diagonal(self, offset, axis1, axis2)
OverflowError: Python int too large to convert to C ssize_t
```
Case 2:
```python
>>> np.eye(1, k=-9223372036854775808, dtype=np.int8)
array([[0]], dtype=int8)
>>>
>>> cp.eye(1, k=-9223372036854775808, dtype=np.int8)
array([[1]], dtype=int8)
```
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `cupy/_creation/basic.py`
Content:
```
1 import numpy
2
3 import cupy
4 from cupy._core.internal import _get_strides_for_order_K, _update_order_char
5
6
7 def empty(shape, dtype=float, order='C'):
8 """Returns an array without initializing the elements.
9
10 Args:
11 shape (int or tuple of ints): Dimensionalities of the array.
12 dtype: Data type specifier.
13 order ({'C', 'F'}): Row-major (C-style) or column-major
14 (Fortran-style) order.
15
16 Returns:
17 cupy.ndarray: A new array with elements not initialized.
18
19 .. seealso:: :func:`numpy.empty`
20
21 """
22 return cupy.ndarray(shape, dtype, order=order)
23
24
25 def _new_like_order_and_strides(
26 a, dtype, order, shape=None, *, get_memptr=True):
27 """
28 Determine order and strides as in NumPy's PyArray_NewLikeArray.
29
30 (see: numpy/core/src/multiarray/ctors.c)
31 """
32 order = order.upper()
33 if order not in ['C', 'F', 'K', 'A']:
34 raise ValueError('order not understood: {}'.format(order))
35
36 if numpy.isscalar(shape):
37 shape = (shape,)
38
39 # Fallback to c_contiguous if keep order and number of dimensions
40 # of new shape mismatch
41 if order == 'K' and shape is not None and len(shape) != a.ndim:
42 return 'C', None, None
43
44 order = chr(_update_order_char(
45 a.flags.c_contiguous, a.flags.f_contiguous, ord(order)))
46
47 if order == 'K':
48 strides = _get_strides_for_order_K(a, numpy.dtype(dtype), shape)
49 order = 'C'
50 memptr = cupy.empty(a.size, dtype=dtype).data if get_memptr else None
51 return order, strides, memptr
52 else:
53 return order, None, None
54
55
56 def empty_like(a, dtype=None, order='K', subok=None, shape=None):
57 """Returns a new array with same shape and dtype of a given array.
58
59 This function currently does not support ``subok`` option.
60
61 Args:
62 a (cupy.ndarray): Base array.
63 dtype: Data type specifier. The data type of ``a`` is used by default.
64 order ({'C', 'F', 'A', or 'K'}): Overrides the memory layout of the
65 result. ``'C'`` means C-order, ``'F'`` means F-order, ``'A'`` means
66 ``'F'`` if ``a`` is Fortran contiguous, ``'C'`` otherwise.
67 ``'K'`` means match the layout of ``a`` as closely as possible.
68 subok: Not supported yet, must be None.
69 shape (int or tuple of ints): Overrides the shape of the result. If
70 ``order='K'`` and the number of dimensions is unchanged, will try
71 to keep order, otherwise, ``order='C'`` is implied.
72
73 Returns:
74 cupy.ndarray: A new array with same shape and dtype of ``a`` with
75 elements not initialized.
76
77 .. seealso:: :func:`numpy.empty_like`
78
79 """
80 if subok is not None:
81 raise TypeError('subok is not supported yet')
82 if dtype is None:
83 dtype = a.dtype
84
85 order, strides, memptr = _new_like_order_and_strides(a, dtype, order,
86 shape)
87 shape = shape if shape else a.shape
88 return cupy.ndarray(shape, dtype, memptr, strides, order)
89
90
91 def eye(N, M=None, k=0, dtype=float, order='C'):
92 """Returns a 2-D array with ones on the diagonals and zeros elsewhere.
93
94 Args:
95 N (int): Number of rows.
96 M (int): Number of columns. ``M == N`` by default.
97 k (int): Index of the diagonal. Zero indicates the main diagonal,
98 a positive index an upper diagonal, and a negative index a lower
99 diagonal.
100 dtype: Data type specifier.
101 order ({'C', 'F'}): Row-major (C-style) or column-major
102 (Fortran-style) order.
103
104 Returns:
105 cupy.ndarray: A 2-D array with given diagonals filled with ones and
106 zeros elsewhere.
107
108 .. seealso:: :func:`numpy.eye`
109
110 """
111 if M is None:
112 M = N
113 ret = zeros((N, M), dtype, order=order)
114 ret.diagonal(k)[:] = 1
115 return ret
116
117
118 def identity(n, dtype=float):
119 """Returns a 2-D identity array.
120
121 It is equivalent to ``eye(n, n, dtype)``.
122
123 Args:
124 n (int): Number of rows and columns.
125 dtype: Data type specifier.
126
127 Returns:
128 cupy.ndarray: A 2-D identity array.
129
130 .. seealso:: :func:`numpy.identity`
131
132 """
133 return eye(n, dtype=dtype)
134
135
136 def ones(shape, dtype=float, order='C'):
137 """Returns a new array of given shape and dtype, filled with ones.
138
139 This function currently does not support ``order`` option.
140
141 Args:
142 shape (int or tuple of ints): Dimensionalities of the array.
143 dtype: Data type specifier.
144 order ({'C', 'F'}): Row-major (C-style) or column-major
145 (Fortran-style) order.
146
147 Returns:
148 cupy.ndarray: An array filled with ones.
149
150 .. seealso:: :func:`numpy.ones`
151
152 """
153 a = cupy.ndarray(shape, dtype, order=order)
154 a.fill(1)
155 return a
156
157
158 def ones_like(a, dtype=None, order='K', subok=None, shape=None):
159 """Returns an array of ones with same shape and dtype as a given array.
160
161 This function currently does not support ``subok`` option.
162
163 Args:
164 a (cupy.ndarray): Base array.
165 dtype: Data type specifier. The dtype of ``a`` is used by default.
166 order ({'C', 'F', 'A', or 'K'}): Overrides the memory layout of the
167 result. ``'C'`` means C-order, ``'F'`` means F-order, ``'A'`` means
168 ``'F'`` if ``a`` is Fortran contiguous, ``'C'`` otherwise.
169 ``'K'`` means match the layout of ``a`` as closely as possible.
170 subok: Not supported yet, must be None.
171 shape (int or tuple of ints): Overrides the shape of the result. If
172 ``order='K'`` and the number of dimensions is unchanged, will try
173 to keep order, otherwise, ``order='C'`` is implied.
174
175 Returns:
176 cupy.ndarray: An array filled with ones.
177
178 .. seealso:: :func:`numpy.ones_like`
179
180 """
181 if subok is not None:
182 raise TypeError('subok is not supported yet')
183 if dtype is None:
184 dtype = a.dtype
185
186 order, strides, memptr = _new_like_order_and_strides(a, dtype, order,
187 shape)
188 shape = shape if shape else a.shape
189 a = cupy.ndarray(shape, dtype, memptr, strides, order)
190 a.fill(1)
191 return a
192
193
194 def zeros(shape, dtype=float, order='C'):
195 """Returns a new array of given shape and dtype, filled with zeros.
196
197 Args:
198 shape (int or tuple of ints): Dimensionalities of the array.
199 dtype: Data type specifier.
200 order ({'C', 'F'}): Row-major (C-style) or column-major
201 (Fortran-style) order.
202
203 Returns:
204 cupy.ndarray: An array filled with zeros.
205
206 .. seealso:: :func:`numpy.zeros`
207
208 """
209 a = cupy.ndarray(shape, dtype, order=order)
210 a.data.memset_async(0, a.nbytes)
211 return a
212
213
214 def zeros_like(a, dtype=None, order='K', subok=None, shape=None):
215 """Returns an array of zeros with same shape and dtype as a given array.
216
217 This function currently does not support ``subok`` option.
218
219 Args:
220 a (cupy.ndarray): Base array.
221 dtype: Data type specifier. The dtype of ``a`` is used by default.
222 order ({'C', 'F', 'A', or 'K'}): Overrides the memory layout of the
223 result. ``'C'`` means C-order, ``'F'`` means F-order, ``'A'`` means
224 ``'F'`` if ``a`` is Fortran contiguous, ``'C'`` otherwise.
225 ``'K'`` means match the layout of ``a`` as closely as possible.
226 subok: Not supported yet, must be None.
227 shape (int or tuple of ints): Overrides the shape of the result. If
228 ``order='K'`` and the number of dimensions is unchanged, will try
229 to keep order, otherwise, ``order='C'`` is implied.
230
231 Returns:
232 cupy.ndarray: An array filled with zeros.
233
234 .. seealso:: :func:`numpy.zeros_like`
235
236 """
237 if subok is not None:
238 raise TypeError('subok is not supported yet')
239 if dtype is None:
240 dtype = a.dtype
241
242 order, strides, memptr = _new_like_order_and_strides(a, dtype, order,
243 shape)
244 shape = shape if shape else a.shape
245 a = cupy.ndarray(shape, dtype, memptr, strides, order)
246 a.data.memset_async(0, a.nbytes)
247 return a
248
249
250 def full(shape, fill_value, dtype=None, order='C'):
251 """Returns a new array of given shape and dtype, filled with a given value.
252
253 This function currently does not support ``order`` option.
254
255 Args:
256 shape (int or tuple of ints): Dimensionalities of the array.
257 fill_value: A scalar value to fill a new array.
258 dtype: Data type specifier.
259 order ({'C', 'F'}): Row-major (C-style) or column-major
260 (Fortran-style) order.
261
262 Returns:
263 cupy.ndarray: An array filled with ``fill_value``.
264
265 .. seealso:: :func:`numpy.full`
266
267 """
268 if dtype is None:
269 if isinstance(fill_value, cupy.ndarray):
270 dtype = fill_value.dtype
271 else:
272 dtype = numpy.array(fill_value).dtype
273 a = cupy.ndarray(shape, dtype, order=order)
274 a.fill(fill_value)
275 return a
276
277
278 def full_like(a, fill_value, dtype=None, order='K', subok=None, shape=None):
279 """Returns a full array with same shape and dtype as a given array.
280
281 This function currently does not support ``subok`` option.
282
283 Args:
284 a (cupy.ndarray): Base array.
285 fill_value: A scalar value to fill a new array.
286 dtype: Data type specifier. The dtype of ``a`` is used by default.
287 order ({'C', 'F', 'A', or 'K'}): Overrides the memory layout of the
288 result. ``'C'`` means C-order, ``'F'`` means F-order, ``'A'`` means
289 ``'F'`` if ``a`` is Fortran contiguous, ``'C'`` otherwise.
290 ``'K'`` means match the layout of ``a`` as closely as possible.
291 subok: Not supported yet, must be None.
292 shape (int or tuple of ints): Overrides the shape of the result. If
293 ``order='K'`` and the number of dimensions is unchanged, will try
294 to keep order, otherwise, ``order='C'`` is implied.
295
296 Returns:
297 cupy.ndarray: An array filled with ``fill_value``.
298
299 .. seealso:: :func:`numpy.full_like`
300
301 """
302 if subok is not None:
303 raise TypeError('subok is not supported yet')
304 if dtype is None:
305 dtype = a.dtype
306
307 order, strides, memptr = _new_like_order_and_strides(a, dtype, order,
308 shape)
309 shape = shape if shape else a.shape
310 a = cupy.ndarray(shape, dtype, memptr, strides, order)
311 a.fill(fill_value)
312 return a
313
```
--- 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/cupy/_creation/basic.py b/cupy/_creation/basic.py
--- a/cupy/_creation/basic.py
+++ b/cupy/_creation/basic.py
@@ -110,7 +110,9 @@
"""
if M is None:
M = N
- ret = zeros((N, M), dtype, order=order)
+ ret = zeros((N, M), dtype=dtype, order=order)
+ if k <= -N or k >= M:
+ return ret
ret.diagonal(k)[:] = 1
return ret
| {"golden_diff": "diff --git a/cupy/_creation/basic.py b/cupy/_creation/basic.py\n--- a/cupy/_creation/basic.py\n+++ b/cupy/_creation/basic.py\n@@ -110,7 +110,9 @@\n \"\"\"\n if M is None:\n M = N\n- ret = zeros((N, M), dtype, order=order)\n+ ret = zeros((N, M), dtype=dtype, order=order)\n+ if k <= -N or k >= M:\n+ return ret\n ret.diagonal(k)[:] = 1\n return ret\n", "issue": "Edge cases of compatibility in `numpy.eye()`\nThese are discovered when running hypothesis-based Array API tests. For now I am just documenting these discoveries. I do not know if they are something we'd like to fix -- I'd need more time to look into them. \r\n\r\nCase 1:\r\n```python\r\n>>> np.eye(0, k=9223372036854775808, dtype=np.int8)\r\narray([], shape=(0, 0), dtype=int8)\r\n>>>\r\n>>> cp.eye(0, k=9223372036854775808, dtype=np.int8)\r\nTraceback (most recent call last):\r\n File \"<stdin>\", line 1, in <module>\r\n File \"/home/leof/dev/cupy_cuda114/cupy/_creation/basic.py\", line 114, in eye\r\n ret.diagonal(k)[:] = 1\r\n File \"cupy/_core/core.pyx\", line 873, in cupy._core.core.ndarray.diagonal\r\n cpdef ndarray diagonal(self, offset=0, axis1=0, axis2=1):\r\n File \"cupy/_core/core.pyx\", line 881, in cupy._core.core.ndarray.diagonal\r\n return _indexing._ndarray_diagonal(self, offset, axis1, axis2)\r\n File \"cupy/_core/_routines_indexing.pyx\", line 218, in cupy._core._routines_indexing._ndarray_diagonal\r\n return _diagonal(self, offset, axis1, axis2)\r\nOverflowError: Python int too large to convert to C ssize_t\r\n```\r\n\r\nCase 2:\r\n```python\r\n>>> np.eye(1, k=-9223372036854775808, dtype=np.int8)\r\narray([[0]], dtype=int8)\r\n>>>\r\n>>> cp.eye(1, k=-9223372036854775808, dtype=np.int8)\r\narray([[1]], dtype=int8)\r\n```\n", "before_files": [{"content": "import numpy\n\nimport cupy\nfrom cupy._core.internal import _get_strides_for_order_K, _update_order_char\n\n\ndef empty(shape, dtype=float, order='C'):\n \"\"\"Returns an array without initializing the elements.\n\n Args:\n shape (int or tuple of ints): Dimensionalities of the array.\n dtype: Data type specifier.\n order ({'C', 'F'}): Row-major (C-style) or column-major\n (Fortran-style) order.\n\n Returns:\n cupy.ndarray: A new array with elements not initialized.\n\n .. seealso:: :func:`numpy.empty`\n\n \"\"\"\n return cupy.ndarray(shape, dtype, order=order)\n\n\ndef _new_like_order_and_strides(\n a, dtype, order, shape=None, *, get_memptr=True):\n \"\"\"\n Determine order and strides as in NumPy's PyArray_NewLikeArray.\n\n (see: numpy/core/src/multiarray/ctors.c)\n \"\"\"\n order = order.upper()\n if order not in ['C', 'F', 'K', 'A']:\n raise ValueError('order not understood: {}'.format(order))\n\n if numpy.isscalar(shape):\n shape = (shape,)\n\n # Fallback to c_contiguous if keep order and number of dimensions\n # of new shape mismatch\n if order == 'K' and shape is not None and len(shape) != a.ndim:\n return 'C', None, None\n\n order = chr(_update_order_char(\n a.flags.c_contiguous, a.flags.f_contiguous, ord(order)))\n\n if order == 'K':\n strides = _get_strides_for_order_K(a, numpy.dtype(dtype), shape)\n order = 'C'\n memptr = cupy.empty(a.size, dtype=dtype).data if get_memptr else None\n return order, strides, memptr\n else:\n return order, None, None\n\n\ndef empty_like(a, dtype=None, order='K', subok=None, shape=None):\n \"\"\"Returns a new array with same shape and dtype of a given array.\n\n This function currently does not support ``subok`` option.\n\n Args:\n a (cupy.ndarray): Base array.\n dtype: Data type specifier. The data type of ``a`` is used by default.\n order ({'C', 'F', 'A', or 'K'}): Overrides the memory layout of the\n result. ``'C'`` means C-order, ``'F'`` means F-order, ``'A'`` means\n ``'F'`` if ``a`` is Fortran contiguous, ``'C'`` otherwise.\n ``'K'`` means match the layout of ``a`` as closely as possible.\n subok: Not supported yet, must be None.\n shape (int or tuple of ints): Overrides the shape of the result. If\n ``order='K'`` and the number of dimensions is unchanged, will try\n to keep order, otherwise, ``order='C'`` is implied.\n\n Returns:\n cupy.ndarray: A new array with same shape and dtype of ``a`` with\n elements not initialized.\n\n .. seealso:: :func:`numpy.empty_like`\n\n \"\"\"\n if subok is not None:\n raise TypeError('subok is not supported yet')\n if dtype is None:\n dtype = a.dtype\n\n order, strides, memptr = _new_like_order_and_strides(a, dtype, order,\n shape)\n shape = shape if shape else a.shape\n return cupy.ndarray(shape, dtype, memptr, strides, order)\n\n\ndef eye(N, M=None, k=0, dtype=float, order='C'):\n \"\"\"Returns a 2-D array with ones on the diagonals and zeros elsewhere.\n\n Args:\n N (int): Number of rows.\n M (int): Number of columns. ``M == N`` by default.\n k (int): Index of the diagonal. Zero indicates the main diagonal,\n a positive index an upper diagonal, and a negative index a lower\n diagonal.\n dtype: Data type specifier.\n order ({'C', 'F'}): Row-major (C-style) or column-major\n (Fortran-style) order.\n\n Returns:\n cupy.ndarray: A 2-D array with given diagonals filled with ones and\n zeros elsewhere.\n\n .. seealso:: :func:`numpy.eye`\n\n \"\"\"\n if M is None:\n M = N\n ret = zeros((N, M), dtype, order=order)\n ret.diagonal(k)[:] = 1\n return ret\n\n\ndef identity(n, dtype=float):\n \"\"\"Returns a 2-D identity array.\n\n It is equivalent to ``eye(n, n, dtype)``.\n\n Args:\n n (int): Number of rows and columns.\n dtype: Data type specifier.\n\n Returns:\n cupy.ndarray: A 2-D identity array.\n\n .. seealso:: :func:`numpy.identity`\n\n \"\"\"\n return eye(n, dtype=dtype)\n\n\ndef ones(shape, dtype=float, order='C'):\n \"\"\"Returns a new array of given shape and dtype, filled with ones.\n\n This function currently does not support ``order`` option.\n\n Args:\n shape (int or tuple of ints): Dimensionalities of the array.\n dtype: Data type specifier.\n order ({'C', 'F'}): Row-major (C-style) or column-major\n (Fortran-style) order.\n\n Returns:\n cupy.ndarray: An array filled with ones.\n\n .. seealso:: :func:`numpy.ones`\n\n \"\"\"\n a = cupy.ndarray(shape, dtype, order=order)\n a.fill(1)\n return a\n\n\ndef ones_like(a, dtype=None, order='K', subok=None, shape=None):\n \"\"\"Returns an array of ones with same shape and dtype as a given array.\n\n This function currently does not support ``subok`` option.\n\n Args:\n a (cupy.ndarray): Base array.\n dtype: Data type specifier. The dtype of ``a`` is used by default.\n order ({'C', 'F', 'A', or 'K'}): Overrides the memory layout of the\n result. ``'C'`` means C-order, ``'F'`` means F-order, ``'A'`` means\n ``'F'`` if ``a`` is Fortran contiguous, ``'C'`` otherwise.\n ``'K'`` means match the layout of ``a`` as closely as possible.\n subok: Not supported yet, must be None.\n shape (int or tuple of ints): Overrides the shape of the result. If\n ``order='K'`` and the number of dimensions is unchanged, will try\n to keep order, otherwise, ``order='C'`` is implied.\n\n Returns:\n cupy.ndarray: An array filled with ones.\n\n .. seealso:: :func:`numpy.ones_like`\n\n \"\"\"\n if subok is not None:\n raise TypeError('subok is not supported yet')\n if dtype is None:\n dtype = a.dtype\n\n order, strides, memptr = _new_like_order_and_strides(a, dtype, order,\n shape)\n shape = shape if shape else a.shape\n a = cupy.ndarray(shape, dtype, memptr, strides, order)\n a.fill(1)\n return a\n\n\ndef zeros(shape, dtype=float, order='C'):\n \"\"\"Returns a new array of given shape and dtype, filled with zeros.\n\n Args:\n shape (int or tuple of ints): Dimensionalities of the array.\n dtype: Data type specifier.\n order ({'C', 'F'}): Row-major (C-style) or column-major\n (Fortran-style) order.\n\n Returns:\n cupy.ndarray: An array filled with zeros.\n\n .. seealso:: :func:`numpy.zeros`\n\n \"\"\"\n a = cupy.ndarray(shape, dtype, order=order)\n a.data.memset_async(0, a.nbytes)\n return a\n\n\ndef zeros_like(a, dtype=None, order='K', subok=None, shape=None):\n \"\"\"Returns an array of zeros with same shape and dtype as a given array.\n\n This function currently does not support ``subok`` option.\n\n Args:\n a (cupy.ndarray): Base array.\n dtype: Data type specifier. The dtype of ``a`` is used by default.\n order ({'C', 'F', 'A', or 'K'}): Overrides the memory layout of the\n result. ``'C'`` means C-order, ``'F'`` means F-order, ``'A'`` means\n ``'F'`` if ``a`` is Fortran contiguous, ``'C'`` otherwise.\n ``'K'`` means match the layout of ``a`` as closely as possible.\n subok: Not supported yet, must be None.\n shape (int or tuple of ints): Overrides the shape of the result. If\n ``order='K'`` and the number of dimensions is unchanged, will try\n to keep order, otherwise, ``order='C'`` is implied.\n\n Returns:\n cupy.ndarray: An array filled with zeros.\n\n .. seealso:: :func:`numpy.zeros_like`\n\n \"\"\"\n if subok is not None:\n raise TypeError('subok is not supported yet')\n if dtype is None:\n dtype = a.dtype\n\n order, strides, memptr = _new_like_order_and_strides(a, dtype, order,\n shape)\n shape = shape if shape else a.shape\n a = cupy.ndarray(shape, dtype, memptr, strides, order)\n a.data.memset_async(0, a.nbytes)\n return a\n\n\ndef full(shape, fill_value, dtype=None, order='C'):\n \"\"\"Returns a new array of given shape and dtype, filled with a given value.\n\n This function currently does not support ``order`` option.\n\n Args:\n shape (int or tuple of ints): Dimensionalities of the array.\n fill_value: A scalar value to fill a new array.\n dtype: Data type specifier.\n order ({'C', 'F'}): Row-major (C-style) or column-major\n (Fortran-style) order.\n\n Returns:\n cupy.ndarray: An array filled with ``fill_value``.\n\n .. seealso:: :func:`numpy.full`\n\n \"\"\"\n if dtype is None:\n if isinstance(fill_value, cupy.ndarray):\n dtype = fill_value.dtype\n else:\n dtype = numpy.array(fill_value).dtype\n a = cupy.ndarray(shape, dtype, order=order)\n a.fill(fill_value)\n return a\n\n\ndef full_like(a, fill_value, dtype=None, order='K', subok=None, shape=None):\n \"\"\"Returns a full array with same shape and dtype as a given array.\n\n This function currently does not support ``subok`` option.\n\n Args:\n a (cupy.ndarray): Base array.\n fill_value: A scalar value to fill a new array.\n dtype: Data type specifier. The dtype of ``a`` is used by default.\n order ({'C', 'F', 'A', or 'K'}): Overrides the memory layout of the\n result. ``'C'`` means C-order, ``'F'`` means F-order, ``'A'`` means\n ``'F'`` if ``a`` is Fortran contiguous, ``'C'`` otherwise.\n ``'K'`` means match the layout of ``a`` as closely as possible.\n subok: Not supported yet, must be None.\n shape (int or tuple of ints): Overrides the shape of the result. If\n ``order='K'`` and the number of dimensions is unchanged, will try\n to keep order, otherwise, ``order='C'`` is implied.\n\n Returns:\n cupy.ndarray: An array filled with ``fill_value``.\n\n .. seealso:: :func:`numpy.full_like`\n\n \"\"\"\n if subok is not None:\n raise TypeError('subok is not supported yet')\n if dtype is None:\n dtype = a.dtype\n\n order, strides, memptr = _new_like_order_and_strides(a, dtype, order,\n shape)\n shape = shape if shape else a.shape\n a = cupy.ndarray(shape, dtype, memptr, strides, order)\n a.fill(fill_value)\n return a\n", "path": "cupy/_creation/basic.py"}], "after_files": [{"content": "import numpy\n\nimport cupy\nfrom cupy._core.internal import _get_strides_for_order_K, _update_order_char\n\n\ndef empty(shape, dtype=float, order='C'):\n \"\"\"Returns an array without initializing the elements.\n\n Args:\n shape (int or tuple of ints): Dimensionalities of the array.\n dtype: Data type specifier.\n order ({'C', 'F'}): Row-major (C-style) or column-major\n (Fortran-style) order.\n\n Returns:\n cupy.ndarray: A new array with elements not initialized.\n\n .. seealso:: :func:`numpy.empty`\n\n \"\"\"\n return cupy.ndarray(shape, dtype, order=order)\n\n\ndef _new_like_order_and_strides(\n a, dtype, order, shape=None, *, get_memptr=True):\n \"\"\"\n Determine order and strides as in NumPy's PyArray_NewLikeArray.\n\n (see: numpy/core/src/multiarray/ctors.c)\n \"\"\"\n order = order.upper()\n if order not in ['C', 'F', 'K', 'A']:\n raise ValueError('order not understood: {}'.format(order))\n\n if numpy.isscalar(shape):\n shape = (shape,)\n\n # Fallback to c_contiguous if keep order and number of dimensions\n # of new shape mismatch\n if order == 'K' and shape is not None and len(shape) != a.ndim:\n return 'C', None, None\n\n order = chr(_update_order_char(\n a.flags.c_contiguous, a.flags.f_contiguous, ord(order)))\n\n if order == 'K':\n strides = _get_strides_for_order_K(a, numpy.dtype(dtype), shape)\n order = 'C'\n memptr = cupy.empty(a.size, dtype=dtype).data if get_memptr else None\n return order, strides, memptr\n else:\n return order, None, None\n\n\ndef empty_like(a, dtype=None, order='K', subok=None, shape=None):\n \"\"\"Returns a new array with same shape and dtype of a given array.\n\n This function currently does not support ``subok`` option.\n\n Args:\n a (cupy.ndarray): Base array.\n dtype: Data type specifier. The data type of ``a`` is used by default.\n order ({'C', 'F', 'A', or 'K'}): Overrides the memory layout of the\n result. ``'C'`` means C-order, ``'F'`` means F-order, ``'A'`` means\n ``'F'`` if ``a`` is Fortran contiguous, ``'C'`` otherwise.\n ``'K'`` means match the layout of ``a`` as closely as possible.\n subok: Not supported yet, must be None.\n shape (int or tuple of ints): Overrides the shape of the result. If\n ``order='K'`` and the number of dimensions is unchanged, will try\n to keep order, otherwise, ``order='C'`` is implied.\n\n Returns:\n cupy.ndarray: A new array with same shape and dtype of ``a`` with\n elements not initialized.\n\n .. seealso:: :func:`numpy.empty_like`\n\n \"\"\"\n if subok is not None:\n raise TypeError('subok is not supported yet')\n if dtype is None:\n dtype = a.dtype\n\n order, strides, memptr = _new_like_order_and_strides(a, dtype, order,\n shape)\n shape = shape if shape else a.shape\n return cupy.ndarray(shape, dtype, memptr, strides, order)\n\n\ndef eye(N, M=None, k=0, dtype=float, order='C'):\n \"\"\"Returns a 2-D array with ones on the diagonals and zeros elsewhere.\n\n Args:\n N (int): Number of rows.\n M (int): Number of columns. ``M == N`` by default.\n k (int): Index of the diagonal. Zero indicates the main diagonal,\n a positive index an upper diagonal, and a negative index a lower\n diagonal.\n dtype: Data type specifier.\n order ({'C', 'F'}): Row-major (C-style) or column-major\n (Fortran-style) order.\n\n Returns:\n cupy.ndarray: A 2-D array with given diagonals filled with ones and\n zeros elsewhere.\n\n .. seealso:: :func:`numpy.eye`\n\n \"\"\"\n if M is None:\n M = N\n ret = zeros((N, M), dtype=dtype, order=order)\n if k <= -N or k >= M:\n return ret\n ret.diagonal(k)[:] = 1\n return ret\n\n\ndef identity(n, dtype=float):\n \"\"\"Returns a 2-D identity array.\n\n It is equivalent to ``eye(n, n, dtype)``.\n\n Args:\n n (int): Number of rows and columns.\n dtype: Data type specifier.\n\n Returns:\n cupy.ndarray: A 2-D identity array.\n\n .. seealso:: :func:`numpy.identity`\n\n \"\"\"\n return eye(n, dtype=dtype)\n\n\ndef ones(shape, dtype=float, order='C'):\n \"\"\"Returns a new array of given shape and dtype, filled with ones.\n\n This function currently does not support ``order`` option.\n\n Args:\n shape (int or tuple of ints): Dimensionalities of the array.\n dtype: Data type specifier.\n order ({'C', 'F'}): Row-major (C-style) or column-major\n (Fortran-style) order.\n\n Returns:\n cupy.ndarray: An array filled with ones.\n\n .. seealso:: :func:`numpy.ones`\n\n \"\"\"\n a = cupy.ndarray(shape, dtype, order=order)\n a.fill(1)\n return a\n\n\ndef ones_like(a, dtype=None, order='K', subok=None, shape=None):\n \"\"\"Returns an array of ones with same shape and dtype as a given array.\n\n This function currently does not support ``subok`` option.\n\n Args:\n a (cupy.ndarray): Base array.\n dtype: Data type specifier. The dtype of ``a`` is used by default.\n order ({'C', 'F', 'A', or 'K'}): Overrides the memory layout of the\n result. ``'C'`` means C-order, ``'F'`` means F-order, ``'A'`` means\n ``'F'`` if ``a`` is Fortran contiguous, ``'C'`` otherwise.\n ``'K'`` means match the layout of ``a`` as closely as possible.\n subok: Not supported yet, must be None.\n shape (int or tuple of ints): Overrides the shape of the result. If\n ``order='K'`` and the number of dimensions is unchanged, will try\n to keep order, otherwise, ``order='C'`` is implied.\n\n Returns:\n cupy.ndarray: An array filled with ones.\n\n .. seealso:: :func:`numpy.ones_like`\n\n \"\"\"\n if subok is not None:\n raise TypeError('subok is not supported yet')\n if dtype is None:\n dtype = a.dtype\n\n order, strides, memptr = _new_like_order_and_strides(a, dtype, order,\n shape)\n shape = shape if shape else a.shape\n a = cupy.ndarray(shape, dtype, memptr, strides, order)\n a.fill(1)\n return a\n\n\ndef zeros(shape, dtype=float, order='C'):\n \"\"\"Returns a new array of given shape and dtype, filled with zeros.\n\n Args:\n shape (int or tuple of ints): Dimensionalities of the array.\n dtype: Data type specifier.\n order ({'C', 'F'}): Row-major (C-style) or column-major\n (Fortran-style) order.\n\n Returns:\n cupy.ndarray: An array filled with zeros.\n\n .. seealso:: :func:`numpy.zeros`\n\n \"\"\"\n a = cupy.ndarray(shape, dtype, order=order)\n a.data.memset_async(0, a.nbytes)\n return a\n\n\ndef zeros_like(a, dtype=None, order='K', subok=None, shape=None):\n \"\"\"Returns an array of zeros with same shape and dtype as a given array.\n\n This function currently does not support ``subok`` option.\n\n Args:\n a (cupy.ndarray): Base array.\n dtype: Data type specifier. The dtype of ``a`` is used by default.\n order ({'C', 'F', 'A', or 'K'}): Overrides the memory layout of the\n result. ``'C'`` means C-order, ``'F'`` means F-order, ``'A'`` means\n ``'F'`` if ``a`` is Fortran contiguous, ``'C'`` otherwise.\n ``'K'`` means match the layout of ``a`` as closely as possible.\n subok: Not supported yet, must be None.\n shape (int or tuple of ints): Overrides the shape of the result. If\n ``order='K'`` and the number of dimensions is unchanged, will try\n to keep order, otherwise, ``order='C'`` is implied.\n\n Returns:\n cupy.ndarray: An array filled with zeros.\n\n .. seealso:: :func:`numpy.zeros_like`\n\n \"\"\"\n if subok is not None:\n raise TypeError('subok is not supported yet')\n if dtype is None:\n dtype = a.dtype\n\n order, strides, memptr = _new_like_order_and_strides(a, dtype, order,\n shape)\n shape = shape if shape else a.shape\n a = cupy.ndarray(shape, dtype, memptr, strides, order)\n a.data.memset_async(0, a.nbytes)\n return a\n\n\ndef full(shape, fill_value, dtype=None, order='C'):\n \"\"\"Returns a new array of given shape and dtype, filled with a given value.\n\n This function currently does not support ``order`` option.\n\n Args:\n shape (int or tuple of ints): Dimensionalities of the array.\n fill_value: A scalar value to fill a new array.\n dtype: Data type specifier.\n order ({'C', 'F'}): Row-major (C-style) or column-major\n (Fortran-style) order.\n\n Returns:\n cupy.ndarray: An array filled with ``fill_value``.\n\n .. seealso:: :func:`numpy.full`\n\n \"\"\"\n if dtype is None:\n if isinstance(fill_value, cupy.ndarray):\n dtype = fill_value.dtype\n else:\n dtype = numpy.array(fill_value).dtype\n a = cupy.ndarray(shape, dtype, order=order)\n a.fill(fill_value)\n return a\n\n\ndef full_like(a, fill_value, dtype=None, order='K', subok=None, shape=None):\n \"\"\"Returns a full array with same shape and dtype as a given array.\n\n This function currently does not support ``subok`` option.\n\n Args:\n a (cupy.ndarray): Base array.\n fill_value: A scalar value to fill a new array.\n dtype: Data type specifier. The dtype of ``a`` is used by default.\n order ({'C', 'F', 'A', or 'K'}): Overrides the memory layout of the\n result. ``'C'`` means C-order, ``'F'`` means F-order, ``'A'`` means\n ``'F'`` if ``a`` is Fortran contiguous, ``'C'`` otherwise.\n ``'K'`` means match the layout of ``a`` as closely as possible.\n subok: Not supported yet, must be None.\n shape (int or tuple of ints): Overrides the shape of the result. If\n ``order='K'`` and the number of dimensions is unchanged, will try\n to keep order, otherwise, ``order='C'`` is implied.\n\n Returns:\n cupy.ndarray: An array filled with ``fill_value``.\n\n .. seealso:: :func:`numpy.full_like`\n\n \"\"\"\n if subok is not None:\n raise TypeError('subok is not supported yet')\n if dtype is None:\n dtype = a.dtype\n\n order, strides, memptr = _new_like_order_and_strides(a, dtype, order,\n shape)\n shape = shape if shape else a.shape\n a = cupy.ndarray(shape, dtype, memptr, strides, order)\n a.fill(fill_value)\n return a\n", "path": "cupy/_creation/basic.py"}]} |
gh_patches_debug_249 | rasdani/github-patches | git_diff | inventree__InvenTree-1544 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[BUG] invoke: too many arguments
When running any invoke-command in an WSL-Enviroment I get the following error:
`/bin/bash: line 0: cd: too many arguments`
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `tasks.py`
Content:
```
1 # -*- coding: utf-8 -*-
2
3 from shutil import copyfile
4 import os
5 import json
6 import sys
7
8 try:
9 from invoke import ctask as task
10 except:
11 from invoke import task
12
13
14 def apps():
15 """
16 Returns a list of installed apps
17 """
18
19 return [
20 'barcode',
21 'build',
22 'common',
23 'company',
24 'label',
25 'order',
26 'part',
27 'report',
28 'stock',
29 'InvenTree',
30 'users',
31 ]
32
33
34 def localDir():
35 """
36 Returns the directory of *THIS* file.
37 Used to ensure that the various scripts always run
38 in the correct directory.
39 """
40 return os.path.dirname(os.path.abspath(__file__))
41
42
43 def managePyDir():
44 """
45 Returns the directory of the manage.py file
46 """
47
48 return os.path.join(localDir(), 'InvenTree')
49
50
51 def managePyPath():
52 """
53 Return the path of the manage.py file
54 """
55
56 return os.path.join(managePyDir(), 'manage.py')
57
58
59 def manage(c, cmd, pty=False):
60 """
61 Runs a given command against django's "manage.py" script.
62
63 Args:
64 c - Command line context
65 cmd - django command to run
66 """
67
68 c.run('cd {path} && python3 manage.py {cmd}'.format(
69 path=managePyDir(),
70 cmd=cmd
71 ), pty=pty)
72
73
74 @task
75 def install(c):
76 """
77 Installs required python packages
78 """
79
80 # Install required Python packages with PIP
81 c.run('pip3 install -U -r requirements.txt')
82
83 # If a config.yaml file does not exist, copy from the template!
84 CONFIG_FILE = os.path.join(localDir(), 'InvenTree', 'config.yaml')
85 CONFIG_TEMPLATE_FILE = os.path.join(localDir(), 'InvenTree', 'config_template.yaml')
86
87 if not os.path.exists(CONFIG_FILE):
88 print("Config file 'config.yaml' does not exist - copying from template.")
89 copyfile(CONFIG_TEMPLATE_FILE, CONFIG_FILE)
90
91
92 @task
93 def shell(c):
94 """
95 Open a python shell with access to the InvenTree database models.
96 """
97
98 manage(c, 'shell', pty=True)
99
100 @task
101 def worker(c):
102 """
103 Run the InvenTree background worker process
104 """
105
106 manage(c, 'qcluster', pty=True)
107
108 @task
109 def superuser(c):
110 """
111 Create a superuser (admin) account for the database.
112 """
113
114 manage(c, 'createsuperuser', pty=True)
115
116 @task
117 def check(c):
118 """
119 Check validity of django codebase
120 """
121
122 manage(c, "check")
123
124 @task
125 def wait(c):
126 """
127 Wait until the database connection is ready
128 """
129
130 manage(c, "wait_for_db")
131
132 @task
133 def migrate(c):
134 """
135 Performs database migrations.
136 This is a critical step if the database schema have been altered!
137 """
138
139 print("Running InvenTree database migrations...")
140 print("========================================")
141
142 manage(c, "makemigrations")
143 manage(c, "migrate")
144 manage(c, "migrate --run-syncdb")
145 manage(c, "check")
146
147 print("========================================")
148 print("InvenTree database migrations completed!")
149
150
151 @task
152 def static(c):
153 """
154 Copies required static files to the STATIC_ROOT directory,
155 as per Django requirements.
156 """
157
158 manage(c, "prerender")
159 manage(c, "collectstatic --no-input")
160
161
162 @task(pre=[install, migrate, static])
163 def update(c):
164 """
165 Update InvenTree installation.
166
167 This command should be invoked after source code has been updated,
168 e.g. downloading new code from GitHub.
169
170 The following tasks are performed, in order:
171
172 - install
173 - migrate
174 - static
175 """
176 pass
177
178 @task(post=[static])
179 def translate(c):
180 """
181 Regenerate translation files.
182
183 Run this command after added new translatable strings,
184 or after adding translations for existing strings.
185 """
186
187 # Translate applicable .py / .html / .js files
188 manage(c, "makemessages --all -e py,html,js")
189 manage(c, "compilemessages")
190
191 path = os.path.join('InvenTree', 'script', 'translation_stats.py')
192
193 c.run(f'python {path}')
194
195 @task
196 def style(c):
197 """
198 Run PEP style checks against InvenTree sourcecode
199 """
200
201 print("Running PEP style checks...")
202 c.run('flake8 InvenTree')
203
204 @task
205 def test(c, database=None):
206 """
207 Run unit-tests for InvenTree codebase.
208 """
209 # Run sanity check on the django install
210 manage(c, 'check')
211
212 # Run coverage tests
213 manage(c, 'test', pty=True)
214
215 @task
216 def coverage(c):
217 """
218 Run code-coverage of the InvenTree codebase,
219 using the 'coverage' code-analysis tools.
220
221 Generates a code coverage report (available in the htmlcov directory)
222 """
223
224 # Run sanity check on the django install
225 manage(c, 'check')
226
227 # Run coverage tests
228 c.run('coverage run {manage} test {apps}'.format(
229 manage=managePyPath(),
230 apps=' '.join(apps())
231 ))
232
233 # Generate coverage report
234 c.run('coverage html')
235
236
237 def content_excludes():
238 """
239 Returns a list of content types to exclude from import/export
240 """
241
242 excludes = [
243 "contenttypes",
244 "sessions.session",
245 "auth.permission",
246 "error_report.error",
247 "admin.logentry",
248 "django_q.schedule",
249 "django_q.task",
250 "django_q.ormq",
251 "users.owner",
252 ]
253
254 output = ""
255
256 for e in excludes:
257 output += f"--exclude {e} "
258
259 return output
260
261
262 @task(help={'filename': "Output filename (default = 'data.json')"})
263 def export_records(c, filename='data.json'):
264 """
265 Export all database records to a file
266 """
267
268 # Get an absolute path to the file
269 if not os.path.isabs(filename):
270 filename = os.path.join(localDir(), filename)
271 filename = os.path.abspath(filename)
272
273 print(f"Exporting database records to file '{filename}'")
274
275 if os.path.exists(filename):
276 response = input("Warning: file already exists. Do you want to overwrite? [y/N]: ")
277 response = str(response).strip().lower()
278
279 if response not in ['y', 'yes']:
280 print("Cancelled export operation")
281 sys.exit(1)
282
283 tmpfile = f"{filename}.tmp"
284
285 cmd = f"dumpdata --indent 2 --output {tmpfile} {content_excludes()}"
286
287 # Dump data to temporary file
288 manage(c, cmd, pty=True)
289
290 print("Running data post-processing step...")
291
292 # Post-process the file, to remove any "permissions" specified for a user or group
293 with open(tmpfile, "r") as f_in:
294 data = json.loads(f_in.read())
295
296 for entry in data:
297 if "model" in entry:
298
299 # Clear out any permissions specified for a group
300 if entry["model"] == "auth.group":
301 entry["fields"]["permissions"] = []
302
303 # Clear out any permissions specified for a user
304 if entry["model"] == "auth.user":
305 entry["fields"]["user_permissions"] = []
306
307 # Write the processed data to file
308 with open(filename, "w") as f_out:
309 f_out.write(json.dumps(data, indent=2))
310
311 print("Data export completed")
312
313
314 @task(help={'filename': 'Input filename'})
315 def import_records(c, filename='data.json'):
316 """
317 Import database records from a file
318 """
319
320 # Get an absolute path to the supplied filename
321 if not os.path.isabs(filename):
322 filename = os.path.join(localDir(), filename)
323
324 if not os.path.exists(filename):
325 print(f"Error: File '{filename}' does not exist")
326 sys.exit(1)
327
328 print(f"Importing database records from '{filename}'")
329
330 # Pre-process the data, to remove any "permissions" specified for a user or group
331 tmpfile = f"{filename}.tmp.json"
332
333 with open(filename, "r") as f_in:
334 data = json.loads(f_in.read())
335
336 for entry in data:
337 if "model" in entry:
338
339 # Clear out any permissions specified for a group
340 if entry["model"] == "auth.group":
341 entry["fields"]["permissions"] = []
342
343 # Clear out any permissions specified for a user
344 if entry["model"] == "auth.user":
345 entry["fields"]["user_permissions"] = []
346
347 # Write the processed data to the tmp file
348 with open(tmpfile, "w") as f_out:
349 f_out.write(json.dumps(data, indent=2))
350
351 cmd = f"loaddata {tmpfile} -i {content_excludes()}"
352
353 manage(c, cmd, pty=True)
354
355 print("Data import completed")
356
357 @task
358 def import_fixtures(c):
359 """
360 Import fixture data into the database.
361
362 This command imports all existing test fixture data into the database.
363
364 Warning:
365 - Intended for testing / development only!
366 - Running this command may overwrite existing database data!!
367 - Don't say you were not warned...
368 """
369
370 fixtures = [
371 # Build model
372 'build',
373
374 # Common models
375 'settings',
376
377 # Company model
378 'company',
379 'price_breaks',
380 'supplier_part',
381
382 # Order model
383 'order',
384
385 # Part model
386 'bom',
387 'category',
388 'params',
389 'part',
390 'test_templates',
391
392 # Stock model
393 'location',
394 'stock_tests',
395 'stock',
396
397 # Users
398 'users'
399 ]
400
401 command = 'loaddata ' + ' '.join(fixtures)
402
403 manage(c, command, pty=True)
404
405
406 @task(help={'address': 'Server address:port (default=127.0.0.1:8000)'})
407 def server(c, address="127.0.0.1:8000"):
408 """
409 Launch a (deveopment) server using Django's in-built webserver.
410
411 Note: This is *not* sufficient for a production installation.
412 """
413
414 manage(c, "runserver {address}".format(address=address), pty=True)
415
```
--- 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/tasks.py b/tasks.py
--- a/tasks.py
+++ b/tasks.py
@@ -65,7 +65,7 @@
cmd - django command to run
"""
- c.run('cd {path} && python3 manage.py {cmd}'.format(
+ c.run('cd "{path}" && python3 manage.py {cmd}'.format(
path=managePyDir(),
cmd=cmd
), pty=pty)
| {"golden_diff": "diff --git a/tasks.py b/tasks.py\n--- a/tasks.py\n+++ b/tasks.py\n@@ -65,7 +65,7 @@\n cmd - django command to run\n \"\"\"\n \n- c.run('cd {path} && python3 manage.py {cmd}'.format(\n+ c.run('cd \"{path}\" && python3 manage.py {cmd}'.format(\n path=managePyDir(),\n cmd=cmd\n ), pty=pty)\n", "issue": "[BUG] invoke: too many arguments\nWhen running any invoke-command in an WSL-Enviroment I get the following error:\r\n`/bin/bash: line 0: cd: too many arguments`\n", "before_files": [{"content": "# -*- coding: utf-8 -*-\n\nfrom shutil import copyfile\nimport os\nimport json\nimport sys\n\ntry:\n from invoke import ctask as task\nexcept:\n from invoke import task\n\n\ndef apps():\n \"\"\"\n Returns a list of installed apps\n \"\"\"\n\n return [\n 'barcode',\n 'build',\n 'common',\n 'company',\n 'label',\n 'order',\n 'part',\n 'report',\n 'stock',\n 'InvenTree',\n 'users',\n ]\n\n\ndef localDir():\n \"\"\"\n Returns the directory of *THIS* file.\n Used to ensure that the various scripts always run\n in the correct directory.\n \"\"\"\n return os.path.dirname(os.path.abspath(__file__))\n\n\ndef managePyDir():\n \"\"\"\n Returns the directory of the manage.py file\n \"\"\"\n\n return os.path.join(localDir(), 'InvenTree')\n\n\ndef managePyPath():\n \"\"\"\n Return the path of the manage.py file\n \"\"\"\n\n return os.path.join(managePyDir(), 'manage.py')\n\n\ndef manage(c, cmd, pty=False):\n \"\"\"\n Runs a given command against django's \"manage.py\" script.\n\n Args:\n c - Command line context\n cmd - django command to run\n \"\"\"\n\n c.run('cd {path} && python3 manage.py {cmd}'.format(\n path=managePyDir(),\n cmd=cmd\n ), pty=pty)\n\n\n@task\ndef install(c):\n \"\"\"\n Installs required python packages\n \"\"\"\n\n # Install required Python packages with PIP\n c.run('pip3 install -U -r requirements.txt')\n\n # If a config.yaml file does not exist, copy from the template!\n CONFIG_FILE = os.path.join(localDir(), 'InvenTree', 'config.yaml')\n CONFIG_TEMPLATE_FILE = os.path.join(localDir(), 'InvenTree', 'config_template.yaml')\n\n if not os.path.exists(CONFIG_FILE):\n print(\"Config file 'config.yaml' does not exist - copying from template.\")\n copyfile(CONFIG_TEMPLATE_FILE, CONFIG_FILE)\n\n\n@task\ndef shell(c):\n \"\"\"\n Open a python shell with access to the InvenTree database models.\n \"\"\"\n\n manage(c, 'shell', pty=True)\n\n@task\ndef worker(c):\n \"\"\"\n Run the InvenTree background worker process\n \"\"\"\n\n manage(c, 'qcluster', pty=True)\n\n@task\ndef superuser(c):\n \"\"\"\n Create a superuser (admin) account for the database.\n \"\"\"\n\n manage(c, 'createsuperuser', pty=True)\n\n@task\ndef check(c):\n \"\"\"\n Check validity of django codebase\n \"\"\"\n\n manage(c, \"check\")\n\n@task\ndef wait(c):\n \"\"\"\n Wait until the database connection is ready\n \"\"\"\n\n manage(c, \"wait_for_db\")\n\n@task\ndef migrate(c):\n \"\"\"\n Performs database migrations.\n This is a critical step if the database schema have been altered!\n \"\"\"\n\n print(\"Running InvenTree database migrations...\")\n print(\"========================================\")\n\n manage(c, \"makemigrations\")\n manage(c, \"migrate\")\n manage(c, \"migrate --run-syncdb\")\n manage(c, \"check\")\n\n print(\"========================================\")\n print(\"InvenTree database migrations completed!\")\n\n\n@task\ndef static(c):\n \"\"\"\n Copies required static files to the STATIC_ROOT directory,\n as per Django requirements.\n \"\"\"\n\n manage(c, \"prerender\")\n manage(c, \"collectstatic --no-input\")\n\n\n@task(pre=[install, migrate, static])\ndef update(c):\n \"\"\"\n Update InvenTree installation.\n\n This command should be invoked after source code has been updated,\n e.g. downloading new code from GitHub.\n\n The following tasks are performed, in order:\n\n - install\n - migrate\n - static\n \"\"\"\n pass\n\n@task(post=[static])\ndef translate(c):\n \"\"\"\n Regenerate translation files.\n\n Run this command after added new translatable strings,\n or after adding translations for existing strings.\n \"\"\"\n\n # Translate applicable .py / .html / .js files\n manage(c, \"makemessages --all -e py,html,js\")\n manage(c, \"compilemessages\")\n\n path = os.path.join('InvenTree', 'script', 'translation_stats.py')\n\n c.run(f'python {path}')\n\n@task\ndef style(c):\n \"\"\"\n Run PEP style checks against InvenTree sourcecode\n \"\"\"\n\n print(\"Running PEP style checks...\")\n c.run('flake8 InvenTree')\n\n@task\ndef test(c, database=None):\n \"\"\"\n Run unit-tests for InvenTree codebase.\n \"\"\"\n # Run sanity check on the django install\n manage(c, 'check')\n\n # Run coverage tests\n manage(c, 'test', pty=True)\n\n@task\ndef coverage(c):\n \"\"\"\n Run code-coverage of the InvenTree codebase,\n using the 'coverage' code-analysis tools.\n\n Generates a code coverage report (available in the htmlcov directory)\n \"\"\"\n\n # Run sanity check on the django install\n manage(c, 'check')\n\n # Run coverage tests\n c.run('coverage run {manage} test {apps}'.format(\n manage=managePyPath(),\n apps=' '.join(apps())\n ))\n\n # Generate coverage report\n c.run('coverage html')\n\n\ndef content_excludes():\n \"\"\"\n Returns a list of content types to exclude from import/export\n \"\"\"\n\n excludes = [\n \"contenttypes\",\n \"sessions.session\",\n \"auth.permission\",\n \"error_report.error\",\n \"admin.logentry\",\n \"django_q.schedule\",\n \"django_q.task\",\n \"django_q.ormq\",\n \"users.owner\",\n ]\n\n output = \"\"\n\n for e in excludes:\n output += f\"--exclude {e} \"\n\n return output\n\n\n@task(help={'filename': \"Output filename (default = 'data.json')\"})\ndef export_records(c, filename='data.json'):\n \"\"\"\n Export all database records to a file\n \"\"\"\n\n # Get an absolute path to the file\n if not os.path.isabs(filename):\n filename = os.path.join(localDir(), filename)\n filename = os.path.abspath(filename) \n\n print(f\"Exporting database records to file '{filename}'\")\n\n if os.path.exists(filename):\n response = input(\"Warning: file already exists. Do you want to overwrite? [y/N]: \")\n response = str(response).strip().lower()\n\n if response not in ['y', 'yes']:\n print(\"Cancelled export operation\")\n sys.exit(1)\n\n tmpfile = f\"{filename}.tmp\"\n\n cmd = f\"dumpdata --indent 2 --output {tmpfile} {content_excludes()}\"\n\n # Dump data to temporary file\n manage(c, cmd, pty=True)\n\n print(\"Running data post-processing step...\")\n\n # Post-process the file, to remove any \"permissions\" specified for a user or group\n with open(tmpfile, \"r\") as f_in:\n data = json.loads(f_in.read())\n\n for entry in data:\n if \"model\" in entry:\n \n # Clear out any permissions specified for a group\n if entry[\"model\"] == \"auth.group\":\n entry[\"fields\"][\"permissions\"] = []\n\n # Clear out any permissions specified for a user\n if entry[\"model\"] == \"auth.user\":\n entry[\"fields\"][\"user_permissions\"] = []\n\n # Write the processed data to file\n with open(filename, \"w\") as f_out:\n f_out.write(json.dumps(data, indent=2))\n\n print(\"Data export completed\")\n\n\n@task(help={'filename': 'Input filename'})\ndef import_records(c, filename='data.json'):\n \"\"\"\n Import database records from a file\n \"\"\"\n\n # Get an absolute path to the supplied filename\n if not os.path.isabs(filename):\n filename = os.path.join(localDir(), filename)\n\n if not os.path.exists(filename):\n print(f\"Error: File '{filename}' does not exist\")\n sys.exit(1)\n\n print(f\"Importing database records from '{filename}'\")\n\n # Pre-process the data, to remove any \"permissions\" specified for a user or group\n tmpfile = f\"{filename}.tmp.json\"\n\n with open(filename, \"r\") as f_in:\n data = json.loads(f_in.read())\n\n for entry in data:\n if \"model\" in entry:\n \n # Clear out any permissions specified for a group\n if entry[\"model\"] == \"auth.group\":\n entry[\"fields\"][\"permissions\"] = []\n\n # Clear out any permissions specified for a user\n if entry[\"model\"] == \"auth.user\":\n entry[\"fields\"][\"user_permissions\"] = []\n\n # Write the processed data to the tmp file\n with open(tmpfile, \"w\") as f_out:\n f_out.write(json.dumps(data, indent=2))\n\n cmd = f\"loaddata {tmpfile} -i {content_excludes()}\"\n\n manage(c, cmd, pty=True)\n\n print(\"Data import completed\")\n\n@task\ndef import_fixtures(c):\n \"\"\"\n Import fixture data into the database.\n\n This command imports all existing test fixture data into the database.\n\n Warning:\n - Intended for testing / development only!\n - Running this command may overwrite existing database data!!\n - Don't say you were not warned...\n \"\"\"\n\n fixtures = [\n # Build model\n 'build',\n \n # Common models\n 'settings',\n\n # Company model\n 'company',\n 'price_breaks',\n 'supplier_part',\n\n # Order model\n 'order',\n\n # Part model\n 'bom',\n 'category',\n 'params',\n 'part',\n 'test_templates',\n\n # Stock model\n 'location',\n 'stock_tests',\n 'stock',\n\n # Users\n 'users'\n ]\n\n command = 'loaddata ' + ' '.join(fixtures)\n\n manage(c, command, pty=True)\n\n\n@task(help={'address': 'Server address:port (default=127.0.0.1:8000)'})\ndef server(c, address=\"127.0.0.1:8000\"):\n \"\"\"\n Launch a (deveopment) server using Django's in-built webserver.\n\n Note: This is *not* sufficient for a production installation.\n \"\"\"\n\n manage(c, \"runserver {address}\".format(address=address), pty=True)\n", "path": "tasks.py"}], "after_files": [{"content": "# -*- coding: utf-8 -*-\n\nfrom shutil import copyfile\nimport os\nimport json\nimport sys\n\ntry:\n from invoke import ctask as task\nexcept:\n from invoke import task\n\n\ndef apps():\n \"\"\"\n Returns a list of installed apps\n \"\"\"\n\n return [\n 'barcode',\n 'build',\n 'common',\n 'company',\n 'label',\n 'order',\n 'part',\n 'report',\n 'stock',\n 'InvenTree',\n 'users',\n ]\n\n\ndef localDir():\n \"\"\"\n Returns the directory of *THIS* file.\n Used to ensure that the various scripts always run\n in the correct directory.\n \"\"\"\n return os.path.dirname(os.path.abspath(__file__))\n\n\ndef managePyDir():\n \"\"\"\n Returns the directory of the manage.py file\n \"\"\"\n\n return os.path.join(localDir(), 'InvenTree')\n\n\ndef managePyPath():\n \"\"\"\n Return the path of the manage.py file\n \"\"\"\n\n return os.path.join(managePyDir(), 'manage.py')\n\n\ndef manage(c, cmd, pty=False):\n \"\"\"\n Runs a given command against django's \"manage.py\" script.\n\n Args:\n c - Command line context\n cmd - django command to run\n \"\"\"\n\n c.run('cd \"{path}\" && python3 manage.py {cmd}'.format(\n path=managePyDir(),\n cmd=cmd\n ), pty=pty)\n\n\n@task\ndef install(c):\n \"\"\"\n Installs required python packages\n \"\"\"\n\n # Install required Python packages with PIP\n c.run('pip3 install -U -r requirements.txt')\n\n # If a config.yaml file does not exist, copy from the template!\n CONFIG_FILE = os.path.join(localDir(), 'InvenTree', 'config.yaml')\n CONFIG_TEMPLATE_FILE = os.path.join(localDir(), 'InvenTree', 'config_template.yaml')\n\n if not os.path.exists(CONFIG_FILE):\n print(\"Config file 'config.yaml' does not exist - copying from template.\")\n copyfile(CONFIG_TEMPLATE_FILE, CONFIG_FILE)\n\n\n@task\ndef shell(c):\n \"\"\"\n Open a python shell with access to the InvenTree database models.\n \"\"\"\n\n manage(c, 'shell', pty=True)\n\n@task\ndef worker(c):\n \"\"\"\n Run the InvenTree background worker process\n \"\"\"\n\n manage(c, 'qcluster', pty=True)\n\n@task\ndef superuser(c):\n \"\"\"\n Create a superuser (admin) account for the database.\n \"\"\"\n\n manage(c, 'createsuperuser', pty=True)\n\n@task\ndef check(c):\n \"\"\"\n Check validity of django codebase\n \"\"\"\n\n manage(c, \"check\")\n\n@task\ndef wait(c):\n \"\"\"\n Wait until the database connection is ready\n \"\"\"\n\n manage(c, \"wait_for_db\")\n\n@task\ndef migrate(c):\n \"\"\"\n Performs database migrations.\n This is a critical step if the database schema have been altered!\n \"\"\"\n\n print(\"Running InvenTree database migrations...\")\n print(\"========================================\")\n\n manage(c, \"makemigrations\")\n manage(c, \"migrate\")\n manage(c, \"migrate --run-syncdb\")\n manage(c, \"check\")\n\n print(\"========================================\")\n print(\"InvenTree database migrations completed!\")\n\n\n@task\ndef static(c):\n \"\"\"\n Copies required static files to the STATIC_ROOT directory,\n as per Django requirements.\n \"\"\"\n\n manage(c, \"prerender\")\n manage(c, \"collectstatic --no-input\")\n\n\n@task(pre=[install, migrate, static])\ndef update(c):\n \"\"\"\n Update InvenTree installation.\n\n This command should be invoked after source code has been updated,\n e.g. downloading new code from GitHub.\n\n The following tasks are performed, in order:\n\n - install\n - migrate\n - static\n \"\"\"\n pass\n\n@task(post=[static])\ndef translate(c):\n \"\"\"\n Regenerate translation files.\n\n Run this command after added new translatable strings,\n or after adding translations for existing strings.\n \"\"\"\n\n # Translate applicable .py / .html / .js files\n manage(c, \"makemessages --all -e py,html,js\")\n manage(c, \"compilemessages\")\n\n path = os.path.join('InvenTree', 'script', 'translation_stats.py')\n\n c.run(f'python {path}')\n\n@task\ndef style(c):\n \"\"\"\n Run PEP style checks against InvenTree sourcecode\n \"\"\"\n\n print(\"Running PEP style checks...\")\n c.run('flake8 InvenTree')\n\n@task\ndef test(c, database=None):\n \"\"\"\n Run unit-tests for InvenTree codebase.\n \"\"\"\n # Run sanity check on the django install\n manage(c, 'check')\n\n # Run coverage tests\n manage(c, 'test', pty=True)\n\n@task\ndef coverage(c):\n \"\"\"\n Run code-coverage of the InvenTree codebase,\n using the 'coverage' code-analysis tools.\n\n Generates a code coverage report (available in the htmlcov directory)\n \"\"\"\n\n # Run sanity check on the django install\n manage(c, 'check')\n\n # Run coverage tests\n c.run('coverage run {manage} test {apps}'.format(\n manage=managePyPath(),\n apps=' '.join(apps())\n ))\n\n # Generate coverage report\n c.run('coverage html')\n\n\ndef content_excludes():\n \"\"\"\n Returns a list of content types to exclude from import/export\n \"\"\"\n\n excludes = [\n \"contenttypes\",\n \"sessions.session\",\n \"auth.permission\",\n \"error_report.error\",\n \"admin.logentry\",\n \"django_q.schedule\",\n \"django_q.task\",\n \"django_q.ormq\",\n \"users.owner\",\n ]\n\n output = \"\"\n\n for e in excludes:\n output += f\"--exclude {e} \"\n\n return output\n\n\n@task(help={'filename': \"Output filename (default = 'data.json')\"})\ndef export_records(c, filename='data.json'):\n \"\"\"\n Export all database records to a file\n \"\"\"\n\n # Get an absolute path to the file\n if not os.path.isabs(filename):\n filename = os.path.join(localDir(), filename)\n filename = os.path.abspath(filename) \n\n print(f\"Exporting database records to file '{filename}'\")\n\n if os.path.exists(filename):\n response = input(\"Warning: file already exists. Do you want to overwrite? [y/N]: \")\n response = str(response).strip().lower()\n\n if response not in ['y', 'yes']:\n print(\"Cancelled export operation\")\n sys.exit(1)\n\n tmpfile = f\"{filename}.tmp\"\n\n cmd = f\"dumpdata --indent 2 --output {tmpfile} {content_excludes()}\"\n\n # Dump data to temporary file\n manage(c, cmd, pty=True)\n\n print(\"Running data post-processing step...\")\n\n # Post-process the file, to remove any \"permissions\" specified for a user or group\n with open(tmpfile, \"r\") as f_in:\n data = json.loads(f_in.read())\n\n for entry in data:\n if \"model\" in entry:\n \n # Clear out any permissions specified for a group\n if entry[\"model\"] == \"auth.group\":\n entry[\"fields\"][\"permissions\"] = []\n\n # Clear out any permissions specified for a user\n if entry[\"model\"] == \"auth.user\":\n entry[\"fields\"][\"user_permissions\"] = []\n\n # Write the processed data to file\n with open(filename, \"w\") as f_out:\n f_out.write(json.dumps(data, indent=2))\n\n print(\"Data export completed\")\n\n\n@task(help={'filename': 'Input filename'})\ndef import_records(c, filename='data.json'):\n \"\"\"\n Import database records from a file\n \"\"\"\n\n # Get an absolute path to the supplied filename\n if not os.path.isabs(filename):\n filename = os.path.join(localDir(), filename)\n\n if not os.path.exists(filename):\n print(f\"Error: File '{filename}' does not exist\")\n sys.exit(1)\n\n print(f\"Importing database records from '{filename}'\")\n\n # Pre-process the data, to remove any \"permissions\" specified for a user or group\n tmpfile = f\"{filename}.tmp.json\"\n\n with open(filename, \"r\") as f_in:\n data = json.loads(f_in.read())\n\n for entry in data:\n if \"model\" in entry:\n \n # Clear out any permissions specified for a group\n if entry[\"model\"] == \"auth.group\":\n entry[\"fields\"][\"permissions\"] = []\n\n # Clear out any permissions specified for a user\n if entry[\"model\"] == \"auth.user\":\n entry[\"fields\"][\"user_permissions\"] = []\n\n # Write the processed data to the tmp file\n with open(tmpfile, \"w\") as f_out:\n f_out.write(json.dumps(data, indent=2))\n\n cmd = f\"loaddata {tmpfile} -i {content_excludes()}\"\n\n manage(c, cmd, pty=True)\n\n print(\"Data import completed\")\n\n@task\ndef import_fixtures(c):\n \"\"\"\n Import fixture data into the database.\n\n This command imports all existing test fixture data into the database.\n\n Warning:\n - Intended for testing / development only!\n - Running this command may overwrite existing database data!!\n - Don't say you were not warned...\n \"\"\"\n\n fixtures = [\n # Build model\n 'build',\n \n # Common models\n 'settings',\n\n # Company model\n 'company',\n 'price_breaks',\n 'supplier_part',\n\n # Order model\n 'order',\n\n # Part model\n 'bom',\n 'category',\n 'params',\n 'part',\n 'test_templates',\n\n # Stock model\n 'location',\n 'stock_tests',\n 'stock',\n\n # Users\n 'users'\n ]\n\n command = 'loaddata ' + ' '.join(fixtures)\n\n manage(c, command, pty=True)\n\n\n@task(help={'address': 'Server address:port (default=127.0.0.1:8000)'})\ndef server(c, address=\"127.0.0.1:8000\"):\n \"\"\"\n Launch a (deveopment) server using Django's in-built webserver.\n\n Note: This is *not* sufficient for a production installation.\n \"\"\"\n\n manage(c, \"runserver {address}\".format(address=address), pty=True)\n", "path": "tasks.py"}]} |
gh_patches_debug_250 | rasdani/github-patches | git_diff | Pycord-Development__pycord-1381 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
`ScheduledEvent` object has not attribute `_image`
### Summary
Title explains it
### Reproduction Steps
i used jishaku `jsk py _ctx.guild.scheduled_events[0].cover`
### Minimal Reproducible Code
_No response_
### Expected Results
I was expecting it to return assets
### Actual Results
it returned an error saying that `ScheduledEvents` object has no attribute `_image`
### Intents
this bot has all intents enabled
### System Information
- Python v3.10.4-final
- py-cord v2.0.0-candidate
- py-cord pkg_resources: v2.0.0rc1
- aiohttp v3.8.1
- system info: Windows 10 10.0.22000
### Checklist
- [X] I have searched the open issues for duplicates.
- [X] I have shown the entire traceback, if possible.
- [X] I have removed my token from display, if visible.
### Additional Context
so i was checking the source code and i realized that here:
```py
return Asset._from_scheduled_event_cover(
self._state,
self.id,
self._image,
)
```
`self._image` is actually **not** defined.
So I tried to change it to `self._cover` and it worked! I'm making a PR for this as well, for you guys to look into it. If it works, feel free to merge 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: `discord/scheduled_events.py`
Content:
```
1 """
2 The MIT License (MIT)
3
4 Copyright (c) 2021-present Pycord Development
5
6 Permission is hereby granted, free of charge, to any person obtaining a
7 copy of this software and associated documentation files (the "Software"),
8 to deal in the Software without restriction, including without limitation
9 the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 and/or sell copies of the Software, and to permit persons to whom the
11 Software is furnished to do so, subject to the following conditions:
12
13 The above copyright notice and this permission notice shall be included in
14 all copies or substantial portions of the Software.
15
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 DEALINGS IN THE SOFTWARE.
23 """
24
25 from __future__ import annotations
26
27 import datetime
28 from typing import TYPE_CHECKING, Any, Dict, Optional, Union
29
30 from . import utils
31 from .asset import Asset
32 from .enums import (
33 ScheduledEventLocationType,
34 ScheduledEventPrivacyLevel,
35 ScheduledEventStatus,
36 try_enum,
37 )
38 from .errors import ValidationError
39 from .iterators import ScheduledEventSubscribersIterator
40 from .mixins import Hashable
41 from .object import Object
42
43 __all__ = (
44 "ScheduledEvent",
45 "ScheduledEventLocation",
46 )
47
48 if TYPE_CHECKING:
49 from .abc import Snowflake
50 from .guild import Guild
51 from .iterators import AsyncIterator
52 from .member import Member
53 from .state import ConnectionState
54 from .types.channel import StageChannel, VoiceChannel
55 from .types.scheduled_events import ScheduledEvent as ScheduledEventPayload
56
57 MISSING = utils.MISSING
58
59
60 class ScheduledEventLocation:
61 """Represents a scheduled event's location.
62
63 Setting the ``value`` to its corresponding type will set the location type automatically:
64
65 +------------------------+---------------------------------------------------+
66 | Type of Input | Location Type |
67 +========================+===================================================+
68 | :class:`StageChannel`: | :attr:`ScheduledEventLocationType.stage_instance` |
69 | :class:`VoiceChannel`: | :attr:`ScheduledEventLocationType.voice` |
70 | :class:`str`: | :attr:`ScheduledEventLocationType.external` |
71 +------------------------+---------------------------------------------------+
72
73 .. versionadded:: 2.0
74
75 Attributes
76 ----------
77 value: Union[:class:`str`, :class:`StageChannel`, :class:`VoiceChannel`, :class:`Object`]
78 The actual location of the scheduled event.
79 type: :class:`ScheduledEventLocationType`
80 The type of location.
81 """
82
83 __slots__ = (
84 "_state",
85 "value",
86 )
87
88 def __init__(
89 self,
90 *,
91 state: ConnectionState,
92 value: Union[str, int, StageChannel, VoiceChannel],
93 ):
94 self._state = state
95 self.value: Union[str, StageChannel, VoiceChannel, Object]
96 if isinstance(value, int):
97 self.value = self._state.get_channel(id=int(value)) or Object(id=int(value))
98 else:
99 self.value = value
100
101 def __repr__(self) -> str:
102 return f"<ScheduledEventLocation value={self.value!r} type={self.type}>"
103
104 def __str__(self) -> str:
105 return str(self.value)
106
107 @property
108 def type(self) -> ScheduledEventLocationType:
109 if isinstance(self.value, str):
110 return ScheduledEventLocationType.external
111 elif self.value.__class__.__name__ == "StageChannel":
112 return ScheduledEventLocationType.stage_instance
113 elif self.value.__class__.__name__ == "VoiceChannel":
114 return ScheduledEventLocationType.voice
115
116
117 class ScheduledEvent(Hashable):
118 """Represents a Discord Guild Scheduled Event.
119
120 .. container:: operations
121
122 .. describe:: x == y
123
124 Checks if two scheduled events are equal.
125
126 .. describe:: x != y
127
128 Checks if two scheduled events are not equal.
129
130 .. describe:: hash(x)
131
132 Returns the scheduled event's hash.
133
134 .. describe:: str(x)
135
136 Returns the scheduled event's name.
137
138 .. versionadded:: 2.0
139
140 Attributes
141 ----------
142 guild: :class:`Guild`
143 The guild where the scheduled event is happening.
144 name: :class:`str`
145 The name of the scheduled event.
146 description: Optional[:class:`str`]
147 The description of the scheduled event.
148 start_time: :class:`datetime.datetime`
149 The time when the event will start
150 end_time: Optional[:class:`datetime.datetime`]
151 The time when the event is supposed to end.
152 status: :class:`ScheduledEventStatus`
153 The status of the scheduled event.
154 location: :class:`ScheduledEventLocation`
155 The location of the event.
156 See :class:`ScheduledEventLocation` for more information.
157 subscriber_count: Optional[:class:`int`]
158 The number of users that have marked themselves as interested for the event.
159 creator_id: Optional[:class:`int`]
160 The ID of the user who created the event.
161 It may be ``None`` because events created before October 25th, 2021, haven't
162 had their creators tracked.
163 creator: Optional[:class:`User`]
164 The resolved user object of who created the event.
165 privacy_level: :class:`ScheduledEventPrivacyLevel`
166 The privacy level of the event. Currently, the only possible value
167 is :attr:`ScheduledEventPrivacyLevel.guild_only`, which is default,
168 so there is no need to use this attribute.
169 """
170
171 __slots__ = (
172 "id",
173 "name",
174 "description",
175 "start_time",
176 "end_time",
177 "status",
178 "creator_id",
179 "creator",
180 "location",
181 "guild",
182 "_state",
183 "_cover",
184 "subscriber_count",
185 )
186
187 def __init__(
188 self,
189 *,
190 state: ConnectionState,
191 guild: Guild,
192 creator: Optional[Member],
193 data: ScheduledEventPayload,
194 ):
195 self._state: ConnectionState = state
196
197 self.id: int = int(data.get("id"))
198 self.guild: Guild = guild
199 self.name: str = data.get("name")
200 self.description: Optional[str] = data.get("description", None)
201 self._cover: Optional[str] = data.get("image", None)
202 self.start_time: datetime.datetime = datetime.datetime.fromisoformat(data.get("scheduled_start_time"))
203 end_time = data.get("scheduled_end_time", None)
204 if end_time != None:
205 end_time = datetime.datetime.fromisoformat(end_time)
206 self.end_time: Optional[datetime.datetime] = end_time
207 self.status: ScheduledEventStatus = try_enum(ScheduledEventStatus, data.get("status"))
208 self.subscriber_count: Optional[int] = data.get("user_count", None)
209 self.creator_id = data.get("creator_id", None)
210 self.creator: Optional[Member] = creator
211
212 entity_metadata = data.get("entity_metadata")
213 channel_id = data.get("channel_id", None)
214 if channel_id is None:
215 self.location = ScheduledEventLocation(state=state, value=entity_metadata["location"])
216 else:
217 self.location = ScheduledEventLocation(state=state, value=int(channel_id))
218
219 def __str__(self) -> str:
220 return self.name
221
222 def __repr__(self) -> str:
223 return (
224 f"<ScheduledEvent id={self.id} "
225 f"name={self.name} "
226 f"description={self.description} "
227 f"start_time={self.start_time} "
228 f"end_time={self.end_time} "
229 f"location={self.location!r} "
230 f"status={self.status.name} "
231 f"subscriber_count={self.subscriber_count} "
232 f"creator_id={self.creator_id}>"
233 )
234
235 @property
236 def created_at(self) -> datetime.datetime:
237 """:class:`datetime.datetime`: Returns the scheduled event's creation time in UTC."""
238 return utils.snowflake_time(self.id)
239
240 @property
241 def interested(self) -> Optional[int]:
242 """An alias to :attr:`.subscriber_count`"""
243 return self.subscriber_count
244
245 @property
246 def url(self) -> str:
247 """:class:`str`: The url to reference the scheduled event."""
248 return f"https://discord.com/events/{self.guild.id}/{self.id}"
249
250 @property
251 def cover(self) -> Optional[Asset]:
252 """Optional[:class:`Asset`]: Returns the scheduled event cover image asset, if available."""
253 if self._cover is None:
254 return None
255 return Asset._from_scheduled_event_cover(
256 self._state,
257 self.id,
258 self._image,
259 )
260
261 async def edit(
262 self,
263 *,
264 reason: Optional[str] = None,
265 name: str = MISSING,
266 description: str = MISSING,
267 status: Union[int, ScheduledEventStatus] = MISSING,
268 location: Union[str, int, VoiceChannel, StageChannel, ScheduledEventLocation] = MISSING,
269 start_time: datetime.datetime = MISSING,
270 end_time: datetime.datetime = MISSING,
271 cover: Optional[bytes] = MISSING,
272 privacy_level: ScheduledEventPrivacyLevel = ScheduledEventPrivacyLevel.guild_only,
273 ) -> Optional[ScheduledEvent]:
274 """|coro|
275
276 Edits the Scheduled Event's data
277
278 All parameters are optional unless ``location.type`` is
279 :attr:`ScheduledEventLocationType.external`, then ``end_time``
280 is required.
281
282 Will return a new :class:`.ScheduledEvent` object if applicable.
283
284 Parameters
285 -----------
286 name: :class:`str`
287 The new name of the event.
288 description: :class:`str`
289 The new description of the event.
290 location: :class:`.ScheduledEventLocation`
291 The location of the event.
292 status: :class:`ScheduledEventStatus`
293 The status of the event. It is recommended, however,
294 to use :meth:`.start`, :meth:`.complete`, and
295 :meth:`cancel` to edit statuses instead.
296 start_time: :class:`datetime.datetime`
297 The new starting time for the event.
298 end_time: :class:`datetime.datetime`
299 The new ending time of the event.
300 privacy_level: :class:`ScheduledEventPrivacyLevel`
301 The privacy level of the event. Currently, the only possible value
302 is :attr:`ScheduledEventPrivacyLevel.guild_only`, which is default,
303 so there is no need to change this parameter.
304 reason: Optional[:class:`str`]
305 The reason to show in the audit log.
306 cover: Optional[:class:`Asset`]
307 The cover image of the scheduled event.
308
309 Raises
310 -------
311 Forbidden
312 You do not have the Manage Events permission.
313 HTTPException
314 The operation failed.
315
316 Returns
317 --------
318 Optional[:class:`.ScheduledEvent`]
319 The newly updated scheduled event object. This is only returned when certain
320 fields are updated.
321 """
322 payload: Dict[str, Any] = {}
323
324 if name is not MISSING:
325 payload["name"] = name
326
327 if description is not MISSING:
328 payload["description"] = description
329
330 if status is not MISSING:
331 payload["status"] = int(status)
332
333 if privacy_level is not MISSING:
334 payload["privacy_level"] = int(privacy_level)
335
336 if cover is not MISSING:
337 if cover is None:
338 payload["image"]
339 else:
340 payload["image"] = utils._bytes_to_base64_data(cover)
341
342 if location is not MISSING:
343 if not isinstance(location, (ScheduledEventLocation, utils._MissingSentinel)):
344 location = ScheduledEventLocation(state=self._state, value=location)
345
346 if location.type is ScheduledEventLocationType.external:
347 payload["channel_id"] = None
348 payload["entity_metadata"] = {"location": str(location.value)}
349 else:
350 payload["channel_id"] = location.value.id
351 payload["entity_metadata"] = None
352
353 location = location if location is not MISSING else self.location
354 if end_time is MISSING and location.type is ScheduledEventLocationType.external:
355 end_time = self.end_time
356 if end_time is None:
357 raise ValidationError("end_time needs to be passed if location type is external.")
358
359 if start_time is not MISSING:
360 payload["scheduled_start_time"] = start_time.isoformat()
361
362 if end_time is not MISSING:
363 payload["scheduled_end_time"] = end_time.isoformat()
364
365 if payload != {}:
366 data = await self._state.http.edit_scheduled_event(self.guild.id, self.id, **payload, reason=reason)
367 return ScheduledEvent(data=data, guild=self.guild, creator=self.creator, state=self._state)
368
369 async def delete(self) -> None:
370 """|coro|
371
372 Deletes the scheduled event.
373
374 Raises
375 -------
376 Forbidden
377 You do not have the Manage Events permission.
378 HTTPException
379 The operation failed.
380 """
381 await self._state.http.delete_scheduled_event(self.guild.id, self.id)
382
383 async def start(self, *, reason: Optional[str] = None) -> None:
384 """|coro|
385
386 Starts the scheduled event. Shortcut from :meth:`.edit`.
387
388 .. note::
389
390 This method can only be used if :attr:`.status` is :attr:`ScheduledEventStatus.scheduled`.
391
392 Parameters
393 -----------
394 reason: Optional[:class:`str`]
395 The reason to show in the audit log.
396
397 Raises
398 -------
399 Forbidden
400 You do not have the Manage Events permission.
401 HTTPException
402 The operation failed.
403
404 Returns
405 --------
406 Optional[:class:`.ScheduledEvent`]
407 The newly updated scheduled event object.
408 """
409 return await self.edit(status=ScheduledEventStatus.active, reason=reason)
410
411 async def complete(self, *, reason: Optional[str] = None) -> None:
412 """|coro|
413
414 Ends/completes the scheduled event. Shortcut from :meth:`.edit`.
415
416 .. note::
417
418 This method can only be used if :attr:`.status` is :attr:`ScheduledEventStatus.active`.
419
420 Parameters
421 -----------
422 reason: Optional[:class:`str`]
423 The reason to show in the audit log.
424
425 Raises
426 -------
427 Forbidden
428 You do not have the Manage Events permission.
429 HTTPException
430 The operation failed.
431
432 Returns
433 --------
434 Optional[:class:`.ScheduledEvent`]
435 The newly updated scheduled event object.
436 """
437 return await self.edit(status=ScheduledEventStatus.completed, reason=reason)
438
439 async def cancel(self, *, reason: Optional[str] = None) -> None:
440 """|coro|
441
442 Cancels the scheduled event. Shortcut from :meth:`.edit`.
443
444 .. note::
445
446 This method can only be used if :attr:`.status` is :attr:`ScheduledEventStatus.scheduled`.
447
448 Parameters
449 -----------
450 reason: Optional[:class:`str`]
451 The reason to show in the audit log.
452
453 Raises
454 -------
455 Forbidden
456 You do not have the Manage Events permission.
457 HTTPException
458 The operation failed.
459
460 Returns
461 --------
462 Optional[:class:`.ScheduledEvent`]
463 The newly updated scheduled event object.
464 """
465 return await self.edit(status=ScheduledEventStatus.canceled, reason=reason)
466
467 def subscribers(
468 self,
469 *,
470 limit: int = 100,
471 as_member: bool = False,
472 before: Optional[Union[Snowflake, datetime.datetime]] = None,
473 after: Optional[Union[Snowflake, datetime.datetime]] = None,
474 ) -> AsyncIterator:
475 """Returns an :class:`AsyncIterator` representing the users or members subscribed to the event.
476
477 The ``after`` and ``before`` parameters must represent member
478 or user objects and meet the :class:`abc.Snowflake` abc.
479
480 .. note::
481
482 Even is ``as_member`` is set to ``True``, if the user
483 is outside the guild, it will be a :class:`User` object.
484
485 Examples
486 ---------
487
488 Usage ::
489
490 async for user in event.subscribers(limit=100):
491 print(user.name)
492
493 Flattening into a list: ::
494
495 users = await event.subscribers(limit=100).flatten()
496 # users is now a list of User...
497
498 Getting members instead of user objects: ::
499
500 async for member in event.subscribers(limit=100, as_member=True):
501 print(member.display_name)
502
503 Parameters
504 -----------
505 limit: Optional[:class:`int`]
506 The maximum number of results to return.
507 as_member: Optional[:class:`bool`]
508 Whether to fetch :class:`Member` objects instead of user objects.
509 There may still be :class:`User` objects if the user is outside
510 the guild.
511 before: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]]
512 Retrieves users before this date or object. If a datetime is provided,
513 it is recommended to use a UTC aware datetime. If the datetime is naive,
514 it is assumed to be local time.
515 after: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]]
516 Retrieves users after this date or object. If a datetime is provided,
517 it is recommended to use a UTC aware datetime. If the datetime is naive,
518 it is assumed to be local time.
519
520 Raises
521 -------
522 HTTPException
523 Fetching the subscribed users failed.
524
525 Yields
526 -------
527 Union[:class:`User`, :class:`Member`]
528 The subscribed :class:`Member`. If ``as_member`` is set to
529 ``False`` or the user is outside the guild, it will be a
530 :class:`User` object.
531 """
532 return ScheduledEventSubscribersIterator(
533 event=self, limit=limit, with_member=as_member, before=before, after=after
534 )
535
```
--- 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/discord/scheduled_events.py b/discord/scheduled_events.py
--- a/discord/scheduled_events.py
+++ b/discord/scheduled_events.py
@@ -255,7 +255,7 @@
return Asset._from_scheduled_event_cover(
self._state,
self.id,
- self._image,
+ self._cover,
)
async def edit(
| {"golden_diff": "diff --git a/discord/scheduled_events.py b/discord/scheduled_events.py\n--- a/discord/scheduled_events.py\n+++ b/discord/scheduled_events.py\n@@ -255,7 +255,7 @@\n return Asset._from_scheduled_event_cover(\n self._state,\n self.id,\n- self._image,\n+ self._cover,\n )\n \n async def edit(\n", "issue": "`ScheduledEvent` object has not attribute `_image`\n### Summary\n\nTitle explains it\n\n### Reproduction Steps\n\ni used jishaku `jsk py _ctx.guild.scheduled_events[0].cover`\r\n\n\n### Minimal Reproducible Code\n\n_No response_\n\n### Expected Results\n\nI was expecting it to return assets\n\n### Actual Results\n\nit returned an error saying that `ScheduledEvents` object has no attribute `_image`\n\n### Intents\n\nthis bot has all intents enabled\n\n### System Information\n\n- Python v3.10.4-final\r\n- py-cord v2.0.0-candidate\r\n - py-cord pkg_resources: v2.0.0rc1\r\n- aiohttp v3.8.1\r\n- system info: Windows 10 10.0.22000\n\n### Checklist\n\n- [X] I have searched the open issues for duplicates.\n- [X] I have shown the entire traceback, if possible.\n- [X] I have removed my token from display, if visible.\n\n### Additional Context\n\nso i was checking the source code and i realized that here:\r\n```py\r\n return Asset._from_scheduled_event_cover(\r\n self._state,\r\n self.id,\r\n self._image,\r\n )\r\n```\r\n`self._image` is actually **not** defined.\r\n\r\nSo I tried to change it to `self._cover` and it worked! I'm making a PR for this as well, for you guys to look into it. If it works, feel free to merge it!\n", "before_files": [{"content": "\"\"\"\nThe MIT License (MIT)\n\nCopyright (c) 2021-present Pycord Development\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the \"Software\"),\nto deal in the Software without restriction, including without limitation\nthe rights to use, copy, modify, merge, publish, distribute, sublicense,\nand/or sell copies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER\nDEALINGS IN THE SOFTWARE.\n\"\"\"\n\nfrom __future__ import annotations\n\nimport datetime\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Union\n\nfrom . import utils\nfrom .asset import Asset\nfrom .enums import (\n ScheduledEventLocationType,\n ScheduledEventPrivacyLevel,\n ScheduledEventStatus,\n try_enum,\n)\nfrom .errors import ValidationError\nfrom .iterators import ScheduledEventSubscribersIterator\nfrom .mixins import Hashable\nfrom .object import Object\n\n__all__ = (\n \"ScheduledEvent\",\n \"ScheduledEventLocation\",\n)\n\nif TYPE_CHECKING:\n from .abc import Snowflake\n from .guild import Guild\n from .iterators import AsyncIterator\n from .member import Member\n from .state import ConnectionState\n from .types.channel import StageChannel, VoiceChannel\n from .types.scheduled_events import ScheduledEvent as ScheduledEventPayload\n\nMISSING = utils.MISSING\n\n\nclass ScheduledEventLocation:\n \"\"\"Represents a scheduled event's location.\n\n Setting the ``value`` to its corresponding type will set the location type automatically:\n\n +------------------------+---------------------------------------------------+\n | Type of Input | Location Type |\n +========================+===================================================+\n | :class:`StageChannel`: | :attr:`ScheduledEventLocationType.stage_instance` |\n | :class:`VoiceChannel`: | :attr:`ScheduledEventLocationType.voice` |\n | :class:`str`: | :attr:`ScheduledEventLocationType.external` |\n +------------------------+---------------------------------------------------+\n\n .. versionadded:: 2.0\n\n Attributes\n ----------\n value: Union[:class:`str`, :class:`StageChannel`, :class:`VoiceChannel`, :class:`Object`]\n The actual location of the scheduled event.\n type: :class:`ScheduledEventLocationType`\n The type of location.\n \"\"\"\n\n __slots__ = (\n \"_state\",\n \"value\",\n )\n\n def __init__(\n self,\n *,\n state: ConnectionState,\n value: Union[str, int, StageChannel, VoiceChannel],\n ):\n self._state = state\n self.value: Union[str, StageChannel, VoiceChannel, Object]\n if isinstance(value, int):\n self.value = self._state.get_channel(id=int(value)) or Object(id=int(value))\n else:\n self.value = value\n\n def __repr__(self) -> str:\n return f\"<ScheduledEventLocation value={self.value!r} type={self.type}>\"\n\n def __str__(self) -> str:\n return str(self.value)\n\n @property\n def type(self) -> ScheduledEventLocationType:\n if isinstance(self.value, str):\n return ScheduledEventLocationType.external\n elif self.value.__class__.__name__ == \"StageChannel\":\n return ScheduledEventLocationType.stage_instance\n elif self.value.__class__.__name__ == \"VoiceChannel\":\n return ScheduledEventLocationType.voice\n\n\nclass ScheduledEvent(Hashable):\n \"\"\"Represents a Discord Guild Scheduled Event.\n\n .. container:: operations\n\n .. describe:: x == y\n\n Checks if two scheduled events are equal.\n\n .. describe:: x != y\n\n Checks if two scheduled events are not equal.\n\n .. describe:: hash(x)\n\n Returns the scheduled event's hash.\n\n .. describe:: str(x)\n\n Returns the scheduled event's name.\n\n .. versionadded:: 2.0\n\n Attributes\n ----------\n guild: :class:`Guild`\n The guild where the scheduled event is happening.\n name: :class:`str`\n The name of the scheduled event.\n description: Optional[:class:`str`]\n The description of the scheduled event.\n start_time: :class:`datetime.datetime`\n The time when the event will start\n end_time: Optional[:class:`datetime.datetime`]\n The time when the event is supposed to end.\n status: :class:`ScheduledEventStatus`\n The status of the scheduled event.\n location: :class:`ScheduledEventLocation`\n The location of the event.\n See :class:`ScheduledEventLocation` for more information.\n subscriber_count: Optional[:class:`int`]\n The number of users that have marked themselves as interested for the event.\n creator_id: Optional[:class:`int`]\n The ID of the user who created the event.\n It may be ``None`` because events created before October 25th, 2021, haven't\n had their creators tracked.\n creator: Optional[:class:`User`]\n The resolved user object of who created the event.\n privacy_level: :class:`ScheduledEventPrivacyLevel`\n The privacy level of the event. Currently, the only possible value\n is :attr:`ScheduledEventPrivacyLevel.guild_only`, which is default,\n so there is no need to use this attribute.\n \"\"\"\n\n __slots__ = (\n \"id\",\n \"name\",\n \"description\",\n \"start_time\",\n \"end_time\",\n \"status\",\n \"creator_id\",\n \"creator\",\n \"location\",\n \"guild\",\n \"_state\",\n \"_cover\",\n \"subscriber_count\",\n )\n\n def __init__(\n self,\n *,\n state: ConnectionState,\n guild: Guild,\n creator: Optional[Member],\n data: ScheduledEventPayload,\n ):\n self._state: ConnectionState = state\n\n self.id: int = int(data.get(\"id\"))\n self.guild: Guild = guild\n self.name: str = data.get(\"name\")\n self.description: Optional[str] = data.get(\"description\", None)\n self._cover: Optional[str] = data.get(\"image\", None)\n self.start_time: datetime.datetime = datetime.datetime.fromisoformat(data.get(\"scheduled_start_time\"))\n end_time = data.get(\"scheduled_end_time\", None)\n if end_time != None:\n end_time = datetime.datetime.fromisoformat(end_time)\n self.end_time: Optional[datetime.datetime] = end_time\n self.status: ScheduledEventStatus = try_enum(ScheduledEventStatus, data.get(\"status\"))\n self.subscriber_count: Optional[int] = data.get(\"user_count\", None)\n self.creator_id = data.get(\"creator_id\", None)\n self.creator: Optional[Member] = creator\n\n entity_metadata = data.get(\"entity_metadata\")\n channel_id = data.get(\"channel_id\", None)\n if channel_id is None:\n self.location = ScheduledEventLocation(state=state, value=entity_metadata[\"location\"])\n else:\n self.location = ScheduledEventLocation(state=state, value=int(channel_id))\n\n def __str__(self) -> str:\n return self.name\n\n def __repr__(self) -> str:\n return (\n f\"<ScheduledEvent id={self.id} \"\n f\"name={self.name} \"\n f\"description={self.description} \"\n f\"start_time={self.start_time} \"\n f\"end_time={self.end_time} \"\n f\"location={self.location!r} \"\n f\"status={self.status.name} \"\n f\"subscriber_count={self.subscriber_count} \"\n f\"creator_id={self.creator_id}>\"\n )\n\n @property\n def created_at(self) -> datetime.datetime:\n \"\"\":class:`datetime.datetime`: Returns the scheduled event's creation time in UTC.\"\"\"\n return utils.snowflake_time(self.id)\n\n @property\n def interested(self) -> Optional[int]:\n \"\"\"An alias to :attr:`.subscriber_count`\"\"\"\n return self.subscriber_count\n\n @property\n def url(self) -> str:\n \"\"\":class:`str`: The url to reference the scheduled event.\"\"\"\n return f\"https://discord.com/events/{self.guild.id}/{self.id}\"\n\n @property\n def cover(self) -> Optional[Asset]:\n \"\"\"Optional[:class:`Asset`]: Returns the scheduled event cover image asset, if available.\"\"\"\n if self._cover is None:\n return None\n return Asset._from_scheduled_event_cover(\n self._state,\n self.id,\n self._image,\n )\n\n async def edit(\n self,\n *,\n reason: Optional[str] = None,\n name: str = MISSING,\n description: str = MISSING,\n status: Union[int, ScheduledEventStatus] = MISSING,\n location: Union[str, int, VoiceChannel, StageChannel, ScheduledEventLocation] = MISSING,\n start_time: datetime.datetime = MISSING,\n end_time: datetime.datetime = MISSING,\n cover: Optional[bytes] = MISSING,\n privacy_level: ScheduledEventPrivacyLevel = ScheduledEventPrivacyLevel.guild_only,\n ) -> Optional[ScheduledEvent]:\n \"\"\"|coro|\n\n Edits the Scheduled Event's data\n\n All parameters are optional unless ``location.type`` is\n :attr:`ScheduledEventLocationType.external`, then ``end_time``\n is required.\n\n Will return a new :class:`.ScheduledEvent` object if applicable.\n\n Parameters\n -----------\n name: :class:`str`\n The new name of the event.\n description: :class:`str`\n The new description of the event.\n location: :class:`.ScheduledEventLocation`\n The location of the event.\n status: :class:`ScheduledEventStatus`\n The status of the event. It is recommended, however,\n to use :meth:`.start`, :meth:`.complete`, and\n :meth:`cancel` to edit statuses instead.\n start_time: :class:`datetime.datetime`\n The new starting time for the event.\n end_time: :class:`datetime.datetime`\n The new ending time of the event.\n privacy_level: :class:`ScheduledEventPrivacyLevel`\n The privacy level of the event. Currently, the only possible value\n is :attr:`ScheduledEventPrivacyLevel.guild_only`, which is default,\n so there is no need to change this parameter.\n reason: Optional[:class:`str`]\n The reason to show in the audit log.\n cover: Optional[:class:`Asset`]\n The cover image of the scheduled event.\n\n Raises\n -------\n Forbidden\n You do not have the Manage Events permission.\n HTTPException\n The operation failed.\n\n Returns\n --------\n Optional[:class:`.ScheduledEvent`]\n The newly updated scheduled event object. This is only returned when certain\n fields are updated.\n \"\"\"\n payload: Dict[str, Any] = {}\n\n if name is not MISSING:\n payload[\"name\"] = name\n\n if description is not MISSING:\n payload[\"description\"] = description\n\n if status is not MISSING:\n payload[\"status\"] = int(status)\n\n if privacy_level is not MISSING:\n payload[\"privacy_level\"] = int(privacy_level)\n\n if cover is not MISSING:\n if cover is None:\n payload[\"image\"]\n else:\n payload[\"image\"] = utils._bytes_to_base64_data(cover)\n\n if location is not MISSING:\n if not isinstance(location, (ScheduledEventLocation, utils._MissingSentinel)):\n location = ScheduledEventLocation(state=self._state, value=location)\n\n if location.type is ScheduledEventLocationType.external:\n payload[\"channel_id\"] = None\n payload[\"entity_metadata\"] = {\"location\": str(location.value)}\n else:\n payload[\"channel_id\"] = location.value.id\n payload[\"entity_metadata\"] = None\n\n location = location if location is not MISSING else self.location\n if end_time is MISSING and location.type is ScheduledEventLocationType.external:\n end_time = self.end_time\n if end_time is None:\n raise ValidationError(\"end_time needs to be passed if location type is external.\")\n\n if start_time is not MISSING:\n payload[\"scheduled_start_time\"] = start_time.isoformat()\n\n if end_time is not MISSING:\n payload[\"scheduled_end_time\"] = end_time.isoformat()\n\n if payload != {}:\n data = await self._state.http.edit_scheduled_event(self.guild.id, self.id, **payload, reason=reason)\n return ScheduledEvent(data=data, guild=self.guild, creator=self.creator, state=self._state)\n\n async def delete(self) -> None:\n \"\"\"|coro|\n\n Deletes the scheduled event.\n\n Raises\n -------\n Forbidden\n You do not have the Manage Events permission.\n HTTPException\n The operation failed.\n \"\"\"\n await self._state.http.delete_scheduled_event(self.guild.id, self.id)\n\n async def start(self, *, reason: Optional[str] = None) -> None:\n \"\"\"|coro|\n\n Starts the scheduled event. Shortcut from :meth:`.edit`.\n\n .. note::\n\n This method can only be used if :attr:`.status` is :attr:`ScheduledEventStatus.scheduled`.\n\n Parameters\n -----------\n reason: Optional[:class:`str`]\n The reason to show in the audit log.\n\n Raises\n -------\n Forbidden\n You do not have the Manage Events permission.\n HTTPException\n The operation failed.\n\n Returns\n --------\n Optional[:class:`.ScheduledEvent`]\n The newly updated scheduled event object.\n \"\"\"\n return await self.edit(status=ScheduledEventStatus.active, reason=reason)\n\n async def complete(self, *, reason: Optional[str] = None) -> None:\n \"\"\"|coro|\n\n Ends/completes the scheduled event. Shortcut from :meth:`.edit`.\n\n .. note::\n\n This method can only be used if :attr:`.status` is :attr:`ScheduledEventStatus.active`.\n\n Parameters\n -----------\n reason: Optional[:class:`str`]\n The reason to show in the audit log.\n\n Raises\n -------\n Forbidden\n You do not have the Manage Events permission.\n HTTPException\n The operation failed.\n\n Returns\n --------\n Optional[:class:`.ScheduledEvent`]\n The newly updated scheduled event object.\n \"\"\"\n return await self.edit(status=ScheduledEventStatus.completed, reason=reason)\n\n async def cancel(self, *, reason: Optional[str] = None) -> None:\n \"\"\"|coro|\n\n Cancels the scheduled event. Shortcut from :meth:`.edit`.\n\n .. note::\n\n This method can only be used if :attr:`.status` is :attr:`ScheduledEventStatus.scheduled`.\n\n Parameters\n -----------\n reason: Optional[:class:`str`]\n The reason to show in the audit log.\n\n Raises\n -------\n Forbidden\n You do not have the Manage Events permission.\n HTTPException\n The operation failed.\n\n Returns\n --------\n Optional[:class:`.ScheduledEvent`]\n The newly updated scheduled event object.\n \"\"\"\n return await self.edit(status=ScheduledEventStatus.canceled, reason=reason)\n\n def subscribers(\n self,\n *,\n limit: int = 100,\n as_member: bool = False,\n before: Optional[Union[Snowflake, datetime.datetime]] = None,\n after: Optional[Union[Snowflake, datetime.datetime]] = None,\n ) -> AsyncIterator:\n \"\"\"Returns an :class:`AsyncIterator` representing the users or members subscribed to the event.\n\n The ``after`` and ``before`` parameters must represent member\n or user objects and meet the :class:`abc.Snowflake` abc.\n\n .. note::\n\n Even is ``as_member`` is set to ``True``, if the user\n is outside the guild, it will be a :class:`User` object.\n\n Examples\n ---------\n\n Usage ::\n\n async for user in event.subscribers(limit=100):\n print(user.name)\n\n Flattening into a list: ::\n\n users = await event.subscribers(limit=100).flatten()\n # users is now a list of User...\n\n Getting members instead of user objects: ::\n\n async for member in event.subscribers(limit=100, as_member=True):\n print(member.display_name)\n\n Parameters\n -----------\n limit: Optional[:class:`int`]\n The maximum number of results to return.\n as_member: Optional[:class:`bool`]\n Whether to fetch :class:`Member` objects instead of user objects.\n There may still be :class:`User` objects if the user is outside\n the guild.\n before: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]]\n Retrieves users before this date or object. If a datetime is provided,\n it is recommended to use a UTC aware datetime. If the datetime is naive,\n it is assumed to be local time.\n after: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]]\n Retrieves users after this date or object. If a datetime is provided,\n it is recommended to use a UTC aware datetime. If the datetime is naive,\n it is assumed to be local time.\n\n Raises\n -------\n HTTPException\n Fetching the subscribed users failed.\n\n Yields\n -------\n Union[:class:`User`, :class:`Member`]\n The subscribed :class:`Member`. If ``as_member`` is set to\n ``False`` or the user is outside the guild, it will be a\n :class:`User` object.\n \"\"\"\n return ScheduledEventSubscribersIterator(\n event=self, limit=limit, with_member=as_member, before=before, after=after\n )\n", "path": "discord/scheduled_events.py"}], "after_files": [{"content": "\"\"\"\nThe MIT License (MIT)\n\nCopyright (c) 2021-present Pycord Development\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the \"Software\"),\nto deal in the Software without restriction, including without limitation\nthe rights to use, copy, modify, merge, publish, distribute, sublicense,\nand/or sell copies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER\nDEALINGS IN THE SOFTWARE.\n\"\"\"\n\nfrom __future__ import annotations\n\nimport datetime\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Union\n\nfrom . import utils\nfrom .asset import Asset\nfrom .enums import (\n ScheduledEventLocationType,\n ScheduledEventPrivacyLevel,\n ScheduledEventStatus,\n try_enum,\n)\nfrom .errors import ValidationError\nfrom .iterators import ScheduledEventSubscribersIterator\nfrom .mixins import Hashable\nfrom .object import Object\n\n__all__ = (\n \"ScheduledEvent\",\n \"ScheduledEventLocation\",\n)\n\nif TYPE_CHECKING:\n from .abc import Snowflake\n from .guild import Guild\n from .iterators import AsyncIterator\n from .member import Member\n from .state import ConnectionState\n from .types.channel import StageChannel, VoiceChannel\n from .types.scheduled_events import ScheduledEvent as ScheduledEventPayload\n\nMISSING = utils.MISSING\n\n\nclass ScheduledEventLocation:\n \"\"\"Represents a scheduled event's location.\n\n Setting the ``value`` to its corresponding type will set the location type automatically:\n\n +------------------------+---------------------------------------------------+\n | Type of Input | Location Type |\n +========================+===================================================+\n | :class:`StageChannel`: | :attr:`ScheduledEventLocationType.stage_instance` |\n | :class:`VoiceChannel`: | :attr:`ScheduledEventLocationType.voice` |\n | :class:`str`: | :attr:`ScheduledEventLocationType.external` |\n +------------------------+---------------------------------------------------+\n\n .. versionadded:: 2.0\n\n Attributes\n ----------\n value: Union[:class:`str`, :class:`StageChannel`, :class:`VoiceChannel`, :class:`Object`]\n The actual location of the scheduled event.\n type: :class:`ScheduledEventLocationType`\n The type of location.\n \"\"\"\n\n __slots__ = (\n \"_state\",\n \"value\",\n )\n\n def __init__(\n self,\n *,\n state: ConnectionState,\n value: Union[str, int, StageChannel, VoiceChannel],\n ):\n self._state = state\n self.value: Union[str, StageChannel, VoiceChannel, Object]\n if isinstance(value, int):\n self.value = self._state.get_channel(id=int(value)) or Object(id=int(value))\n else:\n self.value = value\n\n def __repr__(self) -> str:\n return f\"<ScheduledEventLocation value={self.value!r} type={self.type}>\"\n\n def __str__(self) -> str:\n return str(self.value)\n\n @property\n def type(self) -> ScheduledEventLocationType:\n if isinstance(self.value, str):\n return ScheduledEventLocationType.external\n elif self.value.__class__.__name__ == \"StageChannel\":\n return ScheduledEventLocationType.stage_instance\n elif self.value.__class__.__name__ == \"VoiceChannel\":\n return ScheduledEventLocationType.voice\n\n\nclass ScheduledEvent(Hashable):\n \"\"\"Represents a Discord Guild Scheduled Event.\n\n .. container:: operations\n\n .. describe:: x == y\n\n Checks if two scheduled events are equal.\n\n .. describe:: x != y\n\n Checks if two scheduled events are not equal.\n\n .. describe:: hash(x)\n\n Returns the scheduled event's hash.\n\n .. describe:: str(x)\n\n Returns the scheduled event's name.\n\n .. versionadded:: 2.0\n\n Attributes\n ----------\n guild: :class:`Guild`\n The guild where the scheduled event is happening.\n name: :class:`str`\n The name of the scheduled event.\n description: Optional[:class:`str`]\n The description of the scheduled event.\n start_time: :class:`datetime.datetime`\n The time when the event will start\n end_time: Optional[:class:`datetime.datetime`]\n The time when the event is supposed to end.\n status: :class:`ScheduledEventStatus`\n The status of the scheduled event.\n location: :class:`ScheduledEventLocation`\n The location of the event.\n See :class:`ScheduledEventLocation` for more information.\n subscriber_count: Optional[:class:`int`]\n The number of users that have marked themselves as interested for the event.\n creator_id: Optional[:class:`int`]\n The ID of the user who created the event.\n It may be ``None`` because events created before October 25th, 2021, haven't\n had their creators tracked.\n creator: Optional[:class:`User`]\n The resolved user object of who created the event.\n privacy_level: :class:`ScheduledEventPrivacyLevel`\n The privacy level of the event. Currently, the only possible value\n is :attr:`ScheduledEventPrivacyLevel.guild_only`, which is default,\n so there is no need to use this attribute.\n \"\"\"\n\n __slots__ = (\n \"id\",\n \"name\",\n \"description\",\n \"start_time\",\n \"end_time\",\n \"status\",\n \"creator_id\",\n \"creator\",\n \"location\",\n \"guild\",\n \"_state\",\n \"_cover\",\n \"subscriber_count\",\n )\n\n def __init__(\n self,\n *,\n state: ConnectionState,\n guild: Guild,\n creator: Optional[Member],\n data: ScheduledEventPayload,\n ):\n self._state: ConnectionState = state\n\n self.id: int = int(data.get(\"id\"))\n self.guild: Guild = guild\n self.name: str = data.get(\"name\")\n self.description: Optional[str] = data.get(\"description\", None)\n self._cover: Optional[str] = data.get(\"image\", None)\n self.start_time: datetime.datetime = datetime.datetime.fromisoformat(data.get(\"scheduled_start_time\"))\n end_time = data.get(\"scheduled_end_time\", None)\n if end_time != None:\n end_time = datetime.datetime.fromisoformat(end_time)\n self.end_time: Optional[datetime.datetime] = end_time\n self.status: ScheduledEventStatus = try_enum(ScheduledEventStatus, data.get(\"status\"))\n self.subscriber_count: Optional[int] = data.get(\"user_count\", None)\n self.creator_id = data.get(\"creator_id\", None)\n self.creator: Optional[Member] = creator\n\n entity_metadata = data.get(\"entity_metadata\")\n channel_id = data.get(\"channel_id\", None)\n if channel_id is None:\n self.location = ScheduledEventLocation(state=state, value=entity_metadata[\"location\"])\n else:\n self.location = ScheduledEventLocation(state=state, value=int(channel_id))\n\n def __str__(self) -> str:\n return self.name\n\n def __repr__(self) -> str:\n return (\n f\"<ScheduledEvent id={self.id} \"\n f\"name={self.name} \"\n f\"description={self.description} \"\n f\"start_time={self.start_time} \"\n f\"end_time={self.end_time} \"\n f\"location={self.location!r} \"\n f\"status={self.status.name} \"\n f\"subscriber_count={self.subscriber_count} \"\n f\"creator_id={self.creator_id}>\"\n )\n\n @property\n def created_at(self) -> datetime.datetime:\n \"\"\":class:`datetime.datetime`: Returns the scheduled event's creation time in UTC.\"\"\"\n return utils.snowflake_time(self.id)\n\n @property\n def interested(self) -> Optional[int]:\n \"\"\"An alias to :attr:`.subscriber_count`\"\"\"\n return self.subscriber_count\n\n @property\n def url(self) -> str:\n \"\"\":class:`str`: The url to reference the scheduled event.\"\"\"\n return f\"https://discord.com/events/{self.guild.id}/{self.id}\"\n\n @property\n def cover(self) -> Optional[Asset]:\n \"\"\"Optional[:class:`Asset`]: Returns the scheduled event cover image asset, if available.\"\"\"\n if self._cover is None:\n return None\n return Asset._from_scheduled_event_cover(\n self._state,\n self.id,\n self._cover,\n )\n\n async def edit(\n self,\n *,\n reason: Optional[str] = None,\n name: str = MISSING,\n description: str = MISSING,\n status: Union[int, ScheduledEventStatus] = MISSING,\n location: Union[str, int, VoiceChannel, StageChannel, ScheduledEventLocation] = MISSING,\n start_time: datetime.datetime = MISSING,\n end_time: datetime.datetime = MISSING,\n cover: Optional[bytes] = MISSING,\n privacy_level: ScheduledEventPrivacyLevel = ScheduledEventPrivacyLevel.guild_only,\n ) -> Optional[ScheduledEvent]:\n \"\"\"|coro|\n\n Edits the Scheduled Event's data\n\n All parameters are optional unless ``location.type`` is\n :attr:`ScheduledEventLocationType.external`, then ``end_time``\n is required.\n\n Will return a new :class:`.ScheduledEvent` object if applicable.\n\n Parameters\n -----------\n name: :class:`str`\n The new name of the event.\n description: :class:`str`\n The new description of the event.\n location: :class:`.ScheduledEventLocation`\n The location of the event.\n status: :class:`ScheduledEventStatus`\n The status of the event. It is recommended, however,\n to use :meth:`.start`, :meth:`.complete`, and\n :meth:`cancel` to edit statuses instead.\n start_time: :class:`datetime.datetime`\n The new starting time for the event.\n end_time: :class:`datetime.datetime`\n The new ending time of the event.\n privacy_level: :class:`ScheduledEventPrivacyLevel`\n The privacy level of the event. Currently, the only possible value\n is :attr:`ScheduledEventPrivacyLevel.guild_only`, which is default,\n so there is no need to change this parameter.\n reason: Optional[:class:`str`]\n The reason to show in the audit log.\n cover: Optional[:class:`Asset`]\n The cover image of the scheduled event.\n\n Raises\n -------\n Forbidden\n You do not have the Manage Events permission.\n HTTPException\n The operation failed.\n\n Returns\n --------\n Optional[:class:`.ScheduledEvent`]\n The newly updated scheduled event object. This is only returned when certain\n fields are updated.\n \"\"\"\n payload: Dict[str, Any] = {}\n\n if name is not MISSING:\n payload[\"name\"] = name\n\n if description is not MISSING:\n payload[\"description\"] = description\n\n if status is not MISSING:\n payload[\"status\"] = int(status)\n\n if privacy_level is not MISSING:\n payload[\"privacy_level\"] = int(privacy_level)\n\n if cover is not MISSING:\n if cover is None:\n payload[\"image\"]\n else:\n payload[\"image\"] = utils._bytes_to_base64_data(cover)\n\n if location is not MISSING:\n if not isinstance(location, (ScheduledEventLocation, utils._MissingSentinel)):\n location = ScheduledEventLocation(state=self._state, value=location)\n\n if location.type is ScheduledEventLocationType.external:\n payload[\"channel_id\"] = None\n payload[\"entity_metadata\"] = {\"location\": str(location.value)}\n else:\n payload[\"channel_id\"] = location.value.id\n payload[\"entity_metadata\"] = None\n\n location = location if location is not MISSING else self.location\n if end_time is MISSING and location.type is ScheduledEventLocationType.external:\n end_time = self.end_time\n if end_time is None:\n raise ValidationError(\"end_time needs to be passed if location type is external.\")\n\n if start_time is not MISSING:\n payload[\"scheduled_start_time\"] = start_time.isoformat()\n\n if end_time is not MISSING:\n payload[\"scheduled_end_time\"] = end_time.isoformat()\n\n if payload != {}:\n data = await self._state.http.edit_scheduled_event(self.guild.id, self.id, **payload, reason=reason)\n return ScheduledEvent(data=data, guild=self.guild, creator=self.creator, state=self._state)\n\n async def delete(self) -> None:\n \"\"\"|coro|\n\n Deletes the scheduled event.\n\n Raises\n -------\n Forbidden\n You do not have the Manage Events permission.\n HTTPException\n The operation failed.\n \"\"\"\n await self._state.http.delete_scheduled_event(self.guild.id, self.id)\n\n async def start(self, *, reason: Optional[str] = None) -> None:\n \"\"\"|coro|\n\n Starts the scheduled event. Shortcut from :meth:`.edit`.\n\n .. note::\n\n This method can only be used if :attr:`.status` is :attr:`ScheduledEventStatus.scheduled`.\n\n Parameters\n -----------\n reason: Optional[:class:`str`]\n The reason to show in the audit log.\n\n Raises\n -------\n Forbidden\n You do not have the Manage Events permission.\n HTTPException\n The operation failed.\n\n Returns\n --------\n Optional[:class:`.ScheduledEvent`]\n The newly updated scheduled event object.\n \"\"\"\n return await self.edit(status=ScheduledEventStatus.active, reason=reason)\n\n async def complete(self, *, reason: Optional[str] = None) -> None:\n \"\"\"|coro|\n\n Ends/completes the scheduled event. Shortcut from :meth:`.edit`.\n\n .. note::\n\n This method can only be used if :attr:`.status` is :attr:`ScheduledEventStatus.active`.\n\n Parameters\n -----------\n reason: Optional[:class:`str`]\n The reason to show in the audit log.\n\n Raises\n -------\n Forbidden\n You do not have the Manage Events permission.\n HTTPException\n The operation failed.\n\n Returns\n --------\n Optional[:class:`.ScheduledEvent`]\n The newly updated scheduled event object.\n \"\"\"\n return await self.edit(status=ScheduledEventStatus.completed, reason=reason)\n\n async def cancel(self, *, reason: Optional[str] = None) -> None:\n \"\"\"|coro|\n\n Cancels the scheduled event. Shortcut from :meth:`.edit`.\n\n .. note::\n\n This method can only be used if :attr:`.status` is :attr:`ScheduledEventStatus.scheduled`.\n\n Parameters\n -----------\n reason: Optional[:class:`str`]\n The reason to show in the audit log.\n\n Raises\n -------\n Forbidden\n You do not have the Manage Events permission.\n HTTPException\n The operation failed.\n\n Returns\n --------\n Optional[:class:`.ScheduledEvent`]\n The newly updated scheduled event object.\n \"\"\"\n return await self.edit(status=ScheduledEventStatus.canceled, reason=reason)\n\n def subscribers(\n self,\n *,\n limit: int = 100,\n as_member: bool = False,\n before: Optional[Union[Snowflake, datetime.datetime]] = None,\n after: Optional[Union[Snowflake, datetime.datetime]] = None,\n ) -> AsyncIterator:\n \"\"\"Returns an :class:`AsyncIterator` representing the users or members subscribed to the event.\n\n The ``after`` and ``before`` parameters must represent member\n or user objects and meet the :class:`abc.Snowflake` abc.\n\n .. note::\n\n Even is ``as_member`` is set to ``True``, if the user\n is outside the guild, it will be a :class:`User` object.\n\n Examples\n ---------\n\n Usage ::\n\n async for user in event.subscribers(limit=100):\n print(user.name)\n\n Flattening into a list: ::\n\n users = await event.subscribers(limit=100).flatten()\n # users is now a list of User...\n\n Getting members instead of user objects: ::\n\n async for member in event.subscribers(limit=100, as_member=True):\n print(member.display_name)\n\n Parameters\n -----------\n limit: Optional[:class:`int`]\n The maximum number of results to return.\n as_member: Optional[:class:`bool`]\n Whether to fetch :class:`Member` objects instead of user objects.\n There may still be :class:`User` objects if the user is outside\n the guild.\n before: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]]\n Retrieves users before this date or object. If a datetime is provided,\n it is recommended to use a UTC aware datetime. If the datetime is naive,\n it is assumed to be local time.\n after: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]]\n Retrieves users after this date or object. If a datetime is provided,\n it is recommended to use a UTC aware datetime. If the datetime is naive,\n it is assumed to be local time.\n\n Raises\n -------\n HTTPException\n Fetching the subscribed users failed.\n\n Yields\n -------\n Union[:class:`User`, :class:`Member`]\n The subscribed :class:`Member`. If ``as_member`` is set to\n ``False`` or the user is outside the guild, it will be a\n :class:`User` object.\n \"\"\"\n return ScheduledEventSubscribersIterator(\n event=self, limit=limit, with_member=as_member, before=before, after=after\n )\n", "path": "discord/scheduled_events.py"}]} |
gh_patches_debug_251 | rasdani/github-patches | git_diff | flask-admin__flask-admin-1408 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Leaflet JS Errors on examples.flask-admin.org
To reproduce, go here: http://examples.flask-admin.org/geo/admin/multipoint/edit/?url=%2Fgeo%2Fadmin%2Fmultipoint%2F&id=1
and click the "edit layers" icon (above the delete trashcan).
```
Uncaught TypeError: Cannot set property 'previousOptions' of undefined
```
Is this an issue with Leaflet, or something wrong with the flask-admin implementation?
--- 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/geo_alchemy/config.py`
Content:
```
1 # Create dummy secrey key so we can use sessions
2 SECRET_KEY = '123456790'
3
4 # database connection
5 SQLALCHEMY_DATABASE_URI = 'postgresql+psycopg2://flask_admin_geo:flask_admin_geo@localhost/flask_admin_geo'
6 SQLALCHEMY_ECHO = True
7
8 # credentials for loading map tiles from mapbox
9 MAPBOX_MAP_ID = '...'
10 MAPBOX_ACCESS_TOKEN = '...'
```
--- 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/geo_alchemy/config.py b/examples/geo_alchemy/config.py
--- a/examples/geo_alchemy/config.py
+++ b/examples/geo_alchemy/config.py
@@ -7,4 +7,8 @@
# credentials for loading map tiles from mapbox
MAPBOX_MAP_ID = '...'
-MAPBOX_ACCESS_TOKEN = '...'
\ No newline at end of file
+MAPBOX_ACCESS_TOKEN = '...'
+
+# when the creating new shapes, use this default map center
+DEFAULT_CENTER_LAT = -33.918861
+DEFAULT_CENTER_LONG = 18.423300
| {"golden_diff": "diff --git a/examples/geo_alchemy/config.py b/examples/geo_alchemy/config.py\n--- a/examples/geo_alchemy/config.py\n+++ b/examples/geo_alchemy/config.py\n@@ -7,4 +7,8 @@\n \n # credentials for loading map tiles from mapbox\n MAPBOX_MAP_ID = '...'\n-MAPBOX_ACCESS_TOKEN = '...'\n\\ No newline at end of file\n+MAPBOX_ACCESS_TOKEN = '...'\n+\n+# when the creating new shapes, use this default map center\n+DEFAULT_CENTER_LAT = -33.918861\n+DEFAULT_CENTER_LONG = 18.423300\n", "issue": "Leaflet JS Errors on examples.flask-admin.org\nTo reproduce, go here: http://examples.flask-admin.org/geo/admin/multipoint/edit/?url=%2Fgeo%2Fadmin%2Fmultipoint%2F&id=1\n\nand click the \"edit layers\" icon (above the delete trashcan).\n\n```\nUncaught TypeError: Cannot set property 'previousOptions' of undefined\n```\n\nIs this an issue with Leaflet, or something wrong with the flask-admin implementation?\n\n", "before_files": [{"content": "# Create dummy secrey key so we can use sessions\nSECRET_KEY = '123456790'\n\n# database connection\nSQLALCHEMY_DATABASE_URI = 'postgresql+psycopg2://flask_admin_geo:flask_admin_geo@localhost/flask_admin_geo'\nSQLALCHEMY_ECHO = True\n\n# credentials for loading map tiles from mapbox\nMAPBOX_MAP_ID = '...'\nMAPBOX_ACCESS_TOKEN = '...'", "path": "examples/geo_alchemy/config.py"}], "after_files": [{"content": "# Create dummy secrey key so we can use sessions\nSECRET_KEY = '123456790'\n\n# database connection\nSQLALCHEMY_DATABASE_URI = 'postgresql+psycopg2://flask_admin_geo:flask_admin_geo@localhost/flask_admin_geo'\nSQLALCHEMY_ECHO = True\n\n# credentials for loading map tiles from mapbox\nMAPBOX_MAP_ID = '...'\nMAPBOX_ACCESS_TOKEN = '...'\n\n# when the creating new shapes, use this default map center\nDEFAULT_CENTER_LAT = -33.918861\nDEFAULT_CENTER_LONG = 18.423300\n", "path": "examples/geo_alchemy/config.py"}]} |
gh_patches_debug_252 | rasdani/github-patches | git_diff | feast-dev__feast-3280 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Minimal Python version on PyPI seems to be too low
## Expected Behavior
From what I can understand, the minimal version of Python to run Feast is 3.8; that's what I would expect on the PyPI page.
## Current Behavior
`Requires: Python >=3.7.0`
## Steps to reproduce
https://pypi.org/project/feast/
--- 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 # Copyright 2019 The Feast 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 # https://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 import copy
15 import glob
16 import json
17 import os
18 import pathlib
19 import re
20 import shutil
21 import subprocess
22 import sys
23 from distutils.cmd import Command
24 from distutils.dir_util import copy_tree
25 from pathlib import Path
26 from subprocess import CalledProcessError
27
28 from setuptools import Extension, find_packages
29
30 try:
31 from setuptools import setup
32 from setuptools.command.build_ext import build_ext as _build_ext
33 from setuptools.command.build_py import build_py
34 from setuptools.command.develop import develop
35 from setuptools.command.install import install
36
37 except ImportError:
38 from distutils.command.build_ext import build_ext as _build_ext
39 from distutils.command.build_py import build_py
40 from distutils.core import setup
41
42 NAME = "feast"
43 DESCRIPTION = "Python SDK for Feast"
44 URL = "https://github.com/feast-dev/feast"
45 AUTHOR = "Feast"
46 REQUIRES_PYTHON = ">=3.7.0"
47
48 REQUIRED = [
49 "click>=7.0.0,<9.0.0",
50 "colorama>=0.3.9,<1",
51 "dill==0.3.*",
52 "fastavro>=1.1.0,<2",
53 "google-api-core>=1.23.0,<3",
54 "googleapis-common-protos>=1.52.*,<2",
55 "grpcio>=1.47.0,<2",
56 "grpcio-reflection>=1.47.0,<2",
57 "Jinja2>=2,<4",
58 "jsonschema",
59 "mmh3",
60 "numpy>=1.22,<3",
61 "pandas>=1.4.3,<2",
62 "pandavro==1.5.*", # For some reason pandavro higher than 1.5.* only support pandas less than 1.3.
63 "protobuf<5,>3",
64 "proto-plus>=1.20.0,<2",
65 "pyarrow>=4,<9",
66 "pydantic>=1,<2",
67 "pygments>=2.12.0,<3",
68 "PyYAML>=5.4.*,<7",
69 "SQLAlchemy[mypy]>1,<2",
70 "tabulate>=0.8.0,<1",
71 "tenacity>=7,<9",
72 "toml>=0.10.0,<1",
73 "tqdm>=4,<5",
74 "typeguard",
75 "fastapi>=0.68.0,<1",
76 "uvicorn[standard]>=0.14.0,<1",
77 "dask>=2021.*,<2022.02.0",
78 "bowler", # Needed for automatic repo upgrades
79 ]
80
81 GCP_REQUIRED = [
82 "google-cloud-bigquery[pandas]>=2,<4",
83 "google-cloud-bigquery-storage >= 2.0.0,<3",
84 "google-cloud-datastore>=2.1.*,<3",
85 "google-cloud-storage>=1.34.*,<3",
86 "google-cloud-bigtable>=2.11.*,<3",
87 ]
88
89 REDIS_REQUIRED = [
90 "redis==4.2.2",
91 "hiredis>=2.0.0,<3",
92 ]
93
94 AWS_REQUIRED = ["boto3>=1.17.0,<=1.20.23", "docker>=5.0.2", "s3fs>=0.4.0,<=2022.01.0"]
95
96 BYTEWAX_REQUIRED = ["bytewax==0.10.0", "docker>=5.0.2", "kubernetes<=20.13.0"]
97
98 SNOWFLAKE_REQUIRED = [
99 "snowflake-connector-python[pandas]>=2.7.3,<3",
100 # `pyOpenSSL==22.1.0` requires `cryptography<39,>=38.0.0`, which is incompatible
101 # with `snowflake-connector-python[pandas]==2.8.0`, which depends on
102 # `cryptography<37.0.0,>=3.1.0`.
103 "pyOpenSSL<22.1.0",
104 ]
105
106 SPARK_REQUIRED = [
107 "pyspark>=3.0.0,<4",
108 ]
109
110 TRINO_REQUIRED = [
111 "trino>=0.305.0,<0.400.0",
112 ]
113
114 POSTGRES_REQUIRED = [
115 "psycopg2-binary>=2.8.3,<3",
116 ]
117
118 MYSQL_REQUIRED = ["mysqlclient", "pymysql", "types-PyMySQL"]
119
120 HBASE_REQUIRED = [
121 "happybase>=1.2.0,<3",
122 ]
123
124 CASSANDRA_REQUIRED = [
125 "cassandra-driver>=3.24.0,<4",
126 ]
127
128 GE_REQUIRED = ["great_expectations>=0.14.0,<0.15.0"]
129
130 GO_REQUIRED = [
131 "cffi==1.15.*,<2",
132 ]
133
134 AZURE_REQUIRED = [
135 "azure-storage-blob>=0.37.0",
136 "azure-identity>=1.6.1",
137 "SQLAlchemy>=1.4.19",
138 "pyodbc>=4.0.30",
139 "pymssql",
140 ]
141
142 CI_REQUIRED = (
143 [
144 "build",
145 "cryptography>=35.0,<36",
146 "flake8",
147 "black>=22.6.0,<23",
148 "isort>=5,<6",
149 "grpcio-tools>=1.47.0",
150 "grpcio-testing>=1.47.0",
151 "minio==7.1.0",
152 "mock==2.0.0",
153 "moto<4",
154 "mypy>=0.931",
155 "mypy-protobuf==3.1",
156 "avro==1.10.0",
157 "gcsfs>=0.4.0,<=2022.01.0",
158 "urllib3>=1.25.4,<2",
159 "psutil==5.9.0",
160 "pytest>=6.0.0,<8",
161 "pytest-cov",
162 "pytest-xdist",
163 "pytest-benchmark>=3.4.1,<4",
164 "pytest-lazy-fixture==0.6.3",
165 "pytest-timeout==1.4.2",
166 "pytest-ordering==0.6.*",
167 "pytest-mock==1.10.4",
168 "Sphinx!=4.0.0,<4.4.0",
169 "sphinx-rtd-theme",
170 "testcontainers>=3.5,<4",
171 "adlfs==0.5.9",
172 "firebase-admin>=5.2.0,<6",
173 "pre-commit",
174 "assertpy==1.1",
175 "pip-tools",
176 "pybindgen",
177 "types-protobuf",
178 "types-python-dateutil",
179 "types-pytz",
180 "types-PyYAML",
181 "types-redis",
182 "types-requests",
183 "types-setuptools",
184 "types-tabulate",
185 ]
186 + GCP_REQUIRED
187 + REDIS_REQUIRED
188 + AWS_REQUIRED
189 + BYTEWAX_REQUIRED
190 + SNOWFLAKE_REQUIRED
191 + SPARK_REQUIRED
192 + POSTGRES_REQUIRED
193 + MYSQL_REQUIRED
194 + TRINO_REQUIRED
195 + GE_REQUIRED
196 + HBASE_REQUIRED
197 + CASSANDRA_REQUIRED
198 + AZURE_REQUIRED
199 )
200
201
202 # rtd builds fail because of mysql not being installed in their environment.
203 # We can add mysql there, but it's not strictly needed. This will be faster for builds.
204 DOCS_REQUIRED = CI_REQUIRED.copy()
205 for _r in MYSQL_REQUIRED:
206 DOCS_REQUIRED.remove(_r)
207
208 DEV_REQUIRED = ["mypy-protobuf==3.1", "grpcio-testing==1.*"] + CI_REQUIRED
209
210 # Get git repo root directory
211 repo_root = str(pathlib.Path(__file__).resolve().parent)
212
213 # README file from Feast repo root directory
214 README_FILE = os.path.join(repo_root, "README.md")
215 with open(README_FILE, "r", encoding="utf8") as f:
216 LONG_DESCRIPTION = f.read()
217
218 # Add Support for parsing tags that have a prefix containing '/' (ie 'sdk/go') to setuptools_scm.
219 # Regex modified from default tag regex in:
220 # https://github.com/pypa/setuptools_scm/blob/2a1b46d38fb2b8aeac09853e660bcd0d7c1bc7be/src/setuptools_scm/config.py#L9
221 TAG_REGEX = re.compile(
222 r"^(?:[\/\w-]+)?(?P<version>[vV]?\d+(?:\.\d+){0,2}[^\+]*)(?:\+.*)?$"
223 )
224
225 # Only set use_scm_version if git executable exists (setting this variable causes pip to use git under the hood)
226 if shutil.which("git"):
227 use_scm_version = {"root": ".", "relative_to": __file__, "tag_regex": TAG_REGEX}
228 else:
229 use_scm_version = None
230
231 PROTO_SUBDIRS = ["core", "serving", "types", "storage"]
232 PYTHON_CODE_PREFIX = "sdk/python"
233
234
235 class BuildPythonProtosCommand(Command):
236 description = "Builds the proto files into Python files."
237 user_options = [
238 ("inplace", "i", "Write generated proto files to source directory."),
239 ]
240
241 def initialize_options(self):
242 self.python_protoc = [
243 sys.executable,
244 "-m",
245 "grpc_tools.protoc",
246 ] # find_executable("protoc")
247 self.proto_folder = os.path.join(repo_root, "protos")
248 self.sub_folders = PROTO_SUBDIRS
249 self.build_lib = None
250 self.inplace = 0
251
252 def finalize_options(self):
253 self.set_undefined_options("build", ("build_lib", "build_lib"))
254
255 @property
256 def python_folder(self):
257 if self.inplace:
258 return os.path.join(
259 os.path.dirname(__file__) or os.getcwd(), "sdk/python/feast/protos"
260 )
261
262 return os.path.join(self.build_lib, "feast/protos")
263
264 def _generate_python_protos(self, path: str):
265 proto_files = glob.glob(os.path.join(self.proto_folder, path))
266 Path(self.python_folder).mkdir(parents=True, exist_ok=True)
267 subprocess.check_call(
268 self.python_protoc
269 + [
270 "-I",
271 self.proto_folder,
272 "--python_out",
273 self.python_folder,
274 "--grpc_python_out",
275 self.python_folder,
276 "--mypy_out",
277 self.python_folder,
278 ]
279 + proto_files
280 )
281
282 def run(self):
283 for sub_folder in self.sub_folders:
284 self._generate_python_protos(f"feast/{sub_folder}/*.proto")
285 # We need the __init__ files for each of the generated subdirs
286 # so that they are regular packages, and don't need the `--namespace-packages` flags
287 # when being typechecked using mypy.
288 with open(f"{self.python_folder}/feast/{sub_folder}/__init__.py", "w"):
289 pass
290
291 with open(f"{self.python_folder}/__init__.py", "w"):
292 pass
293 with open(f"{self.python_folder}/feast/__init__.py", "w"):
294 pass
295
296 for path in Path(self.python_folder).rglob("*.py"):
297 for folder in self.sub_folders:
298 # Read in the file
299 with open(path, "r") as file:
300 filedata = file.read()
301
302 # Replace the target string
303 filedata = filedata.replace(
304 f"from feast.{folder}", f"from feast.protos.feast.{folder}"
305 )
306
307 # Write the file out again
308 with open(path, "w") as file:
309 file.write(filedata)
310
311
312 def _generate_path_with_gopath():
313 go_path = subprocess.check_output(["go", "env", "GOPATH"]).decode("utf-8")
314 go_path = go_path.strip()
315 path_val = os.getenv("PATH")
316 path_val = f"{path_val}:{go_path}/bin"
317
318 return path_val
319
320
321 def _ensure_go_and_proto_toolchain():
322 try:
323 version = subprocess.check_output(["go", "version"])
324 except Exception as e:
325 raise RuntimeError("Unable to find go toolchain") from e
326
327 semver_string = re.search(r"go[\S]+", str(version)).group().lstrip("go")
328 parts = semver_string.split(".")
329 if not (int(parts[0]) >= 1 and int(parts[1]) >= 16):
330 raise RuntimeError(f"Go compiler too old; expected 1.16+ found {semver_string}")
331
332 path_val = _generate_path_with_gopath()
333
334 try:
335 subprocess.check_call(["protoc-gen-go", "--version"], env={"PATH": path_val})
336 subprocess.check_call(
337 ["protoc-gen-go-grpc", "--version"], env={"PATH": path_val}
338 )
339 except Exception as e:
340 raise RuntimeError("Unable to find go/grpc extensions for protoc") from e
341
342
343 class BuildGoProtosCommand(Command):
344 description = "Builds the proto files into Go files."
345 user_options = []
346
347 def initialize_options(self):
348 self.go_protoc = [
349 sys.executable,
350 "-m",
351 "grpc_tools.protoc",
352 ] # find_executable("protoc")
353 self.proto_folder = os.path.join(repo_root, "protos")
354 self.go_folder = os.path.join(repo_root, "go/protos")
355 self.sub_folders = PROTO_SUBDIRS
356 self.path_val = _generate_path_with_gopath()
357
358 def finalize_options(self):
359 pass
360
361 def _generate_go_protos(self, path: str):
362 proto_files = glob.glob(os.path.join(self.proto_folder, path))
363
364 try:
365 subprocess.check_call(
366 self.go_protoc
367 + [
368 "-I",
369 self.proto_folder,
370 "--go_out",
371 self.go_folder,
372 "--go_opt=module=github.com/feast-dev/feast/go/protos",
373 "--go-grpc_out",
374 self.go_folder,
375 "--go-grpc_opt=module=github.com/feast-dev/feast/go/protos",
376 ]
377 + proto_files,
378 env={"PATH": self.path_val},
379 )
380 except CalledProcessError as e:
381 print(f"Stderr: {e.stderr}")
382 print(f"Stdout: {e.stdout}")
383
384 def run(self):
385 go_dir = Path(repo_root) / "go" / "protos"
386 go_dir.mkdir(exist_ok=True)
387 for sub_folder in self.sub_folders:
388 self._generate_go_protos(f"feast/{sub_folder}/*.proto")
389
390
391 class BuildCommand(build_py):
392 """Custom build command."""
393
394 def run(self):
395 self.run_command("build_python_protos")
396 if os.getenv("COMPILE_GO", "false").lower() == "true":
397 _ensure_go_and_proto_toolchain()
398 self.run_command("build_go_protos")
399
400 self.run_command("build_ext")
401 build_py.run(self)
402
403
404 class DevelopCommand(develop):
405 """Custom develop command."""
406
407 def run(self):
408 self.reinitialize_command("build_python_protos", inplace=1)
409 self.run_command("build_python_protos")
410 if os.getenv("COMPILE_GO", "false").lower() == "true":
411 _ensure_go_and_proto_toolchain()
412 self.run_command("build_go_protos")
413
414 develop.run(self)
415
416
417 class build_ext(_build_ext):
418 def finalize_options(self) -> None:
419 super().finalize_options()
420 if os.getenv("COMPILE_GO", "false").lower() == "false":
421 self.extensions = [e for e in self.extensions if not self._is_go_ext(e)]
422
423 def _is_go_ext(self, ext: Extension):
424 return any(
425 source.endswith(".go") or source.startswith("github")
426 for source in ext.sources
427 )
428
429 def build_extension(self, ext: Extension):
430 print(f"Building extension {ext}")
431 if not self._is_go_ext(ext):
432 # the base class may mutate `self.compiler`
433 compiler = copy.deepcopy(self.compiler)
434 self.compiler, compiler = compiler, self.compiler
435 try:
436 return _build_ext.build_extension(self, ext)
437 finally:
438 self.compiler, compiler = compiler, self.compiler
439
440 bin_path = _generate_path_with_gopath()
441 go_env = json.loads(
442 subprocess.check_output(["go", "env", "-json"]).decode("utf-8").strip()
443 )
444
445 print(f"Go env: {go_env}")
446 print(f"CWD: {os.getcwd()}")
447
448 destination = os.path.dirname(os.path.abspath(self.get_ext_fullpath(ext.name)))
449 subprocess.check_call(
450 ["go", "install", "golang.org/x/tools/cmd/goimports"],
451 env={"PATH": bin_path, **go_env},
452 )
453 subprocess.check_call(
454 ["go", "get", "github.com/go-python/[email protected]"],
455 env={"PATH": bin_path, **go_env},
456 )
457 subprocess.check_call(
458 ["go", "install", "github.com/go-python/gopy"],
459 env={"PATH": bin_path, **go_env},
460 )
461 subprocess.check_call(
462 [
463 "gopy",
464 "build",
465 "-output",
466 destination,
467 "-vm",
468 sys.executable,
469 "--build-tags",
470 "cgo,ccalloc",
471 "--dynamic-link=True",
472 "-no-make",
473 *ext.sources,
474 ],
475 env={
476 "PATH": bin_path,
477 "CGO_LDFLAGS_ALLOW": ".*",
478 **go_env,
479 },
480 )
481
482 def copy_extensions_to_source(self):
483 build_py = self.get_finalized_command("build_py")
484 for ext in self.extensions:
485 fullname = self.get_ext_fullname(ext.name)
486 modpath = fullname.split(".")
487 package = ".".join(modpath[:-1])
488 package_dir = build_py.get_package_dir(package)
489
490 src_dir = dest_dir = package_dir
491
492 if src_dir.startswith(PYTHON_CODE_PREFIX):
493 src_dir = package_dir[len(PYTHON_CODE_PREFIX) :]
494 src_dir = src_dir.lstrip("/")
495
496 src_dir = os.path.join(self.build_lib, src_dir)
497
498 # copy whole directory
499 print(f"Copying from {src_dir} to {dest_dir}")
500 copy_tree(src_dir, dest_dir)
501
502
503 setup(
504 name=NAME,
505 author=AUTHOR,
506 description=DESCRIPTION,
507 long_description=LONG_DESCRIPTION,
508 long_description_content_type="text/markdown",
509 python_requires=REQUIRES_PYTHON,
510 url=URL,
511 packages=find_packages(
512 where=PYTHON_CODE_PREFIX, exclude=("java", "infra", "sdk/python/tests", "ui")
513 ),
514 package_dir={"": PYTHON_CODE_PREFIX},
515 install_requires=REQUIRED,
516 # https://stackoverflow.com/questions/28509965/setuptools-development-requirements
517 # Install dev requirements with: pip install -e .[dev]
518 extras_require={
519 "dev": DEV_REQUIRED,
520 "ci": CI_REQUIRED,
521 "gcp": GCP_REQUIRED,
522 "aws": AWS_REQUIRED,
523 "bytewax": BYTEWAX_REQUIRED,
524 "redis": REDIS_REQUIRED,
525 "snowflake": SNOWFLAKE_REQUIRED,
526 "spark": SPARK_REQUIRED,
527 "trino": TRINO_REQUIRED,
528 "postgres": POSTGRES_REQUIRED,
529 "azure": AZURE_REQUIRED,
530 "mysql": MYSQL_REQUIRED,
531 "ge": GE_REQUIRED,
532 "hbase": HBASE_REQUIRED,
533 "go": GO_REQUIRED,
534 "docs": DOCS_REQUIRED,
535 "cassandra": CASSANDRA_REQUIRED,
536 },
537 include_package_data=True,
538 license="Apache",
539 classifiers=[
540 # Trove classifiers
541 # Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
542 "License :: OSI Approved :: Apache Software License",
543 "Programming Language :: Python",
544 "Programming Language :: Python :: 3",
545 "Programming Language :: Python :: 3.7",
546 ],
547 entry_points={"console_scripts": ["feast=feast.cli:cli"]},
548 use_scm_version=use_scm_version,
549 setup_requires=[
550 "setuptools_scm",
551 "grpcio>=1.47.0",
552 "grpcio-tools>=1.47.0",
553 "mypy-protobuf==3.1",
554 "pybindgen==0.22.0",
555 "sphinx!=4.0.0",
556 ],
557 cmdclass={
558 "build_python_protos": BuildPythonProtosCommand,
559 "build_go_protos": BuildGoProtosCommand,
560 "build_py": BuildCommand,
561 "develop": DevelopCommand,
562 "build_ext": build_ext,
563 },
564 ext_modules=[
565 Extension(
566 "feast.embedded_go.lib._embedded",
567 ["github.com/feast-dev/feast/go/embedded"],
568 )
569 ],
570 )
571
```
--- 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
@@ -43,7 +43,7 @@
DESCRIPTION = "Python SDK for Feast"
URL = "https://github.com/feast-dev/feast"
AUTHOR = "Feast"
-REQUIRES_PYTHON = ">=3.7.0"
+REQUIRES_PYTHON = ">=3.8.0"
REQUIRED = [
"click>=7.0.0,<9.0.0",
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -43,7 +43,7 @@\n DESCRIPTION = \"Python SDK for Feast\"\n URL = \"https://github.com/feast-dev/feast\"\n AUTHOR = \"Feast\"\n-REQUIRES_PYTHON = \">=3.7.0\"\n+REQUIRES_PYTHON = \">=3.8.0\"\n \n REQUIRED = [\n \"click>=7.0.0,<9.0.0\",\n", "issue": "Minimal Python version on PyPI seems to be too low\n## Expected Behavior \r\n\r\nFrom what I can understand, the minimal version of Python to run Feast is 3.8; that's what I would expect on the PyPI page.\r\n\r\n## Current Behavior\r\n\r\n`Requires: Python >=3.7.0`\r\n\r\n## Steps to reproduce\r\n\r\nhttps://pypi.org/project/feast/\r\n\n", "before_files": [{"content": "# Copyright 2019 The Feast 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# https://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.\nimport copy\nimport glob\nimport json\nimport os\nimport pathlib\nimport re\nimport shutil\nimport subprocess\nimport sys\nfrom distutils.cmd import Command\nfrom distutils.dir_util import copy_tree\nfrom pathlib import Path\nfrom subprocess import CalledProcessError\n\nfrom setuptools import Extension, find_packages\n\ntry:\n from setuptools import setup\n from setuptools.command.build_ext import build_ext as _build_ext\n from setuptools.command.build_py import build_py\n from setuptools.command.develop import develop\n from setuptools.command.install import install\n\nexcept ImportError:\n from distutils.command.build_ext import build_ext as _build_ext\n from distutils.command.build_py import build_py\n from distutils.core import setup\n\nNAME = \"feast\"\nDESCRIPTION = \"Python SDK for Feast\"\nURL = \"https://github.com/feast-dev/feast\"\nAUTHOR = \"Feast\"\nREQUIRES_PYTHON = \">=3.7.0\"\n\nREQUIRED = [\n \"click>=7.0.0,<9.0.0\",\n \"colorama>=0.3.9,<1\",\n \"dill==0.3.*\",\n \"fastavro>=1.1.0,<2\",\n \"google-api-core>=1.23.0,<3\",\n \"googleapis-common-protos>=1.52.*,<2\",\n \"grpcio>=1.47.0,<2\",\n \"grpcio-reflection>=1.47.0,<2\",\n \"Jinja2>=2,<4\",\n \"jsonschema\",\n \"mmh3\",\n \"numpy>=1.22,<3\",\n \"pandas>=1.4.3,<2\",\n \"pandavro==1.5.*\", # For some reason pandavro higher than 1.5.* only support pandas less than 1.3.\n \"protobuf<5,>3\",\n \"proto-plus>=1.20.0,<2\",\n \"pyarrow>=4,<9\",\n \"pydantic>=1,<2\",\n \"pygments>=2.12.0,<3\",\n \"PyYAML>=5.4.*,<7\",\n \"SQLAlchemy[mypy]>1,<2\",\n \"tabulate>=0.8.0,<1\",\n \"tenacity>=7,<9\",\n \"toml>=0.10.0,<1\",\n \"tqdm>=4,<5\",\n \"typeguard\",\n \"fastapi>=0.68.0,<1\",\n \"uvicorn[standard]>=0.14.0,<1\",\n \"dask>=2021.*,<2022.02.0\",\n \"bowler\", # Needed for automatic repo upgrades\n]\n\nGCP_REQUIRED = [\n \"google-cloud-bigquery[pandas]>=2,<4\",\n \"google-cloud-bigquery-storage >= 2.0.0,<3\",\n \"google-cloud-datastore>=2.1.*,<3\",\n \"google-cloud-storage>=1.34.*,<3\",\n \"google-cloud-bigtable>=2.11.*,<3\",\n]\n\nREDIS_REQUIRED = [\n \"redis==4.2.2\",\n \"hiredis>=2.0.0,<3\",\n]\n\nAWS_REQUIRED = [\"boto3>=1.17.0,<=1.20.23\", \"docker>=5.0.2\", \"s3fs>=0.4.0,<=2022.01.0\"]\n\nBYTEWAX_REQUIRED = [\"bytewax==0.10.0\", \"docker>=5.0.2\", \"kubernetes<=20.13.0\"]\n\nSNOWFLAKE_REQUIRED = [\n \"snowflake-connector-python[pandas]>=2.7.3,<3\",\n # `pyOpenSSL==22.1.0` requires `cryptography<39,>=38.0.0`, which is incompatible\n # with `snowflake-connector-python[pandas]==2.8.0`, which depends on\n # `cryptography<37.0.0,>=3.1.0`.\n \"pyOpenSSL<22.1.0\",\n]\n\nSPARK_REQUIRED = [\n \"pyspark>=3.0.0,<4\",\n]\n\nTRINO_REQUIRED = [\n \"trino>=0.305.0,<0.400.0\",\n]\n\nPOSTGRES_REQUIRED = [\n \"psycopg2-binary>=2.8.3,<3\",\n]\n\nMYSQL_REQUIRED = [\"mysqlclient\", \"pymysql\", \"types-PyMySQL\"]\n\nHBASE_REQUIRED = [\n \"happybase>=1.2.0,<3\",\n]\n\nCASSANDRA_REQUIRED = [\n \"cassandra-driver>=3.24.0,<4\",\n]\n\nGE_REQUIRED = [\"great_expectations>=0.14.0,<0.15.0\"]\n\nGO_REQUIRED = [\n \"cffi==1.15.*,<2\",\n]\n\nAZURE_REQUIRED = [\n \"azure-storage-blob>=0.37.0\",\n \"azure-identity>=1.6.1\",\n \"SQLAlchemy>=1.4.19\",\n \"pyodbc>=4.0.30\",\n \"pymssql\",\n]\n\nCI_REQUIRED = (\n [\n \"build\",\n \"cryptography>=35.0,<36\",\n \"flake8\",\n \"black>=22.6.0,<23\",\n \"isort>=5,<6\",\n \"grpcio-tools>=1.47.0\",\n \"grpcio-testing>=1.47.0\",\n \"minio==7.1.0\",\n \"mock==2.0.0\",\n \"moto<4\",\n \"mypy>=0.931\",\n \"mypy-protobuf==3.1\",\n \"avro==1.10.0\",\n \"gcsfs>=0.4.0,<=2022.01.0\",\n \"urllib3>=1.25.4,<2\",\n \"psutil==5.9.0\",\n \"pytest>=6.0.0,<8\",\n \"pytest-cov\",\n \"pytest-xdist\",\n \"pytest-benchmark>=3.4.1,<4\",\n \"pytest-lazy-fixture==0.6.3\",\n \"pytest-timeout==1.4.2\",\n \"pytest-ordering==0.6.*\",\n \"pytest-mock==1.10.4\",\n \"Sphinx!=4.0.0,<4.4.0\",\n \"sphinx-rtd-theme\",\n \"testcontainers>=3.5,<4\",\n \"adlfs==0.5.9\",\n \"firebase-admin>=5.2.0,<6\",\n \"pre-commit\",\n \"assertpy==1.1\",\n \"pip-tools\",\n \"pybindgen\",\n \"types-protobuf\",\n \"types-python-dateutil\",\n \"types-pytz\",\n \"types-PyYAML\",\n \"types-redis\",\n \"types-requests\",\n \"types-setuptools\",\n \"types-tabulate\",\n ]\n + GCP_REQUIRED\n + REDIS_REQUIRED\n + AWS_REQUIRED\n + BYTEWAX_REQUIRED\n + SNOWFLAKE_REQUIRED\n + SPARK_REQUIRED\n + POSTGRES_REQUIRED\n + MYSQL_REQUIRED\n + TRINO_REQUIRED\n + GE_REQUIRED\n + HBASE_REQUIRED\n + CASSANDRA_REQUIRED\n + AZURE_REQUIRED\n)\n\n\n# rtd builds fail because of mysql not being installed in their environment.\n# We can add mysql there, but it's not strictly needed. This will be faster for builds.\nDOCS_REQUIRED = CI_REQUIRED.copy()\nfor _r in MYSQL_REQUIRED:\n DOCS_REQUIRED.remove(_r)\n\nDEV_REQUIRED = [\"mypy-protobuf==3.1\", \"grpcio-testing==1.*\"] + CI_REQUIRED\n\n# Get git repo root directory\nrepo_root = str(pathlib.Path(__file__).resolve().parent)\n\n# README file from Feast repo root directory\nREADME_FILE = os.path.join(repo_root, \"README.md\")\nwith open(README_FILE, \"r\", encoding=\"utf8\") as f:\n LONG_DESCRIPTION = f.read()\n\n# Add Support for parsing tags that have a prefix containing '/' (ie 'sdk/go') to setuptools_scm.\n# Regex modified from default tag regex in:\n# https://github.com/pypa/setuptools_scm/blob/2a1b46d38fb2b8aeac09853e660bcd0d7c1bc7be/src/setuptools_scm/config.py#L9\nTAG_REGEX = re.compile(\n r\"^(?:[\\/\\w-]+)?(?P<version>[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$\"\n)\n\n# Only set use_scm_version if git executable exists (setting this variable causes pip to use git under the hood)\nif shutil.which(\"git\"):\n use_scm_version = {\"root\": \".\", \"relative_to\": __file__, \"tag_regex\": TAG_REGEX}\nelse:\n use_scm_version = None\n\nPROTO_SUBDIRS = [\"core\", \"serving\", \"types\", \"storage\"]\nPYTHON_CODE_PREFIX = \"sdk/python\"\n\n\nclass BuildPythonProtosCommand(Command):\n description = \"Builds the proto files into Python files.\"\n user_options = [\n (\"inplace\", \"i\", \"Write generated proto files to source directory.\"),\n ]\n\n def initialize_options(self):\n self.python_protoc = [\n sys.executable,\n \"-m\",\n \"grpc_tools.protoc\",\n ] # find_executable(\"protoc\")\n self.proto_folder = os.path.join(repo_root, \"protos\")\n self.sub_folders = PROTO_SUBDIRS\n self.build_lib = None\n self.inplace = 0\n\n def finalize_options(self):\n self.set_undefined_options(\"build\", (\"build_lib\", \"build_lib\"))\n\n @property\n def python_folder(self):\n if self.inplace:\n return os.path.join(\n os.path.dirname(__file__) or os.getcwd(), \"sdk/python/feast/protos\"\n )\n\n return os.path.join(self.build_lib, \"feast/protos\")\n\n def _generate_python_protos(self, path: str):\n proto_files = glob.glob(os.path.join(self.proto_folder, path))\n Path(self.python_folder).mkdir(parents=True, exist_ok=True)\n subprocess.check_call(\n self.python_protoc\n + [\n \"-I\",\n self.proto_folder,\n \"--python_out\",\n self.python_folder,\n \"--grpc_python_out\",\n self.python_folder,\n \"--mypy_out\",\n self.python_folder,\n ]\n + proto_files\n )\n\n def run(self):\n for sub_folder in self.sub_folders:\n self._generate_python_protos(f\"feast/{sub_folder}/*.proto\")\n # We need the __init__ files for each of the generated subdirs\n # so that they are regular packages, and don't need the `--namespace-packages` flags\n # when being typechecked using mypy.\n with open(f\"{self.python_folder}/feast/{sub_folder}/__init__.py\", \"w\"):\n pass\n\n with open(f\"{self.python_folder}/__init__.py\", \"w\"):\n pass\n with open(f\"{self.python_folder}/feast/__init__.py\", \"w\"):\n pass\n\n for path in Path(self.python_folder).rglob(\"*.py\"):\n for folder in self.sub_folders:\n # Read in the file\n with open(path, \"r\") as file:\n filedata = file.read()\n\n # Replace the target string\n filedata = filedata.replace(\n f\"from feast.{folder}\", f\"from feast.protos.feast.{folder}\"\n )\n\n # Write the file out again\n with open(path, \"w\") as file:\n file.write(filedata)\n\n\ndef _generate_path_with_gopath():\n go_path = subprocess.check_output([\"go\", \"env\", \"GOPATH\"]).decode(\"utf-8\")\n go_path = go_path.strip()\n path_val = os.getenv(\"PATH\")\n path_val = f\"{path_val}:{go_path}/bin\"\n\n return path_val\n\n\ndef _ensure_go_and_proto_toolchain():\n try:\n version = subprocess.check_output([\"go\", \"version\"])\n except Exception as e:\n raise RuntimeError(\"Unable to find go toolchain\") from e\n\n semver_string = re.search(r\"go[\\S]+\", str(version)).group().lstrip(\"go\")\n parts = semver_string.split(\".\")\n if not (int(parts[0]) >= 1 and int(parts[1]) >= 16):\n raise RuntimeError(f\"Go compiler too old; expected 1.16+ found {semver_string}\")\n\n path_val = _generate_path_with_gopath()\n\n try:\n subprocess.check_call([\"protoc-gen-go\", \"--version\"], env={\"PATH\": path_val})\n subprocess.check_call(\n [\"protoc-gen-go-grpc\", \"--version\"], env={\"PATH\": path_val}\n )\n except Exception as e:\n raise RuntimeError(\"Unable to find go/grpc extensions for protoc\") from e\n\n\nclass BuildGoProtosCommand(Command):\n description = \"Builds the proto files into Go files.\"\n user_options = []\n\n def initialize_options(self):\n self.go_protoc = [\n sys.executable,\n \"-m\",\n \"grpc_tools.protoc\",\n ] # find_executable(\"protoc\")\n self.proto_folder = os.path.join(repo_root, \"protos\")\n self.go_folder = os.path.join(repo_root, \"go/protos\")\n self.sub_folders = PROTO_SUBDIRS\n self.path_val = _generate_path_with_gopath()\n\n def finalize_options(self):\n pass\n\n def _generate_go_protos(self, path: str):\n proto_files = glob.glob(os.path.join(self.proto_folder, path))\n\n try:\n subprocess.check_call(\n self.go_protoc\n + [\n \"-I\",\n self.proto_folder,\n \"--go_out\",\n self.go_folder,\n \"--go_opt=module=github.com/feast-dev/feast/go/protos\",\n \"--go-grpc_out\",\n self.go_folder,\n \"--go-grpc_opt=module=github.com/feast-dev/feast/go/protos\",\n ]\n + proto_files,\n env={\"PATH\": self.path_val},\n )\n except CalledProcessError as e:\n print(f\"Stderr: {e.stderr}\")\n print(f\"Stdout: {e.stdout}\")\n\n def run(self):\n go_dir = Path(repo_root) / \"go\" / \"protos\"\n go_dir.mkdir(exist_ok=True)\n for sub_folder in self.sub_folders:\n self._generate_go_protos(f\"feast/{sub_folder}/*.proto\")\n\n\nclass BuildCommand(build_py):\n \"\"\"Custom build command.\"\"\"\n\n def run(self):\n self.run_command(\"build_python_protos\")\n if os.getenv(\"COMPILE_GO\", \"false\").lower() == \"true\":\n _ensure_go_and_proto_toolchain()\n self.run_command(\"build_go_protos\")\n\n self.run_command(\"build_ext\")\n build_py.run(self)\n\n\nclass DevelopCommand(develop):\n \"\"\"Custom develop command.\"\"\"\n\n def run(self):\n self.reinitialize_command(\"build_python_protos\", inplace=1)\n self.run_command(\"build_python_protos\")\n if os.getenv(\"COMPILE_GO\", \"false\").lower() == \"true\":\n _ensure_go_and_proto_toolchain()\n self.run_command(\"build_go_protos\")\n\n develop.run(self)\n\n\nclass build_ext(_build_ext):\n def finalize_options(self) -> None:\n super().finalize_options()\n if os.getenv(\"COMPILE_GO\", \"false\").lower() == \"false\":\n self.extensions = [e for e in self.extensions if not self._is_go_ext(e)]\n\n def _is_go_ext(self, ext: Extension):\n return any(\n source.endswith(\".go\") or source.startswith(\"github\")\n for source in ext.sources\n )\n\n def build_extension(self, ext: Extension):\n print(f\"Building extension {ext}\")\n if not self._is_go_ext(ext):\n # the base class may mutate `self.compiler`\n compiler = copy.deepcopy(self.compiler)\n self.compiler, compiler = compiler, self.compiler\n try:\n return _build_ext.build_extension(self, ext)\n finally:\n self.compiler, compiler = compiler, self.compiler\n\n bin_path = _generate_path_with_gopath()\n go_env = json.loads(\n subprocess.check_output([\"go\", \"env\", \"-json\"]).decode(\"utf-8\").strip()\n )\n\n print(f\"Go env: {go_env}\")\n print(f\"CWD: {os.getcwd()}\")\n\n destination = os.path.dirname(os.path.abspath(self.get_ext_fullpath(ext.name)))\n subprocess.check_call(\n [\"go\", \"install\", \"golang.org/x/tools/cmd/goimports\"],\n env={\"PATH\": bin_path, **go_env},\n )\n subprocess.check_call(\n [\"go\", \"get\", \"github.com/go-python/[email protected]\"],\n env={\"PATH\": bin_path, **go_env},\n )\n subprocess.check_call(\n [\"go\", \"install\", \"github.com/go-python/gopy\"],\n env={\"PATH\": bin_path, **go_env},\n )\n subprocess.check_call(\n [\n \"gopy\",\n \"build\",\n \"-output\",\n destination,\n \"-vm\",\n sys.executable,\n \"--build-tags\",\n \"cgo,ccalloc\",\n \"--dynamic-link=True\",\n \"-no-make\",\n *ext.sources,\n ],\n env={\n \"PATH\": bin_path,\n \"CGO_LDFLAGS_ALLOW\": \".*\",\n **go_env,\n },\n )\n\n def copy_extensions_to_source(self):\n build_py = self.get_finalized_command(\"build_py\")\n for ext in self.extensions:\n fullname = self.get_ext_fullname(ext.name)\n modpath = fullname.split(\".\")\n package = \".\".join(modpath[:-1])\n package_dir = build_py.get_package_dir(package)\n\n src_dir = dest_dir = package_dir\n\n if src_dir.startswith(PYTHON_CODE_PREFIX):\n src_dir = package_dir[len(PYTHON_CODE_PREFIX) :]\n src_dir = src_dir.lstrip(\"/\")\n\n src_dir = os.path.join(self.build_lib, src_dir)\n\n # copy whole directory\n print(f\"Copying from {src_dir} to {dest_dir}\")\n copy_tree(src_dir, dest_dir)\n\n\nsetup(\n name=NAME,\n author=AUTHOR,\n description=DESCRIPTION,\n long_description=LONG_DESCRIPTION,\n long_description_content_type=\"text/markdown\",\n python_requires=REQUIRES_PYTHON,\n url=URL,\n packages=find_packages(\n where=PYTHON_CODE_PREFIX, exclude=(\"java\", \"infra\", \"sdk/python/tests\", \"ui\")\n ),\n package_dir={\"\": PYTHON_CODE_PREFIX},\n install_requires=REQUIRED,\n # https://stackoverflow.com/questions/28509965/setuptools-development-requirements\n # Install dev requirements with: pip install -e .[dev]\n extras_require={\n \"dev\": DEV_REQUIRED,\n \"ci\": CI_REQUIRED,\n \"gcp\": GCP_REQUIRED,\n \"aws\": AWS_REQUIRED,\n \"bytewax\": BYTEWAX_REQUIRED,\n \"redis\": REDIS_REQUIRED,\n \"snowflake\": SNOWFLAKE_REQUIRED,\n \"spark\": SPARK_REQUIRED,\n \"trino\": TRINO_REQUIRED,\n \"postgres\": POSTGRES_REQUIRED,\n \"azure\": AZURE_REQUIRED,\n \"mysql\": MYSQL_REQUIRED,\n \"ge\": GE_REQUIRED,\n \"hbase\": HBASE_REQUIRED,\n \"go\": GO_REQUIRED,\n \"docs\": DOCS_REQUIRED,\n \"cassandra\": CASSANDRA_REQUIRED,\n },\n include_package_data=True,\n license=\"Apache\",\n classifiers=[\n # Trove classifiers\n # Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers\n \"License :: OSI Approved :: Apache Software License\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.7\",\n ],\n entry_points={\"console_scripts\": [\"feast=feast.cli:cli\"]},\n use_scm_version=use_scm_version,\n setup_requires=[\n \"setuptools_scm\",\n \"grpcio>=1.47.0\",\n \"grpcio-tools>=1.47.0\",\n \"mypy-protobuf==3.1\",\n \"pybindgen==0.22.0\",\n \"sphinx!=4.0.0\",\n ],\n cmdclass={\n \"build_python_protos\": BuildPythonProtosCommand,\n \"build_go_protos\": BuildGoProtosCommand,\n \"build_py\": BuildCommand,\n \"develop\": DevelopCommand,\n \"build_ext\": build_ext,\n },\n ext_modules=[\n Extension(\n \"feast.embedded_go.lib._embedded\",\n [\"github.com/feast-dev/feast/go/embedded\"],\n )\n ],\n)\n", "path": "setup.py"}], "after_files": [{"content": "# Copyright 2019 The Feast 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# https://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.\nimport copy\nimport glob\nimport json\nimport os\nimport pathlib\nimport re\nimport shutil\nimport subprocess\nimport sys\nfrom distutils.cmd import Command\nfrom distutils.dir_util import copy_tree\nfrom pathlib import Path\nfrom subprocess import CalledProcessError\n\nfrom setuptools import Extension, find_packages\n\ntry:\n from setuptools import setup\n from setuptools.command.build_ext import build_ext as _build_ext\n from setuptools.command.build_py import build_py\n from setuptools.command.develop import develop\n from setuptools.command.install import install\n\nexcept ImportError:\n from distutils.command.build_ext import build_ext as _build_ext\n from distutils.command.build_py import build_py\n from distutils.core import setup\n\nNAME = \"feast\"\nDESCRIPTION = \"Python SDK for Feast\"\nURL = \"https://github.com/feast-dev/feast\"\nAUTHOR = \"Feast\"\nREQUIRES_PYTHON = \">=3.8.0\"\n\nREQUIRED = [\n \"click>=7.0.0,<9.0.0\",\n \"colorama>=0.3.9,<1\",\n \"dill==0.3.*\",\n \"fastavro>=1.1.0,<2\",\n \"google-api-core>=1.23.0,<3\",\n \"googleapis-common-protos>=1.52.*,<2\",\n \"grpcio>=1.47.0,<2\",\n \"grpcio-reflection>=1.47.0,<2\",\n \"Jinja2>=2,<4\",\n \"jsonschema\",\n \"mmh3\",\n \"numpy>=1.22,<3\",\n \"pandas>=1.4.3,<2\",\n \"pandavro==1.5.*\", # For some reason pandavro higher than 1.5.* only support pandas less than 1.3.\n \"protobuf<5,>3\",\n \"proto-plus>=1.20.0,<2\",\n \"pyarrow>=4,<9\",\n \"pydantic>=1,<2\",\n \"pygments>=2.12.0,<3\",\n \"PyYAML>=5.4.*,<7\",\n \"SQLAlchemy[mypy]>1,<2\",\n \"tabulate>=0.8.0,<1\",\n \"tenacity>=7,<9\",\n \"toml>=0.10.0,<1\",\n \"tqdm>=4,<5\",\n \"typeguard\",\n \"fastapi>=0.68.0,<1\",\n \"uvicorn[standard]>=0.14.0,<1\",\n \"dask>=2021.*,<2022.02.0\",\n \"bowler\", # Needed for automatic repo upgrades\n]\n\nGCP_REQUIRED = [\n \"google-cloud-bigquery[pandas]>=2,<4\",\n \"google-cloud-bigquery-storage >= 2.0.0,<3\",\n \"google-cloud-datastore>=2.1.*,<3\",\n \"google-cloud-storage>=1.34.*,<3\",\n \"google-cloud-bigtable>=2.11.*,<3\",\n]\n\nREDIS_REQUIRED = [\n \"redis==4.2.2\",\n \"hiredis>=2.0.0,<3\",\n]\n\nAWS_REQUIRED = [\"boto3>=1.17.0,<=1.20.23\", \"docker>=5.0.2\", \"s3fs>=0.4.0,<=2022.01.0\"]\n\nBYTEWAX_REQUIRED = [\"bytewax==0.10.0\", \"docker>=5.0.2\", \"kubernetes<=20.13.0\"]\n\nSNOWFLAKE_REQUIRED = [\n \"snowflake-connector-python[pandas]>=2.7.3,<3\",\n # `pyOpenSSL==22.1.0` requires `cryptography<39,>=38.0.0`, which is incompatible\n # with `snowflake-connector-python[pandas]==2.8.0`, which depends on\n # `cryptography<37.0.0,>=3.1.0`.\n \"pyOpenSSL<22.1.0\",\n]\n\nSPARK_REQUIRED = [\n \"pyspark>=3.0.0,<4\",\n]\n\nTRINO_REQUIRED = [\n \"trino>=0.305.0,<0.400.0\",\n]\n\nPOSTGRES_REQUIRED = [\n \"psycopg2-binary>=2.8.3,<3\",\n]\n\nMYSQL_REQUIRED = [\"mysqlclient\", \"pymysql\", \"types-PyMySQL\"]\n\nHBASE_REQUIRED = [\n \"happybase>=1.2.0,<3\",\n]\n\nCASSANDRA_REQUIRED = [\n \"cassandra-driver>=3.24.0,<4\",\n]\n\nGE_REQUIRED = [\"great_expectations>=0.14.0,<0.15.0\"]\n\nGO_REQUIRED = [\n \"cffi==1.15.*,<2\",\n]\n\nAZURE_REQUIRED = [\n \"azure-storage-blob>=0.37.0\",\n \"azure-identity>=1.6.1\",\n \"SQLAlchemy>=1.4.19\",\n \"pyodbc>=4.0.30\",\n \"pymssql\",\n]\n\nCI_REQUIRED = (\n [\n \"build\",\n \"cryptography>=35.0,<36\",\n \"flake8\",\n \"black>=22.6.0,<23\",\n \"isort>=5,<6\",\n \"grpcio-tools>=1.47.0\",\n \"grpcio-testing>=1.47.0\",\n \"minio==7.1.0\",\n \"mock==2.0.0\",\n \"moto<4\",\n \"mypy>=0.931\",\n \"mypy-protobuf==3.1\",\n \"avro==1.10.0\",\n \"gcsfs>=0.4.0,<=2022.01.0\",\n \"urllib3>=1.25.4,<2\",\n \"psutil==5.9.0\",\n \"pytest>=6.0.0,<8\",\n \"pytest-cov\",\n \"pytest-xdist\",\n \"pytest-benchmark>=3.4.1,<4\",\n \"pytest-lazy-fixture==0.6.3\",\n \"pytest-timeout==1.4.2\",\n \"pytest-ordering==0.6.*\",\n \"pytest-mock==1.10.4\",\n \"Sphinx!=4.0.0,<4.4.0\",\n \"sphinx-rtd-theme\",\n \"testcontainers>=3.5,<4\",\n \"adlfs==0.5.9\",\n \"firebase-admin>=5.2.0,<6\",\n \"pre-commit\",\n \"assertpy==1.1\",\n \"pip-tools\",\n \"pybindgen\",\n \"types-protobuf\",\n \"types-python-dateutil\",\n \"types-pytz\",\n \"types-PyYAML\",\n \"types-redis\",\n \"types-requests\",\n \"types-setuptools\",\n \"types-tabulate\",\n ]\n + GCP_REQUIRED\n + REDIS_REQUIRED\n + AWS_REQUIRED\n + BYTEWAX_REQUIRED\n + SNOWFLAKE_REQUIRED\n + SPARK_REQUIRED\n + POSTGRES_REQUIRED\n + MYSQL_REQUIRED\n + TRINO_REQUIRED\n + GE_REQUIRED\n + HBASE_REQUIRED\n + CASSANDRA_REQUIRED\n + AZURE_REQUIRED\n)\n\n\n# rtd builds fail because of mysql not being installed in their environment.\n# We can add mysql there, but it's not strictly needed. This will be faster for builds.\nDOCS_REQUIRED = CI_REQUIRED.copy()\nfor _r in MYSQL_REQUIRED:\n DOCS_REQUIRED.remove(_r)\n\nDEV_REQUIRED = [\"mypy-protobuf==3.1\", \"grpcio-testing==1.*\"] + CI_REQUIRED\n\n# Get git repo root directory\nrepo_root = str(pathlib.Path(__file__).resolve().parent)\n\n# README file from Feast repo root directory\nREADME_FILE = os.path.join(repo_root, \"README.md\")\nwith open(README_FILE, \"r\", encoding=\"utf8\") as f:\n LONG_DESCRIPTION = f.read()\n\n# Add Support for parsing tags that have a prefix containing '/' (ie 'sdk/go') to setuptools_scm.\n# Regex modified from default tag regex in:\n# https://github.com/pypa/setuptools_scm/blob/2a1b46d38fb2b8aeac09853e660bcd0d7c1bc7be/src/setuptools_scm/config.py#L9\nTAG_REGEX = re.compile(\n r\"^(?:[\\/\\w-]+)?(?P<version>[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$\"\n)\n\n# Only set use_scm_version if git executable exists (setting this variable causes pip to use git under the hood)\nif shutil.which(\"git\"):\n use_scm_version = {\"root\": \".\", \"relative_to\": __file__, \"tag_regex\": TAG_REGEX}\nelse:\n use_scm_version = None\n\nPROTO_SUBDIRS = [\"core\", \"serving\", \"types\", \"storage\"]\nPYTHON_CODE_PREFIX = \"sdk/python\"\n\n\nclass BuildPythonProtosCommand(Command):\n description = \"Builds the proto files into Python files.\"\n user_options = [\n (\"inplace\", \"i\", \"Write generated proto files to source directory.\"),\n ]\n\n def initialize_options(self):\n self.python_protoc = [\n sys.executable,\n \"-m\",\n \"grpc_tools.protoc\",\n ] # find_executable(\"protoc\")\n self.proto_folder = os.path.join(repo_root, \"protos\")\n self.sub_folders = PROTO_SUBDIRS\n self.build_lib = None\n self.inplace = 0\n\n def finalize_options(self):\n self.set_undefined_options(\"build\", (\"build_lib\", \"build_lib\"))\n\n @property\n def python_folder(self):\n if self.inplace:\n return os.path.join(\n os.path.dirname(__file__) or os.getcwd(), \"sdk/python/feast/protos\"\n )\n\n return os.path.join(self.build_lib, \"feast/protos\")\n\n def _generate_python_protos(self, path: str):\n proto_files = glob.glob(os.path.join(self.proto_folder, path))\n Path(self.python_folder).mkdir(parents=True, exist_ok=True)\n subprocess.check_call(\n self.python_protoc\n + [\n \"-I\",\n self.proto_folder,\n \"--python_out\",\n self.python_folder,\n \"--grpc_python_out\",\n self.python_folder,\n \"--mypy_out\",\n self.python_folder,\n ]\n + proto_files\n )\n\n def run(self):\n for sub_folder in self.sub_folders:\n self._generate_python_protos(f\"feast/{sub_folder}/*.proto\")\n # We need the __init__ files for each of the generated subdirs\n # so that they are regular packages, and don't need the `--namespace-packages` flags\n # when being typechecked using mypy.\n with open(f\"{self.python_folder}/feast/{sub_folder}/__init__.py\", \"w\"):\n pass\n\n with open(f\"{self.python_folder}/__init__.py\", \"w\"):\n pass\n with open(f\"{self.python_folder}/feast/__init__.py\", \"w\"):\n pass\n\n for path in Path(self.python_folder).rglob(\"*.py\"):\n for folder in self.sub_folders:\n # Read in the file\n with open(path, \"r\") as file:\n filedata = file.read()\n\n # Replace the target string\n filedata = filedata.replace(\n f\"from feast.{folder}\", f\"from feast.protos.feast.{folder}\"\n )\n\n # Write the file out again\n with open(path, \"w\") as file:\n file.write(filedata)\n\n\ndef _generate_path_with_gopath():\n go_path = subprocess.check_output([\"go\", \"env\", \"GOPATH\"]).decode(\"utf-8\")\n go_path = go_path.strip()\n path_val = os.getenv(\"PATH\")\n path_val = f\"{path_val}:{go_path}/bin\"\n\n return path_val\n\n\ndef _ensure_go_and_proto_toolchain():\n try:\n version = subprocess.check_output([\"go\", \"version\"])\n except Exception as e:\n raise RuntimeError(\"Unable to find go toolchain\") from e\n\n semver_string = re.search(r\"go[\\S]+\", str(version)).group().lstrip(\"go\")\n parts = semver_string.split(\".\")\n if not (int(parts[0]) >= 1 and int(parts[1]) >= 16):\n raise RuntimeError(f\"Go compiler too old; expected 1.16+ found {semver_string}\")\n\n path_val = _generate_path_with_gopath()\n\n try:\n subprocess.check_call([\"protoc-gen-go\", \"--version\"], env={\"PATH\": path_val})\n subprocess.check_call(\n [\"protoc-gen-go-grpc\", \"--version\"], env={\"PATH\": path_val}\n )\n except Exception as e:\n raise RuntimeError(\"Unable to find go/grpc extensions for protoc\") from e\n\n\nclass BuildGoProtosCommand(Command):\n description = \"Builds the proto files into Go files.\"\n user_options = []\n\n def initialize_options(self):\n self.go_protoc = [\n sys.executable,\n \"-m\",\n \"grpc_tools.protoc\",\n ] # find_executable(\"protoc\")\n self.proto_folder = os.path.join(repo_root, \"protos\")\n self.go_folder = os.path.join(repo_root, \"go/protos\")\n self.sub_folders = PROTO_SUBDIRS\n self.path_val = _generate_path_with_gopath()\n\n def finalize_options(self):\n pass\n\n def _generate_go_protos(self, path: str):\n proto_files = glob.glob(os.path.join(self.proto_folder, path))\n\n try:\n subprocess.check_call(\n self.go_protoc\n + [\n \"-I\",\n self.proto_folder,\n \"--go_out\",\n self.go_folder,\n \"--go_opt=module=github.com/feast-dev/feast/go/protos\",\n \"--go-grpc_out\",\n self.go_folder,\n \"--go-grpc_opt=module=github.com/feast-dev/feast/go/protos\",\n ]\n + proto_files,\n env={\"PATH\": self.path_val},\n )\n except CalledProcessError as e:\n print(f\"Stderr: {e.stderr}\")\n print(f\"Stdout: {e.stdout}\")\n\n def run(self):\n go_dir = Path(repo_root) / \"go\" / \"protos\"\n go_dir.mkdir(exist_ok=True)\n for sub_folder in self.sub_folders:\n self._generate_go_protos(f\"feast/{sub_folder}/*.proto\")\n\n\nclass BuildCommand(build_py):\n \"\"\"Custom build command.\"\"\"\n\n def run(self):\n self.run_command(\"build_python_protos\")\n if os.getenv(\"COMPILE_GO\", \"false\").lower() == \"true\":\n _ensure_go_and_proto_toolchain()\n self.run_command(\"build_go_protos\")\n\n self.run_command(\"build_ext\")\n build_py.run(self)\n\n\nclass DevelopCommand(develop):\n \"\"\"Custom develop command.\"\"\"\n\n def run(self):\n self.reinitialize_command(\"build_python_protos\", inplace=1)\n self.run_command(\"build_python_protos\")\n if os.getenv(\"COMPILE_GO\", \"false\").lower() == \"true\":\n _ensure_go_and_proto_toolchain()\n self.run_command(\"build_go_protos\")\n\n develop.run(self)\n\n\nclass build_ext(_build_ext):\n def finalize_options(self) -> None:\n super().finalize_options()\n if os.getenv(\"COMPILE_GO\", \"false\").lower() == \"false\":\n self.extensions = [e for e in self.extensions if not self._is_go_ext(e)]\n\n def _is_go_ext(self, ext: Extension):\n return any(\n source.endswith(\".go\") or source.startswith(\"github\")\n for source in ext.sources\n )\n\n def build_extension(self, ext: Extension):\n print(f\"Building extension {ext}\")\n if not self._is_go_ext(ext):\n # the base class may mutate `self.compiler`\n compiler = copy.deepcopy(self.compiler)\n self.compiler, compiler = compiler, self.compiler\n try:\n return _build_ext.build_extension(self, ext)\n finally:\n self.compiler, compiler = compiler, self.compiler\n\n bin_path = _generate_path_with_gopath()\n go_env = json.loads(\n subprocess.check_output([\"go\", \"env\", \"-json\"]).decode(\"utf-8\").strip()\n )\n\n print(f\"Go env: {go_env}\")\n print(f\"CWD: {os.getcwd()}\")\n\n destination = os.path.dirname(os.path.abspath(self.get_ext_fullpath(ext.name)))\n subprocess.check_call(\n [\"go\", \"install\", \"golang.org/x/tools/cmd/goimports\"],\n env={\"PATH\": bin_path, **go_env},\n )\n subprocess.check_call(\n [\"go\", \"get\", \"github.com/go-python/[email protected]\"],\n env={\"PATH\": bin_path, **go_env},\n )\n subprocess.check_call(\n [\"go\", \"install\", \"github.com/go-python/gopy\"],\n env={\"PATH\": bin_path, **go_env},\n )\n subprocess.check_call(\n [\n \"gopy\",\n \"build\",\n \"-output\",\n destination,\n \"-vm\",\n sys.executable,\n \"--build-tags\",\n \"cgo,ccalloc\",\n \"--dynamic-link=True\",\n \"-no-make\",\n *ext.sources,\n ],\n env={\n \"PATH\": bin_path,\n \"CGO_LDFLAGS_ALLOW\": \".*\",\n **go_env,\n },\n )\n\n def copy_extensions_to_source(self):\n build_py = self.get_finalized_command(\"build_py\")\n for ext in self.extensions:\n fullname = self.get_ext_fullname(ext.name)\n modpath = fullname.split(\".\")\n package = \".\".join(modpath[:-1])\n package_dir = build_py.get_package_dir(package)\n\n src_dir = dest_dir = package_dir\n\n if src_dir.startswith(PYTHON_CODE_PREFIX):\n src_dir = package_dir[len(PYTHON_CODE_PREFIX) :]\n src_dir = src_dir.lstrip(\"/\")\n\n src_dir = os.path.join(self.build_lib, src_dir)\n\n # copy whole directory\n print(f\"Copying from {src_dir} to {dest_dir}\")\n copy_tree(src_dir, dest_dir)\n\n\nsetup(\n name=NAME,\n author=AUTHOR,\n description=DESCRIPTION,\n long_description=LONG_DESCRIPTION,\n long_description_content_type=\"text/markdown\",\n python_requires=REQUIRES_PYTHON,\n url=URL,\n packages=find_packages(\n where=PYTHON_CODE_PREFIX, exclude=(\"java\", \"infra\", \"sdk/python/tests\", \"ui\")\n ),\n package_dir={\"\": PYTHON_CODE_PREFIX},\n install_requires=REQUIRED,\n # https://stackoverflow.com/questions/28509965/setuptools-development-requirements\n # Install dev requirements with: pip install -e .[dev]\n extras_require={\n \"dev\": DEV_REQUIRED,\n \"ci\": CI_REQUIRED,\n \"gcp\": GCP_REQUIRED,\n \"aws\": AWS_REQUIRED,\n \"bytewax\": BYTEWAX_REQUIRED,\n \"redis\": REDIS_REQUIRED,\n \"snowflake\": SNOWFLAKE_REQUIRED,\n \"spark\": SPARK_REQUIRED,\n \"trino\": TRINO_REQUIRED,\n \"postgres\": POSTGRES_REQUIRED,\n \"azure\": AZURE_REQUIRED,\n \"mysql\": MYSQL_REQUIRED,\n \"ge\": GE_REQUIRED,\n \"hbase\": HBASE_REQUIRED,\n \"go\": GO_REQUIRED,\n \"docs\": DOCS_REQUIRED,\n \"cassandra\": CASSANDRA_REQUIRED,\n },\n include_package_data=True,\n license=\"Apache\",\n classifiers=[\n # Trove classifiers\n # Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers\n \"License :: OSI Approved :: Apache Software License\",\n \"Programming Language :: Python\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.7\",\n ],\n entry_points={\"console_scripts\": [\"feast=feast.cli:cli\"]},\n use_scm_version=use_scm_version,\n setup_requires=[\n \"setuptools_scm\",\n \"grpcio>=1.47.0\",\n \"grpcio-tools>=1.47.0\",\n \"mypy-protobuf==3.1\",\n \"pybindgen==0.22.0\",\n \"sphinx!=4.0.0\",\n ],\n cmdclass={\n \"build_python_protos\": BuildPythonProtosCommand,\n \"build_go_protos\": BuildGoProtosCommand,\n \"build_py\": BuildCommand,\n \"develop\": DevelopCommand,\n \"build_ext\": build_ext,\n },\n ext_modules=[\n Extension(\n \"feast.embedded_go.lib._embedded\",\n [\"github.com/feast-dev/feast/go/embedded\"],\n )\n ],\n)\n", "path": "setup.py"}]} |
gh_patches_debug_253 | rasdani/github-patches | git_diff | pytorch__TensorRT-376 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
🐛 [Bug] Memory leak in ConversionCtx::SerializeEngine()
## Bug Description
Using `trtorch::CompileGraph` many times will increase memory usage.
## To Reproduce
[Source code](https://github.com/SakodaShintaro/trtorch-test/blob/7e9f7a457b3570b40e5aa938ac400aaf5e0028ba/main.cpp)
```cpp
#include <torch/script.h>
#include <trtorch/trtorch.h>
using namespace std;
void compile() {
constexpr int64_t INPUT_CHANNEL_NUM = 256;
constexpr int64_t WIDTH = 32;
torch::jit::Module module = torch::jit::load("model.ts");
module.to(torch::kCUDA);
module.eval();
std::vector<int64_t> in_sizes = {1, INPUT_CHANNEL_NUM, WIDTH, WIDTH};
trtorch::CompileSpec::InputRange range(in_sizes);
trtorch::CompileSpec info({range});
module = trtorch::CompileGraph(module, info);
}
int main() {
for (int64_t i = 0; i < 10000; i++) {
cout << i << endl;
compile();
}
}
```
[Dockerfile](https://github.com/SakodaShintaro/trtorch-test/blob/7e9f7a457b3570b40e5aa938ac400aaf5e0028ba/docker/Dockerfile)
## What seems to be the cause
When I verified it with Valgrind, it seemed that the cause was ConversionCtx::SerializeEngine. Looking at the code, it seemed that the `serialized_engine` isn't released. After making the following modifications, the memory leak no longer occurs.
```
diff --git a/core/conversion/conversionctx/ConversionCtx.cpp b/core/conversion/conversionctx/ConversionCtx.cpp
index ff23692..c241f9c 100644
--- a/core/conversion/conversionctx/ConversionCtx.cpp
+++ b/core/conversion/conversionctx/ConversionCtx.cpp
@@ -147,7 +147,9 @@ std::string ConversionCtx::SerializeEngine() {
auto engine = builder->buildEngineWithConfig(*net, *cfg);
auto serialized_engine = engine->serialize();
engine->destroy();
- return std::string((const char*)serialized_engine->data(), serialized_engine->size());
+ std::string result = std::string((const char*)serialized_engine->data(), serialized_engine->size());
+ serialized_engine->destroy();
+ return result;
}
```
I would appreciate it if you could respond appropriately.
--- 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/trtorch/_compiler.py`
Content:
```
1 from typing import List, Dict, Any
2 import torch
3 from torch import nn
4
5 import trtorch._C
6 from trtorch._compile_spec import _parse_compile_spec
7 from trtorch._version import __version__
8 from types import FunctionType
9
10
11 def compile(module: torch.jit.ScriptModule, compile_spec: Any) -> torch.jit.ScriptModule:
12 """Compile a TorchScript module for NVIDIA GPUs using TensorRT
13
14 Takes a existing TorchScript module and a set of settings to configure the compiler
15 and will convert methods to JIT Graphs which call equivalent TensorRT engines
16
17 Converts specifically the forward method of a TorchScript Module
18
19 Args:
20 module (torch.jit.ScriptModule): Source module, a result of tracing or scripting a PyTorch
21 ``torch.nn.Module``
22 compile_spec (dict): Compilation settings including operating precision, target device, etc.
23 One key is required which is ``input_shapes``, describing the input sizes or ranges for inputs
24 to the graph. All other keys are optional
25
26 .. code-block:: py
27
28 compile_spec = {
29 "input_shapes": [
30 (1, 3, 224, 224), # Static input shape for input #1
31 {
32 "min": (1, 3, 224, 224),
33 "opt": (1, 3, 512, 512),
34 "max": (1, 3, 1024, 1024)
35 } # Dynamic input shape for input #2
36 ],
37 "device": {
38 "device_type": torch.device("cuda"), # Type of device to run engine on (for DLA use trtorch.DeviceType.DLA)
39 "gpu_id": 0, # Target gpu id to run engine (Use Xavier as gpu id for DLA)
40 "dla_core": 0, # (DLA only) Target dla core id to run engine
41 "allow_gpu_fallback": false, # (DLA only) Allow layers unsupported on DLA to run on GPU
42 },
43 "op_precision": torch.half, # Operating precision set to FP16
44 "refit": false, # enable refit
45 "debug": false, # enable debuggable engine
46 "strict_types": false, # kernels should strictly run in operating precision
47 "capability": trtorch.EngineCapability.DEFAULT, # Restrict kernel selection to safe gpu kernels or safe dla kernels
48 "num_min_timing_iters": 2, # Number of minimization timing iterations used to select kernels
49 "num_avg_timing_iters": 1, # Number of averaging timing iterations used to select kernels
50 "workspace_size": 0, # Maximum size of workspace given to TensorRT
51 "max_batch_size": 0, # Maximum batch size (must be >= 1 to be set, 0 means not set)
52 }
53
54 Input Sizes can be specified as torch sizes, tuples or lists. Op precisions can be specified using
55 torch datatypes or trtorch datatypes and you can use either torch devices or the trtorch device type enum
56 to select device type.
57
58 Returns:
59 torch.jit.ScriptModule: Compiled TorchScript Module, when run it will execute via TensorRT
60 """
61
62 if isinstance(module, torch.jit.ScriptFunction):
63 raise TypeError(
64 "torch.jit.ScriptFunction currently is not directly supported, wrap the function in a module to compile")
65
66 compiled_cpp_mod = trtorch._C.compile_graph(module._c, _parse_compile_spec(compile_spec))
67 compiled_module = torch.jit._recursive.wrap_cpp_module(compiled_cpp_mod)
68 return compiled_module
69
70
71 def convert_method_to_trt_engine(module: torch.jit.ScriptModule, method_name: str, compile_spec: Any) -> str:
72 """Convert a TorchScript module method to a serialized TensorRT engine
73
74 Converts a specified method of a module to a serialized TensorRT engine given a dictionary of conversion settings
75
76 Args:
77 module (torch.jit.ScriptModule): Source module, a result of tracing or scripting a PyTorch
78 ``torch.nn.Module``
79 method_name (str): Name of method to convert
80 compile_spec (dict): Compilation settings including operating precision, target device, etc.
81 One key is required which is ``input_shapes``, describing the input sizes or ranges for inputs
82 to the graph. All other keys are optional
83
84 .. code-block:: py
85
86 CompileSpec = {
87 "input_shapes": [
88 (1, 3, 224, 224), # Static input shape for input #1
89 {
90 "min": (1, 3, 224, 224),
91 "opt": (1, 3, 512, 512),
92 "max": (1, 3, 1024, 1024)
93 } # Dynamic input shape for input #2
94 ],
95 "device": {
96 "device_type": torch.device("cuda"), # Type of device to run engine on (for DLA use trtorch.DeviceType.DLA)
97 "gpu_id": 0, # Target gpu id to run engine (Use Xavier as gpu id for DLA)
98 "dla_core": 0, # (DLA only) Target dla core id to run engine
99 "allow_gpu_fallback": false, # (DLA only) Allow layers unsupported on DLA to run on GPU
100 },
101 "op_precision": torch.half, # Operating precision set to FP16
102 "disable_tf32": False, # Force FP32 layers to use traditional as FP32 format vs the default behavior of rounding the inputs to 10-bit mantissas before multiplying, but accumulates the sum using 23-bit mantissas
103 "refit": false, # enable refit
104 "debug": false, # enable debuggable engine
105 "strict_types": false, # kernels should strictly run in operating precision
106 "capability": trtorch.EngineCapability.DEFAULT, # Restrict kernel selection to safe gpu kernels or safe dla kernels
107 "num_min_timing_iters": 2, # Number of minimization timing iterations used to select kernels
108 "num_avg_timing_iters": 1, # Number of averaging timing iterations used to select kernels
109 "workspace_size": 0, # Maximum size of workspace given to TensorRT
110 "max_batch_size": 0, # Maximum batch size (must be >= 1 to be set, 0 means not set)
111 }
112
113 Input Sizes can be specified as torch sizes, tuples or lists. Op precisions can be specified using
114 torch datatypes or trtorch datatypes and you can use either torch devices or the trtorch device type enum
115 to select device type.
116
117 Returns:
118 bytes: Serialized TensorRT engine, can either be saved to a file or deserialized via TensorRT APIs
119 """
120 if isinstance(module, torch.jit.ScriptFunction):
121 raise TypeError(
122 "torch.jit.ScriptFunctions currently are not directly supported, wrap the function in a module to compile")
123
124 return trtorch._C.convert_graph_to_trt_engine(module._c, method_name, _parse_compile_spec(compile_spec))
125
126
127 def check_method_op_support(module: torch.jit.ScriptModule, method_name: str) -> bool:
128 """Checks to see if a method is fully supported by TRTorch
129
130 Checks if a method of a TorchScript module can be compiled by TRTorch, if not, a list of operators
131 that are not supported are printed out and the function returns false, else true.
132
133 Args:
134 module (torch.jit.ScriptModule): Source module, a result of tracing or scripting a PyTorch
135 ``torch.nn.Module``
136 method_name (str): Name of method to check
137
138 Returns:
139 bool: True if supported Method
140 """
141 return trtorch._C.check_method_op_support(module._c, method_name)
142
143
144 def dump_build_info():
145 """Prints build information about the TRTorch distribution to stdout
146 """
147 print(get_build_info())
148
149
150 def get_build_info() -> str:
151 """Returns a string containing the build information of TRTorch distribution
152
153 Returns:
154 str: String containing the build information for TRTorch distribution
155 """
156 build_info = trtorch._C.get_build_info()
157 build_info = "TRTorch Version: " + str(__version__) + '\n' + build_info
158 return build_info
159
160 def set_device(gpu_id):
161 trtorch._C.set_device(gpu_id)
162
```
--- 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/trtorch/_compiler.py b/py/trtorch/_compiler.py
--- a/py/trtorch/_compiler.py
+++ b/py/trtorch/_compiler.py
@@ -157,5 +157,6 @@
build_info = "TRTorch Version: " + str(__version__) + '\n' + build_info
return build_info
+
def set_device(gpu_id):
trtorch._C.set_device(gpu_id)
| {"golden_diff": "diff --git a/py/trtorch/_compiler.py b/py/trtorch/_compiler.py\n--- a/py/trtorch/_compiler.py\n+++ b/py/trtorch/_compiler.py\n@@ -157,5 +157,6 @@\n build_info = \"TRTorch Version: \" + str(__version__) + '\\n' + build_info\n return build_info\n \n+\n def set_device(gpu_id):\n trtorch._C.set_device(gpu_id)\n", "issue": "\ud83d\udc1b [Bug] Memory leak in ConversionCtx::SerializeEngine()\n## Bug Description\r\nUsing `trtorch::CompileGraph` many times will increase memory usage.\r\n\r\n## To Reproduce\r\n[Source code](https://github.com/SakodaShintaro/trtorch-test/blob/7e9f7a457b3570b40e5aa938ac400aaf5e0028ba/main.cpp)\r\n\r\n```cpp\r\n#include <torch/script.h>\r\n#include <trtorch/trtorch.h>\r\nusing namespace std;\r\n\r\nvoid compile() {\r\n constexpr int64_t INPUT_CHANNEL_NUM = 256;\r\n constexpr int64_t WIDTH = 32;\r\n torch::jit::Module module = torch::jit::load(\"model.ts\");\r\n module.to(torch::kCUDA);\r\n module.eval();\r\n\r\n std::vector<int64_t> in_sizes = {1, INPUT_CHANNEL_NUM, WIDTH, WIDTH};\r\n trtorch::CompileSpec::InputRange range(in_sizes);\r\n trtorch::CompileSpec info({range});\r\n module = trtorch::CompileGraph(module, info);\r\n}\r\n\r\nint main() {\r\n for (int64_t i = 0; i < 10000; i++) {\r\n cout << i << endl;\r\n compile();\r\n }\r\n}\r\n```\r\n\r\n[Dockerfile](https://github.com/SakodaShintaro/trtorch-test/blob/7e9f7a457b3570b40e5aa938ac400aaf5e0028ba/docker/Dockerfile)\r\n\r\n## What seems to be the cause\r\nWhen I verified it with Valgrind, it seemed that the cause was ConversionCtx::SerializeEngine. Looking at the code, it seemed that the `serialized_engine` isn't released. After making the following modifications, the memory leak no longer occurs.\r\n\r\n```\r\ndiff --git a/core/conversion/conversionctx/ConversionCtx.cpp b/core/conversion/conversionctx/ConversionCtx.cpp\r\nindex ff23692..c241f9c 100644\r\n--- a/core/conversion/conversionctx/ConversionCtx.cpp\r\n+++ b/core/conversion/conversionctx/ConversionCtx.cpp\r\n@@ -147,7 +147,9 @@ std::string ConversionCtx::SerializeEngine() {\r\n auto engine = builder->buildEngineWithConfig(*net, *cfg);\r\n auto serialized_engine = engine->serialize();\r\n engine->destroy();\r\n- return std::string((const char*)serialized_engine->data(), serialized_engine->size());\r\n+ std::string result = std::string((const char*)serialized_engine->data(), serialized_engine->size());\r\n+ serialized_engine->destroy();\r\n+ return result;\r\n }\r\n ```\r\n\r\nI would appreciate it if you could respond appropriately.\n", "before_files": [{"content": "from typing import List, Dict, Any\nimport torch\nfrom torch import nn\n\nimport trtorch._C\nfrom trtorch._compile_spec import _parse_compile_spec\nfrom trtorch._version import __version__\nfrom types import FunctionType\n\n\ndef compile(module: torch.jit.ScriptModule, compile_spec: Any) -> torch.jit.ScriptModule:\n \"\"\"Compile a TorchScript module for NVIDIA GPUs using TensorRT\n\n Takes a existing TorchScript module and a set of settings to configure the compiler\n and will convert methods to JIT Graphs which call equivalent TensorRT engines\n\n Converts specifically the forward method of a TorchScript Module\n\n Args:\n module (torch.jit.ScriptModule): Source module, a result of tracing or scripting a PyTorch\n ``torch.nn.Module``\n compile_spec (dict): Compilation settings including operating precision, target device, etc.\n One key is required which is ``input_shapes``, describing the input sizes or ranges for inputs\n to the graph. All other keys are optional\n\n .. code-block:: py\n\n compile_spec = {\n \"input_shapes\": [\n (1, 3, 224, 224), # Static input shape for input #1\n {\n \"min\": (1, 3, 224, 224),\n \"opt\": (1, 3, 512, 512),\n \"max\": (1, 3, 1024, 1024)\n } # Dynamic input shape for input #2\n ],\n \"device\": {\n \"device_type\": torch.device(\"cuda\"), # Type of device to run engine on (for DLA use trtorch.DeviceType.DLA)\n \"gpu_id\": 0, # Target gpu id to run engine (Use Xavier as gpu id for DLA)\n \"dla_core\": 0, # (DLA only) Target dla core id to run engine\n \"allow_gpu_fallback\": false, # (DLA only) Allow layers unsupported on DLA to run on GPU\n },\n \"op_precision\": torch.half, # Operating precision set to FP16\n \"refit\": false, # enable refit\n \"debug\": false, # enable debuggable engine\n \"strict_types\": false, # kernels should strictly run in operating precision\n \"capability\": trtorch.EngineCapability.DEFAULT, # Restrict kernel selection to safe gpu kernels or safe dla kernels\n \"num_min_timing_iters\": 2, # Number of minimization timing iterations used to select kernels\n \"num_avg_timing_iters\": 1, # Number of averaging timing iterations used to select kernels\n \"workspace_size\": 0, # Maximum size of workspace given to TensorRT\n \"max_batch_size\": 0, # Maximum batch size (must be >= 1 to be set, 0 means not set)\n }\n\n Input Sizes can be specified as torch sizes, tuples or lists. Op precisions can be specified using\n torch datatypes or trtorch datatypes and you can use either torch devices or the trtorch device type enum\n to select device type.\n\n Returns:\n torch.jit.ScriptModule: Compiled TorchScript Module, when run it will execute via TensorRT\n \"\"\"\n\n if isinstance(module, torch.jit.ScriptFunction):\n raise TypeError(\n \"torch.jit.ScriptFunction currently is not directly supported, wrap the function in a module to compile\")\n\n compiled_cpp_mod = trtorch._C.compile_graph(module._c, _parse_compile_spec(compile_spec))\n compiled_module = torch.jit._recursive.wrap_cpp_module(compiled_cpp_mod)\n return compiled_module\n\n\ndef convert_method_to_trt_engine(module: torch.jit.ScriptModule, method_name: str, compile_spec: Any) -> str:\n \"\"\"Convert a TorchScript module method to a serialized TensorRT engine\n\n Converts a specified method of a module to a serialized TensorRT engine given a dictionary of conversion settings\n\n Args:\n module (torch.jit.ScriptModule): Source module, a result of tracing or scripting a PyTorch\n ``torch.nn.Module``\n method_name (str): Name of method to convert\n compile_spec (dict): Compilation settings including operating precision, target device, etc.\n One key is required which is ``input_shapes``, describing the input sizes or ranges for inputs\n to the graph. All other keys are optional\n\n .. code-block:: py\n\n CompileSpec = {\n \"input_shapes\": [\n (1, 3, 224, 224), # Static input shape for input #1\n {\n \"min\": (1, 3, 224, 224),\n \"opt\": (1, 3, 512, 512),\n \"max\": (1, 3, 1024, 1024)\n } # Dynamic input shape for input #2\n ],\n \"device\": {\n \"device_type\": torch.device(\"cuda\"), # Type of device to run engine on (for DLA use trtorch.DeviceType.DLA)\n \"gpu_id\": 0, # Target gpu id to run engine (Use Xavier as gpu id for DLA)\n \"dla_core\": 0, # (DLA only) Target dla core id to run engine\n \"allow_gpu_fallback\": false, # (DLA only) Allow layers unsupported on DLA to run on GPU\n },\n \"op_precision\": torch.half, # Operating precision set to FP16\n \"disable_tf32\": False, # Force FP32 layers to use traditional as FP32 format vs the default behavior of rounding the inputs to 10-bit mantissas before multiplying, but accumulates the sum using 23-bit mantissas\n \"refit\": false, # enable refit\n \"debug\": false, # enable debuggable engine\n \"strict_types\": false, # kernels should strictly run in operating precision\n \"capability\": trtorch.EngineCapability.DEFAULT, # Restrict kernel selection to safe gpu kernels or safe dla kernels\n \"num_min_timing_iters\": 2, # Number of minimization timing iterations used to select kernels\n \"num_avg_timing_iters\": 1, # Number of averaging timing iterations used to select kernels\n \"workspace_size\": 0, # Maximum size of workspace given to TensorRT\n \"max_batch_size\": 0, # Maximum batch size (must be >= 1 to be set, 0 means not set)\n }\n\n Input Sizes can be specified as torch sizes, tuples or lists. Op precisions can be specified using\n torch datatypes or trtorch datatypes and you can use either torch devices or the trtorch device type enum\n to select device type.\n\n Returns:\n bytes: Serialized TensorRT engine, can either be saved to a file or deserialized via TensorRT APIs\n \"\"\"\n if isinstance(module, torch.jit.ScriptFunction):\n raise TypeError(\n \"torch.jit.ScriptFunctions currently are not directly supported, wrap the function in a module to compile\")\n\n return trtorch._C.convert_graph_to_trt_engine(module._c, method_name, _parse_compile_spec(compile_spec))\n\n\ndef check_method_op_support(module: torch.jit.ScriptModule, method_name: str) -> bool:\n \"\"\"Checks to see if a method is fully supported by TRTorch\n\n Checks if a method of a TorchScript module can be compiled by TRTorch, if not, a list of operators\n that are not supported are printed out and the function returns false, else true.\n\n Args:\n module (torch.jit.ScriptModule): Source module, a result of tracing or scripting a PyTorch\n ``torch.nn.Module``\n method_name (str): Name of method to check\n\n Returns:\n bool: True if supported Method\n \"\"\"\n return trtorch._C.check_method_op_support(module._c, method_name)\n\n\ndef dump_build_info():\n \"\"\"Prints build information about the TRTorch distribution to stdout\n \"\"\"\n print(get_build_info())\n\n\ndef get_build_info() -> str:\n \"\"\"Returns a string containing the build information of TRTorch distribution\n\n Returns:\n str: String containing the build information for TRTorch distribution\n \"\"\"\n build_info = trtorch._C.get_build_info()\n build_info = \"TRTorch Version: \" + str(__version__) + '\\n' + build_info\n return build_info\n\ndef set_device(gpu_id):\n trtorch._C.set_device(gpu_id)\n", "path": "py/trtorch/_compiler.py"}], "after_files": [{"content": "from typing import List, Dict, Any\nimport torch\nfrom torch import nn\n\nimport trtorch._C\nfrom trtorch._compile_spec import _parse_compile_spec\nfrom trtorch._version import __version__\nfrom types import FunctionType\n\n\ndef compile(module: torch.jit.ScriptModule, compile_spec: Any) -> torch.jit.ScriptModule:\n \"\"\"Compile a TorchScript module for NVIDIA GPUs using TensorRT\n\n Takes a existing TorchScript module and a set of settings to configure the compiler\n and will convert methods to JIT Graphs which call equivalent TensorRT engines\n\n Converts specifically the forward method of a TorchScript Module\n\n Args:\n module (torch.jit.ScriptModule): Source module, a result of tracing or scripting a PyTorch\n ``torch.nn.Module``\n compile_spec (dict): Compilation settings including operating precision, target device, etc.\n One key is required which is ``input_shapes``, describing the input sizes or ranges for inputs\n to the graph. All other keys are optional\n\n .. code-block:: py\n\n compile_spec = {\n \"input_shapes\": [\n (1, 3, 224, 224), # Static input shape for input #1\n {\n \"min\": (1, 3, 224, 224),\n \"opt\": (1, 3, 512, 512),\n \"max\": (1, 3, 1024, 1024)\n } # Dynamic input shape for input #2\n ],\n \"device\": {\n \"device_type\": torch.device(\"cuda\"), # Type of device to run engine on (for DLA use trtorch.DeviceType.DLA)\n \"gpu_id\": 0, # Target gpu id to run engine (Use Xavier as gpu id for DLA)\n \"dla_core\": 0, # (DLA only) Target dla core id to run engine\n \"allow_gpu_fallback\": false, # (DLA only) Allow layers unsupported on DLA to run on GPU\n },\n \"op_precision\": torch.half, # Operating precision set to FP16\n \"refit\": false, # enable refit\n \"debug\": false, # enable debuggable engine\n \"strict_types\": false, # kernels should strictly run in operating precision\n \"capability\": trtorch.EngineCapability.DEFAULT, # Restrict kernel selection to safe gpu kernels or safe dla kernels\n \"num_min_timing_iters\": 2, # Number of minimization timing iterations used to select kernels\n \"num_avg_timing_iters\": 1, # Number of averaging timing iterations used to select kernels\n \"workspace_size\": 0, # Maximum size of workspace given to TensorRT\n \"max_batch_size\": 0, # Maximum batch size (must be >= 1 to be set, 0 means not set)\n }\n\n Input Sizes can be specified as torch sizes, tuples or lists. Op precisions can be specified using\n torch datatypes or trtorch datatypes and you can use either torch devices or the trtorch device type enum\n to select device type.\n\n Returns:\n torch.jit.ScriptModule: Compiled TorchScript Module, when run it will execute via TensorRT\n \"\"\"\n\n if isinstance(module, torch.jit.ScriptFunction):\n raise TypeError(\n \"torch.jit.ScriptFunction currently is not directly supported, wrap the function in a module to compile\")\n\n compiled_cpp_mod = trtorch._C.compile_graph(module._c, _parse_compile_spec(compile_spec))\n compiled_module = torch.jit._recursive.wrap_cpp_module(compiled_cpp_mod)\n return compiled_module\n\n\ndef convert_method_to_trt_engine(module: torch.jit.ScriptModule, method_name: str, compile_spec: Any) -> str:\n \"\"\"Convert a TorchScript module method to a serialized TensorRT engine\n\n Converts a specified method of a module to a serialized TensorRT engine given a dictionary of conversion settings\n\n Args:\n module (torch.jit.ScriptModule): Source module, a result of tracing or scripting a PyTorch\n ``torch.nn.Module``\n method_name (str): Name of method to convert\n compile_spec (dict): Compilation settings including operating precision, target device, etc.\n One key is required which is ``input_shapes``, describing the input sizes or ranges for inputs\n to the graph. All other keys are optional\n\n .. code-block:: py\n\n CompileSpec = {\n \"input_shapes\": [\n (1, 3, 224, 224), # Static input shape for input #1\n {\n \"min\": (1, 3, 224, 224),\n \"opt\": (1, 3, 512, 512),\n \"max\": (1, 3, 1024, 1024)\n } # Dynamic input shape for input #2\n ],\n \"device\": {\n \"device_type\": torch.device(\"cuda\"), # Type of device to run engine on (for DLA use trtorch.DeviceType.DLA)\n \"gpu_id\": 0, # Target gpu id to run engine (Use Xavier as gpu id for DLA)\n \"dla_core\": 0, # (DLA only) Target dla core id to run engine\n \"allow_gpu_fallback\": false, # (DLA only) Allow layers unsupported on DLA to run on GPU\n },\n \"op_precision\": torch.half, # Operating precision set to FP16\n \"disable_tf32\": False, # Force FP32 layers to use traditional as FP32 format vs the default behavior of rounding the inputs to 10-bit mantissas before multiplying, but accumulates the sum using 23-bit mantissas\n \"refit\": false, # enable refit\n \"debug\": false, # enable debuggable engine\n \"strict_types\": false, # kernels should strictly run in operating precision\n \"capability\": trtorch.EngineCapability.DEFAULT, # Restrict kernel selection to safe gpu kernels or safe dla kernels\n \"num_min_timing_iters\": 2, # Number of minimization timing iterations used to select kernels\n \"num_avg_timing_iters\": 1, # Number of averaging timing iterations used to select kernels\n \"workspace_size\": 0, # Maximum size of workspace given to TensorRT\n \"max_batch_size\": 0, # Maximum batch size (must be >= 1 to be set, 0 means not set)\n }\n\n Input Sizes can be specified as torch sizes, tuples or lists. Op precisions can be specified using\n torch datatypes or trtorch datatypes and you can use either torch devices or the trtorch device type enum\n to select device type.\n\n Returns:\n bytes: Serialized TensorRT engine, can either be saved to a file or deserialized via TensorRT APIs\n \"\"\"\n if isinstance(module, torch.jit.ScriptFunction):\n raise TypeError(\n \"torch.jit.ScriptFunctions currently are not directly supported, wrap the function in a module to compile\")\n\n return trtorch._C.convert_graph_to_trt_engine(module._c, method_name, _parse_compile_spec(compile_spec))\n\n\ndef check_method_op_support(module: torch.jit.ScriptModule, method_name: str) -> bool:\n \"\"\"Checks to see if a method is fully supported by TRTorch\n\n Checks if a method of a TorchScript module can be compiled by TRTorch, if not, a list of operators\n that are not supported are printed out and the function returns false, else true.\n\n Args:\n module (torch.jit.ScriptModule): Source module, a result of tracing or scripting a PyTorch\n ``torch.nn.Module``\n method_name (str): Name of method to check\n\n Returns:\n bool: True if supported Method\n \"\"\"\n return trtorch._C.check_method_op_support(module._c, method_name)\n\n\ndef dump_build_info():\n \"\"\"Prints build information about the TRTorch distribution to stdout\n \"\"\"\n print(get_build_info())\n\n\ndef get_build_info() -> str:\n \"\"\"Returns a string containing the build information of TRTorch distribution\n\n Returns:\n str: String containing the build information for TRTorch distribution\n \"\"\"\n build_info = trtorch._C.get_build_info()\n build_info = \"TRTorch Version: \" + str(__version__) + '\\n' + build_info\n return build_info\n\n\ndef set_device(gpu_id):\n trtorch._C.set_device(gpu_id)\n", "path": "py/trtorch/_compiler.py"}]} |
gh_patches_debug_254 | rasdani/github-patches | git_diff | cookiecutter__cookiecutter-1562 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
prompt.read_user_dict() is broken due to click upgrade from 7.1.2 to 8.0.0
* Cookiecutter version: 1.7.3
* Template project url: -
* Python version: 3.9.5
* Operating System: macOS Catalina 10.15.7
### Description:
Apparently, there is a breaking change in `click==8.0.0` affecting dictionary values in cookiecutter.json
cookiecutter.json example:
```json
{
"project_name": "",
"project_policy": {"project_policy_example": "yes"}
}
```
```
% python -m cookiecutter ../Projects/project-configs
devplatform_project_name [infra-dev]:
project_name []: t
project_policy [default]:
Error: Unable to decode to JSON.
```
Looking closer at the cookiecutter.promt, I can see that in `read_user_dict()`, click passes `user_value='default'` to `process_json()`, instead of passing an actual default value from the cookiecutter.json as it was in `click 7.1.2`.
Link to the `process_json()` code: https://github.com/cookiecutter/cookiecutter/blob/master/cookiecutter/prompt.py#L81
As far as I can suppose, that issue could have been introduced by this PR https://github.com/pallets/click/pull/1517/
### Quick local fix
Install click first and specify version older than 8.0.0
```
pip install click==7.1.2
pip install cookiecutter
```
### Quick fix for cookiecutter library
in `setup.py` replace 'click>=7.0' with `'click>=7,<8.0.0'`
### What I've run:
```shell
% python3.9 -m venv test39
% source test39/bin/activate
% python -V
Python 3.9.5
% python -m pip install click==7.1.2
Collecting click==7.1.2
Using cached click-7.1.2-py2.py3-none-any.whl (82 kB)
Installing collected packages: click
Successfully installed click-7.1.2
(test39) ro.solyanik@macbook-ro Environments % python -m pip install cookiecutter
Collecting cookiecutter
Using cached cookiecutter-1.7.3-py2.py3-none-any.whl (34 kB)
Collecting six>=1.10
................................................
Installing collected packages: six, python-dateutil, MarkupSafe, urllib3, text-unidecode, Jinja2, idna, chardet, certifi, arrow, requests, python-slugify, poyo, jinja2-time, binaryornot, cookiecutter
Successfully installed Jinja2-3.0.1 MarkupSafe-2.0.1 arrow-1.1.0 binaryornot-0.4.4 certifi-2020.12.5 chardet-4.0.0 cookiecutter-1.7.3 idna-2.10 jinja2-time-0.2.0 poyo-0.5.0 python-dateutil-2.8.1 python-slugify-5.0.2 requests-2.25.1 six-1.16.0 text-unidecode-1.3 urllib3-1.26.4
% python -m cookiecutter ../Projects/project-configs
project_name []: t
project_policy [default]:
% ls t
Makefile README.md t tests
% rm -rf t
% python -m pip install click==8.0.0
Collecting click==8.0.0
Using cached click-8.0.0-py3-none-any.whl (96 kB)
Installing collected packages: click
Attempting uninstall: click
Found existing installation: click 7.1.2
Uninstalling click-7.1.2:
Successfully uninstalled click-7.1.2
Successfully installed click-8.0.0
% python -m cookiecutter ../Projects/project-configs
devplatform_project_name [infra-dev]:
project_name []: t
project_policy [default]:
Error: Unable to decode to JSON.
project_policy [default]:
Error: Unable to decode to JSON.
```
--- 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 """cookiecutter distutils configuration."""
3 from setuptools import setup
4
5 version = "2.0.0"
6
7 with open('README.md', encoding='utf-8') as readme_file:
8 readme = readme_file.read()
9
10 requirements = [
11 'binaryornot>=0.4.4',
12 'Jinja2>=2.7,<4.0.0',
13 'click>=7.0',
14 'pyyaml>=5.3.1',
15 'jinja2-time>=0.2.0',
16 'python-slugify>=4.0.0',
17 'requests>=2.23.0',
18 ]
19
20 setup(
21 name='cookiecutter',
22 version=version,
23 description=(
24 'A command-line utility that creates projects from project '
25 'templates, e.g. creating a Python package project from a '
26 'Python package project template.'
27 ),
28 long_description=readme,
29 long_description_content_type='text/markdown',
30 author='Audrey Feldroy',
31 author_email='[email protected]',
32 url='https://github.com/cookiecutter/cookiecutter',
33 packages=['cookiecutter'],
34 package_dir={'cookiecutter': 'cookiecutter'},
35 entry_points={'console_scripts': ['cookiecutter = cookiecutter.__main__:main']},
36 include_package_data=True,
37 python_requires='>=3.6',
38 install_requires=requirements,
39 license='BSD',
40 zip_safe=False,
41 classifiers=[
42 "Development Status :: 5 - Production/Stable",
43 "Environment :: Console",
44 "Intended Audience :: Developers",
45 "Natural Language :: English",
46 "License :: OSI Approved :: BSD License",
47 "Programming Language :: Python :: 3 :: Only",
48 "Programming Language :: Python :: 3",
49 "Programming Language :: Python :: 3.6",
50 "Programming Language :: Python :: 3.7",
51 "Programming Language :: Python :: 3.8",
52 "Programming Language :: Python :: 3.9",
53 "Programming Language :: Python :: Implementation :: CPython",
54 "Programming Language :: Python :: Implementation :: PyPy",
55 "Programming Language :: Python",
56 "Topic :: Software Development",
57 ],
58 keywords=[
59 "cookiecutter",
60 "Python",
61 "projects",
62 "project templates",
63 "Jinja2",
64 "skeleton",
65 "scaffolding",
66 "project directory",
67 "package",
68 "packaging",
69 ],
70 )
71
```
--- 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
@@ -10,7 +10,7 @@
requirements = [
'binaryornot>=0.4.4',
'Jinja2>=2.7,<4.0.0',
- 'click>=7.0',
+ 'click>=7.0,<8.0.0',
'pyyaml>=5.3.1',
'jinja2-time>=0.2.0',
'python-slugify>=4.0.0',
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -10,7 +10,7 @@\n requirements = [\n 'binaryornot>=0.4.4',\n 'Jinja2>=2.7,<4.0.0',\n- 'click>=7.0',\n+ 'click>=7.0,<8.0.0',\n 'pyyaml>=5.3.1',\n 'jinja2-time>=0.2.0',\n 'python-slugify>=4.0.0',\n", "issue": "prompt.read_user_dict() is broken due to click upgrade from 7.1.2 to 8.0.0\n* Cookiecutter version: 1.7.3\r\n* Template project url: -\r\n* Python version: 3.9.5\r\n* Operating System: macOS Catalina 10.15.7\r\n\r\n### Description:\r\n\r\nApparently, there is a breaking change in `click==8.0.0` affecting dictionary values in cookiecutter.json\r\ncookiecutter.json example:\r\n```json\r\n{\r\n \"project_name\": \"\",\r\n \"project_policy\": {\"project_policy_example\": \"yes\"}\r\n}\r\n```\r\n \r\n```\r\n% python -m cookiecutter ../Projects/project-configs\r\ndevplatform_project_name [infra-dev]: \r\nproject_name []: t\r\nproject_policy [default]: \r\nError: Unable to decode to JSON.\r\n```\r\n\r\nLooking closer at the cookiecutter.promt, I can see that in `read_user_dict()`, click passes `user_value='default'` to `process_json()`, instead of passing an actual default value from the cookiecutter.json as it was in `click 7.1.2`. \r\nLink to the `process_json()` code: https://github.com/cookiecutter/cookiecutter/blob/master/cookiecutter/prompt.py#L81\r\n\r\n\r\nAs far as I can suppose, that issue could have been introduced by this PR https://github.com/pallets/click/pull/1517/\r\n\r\n### Quick local fix\r\nInstall click first and specify version older than 8.0.0\r\n```\r\npip install click==7.1.2\r\npip install cookiecutter\r\n```\r\n\r\n### Quick fix for cookiecutter library\r\nin `setup.py` replace 'click>=7.0' with `'click>=7,<8.0.0'`\r\n\r\n### What I've run:\r\n\r\n```shell\r\n% python3.9 -m venv test39 \r\n \r\n% source test39/bin/activate\r\n\r\n% python -V\r\nPython 3.9.5\r\n\r\n\r\n% python -m pip install click==7.1.2\r\nCollecting click==7.1.2\r\n Using cached click-7.1.2-py2.py3-none-any.whl (82 kB)\r\nInstalling collected packages: click\r\nSuccessfully installed click-7.1.2\r\n(test39) ro.solyanik@macbook-ro Environments % python -m pip install cookiecutter\r\nCollecting cookiecutter\r\n Using cached cookiecutter-1.7.3-py2.py3-none-any.whl (34 kB)\r\nCollecting six>=1.10\r\n................................................\r\nInstalling collected packages: six, python-dateutil, MarkupSafe, urllib3, text-unidecode, Jinja2, idna, chardet, certifi, arrow, requests, python-slugify, poyo, jinja2-time, binaryornot, cookiecutter\r\nSuccessfully installed Jinja2-3.0.1 MarkupSafe-2.0.1 arrow-1.1.0 binaryornot-0.4.4 certifi-2020.12.5 chardet-4.0.0 cookiecutter-1.7.3 idna-2.10 jinja2-time-0.2.0 poyo-0.5.0 python-dateutil-2.8.1 python-slugify-5.0.2 requests-2.25.1 six-1.16.0 text-unidecode-1.3 urllib3-1.26.4\r\n\r\n% python -m cookiecutter ../Projects/project-configs\r\nproject_name []: t\r\nproject_policy [default]: \r\n\r\n% ls t \r\nMakefile README.md t tests\r\n\r\n% rm -rf t\r\n\r\n% python -m pip install click==8.0.0 \r\nCollecting click==8.0.0\r\n Using cached click-8.0.0-py3-none-any.whl (96 kB)\r\nInstalling collected packages: click\r\n Attempting uninstall: click\r\n Found existing installation: click 7.1.2\r\n Uninstalling click-7.1.2:\r\n Successfully uninstalled click-7.1.2\r\nSuccessfully installed click-8.0.0\r\n\r\n% python -m cookiecutter ../Projects/project-configs\r\ndevplatform_project_name [infra-dev]: \r\nproject_name []: t\r\nproject_policy [default]: \r\nError: Unable to decode to JSON.\r\nproject_policy [default]: \r\nError: Unable to decode to JSON.\r\n```\n", "before_files": [{"content": "#!/usr/bin/env python\n\"\"\"cookiecutter distutils configuration.\"\"\"\nfrom setuptools import setup\n\nversion = \"2.0.0\"\n\nwith open('README.md', encoding='utf-8') as readme_file:\n readme = readme_file.read()\n\nrequirements = [\n 'binaryornot>=0.4.4',\n 'Jinja2>=2.7,<4.0.0',\n 'click>=7.0',\n 'pyyaml>=5.3.1',\n 'jinja2-time>=0.2.0',\n 'python-slugify>=4.0.0',\n 'requests>=2.23.0',\n]\n\nsetup(\n name='cookiecutter',\n version=version,\n description=(\n 'A command-line utility that creates projects from project '\n 'templates, e.g. creating a Python package project from a '\n 'Python package project template.'\n ),\n long_description=readme,\n long_description_content_type='text/markdown',\n author='Audrey Feldroy',\n author_email='[email protected]',\n url='https://github.com/cookiecutter/cookiecutter',\n packages=['cookiecutter'],\n package_dir={'cookiecutter': 'cookiecutter'},\n entry_points={'console_scripts': ['cookiecutter = cookiecutter.__main__:main']},\n include_package_data=True,\n python_requires='>=3.6',\n install_requires=requirements,\n license='BSD',\n zip_safe=False,\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"Natural Language :: English\",\n \"License :: OSI Approved :: BSD License\",\n \"Programming Language :: Python :: 3 :: Only\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\",\n \"Programming Language :: Python :: Implementation :: CPython\",\n \"Programming Language :: Python :: Implementation :: PyPy\",\n \"Programming Language :: Python\",\n \"Topic :: Software Development\",\n ],\n keywords=[\n \"cookiecutter\",\n \"Python\",\n \"projects\",\n \"project templates\",\n \"Jinja2\",\n \"skeleton\",\n \"scaffolding\",\n \"project directory\",\n \"package\",\n \"packaging\",\n ],\n)\n", "path": "setup.py"}], "after_files": [{"content": "#!/usr/bin/env python\n\"\"\"cookiecutter distutils configuration.\"\"\"\nfrom setuptools import setup\n\nversion = \"2.0.0\"\n\nwith open('README.md', encoding='utf-8') as readme_file:\n readme = readme_file.read()\n\nrequirements = [\n 'binaryornot>=0.4.4',\n 'Jinja2>=2.7,<4.0.0',\n 'click>=7.0,<8.0.0',\n 'pyyaml>=5.3.1',\n 'jinja2-time>=0.2.0',\n 'python-slugify>=4.0.0',\n 'requests>=2.23.0',\n]\n\nsetup(\n name='cookiecutter',\n version=version,\n description=(\n 'A command-line utility that creates projects from project '\n 'templates, e.g. creating a Python package project from a '\n 'Python package project template.'\n ),\n long_description=readme,\n long_description_content_type='text/markdown',\n author='Audrey Feldroy',\n author_email='[email protected]',\n url='https://github.com/cookiecutter/cookiecutter',\n packages=['cookiecutter'],\n package_dir={'cookiecutter': 'cookiecutter'},\n entry_points={'console_scripts': ['cookiecutter = cookiecutter.__main__:main']},\n include_package_data=True,\n python_requires='>=3.6',\n install_requires=requirements,\n license='BSD',\n zip_safe=False,\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"Natural Language :: English\",\n \"License :: OSI Approved :: BSD License\",\n \"Programming Language :: Python :: 3 :: Only\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\",\n \"Programming Language :: Python :: Implementation :: CPython\",\n \"Programming Language :: Python :: Implementation :: PyPy\",\n \"Programming Language :: Python\",\n \"Topic :: Software Development\",\n ],\n keywords=[\n \"cookiecutter\",\n \"Python\",\n \"projects\",\n \"project templates\",\n \"Jinja2\",\n \"skeleton\",\n \"scaffolding\",\n \"project directory\",\n \"package\",\n \"packaging\",\n ],\n)\n", "path": "setup.py"}]} |
gh_patches_debug_255 | rasdani/github-patches | git_diff | OpenEnergyPlatform__oeplatform-605 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Add OEO Steering Committee Subpage
The OEO Steering Committee needs its own web page, which should be a sub page of the OEP. Please create such a sub page @jh-RLI . I think it makes sense to link it somewhere under ontology.
https://openenergy-platform.org/ontology/
The URL would then be
https://openenergy-platform.org/ontology/oeo-steering-committee
Content for the page is here:
https://github.com/OpenEnergyPlatform/ontology/wiki/OEO-Steering-Committee
An issue to create an English translation is open here: https://github.com/OpenEnergyPlatform/ontology/issues/313
Creating the page and making it look simple, but decent enough are priorities. The final text and location can easily be changed later on. Contact me if you have any questions.
Feel free to give feedback make changes to this issue @Ludee
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `ontology/urls.py`
Content:
```
1 from django.conf.urls import url
2 from django.conf.urls.static import static
3 from django.views.generic import TemplateView
4
5 from modelview import views
6 from oeplatform import settings
7
8 urlpatterns = [
9 url(r"^$", TemplateView.as_view(template_name="ontology/about.html")),
10 ]
11
```
--- 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/ontology/urls.py b/ontology/urls.py
--- a/ontology/urls.py
+++ b/ontology/urls.py
@@ -7,4 +7,7 @@
urlpatterns = [
url(r"^$", TemplateView.as_view(template_name="ontology/about.html")),
+ url(r"^ontology/oeo-steering-committee$",
+ TemplateView.as_view(template_name="ontology/oeo-steering-committee.html"),
+ name="oeo-s-c"),
]
| {"golden_diff": "diff --git a/ontology/urls.py b/ontology/urls.py\n--- a/ontology/urls.py\n+++ b/ontology/urls.py\n@@ -7,4 +7,7 @@\n \n urlpatterns = [\n url(r\"^$\", TemplateView.as_view(template_name=\"ontology/about.html\")),\n+ url(r\"^ontology/oeo-steering-committee$\",\n+ TemplateView.as_view(template_name=\"ontology/oeo-steering-committee.html\"),\n+ name=\"oeo-s-c\"),\n ]\n", "issue": "Add OEO Steering Committee Subpage\nThe OEO Steering Committee needs its own web page, which should be a sub page of the OEP. Please create such a sub page @jh-RLI . I think it makes sense to link it somewhere under ontology.\r\n\r\nhttps://openenergy-platform.org/ontology/\r\n\r\nThe URL would then be \r\n\r\nhttps://openenergy-platform.org/ontology/oeo-steering-committee\r\n\r\nContent for the page is here:\r\n\r\nhttps://github.com/OpenEnergyPlatform/ontology/wiki/OEO-Steering-Committee\r\n\r\nAn issue to create an English translation is open here: https://github.com/OpenEnergyPlatform/ontology/issues/313\r\n\r\nCreating the page and making it look simple, but decent enough are priorities. The final text and location can easily be changed later on. Contact me if you have any questions. \r\n\r\nFeel free to give feedback make changes to this issue @Ludee \n", "before_files": [{"content": "from django.conf.urls import url\nfrom django.conf.urls.static import static\nfrom django.views.generic import TemplateView\n\nfrom modelview import views\nfrom oeplatform import settings\n\nurlpatterns = [\n url(r\"^$\", TemplateView.as_view(template_name=\"ontology/about.html\")),\n]\n", "path": "ontology/urls.py"}], "after_files": [{"content": "from django.conf.urls import url\nfrom django.conf.urls.static import static\nfrom django.views.generic import TemplateView\n\nfrom modelview import views\nfrom oeplatform import settings\n\nurlpatterns = [\n url(r\"^$\", TemplateView.as_view(template_name=\"ontology/about.html\")),\n url(r\"^ontology/oeo-steering-committee$\",\n TemplateView.as_view(template_name=\"ontology/oeo-steering-committee.html\"),\n name=\"oeo-s-c\"),\n]\n", "path": "ontology/urls.py"}]} |
gh_patches_debug_256 | rasdani/github-patches | git_diff | cocotb__cocotb-797 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Use sphinxcontrib-trio to document coroutines
It looks like https://sphinxcontrib-trio.readthedocs.io/ could help autodoc'ing our coroutines nicer.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `documentation/source/conf.py`
Content:
```
1 # -*- coding: utf-8 -*-
2 #
3 # cocotb documentation build configuration file, created by
4 # sphinx-quickstart on Wed Jun 19 14:44:09 2013.
5 #
6 # This file is execfile()d with the current directory set to its 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 import sys, os
15 import datetime
16
17 # If extensions (or modules to document with autodoc) are in another directory,
18 # add these directories to sys.path here. If the directory is relative to the
19 # documentation root, use os.path.abspath to make it absolute, like shown here.
20 sys.path.insert(0, os.path.abspath('../..'))
21
22 # Add in-tree extensions to path
23 sys.path.insert(0, os.path.abspath('../sphinxext'))
24
25 os.environ["SPHINX_BUILD"] = "1"
26
27 # -- General configuration -----------------------------------------------------
28
29 # If your documentation needs a minimal Sphinx version, state it here.
30 #needs_sphinx = '1.0'
31
32 # Add any Sphinx extension module names here, as strings. They can be extensions
33 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
34 extensions = [
35 'sphinx.ext.autodoc',
36 'sphinx.ext.doctest',
37 'sphinx.ext.todo',
38 'sphinx.ext.coverage',
39 'sphinx.ext.imgmath',
40 'sphinx.ext.viewcode',
41 'sphinx.ext.napoleon',
42 'sphinx.ext.intersphinx',
43 'cairosvgconverter',
44 ]
45
46 intersphinx_mapping = {'https://docs.python.org/3': None}
47
48 # Add any paths that contain templates here, relative to this directory.
49 templates_path = ['_templates']
50
51 # The suffix of source filenames.
52 source_suffix = '.rst'
53
54 # The encoding of source files.
55 #source_encoding = 'utf-8-sig'
56
57 # The master toctree document.
58 master_doc = 'index'
59
60 # General information about the project.
61 project = u'cocotb'
62 copyright = u'2014-{0}, PotentialVentures'.format(datetime.datetime.now().year)
63
64 # The version info for the project you're documenting, acts as replacement for
65 # |version| and |release|, also used in various other places throughout the
66 # built documents.
67 #
68 # The short X.Y version.
69 version = '1.1'
70 # The full version, including alpha/beta/rc tags.
71 release = '1.1'
72
73 # The language for content autogenerated by Sphinx. Refer to documentation
74 # for a list of supported languages.
75 #language = None
76
77 # There are two options for replacing |today|: either, you set today to some
78 # non-false value, then it is used:
79 #today = ''
80 # Else, today_fmt is used as the format for a strftime call.
81 #today_fmt = '%B %d, %Y'
82
83 # List of patterns, relative to source directory, that match files and
84 # directories to ignore when looking for source files.
85 exclude_patterns = []
86
87 # The reST default role (used for this markup: `text`) to use for all documents.
88 #default_role = None
89
90 # If true, '()' will be appended to :func: etc. cross-reference text.
91 #add_function_parentheses = True
92
93 # If true, the current module name will be prepended to all description
94 # unit titles (such as .. function::).
95 #add_module_names = True
96
97 # If true, sectionauthor and moduleauthor directives will be shown in the
98 # output. They are ignored by default.
99 #show_authors = False
100
101 # The name of the Pygments (syntax highlighting) style to use.
102 pygments_style = 'sphinx'
103
104 # A list of ignored prefixes for module index sorting.
105 #modindex_common_prefix = []
106
107 # If true, keep warnings as "system message" paragraphs in the built documents.
108 #keep_warnings = False
109
110
111 # -- Options for HTML output ---------------------------------------------------
112
113 # The theme to use for HTML and HTML Help pages. See the documentation for
114 # a list of builtin themes.
115 html_theme = 'default'
116
117 # Theme options are theme-specific and customize the look and feel of a theme
118 # further. For a list of options available for each theme, see the
119 # documentation.
120 #html_theme_options = {}
121
122 # Add any paths that contain custom themes here, relative to this directory.
123 #html_theme_path = []
124
125 # The name for this set of Sphinx documents. If None, it defaults to
126 # "<project> v<release> documentation".
127 #html_title = None
128
129 # A shorter title for the navigation bar. Default is the same as html_title.
130 #html_short_title = None
131
132 # The name of an image file (relative to this directory) to place at the top
133 # of the sidebar.
134 #html_logo = None
135
136 # The name of an image file (within the static path) to use as favicon of the
137 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
138 # pixels large.
139 #html_favicon = None
140
141 # Add any paths that contain custom static files (such as style sheets) here,
142 # relative to this directory. They are copied after the builtin static files,
143 # so a file named "default.css" will overwrite the builtin "default.css".
144 html_static_path = ['_static']
145
146 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
147 # using the given strftime format.
148 #html_last_updated_fmt = '%b %d, %Y'
149
150 # If true, SmartyPants will be used to convert quotes and dashes to
151 # typographically correct entities.
152 #html_use_smartypants = True
153
154 # Custom sidebar templates, maps document names to template names.
155 #html_sidebars = {}
156
157 # Additional templates that should be rendered to pages, maps page names to
158 # template names.
159 #html_additional_pages = {}
160
161 # If false, no module index is generated.
162 #html_domain_indices = True
163
164 # If false, no index is generated.
165 #html_use_index = True
166
167 # If true, the index is split into individual pages for each letter.
168 #html_split_index = False
169
170 # If true, links to the reST sources are added to the pages.
171 #html_show_sourcelink = True
172
173 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
174 #html_show_sphinx = True
175
176 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
177 #html_show_copyright = True
178
179 # If true, an OpenSearch description file will be output, and all pages will
180 # contain a <link> tag referring to it. The value of this option must be the
181 # base URL from which the finished HTML is served.
182 #html_use_opensearch = ''
183
184 # This is the file name suffix for HTML files (e.g. ".xhtml").
185 #html_file_suffix = None
186
187 # Output file base name for HTML help builder.
188 htmlhelp_basename = 'cocotbdoc'
189
190
191 # -- Options for LaTeX output --------------------------------------------------
192
193 latex_elements = {
194 # The paper size ('letterpaper' or 'a4paper').
195 #'papersize': 'letterpaper',
196
197 # The font size ('10pt', '11pt' or '12pt').
198 #'pointsize': '10pt',
199
200 # Additional stuff for the LaTeX preamble.
201 #'preamble': '',
202 }
203
204 # Grouping the document tree into LaTeX files. List of tuples
205 # (source start file, target name, title, author, documentclass [howto/manual]).
206 latex_documents = [
207 ('index', 'cocotb.tex', u'cocotb Documentation',
208 u'PotentialVentures', 'manual'),
209 ]
210
211 # The name of an image file (relative to this directory) to place at the top of
212 # the title page.
213 #latex_logo = None
214
215 # For "manual" documents, if this is true, then toplevel headings are parts,
216 # not chapters.
217 #latex_use_parts = False
218
219 # If true, show page references after internal links.
220 #latex_show_pagerefs = False
221
222 # If true, show URL addresses after external links.
223 #latex_show_urls = False
224
225 # Documents to append as an appendix to all manuals.
226 #latex_appendices = []
227
228 # If false, no module index is generated.
229 #latex_domain_indices = True
230
231
232 # -- Options for manual page output --------------------------------------------
233
234 # One entry per manual page. List of tuples
235 # (source start file, name, description, authors, manual section).
236 man_pages = [
237 ('index', 'cocotb', u'cocotb Documentation',
238 [u'PotentialVentures'], 1)
239 ]
240
241 # If true, show URL addresses after external links.
242 #man_show_urls = False
243
244
245 # -- Options for Texinfo output ------------------------------------------------
246
247 # Grouping the document tree into Texinfo files. List of tuples
248 # (source start file, target name, title, author,
249 # dir menu entry, description, category)
250 texinfo_documents = [
251 ('index', 'cocotb', u'cocotb Documentation',
252 u'PotentialVentures', 'cocotb', 'Coroutine Cosimulation TestBench \
253 environment for efficient verification of RTL using Python.',
254 'Miscellaneous'),
255 ]
256
257 # Documents to append as an appendix to all manuals.
258 #texinfo_appendices = []
259
260 # If false, no module index is generated.
261 #texinfo_domain_indices = True
262
263 # How to display URL addresses: 'footnote', 'no', or 'inline'.
264 #texinfo_show_urls = 'footnote'
265
266 # If true, do not generate a @detailmenu in the "Top" node's menu.
267 #texinfo_no_detailmenu = False
268
269 # For now show the todoy
270 todo_include_todos = True
271
```
--- 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/documentation/source/conf.py b/documentation/source/conf.py
--- a/documentation/source/conf.py
+++ b/documentation/source/conf.py
@@ -41,6 +41,7 @@
'sphinx.ext.napoleon',
'sphinx.ext.intersphinx',
'cairosvgconverter',
+ 'sphinxcontrib_trio',
]
intersphinx_mapping = {'https://docs.python.org/3': None}
| {"golden_diff": "diff --git a/documentation/source/conf.py b/documentation/source/conf.py\n--- a/documentation/source/conf.py\n+++ b/documentation/source/conf.py\n@@ -41,6 +41,7 @@\n 'sphinx.ext.napoleon',\n 'sphinx.ext.intersphinx',\n 'cairosvgconverter',\n+ 'sphinxcontrib_trio',\n ]\n \n intersphinx_mapping = {'https://docs.python.org/3': None}\n", "issue": "Use sphinxcontrib-trio to document coroutines\nIt looks like https://sphinxcontrib-trio.readthedocs.io/ could help autodoc'ing our coroutines nicer. \n", "before_files": [{"content": "# -*- coding: utf-8 -*-\n#\n# cocotb documentation build configuration file, created by\n# sphinx-quickstart on Wed Jun 19 14:44:09 2013.\n#\n# This file is execfile()d with the current directory set to its 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\nimport sys, os\nimport datetime\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.\nsys.path.insert(0, os.path.abspath('../..'))\n\n# Add in-tree extensions to path\nsys.path.insert(0, os.path.abspath('../sphinxext'))\n\nos.environ[\"SPHINX_BUILD\"] = \"1\"\n\n# -- General configuration -----------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be extensions\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\nextensions = [\n 'sphinx.ext.autodoc', \n 'sphinx.ext.doctest', \n 'sphinx.ext.todo', \n 'sphinx.ext.coverage', \n 'sphinx.ext.imgmath', \n 'sphinx.ext.viewcode',\n 'sphinx.ext.napoleon',\n 'sphinx.ext.intersphinx',\n 'cairosvgconverter',\n ]\n\nintersphinx_mapping = {'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 of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = u'cocotb'\ncopyright = u'2014-{0}, PotentialVentures'.format(datetime.datetime.now().year)\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 = '1.1'\n# The full version, including alpha/beta/rc tags.\nrelease = '1.1'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\nexclude_patterns = []\n\n# The reST default role (used for this markup: `text`) to use for all documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n# If true, keep warnings as \"system message\" paragraphs in the built documents.\n#keep_warnings = False\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.\nhtml_theme = 'default'\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#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \"<project> v<release> documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\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# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_domain_indices = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = None\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'cocotbdoc'\n\n\n# -- Options for LaTeX output --------------------------------------------------\n\nlatex_elements = {\n# The paper size ('letterpaper' or 'a4paper').\n#'papersize': 'letterpaper',\n\n# The font size ('10pt', '11pt' or '12pt').\n#'pointsize': '10pt',\n\n# Additional stuff for the LaTeX preamble.\n#'preamble': '',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title, author, documentclass [howto/manual]).\nlatex_documents = [\n ('index', 'cocotb.tex', u'cocotb Documentation',\n u'PotentialVentures', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# If true, show page references after internal links.\n#latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_domain_indices = True\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 ('index', 'cocotb', u'cocotb Documentation',\n [u'PotentialVentures'], 1)\n]\n\n# If true, show URL addresses after external links.\n#man_show_urls = False\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 ('index', 'cocotb', u'cocotb Documentation',\n u'PotentialVentures', 'cocotb', 'Coroutine Cosimulation TestBench \\\n environment for efficient verification of RTL using Python.',\n 'Miscellaneous'),\n]\n\n# Documents to append as an appendix to all manuals.\n#texinfo_appendices = []\n\n# If false, no module index is generated.\n#texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#texinfo_show_urls = 'footnote'\n\n# If true, do not generate a @detailmenu in the \"Top\" node's menu.\n#texinfo_no_detailmenu = False\n\n# For now show the todoy \ntodo_include_todos = True\n", "path": "documentation/source/conf.py"}], "after_files": [{"content": "# -*- coding: utf-8 -*-\n#\n# cocotb documentation build configuration file, created by\n# sphinx-quickstart on Wed Jun 19 14:44:09 2013.\n#\n# This file is execfile()d with the current directory set to its 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\nimport sys, os\nimport datetime\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.\nsys.path.insert(0, os.path.abspath('../..'))\n\n# Add in-tree extensions to path\nsys.path.insert(0, os.path.abspath('../sphinxext'))\n\nos.environ[\"SPHINX_BUILD\"] = \"1\"\n\n# -- General configuration -----------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be extensions\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\nextensions = [\n 'sphinx.ext.autodoc', \n 'sphinx.ext.doctest', \n 'sphinx.ext.todo', \n 'sphinx.ext.coverage', \n 'sphinx.ext.imgmath', \n 'sphinx.ext.viewcode',\n 'sphinx.ext.napoleon',\n 'sphinx.ext.intersphinx',\n 'cairosvgconverter',\n 'sphinxcontrib_trio',\n ]\n\nintersphinx_mapping = {'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 of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = u'cocotb'\ncopyright = u'2014-{0}, PotentialVentures'.format(datetime.datetime.now().year)\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 = '1.1'\n# The full version, including alpha/beta/rc tags.\nrelease = '1.1'\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\nexclude_patterns = []\n\n# The reST default role (used for this markup: `text`) to use for all documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n# If true, keep warnings as \"system message\" paragraphs in the built documents.\n#keep_warnings = False\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.\nhtml_theme = 'default'\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#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents. If None, it defaults to\n# \"<project> v<release> documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#html_favicon = None\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# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {}\n\n# If false, no module index is generated.\n#html_domain_indices = True\n\n# If false, no index is generated.\n#html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = None\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'cocotbdoc'\n\n\n# -- Options for LaTeX output --------------------------------------------------\n\nlatex_elements = {\n# The paper size ('letterpaper' or 'a4paper').\n#'papersize': 'letterpaper',\n\n# The font size ('10pt', '11pt' or '12pt').\n#'pointsize': '10pt',\n\n# Additional stuff for the LaTeX preamble.\n#'preamble': '',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title, author, documentclass [howto/manual]).\nlatex_documents = [\n ('index', 'cocotb.tex', u'cocotb Documentation',\n u'PotentialVentures', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# If true, show page references after internal links.\n#latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_domain_indices = True\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 ('index', 'cocotb', u'cocotb Documentation',\n [u'PotentialVentures'], 1)\n]\n\n# If true, show URL addresses after external links.\n#man_show_urls = False\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 ('index', 'cocotb', u'cocotb Documentation',\n u'PotentialVentures', 'cocotb', 'Coroutine Cosimulation TestBench \\\n environment for efficient verification of RTL using Python.',\n 'Miscellaneous'),\n]\n\n# Documents to append as an appendix to all manuals.\n#texinfo_appendices = []\n\n# If false, no module index is generated.\n#texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#texinfo_show_urls = 'footnote'\n\n# If true, do not generate a @detailmenu in the \"Top\" node's menu.\n#texinfo_no_detailmenu = False\n\n# For now show the todoy \ntodo_include_todos = True\n", "path": "documentation/source/conf.py"}]} |
gh_patches_debug_257 | rasdani/github-patches | git_diff | google__jax-1807 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
ImportError: ..... ____chkstk_darwin
Hi folks,
Wondering if someone can please help with this import error on a fresh install.
Background: Recently started a new conda environment with a couple of basics like jupyter, numpy, scipy. I'm using MacOS High Sierra 10.13.4, and python3.7
The specific error is:
```
---------------------------------------------------------------------------
ImportError Traceback (most recent call last)
<ipython-input-1-77da20ac745a> in <module>
----> 1 from jax import vmap # for auto-vectorizing functions
2 from functools import partial # for use with vmap
3 from jax import jit # for compiling functions for speedup
4 from jax import random # stax initialization uses jax.random
5 from jax.experimental import stax # neural network library
```
...
```
~/miniconda3/envs/lew_jax/lib/python3.7/site-packages/jaxlib/xla_client.py in <module>
36 # and TensorFlow may fail with duplicate protocol buffer message definitions.
37
---> 38 from . import xla_extension as _xla
39 from .xla_extension import ops
40
ImportError: dlopen(/Users/lmar3213/miniconda3/envs/lew_jax/lib/python3.7/site-packages/jaxlib/xla_extension.so, 2): Symbol not found: ____chkstk_darwin
Referenced from: /Users/lmar3213/miniconda3/envs/lew_jax/lib/python3.7/site-packages/jaxlib/xla_extension.so (which was built for Mac OS X 10.15)
Expected in: /usr/lib/libSystem.B.dylib
in /Users/lmar3213/miniconda3/envs/lew_jax/lib/python3.7/site-packages/jaxlib/xla_extension.so
```
To install, I ran as per the installation instructions i.e. `pip install --upgrade pip` which was already up to date, and then `pip install --upgrade jax jaxlib` which installed happily.
The only clue I have as to understanding the error is that it mentions `xla_extension.so` was built for mac OS X 10.15 but Im on 10.13. Any help is appreciated! Thankyou!
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `build/build.py`
Content:
```
1 #!/usr/bin/python
2 #
3 # Copyright 2018 Google LLC
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # https://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16 #
17 # Helper script for building JAX's libjax easily.
18
19 from __future__ import absolute_import
20 from __future__ import division
21 from __future__ import print_function
22
23 import argparse
24 import collections
25 import hashlib
26 import os
27 import platform
28 import re
29 import shutil
30 import stat
31 import subprocess
32 import sys
33 import urllib
34
35 # pylint: disable=g-import-not-at-top
36 if hasattr(urllib, "urlretrieve"):
37 urlretrieve = urllib.urlretrieve
38 else:
39 import urllib.request
40 urlretrieve = urllib.request.urlretrieve
41
42 if hasattr(shutil, "which"):
43 which = shutil.which
44 else:
45 from distutils.spawn import find_executable as which
46 # pylint: enable=g-import-not-at-top
47
48
49 def shell(cmd):
50 output = subprocess.check_output(cmd)
51 return output.decode("UTF-8").strip()
52
53
54 # Python
55
56 def get_python_bin_path(python_bin_path_flag):
57 """Returns the path to the Python interpreter to use."""
58 return python_bin_path_flag or sys.executable
59
60
61 # Bazel
62
63 BAZEL_BASE_URI = "https://github.com/bazelbuild/bazel/releases/download/0.29.1/"
64 BazelPackage = collections.namedtuple("BazelPackage", ["file", "sha256"])
65 bazel_packages = {
66 "Linux":
67 BazelPackage(
68 file="bazel-0.29.1-linux-x86_64",
69 sha256=
70 "da3031d811f42f6208d24a87984b5b07e1c75afede184cad86eb02bef6c3b9b0"),
71 "Darwin":
72 BazelPackage(
73 file="bazel-0.29.1-darwin-x86_64",
74 sha256=
75 "34daae4caafbdb0952415ed6f97f47f03df84df9af146e9eb910ba65c073efdd"),
76 }
77
78
79 def download_and_verify_bazel():
80 """Downloads a bazel binary from Github, verifying its SHA256 hash."""
81 package = bazel_packages.get(platform.system())
82 if package is None:
83 return None
84
85 if not os.access(package.file, os.X_OK):
86 uri = BAZEL_BASE_URI + package.file
87 sys.stdout.write("Downloading bazel from: {}\n".format(uri))
88
89 def progress(block_count, block_size, total_size):
90 if total_size <= 0:
91 total_size = 170**6
92 progress = (block_count * block_size) / total_size
93 num_chars = 40
94 progress_chars = int(num_chars * progress)
95 sys.stdout.write("{} [{}{}] {}%\r".format(
96 package.file, "#" * progress_chars,
97 "." * (num_chars - progress_chars), int(progress * 100.0)))
98
99 tmp_path, _ = urlretrieve(uri, None, progress)
100 sys.stdout.write("\n")
101
102 # Verify that the downloaded Bazel binary has the expected SHA256.
103 downloaded_file = open(tmp_path, "rb")
104 contents = downloaded_file.read()
105 downloaded_file.close()
106 digest = hashlib.sha256(contents).hexdigest()
107 if digest != package.sha256:
108 print(
109 "Checksum mismatch for downloaded bazel binary (expected {}; got {})."
110 .format(package.sha256, digest))
111 sys.exit(-1)
112
113 # Write the file as the bazel file name.
114 out_file = open(package.file, "wb")
115 out_file.write(contents)
116 out_file.close()
117
118 # Mark the file as executable.
119 st = os.stat(package.file)
120 os.chmod(package.file,
121 st.st_mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
122
123 return "./" + package.file
124
125
126 def get_bazel_path(bazel_path_flag):
127 """Returns the path to a Bazel binary, downloading Bazel if not found."""
128 if bazel_path_flag:
129 return bazel_path_flag
130
131 bazel = which("bazel")
132 if bazel:
133 return bazel
134
135 bazel = download_and_verify_bazel()
136 if bazel:
137 return bazel
138
139 print("Cannot find or download bazel. Please install bazel.")
140 sys.exit(-1)
141
142
143 def check_bazel_version(bazel_path, min_version, max_version):
144 """Checks Bazel's version is in the range [`min_version`, `max_version`)."""
145 version_output = shell([bazel_path, "--bazelrc=/dev/null", "version"])
146 match = re.search("Build label: *([0-9\\.]+)[^0-9\\.]", version_output)
147 if match is None:
148 print("Warning: bazel installation is not a release version. Make sure "
149 "bazel is at least {}".format(min_version))
150 return
151 version = match.group(1)
152 min_ints = [int(x) for x in min_version.split(".")]
153 actual_ints = [int(x) for x in match.group(1).split(".")]
154 if min_ints > actual_ints:
155 print("Outdated bazel revision (>= {} required, found {})".format(
156 min_version, version))
157 sys.exit(0)
158 if max_version is not None:
159 max_ints = [int(x) for x in max_version.split(".")]
160 if actual_ints >= max_ints:
161 print("Please downgrade your bazel revision to build JAX (>= {} and < {}"
162 " required, found {})".format(min_version, max_version, version))
163 sys.exit(0)
164
165
166 BAZELRC_TEMPLATE = """
167 build --repo_env PYTHON_BIN_PATH="{python_bin_path}"
168 build --python_path="{python_bin_path}"
169 build --repo_env TF_NEED_CUDA="{tf_need_cuda}"
170 build --distinct_host_configuration=false
171 build --copt=-Wno-sign-compare
172 build -c opt
173 build:opt --copt=-march=native
174 build:opt --host_copt=-march=native
175 build:mkl_open_source_only --define=tensorflow_mkldnn_contraction_kernel=1
176
177 # Sets the default Apple platform to macOS.
178 build --apple_platform_type=macos
179
180 # Make Bazel print out all options from rc files.
181 build --announce_rc
182
183 # Disable enabled-by-default TensorFlow features that we don't care about.
184 build --define=no_aws_support=true
185 build --define=no_gcp_support=true
186 build --define=no_hdfs_support=true
187 build --define=no_kafka_support=true
188 build --define=no_ignite_support=true
189 build --define=grpc_no_ares=true
190
191 build:cuda --crosstool_top=@local_config_cuda//crosstool:toolchain
192 build:cuda --define=using_cuda=true --define=using_cuda_nvcc=true
193
194 build --spawn_strategy=standalone
195 build --strategy=Genrule=standalone
196
197 build --cxxopt=-std=c++14
198 build --host_cxxopt=-std=c++14
199 """
200
201
202
203 def write_bazelrc(cuda_toolkit_path=None, cudnn_install_path=None, **kwargs):
204 f = open("../.bazelrc", "w")
205 f.write(BAZELRC_TEMPLATE.format(**kwargs))
206 if cuda_toolkit_path:
207 f.write("build --action_env CUDA_TOOLKIT_PATH=\"{cuda_toolkit_path}\"\n"
208 .format(cuda_toolkit_path=cuda_toolkit_path))
209 if cudnn_install_path:
210 f.write("build --action_env CUDNN_INSTALL_PATH=\"{cudnn_install_path}\"\n"
211 .format(cudnn_install_path=cudnn_install_path))
212 f.close()
213
214
215 BANNER = r"""
216 _ _ __ __
217 | | / \ \ \/ /
218 _ | |/ _ \ \ /
219 | |_| / ___ \/ \
220 \___/_/ \/_/\_\
221
222 """
223
224 EPILOG = """
225
226 From the 'build' directory in the JAX repository, run
227 python build.py
228 or
229 python3 build.py
230 to download and build JAX's XLA (jaxlib) dependency.
231 """
232
233
234 def _parse_string_as_bool(s):
235 """Parses a string as a boolean argument."""
236 lower = s.lower()
237 if lower == "true":
238 return True
239 elif lower == "false":
240 return False
241 else:
242 raise ValueError("Expected either 'true' or 'false'; got {}".format(s))
243
244
245 def add_boolean_argument(parser, name, default=False, help_str=None):
246 """Creates a boolean flag."""
247 group = parser.add_mutually_exclusive_group()
248 group.add_argument(
249 "--" + name,
250 nargs="?",
251 default=default,
252 const=True,
253 type=_parse_string_as_bool,
254 help=help_str)
255 group.add_argument("--no" + name, dest=name, action="store_false")
256
257
258 def main():
259 parser = argparse.ArgumentParser(
260 description="Builds libjax from source.", epilog=EPILOG)
261 parser.add_argument(
262 "--bazel_path",
263 help="Path to the Bazel binary to use. The default is to find bazel via "
264 "the PATH; if none is found, downloads a fresh copy of bazel from "
265 "GitHub.")
266 parser.add_argument(
267 "--python_bin_path",
268 help="Path to Python binary to use. The default is the Python "
269 "interpreter used to run the build script.")
270 add_boolean_argument(
271 parser,
272 "enable_march_native",
273 default=False,
274 help_str="Generate code targeted to the current machine? This may "
275 "increase performance, but may generate code that does not run on "
276 "older machines.")
277 add_boolean_argument(
278 parser,
279 "enable_mkl_dnn",
280 default=True,
281 help_str="Should we build with MKL-DNN enabled?")
282 add_boolean_argument(
283 parser,
284 "enable_cuda",
285 help_str="Should we build with CUDA enabled? Requires CUDA and CuDNN.")
286 parser.add_argument(
287 "--cuda_path",
288 default=None,
289 help="Path to the CUDA toolkit.")
290 parser.add_argument(
291 "--cudnn_path",
292 default=None,
293 help="Path to CUDNN libraries.")
294 parser.add_argument(
295 "--bazel_startup_options",
296 action="append", default=[],
297 help="Additional startup options to pass to bazel.")
298 parser.add_argument(
299 "--bazel_options",
300 action="append", default=[],
301 help="Additional options to pass to bazel.")
302 args = parser.parse_args()
303
304 print(BANNER)
305 os.chdir(os.path.dirname(__file__ or args.prog) or '.')
306
307 # Find a working Bazel.
308 bazel_path = get_bazel_path(args.bazel_path)
309 check_bazel_version(bazel_path, min_version="0.24.0", max_version=None)
310 print("Bazel binary path: {}".format(bazel_path))
311
312 python_bin_path = get_python_bin_path(args.python_bin_path)
313 print("Python binary path: {}".format(python_bin_path))
314
315 print("MKL-DNN enabled: {}".format("yes" if args.enable_mkl_dnn else "no"))
316 print("-march=native: {}".format("yes" if args.enable_march_native else "no"))
317
318 cuda_toolkit_path = args.cuda_path
319 cudnn_install_path = args.cudnn_path
320 print("CUDA enabled: {}".format("yes" if args.enable_cuda else "no"))
321 if args.enable_cuda:
322 if cuda_toolkit_path:
323 print("CUDA toolkit path: {}".format(cuda_toolkit_path))
324 if cudnn_install_path:
325 print("CUDNN library path: {}".format(cudnn_install_path))
326 write_bazelrc(
327 python_bin_path=python_bin_path,
328 tf_need_cuda=1 if args.enable_cuda else 0,
329 cuda_toolkit_path=cuda_toolkit_path,
330 cudnn_install_path=cudnn_install_path)
331
332 print("\nBuilding XLA and installing it in the jaxlib source tree...")
333 config_args = args.bazel_options
334 if args.enable_march_native:
335 config_args += ["--config=opt"]
336 if args.enable_mkl_dnn:
337 config_args += ["--config=mkl_open_source_only"]
338 if args.enable_cuda:
339 config_args += ["--config=cuda"]
340 config_args += ["--define=xla_python_enable_gpu=true"]
341 command = ([bazel_path] + args.bazel_startup_options +
342 ["run", "--verbose_failures=true"] + config_args +
343 [":install_xla_in_source_tree", os.getcwd()])
344 print(" ".join(command))
345 shell(command)
346 shell([bazel_path, "shutdown"])
347
348
349 if __name__ == "__main__":
350 main()
351
```
--- 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/build/build.py b/build/build.py
--- a/build/build.py
+++ b/build/build.py
@@ -176,6 +176,7 @@
# Sets the default Apple platform to macOS.
build --apple_platform_type=macos
+build --macos_minimum_os=10.9
# Make Bazel print out all options from rc files.
build --announce_rc
| {"golden_diff": "diff --git a/build/build.py b/build/build.py\n--- a/build/build.py\n+++ b/build/build.py\n@@ -176,6 +176,7 @@\n \n # Sets the default Apple platform to macOS.\n build --apple_platform_type=macos\n+build --macos_minimum_os=10.9\n \n # Make Bazel print out all options from rc files.\n build --announce_rc\n", "issue": "ImportError: ..... ____chkstk_darwin\nHi folks,\r\nWondering if someone can please help with this import error on a fresh install. \r\n\r\nBackground: Recently started a new conda environment with a couple of basics like jupyter, numpy, scipy. I'm using MacOS High Sierra 10.13.4, and python3.7\r\n\r\nThe specific error is:\r\n```\r\n---------------------------------------------------------------------------\r\nImportError Traceback (most recent call last)\r\n<ipython-input-1-77da20ac745a> in <module>\r\n----> 1 from jax import vmap # for auto-vectorizing functions\r\n 2 from functools import partial # for use with vmap\r\n 3 from jax import jit # for compiling functions for speedup\r\n 4 from jax import random # stax initialization uses jax.random\r\n 5 from jax.experimental import stax # neural network library\r\n```\r\n...\r\n\r\n```\r\n~/miniconda3/envs/lew_jax/lib/python3.7/site-packages/jaxlib/xla_client.py in <module>\r\n 36 # and TensorFlow may fail with duplicate protocol buffer message definitions.\r\n 37 \r\n---> 38 from . import xla_extension as _xla\r\n 39 from .xla_extension import ops\r\n 40 \r\n\r\nImportError: dlopen(/Users/lmar3213/miniconda3/envs/lew_jax/lib/python3.7/site-packages/jaxlib/xla_extension.so, 2): Symbol not found: ____chkstk_darwin\r\n Referenced from: /Users/lmar3213/miniconda3/envs/lew_jax/lib/python3.7/site-packages/jaxlib/xla_extension.so (which was built for Mac OS X 10.15)\r\n Expected in: /usr/lib/libSystem.B.dylib\r\n in /Users/lmar3213/miniconda3/envs/lew_jax/lib/python3.7/site-packages/jaxlib/xla_extension.so\r\n```\r\n\r\nTo install, I ran as per the installation instructions i.e. `pip install --upgrade pip` which was already up to date, and then `pip install --upgrade jax jaxlib` which installed happily. \r\n\r\nThe only clue I have as to understanding the error is that it mentions `xla_extension.so` was built for mac OS X 10.15 but Im on 10.13. Any help is appreciated! Thankyou!\r\n\n", "before_files": [{"content": "#!/usr/bin/python\n#\n# Copyright 2018 Google LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# https://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# Helper script for building JAX's libjax easily.\n\nfrom __future__ import absolute_import\nfrom __future__ import division\nfrom __future__ import print_function\n\nimport argparse\nimport collections\nimport hashlib\nimport os\nimport platform\nimport re\nimport shutil\nimport stat\nimport subprocess\nimport sys\nimport urllib\n\n# pylint: disable=g-import-not-at-top\nif hasattr(urllib, \"urlretrieve\"):\n urlretrieve = urllib.urlretrieve\nelse:\n import urllib.request\n urlretrieve = urllib.request.urlretrieve\n\nif hasattr(shutil, \"which\"):\n which = shutil.which\nelse:\n from distutils.spawn import find_executable as which\n# pylint: enable=g-import-not-at-top\n\n\ndef shell(cmd):\n output = subprocess.check_output(cmd)\n return output.decode(\"UTF-8\").strip()\n\n\n# Python\n\ndef get_python_bin_path(python_bin_path_flag):\n \"\"\"Returns the path to the Python interpreter to use.\"\"\"\n return python_bin_path_flag or sys.executable\n\n\n# Bazel\n\nBAZEL_BASE_URI = \"https://github.com/bazelbuild/bazel/releases/download/0.29.1/\"\nBazelPackage = collections.namedtuple(\"BazelPackage\", [\"file\", \"sha256\"])\nbazel_packages = {\n \"Linux\":\n BazelPackage(\n file=\"bazel-0.29.1-linux-x86_64\",\n sha256=\n \"da3031d811f42f6208d24a87984b5b07e1c75afede184cad86eb02bef6c3b9b0\"),\n \"Darwin\":\n BazelPackage(\n file=\"bazel-0.29.1-darwin-x86_64\",\n sha256=\n \"34daae4caafbdb0952415ed6f97f47f03df84df9af146e9eb910ba65c073efdd\"),\n}\n\n\ndef download_and_verify_bazel():\n \"\"\"Downloads a bazel binary from Github, verifying its SHA256 hash.\"\"\"\n package = bazel_packages.get(platform.system())\n if package is None:\n return None\n\n if not os.access(package.file, os.X_OK):\n uri = BAZEL_BASE_URI + package.file\n sys.stdout.write(\"Downloading bazel from: {}\\n\".format(uri))\n\n def progress(block_count, block_size, total_size):\n if total_size <= 0:\n total_size = 170**6\n progress = (block_count * block_size) / total_size\n num_chars = 40\n progress_chars = int(num_chars * progress)\n sys.stdout.write(\"{} [{}{}] {}%\\r\".format(\n package.file, \"#\" * progress_chars,\n \".\" * (num_chars - progress_chars), int(progress * 100.0)))\n\n tmp_path, _ = urlretrieve(uri, None, progress)\n sys.stdout.write(\"\\n\")\n\n # Verify that the downloaded Bazel binary has the expected SHA256.\n downloaded_file = open(tmp_path, \"rb\")\n contents = downloaded_file.read()\n downloaded_file.close()\n digest = hashlib.sha256(contents).hexdigest()\n if digest != package.sha256:\n print(\n \"Checksum mismatch for downloaded bazel binary (expected {}; got {}).\"\n .format(package.sha256, digest))\n sys.exit(-1)\n\n # Write the file as the bazel file name.\n out_file = open(package.file, \"wb\")\n out_file.write(contents)\n out_file.close()\n\n # Mark the file as executable.\n st = os.stat(package.file)\n os.chmod(package.file,\n st.st_mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)\n\n return \"./\" + package.file\n\n\ndef get_bazel_path(bazel_path_flag):\n \"\"\"Returns the path to a Bazel binary, downloading Bazel if not found.\"\"\"\n if bazel_path_flag:\n return bazel_path_flag\n\n bazel = which(\"bazel\")\n if bazel:\n return bazel\n\n bazel = download_and_verify_bazel()\n if bazel:\n return bazel\n\n print(\"Cannot find or download bazel. Please install bazel.\")\n sys.exit(-1)\n\n\ndef check_bazel_version(bazel_path, min_version, max_version):\n \"\"\"Checks Bazel's version is in the range [`min_version`, `max_version`).\"\"\"\n version_output = shell([bazel_path, \"--bazelrc=/dev/null\", \"version\"])\n match = re.search(\"Build label: *([0-9\\\\.]+)[^0-9\\\\.]\", version_output)\n if match is None:\n print(\"Warning: bazel installation is not a release version. Make sure \"\n \"bazel is at least {}\".format(min_version))\n return\n version = match.group(1)\n min_ints = [int(x) for x in min_version.split(\".\")]\n actual_ints = [int(x) for x in match.group(1).split(\".\")]\n if min_ints > actual_ints:\n print(\"Outdated bazel revision (>= {} required, found {})\".format(\n min_version, version))\n sys.exit(0)\n if max_version is not None:\n max_ints = [int(x) for x in max_version.split(\".\")]\n if actual_ints >= max_ints:\n print(\"Please downgrade your bazel revision to build JAX (>= {} and < {}\"\n \" required, found {})\".format(min_version, max_version, version))\n sys.exit(0)\n\n\nBAZELRC_TEMPLATE = \"\"\"\nbuild --repo_env PYTHON_BIN_PATH=\"{python_bin_path}\"\nbuild --python_path=\"{python_bin_path}\"\nbuild --repo_env TF_NEED_CUDA=\"{tf_need_cuda}\"\nbuild --distinct_host_configuration=false\nbuild --copt=-Wno-sign-compare\nbuild -c opt\nbuild:opt --copt=-march=native\nbuild:opt --host_copt=-march=native\nbuild:mkl_open_source_only --define=tensorflow_mkldnn_contraction_kernel=1\n\n# Sets the default Apple platform to macOS.\nbuild --apple_platform_type=macos\n\n# Make Bazel print out all options from rc files.\nbuild --announce_rc\n\n# Disable enabled-by-default TensorFlow features that we don't care about.\nbuild --define=no_aws_support=true\nbuild --define=no_gcp_support=true\nbuild --define=no_hdfs_support=true\nbuild --define=no_kafka_support=true\nbuild --define=no_ignite_support=true\nbuild --define=grpc_no_ares=true\n\nbuild:cuda --crosstool_top=@local_config_cuda//crosstool:toolchain\nbuild:cuda --define=using_cuda=true --define=using_cuda_nvcc=true\n\nbuild --spawn_strategy=standalone\nbuild --strategy=Genrule=standalone\n\nbuild --cxxopt=-std=c++14\nbuild --host_cxxopt=-std=c++14\n\"\"\"\n\n\n\ndef write_bazelrc(cuda_toolkit_path=None, cudnn_install_path=None, **kwargs):\n f = open(\"../.bazelrc\", \"w\")\n f.write(BAZELRC_TEMPLATE.format(**kwargs))\n if cuda_toolkit_path:\n f.write(\"build --action_env CUDA_TOOLKIT_PATH=\\\"{cuda_toolkit_path}\\\"\\n\"\n .format(cuda_toolkit_path=cuda_toolkit_path))\n if cudnn_install_path:\n f.write(\"build --action_env CUDNN_INSTALL_PATH=\\\"{cudnn_install_path}\\\"\\n\"\n .format(cudnn_install_path=cudnn_install_path))\n f.close()\n\n\nBANNER = r\"\"\"\n _ _ __ __\n | | / \\ \\ \\/ /\n _ | |/ _ \\ \\ /\n| |_| / ___ \\/ \\\n \\___/_/ \\/_/\\_\\\n\n\"\"\"\n\nEPILOG = \"\"\"\n\nFrom the 'build' directory in the JAX repository, run\n python build.py\nor\n python3 build.py\nto download and build JAX's XLA (jaxlib) dependency.\n\"\"\"\n\n\ndef _parse_string_as_bool(s):\n \"\"\"Parses a string as a boolean argument.\"\"\"\n lower = s.lower()\n if lower == \"true\":\n return True\n elif lower == \"false\":\n return False\n else:\n raise ValueError(\"Expected either 'true' or 'false'; got {}\".format(s))\n\n\ndef add_boolean_argument(parser, name, default=False, help_str=None):\n \"\"\"Creates a boolean flag.\"\"\"\n group = parser.add_mutually_exclusive_group()\n group.add_argument(\n \"--\" + name,\n nargs=\"?\",\n default=default,\n const=True,\n type=_parse_string_as_bool,\n help=help_str)\n group.add_argument(\"--no\" + name, dest=name, action=\"store_false\")\n\n\ndef main():\n parser = argparse.ArgumentParser(\n description=\"Builds libjax from source.\", epilog=EPILOG)\n parser.add_argument(\n \"--bazel_path\",\n help=\"Path to the Bazel binary to use. The default is to find bazel via \"\n \"the PATH; if none is found, downloads a fresh copy of bazel from \"\n \"GitHub.\")\n parser.add_argument(\n \"--python_bin_path\",\n help=\"Path to Python binary to use. The default is the Python \"\n \"interpreter used to run the build script.\")\n add_boolean_argument(\n parser,\n \"enable_march_native\",\n default=False,\n help_str=\"Generate code targeted to the current machine? This may \"\n \"increase performance, but may generate code that does not run on \"\n \"older machines.\")\n add_boolean_argument(\n parser,\n \"enable_mkl_dnn\",\n default=True,\n help_str=\"Should we build with MKL-DNN enabled?\")\n add_boolean_argument(\n parser,\n \"enable_cuda\",\n help_str=\"Should we build with CUDA enabled? Requires CUDA and CuDNN.\")\n parser.add_argument(\n \"--cuda_path\",\n default=None,\n help=\"Path to the CUDA toolkit.\")\n parser.add_argument(\n \"--cudnn_path\",\n default=None,\n help=\"Path to CUDNN libraries.\")\n parser.add_argument(\n \"--bazel_startup_options\",\n action=\"append\", default=[],\n help=\"Additional startup options to pass to bazel.\")\n parser.add_argument(\n \"--bazel_options\",\n action=\"append\", default=[],\n help=\"Additional options to pass to bazel.\")\n args = parser.parse_args()\n\n print(BANNER)\n os.chdir(os.path.dirname(__file__ or args.prog) or '.')\n\n # Find a working Bazel.\n bazel_path = get_bazel_path(args.bazel_path)\n check_bazel_version(bazel_path, min_version=\"0.24.0\", max_version=None)\n print(\"Bazel binary path: {}\".format(bazel_path))\n\n python_bin_path = get_python_bin_path(args.python_bin_path)\n print(\"Python binary path: {}\".format(python_bin_path))\n\n print(\"MKL-DNN enabled: {}\".format(\"yes\" if args.enable_mkl_dnn else \"no\"))\n print(\"-march=native: {}\".format(\"yes\" if args.enable_march_native else \"no\"))\n\n cuda_toolkit_path = args.cuda_path\n cudnn_install_path = args.cudnn_path\n print(\"CUDA enabled: {}\".format(\"yes\" if args.enable_cuda else \"no\"))\n if args.enable_cuda:\n if cuda_toolkit_path:\n print(\"CUDA toolkit path: {}\".format(cuda_toolkit_path))\n if cudnn_install_path:\n print(\"CUDNN library path: {}\".format(cudnn_install_path))\n write_bazelrc(\n python_bin_path=python_bin_path,\n tf_need_cuda=1 if args.enable_cuda else 0,\n cuda_toolkit_path=cuda_toolkit_path,\n cudnn_install_path=cudnn_install_path)\n\n print(\"\\nBuilding XLA and installing it in the jaxlib source tree...\")\n config_args = args.bazel_options\n if args.enable_march_native:\n config_args += [\"--config=opt\"]\n if args.enable_mkl_dnn:\n config_args += [\"--config=mkl_open_source_only\"]\n if args.enable_cuda:\n config_args += [\"--config=cuda\"]\n config_args += [\"--define=xla_python_enable_gpu=true\"]\n command = ([bazel_path] + args.bazel_startup_options +\n [\"run\", \"--verbose_failures=true\"] + config_args +\n [\":install_xla_in_source_tree\", os.getcwd()])\n print(\" \".join(command))\n shell(command)\n shell([bazel_path, \"shutdown\"])\n\n\nif __name__ == \"__main__\":\n main()\n", "path": "build/build.py"}], "after_files": [{"content": "#!/usr/bin/python\n#\n# Copyright 2018 Google LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# https://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# Helper script for building JAX's libjax easily.\n\nfrom __future__ import absolute_import\nfrom __future__ import division\nfrom __future__ import print_function\n\nimport argparse\nimport collections\nimport hashlib\nimport os\nimport platform\nimport re\nimport shutil\nimport stat\nimport subprocess\nimport sys\nimport urllib\n\n# pylint: disable=g-import-not-at-top\nif hasattr(urllib, \"urlretrieve\"):\n urlretrieve = urllib.urlretrieve\nelse:\n import urllib.request\n urlretrieve = urllib.request.urlretrieve\n\nif hasattr(shutil, \"which\"):\n which = shutil.which\nelse:\n from distutils.spawn import find_executable as which\n# pylint: enable=g-import-not-at-top\n\n\ndef shell(cmd):\n output = subprocess.check_output(cmd)\n return output.decode(\"UTF-8\").strip()\n\n\n# Python\n\ndef get_python_bin_path(python_bin_path_flag):\n \"\"\"Returns the path to the Python interpreter to use.\"\"\"\n return python_bin_path_flag or sys.executable\n\n\n# Bazel\n\nBAZEL_BASE_URI = \"https://github.com/bazelbuild/bazel/releases/download/0.29.1/\"\nBazelPackage = collections.namedtuple(\"BazelPackage\", [\"file\", \"sha256\"])\nbazel_packages = {\n \"Linux\":\n BazelPackage(\n file=\"bazel-0.29.1-linux-x86_64\",\n sha256=\n \"da3031d811f42f6208d24a87984b5b07e1c75afede184cad86eb02bef6c3b9b0\"),\n \"Darwin\":\n BazelPackage(\n file=\"bazel-0.29.1-darwin-x86_64\",\n sha256=\n \"34daae4caafbdb0952415ed6f97f47f03df84df9af146e9eb910ba65c073efdd\"),\n}\n\n\ndef download_and_verify_bazel():\n \"\"\"Downloads a bazel binary from Github, verifying its SHA256 hash.\"\"\"\n package = bazel_packages.get(platform.system())\n if package is None:\n return None\n\n if not os.access(package.file, os.X_OK):\n uri = BAZEL_BASE_URI + package.file\n sys.stdout.write(\"Downloading bazel from: {}\\n\".format(uri))\n\n def progress(block_count, block_size, total_size):\n if total_size <= 0:\n total_size = 170**6\n progress = (block_count * block_size) / total_size\n num_chars = 40\n progress_chars = int(num_chars * progress)\n sys.stdout.write(\"{} [{}{}] {}%\\r\".format(\n package.file, \"#\" * progress_chars,\n \".\" * (num_chars - progress_chars), int(progress * 100.0)))\n\n tmp_path, _ = urlretrieve(uri, None, progress)\n sys.stdout.write(\"\\n\")\n\n # Verify that the downloaded Bazel binary has the expected SHA256.\n downloaded_file = open(tmp_path, \"rb\")\n contents = downloaded_file.read()\n downloaded_file.close()\n digest = hashlib.sha256(contents).hexdigest()\n if digest != package.sha256:\n print(\n \"Checksum mismatch for downloaded bazel binary (expected {}; got {}).\"\n .format(package.sha256, digest))\n sys.exit(-1)\n\n # Write the file as the bazel file name.\n out_file = open(package.file, \"wb\")\n out_file.write(contents)\n out_file.close()\n\n # Mark the file as executable.\n st = os.stat(package.file)\n os.chmod(package.file,\n st.st_mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)\n\n return \"./\" + package.file\n\n\ndef get_bazel_path(bazel_path_flag):\n \"\"\"Returns the path to a Bazel binary, downloading Bazel if not found.\"\"\"\n if bazel_path_flag:\n return bazel_path_flag\n\n bazel = which(\"bazel\")\n if bazel:\n return bazel\n\n bazel = download_and_verify_bazel()\n if bazel:\n return bazel\n\n print(\"Cannot find or download bazel. Please install bazel.\")\n sys.exit(-1)\n\n\ndef check_bazel_version(bazel_path, min_version, max_version):\n \"\"\"Checks Bazel's version is in the range [`min_version`, `max_version`).\"\"\"\n version_output = shell([bazel_path, \"--bazelrc=/dev/null\", \"version\"])\n match = re.search(\"Build label: *([0-9\\\\.]+)[^0-9\\\\.]\", version_output)\n if match is None:\n print(\"Warning: bazel installation is not a release version. Make sure \"\n \"bazel is at least {}\".format(min_version))\n return\n version = match.group(1)\n min_ints = [int(x) for x in min_version.split(\".\")]\n actual_ints = [int(x) for x in match.group(1).split(\".\")]\n if min_ints > actual_ints:\n print(\"Outdated bazel revision (>= {} required, found {})\".format(\n min_version, version))\n sys.exit(0)\n if max_version is not None:\n max_ints = [int(x) for x in max_version.split(\".\")]\n if actual_ints >= max_ints:\n print(\"Please downgrade your bazel revision to build JAX (>= {} and < {}\"\n \" required, found {})\".format(min_version, max_version, version))\n sys.exit(0)\n\n\nBAZELRC_TEMPLATE = \"\"\"\nbuild --repo_env PYTHON_BIN_PATH=\"{python_bin_path}\"\nbuild --python_path=\"{python_bin_path}\"\nbuild --repo_env TF_NEED_CUDA=\"{tf_need_cuda}\"\nbuild --distinct_host_configuration=false\nbuild --copt=-Wno-sign-compare\nbuild -c opt\nbuild:opt --copt=-march=native\nbuild:opt --host_copt=-march=native\nbuild:mkl_open_source_only --define=tensorflow_mkldnn_contraction_kernel=1\n\n# Sets the default Apple platform to macOS.\nbuild --apple_platform_type=macos\nbuild --macos_minimum_os=10.9\n\n# Make Bazel print out all options from rc files.\nbuild --announce_rc\n\n# Disable enabled-by-default TensorFlow features that we don't care about.\nbuild --define=no_aws_support=true\nbuild --define=no_gcp_support=true\nbuild --define=no_hdfs_support=true\nbuild --define=no_kafka_support=true\nbuild --define=no_ignite_support=true\nbuild --define=grpc_no_ares=true\n\nbuild:cuda --crosstool_top=@local_config_cuda//crosstool:toolchain\nbuild:cuda --define=using_cuda=true --define=using_cuda_nvcc=true\n\nbuild --spawn_strategy=standalone\nbuild --strategy=Genrule=standalone\n\nbuild --cxxopt=-std=c++14\nbuild --host_cxxopt=-std=c++14\n\"\"\"\n\n\n\ndef write_bazelrc(cuda_toolkit_path=None, cudnn_install_path=None, **kwargs):\n f = open(\"../.bazelrc\", \"w\")\n f.write(BAZELRC_TEMPLATE.format(**kwargs))\n if cuda_toolkit_path:\n f.write(\"build --action_env CUDA_TOOLKIT_PATH=\\\"{cuda_toolkit_path}\\\"\\n\"\n .format(cuda_toolkit_path=cuda_toolkit_path))\n if cudnn_install_path:\n f.write(\"build --action_env CUDNN_INSTALL_PATH=\\\"{cudnn_install_path}\\\"\\n\"\n .format(cudnn_install_path=cudnn_install_path))\n f.close()\n\n\nBANNER = r\"\"\"\n _ _ __ __\n | | / \\ \\ \\/ /\n _ | |/ _ \\ \\ /\n| |_| / ___ \\/ \\\n \\___/_/ \\/_/\\_\\\n\n\"\"\"\n\nEPILOG = \"\"\"\n\nFrom the 'build' directory in the JAX repository, run\n python build.py\nor\n python3 build.py\nto download and build JAX's XLA (jaxlib) dependency.\n\"\"\"\n\n\ndef _parse_string_as_bool(s):\n \"\"\"Parses a string as a boolean argument.\"\"\"\n lower = s.lower()\n if lower == \"true\":\n return True\n elif lower == \"false\":\n return False\n else:\n raise ValueError(\"Expected either 'true' or 'false'; got {}\".format(s))\n\n\ndef add_boolean_argument(parser, name, default=False, help_str=None):\n \"\"\"Creates a boolean flag.\"\"\"\n group = parser.add_mutually_exclusive_group()\n group.add_argument(\n \"--\" + name,\n nargs=\"?\",\n default=default,\n const=True,\n type=_parse_string_as_bool,\n help=help_str)\n group.add_argument(\"--no\" + name, dest=name, action=\"store_false\")\n\n\ndef main():\n parser = argparse.ArgumentParser(\n description=\"Builds libjax from source.\", epilog=EPILOG)\n parser.add_argument(\n \"--bazel_path\",\n help=\"Path to the Bazel binary to use. The default is to find bazel via \"\n \"the PATH; if none is found, downloads a fresh copy of bazel from \"\n \"GitHub.\")\n parser.add_argument(\n \"--python_bin_path\",\n help=\"Path to Python binary to use. The default is the Python \"\n \"interpreter used to run the build script.\")\n add_boolean_argument(\n parser,\n \"enable_march_native\",\n default=False,\n help_str=\"Generate code targeted to the current machine? This may \"\n \"increase performance, but may generate code that does not run on \"\n \"older machines.\")\n add_boolean_argument(\n parser,\n \"enable_mkl_dnn\",\n default=True,\n help_str=\"Should we build with MKL-DNN enabled?\")\n add_boolean_argument(\n parser,\n \"enable_cuda\",\n help_str=\"Should we build with CUDA enabled? Requires CUDA and CuDNN.\")\n parser.add_argument(\n \"--cuda_path\",\n default=None,\n help=\"Path to the CUDA toolkit.\")\n parser.add_argument(\n \"--cudnn_path\",\n default=None,\n help=\"Path to CUDNN libraries.\")\n parser.add_argument(\n \"--bazel_startup_options\",\n action=\"append\", default=[],\n help=\"Additional startup options to pass to bazel.\")\n parser.add_argument(\n \"--bazel_options\",\n action=\"append\", default=[],\n help=\"Additional options to pass to bazel.\")\n args = parser.parse_args()\n\n print(BANNER)\n os.chdir(os.path.dirname(__file__ or args.prog) or '.')\n\n # Find a working Bazel.\n bazel_path = get_bazel_path(args.bazel_path)\n check_bazel_version(bazel_path, min_version=\"0.24.0\", max_version=None)\n print(\"Bazel binary path: {}\".format(bazel_path))\n\n python_bin_path = get_python_bin_path(args.python_bin_path)\n print(\"Python binary path: {}\".format(python_bin_path))\n\n print(\"MKL-DNN enabled: {}\".format(\"yes\" if args.enable_mkl_dnn else \"no\"))\n print(\"-march=native: {}\".format(\"yes\" if args.enable_march_native else \"no\"))\n\n cuda_toolkit_path = args.cuda_path\n cudnn_install_path = args.cudnn_path\n print(\"CUDA enabled: {}\".format(\"yes\" if args.enable_cuda else \"no\"))\n if args.enable_cuda:\n if cuda_toolkit_path:\n print(\"CUDA toolkit path: {}\".format(cuda_toolkit_path))\n if cudnn_install_path:\n print(\"CUDNN library path: {}\".format(cudnn_install_path))\n write_bazelrc(\n python_bin_path=python_bin_path,\n tf_need_cuda=1 if args.enable_cuda else 0,\n cuda_toolkit_path=cuda_toolkit_path,\n cudnn_install_path=cudnn_install_path)\n\n print(\"\\nBuilding XLA and installing it in the jaxlib source tree...\")\n config_args = args.bazel_options\n if args.enable_march_native:\n config_args += [\"--config=opt\"]\n if args.enable_mkl_dnn:\n config_args += [\"--config=mkl_open_source_only\"]\n if args.enable_cuda:\n config_args += [\"--config=cuda\"]\n config_args += [\"--define=xla_python_enable_gpu=true\"]\n command = ([bazel_path] + args.bazel_startup_options +\n [\"run\", \"--verbose_failures=true\"] + config_args +\n [\":install_xla_in_source_tree\", os.getcwd()])\n print(\" \".join(command))\n shell(command)\n shell([bazel_path, \"shutdown\"])\n\n\nif __name__ == \"__main__\":\n main()\n", "path": "build/build.py"}]} |
gh_patches_debug_258 | rasdani/github-patches | git_diff | cltk__cltk-575 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Double-check code and data for new French PR
This issue is for @nat1881 to follow up on her large PR #571 for Old and Middle French.
Natasha, I would like you to do the following steps, to be certain that the code works as you intended:
* Start a brand new clone of (this) cltk repo.
* Make a new virtual env
* Mk source tarball and install (this should install all dependencies, too): `python setup.py sdist install`
* Temporarily rename your `~/cltk_data` dir (eg, `mv ~/cltk_data ~/cltk_data_backup`)
* Import the french corpora and make sure they appear as they should
* Check in ipython all of your commands that you have added to the docs. Copy-paste these exactly as they are in the docs.
* Follow up on any bugs in your own updated branch ([this is what I recommend for updating your branch](https://github.com/cltk/cltk/wiki/Example-Git-and-Python-workflow))
* Bump the version in `setup.py` and make PR for this
* Then @diyclassics or I will push the code to PyPI
You may be tired of this, but you're getting close! :weary:
cc @mlj
--- 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 """Config for PyPI."""
2
3 from setuptools import find_packages
4 from setuptools import setup
5
6
7 setup(
8 author='Kyle P. Johnson',
9 author_email='[email protected]',
10 classifiers=[
11 'Intended Audience :: Education',
12 'Intended Audience :: Science/Research',
13 'License :: OSI Approved :: MIT License',
14 'Natural Language :: Chinese (Traditional)',
15 'Natural Language :: English',
16 'Natural Language :: Greek',
17 'Natural Language :: Latin',
18 'Operating System :: POSIX',
19 'Programming Language :: Python :: 3.6',
20 'Topic :: Scientific/Engineering :: Artificial Intelligence',
21 'Topic :: Text Processing',
22 'Topic :: Text Processing :: General',
23 'Topic :: Text Processing :: Linguistic',
24 ],
25 description='NLP for the ancient world',
26 install_requires=['gitpython',
27 'nltk',
28 'python-crfsuite',
29 'pyuca',
30 'pyyaml',
31 'regex',
32 'whoosh'],
33 keywords=['nlp', 'nltk', 'greek', 'latin', 'chinese', 'sanskrit', 'pali', 'tibetan'],
34 license='MIT',
35 long_description='The Classical Language Toolkit (CLTK) is a framework for natural language processing for Classical languages.', # pylint: disable=C0301,
36 name='cltk',
37 packages=find_packages(),
38 url='https://github.com/cltk/cltk',
39 version='0.1.63',
40 zip_safe=True,
41 test_suite='cltk.tests.test_cltk',
42 )
43
```
--- 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
@@ -36,7 +36,7 @@
name='cltk',
packages=find_packages(),
url='https://github.com/cltk/cltk',
- version='0.1.63',
+ version='0.1.64',
zip_safe=True,
test_suite='cltk.tests.test_cltk',
)
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -36,7 +36,7 @@\n name='cltk',\n packages=find_packages(),\n url='https://github.com/cltk/cltk',\n- version='0.1.63',\n+ version='0.1.64',\n zip_safe=True,\n test_suite='cltk.tests.test_cltk',\n )\n", "issue": "Double-check code and data for new French PR\nThis issue is for @nat1881 to follow up on her large PR #571 for Old and Middle French.\r\n\r\nNatasha, I would like you to do the following steps, to be certain that the code works as you intended:\r\n\r\n* Start a brand new clone of (this) cltk repo.\r\n* Make a new virtual env\r\n* Mk source tarball and install (this should install all dependencies, too): `python setup.py sdist install`\r\n* Temporarily rename your `~/cltk_data` dir (eg, `mv ~/cltk_data ~/cltk_data_backup`)\r\n* Import the french corpora and make sure they appear as they should\r\n* Check in ipython all of your commands that you have added to the docs. Copy-paste these exactly as they are in the docs.\r\n* Follow up on any bugs in your own updated branch ([this is what I recommend for updating your branch](https://github.com/cltk/cltk/wiki/Example-Git-and-Python-workflow))\r\n* Bump the version in `setup.py` and make PR for this\r\n* Then @diyclassics or I will push the code to PyPI\r\n\r\nYou may be tired of this, but you're getting close! :weary:\r\n\r\ncc @mlj \n", "before_files": [{"content": "\"\"\"Config for PyPI.\"\"\"\n\nfrom setuptools import find_packages\nfrom setuptools import setup\n\n\nsetup(\n author='Kyle P. Johnson',\n author_email='[email protected]',\n classifiers=[\n 'Intended Audience :: Education',\n 'Intended Audience :: Science/Research',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: Chinese (Traditional)',\n 'Natural Language :: English',\n 'Natural Language :: Greek',\n 'Natural Language :: Latin',\n 'Operating System :: POSIX',\n 'Programming Language :: Python :: 3.6',\n 'Topic :: Scientific/Engineering :: Artificial Intelligence',\n 'Topic :: Text Processing',\n 'Topic :: Text Processing :: General',\n 'Topic :: Text Processing :: Linguistic',\n ],\n description='NLP for the ancient world',\n install_requires=['gitpython',\n 'nltk',\n 'python-crfsuite',\n 'pyuca',\n 'pyyaml',\n 'regex',\n 'whoosh'],\n keywords=['nlp', 'nltk', 'greek', 'latin', 'chinese', 'sanskrit', 'pali', 'tibetan'],\n license='MIT',\n long_description='The Classical Language Toolkit (CLTK) is a framework for natural language processing for Classical languages.', # pylint: disable=C0301,\n name='cltk',\n packages=find_packages(),\n url='https://github.com/cltk/cltk',\n version='0.1.63',\n zip_safe=True,\n test_suite='cltk.tests.test_cltk',\n)\n", "path": "setup.py"}], "after_files": [{"content": "\"\"\"Config for PyPI.\"\"\"\n\nfrom setuptools import find_packages\nfrom setuptools import setup\n\n\nsetup(\n author='Kyle P. Johnson',\n author_email='[email protected]',\n classifiers=[\n 'Intended Audience :: Education',\n 'Intended Audience :: Science/Research',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: Chinese (Traditional)',\n 'Natural Language :: English',\n 'Natural Language :: Greek',\n 'Natural Language :: Latin',\n 'Operating System :: POSIX',\n 'Programming Language :: Python :: 3.6',\n 'Topic :: Scientific/Engineering :: Artificial Intelligence',\n 'Topic :: Text Processing',\n 'Topic :: Text Processing :: General',\n 'Topic :: Text Processing :: Linguistic',\n ],\n description='NLP for the ancient world',\n install_requires=['gitpython',\n 'nltk',\n 'python-crfsuite',\n 'pyuca',\n 'pyyaml',\n 'regex',\n 'whoosh'],\n keywords=['nlp', 'nltk', 'greek', 'latin', 'chinese', 'sanskrit', 'pali', 'tibetan'],\n license='MIT',\n long_description='The Classical Language Toolkit (CLTK) is a framework for natural language processing for Classical languages.', # pylint: disable=C0301,\n name='cltk',\n packages=find_packages(),\n url='https://github.com/cltk/cltk',\n version='0.1.64',\n zip_safe=True,\n test_suite='cltk.tests.test_cltk',\n)\n", "path": "setup.py"}]} |
gh_patches_debug_259 | rasdani/github-patches | git_diff | sopel-irc__sopel-949 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Problem in (at least) Wikipedia module: possibly Unicode related
Hi,
observe the following use case:
https://en.wikipedia.org/wiki/Hir%C5%8D_Onoda
@willie_5.4.1 KeyError: u'extract' (file "/usr/local/lib/python2.7/dist-packages/willie-5.4.1-py2.7.egg/willie/modules/wikipedia.py", line 89, in mw_snippet)
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `sopel/modules/wikipedia.py`
Content:
```
1 # coding=utf-8
2 """
3 wikipedia.py - Sopel Wikipedia Module
4 Copyright 2013 Edward Powell - embolalia.net
5 Licensed under the Eiffel Forum License 2.
6
7 http://sopel.chat
8 """
9 from __future__ import unicode_literals, absolute_import, print_function, division
10 from sopel import web, tools
11 from sopel.config.types import StaticSection, ValidatedAttribute
12 from sopel.module import NOLIMIT, commands, example, rule
13 import json
14 import re
15
16 import sys
17 if sys.version_info.major < 3:
18 from urlparse import unquote
19 else:
20 from urllib.parse import unquote
21
22 REDIRECT = re.compile(r'^REDIRECT (.*)')
23
24
25 class WikipediaSection(StaticSection):
26 default_lang = ValidatedAttribute('default_lang', default='en')
27 """The default language to find articles from."""
28 lang_per_channel = ValidatedAttribute('lang_per_channel')
29
30
31 def setup(bot):
32 bot.config.define_section('wikipedia', WikipediaSection)
33
34 regex = re.compile('([a-z]+).(wikipedia.org/wiki/)([^ ]+)')
35 if not bot.memory.contains('url_callbacks'):
36 bot.memory['url_callbacks'] = tools.SopelMemory()
37 bot.memory['url_callbacks'][regex] = mw_info
38
39
40 def configure(config):
41 config.define_section('wikipedia', WikipediaSection)
42 config.wikipedia.configure_setting(
43 'default_lang',
44 "Enter the default language to find articles from."
45 )
46
47
48 def mw_search(server, query, num):
49 """
50 Searches the specified MediaWiki server for the given query, and returns
51 the specified number of results.
52 """
53 search_url = ('http://%s/w/api.php?format=json&action=query'
54 '&list=search&srlimit=%d&srprop=timestamp&srwhat=text'
55 '&srsearch=') % (server, num)
56 search_url += query
57 query = json.loads(web.get(search_url))
58 if 'query' in query:
59 query = query['query']['search']
60 return [r['title'] for r in query]
61 else:
62 return None
63
64
65 def say_snippet(bot, server, query, show_url=True):
66 page_name = query.replace('_', ' ')
67 query = query.replace(' ', '_')
68 snippet = mw_snippet(server, query)
69 msg = '[WIKIPEDIA] {} | "{}"'.format(page_name, snippet)
70 if show_url:
71 msg = msg + ' | https://{}/wiki/{}'.format(server, query)
72 bot.say(msg)
73
74
75 def mw_snippet(server, query):
76 """
77 Retrives a snippet of the specified length from the given page on the given
78 server.
79 """
80 snippet_url = ('https://' + server + '/w/api.php?format=json'
81 '&action=query&prop=extracts&exintro&explaintext'
82 '&exchars=300&redirects&titles=')
83 snippet_url += query
84 snippet = json.loads(web.get(snippet_url))
85 snippet = snippet['query']['pages']
86
87 # For some reason, the API gives the page *number* as the key, so we just
88 # grab the first page number in the results.
89 snippet = snippet[list(snippet.keys())[0]]
90
91 return snippet['extract']
92
93
94 @rule('.*/([a-z]+\.wikipedia.org)/wiki/([^ ]+).*')
95 def mw_info(bot, trigger, found_match=None):
96 """
97 Retrives a snippet of the specified length from the given page on the given
98 server.
99 """
100 match = found_match or trigger
101 say_snippet(bot, match.group(1), unquote(match.group(2)), show_url=False)
102
103
104 @commands('w', 'wiki', 'wik')
105 @example('.w San Francisco')
106 def wikipedia(bot, trigger):
107 lang = bot.config.wikipedia.default_lang
108
109 #change lang if channel has custom language set
110 if (trigger.sender and not trigger.sender.is_nick() and
111 bot.config.wikipedia.lang_per_channel):
112 customlang = re.search('(' + trigger.sender + '):(\w+)',
113 bot.config.wikipedia.lang_per_channel)
114 if customlang is not None:
115 lang = customlang.group(2)
116
117 if trigger.group(2) is None:
118 bot.reply("What do you want me to look up?")
119 return NOLIMIT
120
121 query = trigger.group(2)
122 args = re.search(r'^-([a-z]{2,12})\s(.*)', query)
123 if args is not None:
124 lang = args.group(1)
125 query = args.group(2)
126
127 if not query:
128 bot.reply('What do you want me to look up?')
129 return NOLIMIT
130 server = lang + '.wikipedia.org'
131 query = mw_search(server, query, 1)
132 if not query:
133 bot.reply("I can't find any results for that.")
134 return NOLIMIT
135 else:
136 query = query[0]
137 say_snippet(bot, server, query)
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/sopel/modules/wikipedia.py b/sopel/modules/wikipedia.py
--- a/sopel/modules/wikipedia.py
+++ b/sopel/modules/wikipedia.py
@@ -15,7 +15,8 @@
import sys
if sys.version_info.major < 3:
- from urlparse import unquote
+ from urlparse import unquote as _unquote
+ unquote = lambda s: _unquote(s.encode('utf-8')).decode('utf-8')
else:
from urllib.parse import unquote
| {"golden_diff": "diff --git a/sopel/modules/wikipedia.py b/sopel/modules/wikipedia.py\n--- a/sopel/modules/wikipedia.py\n+++ b/sopel/modules/wikipedia.py\n@@ -15,7 +15,8 @@\n \n import sys\n if sys.version_info.major < 3:\n- from urlparse import unquote\n+ from urlparse import unquote as _unquote\n+ unquote = lambda s: _unquote(s.encode('utf-8')).decode('utf-8')\n else:\n from urllib.parse import unquote\n", "issue": "Problem in (at least) Wikipedia module: possibly Unicode related\nHi,\nobserve the following use case:\n https://en.wikipedia.org/wiki/Hir%C5%8D_Onoda\n @willie_5.4.1 KeyError: u'extract' (file \"/usr/local/lib/python2.7/dist-packages/willie-5.4.1-py2.7.egg/willie/modules/wikipedia.py\", line 89, in mw_snippet)\n\n", "before_files": [{"content": "# coding=utf-8\n\"\"\"\nwikipedia.py - Sopel Wikipedia Module\nCopyright 2013 Edward Powell - embolalia.net\nLicensed under the Eiffel Forum License 2.\n\nhttp://sopel.chat\n\"\"\"\nfrom __future__ import unicode_literals, absolute_import, print_function, division\nfrom sopel import web, tools\nfrom sopel.config.types import StaticSection, ValidatedAttribute\nfrom sopel.module import NOLIMIT, commands, example, rule\nimport json\nimport re\n\nimport sys\nif sys.version_info.major < 3:\n from urlparse import unquote\nelse:\n from urllib.parse import unquote\n\nREDIRECT = re.compile(r'^REDIRECT (.*)')\n\n\nclass WikipediaSection(StaticSection):\n default_lang = ValidatedAttribute('default_lang', default='en')\n \"\"\"The default language to find articles from.\"\"\"\n lang_per_channel = ValidatedAttribute('lang_per_channel')\n\n\ndef setup(bot):\n bot.config.define_section('wikipedia', WikipediaSection)\n\n regex = re.compile('([a-z]+).(wikipedia.org/wiki/)([^ ]+)')\n if not bot.memory.contains('url_callbacks'):\n bot.memory['url_callbacks'] = tools.SopelMemory()\n bot.memory['url_callbacks'][regex] = mw_info\n\n\ndef configure(config):\n config.define_section('wikipedia', WikipediaSection)\n config.wikipedia.configure_setting(\n 'default_lang',\n \"Enter the default language to find articles from.\"\n )\n\n\ndef mw_search(server, query, num):\n \"\"\"\n Searches the specified MediaWiki server for the given query, and returns\n the specified number of results.\n \"\"\"\n search_url = ('http://%s/w/api.php?format=json&action=query'\n '&list=search&srlimit=%d&srprop=timestamp&srwhat=text'\n '&srsearch=') % (server, num)\n search_url += query\n query = json.loads(web.get(search_url))\n if 'query' in query:\n query = query['query']['search']\n return [r['title'] for r in query]\n else:\n return None\n\n\ndef say_snippet(bot, server, query, show_url=True):\n page_name = query.replace('_', ' ')\n query = query.replace(' ', '_')\n snippet = mw_snippet(server, query)\n msg = '[WIKIPEDIA] {} | \"{}\"'.format(page_name, snippet)\n if show_url:\n msg = msg + ' | https://{}/wiki/{}'.format(server, query)\n bot.say(msg)\n\n\ndef mw_snippet(server, query):\n \"\"\"\n Retrives a snippet of the specified length from the given page on the given\n server.\n \"\"\"\n snippet_url = ('https://' + server + '/w/api.php?format=json'\n '&action=query&prop=extracts&exintro&explaintext'\n '&exchars=300&redirects&titles=')\n snippet_url += query\n snippet = json.loads(web.get(snippet_url))\n snippet = snippet['query']['pages']\n\n # For some reason, the API gives the page *number* as the key, so we just\n # grab the first page number in the results.\n snippet = snippet[list(snippet.keys())[0]]\n\n return snippet['extract']\n\n\n@rule('.*/([a-z]+\\.wikipedia.org)/wiki/([^ ]+).*')\ndef mw_info(bot, trigger, found_match=None):\n \"\"\"\n Retrives a snippet of the specified length from the given page on the given\n server.\n \"\"\"\n match = found_match or trigger\n say_snippet(bot, match.group(1), unquote(match.group(2)), show_url=False)\n\n\n@commands('w', 'wiki', 'wik')\n@example('.w San Francisco')\ndef wikipedia(bot, trigger):\n lang = bot.config.wikipedia.default_lang\n\n #change lang if channel has custom language set\n if (trigger.sender and not trigger.sender.is_nick() and\n bot.config.wikipedia.lang_per_channel):\n customlang = re.search('(' + trigger.sender + '):(\\w+)',\n bot.config.wikipedia.lang_per_channel)\n if customlang is not None:\n lang = customlang.group(2)\n\n if trigger.group(2) is None:\n bot.reply(\"What do you want me to look up?\")\n return NOLIMIT\n\n query = trigger.group(2)\n args = re.search(r'^-([a-z]{2,12})\\s(.*)', query)\n if args is not None:\n lang = args.group(1)\n query = args.group(2)\n\n if not query:\n bot.reply('What do you want me to look up?')\n return NOLIMIT\n server = lang + '.wikipedia.org'\n query = mw_search(server, query, 1)\n if not query:\n bot.reply(\"I can't find any results for that.\")\n return NOLIMIT\n else:\n query = query[0]\n say_snippet(bot, server, query)\n", "path": "sopel/modules/wikipedia.py"}], "after_files": [{"content": "# coding=utf-8\n\"\"\"\nwikipedia.py - Sopel Wikipedia Module\nCopyright 2013 Edward Powell - embolalia.net\nLicensed under the Eiffel Forum License 2.\n\nhttp://sopel.chat\n\"\"\"\nfrom __future__ import unicode_literals, absolute_import, print_function, division\nfrom sopel import web, tools\nfrom sopel.config.types import StaticSection, ValidatedAttribute\nfrom sopel.module import NOLIMIT, commands, example, rule\nimport json\nimport re\n\nimport sys\nif sys.version_info.major < 3:\n from urlparse import unquote as _unquote\n unquote = lambda s: _unquote(s.encode('utf-8')).decode('utf-8')\nelse:\n from urllib.parse import unquote\n\nREDIRECT = re.compile(r'^REDIRECT (.*)')\n\n\nclass WikipediaSection(StaticSection):\n default_lang = ValidatedAttribute('default_lang', default='en')\n \"\"\"The default language to find articles from.\"\"\"\n lang_per_channel = ValidatedAttribute('lang_per_channel')\n\n\ndef setup(bot):\n bot.config.define_section('wikipedia', WikipediaSection)\n\n regex = re.compile('([a-z]+).(wikipedia.org/wiki/)([^ ]+)')\n if not bot.memory.contains('url_callbacks'):\n bot.memory['url_callbacks'] = tools.SopelMemory()\n bot.memory['url_callbacks'][regex] = mw_info\n\n\ndef configure(config):\n config.define_section('wikipedia', WikipediaSection)\n config.wikipedia.configure_setting(\n 'default_lang',\n \"Enter the default language to find articles from.\"\n )\n\n\ndef mw_search(server, query, num):\n \"\"\"\n Searches the specified MediaWiki server for the given query, and returns\n the specified number of results.\n \"\"\"\n search_url = ('http://%s/w/api.php?format=json&action=query'\n '&list=search&srlimit=%d&srprop=timestamp&srwhat=text'\n '&srsearch=') % (server, num)\n search_url += query\n query = json.loads(web.get(search_url))\n if 'query' in query:\n query = query['query']['search']\n return [r['title'] for r in query]\n else:\n return None\n\n\ndef say_snippet(bot, server, query, show_url=True):\n page_name = query.replace('_', ' ')\n query = query.replace(' ', '_')\n snippet = mw_snippet(server, query)\n msg = '[WIKIPEDIA] {} | \"{}\"'.format(page_name, snippet)\n if show_url:\n msg = msg + ' | https://{}/wiki/{}'.format(server, query)\n bot.say(msg)\n\n\ndef mw_snippet(server, query):\n \"\"\"\n Retrives a snippet of the specified length from the given page on the given\n server.\n \"\"\"\n snippet_url = ('https://' + server + '/w/api.php?format=json'\n '&action=query&prop=extracts&exintro&explaintext'\n '&exchars=300&redirects&titles=')\n snippet_url += query\n snippet = json.loads(web.get(snippet_url))\n snippet = snippet['query']['pages']\n\n # For some reason, the API gives the page *number* as the key, so we just\n # grab the first page number in the results.\n snippet = snippet[list(snippet.keys())[0]]\n\n return snippet['extract']\n\n\n@rule('.*/([a-z]+\\.wikipedia.org)/wiki/([^ ]+).*')\ndef mw_info(bot, trigger, found_match=None):\n \"\"\"\n Retrives a snippet of the specified length from the given page on the given\n server.\n \"\"\"\n match = found_match or trigger\n say_snippet(bot, match.group(1), unquote(match.group(2)), show_url=False)\n\n\n@commands('w', 'wiki', 'wik')\n@example('.w San Francisco')\ndef wikipedia(bot, trigger):\n lang = bot.config.wikipedia.default_lang\n\n #change lang if channel has custom language set\n if (trigger.sender and not trigger.sender.is_nick() and\n bot.config.wikipedia.lang_per_channel):\n customlang = re.search('(' + trigger.sender + '):(\\w+)',\n bot.config.wikipedia.lang_per_channel)\n if customlang is not None:\n lang = customlang.group(2)\n\n if trigger.group(2) is None:\n bot.reply(\"What do you want me to look up?\")\n return NOLIMIT\n\n query = trigger.group(2)\n args = re.search(r'^-([a-z]{2,12})\\s(.*)', query)\n if args is not None:\n lang = args.group(1)\n query = args.group(2)\n\n if not query:\n bot.reply('What do you want me to look up?')\n return NOLIMIT\n server = lang + '.wikipedia.org'\n query = mw_search(server, query, 1)\n if not query:\n bot.reply(\"I can't find any results for that.\")\n return NOLIMIT\n else:\n query = query[0]\n say_snippet(bot, server, query)\n", "path": "sopel/modules/wikipedia.py"}]} |
gh_patches_debug_260 | rasdani/github-patches | git_diff | scrapy__scrapy-5754 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Silence the `filelock` logger
After we started using `tldextract` we sometimes get log messages from `filelock` with the DEBUG level, it makes sense to silence them like we do for some other libraries in https://github.com/scrapy/scrapy/blob/fe60c1224e39aa3d85b20afd54566f135d9de085/scrapy/utils/log.py#L45-L59
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `scrapy/utils/log.py`
Content:
```
1 import logging
2 import sys
3 import warnings
4 from logging.config import dictConfig
5
6 from twisted.python import log as twisted_log
7 from twisted.python.failure import Failure
8
9 import scrapy
10 from scrapy.exceptions import ScrapyDeprecationWarning
11 from scrapy.settings import Settings
12 from scrapy.utils.versions import scrapy_components_versions
13
14
15 logger = logging.getLogger(__name__)
16
17
18 def failure_to_exc_info(failure):
19 """Extract exc_info from Failure instances"""
20 if isinstance(failure, Failure):
21 return (failure.type, failure.value, failure.getTracebackObject())
22
23
24 class TopLevelFormatter(logging.Filter):
25 """Keep only top level loggers's name (direct children from root) from
26 records.
27
28 This filter will replace Scrapy loggers' names with 'scrapy'. This mimics
29 the old Scrapy log behaviour and helps shortening long names.
30
31 Since it can't be set for just one logger (it won't propagate for its
32 children), it's going to be set in the root handler, with a parametrized
33 ``loggers`` list where it should act.
34 """
35
36 def __init__(self, loggers=None):
37 self.loggers = loggers or []
38
39 def filter(self, record):
40 if any(record.name.startswith(logger + '.') for logger in self.loggers):
41 record.name = record.name.split('.', 1)[0]
42 return True
43
44
45 DEFAULT_LOGGING = {
46 'version': 1,
47 'disable_existing_loggers': False,
48 'loggers': {
49 'hpack': {
50 'level': 'ERROR',
51 },
52 'scrapy': {
53 'level': 'DEBUG',
54 },
55 'twisted': {
56 'level': 'ERROR',
57 },
58 }
59 }
60
61
62 def configure_logging(settings=None, install_root_handler=True):
63 """
64 Initialize logging defaults for Scrapy.
65
66 :param settings: settings used to create and configure a handler for the
67 root logger (default: None).
68 :type settings: dict, :class:`~scrapy.settings.Settings` object or ``None``
69
70 :param install_root_handler: whether to install root logging handler
71 (default: True)
72 :type install_root_handler: bool
73
74 This function does:
75
76 - Route warnings and twisted logging through Python standard logging
77 - Assign DEBUG and ERROR level to Scrapy and Twisted loggers respectively
78 - Route stdout to log if LOG_STDOUT setting is True
79
80 When ``install_root_handler`` is True (default), this function also
81 creates a handler for the root logger according to given settings
82 (see :ref:`topics-logging-settings`). You can override default options
83 using ``settings`` argument. When ``settings`` is empty or None, defaults
84 are used.
85 """
86 if not sys.warnoptions:
87 # Route warnings through python logging
88 logging.captureWarnings(True)
89
90 observer = twisted_log.PythonLoggingObserver('twisted')
91 observer.start()
92
93 dictConfig(DEFAULT_LOGGING)
94
95 if isinstance(settings, dict) or settings is None:
96 settings = Settings(settings)
97
98 if settings.getbool('LOG_STDOUT'):
99 sys.stdout = StreamLogger(logging.getLogger('stdout'))
100
101 if install_root_handler:
102 install_scrapy_root_handler(settings)
103
104
105 def install_scrapy_root_handler(settings):
106 global _scrapy_root_handler
107
108 if (_scrapy_root_handler is not None
109 and _scrapy_root_handler in logging.root.handlers):
110 logging.root.removeHandler(_scrapy_root_handler)
111 logging.root.setLevel(logging.NOTSET)
112 _scrapy_root_handler = _get_handler(settings)
113 logging.root.addHandler(_scrapy_root_handler)
114
115
116 def get_scrapy_root_handler():
117 return _scrapy_root_handler
118
119
120 _scrapy_root_handler = None
121
122
123 def _get_handler(settings):
124 """ Return a log handler object according to settings """
125 filename = settings.get('LOG_FILE')
126 if filename:
127 mode = 'a' if settings.getbool('LOG_FILE_APPEND') else 'w'
128 encoding = settings.get('LOG_ENCODING')
129 handler = logging.FileHandler(filename, mode=mode, encoding=encoding)
130 elif settings.getbool('LOG_ENABLED'):
131 handler = logging.StreamHandler()
132 else:
133 handler = logging.NullHandler()
134
135 formatter = logging.Formatter(
136 fmt=settings.get('LOG_FORMAT'),
137 datefmt=settings.get('LOG_DATEFORMAT')
138 )
139 handler.setFormatter(formatter)
140 handler.setLevel(settings.get('LOG_LEVEL'))
141 if settings.getbool('LOG_SHORT_NAMES'):
142 handler.addFilter(TopLevelFormatter(['scrapy']))
143 return handler
144
145
146 def log_scrapy_info(settings: Settings) -> None:
147 logger.info("Scrapy %(version)s started (bot: %(bot)s)",
148 {'version': scrapy.__version__, 'bot': settings['BOT_NAME']})
149 versions = [
150 f"{name} {version}"
151 for name, version in scrapy_components_versions()
152 if name != "Scrapy"
153 ]
154 logger.info("Versions: %(versions)s", {'versions': ", ".join(versions)})
155
156
157 def log_reactor_info() -> None:
158 from twisted.internet import reactor
159 logger.debug("Using reactor: %s.%s", reactor.__module__, reactor.__class__.__name__)
160 from twisted.internet import asyncioreactor
161 if isinstance(reactor, asyncioreactor.AsyncioSelectorReactor):
162 logger.debug(
163 "Using asyncio event loop: %s.%s",
164 reactor._asyncioEventloop.__module__,
165 reactor._asyncioEventloop.__class__.__name__,
166 )
167
168
169 class StreamLogger:
170 """Fake file-like stream object that redirects writes to a logger instance
171
172 Taken from:
173 https://www.electricmonk.nl/log/2011/08/14/redirect-stdout-and-stderr-to-a-logger-in-python/
174 """
175 def __init__(self, logger, log_level=logging.INFO):
176 self.logger = logger
177 self.log_level = log_level
178 self.linebuf = ''
179
180 def write(self, buf):
181 for line in buf.rstrip().splitlines():
182 self.logger.log(self.log_level, line.rstrip())
183
184 def flush(self):
185 for h in self.logger.handlers:
186 h.flush()
187
188
189 class LogCounterHandler(logging.Handler):
190 """Record log levels count into a crawler stats"""
191
192 def __init__(self, crawler, *args, **kwargs):
193 super().__init__(*args, **kwargs)
194 self.crawler = crawler
195
196 def emit(self, record):
197 sname = f'log_count/{record.levelname}'
198 self.crawler.stats.inc_value(sname)
199
200
201 def logformatter_adapter(logkws):
202 """
203 Helper that takes the dictionary output from the methods in LogFormatter
204 and adapts it into a tuple of positional arguments for logger.log calls,
205 handling backward compatibility as well.
206 """
207 if not {'level', 'msg', 'args'} <= set(logkws):
208 warnings.warn('Missing keys in LogFormatter method',
209 ScrapyDeprecationWarning)
210
211 if 'format' in logkws:
212 warnings.warn('`format` key in LogFormatter methods has been '
213 'deprecated, use `msg` instead',
214 ScrapyDeprecationWarning)
215
216 level = logkws.get('level', logging.INFO)
217 message = logkws.get('format', logkws.get('msg'))
218 # NOTE: This also handles 'args' being an empty dict, that case doesn't
219 # play well in logger.log calls
220 args = logkws if not logkws.get('args') else logkws['args']
221
222 return (level, message, args)
223
```
--- 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/scrapy/utils/log.py b/scrapy/utils/log.py
--- a/scrapy/utils/log.py
+++ b/scrapy/utils/log.py
@@ -46,6 +46,9 @@
'version': 1,
'disable_existing_loggers': False,
'loggers': {
+ 'filelock': {
+ 'level': 'ERROR',
+ },
'hpack': {
'level': 'ERROR',
},
| {"golden_diff": "diff --git a/scrapy/utils/log.py b/scrapy/utils/log.py\n--- a/scrapy/utils/log.py\n+++ b/scrapy/utils/log.py\n@@ -46,6 +46,9 @@\n 'version': 1,\n 'disable_existing_loggers': False,\n 'loggers': {\n+ 'filelock': {\n+ 'level': 'ERROR',\n+ },\n 'hpack': {\n 'level': 'ERROR',\n },\n", "issue": "Silence the `filelock` logger\nAfter we started using `tldextract` we sometimes get log messages from `filelock` with the DEBUG level, it makes sense to silence them like we do for some other libraries in https://github.com/scrapy/scrapy/blob/fe60c1224e39aa3d85b20afd54566f135d9de085/scrapy/utils/log.py#L45-L59\n", "before_files": [{"content": "import logging\nimport sys\nimport warnings\nfrom logging.config import dictConfig\n\nfrom twisted.python import log as twisted_log\nfrom twisted.python.failure import Failure\n\nimport scrapy\nfrom scrapy.exceptions import ScrapyDeprecationWarning\nfrom scrapy.settings import Settings\nfrom scrapy.utils.versions import scrapy_components_versions\n\n\nlogger = logging.getLogger(__name__)\n\n\ndef failure_to_exc_info(failure):\n \"\"\"Extract exc_info from Failure instances\"\"\"\n if isinstance(failure, Failure):\n return (failure.type, failure.value, failure.getTracebackObject())\n\n\nclass TopLevelFormatter(logging.Filter):\n \"\"\"Keep only top level loggers's name (direct children from root) from\n records.\n\n This filter will replace Scrapy loggers' names with 'scrapy'. This mimics\n the old Scrapy log behaviour and helps shortening long names.\n\n Since it can't be set for just one logger (it won't propagate for its\n children), it's going to be set in the root handler, with a parametrized\n ``loggers`` list where it should act.\n \"\"\"\n\n def __init__(self, loggers=None):\n self.loggers = loggers or []\n\n def filter(self, record):\n if any(record.name.startswith(logger + '.') for logger in self.loggers):\n record.name = record.name.split('.', 1)[0]\n return True\n\n\nDEFAULT_LOGGING = {\n 'version': 1,\n 'disable_existing_loggers': False,\n 'loggers': {\n 'hpack': {\n 'level': 'ERROR',\n },\n 'scrapy': {\n 'level': 'DEBUG',\n },\n 'twisted': {\n 'level': 'ERROR',\n },\n }\n}\n\n\ndef configure_logging(settings=None, install_root_handler=True):\n \"\"\"\n Initialize logging defaults for Scrapy.\n\n :param settings: settings used to create and configure a handler for the\n root logger (default: None).\n :type settings: dict, :class:`~scrapy.settings.Settings` object or ``None``\n\n :param install_root_handler: whether to install root logging handler\n (default: True)\n :type install_root_handler: bool\n\n This function does:\n\n - Route warnings and twisted logging through Python standard logging\n - Assign DEBUG and ERROR level to Scrapy and Twisted loggers respectively\n - Route stdout to log if LOG_STDOUT setting is True\n\n When ``install_root_handler`` is True (default), this function also\n creates a handler for the root logger according to given settings\n (see :ref:`topics-logging-settings`). You can override default options\n using ``settings`` argument. When ``settings`` is empty or None, defaults\n are used.\n \"\"\"\n if not sys.warnoptions:\n # Route warnings through python logging\n logging.captureWarnings(True)\n\n observer = twisted_log.PythonLoggingObserver('twisted')\n observer.start()\n\n dictConfig(DEFAULT_LOGGING)\n\n if isinstance(settings, dict) or settings is None:\n settings = Settings(settings)\n\n if settings.getbool('LOG_STDOUT'):\n sys.stdout = StreamLogger(logging.getLogger('stdout'))\n\n if install_root_handler:\n install_scrapy_root_handler(settings)\n\n\ndef install_scrapy_root_handler(settings):\n global _scrapy_root_handler\n\n if (_scrapy_root_handler is not None\n and _scrapy_root_handler in logging.root.handlers):\n logging.root.removeHandler(_scrapy_root_handler)\n logging.root.setLevel(logging.NOTSET)\n _scrapy_root_handler = _get_handler(settings)\n logging.root.addHandler(_scrapy_root_handler)\n\n\ndef get_scrapy_root_handler():\n return _scrapy_root_handler\n\n\n_scrapy_root_handler = None\n\n\ndef _get_handler(settings):\n \"\"\" Return a log handler object according to settings \"\"\"\n filename = settings.get('LOG_FILE')\n if filename:\n mode = 'a' if settings.getbool('LOG_FILE_APPEND') else 'w'\n encoding = settings.get('LOG_ENCODING')\n handler = logging.FileHandler(filename, mode=mode, encoding=encoding)\n elif settings.getbool('LOG_ENABLED'):\n handler = logging.StreamHandler()\n else:\n handler = logging.NullHandler()\n\n formatter = logging.Formatter(\n fmt=settings.get('LOG_FORMAT'),\n datefmt=settings.get('LOG_DATEFORMAT')\n )\n handler.setFormatter(formatter)\n handler.setLevel(settings.get('LOG_LEVEL'))\n if settings.getbool('LOG_SHORT_NAMES'):\n handler.addFilter(TopLevelFormatter(['scrapy']))\n return handler\n\n\ndef log_scrapy_info(settings: Settings) -> None:\n logger.info(\"Scrapy %(version)s started (bot: %(bot)s)\",\n {'version': scrapy.__version__, 'bot': settings['BOT_NAME']})\n versions = [\n f\"{name} {version}\"\n for name, version in scrapy_components_versions()\n if name != \"Scrapy\"\n ]\n logger.info(\"Versions: %(versions)s\", {'versions': \", \".join(versions)})\n\n\ndef log_reactor_info() -> None:\n from twisted.internet import reactor\n logger.debug(\"Using reactor: %s.%s\", reactor.__module__, reactor.__class__.__name__)\n from twisted.internet import asyncioreactor\n if isinstance(reactor, asyncioreactor.AsyncioSelectorReactor):\n logger.debug(\n \"Using asyncio event loop: %s.%s\",\n reactor._asyncioEventloop.__module__,\n reactor._asyncioEventloop.__class__.__name__,\n )\n\n\nclass StreamLogger:\n \"\"\"Fake file-like stream object that redirects writes to a logger instance\n\n Taken from:\n https://www.electricmonk.nl/log/2011/08/14/redirect-stdout-and-stderr-to-a-logger-in-python/\n \"\"\"\n def __init__(self, logger, log_level=logging.INFO):\n self.logger = logger\n self.log_level = log_level\n self.linebuf = ''\n\n def write(self, buf):\n for line in buf.rstrip().splitlines():\n self.logger.log(self.log_level, line.rstrip())\n\n def flush(self):\n for h in self.logger.handlers:\n h.flush()\n\n\nclass LogCounterHandler(logging.Handler):\n \"\"\"Record log levels count into a crawler stats\"\"\"\n\n def __init__(self, crawler, *args, **kwargs):\n super().__init__(*args, **kwargs)\n self.crawler = crawler\n\n def emit(self, record):\n sname = f'log_count/{record.levelname}'\n self.crawler.stats.inc_value(sname)\n\n\ndef logformatter_adapter(logkws):\n \"\"\"\n Helper that takes the dictionary output from the methods in LogFormatter\n and adapts it into a tuple of positional arguments for logger.log calls,\n handling backward compatibility as well.\n \"\"\"\n if not {'level', 'msg', 'args'} <= set(logkws):\n warnings.warn('Missing keys in LogFormatter method',\n ScrapyDeprecationWarning)\n\n if 'format' in logkws:\n warnings.warn('`format` key in LogFormatter methods has been '\n 'deprecated, use `msg` instead',\n ScrapyDeprecationWarning)\n\n level = logkws.get('level', logging.INFO)\n message = logkws.get('format', logkws.get('msg'))\n # NOTE: This also handles 'args' being an empty dict, that case doesn't\n # play well in logger.log calls\n args = logkws if not logkws.get('args') else logkws['args']\n\n return (level, message, args)\n", "path": "scrapy/utils/log.py"}], "after_files": [{"content": "import logging\nimport sys\nimport warnings\nfrom logging.config import dictConfig\n\nfrom twisted.python import log as twisted_log\nfrom twisted.python.failure import Failure\n\nimport scrapy\nfrom scrapy.exceptions import ScrapyDeprecationWarning\nfrom scrapy.settings import Settings\nfrom scrapy.utils.versions import scrapy_components_versions\n\n\nlogger = logging.getLogger(__name__)\n\n\ndef failure_to_exc_info(failure):\n \"\"\"Extract exc_info from Failure instances\"\"\"\n if isinstance(failure, Failure):\n return (failure.type, failure.value, failure.getTracebackObject())\n\n\nclass TopLevelFormatter(logging.Filter):\n \"\"\"Keep only top level loggers's name (direct children from root) from\n records.\n\n This filter will replace Scrapy loggers' names with 'scrapy'. This mimics\n the old Scrapy log behaviour and helps shortening long names.\n\n Since it can't be set for just one logger (it won't propagate for its\n children), it's going to be set in the root handler, with a parametrized\n ``loggers`` list where it should act.\n \"\"\"\n\n def __init__(self, loggers=None):\n self.loggers = loggers or []\n\n def filter(self, record):\n if any(record.name.startswith(logger + '.') for logger in self.loggers):\n record.name = record.name.split('.', 1)[0]\n return True\n\n\nDEFAULT_LOGGING = {\n 'version': 1,\n 'disable_existing_loggers': False,\n 'loggers': {\n 'filelock': {\n 'level': 'ERROR',\n },\n 'hpack': {\n 'level': 'ERROR',\n },\n 'scrapy': {\n 'level': 'DEBUG',\n },\n 'twisted': {\n 'level': 'ERROR',\n },\n }\n}\n\n\ndef configure_logging(settings=None, install_root_handler=True):\n \"\"\"\n Initialize logging defaults for Scrapy.\n\n :param settings: settings used to create and configure a handler for the\n root logger (default: None).\n :type settings: dict, :class:`~scrapy.settings.Settings` object or ``None``\n\n :param install_root_handler: whether to install root logging handler\n (default: True)\n :type install_root_handler: bool\n\n This function does:\n\n - Route warnings and twisted logging through Python standard logging\n - Assign DEBUG and ERROR level to Scrapy and Twisted loggers respectively\n - Route stdout to log if LOG_STDOUT setting is True\n\n When ``install_root_handler`` is True (default), this function also\n creates a handler for the root logger according to given settings\n (see :ref:`topics-logging-settings`). You can override default options\n using ``settings`` argument. When ``settings`` is empty or None, defaults\n are used.\n \"\"\"\n if not sys.warnoptions:\n # Route warnings through python logging\n logging.captureWarnings(True)\n\n observer = twisted_log.PythonLoggingObserver('twisted')\n observer.start()\n\n dictConfig(DEFAULT_LOGGING)\n\n if isinstance(settings, dict) or settings is None:\n settings = Settings(settings)\n\n if settings.getbool('LOG_STDOUT'):\n sys.stdout = StreamLogger(logging.getLogger('stdout'))\n\n if install_root_handler:\n install_scrapy_root_handler(settings)\n\n\ndef install_scrapy_root_handler(settings):\n global _scrapy_root_handler\n\n if (_scrapy_root_handler is not None\n and _scrapy_root_handler in logging.root.handlers):\n logging.root.removeHandler(_scrapy_root_handler)\n logging.root.setLevel(logging.NOTSET)\n _scrapy_root_handler = _get_handler(settings)\n logging.root.addHandler(_scrapy_root_handler)\n\n\ndef get_scrapy_root_handler():\n return _scrapy_root_handler\n\n\n_scrapy_root_handler = None\n\n\ndef _get_handler(settings):\n \"\"\" Return a log handler object according to settings \"\"\"\n filename = settings.get('LOG_FILE')\n if filename:\n mode = 'a' if settings.getbool('LOG_FILE_APPEND') else 'w'\n encoding = settings.get('LOG_ENCODING')\n handler = logging.FileHandler(filename, mode=mode, encoding=encoding)\n elif settings.getbool('LOG_ENABLED'):\n handler = logging.StreamHandler()\n else:\n handler = logging.NullHandler()\n\n formatter = logging.Formatter(\n fmt=settings.get('LOG_FORMAT'),\n datefmt=settings.get('LOG_DATEFORMAT')\n )\n handler.setFormatter(formatter)\n handler.setLevel(settings.get('LOG_LEVEL'))\n if settings.getbool('LOG_SHORT_NAMES'):\n handler.addFilter(TopLevelFormatter(['scrapy']))\n return handler\n\n\ndef log_scrapy_info(settings: Settings) -> None:\n logger.info(\"Scrapy %(version)s started (bot: %(bot)s)\",\n {'version': scrapy.__version__, 'bot': settings['BOT_NAME']})\n versions = [\n f\"{name} {version}\"\n for name, version in scrapy_components_versions()\n if name != \"Scrapy\"\n ]\n logger.info(\"Versions: %(versions)s\", {'versions': \", \".join(versions)})\n\n\ndef log_reactor_info() -> None:\n from twisted.internet import reactor\n logger.debug(\"Using reactor: %s.%s\", reactor.__module__, reactor.__class__.__name__)\n from twisted.internet import asyncioreactor\n if isinstance(reactor, asyncioreactor.AsyncioSelectorReactor):\n logger.debug(\n \"Using asyncio event loop: %s.%s\",\n reactor._asyncioEventloop.__module__,\n reactor._asyncioEventloop.__class__.__name__,\n )\n\n\nclass StreamLogger:\n \"\"\"Fake file-like stream object that redirects writes to a logger instance\n\n Taken from:\n https://www.electricmonk.nl/log/2011/08/14/redirect-stdout-and-stderr-to-a-logger-in-python/\n \"\"\"\n def __init__(self, logger, log_level=logging.INFO):\n self.logger = logger\n self.log_level = log_level\n self.linebuf = ''\n\n def write(self, buf):\n for line in buf.rstrip().splitlines():\n self.logger.log(self.log_level, line.rstrip())\n\n def flush(self):\n for h in self.logger.handlers:\n h.flush()\n\n\nclass LogCounterHandler(logging.Handler):\n \"\"\"Record log levels count into a crawler stats\"\"\"\n\n def __init__(self, crawler, *args, **kwargs):\n super().__init__(*args, **kwargs)\n self.crawler = crawler\n\n def emit(self, record):\n sname = f'log_count/{record.levelname}'\n self.crawler.stats.inc_value(sname)\n\n\ndef logformatter_adapter(logkws):\n \"\"\"\n Helper that takes the dictionary output from the methods in LogFormatter\n and adapts it into a tuple of positional arguments for logger.log calls,\n handling backward compatibility as well.\n \"\"\"\n if not {'level', 'msg', 'args'} <= set(logkws):\n warnings.warn('Missing keys in LogFormatter method',\n ScrapyDeprecationWarning)\n\n if 'format' in logkws:\n warnings.warn('`format` key in LogFormatter methods has been '\n 'deprecated, use `msg` instead',\n ScrapyDeprecationWarning)\n\n level = logkws.get('level', logging.INFO)\n message = logkws.get('format', logkws.get('msg'))\n # NOTE: This also handles 'args' being an empty dict, that case doesn't\n # play well in logger.log calls\n args = logkws if not logkws.get('args') else logkws['args']\n\n return (level, message, args)\n", "path": "scrapy/utils/log.py"}]} |
gh_patches_debug_261 | rasdani/github-patches | git_diff | sopel-irc__sopel-493 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[chanlogs] Missing copyright header
@singingwolfboy could you add the copyright header to comply with the [EFL](https://github.com/embolalia/willie/blob/master/COPYING)? Below is the required lay-out:
```
# coding=utf-8
"""
chanlogs.py - Willie Channel Logger Module
Copyright 2014, FIRSTNAME LASTNAME <EMAIL>
Licensed under the Eiffel Forum License 2.
http://willie.dftba.net
"""
```
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `willie/modules/chanlogs.py`
Content:
```
1 #coding: utf8
2 """
3 Channel logger
4 """
5 from __future__ import unicode_literals
6 import os
7 import os.path
8 import threading
9 from datetime import datetime
10 import willie.module
11 import willie.tools
12 from willie.config import ConfigurationError
13
14 MESSAGE_TPL = "{datetime} <{origin.nick}> {message}"
15 ACTION_TPL = "{datetime} * {origin.nick} {message}"
16 NICK_TPL = "{datetime} *** {origin.nick} is now known as {origin.sender}"
17 JOIN_TPL = "{datetime} *** {origin.nick} has joined {trigger}"
18 PART_TPL = "{datetime} *** {origin.nick} has left {trigger}"
19 QUIT_TPL = "{datetime} *** {origin.nick} has quit IRC"
20
21
22 def configure(config):
23 if config.option("Configure channel logging", False):
24 config.add_section("chanlogs")
25 config.interactive_add(
26 "chanlogs", "dir",
27 "Absolute path to channel log storage directory",
28 default="/home/willie/chanlogs"
29 )
30 config.add_option("chanlogs", "by_day", "Split log files by day", default=True)
31 config.add_option("chanlogs", "privmsg", "Record private messages", default=False)
32 config.add_option("chanlogs", "microseconds", "Microsecond precision", default=False)
33 # could ask if user wants to customize message templates,
34 # but that seems unnecessary
35
36
37 def get_fpath(bot, channel=None):
38 """
39 Returns a string corresponding to the path to the file where the message
40 currently being handled should be logged.
41 """
42 basedir = os.path.expanduser(bot.config.chanlogs.dir)
43 channel = channel or bot.origin.sender
44 channel = channel.lstrip("#")
45
46 dt = datetime.utcnow()
47 if not bot.config.chanlogs.microseconds:
48 dt = dt.replace(microsecond=0)
49 if bot.config.chanlogs.by_day:
50 fname = "{channel}-{date}.log".format(channel=channel, date=dt.date().isoformat())
51 else:
52 fname = "{channel}.log".format(channel=channel)
53 return os.path.join(basedir, fname)
54
55
56 def _format_template(tpl, bot, **kwargs):
57 dt = datetime.utcnow()
58 if not bot.config.chanlogs.microseconds:
59 dt = dt.replace(microsecond=0)
60
61 return tpl.format(
62 origin=bot.origin, datetime=dt.isoformat(),
63 date=dt.date().isoformat(), time=dt.time().isoformat(),
64 **kwargs
65 ) + "\n"
66
67
68 def setup(bot):
69 if not getattr(bot.config, "chanlogs", None):
70 raise ConfigurationError("Channel logs are not configured")
71 if not getattr(bot.config.chanlogs, "dir", None):
72 raise ConfigurationError("Channel log storage directory is not defined")
73
74 # ensure log directory exists
75 basedir = os.path.expanduser(bot.config.chanlogs.dir)
76 if not os.path.exists(basedir):
77 os.makedirs(basedir)
78
79 # locks for log files
80 if not bot.memory.contains('chanlog_locks'):
81 bot.memory['chanlog_locks'] = willie.tools.WillieMemoryWithDefault(threading.Lock)
82
83
84 @willie.module.rule('.*')
85 @willie.module.unblockable
86 def log_message(bot, message):
87 "Log every message in a channel"
88 # if this is a private message and we're not logging those, return early
89 if not bot.origin.sender.startswith("#") and not bot.config.chanlogs.privmsg:
90 return
91
92 # determine which template we want, message or action
93 if message.startswith("\001ACTION ") and message.endswith("\001"):
94 tpl = bot.config.chanlogs.action_template or ACTION_TPL
95 # strip off start and end
96 message = message[8:-1]
97 else:
98 tpl = bot.config.chanlogs.message_template or MESSAGE_TPL
99
100 logline = _format_template(tpl, bot, message=message)
101 fpath = get_fpath(bot)
102 with bot.memory['chanlog_locks'][fpath]:
103 with open(fpath, "a") as f:
104 f.write(logline.encode('utf-8'))
105
106
107 @willie.module.rule('.*')
108 @willie.module.event("JOIN")
109 @willie.module.unblockable
110 def log_join(bot, trigger):
111 tpl = bot.config.chanlogs.join_template or JOIN_TPL
112 logline = _format_template(tpl, bot, trigger=trigger)
113 fpath = get_fpath(bot, channel=trigger)
114 with bot.memory['chanlog_locks'][fpath]:
115 with open(fpath, "a") as f:
116 f.write(logline.encode('utf-8'))
117
118
119 @willie.module.rule('.*')
120 @willie.module.event("PART")
121 @willie.module.unblockable
122 def log_part(bot, trigger):
123 tpl = bot.config.chanlogs.part_template or PART_TPL
124 logline = _format_template(tpl, bot, trigger=trigger)
125 fpath = get_fpath(bot, channel=trigger)
126 with bot.memory['chanlog_locks'][fpath]:
127 with open(fpath, "a") as f:
128 f.write(logline.encode('utf-8'))
129
130
131 @willie.module.rule('.*')
132 @willie.module.event("QUIT")
133 @willie.module.unblockable
134 @willie.module.thread(False)
135 @willie.module.priority('high')
136 def log_quit(bot, trigger):
137 tpl = bot.config.chanlogs.quit_template or QUIT_TPL
138 logline = _format_template(tpl, bot, trigger=trigger)
139 # make a copy of bot.privileges that we can safely iterate over
140 privcopy = list(bot.privileges.items())
141 # write logline to *all* channels that the user was present in
142 for channel, privileges in privcopy:
143 if bot.origin.nick in privileges:
144 fpath = get_fpath(bot, channel)
145 with bot.memory['chanlog_locks'][fpath]:
146 with open(fpath, "a") as f:
147 f.write(logline.encode('utf-8'))
148
149
150 @willie.module.rule('.*')
151 @willie.module.event("NICK")
152 @willie.module.unblockable
153 def log_nick_change(bot, trigger):
154 tpl = bot.config.chanlogs.nick_template or NICK_TPL
155 logline = _format_template(tpl, bot, trigger=trigger)
156 old_nick = bot.origin.nick
157 new_nick = bot.origin.sender
158 # make a copy of bot.privileges that we can safely iterate over
159 privcopy = list(bot.privileges.items())
160 # write logline to *all* channels that the user is present in
161 for channel, privileges in privcopy:
162 if old_nick in privileges or new_nick in privileges:
163 fpath = get_fpath(bot, channel)
164 with bot.memory['chanlog_locks'][fpath]:
165 with open(fpath, "a") as f:
166 f.write(logline.encode('utf-8'))
167
```
--- 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/willie/modules/chanlogs.py b/willie/modules/chanlogs.py
--- a/willie/modules/chanlogs.py
+++ b/willie/modules/chanlogs.py
@@ -1,6 +1,11 @@
-#coding: utf8
+# coding=utf-8
"""
-Channel logger
+chanlogs.py - Willie Channel Logger module
+Copyright 2014, David Baumgold <[email protected]>
+
+Licensed under the Eiffel Forum License 2
+
+http://willie.dftba.net
"""
from __future__ import unicode_literals
import os
| {"golden_diff": "diff --git a/willie/modules/chanlogs.py b/willie/modules/chanlogs.py\n--- a/willie/modules/chanlogs.py\n+++ b/willie/modules/chanlogs.py\n@@ -1,6 +1,11 @@\n-#coding: utf8\n+# coding=utf-8\n \"\"\"\n-Channel logger\n+chanlogs.py - Willie Channel Logger module\n+Copyright 2014, David Baumgold <[email protected]>\n+\n+Licensed under the Eiffel Forum License 2\n+\n+http://willie.dftba.net\n \"\"\"\n from __future__ import unicode_literals\n import os\n", "issue": "[chanlogs] Missing copyright header\n@singingwolfboy could you add the copyright header to comply with the [EFL](https://github.com/embolalia/willie/blob/master/COPYING)? Below is the required lay-out:\n\n```\n# coding=utf-8\n\"\"\"\nchanlogs.py - Willie Channel Logger Module\nCopyright 2014, FIRSTNAME LASTNAME <EMAIL>\n\nLicensed under the Eiffel Forum License 2.\n\nhttp://willie.dftba.net\n\"\"\"\n```\n\n", "before_files": [{"content": "#coding: utf8\n\"\"\"\nChannel logger\n\"\"\"\nfrom __future__ import unicode_literals\nimport os\nimport os.path\nimport threading\nfrom datetime import datetime\nimport willie.module\nimport willie.tools\nfrom willie.config import ConfigurationError\n\nMESSAGE_TPL = \"{datetime} <{origin.nick}> {message}\"\nACTION_TPL = \"{datetime} * {origin.nick} {message}\"\nNICK_TPL = \"{datetime} *** {origin.nick} is now known as {origin.sender}\"\nJOIN_TPL = \"{datetime} *** {origin.nick} has joined {trigger}\"\nPART_TPL = \"{datetime} *** {origin.nick} has left {trigger}\"\nQUIT_TPL = \"{datetime} *** {origin.nick} has quit IRC\"\n\n\ndef configure(config):\n if config.option(\"Configure channel logging\", False):\n config.add_section(\"chanlogs\")\n config.interactive_add(\n \"chanlogs\", \"dir\",\n \"Absolute path to channel log storage directory\",\n default=\"/home/willie/chanlogs\"\n )\n config.add_option(\"chanlogs\", \"by_day\", \"Split log files by day\", default=True)\n config.add_option(\"chanlogs\", \"privmsg\", \"Record private messages\", default=False)\n config.add_option(\"chanlogs\", \"microseconds\", \"Microsecond precision\", default=False)\n # could ask if user wants to customize message templates,\n # but that seems unnecessary\n\n\ndef get_fpath(bot, channel=None):\n \"\"\"\n Returns a string corresponding to the path to the file where the message\n currently being handled should be logged.\n \"\"\"\n basedir = os.path.expanduser(bot.config.chanlogs.dir)\n channel = channel or bot.origin.sender\n channel = channel.lstrip(\"#\")\n\n dt = datetime.utcnow()\n if not bot.config.chanlogs.microseconds:\n dt = dt.replace(microsecond=0)\n if bot.config.chanlogs.by_day:\n fname = \"{channel}-{date}.log\".format(channel=channel, date=dt.date().isoformat())\n else:\n fname = \"{channel}.log\".format(channel=channel)\n return os.path.join(basedir, fname)\n\n\ndef _format_template(tpl, bot, **kwargs):\n dt = datetime.utcnow()\n if not bot.config.chanlogs.microseconds:\n dt = dt.replace(microsecond=0)\n\n return tpl.format(\n origin=bot.origin, datetime=dt.isoformat(),\n date=dt.date().isoformat(), time=dt.time().isoformat(),\n **kwargs\n ) + \"\\n\"\n\n\ndef setup(bot):\n if not getattr(bot.config, \"chanlogs\", None):\n raise ConfigurationError(\"Channel logs are not configured\")\n if not getattr(bot.config.chanlogs, \"dir\", None):\n raise ConfigurationError(\"Channel log storage directory is not defined\")\n\n # ensure log directory exists\n basedir = os.path.expanduser(bot.config.chanlogs.dir)\n if not os.path.exists(basedir):\n os.makedirs(basedir)\n\n # locks for log files\n if not bot.memory.contains('chanlog_locks'):\n bot.memory['chanlog_locks'] = willie.tools.WillieMemoryWithDefault(threading.Lock)\n\n\[email protected]('.*')\[email protected]\ndef log_message(bot, message):\n \"Log every message in a channel\"\n # if this is a private message and we're not logging those, return early\n if not bot.origin.sender.startswith(\"#\") and not bot.config.chanlogs.privmsg:\n return\n\n # determine which template we want, message or action\n if message.startswith(\"\\001ACTION \") and message.endswith(\"\\001\"):\n tpl = bot.config.chanlogs.action_template or ACTION_TPL\n # strip off start and end\n message = message[8:-1]\n else:\n tpl = bot.config.chanlogs.message_template or MESSAGE_TPL\n\n logline = _format_template(tpl, bot, message=message)\n fpath = get_fpath(bot)\n with bot.memory['chanlog_locks'][fpath]:\n with open(fpath, \"a\") as f:\n f.write(logline.encode('utf-8'))\n\n\[email protected]('.*')\[email protected](\"JOIN\")\[email protected]\ndef log_join(bot, trigger):\n tpl = bot.config.chanlogs.join_template or JOIN_TPL\n logline = _format_template(tpl, bot, trigger=trigger)\n fpath = get_fpath(bot, channel=trigger)\n with bot.memory['chanlog_locks'][fpath]:\n with open(fpath, \"a\") as f:\n f.write(logline.encode('utf-8'))\n\n\[email protected]('.*')\[email protected](\"PART\")\[email protected]\ndef log_part(bot, trigger):\n tpl = bot.config.chanlogs.part_template or PART_TPL\n logline = _format_template(tpl, bot, trigger=trigger)\n fpath = get_fpath(bot, channel=trigger)\n with bot.memory['chanlog_locks'][fpath]:\n with open(fpath, \"a\") as f:\n f.write(logline.encode('utf-8'))\n\n\[email protected]('.*')\[email protected](\"QUIT\")\[email protected]\[email protected](False)\[email protected]('high')\ndef log_quit(bot, trigger):\n tpl = bot.config.chanlogs.quit_template or QUIT_TPL\n logline = _format_template(tpl, bot, trigger=trigger)\n # make a copy of bot.privileges that we can safely iterate over\n privcopy = list(bot.privileges.items())\n # write logline to *all* channels that the user was present in\n for channel, privileges in privcopy:\n if bot.origin.nick in privileges:\n fpath = get_fpath(bot, channel)\n with bot.memory['chanlog_locks'][fpath]:\n with open(fpath, \"a\") as f:\n f.write(logline.encode('utf-8'))\n\n\[email protected]('.*')\[email protected](\"NICK\")\[email protected]\ndef log_nick_change(bot, trigger):\n tpl = bot.config.chanlogs.nick_template or NICK_TPL\n logline = _format_template(tpl, bot, trigger=trigger)\n old_nick = bot.origin.nick\n new_nick = bot.origin.sender\n # make a copy of bot.privileges that we can safely iterate over\n privcopy = list(bot.privileges.items())\n # write logline to *all* channels that the user is present in\n for channel, privileges in privcopy:\n if old_nick in privileges or new_nick in privileges:\n fpath = get_fpath(bot, channel)\n with bot.memory['chanlog_locks'][fpath]:\n with open(fpath, \"a\") as f:\n f.write(logline.encode('utf-8'))\n", "path": "willie/modules/chanlogs.py"}], "after_files": [{"content": "# coding=utf-8\n\"\"\"\nchanlogs.py - Willie Channel Logger module\nCopyright 2014, David Baumgold <[email protected]>\n\nLicensed under the Eiffel Forum License 2\n\nhttp://willie.dftba.net\n\"\"\"\nfrom __future__ import unicode_literals\nimport os\nimport os.path\nimport threading\nfrom datetime import datetime\nimport willie.module\nimport willie.tools\nfrom willie.config import ConfigurationError\n\nMESSAGE_TPL = \"{datetime} <{origin.nick}> {message}\"\nACTION_TPL = \"{datetime} * {origin.nick} {message}\"\nNICK_TPL = \"{datetime} *** {origin.nick} is now known as {origin.sender}\"\nJOIN_TPL = \"{datetime} *** {origin.nick} has joined {trigger}\"\nPART_TPL = \"{datetime} *** {origin.nick} has left {trigger}\"\nQUIT_TPL = \"{datetime} *** {origin.nick} has quit IRC\"\n\n\ndef configure(config):\n if config.option(\"Configure channel logging\", False):\n config.add_section(\"chanlogs\")\n config.interactive_add(\n \"chanlogs\", \"dir\",\n \"Absolute path to channel log storage directory\",\n default=\"/home/willie/chanlogs\"\n )\n config.add_option(\"chanlogs\", \"by_day\", \"Split log files by day\", default=True)\n config.add_option(\"chanlogs\", \"privmsg\", \"Record private messages\", default=False)\n config.add_option(\"chanlogs\", \"microseconds\", \"Microsecond precision\", default=False)\n # could ask if user wants to customize message templates,\n # but that seems unnecessary\n\n\ndef get_fpath(bot, channel=None):\n \"\"\"\n Returns a string corresponding to the path to the file where the message\n currently being handled should be logged.\n \"\"\"\n basedir = os.path.expanduser(bot.config.chanlogs.dir)\n channel = channel or bot.origin.sender\n channel = channel.lstrip(\"#\")\n\n dt = datetime.utcnow()\n if not bot.config.chanlogs.microseconds:\n dt = dt.replace(microsecond=0)\n if bot.config.chanlogs.by_day:\n fname = \"{channel}-{date}.log\".format(channel=channel, date=dt.date().isoformat())\n else:\n fname = \"{channel}.log\".format(channel=channel)\n return os.path.join(basedir, fname)\n\n\ndef _format_template(tpl, bot, **kwargs):\n dt = datetime.utcnow()\n if not bot.config.chanlogs.microseconds:\n dt = dt.replace(microsecond=0)\n\n return tpl.format(\n origin=bot.origin, datetime=dt.isoformat(),\n date=dt.date().isoformat(), time=dt.time().isoformat(),\n **kwargs\n ) + \"\\n\"\n\n\ndef setup(bot):\n if not getattr(bot.config, \"chanlogs\", None):\n raise ConfigurationError(\"Channel logs are not configured\")\n if not getattr(bot.config.chanlogs, \"dir\", None):\n raise ConfigurationError(\"Channel log storage directory is not defined\")\n\n # ensure log directory exists\n basedir = os.path.expanduser(bot.config.chanlogs.dir)\n if not os.path.exists(basedir):\n os.makedirs(basedir)\n\n # locks for log files\n if not bot.memory.contains('chanlog_locks'):\n bot.memory['chanlog_locks'] = willie.tools.WillieMemoryWithDefault(threading.Lock)\n\n\[email protected]('.*')\[email protected]\ndef log_message(bot, message):\n \"Log every message in a channel\"\n # if this is a private message and we're not logging those, return early\n if not bot.origin.sender.startswith(\"#\") and not bot.config.chanlogs.privmsg:\n return\n\n # determine which template we want, message or action\n if message.startswith(\"\\001ACTION \") and message.endswith(\"\\001\"):\n tpl = bot.config.chanlogs.action_template or ACTION_TPL\n # strip off start and end\n message = message[8:-1]\n else:\n tpl = bot.config.chanlogs.message_template or MESSAGE_TPL\n\n logline = _format_template(tpl, bot, message=message)\n fpath = get_fpath(bot)\n with bot.memory['chanlog_locks'][fpath]:\n with open(fpath, \"a\") as f:\n f.write(logline.encode('utf-8'))\n\n\[email protected]('.*')\[email protected](\"JOIN\")\[email protected]\ndef log_join(bot, trigger):\n tpl = bot.config.chanlogs.join_template or JOIN_TPL\n logline = _format_template(tpl, bot, trigger=trigger)\n fpath = get_fpath(bot, channel=trigger)\n with bot.memory['chanlog_locks'][fpath]:\n with open(fpath, \"a\") as f:\n f.write(logline.encode('utf-8'))\n\n\[email protected]('.*')\[email protected](\"PART\")\[email protected]\ndef log_part(bot, trigger):\n tpl = bot.config.chanlogs.part_template or PART_TPL\n logline = _format_template(tpl, bot, trigger=trigger)\n fpath = get_fpath(bot, channel=trigger)\n with bot.memory['chanlog_locks'][fpath]:\n with open(fpath, \"a\") as f:\n f.write(logline.encode('utf-8'))\n\n\[email protected]('.*')\[email protected](\"QUIT\")\[email protected]\[email protected](False)\[email protected]('high')\ndef log_quit(bot, trigger):\n tpl = bot.config.chanlogs.quit_template or QUIT_TPL\n logline = _format_template(tpl, bot, trigger=trigger)\n # make a copy of bot.privileges that we can safely iterate over\n privcopy = list(bot.privileges.items())\n # write logline to *all* channels that the user was present in\n for channel, privileges in privcopy:\n if bot.origin.nick in privileges:\n fpath = get_fpath(bot, channel)\n with bot.memory['chanlog_locks'][fpath]:\n with open(fpath, \"a\") as f:\n f.write(logline.encode('utf-8'))\n\n\[email protected]('.*')\[email protected](\"NICK\")\[email protected]\ndef log_nick_change(bot, trigger):\n tpl = bot.config.chanlogs.nick_template or NICK_TPL\n logline = _format_template(tpl, bot, trigger=trigger)\n old_nick = bot.origin.nick\n new_nick = bot.origin.sender\n # make a copy of bot.privileges that we can safely iterate over\n privcopy = list(bot.privileges.items())\n # write logline to *all* channels that the user is present in\n for channel, privileges in privcopy:\n if old_nick in privileges or new_nick in privileges:\n fpath = get_fpath(bot, channel)\n with bot.memory['chanlog_locks'][fpath]:\n with open(fpath, \"a\") as f:\n f.write(logline.encode('utf-8'))\n", "path": "willie/modules/chanlogs.py"}]} |
gh_patches_debug_262 | rasdani/github-patches | git_diff | pypi__warehouse-1454 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[WIP] Show Author and Maintainer in Project detail view
Refs #1060
@dstufft I need some input regarding the implementation of email validation. How do you want to have this implemented? Should I use a self written primitive regex? Or a package like https://pypi.python.org/pypi/validate_email ? Something else?
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `warehouse/packaging/models.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 import enum
14
15 from collections import OrderedDict
16
17 from citext import CIText
18 from pyramid.security import Allow
19 from pyramid.threadlocal import get_current_request
20 from sqlalchemy import (
21 CheckConstraint, Column, Enum, ForeignKey, ForeignKeyConstraint, Index,
22 Boolean, DateTime, Integer, Table, Text,
23 )
24 from sqlalchemy import func, orm, sql
25 from sqlalchemy.orm.exc import NoResultFound
26 from sqlalchemy.ext.associationproxy import association_proxy
27 from sqlalchemy.ext.declarative import declared_attr
28 from sqlalchemy.ext.hybrid import hybrid_property
29
30 from warehouse import db
31 from warehouse.accounts.models import User
32 from warehouse.classifiers.models import Classifier
33 from warehouse.sitemap.models import SitemapMixin
34 from warehouse.utils.attrs import make_repr
35
36
37 class Role(db.Model):
38
39 __tablename__ = "roles"
40 __table_args__ = (
41 Index("roles_pack_name_idx", "package_name"),
42 Index("roles_user_name_idx", "user_name"),
43 )
44
45 __repr__ = make_repr("role_name", "user_name", "package_name")
46
47 role_name = Column(Text)
48 user_name = Column(
49 CIText,
50 ForeignKey("accounts_user.username", onupdate="CASCADE"),
51 )
52 package_name = Column(
53 Text,
54 ForeignKey("packages.name", onupdate="CASCADE"),
55 )
56
57 user = orm.relationship(User, lazy=False)
58 project = orm.relationship("Project", lazy=False)
59
60
61 class ProjectFactory:
62
63 def __init__(self, request):
64 self.request = request
65
66 def __getitem__(self, project):
67 try:
68 return self.request.db.query(Project).filter(
69 Project.normalized_name == func.normalize_pep426_name(project)
70 ).one()
71 except NoResultFound:
72 raise KeyError from None
73
74
75 class Project(SitemapMixin, db.ModelBase):
76
77 __tablename__ = "packages"
78 __table_args__ = (
79 CheckConstraint(
80 "name ~* '^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$'::text",
81 name="packages_valid_name",
82 ),
83 )
84
85 __repr__ = make_repr("name")
86
87 name = Column(Text, primary_key=True, nullable=False)
88 normalized_name = orm.column_property(func.normalize_pep426_name(name))
89 stable_version = Column(Text)
90 autohide = Column(Boolean, server_default=sql.true())
91 comments = Column(Boolean, server_default=sql.true())
92 bugtrack_url = Column(Text)
93 hosting_mode = Column(Text, nullable=False, server_default="pypi-only")
94 created = Column(
95 DateTime(timezone=False),
96 nullable=False,
97 server_default=sql.func.now(),
98 )
99 has_docs = Column(Boolean)
100 upload_limit = Column(Integer, nullable=True)
101 last_serial = Column(Integer, nullable=False, server_default=sql.text("0"))
102 allow_legacy_files = Column(
103 Boolean,
104 nullable=False,
105 server_default=sql.false(),
106 )
107
108 users = orm.relationship(
109 User,
110 secondary=Role.__table__,
111 backref="projects",
112 )
113
114 releases = orm.relationship(
115 "Release",
116 backref="project",
117 cascade="all, delete-orphan",
118 order_by=lambda: Release._pypi_ordering.desc(),
119 )
120
121 def __getitem__(self, version):
122 session = orm.object_session(self)
123
124 try:
125 return (
126 session.query(Release)
127 .filter((Release.project == self) &
128 (Release.version == version))
129 .one()
130 )
131 except NoResultFound:
132 raise KeyError from None
133
134 def __acl__(self):
135 session = orm.object_session(self)
136 acls = []
137
138 # Get all of the users for this project.
139 query = session.query(Role).filter(Role.project == self)
140 query = query.options(orm.lazyload("project"))
141 query = query.options(orm.joinedload("user").lazyload("emails"))
142 for role in sorted(
143 query.all(),
144 key=lambda x: ["Owner", "Maintainer"].index(x.role_name)):
145 acls.append((Allow, role.user.id, ["upload"]))
146
147 return acls
148
149 @property
150 def documentation_url(self):
151 # TODO: Move this into the database and elimnate the use of the
152 # threadlocal here.
153 request = get_current_request()
154
155 # If the project doesn't have docs, then we'll just return a None here.
156 if not self.has_docs:
157 return
158
159 return request.route_url("legacy.docs", project=self.name)
160
161
162 class DependencyKind(enum.IntEnum):
163
164 requires = 1
165 provides = 2
166 obsoletes = 3
167 requires_dist = 4
168 provides_dist = 5
169 obsoletes_dist = 6
170 requires_external = 7
171
172 # TODO: Move project URLs into their own table, since they are not actually
173 # a "dependency".
174 project_url = 8
175
176
177 class Dependency(db.Model):
178
179 __tablename__ = "release_dependencies"
180 __table_args__ = (
181 Index("rel_dep_name_idx", "name"),
182 Index("rel_dep_name_version_idx", "name", "version"),
183 Index("rel_dep_name_version_kind_idx", "name", "version", "kind"),
184 ForeignKeyConstraint(
185 ["name", "version"],
186 ["releases.name", "releases.version"],
187 onupdate="CASCADE",
188 ),
189 )
190 __repr__ = make_repr("name", "version", "kind", "specifier")
191
192 name = Column(Text)
193 version = Column(Text)
194 kind = Column(Integer)
195 specifier = Column(Text)
196
197
198 def _dependency_relation(kind):
199 return orm.relationship(
200 "Dependency",
201 primaryjoin=lambda: sql.and_(
202 Release.name == Dependency.name,
203 Release.version == Dependency.version,
204 Dependency.kind == kind.value,
205 ),
206 viewonly=True,
207 )
208
209
210 class Release(db.ModelBase):
211
212 __tablename__ = "releases"
213
214 @declared_attr
215 def __table_args__(cls): # noqa
216 return (
217 Index("release_created_idx", cls.created.desc()),
218 Index("release_name_created_idx", cls.name, cls.created.desc()),
219 Index("release_name_idx", cls.name),
220 Index("release_pypi_hidden_idx", cls._pypi_hidden),
221 Index("release_version_idx", cls.version),
222 )
223
224 __repr__ = make_repr("name", "version")
225
226 name = Column(
227 Text,
228 ForeignKey("packages.name", onupdate="CASCADE"),
229 primary_key=True,
230 )
231 version = Column(Text, primary_key=True)
232 author = Column(Text)
233 author_email = Column(Text)
234 maintainer = Column(Text)
235 maintainer_email = Column(Text)
236 home_page = Column(Text)
237 license = Column(Text)
238 summary = Column(Text)
239 description = Column(Text)
240 keywords = Column(Text)
241 platform = Column(Text)
242 download_url = Column(Text)
243 _pypi_ordering = Column(Integer)
244 _pypi_hidden = Column(Boolean)
245 cheesecake_installability_id = Column(
246 Integer,
247 ForeignKey("cheesecake_main_indices.id"),
248 )
249 cheesecake_documentation_id = Column(
250 Integer,
251 ForeignKey("cheesecake_main_indices.id"),
252 )
253 cheesecake_code_kwalitee_id = Column(
254 Integer,
255 ForeignKey("cheesecake_main_indices.id"),
256 )
257 requires_python = Column(Text)
258 description_from_readme = Column(Boolean)
259 created = Column(
260 DateTime(timezone=False),
261 nullable=False,
262 server_default=sql.func.now(),
263 )
264
265 _classifiers = orm.relationship(
266 Classifier,
267 backref="project_releases",
268 secondary=lambda: release_classifiers,
269 order_by=Classifier.classifier,
270 )
271 classifiers = association_proxy("_classifiers", "classifier")
272
273 files = orm.relationship(
274 "File",
275 backref="release",
276 cascade="all, delete-orphan",
277 lazy="dynamic",
278 order_by=lambda: File.filename,
279 )
280
281 dependencies = orm.relationship("Dependency")
282
283 _requires = _dependency_relation(DependencyKind.requires)
284 requires = association_proxy("_requires", "specifier")
285
286 _provides = _dependency_relation(DependencyKind.provides)
287 provides = association_proxy("_provides", "specifier")
288
289 _obsoletes = _dependency_relation(DependencyKind.obsoletes)
290 obsoletes = association_proxy("_obsoletes", "specifier")
291
292 _requires_dist = _dependency_relation(DependencyKind.requires_dist)
293 requires_dist = association_proxy("_requires_dist", "specifier")
294
295 _provides_dist = _dependency_relation(DependencyKind.provides_dist)
296 provides_dist = association_proxy("_provides_dist", "specifier")
297
298 _obsoletes_dist = _dependency_relation(DependencyKind.obsoletes_dist)
299 obsoletes_dist = association_proxy("_obsoletes_dist", "specifier")
300
301 _requires_external = _dependency_relation(DependencyKind.requires_external)
302 requires_external = association_proxy("_requires_external", "specifier")
303
304 _project_urls = _dependency_relation(DependencyKind.project_url)
305 project_urls = association_proxy("_project_urls", "specifier")
306
307 uploader = orm.relationship(
308 "User",
309 secondary=lambda: JournalEntry.__table__,
310 primaryjoin=lambda: (
311 (JournalEntry.name == orm.foreign(Release.name)) &
312 (JournalEntry.version == orm.foreign(Release.version)) &
313 (JournalEntry.action == "new release")),
314 secondaryjoin=lambda: (
315 (User.username == orm.foreign(JournalEntry._submitted_by))
316 ),
317 order_by=lambda: JournalEntry.submitted_date.desc(),
318 # TODO: We have uselist=False here which raises a warning because
319 # multiple items were returned. This should only be temporary because
320 # we should add a nullable FK to JournalEntry so we don't need to rely
321 # on ordering and implicitly selecting the first object to make this
322 # happen,
323 uselist=False,
324 viewonly=True,
325 )
326
327 @property
328 def urls(self):
329 _urls = OrderedDict()
330
331 if self.home_page:
332 _urls["Homepage"] = self.home_page
333
334 for urlspec in self.project_urls:
335 name, url = urlspec.split(",", 1)
336 _urls[name] = url
337
338 if self.download_url and "Download" not in _urls:
339 _urls["Download"] = self.download_url
340
341 return _urls
342
343 @property
344 def has_meta(self):
345 return any([self.keywords])
346
347
348 class File(db.Model):
349
350 __tablename__ = "release_files"
351 __table_args__ = (
352 ForeignKeyConstraint(
353 ["name", "version"],
354 ["releases.name", "releases.version"],
355 onupdate="CASCADE",
356 ),
357
358 CheckConstraint("sha256_digest ~* '^[A-F0-9]{64}$'"),
359 CheckConstraint("blake2_256_digest ~* '^[A-F0-9]{64}$'"),
360
361 Index("release_files_name_idx", "name"),
362 Index("release_files_name_version_idx", "name", "version"),
363 Index("release_files_packagetype_idx", "packagetype"),
364 Index("release_files_version_idx", "version"),
365 )
366
367 name = Column(Text)
368 version = Column(Text)
369 python_version = Column(Text)
370 packagetype = Column(
371 Enum(
372 "bdist_dmg", "bdist_dumb", "bdist_egg", "bdist_msi", "bdist_rpm",
373 "bdist_wheel", "bdist_wininst", "sdist",
374 ),
375 )
376 comment_text = Column(Text)
377 filename = Column(Text, unique=True)
378 path = Column(Text, unique=True, nullable=False)
379 size = Column(Integer)
380 has_signature = Column(Boolean)
381 md5_digest = Column(Text, unique=True, nullable=False)
382 sha256_digest = Column(CIText, unique=True, nullable=False)
383 blake2_256_digest = Column(CIText, unique=True, nullable=False)
384 downloads = Column(Integer, server_default=sql.text("0"))
385 upload_time = Column(DateTime(timezone=False), server_default=func.now())
386
387 @hybrid_property
388 def pgp_path(self):
389 return self.path + ".asc"
390
391 @pgp_path.expression
392 def pgp_path(self):
393 return func.concat(self.path, ".asc")
394
395
396 class Filename(db.ModelBase):
397
398 __tablename__ = "file_registry"
399
400 id = Column(Integer, primary_key=True, nullable=False)
401 filename = Column(Text, unique=True, nullable=False)
402
403
404 release_classifiers = Table(
405 "release_classifiers",
406 db.metadata,
407
408 Column("name", Text()),
409 Column("version", Text()),
410 Column("trove_id", Integer(), ForeignKey("trove_classifiers.id")),
411
412 ForeignKeyConstraint(
413 ["name", "version"],
414 ["releases.name", "releases.version"],
415 onupdate="CASCADE",
416 ),
417
418 Index("rel_class_name_idx", "name"),
419 Index("rel_class_name_version_idx", "name", "version"),
420 Index("rel_class_trove_id_idx", "trove_id"),
421 Index("rel_class_version_id_idx", "version"),
422 )
423
424
425 class JournalEntry(db.ModelBase):
426
427 __tablename__ = "journals"
428
429 @declared_attr
430 def __table_args__(cls): # noqa
431 return (
432 Index(
433 "journals_changelog",
434 "submitted_date", "name", "version", "action",
435 ),
436 Index("journals_id_idx", "id"),
437 Index("journals_name_idx", "name"),
438 Index("journals_version_idx", "version"),
439 Index(
440 "journals_latest_releases",
441 "submitted_date", "name", "version",
442 postgresql_where=(
443 (cls.version != None) & (cls.action == "new release") # noqa
444 ),
445 ),
446 )
447
448 id = Column(Integer, primary_key=True, nullable=False)
449 name = Column(Text)
450 version = Column(Text)
451 action = Column(Text)
452 submitted_date = Column(
453 DateTime(timezone=False),
454 nullable=False,
455 server_default=sql.func.now(),
456 )
457 _submitted_by = Column(
458 "submitted_by",
459 CIText,
460 ForeignKey(
461 "accounts_user.username",
462 onupdate="CASCADE",
463 ),
464 )
465 submitted_by = orm.relationship(User)
466 submitted_from = Column(Text)
467
```
--- 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/warehouse/packaging/models.py b/warehouse/packaging/models.py
--- a/warehouse/packaging/models.py
+++ b/warehouse/packaging/models.py
@@ -342,7 +342,9 @@
@property
def has_meta(self):
- return any([self.keywords])
+ return any([self.keywords,
+ self.author, self.author_email,
+ self.maintainer, self.maintainer_email])
class File(db.Model):
| {"golden_diff": "diff --git a/warehouse/packaging/models.py b/warehouse/packaging/models.py\n--- a/warehouse/packaging/models.py\n+++ b/warehouse/packaging/models.py\n@@ -342,7 +342,9 @@\n \n @property\n def has_meta(self):\n- return any([self.keywords])\n+ return any([self.keywords,\n+ self.author, self.author_email,\n+ self.maintainer, self.maintainer_email])\n \n \n class File(db.Model):\n", "issue": "[WIP] Show Author and Maintainer in Project detail view\nRefs #1060 \n\n@dstufft I need some input regarding the implementation of email validation. How do you want to have this implemented? Should I use a self written primitive regex? Or a package like https://pypi.python.org/pypi/validate_email ? Something else?\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\nimport enum\n\nfrom collections import OrderedDict\n\nfrom citext import CIText\nfrom pyramid.security import Allow\nfrom pyramid.threadlocal import get_current_request\nfrom sqlalchemy import (\n CheckConstraint, Column, Enum, ForeignKey, ForeignKeyConstraint, Index,\n Boolean, DateTime, Integer, Table, Text,\n)\nfrom sqlalchemy import func, orm, sql\nfrom sqlalchemy.orm.exc import NoResultFound\nfrom sqlalchemy.ext.associationproxy import association_proxy\nfrom sqlalchemy.ext.declarative import declared_attr\nfrom sqlalchemy.ext.hybrid import hybrid_property\n\nfrom warehouse import db\nfrom warehouse.accounts.models import User\nfrom warehouse.classifiers.models import Classifier\nfrom warehouse.sitemap.models import SitemapMixin\nfrom warehouse.utils.attrs import make_repr\n\n\nclass Role(db.Model):\n\n __tablename__ = \"roles\"\n __table_args__ = (\n Index(\"roles_pack_name_idx\", \"package_name\"),\n Index(\"roles_user_name_idx\", \"user_name\"),\n )\n\n __repr__ = make_repr(\"role_name\", \"user_name\", \"package_name\")\n\n role_name = Column(Text)\n user_name = Column(\n CIText,\n ForeignKey(\"accounts_user.username\", onupdate=\"CASCADE\"),\n )\n package_name = Column(\n Text,\n ForeignKey(\"packages.name\", onupdate=\"CASCADE\"),\n )\n\n user = orm.relationship(User, lazy=False)\n project = orm.relationship(\"Project\", lazy=False)\n\n\nclass ProjectFactory:\n\n def __init__(self, request):\n self.request = request\n\n def __getitem__(self, project):\n try:\n return self.request.db.query(Project).filter(\n Project.normalized_name == func.normalize_pep426_name(project)\n ).one()\n except NoResultFound:\n raise KeyError from None\n\n\nclass Project(SitemapMixin, db.ModelBase):\n\n __tablename__ = \"packages\"\n __table_args__ = (\n CheckConstraint(\n \"name ~* '^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$'::text\",\n name=\"packages_valid_name\",\n ),\n )\n\n __repr__ = make_repr(\"name\")\n\n name = Column(Text, primary_key=True, nullable=False)\n normalized_name = orm.column_property(func.normalize_pep426_name(name))\n stable_version = Column(Text)\n autohide = Column(Boolean, server_default=sql.true())\n comments = Column(Boolean, server_default=sql.true())\n bugtrack_url = Column(Text)\n hosting_mode = Column(Text, nullable=False, server_default=\"pypi-only\")\n created = Column(\n DateTime(timezone=False),\n nullable=False,\n server_default=sql.func.now(),\n )\n has_docs = Column(Boolean)\n upload_limit = Column(Integer, nullable=True)\n last_serial = Column(Integer, nullable=False, server_default=sql.text(\"0\"))\n allow_legacy_files = Column(\n Boolean,\n nullable=False,\n server_default=sql.false(),\n )\n\n users = orm.relationship(\n User,\n secondary=Role.__table__,\n backref=\"projects\",\n )\n\n releases = orm.relationship(\n \"Release\",\n backref=\"project\",\n cascade=\"all, delete-orphan\",\n order_by=lambda: Release._pypi_ordering.desc(),\n )\n\n def __getitem__(self, version):\n session = orm.object_session(self)\n\n try:\n return (\n session.query(Release)\n .filter((Release.project == self) &\n (Release.version == version))\n .one()\n )\n except NoResultFound:\n raise KeyError from None\n\n def __acl__(self):\n session = orm.object_session(self)\n acls = []\n\n # Get all of the users for this project.\n query = session.query(Role).filter(Role.project == self)\n query = query.options(orm.lazyload(\"project\"))\n query = query.options(orm.joinedload(\"user\").lazyload(\"emails\"))\n for role in sorted(\n query.all(),\n key=lambda x: [\"Owner\", \"Maintainer\"].index(x.role_name)):\n acls.append((Allow, role.user.id, [\"upload\"]))\n\n return acls\n\n @property\n def documentation_url(self):\n # TODO: Move this into the database and elimnate the use of the\n # threadlocal here.\n request = get_current_request()\n\n # If the project doesn't have docs, then we'll just return a None here.\n if not self.has_docs:\n return\n\n return request.route_url(\"legacy.docs\", project=self.name)\n\n\nclass DependencyKind(enum.IntEnum):\n\n requires = 1\n provides = 2\n obsoletes = 3\n requires_dist = 4\n provides_dist = 5\n obsoletes_dist = 6\n requires_external = 7\n\n # TODO: Move project URLs into their own table, since they are not actually\n # a \"dependency\".\n project_url = 8\n\n\nclass Dependency(db.Model):\n\n __tablename__ = \"release_dependencies\"\n __table_args__ = (\n Index(\"rel_dep_name_idx\", \"name\"),\n Index(\"rel_dep_name_version_idx\", \"name\", \"version\"),\n Index(\"rel_dep_name_version_kind_idx\", \"name\", \"version\", \"kind\"),\n ForeignKeyConstraint(\n [\"name\", \"version\"],\n [\"releases.name\", \"releases.version\"],\n onupdate=\"CASCADE\",\n ),\n )\n __repr__ = make_repr(\"name\", \"version\", \"kind\", \"specifier\")\n\n name = Column(Text)\n version = Column(Text)\n kind = Column(Integer)\n specifier = Column(Text)\n\n\ndef _dependency_relation(kind):\n return orm.relationship(\n \"Dependency\",\n primaryjoin=lambda: sql.and_(\n Release.name == Dependency.name,\n Release.version == Dependency.version,\n Dependency.kind == kind.value,\n ),\n viewonly=True,\n )\n\n\nclass Release(db.ModelBase):\n\n __tablename__ = \"releases\"\n\n @declared_attr\n def __table_args__(cls): # noqa\n return (\n Index(\"release_created_idx\", cls.created.desc()),\n Index(\"release_name_created_idx\", cls.name, cls.created.desc()),\n Index(\"release_name_idx\", cls.name),\n Index(\"release_pypi_hidden_idx\", cls._pypi_hidden),\n Index(\"release_version_idx\", cls.version),\n )\n\n __repr__ = make_repr(\"name\", \"version\")\n\n name = Column(\n Text,\n ForeignKey(\"packages.name\", onupdate=\"CASCADE\"),\n primary_key=True,\n )\n version = Column(Text, primary_key=True)\n author = Column(Text)\n author_email = Column(Text)\n maintainer = Column(Text)\n maintainer_email = Column(Text)\n home_page = Column(Text)\n license = Column(Text)\n summary = Column(Text)\n description = Column(Text)\n keywords = Column(Text)\n platform = Column(Text)\n download_url = Column(Text)\n _pypi_ordering = Column(Integer)\n _pypi_hidden = Column(Boolean)\n cheesecake_installability_id = Column(\n Integer,\n ForeignKey(\"cheesecake_main_indices.id\"),\n )\n cheesecake_documentation_id = Column(\n Integer,\n ForeignKey(\"cheesecake_main_indices.id\"),\n )\n cheesecake_code_kwalitee_id = Column(\n Integer,\n ForeignKey(\"cheesecake_main_indices.id\"),\n )\n requires_python = Column(Text)\n description_from_readme = Column(Boolean)\n created = Column(\n DateTime(timezone=False),\n nullable=False,\n server_default=sql.func.now(),\n )\n\n _classifiers = orm.relationship(\n Classifier,\n backref=\"project_releases\",\n secondary=lambda: release_classifiers,\n order_by=Classifier.classifier,\n )\n classifiers = association_proxy(\"_classifiers\", \"classifier\")\n\n files = orm.relationship(\n \"File\",\n backref=\"release\",\n cascade=\"all, delete-orphan\",\n lazy=\"dynamic\",\n order_by=lambda: File.filename,\n )\n\n dependencies = orm.relationship(\"Dependency\")\n\n _requires = _dependency_relation(DependencyKind.requires)\n requires = association_proxy(\"_requires\", \"specifier\")\n\n _provides = _dependency_relation(DependencyKind.provides)\n provides = association_proxy(\"_provides\", \"specifier\")\n\n _obsoletes = _dependency_relation(DependencyKind.obsoletes)\n obsoletes = association_proxy(\"_obsoletes\", \"specifier\")\n\n _requires_dist = _dependency_relation(DependencyKind.requires_dist)\n requires_dist = association_proxy(\"_requires_dist\", \"specifier\")\n\n _provides_dist = _dependency_relation(DependencyKind.provides_dist)\n provides_dist = association_proxy(\"_provides_dist\", \"specifier\")\n\n _obsoletes_dist = _dependency_relation(DependencyKind.obsoletes_dist)\n obsoletes_dist = association_proxy(\"_obsoletes_dist\", \"specifier\")\n\n _requires_external = _dependency_relation(DependencyKind.requires_external)\n requires_external = association_proxy(\"_requires_external\", \"specifier\")\n\n _project_urls = _dependency_relation(DependencyKind.project_url)\n project_urls = association_proxy(\"_project_urls\", \"specifier\")\n\n uploader = orm.relationship(\n \"User\",\n secondary=lambda: JournalEntry.__table__,\n primaryjoin=lambda: (\n (JournalEntry.name == orm.foreign(Release.name)) &\n (JournalEntry.version == orm.foreign(Release.version)) &\n (JournalEntry.action == \"new release\")),\n secondaryjoin=lambda: (\n (User.username == orm.foreign(JournalEntry._submitted_by))\n ),\n order_by=lambda: JournalEntry.submitted_date.desc(),\n # TODO: We have uselist=False here which raises a warning because\n # multiple items were returned. This should only be temporary because\n # we should add a nullable FK to JournalEntry so we don't need to rely\n # on ordering and implicitly selecting the first object to make this\n # happen,\n uselist=False,\n viewonly=True,\n )\n\n @property\n def urls(self):\n _urls = OrderedDict()\n\n if self.home_page:\n _urls[\"Homepage\"] = self.home_page\n\n for urlspec in self.project_urls:\n name, url = urlspec.split(\",\", 1)\n _urls[name] = url\n\n if self.download_url and \"Download\" not in _urls:\n _urls[\"Download\"] = self.download_url\n\n return _urls\n\n @property\n def has_meta(self):\n return any([self.keywords])\n\n\nclass File(db.Model):\n\n __tablename__ = \"release_files\"\n __table_args__ = (\n ForeignKeyConstraint(\n [\"name\", \"version\"],\n [\"releases.name\", \"releases.version\"],\n onupdate=\"CASCADE\",\n ),\n\n CheckConstraint(\"sha256_digest ~* '^[A-F0-9]{64}$'\"),\n CheckConstraint(\"blake2_256_digest ~* '^[A-F0-9]{64}$'\"),\n\n Index(\"release_files_name_idx\", \"name\"),\n Index(\"release_files_name_version_idx\", \"name\", \"version\"),\n Index(\"release_files_packagetype_idx\", \"packagetype\"),\n Index(\"release_files_version_idx\", \"version\"),\n )\n\n name = Column(Text)\n version = Column(Text)\n python_version = Column(Text)\n packagetype = Column(\n Enum(\n \"bdist_dmg\", \"bdist_dumb\", \"bdist_egg\", \"bdist_msi\", \"bdist_rpm\",\n \"bdist_wheel\", \"bdist_wininst\", \"sdist\",\n ),\n )\n comment_text = Column(Text)\n filename = Column(Text, unique=True)\n path = Column(Text, unique=True, nullable=False)\n size = Column(Integer)\n has_signature = Column(Boolean)\n md5_digest = Column(Text, unique=True, nullable=False)\n sha256_digest = Column(CIText, unique=True, nullable=False)\n blake2_256_digest = Column(CIText, unique=True, nullable=False)\n downloads = Column(Integer, server_default=sql.text(\"0\"))\n upload_time = Column(DateTime(timezone=False), server_default=func.now())\n\n @hybrid_property\n def pgp_path(self):\n return self.path + \".asc\"\n\n @pgp_path.expression\n def pgp_path(self):\n return func.concat(self.path, \".asc\")\n\n\nclass Filename(db.ModelBase):\n\n __tablename__ = \"file_registry\"\n\n id = Column(Integer, primary_key=True, nullable=False)\n filename = Column(Text, unique=True, nullable=False)\n\n\nrelease_classifiers = Table(\n \"release_classifiers\",\n db.metadata,\n\n Column(\"name\", Text()),\n Column(\"version\", Text()),\n Column(\"trove_id\", Integer(), ForeignKey(\"trove_classifiers.id\")),\n\n ForeignKeyConstraint(\n [\"name\", \"version\"],\n [\"releases.name\", \"releases.version\"],\n onupdate=\"CASCADE\",\n ),\n\n Index(\"rel_class_name_idx\", \"name\"),\n Index(\"rel_class_name_version_idx\", \"name\", \"version\"),\n Index(\"rel_class_trove_id_idx\", \"trove_id\"),\n Index(\"rel_class_version_id_idx\", \"version\"),\n)\n\n\nclass JournalEntry(db.ModelBase):\n\n __tablename__ = \"journals\"\n\n @declared_attr\n def __table_args__(cls): # noqa\n return (\n Index(\n \"journals_changelog\",\n \"submitted_date\", \"name\", \"version\", \"action\",\n ),\n Index(\"journals_id_idx\", \"id\"),\n Index(\"journals_name_idx\", \"name\"),\n Index(\"journals_version_idx\", \"version\"),\n Index(\n \"journals_latest_releases\",\n \"submitted_date\", \"name\", \"version\",\n postgresql_where=(\n (cls.version != None) & (cls.action == \"new release\") # noqa\n ),\n ),\n )\n\n id = Column(Integer, primary_key=True, nullable=False)\n name = Column(Text)\n version = Column(Text)\n action = Column(Text)\n submitted_date = Column(\n DateTime(timezone=False),\n nullable=False,\n server_default=sql.func.now(),\n )\n _submitted_by = Column(\n \"submitted_by\",\n CIText,\n ForeignKey(\n \"accounts_user.username\",\n onupdate=\"CASCADE\",\n ),\n )\n submitted_by = orm.relationship(User)\n submitted_from = Column(Text)\n", "path": "warehouse/packaging/models.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\nimport enum\n\nfrom collections import OrderedDict\n\nfrom citext import CIText\nfrom pyramid.security import Allow\nfrom pyramid.threadlocal import get_current_request\nfrom sqlalchemy import (\n CheckConstraint, Column, Enum, ForeignKey, ForeignKeyConstraint, Index,\n Boolean, DateTime, Integer, Table, Text,\n)\nfrom sqlalchemy import func, orm, sql\nfrom sqlalchemy.orm.exc import NoResultFound\nfrom sqlalchemy.ext.associationproxy import association_proxy\nfrom sqlalchemy.ext.declarative import declared_attr\nfrom sqlalchemy.ext.hybrid import hybrid_property\n\nfrom warehouse import db\nfrom warehouse.accounts.models import User\nfrom warehouse.classifiers.models import Classifier\nfrom warehouse.sitemap.models import SitemapMixin\nfrom warehouse.utils.attrs import make_repr\n\n\nclass Role(db.Model):\n\n __tablename__ = \"roles\"\n __table_args__ = (\n Index(\"roles_pack_name_idx\", \"package_name\"),\n Index(\"roles_user_name_idx\", \"user_name\"),\n )\n\n __repr__ = make_repr(\"role_name\", \"user_name\", \"package_name\")\n\n role_name = Column(Text)\n user_name = Column(\n CIText,\n ForeignKey(\"accounts_user.username\", onupdate=\"CASCADE\"),\n )\n package_name = Column(\n Text,\n ForeignKey(\"packages.name\", onupdate=\"CASCADE\"),\n )\n\n user = orm.relationship(User, lazy=False)\n project = orm.relationship(\"Project\", lazy=False)\n\n\nclass ProjectFactory:\n\n def __init__(self, request):\n self.request = request\n\n def __getitem__(self, project):\n try:\n return self.request.db.query(Project).filter(\n Project.normalized_name == func.normalize_pep426_name(project)\n ).one()\n except NoResultFound:\n raise KeyError from None\n\n\nclass Project(SitemapMixin, db.ModelBase):\n\n __tablename__ = \"packages\"\n __table_args__ = (\n CheckConstraint(\n \"name ~* '^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$'::text\",\n name=\"packages_valid_name\",\n ),\n )\n\n __repr__ = make_repr(\"name\")\n\n name = Column(Text, primary_key=True, nullable=False)\n normalized_name = orm.column_property(func.normalize_pep426_name(name))\n stable_version = Column(Text)\n autohide = Column(Boolean, server_default=sql.true())\n comments = Column(Boolean, server_default=sql.true())\n bugtrack_url = Column(Text)\n hosting_mode = Column(Text, nullable=False, server_default=\"pypi-only\")\n created = Column(\n DateTime(timezone=False),\n nullable=False,\n server_default=sql.func.now(),\n )\n has_docs = Column(Boolean)\n upload_limit = Column(Integer, nullable=True)\n last_serial = Column(Integer, nullable=False, server_default=sql.text(\"0\"))\n allow_legacy_files = Column(\n Boolean,\n nullable=False,\n server_default=sql.false(),\n )\n\n users = orm.relationship(\n User,\n secondary=Role.__table__,\n backref=\"projects\",\n )\n\n releases = orm.relationship(\n \"Release\",\n backref=\"project\",\n cascade=\"all, delete-orphan\",\n order_by=lambda: Release._pypi_ordering.desc(),\n )\n\n def __getitem__(self, version):\n session = orm.object_session(self)\n\n try:\n return (\n session.query(Release)\n .filter((Release.project == self) &\n (Release.version == version))\n .one()\n )\n except NoResultFound:\n raise KeyError from None\n\n def __acl__(self):\n session = orm.object_session(self)\n acls = []\n\n # Get all of the users for this project.\n query = session.query(Role).filter(Role.project == self)\n query = query.options(orm.lazyload(\"project\"))\n query = query.options(orm.joinedload(\"user\").lazyload(\"emails\"))\n for role in sorted(\n query.all(),\n key=lambda x: [\"Owner\", \"Maintainer\"].index(x.role_name)):\n acls.append((Allow, role.user.id, [\"upload\"]))\n\n return acls\n\n @property\n def documentation_url(self):\n # TODO: Move this into the database and elimnate the use of the\n # threadlocal here.\n request = get_current_request()\n\n # If the project doesn't have docs, then we'll just return a None here.\n if not self.has_docs:\n return\n\n return request.route_url(\"legacy.docs\", project=self.name)\n\n\nclass DependencyKind(enum.IntEnum):\n\n requires = 1\n provides = 2\n obsoletes = 3\n requires_dist = 4\n provides_dist = 5\n obsoletes_dist = 6\n requires_external = 7\n\n # TODO: Move project URLs into their own table, since they are not actually\n # a \"dependency\".\n project_url = 8\n\n\nclass Dependency(db.Model):\n\n __tablename__ = \"release_dependencies\"\n __table_args__ = (\n Index(\"rel_dep_name_idx\", \"name\"),\n Index(\"rel_dep_name_version_idx\", \"name\", \"version\"),\n Index(\"rel_dep_name_version_kind_idx\", \"name\", \"version\", \"kind\"),\n ForeignKeyConstraint(\n [\"name\", \"version\"],\n [\"releases.name\", \"releases.version\"],\n onupdate=\"CASCADE\",\n ),\n )\n __repr__ = make_repr(\"name\", \"version\", \"kind\", \"specifier\")\n\n name = Column(Text)\n version = Column(Text)\n kind = Column(Integer)\n specifier = Column(Text)\n\n\ndef _dependency_relation(kind):\n return orm.relationship(\n \"Dependency\",\n primaryjoin=lambda: sql.and_(\n Release.name == Dependency.name,\n Release.version == Dependency.version,\n Dependency.kind == kind.value,\n ),\n viewonly=True,\n )\n\n\nclass Release(db.ModelBase):\n\n __tablename__ = \"releases\"\n\n @declared_attr\n def __table_args__(cls): # noqa\n return (\n Index(\"release_created_idx\", cls.created.desc()),\n Index(\"release_name_created_idx\", cls.name, cls.created.desc()),\n Index(\"release_name_idx\", cls.name),\n Index(\"release_pypi_hidden_idx\", cls._pypi_hidden),\n Index(\"release_version_idx\", cls.version),\n )\n\n __repr__ = make_repr(\"name\", \"version\")\n\n name = Column(\n Text,\n ForeignKey(\"packages.name\", onupdate=\"CASCADE\"),\n primary_key=True,\n )\n version = Column(Text, primary_key=True)\n author = Column(Text)\n author_email = Column(Text)\n maintainer = Column(Text)\n maintainer_email = Column(Text)\n home_page = Column(Text)\n license = Column(Text)\n summary = Column(Text)\n description = Column(Text)\n keywords = Column(Text)\n platform = Column(Text)\n download_url = Column(Text)\n _pypi_ordering = Column(Integer)\n _pypi_hidden = Column(Boolean)\n cheesecake_installability_id = Column(\n Integer,\n ForeignKey(\"cheesecake_main_indices.id\"),\n )\n cheesecake_documentation_id = Column(\n Integer,\n ForeignKey(\"cheesecake_main_indices.id\"),\n )\n cheesecake_code_kwalitee_id = Column(\n Integer,\n ForeignKey(\"cheesecake_main_indices.id\"),\n )\n requires_python = Column(Text)\n description_from_readme = Column(Boolean)\n created = Column(\n DateTime(timezone=False),\n nullable=False,\n server_default=sql.func.now(),\n )\n\n _classifiers = orm.relationship(\n Classifier,\n backref=\"project_releases\",\n secondary=lambda: release_classifiers,\n order_by=Classifier.classifier,\n )\n classifiers = association_proxy(\"_classifiers\", \"classifier\")\n\n files = orm.relationship(\n \"File\",\n backref=\"release\",\n cascade=\"all, delete-orphan\",\n lazy=\"dynamic\",\n order_by=lambda: File.filename,\n )\n\n dependencies = orm.relationship(\"Dependency\")\n\n _requires = _dependency_relation(DependencyKind.requires)\n requires = association_proxy(\"_requires\", \"specifier\")\n\n _provides = _dependency_relation(DependencyKind.provides)\n provides = association_proxy(\"_provides\", \"specifier\")\n\n _obsoletes = _dependency_relation(DependencyKind.obsoletes)\n obsoletes = association_proxy(\"_obsoletes\", \"specifier\")\n\n _requires_dist = _dependency_relation(DependencyKind.requires_dist)\n requires_dist = association_proxy(\"_requires_dist\", \"specifier\")\n\n _provides_dist = _dependency_relation(DependencyKind.provides_dist)\n provides_dist = association_proxy(\"_provides_dist\", \"specifier\")\n\n _obsoletes_dist = _dependency_relation(DependencyKind.obsoletes_dist)\n obsoletes_dist = association_proxy(\"_obsoletes_dist\", \"specifier\")\n\n _requires_external = _dependency_relation(DependencyKind.requires_external)\n requires_external = association_proxy(\"_requires_external\", \"specifier\")\n\n _project_urls = _dependency_relation(DependencyKind.project_url)\n project_urls = association_proxy(\"_project_urls\", \"specifier\")\n\n uploader = orm.relationship(\n \"User\",\n secondary=lambda: JournalEntry.__table__,\n primaryjoin=lambda: (\n (JournalEntry.name == orm.foreign(Release.name)) &\n (JournalEntry.version == orm.foreign(Release.version)) &\n (JournalEntry.action == \"new release\")),\n secondaryjoin=lambda: (\n (User.username == orm.foreign(JournalEntry._submitted_by))\n ),\n order_by=lambda: JournalEntry.submitted_date.desc(),\n # TODO: We have uselist=False here which raises a warning because\n # multiple items were returned. This should only be temporary because\n # we should add a nullable FK to JournalEntry so we don't need to rely\n # on ordering and implicitly selecting the first object to make this\n # happen,\n uselist=False,\n viewonly=True,\n )\n\n @property\n def urls(self):\n _urls = OrderedDict()\n\n if self.home_page:\n _urls[\"Homepage\"] = self.home_page\n\n for urlspec in self.project_urls:\n name, url = urlspec.split(\",\", 1)\n _urls[name] = url\n\n if self.download_url and \"Download\" not in _urls:\n _urls[\"Download\"] = self.download_url\n\n return _urls\n\n @property\n def has_meta(self):\n return any([self.keywords,\n self.author, self.author_email,\n self.maintainer, self.maintainer_email])\n\n\nclass File(db.Model):\n\n __tablename__ = \"release_files\"\n __table_args__ = (\n ForeignKeyConstraint(\n [\"name\", \"version\"],\n [\"releases.name\", \"releases.version\"],\n onupdate=\"CASCADE\",\n ),\n\n CheckConstraint(\"sha256_digest ~* '^[A-F0-9]{64}$'\"),\n CheckConstraint(\"blake2_256_digest ~* '^[A-F0-9]{64}$'\"),\n\n Index(\"release_files_name_idx\", \"name\"),\n Index(\"release_files_name_version_idx\", \"name\", \"version\"),\n Index(\"release_files_packagetype_idx\", \"packagetype\"),\n Index(\"release_files_version_idx\", \"version\"),\n )\n\n name = Column(Text)\n version = Column(Text)\n python_version = Column(Text)\n packagetype = Column(\n Enum(\n \"bdist_dmg\", \"bdist_dumb\", \"bdist_egg\", \"bdist_msi\", \"bdist_rpm\",\n \"bdist_wheel\", \"bdist_wininst\", \"sdist\",\n ),\n )\n comment_text = Column(Text)\n filename = Column(Text, unique=True)\n path = Column(Text, unique=True, nullable=False)\n size = Column(Integer)\n has_signature = Column(Boolean)\n md5_digest = Column(Text, unique=True, nullable=False)\n sha256_digest = Column(CIText, unique=True, nullable=False)\n blake2_256_digest = Column(CIText, unique=True, nullable=False)\n downloads = Column(Integer, server_default=sql.text(\"0\"))\n upload_time = Column(DateTime(timezone=False), server_default=func.now())\n\n @hybrid_property\n def pgp_path(self):\n return self.path + \".asc\"\n\n @pgp_path.expression\n def pgp_path(self):\n return func.concat(self.path, \".asc\")\n\n\nclass Filename(db.ModelBase):\n\n __tablename__ = \"file_registry\"\n\n id = Column(Integer, primary_key=True, nullable=False)\n filename = Column(Text, unique=True, nullable=False)\n\n\nrelease_classifiers = Table(\n \"release_classifiers\",\n db.metadata,\n\n Column(\"name\", Text()),\n Column(\"version\", Text()),\n Column(\"trove_id\", Integer(), ForeignKey(\"trove_classifiers.id\")),\n\n ForeignKeyConstraint(\n [\"name\", \"version\"],\n [\"releases.name\", \"releases.version\"],\n onupdate=\"CASCADE\",\n ),\n\n Index(\"rel_class_name_idx\", \"name\"),\n Index(\"rel_class_name_version_idx\", \"name\", \"version\"),\n Index(\"rel_class_trove_id_idx\", \"trove_id\"),\n Index(\"rel_class_version_id_idx\", \"version\"),\n)\n\n\nclass JournalEntry(db.ModelBase):\n\n __tablename__ = \"journals\"\n\n @declared_attr\n def __table_args__(cls): # noqa\n return (\n Index(\n \"journals_changelog\",\n \"submitted_date\", \"name\", \"version\", \"action\",\n ),\n Index(\"journals_id_idx\", \"id\"),\n Index(\"journals_name_idx\", \"name\"),\n Index(\"journals_version_idx\", \"version\"),\n Index(\n \"journals_latest_releases\",\n \"submitted_date\", \"name\", \"version\",\n postgresql_where=(\n (cls.version != None) & (cls.action == \"new release\") # noqa\n ),\n ),\n )\n\n id = Column(Integer, primary_key=True, nullable=False)\n name = Column(Text)\n version = Column(Text)\n action = Column(Text)\n submitted_date = Column(\n DateTime(timezone=False),\n nullable=False,\n server_default=sql.func.now(),\n )\n _submitted_by = Column(\n \"submitted_by\",\n CIText,\n ForeignKey(\n \"accounts_user.username\",\n onupdate=\"CASCADE\",\n ),\n )\n submitted_by = orm.relationship(User)\n submitted_from = Column(Text)\n", "path": "warehouse/packaging/models.py"}]} |
gh_patches_debug_263 | rasdani/github-patches | git_diff | ivy-llc__ivy-17901 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
fmin
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `ivy/functional/frontends/paddle/tensor/math.py`
Content:
```
1 # global
2 import ivy
3 from ivy.func_wrapper import with_unsupported_dtypes, with_supported_dtypes
4 from ivy.functional.frontends.paddle.func_wrapper import to_ivy_arrays_and_back
5
6
7 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
8 @to_ivy_arrays_and_back
9 def sin(x, name=None):
10 return ivy.sin(x)
11
12
13 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
14 @to_ivy_arrays_and_back
15 def cos(x, name=None):
16 return ivy.cos(x)
17
18
19 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
20 @to_ivy_arrays_and_back
21 def acos(x, name=None):
22 return ivy.acos(x)
23
24
25 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
26 @to_ivy_arrays_and_back
27 def cosh(x, name=None):
28 return ivy.cosh(x)
29
30
31 @with_supported_dtypes({"2.5.0 and below": ("float32", "float64")}, "paddle")
32 @to_ivy_arrays_and_back
33 def tanh(x, name=None):
34 return ivy.tanh(x)
35
36
37 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
38 @to_ivy_arrays_and_back
39 def acosh(x, name=None):
40 return ivy.acosh(x)
41
42
43 @with_supported_dtypes({"2.5.0 and below": ("float32", "float64")}, "paddle")
44 @to_ivy_arrays_and_back
45 def asin(x, name=None):
46 return ivy.asin(x)
47
48
49 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
50 @to_ivy_arrays_and_back
51 def log(x, name=None):
52 return ivy.log(x)
53
54
55 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
56 @to_ivy_arrays_and_back
57 def divide(x, y, name=None):
58 return ivy.divide(x, y)
59
60
61 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
62 @to_ivy_arrays_and_back
63 def abs(x, name=None):
64 return ivy.abs(x)
65
66
67 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
68 @to_ivy_arrays_and_back
69 def multiply(x, y, name=None):
70 return ivy.multiply(x, y)
71
72
73 @with_unsupported_dtypes(
74 {"2.5.0 and below": ("bool", "unsigned", "int8", "float16", "bfloat16")}, "paddle"
75 )
76 @to_ivy_arrays_and_back
77 def add(x, y, name=None):
78 return ivy.add(x, y)
79
80
81 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
82 @to_ivy_arrays_and_back
83 def subtract(x, y, name=None):
84 return ivy.subtract(x, y)
85
86
87 @with_supported_dtypes({"2.5.0 and below": ("float32", "float64")}, "paddle")
88 @to_ivy_arrays_and_back
89 def sqrt(x, name=None):
90 return ivy.sqrt(x)
91
92
93 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
94 @to_ivy_arrays_and_back
95 def atanh(x, name=None):
96 return ivy.atanh(x)
97
98
99 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
100 @to_ivy_arrays_and_back
101 def atan(x, name=None):
102 return ivy.atan(x)
103
104
105 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
106 @to_ivy_arrays_and_back
107 def round(x, name=None):
108 return ivy.round(x)
109
110
111 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
112 @to_ivy_arrays_and_back
113 def ceil(x, name=None):
114 return ivy.ceil(x)
115
116
117 @with_supported_dtypes({"2.5.0 and below": ("float32", "float64")}, "paddle")
118 @to_ivy_arrays_and_back
119 def sinh(x, name=None):
120 return ivy.sinh(x)
121
122
123 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
124 @to_ivy_arrays_and_back
125 def pow(x, y, name=None):
126 return ivy.pow(x, y)
127
128
129 @with_unsupported_dtypes({"2.4.2 and below": ("int16", "float16")}, "paddle")
130 @to_ivy_arrays_and_back
131 def conj(x, name=None):
132 return ivy.conj(x)
133
134
135 @with_unsupported_dtypes({"2.4.2 and below": ("float16", "bfloat16")}, "paddle")
136 @to_ivy_arrays_and_back
137 def floor(x, name=None):
138 return ivy.floor(x)
139
140
141 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
142 @to_ivy_arrays_and_back
143 def remainder(x, y, name=None):
144 return ivy.remainder(x, y)
145
146
147 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
148 @to_ivy_arrays_and_back
149 def log2(x, name=None):
150 return ivy.log2(x)
151
152
153 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
154 @to_ivy_arrays_and_back
155 def log1p(x, name=None):
156 return ivy.log1p(x)
157
158
159 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
160 @to_ivy_arrays_and_back
161 def rad2deg(x, name=None):
162 return ivy.rad2deg(x)
163
164
165 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
166 @to_ivy_arrays_and_back
167 def deg2rad(x, name=None):
168 return ivy.deg2rad(x)
169
170
171 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
172 @to_ivy_arrays_and_back
173 def gcd(x, y, name=None):
174 return ivy.gcd(x, y)
175
176
177 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
178 @to_ivy_arrays_and_back
179 def tan(x, name=None):
180 return ivy.tan(x)
181
182
183 @with_unsupported_dtypes({"2.4.2 and below": ("float16", "bfloat16")}, "paddle")
184 @to_ivy_arrays_and_back
185 def atan2(x, y, name=None):
186 return ivy.atan2(x, y)
187
188
189 @with_supported_dtypes({"2.5.0 and below": ("float32", "float64")}, "paddle")
190 @to_ivy_arrays_and_back
191 def square(x, name=None):
192 return ivy.square(x)
193
194
195 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
196 @to_ivy_arrays_and_back
197 def sign(x, name=None):
198 return ivy.sign(x)
199
200
201 @with_unsupported_dtypes({"2.4.2 and below": ("float16", "bfloat16")}, "paddle")
202 @to_ivy_arrays_and_back
203 def neg(x, name=None):
204 return ivy.negative(x)
205
206
207 @with_supported_dtypes({"2.5.0 and below": ("float32", "float64")}, "paddle")
208 @to_ivy_arrays_and_back
209 def exp(x, name=None):
210 return ivy.exp(x)
211
212
213 @with_supported_dtypes(
214 {
215 "2.4.2 and below": (
216 "float32",
217 "float64",
218 "int32",
219 "int64",
220 "complex64",
221 "complex128",
222 )
223 },
224 "paddle",
225 )
226 @to_ivy_arrays_and_back
227 def cumprod(x, dim=None, dtype=None, name=None):
228 return ivy.cumprod(x, axis=dim, dtype=dtype)
229
230
231 @with_unsupported_dtypes({"2.5.0 and below": ("float16", "bfloat16")}, "paddle")
232 @to_ivy_arrays_and_back
233 def reciprocal(x, name=None):
234 return ivy.reciprocal(x)
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/ivy/functional/frontends/paddle/tensor/math.py b/ivy/functional/frontends/paddle/tensor/math.py
--- a/ivy/functional/frontends/paddle/tensor/math.py
+++ b/ivy/functional/frontends/paddle/tensor/math.py
@@ -232,3 +232,9 @@
@to_ivy_arrays_and_back
def reciprocal(x, name=None):
return ivy.reciprocal(x)
+
+
+@with_unsupported_dtypes({"2.5.0 and below": "bfloat16"}, "paddle")
+@to_ivy_arrays_and_back
+def fmin(x, y, name=None):
+ return ivy.fmin(x, y)
| {"golden_diff": "diff --git a/ivy/functional/frontends/paddle/tensor/math.py b/ivy/functional/frontends/paddle/tensor/math.py\n--- a/ivy/functional/frontends/paddle/tensor/math.py\n+++ b/ivy/functional/frontends/paddle/tensor/math.py\n@@ -232,3 +232,9 @@\n @to_ivy_arrays_and_back\n def reciprocal(x, name=None):\n return ivy.reciprocal(x)\n+\n+\n+@with_unsupported_dtypes({\"2.5.0 and below\": \"bfloat16\"}, \"paddle\")\n+@to_ivy_arrays_and_back\n+def fmin(x, y, name=None):\n+ return ivy.fmin(x, y)\n", "issue": "fmin\n\n", "before_files": [{"content": "# global\nimport ivy\nfrom ivy.func_wrapper import with_unsupported_dtypes, with_supported_dtypes\nfrom ivy.functional.frontends.paddle.func_wrapper import to_ivy_arrays_and_back\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef sin(x, name=None):\n return ivy.sin(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef cos(x, name=None):\n return ivy.cos(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef acos(x, name=None):\n return ivy.acos(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef cosh(x, name=None):\n return ivy.cosh(x)\n\n\n@with_supported_dtypes({\"2.5.0 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef tanh(x, name=None):\n return ivy.tanh(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef acosh(x, name=None):\n return ivy.acosh(x)\n\n\n@with_supported_dtypes({\"2.5.0 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef asin(x, name=None):\n return ivy.asin(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef log(x, name=None):\n return ivy.log(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef divide(x, y, name=None):\n return ivy.divide(x, y)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef abs(x, name=None):\n return ivy.abs(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef multiply(x, y, name=None):\n return ivy.multiply(x, y)\n\n\n@with_unsupported_dtypes(\n {\"2.5.0 and below\": (\"bool\", \"unsigned\", \"int8\", \"float16\", \"bfloat16\")}, \"paddle\"\n)\n@to_ivy_arrays_and_back\ndef add(x, y, name=None):\n return ivy.add(x, y)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef subtract(x, y, name=None):\n return ivy.subtract(x, y)\n\n\n@with_supported_dtypes({\"2.5.0 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef sqrt(x, name=None):\n return ivy.sqrt(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef atanh(x, name=None):\n return ivy.atanh(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef atan(x, name=None):\n return ivy.atan(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef round(x, name=None):\n return ivy.round(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef ceil(x, name=None):\n return ivy.ceil(x)\n\n\n@with_supported_dtypes({\"2.5.0 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef sinh(x, name=None):\n return ivy.sinh(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef pow(x, y, name=None):\n return ivy.pow(x, y)\n\n\n@with_unsupported_dtypes({\"2.4.2 and below\": (\"int16\", \"float16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef conj(x, name=None):\n return ivy.conj(x)\n\n\n@with_unsupported_dtypes({\"2.4.2 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef floor(x, name=None):\n return ivy.floor(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef remainder(x, y, name=None):\n return ivy.remainder(x, y)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef log2(x, name=None):\n return ivy.log2(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef log1p(x, name=None):\n return ivy.log1p(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef rad2deg(x, name=None):\n return ivy.rad2deg(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef deg2rad(x, name=None):\n return ivy.deg2rad(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef gcd(x, y, name=None):\n return ivy.gcd(x, y)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef tan(x, name=None):\n return ivy.tan(x)\n\n\n@with_unsupported_dtypes({\"2.4.2 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef atan2(x, y, name=None):\n return ivy.atan2(x, y)\n\n\n@with_supported_dtypes({\"2.5.0 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef square(x, name=None):\n return ivy.square(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef sign(x, name=None):\n return ivy.sign(x)\n\n\n@with_unsupported_dtypes({\"2.4.2 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef neg(x, name=None):\n return ivy.negative(x)\n\n\n@with_supported_dtypes({\"2.5.0 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef exp(x, name=None):\n return ivy.exp(x)\n\n\n@with_supported_dtypes(\n {\n \"2.4.2 and below\": (\n \"float32\",\n \"float64\",\n \"int32\",\n \"int64\",\n \"complex64\",\n \"complex128\",\n )\n },\n \"paddle\",\n)\n@to_ivy_arrays_and_back\ndef cumprod(x, dim=None, dtype=None, name=None):\n return ivy.cumprod(x, axis=dim, dtype=dtype)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef reciprocal(x, name=None):\n return ivy.reciprocal(x)\n", "path": "ivy/functional/frontends/paddle/tensor/math.py"}], "after_files": [{"content": "# global\nimport ivy\nfrom ivy.func_wrapper import with_unsupported_dtypes, with_supported_dtypes\nfrom ivy.functional.frontends.paddle.func_wrapper import to_ivy_arrays_and_back\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef sin(x, name=None):\n return ivy.sin(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef cos(x, name=None):\n return ivy.cos(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef acos(x, name=None):\n return ivy.acos(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef cosh(x, name=None):\n return ivy.cosh(x)\n\n\n@with_supported_dtypes({\"2.5.0 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef tanh(x, name=None):\n return ivy.tanh(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef acosh(x, name=None):\n return ivy.acosh(x)\n\n\n@with_supported_dtypes({\"2.5.0 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef asin(x, name=None):\n return ivy.asin(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef log(x, name=None):\n return ivy.log(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef divide(x, y, name=None):\n return ivy.divide(x, y)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef abs(x, name=None):\n return ivy.abs(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef multiply(x, y, name=None):\n return ivy.multiply(x, y)\n\n\n@with_unsupported_dtypes(\n {\"2.5.0 and below\": (\"bool\", \"unsigned\", \"int8\", \"float16\", \"bfloat16\")}, \"paddle\"\n)\n@to_ivy_arrays_and_back\ndef add(x, y, name=None):\n return ivy.add(x, y)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef subtract(x, y, name=None):\n return ivy.subtract(x, y)\n\n\n@with_supported_dtypes({\"2.5.0 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef sqrt(x, name=None):\n return ivy.sqrt(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef atanh(x, name=None):\n return ivy.atanh(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef atan(x, name=None):\n return ivy.atan(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef round(x, name=None):\n return ivy.round(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef ceil(x, name=None):\n return ivy.ceil(x)\n\n\n@with_supported_dtypes({\"2.5.0 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef sinh(x, name=None):\n return ivy.sinh(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef pow(x, y, name=None):\n return ivy.pow(x, y)\n\n\n@with_unsupported_dtypes({\"2.4.2 and below\": (\"int16\", \"float16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef conj(x, name=None):\n return ivy.conj(x)\n\n\n@with_unsupported_dtypes({\"2.4.2 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef floor(x, name=None):\n return ivy.floor(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef remainder(x, y, name=None):\n return ivy.remainder(x, y)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef log2(x, name=None):\n return ivy.log2(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef log1p(x, name=None):\n return ivy.log1p(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef rad2deg(x, name=None):\n return ivy.rad2deg(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef deg2rad(x, name=None):\n return ivy.deg2rad(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef gcd(x, y, name=None):\n return ivy.gcd(x, y)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef tan(x, name=None):\n return ivy.tan(x)\n\n\n@with_unsupported_dtypes({\"2.4.2 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef atan2(x, y, name=None):\n return ivy.atan2(x, y)\n\n\n@with_supported_dtypes({\"2.5.0 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef square(x, name=None):\n return ivy.square(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef sign(x, name=None):\n return ivy.sign(x)\n\n\n@with_unsupported_dtypes({\"2.4.2 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef neg(x, name=None):\n return ivy.negative(x)\n\n\n@with_supported_dtypes({\"2.5.0 and below\": (\"float32\", \"float64\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef exp(x, name=None):\n return ivy.exp(x)\n\n\n@with_supported_dtypes(\n {\n \"2.4.2 and below\": (\n \"float32\",\n \"float64\",\n \"int32\",\n \"int64\",\n \"complex64\",\n \"complex128\",\n )\n },\n \"paddle\",\n)\n@to_ivy_arrays_and_back\ndef cumprod(x, dim=None, dtype=None, name=None):\n return ivy.cumprod(x, axis=dim, dtype=dtype)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": (\"float16\", \"bfloat16\")}, \"paddle\")\n@to_ivy_arrays_and_back\ndef reciprocal(x, name=None):\n return ivy.reciprocal(x)\n\n\n@with_unsupported_dtypes({\"2.5.0 and below\": \"bfloat16\"}, \"paddle\")\n@to_ivy_arrays_and_back\ndef fmin(x, y, name=None):\n return ivy.fmin(x, y)\n", "path": "ivy/functional/frontends/paddle/tensor/math.py"}]} |
gh_patches_debug_264 | rasdani/github-patches | git_diff | celery__celery-6866 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Celery inspect output JSON serialization is broken
# Checklist
- [ ] I have verified that the issue exists against the `master` branch of Celery.
- [ ] This has already been asked to the [discussion group](https://groups.google.com/forum/#!forum/celery-users) first.
- [x] I have read the relevant section in the
[contribution guide](http://docs.celeryproject.org/en/latest/contributing.html#other-bugs)
on reporting bugs.
- [x] I have checked the [issues list](https://github.com/celery/celery/issues?q=is%3Aissue+label%3A%22Issue+Type%3A+Bug+Report%22+-label%3A%22Category%3A+Documentation%22)
for similar or identical bug reports.
- [x] I have checked the [pull requests list](https://github.com/celery/celery/pulls?q=is%3Apr+label%3A%22PR+Type%3A+Bugfix%22+-label%3A%22Category%3A+Documentation%22)
for existing proposed fixes.
- [ ] I have checked the [commit log](https://github.com/celery/celery/commits/master)
to find out if the bug was already fixed in the master branch.
- [x] I have included all related issues and possible duplicate issues
in this issue (If there are none, check this box anyway).
## Mandatory Debugging Information
- [ ] I have included the output of ``celery -A proj report`` in the issue.
(if you are not able to do this, then at least specify the Celery
version affected).
- [ ] I have verified that the issue exists against the `master` branch of Celery.
- [ ] I have included the contents of ``pip freeze`` in the issue.
- [ ] I have included all the versions of all the external dependencies required
to reproduce this bug.
## Optional Debugging Information
- [ ] I have tried reproducing the issue on more than one Python version
and/or implementation.
- [ ] I have tried reproducing the issue on more than one message broker and/or
result backend.
- [ ] I have tried reproducing the issue on more than one version of the message
broker and/or result backend.
- [ ] I have tried reproducing the issue on more than one operating system.
- [ ] I have tried reproducing the issue on more than one workers pool.
- [ ] I have tried reproducing the issue with autoscaling, retries,
ETA/Countdown & rate limits disabled.
- [ ] I have tried reproducing the issue after downgrading
and/or upgrading Celery and its dependencies.
## Environment & Settings
**Celery version**: 5.1.2 (sun-harmonics)
# Steps to Reproduce
Execute `celery -A proj inspect -j active`
# Expected Behavior
Valid JSON string is returned, like:
```
{"worker-1": [], "worker-2": [], "worker-3": []}
```
# Actual Behavior
Command returns valid JSON in the first line, followed by double newline and some useless summary:
```
{"worker-1": [], "worker-2": [], "worker-3": []}
3 nodes online.
```
which makes the overall output an invalid JSON string.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `celery/bin/control.py`
Content:
```
1 """The ``celery control``, ``. inspect`` and ``. status`` programs."""
2 from functools import partial
3
4 import click
5 from kombu.utils.json import dumps
6
7 from celery.bin.base import (COMMA_SEPARATED_LIST, CeleryCommand,
8 CeleryOption, handle_preload_options)
9 from celery.exceptions import CeleryCommandException
10 from celery.platforms import EX_UNAVAILABLE
11 from celery.utils import text
12 from celery.worker.control import Panel
13
14
15 def _say_remote_command_reply(ctx, replies, show_reply=False):
16 node = next(iter(replies)) # <-- take first.
17 reply = replies[node]
18 node = ctx.obj.style(f'{node}: ', fg='cyan', bold=True)
19 status, preply = ctx.obj.pretty(reply)
20 ctx.obj.say_chat('->', f'{node}{status}',
21 text.indent(preply, 4) if show_reply else '',
22 show_body=show_reply)
23
24
25 def _consume_arguments(meta, method, args):
26 i = 0
27 try:
28 for i, arg in enumerate(args):
29 try:
30 name, typ = meta.args[i]
31 except IndexError:
32 if meta.variadic:
33 break
34 raise click.UsageError(
35 'Command {!r} takes arguments: {}'.format(
36 method, meta.signature))
37 else:
38 yield name, typ(arg) if typ is not None else arg
39 finally:
40 args[:] = args[i:]
41
42
43 def _compile_arguments(action, args):
44 meta = Panel.meta[action]
45 arguments = {}
46 if meta.args:
47 arguments.update({
48 k: v for k, v in _consume_arguments(meta, action, args)
49 })
50 if meta.variadic:
51 arguments.update({meta.variadic: args})
52 return arguments
53
54
55 @click.command(cls=CeleryCommand)
56 @click.option('-t',
57 '--timeout',
58 cls=CeleryOption,
59 type=float,
60 default=1.0,
61 help_group='Remote Control Options',
62 help='Timeout in seconds waiting for reply.')
63 @click.option('-d',
64 '--destination',
65 cls=CeleryOption,
66 type=COMMA_SEPARATED_LIST,
67 help_group='Remote Control Options',
68 help='Comma separated list of destination node names.')
69 @click.option('-j',
70 '--json',
71 cls=CeleryOption,
72 is_flag=True,
73 help_group='Remote Control Options',
74 help='Use json as output format.')
75 @click.pass_context
76 @handle_preload_options
77 def status(ctx, timeout, destination, json, **kwargs):
78 """Show list of workers that are online."""
79 callback = None if json else partial(_say_remote_command_reply, ctx)
80 replies = ctx.obj.app.control.inspect(timeout=timeout,
81 destination=destination,
82 callback=callback).ping()
83
84 if not replies:
85 raise CeleryCommandException(
86 message='No nodes replied within time constraint',
87 exit_code=EX_UNAVAILABLE
88 )
89
90 if json:
91 ctx.obj.echo(dumps(replies))
92 nodecount = len(replies)
93 if not kwargs.get('quiet', False):
94 ctx.obj.echo('\n{} {} online.'.format(
95 nodecount, text.pluralize(nodecount, 'node')))
96
97
98 @click.command(cls=CeleryCommand,
99 context_settings={'allow_extra_args': True})
100 @click.argument("action", type=click.Choice([
101 name for name, info in Panel.meta.items()
102 if info.type == 'inspect' and info.visible
103 ]))
104 @click.option('-t',
105 '--timeout',
106 cls=CeleryOption,
107 type=float,
108 default=1.0,
109 help_group='Remote Control Options',
110 help='Timeout in seconds waiting for reply.')
111 @click.option('-d',
112 '--destination',
113 cls=CeleryOption,
114 type=COMMA_SEPARATED_LIST,
115 help_group='Remote Control Options',
116 help='Comma separated list of destination node names.')
117 @click.option('-j',
118 '--json',
119 cls=CeleryOption,
120 is_flag=True,
121 help_group='Remote Control Options',
122 help='Use json as output format.')
123 @click.pass_context
124 @handle_preload_options
125 def inspect(ctx, action, timeout, destination, json, **kwargs):
126 """Inspect the worker at runtime.
127
128 Availability: RabbitMQ (AMQP) and Redis transports.
129 """
130 callback = None if json else partial(_say_remote_command_reply, ctx,
131 show_reply=True)
132 arguments = _compile_arguments(action, ctx.args)
133 inspect = ctx.obj.app.control.inspect(timeout=timeout,
134 destination=destination,
135 callback=callback)
136 replies = inspect._request(action,
137 **arguments)
138
139 if not replies:
140 raise CeleryCommandException(
141 message='No nodes replied within time constraint',
142 exit_code=EX_UNAVAILABLE
143 )
144
145 if json:
146 ctx.obj.echo(dumps(replies))
147 nodecount = len(replies)
148 if not ctx.obj.quiet:
149 ctx.obj.echo('\n{} {} online.'.format(
150 nodecount, text.pluralize(nodecount, 'node')))
151
152
153 @click.command(cls=CeleryCommand,
154 context_settings={'allow_extra_args': True})
155 @click.argument("action", type=click.Choice([
156 name for name, info in Panel.meta.items()
157 if info.type == 'control' and info.visible
158 ]))
159 @click.option('-t',
160 '--timeout',
161 cls=CeleryOption,
162 type=float,
163 default=1.0,
164 help_group='Remote Control Options',
165 help='Timeout in seconds waiting for reply.')
166 @click.option('-d',
167 '--destination',
168 cls=CeleryOption,
169 type=COMMA_SEPARATED_LIST,
170 help_group='Remote Control Options',
171 help='Comma separated list of destination node names.')
172 @click.option('-j',
173 '--json',
174 cls=CeleryOption,
175 is_flag=True,
176 help_group='Remote Control Options',
177 help='Use json as output format.')
178 @click.pass_context
179 @handle_preload_options
180 def control(ctx, action, timeout, destination, json):
181 """Workers remote control.
182
183 Availability: RabbitMQ (AMQP), Redis, and MongoDB transports.
184 """
185 callback = None if json else partial(_say_remote_command_reply, ctx,
186 show_reply=True)
187 args = ctx.args
188 arguments = _compile_arguments(action, args)
189 replies = ctx.obj.app.control.broadcast(action, timeout=timeout,
190 destination=destination,
191 callback=callback,
192 reply=True,
193 arguments=arguments)
194
195 if not replies:
196 raise CeleryCommandException(
197 message='No nodes replied within time constraint',
198 exit_code=EX_UNAVAILABLE
199 )
200
201 if json:
202 ctx.obj.echo(dumps(replies))
203
```
--- 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/celery/bin/control.py b/celery/bin/control.py
--- a/celery/bin/control.py
+++ b/celery/bin/control.py
@@ -144,6 +144,8 @@
if json:
ctx.obj.echo(dumps(replies))
+ return
+
nodecount = len(replies)
if not ctx.obj.quiet:
ctx.obj.echo('\n{} {} online.'.format(
| {"golden_diff": "diff --git a/celery/bin/control.py b/celery/bin/control.py\n--- a/celery/bin/control.py\n+++ b/celery/bin/control.py\n@@ -144,6 +144,8 @@\n \n if json:\n ctx.obj.echo(dumps(replies))\n+ return\n+\n nodecount = len(replies)\n if not ctx.obj.quiet:\n ctx.obj.echo('\\n{} {} online.'.format(\n", "issue": "Celery inspect output JSON serialization is broken\n# Checklist\r\n- [ ] I have verified that the issue exists against the `master` branch of Celery.\r\n- [ ] This has already been asked to the [discussion group](https://groups.google.com/forum/#!forum/celery-users) first.\r\n- [x] I have read the relevant section in the\r\n [contribution guide](http://docs.celeryproject.org/en/latest/contributing.html#other-bugs)\r\n on reporting bugs.\r\n- [x] I have checked the [issues list](https://github.com/celery/celery/issues?q=is%3Aissue+label%3A%22Issue+Type%3A+Bug+Report%22+-label%3A%22Category%3A+Documentation%22)\r\n for similar or identical bug reports.\r\n- [x] I have checked the [pull requests list](https://github.com/celery/celery/pulls?q=is%3Apr+label%3A%22PR+Type%3A+Bugfix%22+-label%3A%22Category%3A+Documentation%22)\r\n for existing proposed fixes.\r\n- [ ] I have checked the [commit log](https://github.com/celery/celery/commits/master)\r\n to find out if the bug was already fixed in the master branch.\r\n- [x] I have included all related issues and possible duplicate issues\r\n in this issue (If there are none, check this box anyway).\r\n\r\n## Mandatory Debugging Information\r\n\r\n- [ ] I have included the output of ``celery -A proj report`` in the issue.\r\n (if you are not able to do this, then at least specify the Celery\r\n version affected).\r\n- [ ] I have verified that the issue exists against the `master` branch of Celery.\r\n- [ ] I have included the contents of ``pip freeze`` in the issue.\r\n- [ ] I have included all the versions of all the external dependencies required\r\n to reproduce this bug.\r\n\r\n## Optional Debugging Information\r\n- [ ] I have tried reproducing the issue on more than one Python version\r\n and/or implementation.\r\n- [ ] I have tried reproducing the issue on more than one message broker and/or\r\n result backend.\r\n- [ ] I have tried reproducing the issue on more than one version of the message\r\n broker and/or result backend.\r\n- [ ] I have tried reproducing the issue on more than one operating system.\r\n- [ ] I have tried reproducing the issue on more than one workers pool.\r\n- [ ] I have tried reproducing the issue with autoscaling, retries,\r\n ETA/Countdown & rate limits disabled.\r\n- [ ] I have tried reproducing the issue after downgrading\r\n and/or upgrading Celery and its dependencies.\r\n\r\n## Environment & Settings\r\n**Celery version**: 5.1.2 (sun-harmonics)\r\n\r\n# Steps to Reproduce\r\n\r\nExecute `celery -A proj inspect -j active`\r\n\r\n# Expected Behavior\r\nValid JSON string is returned, like: \r\n```\r\n{\"worker-1\": [], \"worker-2\": [], \"worker-3\": []}\r\n```\r\n\r\n# Actual Behavior\r\nCommand returns valid JSON in the first line, followed by double newline and some useless summary:\r\n```\r\n{\"worker-1\": [], \"worker-2\": [], \"worker-3\": []}\r\n\r\n3 nodes online.\r\n```\r\nwhich makes the overall output an invalid JSON string.\n", "before_files": [{"content": "\"\"\"The ``celery control``, ``. inspect`` and ``. status`` programs.\"\"\"\nfrom functools import partial\n\nimport click\nfrom kombu.utils.json import dumps\n\nfrom celery.bin.base import (COMMA_SEPARATED_LIST, CeleryCommand,\n CeleryOption, handle_preload_options)\nfrom celery.exceptions import CeleryCommandException\nfrom celery.platforms import EX_UNAVAILABLE\nfrom celery.utils import text\nfrom celery.worker.control import Panel\n\n\ndef _say_remote_command_reply(ctx, replies, show_reply=False):\n node = next(iter(replies)) # <-- take first.\n reply = replies[node]\n node = ctx.obj.style(f'{node}: ', fg='cyan', bold=True)\n status, preply = ctx.obj.pretty(reply)\n ctx.obj.say_chat('->', f'{node}{status}',\n text.indent(preply, 4) if show_reply else '',\n show_body=show_reply)\n\n\ndef _consume_arguments(meta, method, args):\n i = 0\n try:\n for i, arg in enumerate(args):\n try:\n name, typ = meta.args[i]\n except IndexError:\n if meta.variadic:\n break\n raise click.UsageError(\n 'Command {!r} takes arguments: {}'.format(\n method, meta.signature))\n else:\n yield name, typ(arg) if typ is not None else arg\n finally:\n args[:] = args[i:]\n\n\ndef _compile_arguments(action, args):\n meta = Panel.meta[action]\n arguments = {}\n if meta.args:\n arguments.update({\n k: v for k, v in _consume_arguments(meta, action, args)\n })\n if meta.variadic:\n arguments.update({meta.variadic: args})\n return arguments\n\n\[email protected](cls=CeleryCommand)\[email protected]('-t',\n '--timeout',\n cls=CeleryOption,\n type=float,\n default=1.0,\n help_group='Remote Control Options',\n help='Timeout in seconds waiting for reply.')\[email protected]('-d',\n '--destination',\n cls=CeleryOption,\n type=COMMA_SEPARATED_LIST,\n help_group='Remote Control Options',\n help='Comma separated list of destination node names.')\[email protected]('-j',\n '--json',\n cls=CeleryOption,\n is_flag=True,\n help_group='Remote Control Options',\n help='Use json as output format.')\[email protected]_context\n@handle_preload_options\ndef status(ctx, timeout, destination, json, **kwargs):\n \"\"\"Show list of workers that are online.\"\"\"\n callback = None if json else partial(_say_remote_command_reply, ctx)\n replies = ctx.obj.app.control.inspect(timeout=timeout,\n destination=destination,\n callback=callback).ping()\n\n if not replies:\n raise CeleryCommandException(\n message='No nodes replied within time constraint',\n exit_code=EX_UNAVAILABLE\n )\n\n if json:\n ctx.obj.echo(dumps(replies))\n nodecount = len(replies)\n if not kwargs.get('quiet', False):\n ctx.obj.echo('\\n{} {} online.'.format(\n nodecount, text.pluralize(nodecount, 'node')))\n\n\[email protected](cls=CeleryCommand,\n context_settings={'allow_extra_args': True})\[email protected](\"action\", type=click.Choice([\n name for name, info in Panel.meta.items()\n if info.type == 'inspect' and info.visible\n]))\[email protected]('-t',\n '--timeout',\n cls=CeleryOption,\n type=float,\n default=1.0,\n help_group='Remote Control Options',\n help='Timeout in seconds waiting for reply.')\[email protected]('-d',\n '--destination',\n cls=CeleryOption,\n type=COMMA_SEPARATED_LIST,\n help_group='Remote Control Options',\n help='Comma separated list of destination node names.')\[email protected]('-j',\n '--json',\n cls=CeleryOption,\n is_flag=True,\n help_group='Remote Control Options',\n help='Use json as output format.')\[email protected]_context\n@handle_preload_options\ndef inspect(ctx, action, timeout, destination, json, **kwargs):\n \"\"\"Inspect the worker at runtime.\n\n Availability: RabbitMQ (AMQP) and Redis transports.\n \"\"\"\n callback = None if json else partial(_say_remote_command_reply, ctx,\n show_reply=True)\n arguments = _compile_arguments(action, ctx.args)\n inspect = ctx.obj.app.control.inspect(timeout=timeout,\n destination=destination,\n callback=callback)\n replies = inspect._request(action,\n **arguments)\n\n if not replies:\n raise CeleryCommandException(\n message='No nodes replied within time constraint',\n exit_code=EX_UNAVAILABLE\n )\n\n if json:\n ctx.obj.echo(dumps(replies))\n nodecount = len(replies)\n if not ctx.obj.quiet:\n ctx.obj.echo('\\n{} {} online.'.format(\n nodecount, text.pluralize(nodecount, 'node')))\n\n\[email protected](cls=CeleryCommand,\n context_settings={'allow_extra_args': True})\[email protected](\"action\", type=click.Choice([\n name for name, info in Panel.meta.items()\n if info.type == 'control' and info.visible\n]))\[email protected]('-t',\n '--timeout',\n cls=CeleryOption,\n type=float,\n default=1.0,\n help_group='Remote Control Options',\n help='Timeout in seconds waiting for reply.')\[email protected]('-d',\n '--destination',\n cls=CeleryOption,\n type=COMMA_SEPARATED_LIST,\n help_group='Remote Control Options',\n help='Comma separated list of destination node names.')\[email protected]('-j',\n '--json',\n cls=CeleryOption,\n is_flag=True,\n help_group='Remote Control Options',\n help='Use json as output format.')\[email protected]_context\n@handle_preload_options\ndef control(ctx, action, timeout, destination, json):\n \"\"\"Workers remote control.\n\n Availability: RabbitMQ (AMQP), Redis, and MongoDB transports.\n \"\"\"\n callback = None if json else partial(_say_remote_command_reply, ctx,\n show_reply=True)\n args = ctx.args\n arguments = _compile_arguments(action, args)\n replies = ctx.obj.app.control.broadcast(action, timeout=timeout,\n destination=destination,\n callback=callback,\n reply=True,\n arguments=arguments)\n\n if not replies:\n raise CeleryCommandException(\n message='No nodes replied within time constraint',\n exit_code=EX_UNAVAILABLE\n )\n\n if json:\n ctx.obj.echo(dumps(replies))\n", "path": "celery/bin/control.py"}], "after_files": [{"content": "\"\"\"The ``celery control``, ``. inspect`` and ``. status`` programs.\"\"\"\nfrom functools import partial\n\nimport click\nfrom kombu.utils.json import dumps\n\nfrom celery.bin.base import (COMMA_SEPARATED_LIST, CeleryCommand,\n CeleryOption, handle_preload_options)\nfrom celery.exceptions import CeleryCommandException\nfrom celery.platforms import EX_UNAVAILABLE\nfrom celery.utils import text\nfrom celery.worker.control import Panel\n\n\ndef _say_remote_command_reply(ctx, replies, show_reply=False):\n node = next(iter(replies)) # <-- take first.\n reply = replies[node]\n node = ctx.obj.style(f'{node}: ', fg='cyan', bold=True)\n status, preply = ctx.obj.pretty(reply)\n ctx.obj.say_chat('->', f'{node}{status}',\n text.indent(preply, 4) if show_reply else '',\n show_body=show_reply)\n\n\ndef _consume_arguments(meta, method, args):\n i = 0\n try:\n for i, arg in enumerate(args):\n try:\n name, typ = meta.args[i]\n except IndexError:\n if meta.variadic:\n break\n raise click.UsageError(\n 'Command {!r} takes arguments: {}'.format(\n method, meta.signature))\n else:\n yield name, typ(arg) if typ is not None else arg\n finally:\n args[:] = args[i:]\n\n\ndef _compile_arguments(action, args):\n meta = Panel.meta[action]\n arguments = {}\n if meta.args:\n arguments.update({\n k: v for k, v in _consume_arguments(meta, action, args)\n })\n if meta.variadic:\n arguments.update({meta.variadic: args})\n return arguments\n\n\[email protected](cls=CeleryCommand)\[email protected]('-t',\n '--timeout',\n cls=CeleryOption,\n type=float,\n default=1.0,\n help_group='Remote Control Options',\n help='Timeout in seconds waiting for reply.')\[email protected]('-d',\n '--destination',\n cls=CeleryOption,\n type=COMMA_SEPARATED_LIST,\n help_group='Remote Control Options',\n help='Comma separated list of destination node names.')\[email protected]('-j',\n '--json',\n cls=CeleryOption,\n is_flag=True,\n help_group='Remote Control Options',\n help='Use json as output format.')\[email protected]_context\n@handle_preload_options\ndef status(ctx, timeout, destination, json, **kwargs):\n \"\"\"Show list of workers that are online.\"\"\"\n callback = None if json else partial(_say_remote_command_reply, ctx)\n replies = ctx.obj.app.control.inspect(timeout=timeout,\n destination=destination,\n callback=callback).ping()\n\n if not replies:\n raise CeleryCommandException(\n message='No nodes replied within time constraint',\n exit_code=EX_UNAVAILABLE\n )\n\n if json:\n ctx.obj.echo(dumps(replies))\n nodecount = len(replies)\n if not kwargs.get('quiet', False):\n ctx.obj.echo('\\n{} {} online.'.format(\n nodecount, text.pluralize(nodecount, 'node')))\n\n\[email protected](cls=CeleryCommand,\n context_settings={'allow_extra_args': True})\[email protected](\"action\", type=click.Choice([\n name for name, info in Panel.meta.items()\n if info.type == 'inspect' and info.visible\n]))\[email protected]('-t',\n '--timeout',\n cls=CeleryOption,\n type=float,\n default=1.0,\n help_group='Remote Control Options',\n help='Timeout in seconds waiting for reply.')\[email protected]('-d',\n '--destination',\n cls=CeleryOption,\n type=COMMA_SEPARATED_LIST,\n help_group='Remote Control Options',\n help='Comma separated list of destination node names.')\[email protected]('-j',\n '--json',\n cls=CeleryOption,\n is_flag=True,\n help_group='Remote Control Options',\n help='Use json as output format.')\[email protected]_context\n@handle_preload_options\ndef inspect(ctx, action, timeout, destination, json, **kwargs):\n \"\"\"Inspect the worker at runtime.\n\n Availability: RabbitMQ (AMQP) and Redis transports.\n \"\"\"\n callback = None if json else partial(_say_remote_command_reply, ctx,\n show_reply=True)\n arguments = _compile_arguments(action, ctx.args)\n inspect = ctx.obj.app.control.inspect(timeout=timeout,\n destination=destination,\n callback=callback)\n replies = inspect._request(action,\n **arguments)\n\n if not replies:\n raise CeleryCommandException(\n message='No nodes replied within time constraint',\n exit_code=EX_UNAVAILABLE\n )\n\n if json:\n ctx.obj.echo(dumps(replies))\n return\n\n nodecount = len(replies)\n if not ctx.obj.quiet:\n ctx.obj.echo('\\n{} {} online.'.format(\n nodecount, text.pluralize(nodecount, 'node')))\n\n\[email protected](cls=CeleryCommand,\n context_settings={'allow_extra_args': True})\[email protected](\"action\", type=click.Choice([\n name for name, info in Panel.meta.items()\n if info.type == 'control' and info.visible\n]))\[email protected]('-t',\n '--timeout',\n cls=CeleryOption,\n type=float,\n default=1.0,\n help_group='Remote Control Options',\n help='Timeout in seconds waiting for reply.')\[email protected]('-d',\n '--destination',\n cls=CeleryOption,\n type=COMMA_SEPARATED_LIST,\n help_group='Remote Control Options',\n help='Comma separated list of destination node names.')\[email protected]('-j',\n '--json',\n cls=CeleryOption,\n is_flag=True,\n help_group='Remote Control Options',\n help='Use json as output format.')\[email protected]_context\n@handle_preload_options\ndef control(ctx, action, timeout, destination, json):\n \"\"\"Workers remote control.\n\n Availability: RabbitMQ (AMQP), Redis, and MongoDB transports.\n \"\"\"\n callback = None if json else partial(_say_remote_command_reply, ctx,\n show_reply=True)\n args = ctx.args\n arguments = _compile_arguments(action, args)\n replies = ctx.obj.app.control.broadcast(action, timeout=timeout,\n destination=destination,\n callback=callback,\n reply=True,\n arguments=arguments)\n\n if not replies:\n raise CeleryCommandException(\n message='No nodes replied within time constraint',\n exit_code=EX_UNAVAILABLE\n )\n\n if json:\n ctx.obj.echo(dumps(replies))\n", "path": "celery/bin/control.py"}]} |
gh_patches_debug_265 | rasdani/github-patches | git_diff | secdev__scapy-1402 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
man page spelling error
intances should be instances.
It would be nice if this wasn't gz compressed in the source, otherwise I'd have done a pull request.
--- 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
3 """
4 Distutils setup file for Scapy.
5 """
6
7
8 from distutils import archive_util
9 from distutils import sysconfig
10 from distutils.core import setup
11 from distutils.command.sdist import sdist
12 import os
13
14
15 EZIP_HEADER = """#! /bin/sh
16 PYTHONPATH=$0/%s exec python -m scapy
17 """
18
19
20 def make_ezipfile(base_name, base_dir, verbose=0, dry_run=0, **kwargs):
21 fname = archive_util.make_zipfile(base_name, base_dir, verbose, dry_run)
22 ofname = fname + ".old"
23 os.rename(fname, ofname)
24 of = open(ofname)
25 f = open(fname, "w")
26 f.write(EZIP_HEADER % base_dir)
27 while True:
28 data = of.read(8192)
29 if not data:
30 break
31 f.write(data)
32 f.close()
33 os.system("zip -A '%s'" % fname)
34 of.close()
35 os.unlink(ofname)
36 os.chmod(fname, 0o755)
37 return fname
38
39
40 archive_util.ARCHIVE_FORMATS["ezip"] = (
41 make_ezipfile, [], 'Executable ZIP file')
42
43 SCRIPTS = ['bin/scapy', 'bin/UTscapy']
44 # On Windows we also need additional batch files to run the above scripts
45 if os.name == "nt":
46 SCRIPTS += ['bin/scapy.bat', 'bin/UTscapy.bat']
47
48 setup(
49 name='scapy',
50 version=__import__('scapy').VERSION,
51 packages=[
52 'scapy',
53 'scapy/arch',
54 'scapy/arch/bpf',
55 'scapy/arch/windows',
56 'scapy/contrib',
57 'scapy/layers',
58 'scapy/layers/tls',
59 'scapy/layers/tls/crypto',
60 'scapy/modules',
61 'scapy/modules/krack',
62 'scapy/asn1',
63 'scapy/tools',
64 ],
65 scripts=SCRIPTS,
66 data_files=[('share/man/man1', ["doc/scapy.1.gz"])],
67 package_data={
68 'scapy': ['VERSION'],
69 },
70
71 # Metadata
72 author='Philippe BIONDI',
73 author_email='phil(at)secdev.org',
74 maintainer='Pierre LALET, Guillaume VALADON',
75 description='Scapy: interactive packet manipulation tool',
76 license='GPLv2',
77 url='http://www.secdev.org/projects/scapy',
78 download_url='https://github.com/secdev/scapy/tarball/master',
79 keywords=["network"],
80 classifiers=[
81 "Development Status :: 5 - Production/Stable",
82 "Environment :: Console",
83 "Intended Audience :: Developers",
84 "Intended Audience :: Information Technology",
85 "Intended Audience :: Science/Research",
86 "Intended Audience :: System Administrators",
87 "Intended Audience :: Telecommunications Industry",
88 "License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
89 "Programming Language :: Python :: 2",
90 "Programming Language :: Python :: 2.7",
91 "Programming Language :: Python :: 3",
92 "Programming Language :: Python :: 3.4",
93 "Programming Language :: Python :: 3.5",
94 "Programming Language :: Python :: 3.6",
95 "Topic :: Security",
96 "Topic :: System :: Networking",
97 "Topic :: System :: Networking :: Monitoring",
98 ]
99 )
100
```
--- 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
@@ -63,7 +63,7 @@
'scapy/tools',
],
scripts=SCRIPTS,
- data_files=[('share/man/man1', ["doc/scapy.1.gz"])],
+ data_files=[('share/man/man1', ["doc/scapy.1"])],
package_data={
'scapy': ['VERSION'],
},
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -63,7 +63,7 @@\n 'scapy/tools',\n ],\n scripts=SCRIPTS,\n- data_files=[('share/man/man1', [\"doc/scapy.1.gz\"])],\n+ data_files=[('share/man/man1', [\"doc/scapy.1\"])],\n package_data={\n 'scapy': ['VERSION'],\n },\n", "issue": "man page spelling error\nintances should be instances.\r\n\r\nIt would be nice if this wasn't gz compressed in the source, otherwise I'd have done a pull request.\n", "before_files": [{"content": "#! /usr/bin/env python\n\n\"\"\"\nDistutils setup file for Scapy.\n\"\"\"\n\n\nfrom distutils import archive_util\nfrom distutils import sysconfig\nfrom distutils.core import setup\nfrom distutils.command.sdist import sdist\nimport os\n\n\nEZIP_HEADER = \"\"\"#! /bin/sh\nPYTHONPATH=$0/%s exec python -m scapy\n\"\"\"\n\n\ndef make_ezipfile(base_name, base_dir, verbose=0, dry_run=0, **kwargs):\n fname = archive_util.make_zipfile(base_name, base_dir, verbose, dry_run)\n ofname = fname + \".old\"\n os.rename(fname, ofname)\n of = open(ofname)\n f = open(fname, \"w\")\n f.write(EZIP_HEADER % base_dir)\n while True:\n data = of.read(8192)\n if not data:\n break\n f.write(data)\n f.close()\n os.system(\"zip -A '%s'\" % fname)\n of.close()\n os.unlink(ofname)\n os.chmod(fname, 0o755)\n return fname\n\n\narchive_util.ARCHIVE_FORMATS[\"ezip\"] = (\n make_ezipfile, [], 'Executable ZIP file')\n\nSCRIPTS = ['bin/scapy', 'bin/UTscapy']\n# On Windows we also need additional batch files to run the above scripts\nif os.name == \"nt\":\n SCRIPTS += ['bin/scapy.bat', 'bin/UTscapy.bat']\n\nsetup(\n name='scapy',\n version=__import__('scapy').VERSION,\n packages=[\n 'scapy',\n 'scapy/arch',\n 'scapy/arch/bpf',\n 'scapy/arch/windows',\n 'scapy/contrib',\n 'scapy/layers',\n 'scapy/layers/tls',\n 'scapy/layers/tls/crypto',\n 'scapy/modules',\n 'scapy/modules/krack',\n 'scapy/asn1',\n 'scapy/tools',\n ],\n scripts=SCRIPTS,\n data_files=[('share/man/man1', [\"doc/scapy.1.gz\"])],\n package_data={\n 'scapy': ['VERSION'],\n },\n\n # Metadata\n author='Philippe BIONDI',\n author_email='phil(at)secdev.org',\n maintainer='Pierre LALET, Guillaume VALADON',\n description='Scapy: interactive packet manipulation tool',\n license='GPLv2',\n url='http://www.secdev.org/projects/scapy',\n download_url='https://github.com/secdev/scapy/tarball/master',\n keywords=[\"network\"],\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: Information Technology\",\n \"Intended Audience :: Science/Research\",\n \"Intended Audience :: System Administrators\",\n \"Intended Audience :: Telecommunications Industry\",\n \"License :: OSI Approved :: GNU General Public License v2 (GPLv2)\",\n \"Programming Language :: Python :: 2\",\n \"Programming Language :: Python :: 2.7\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.4\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Topic :: Security\",\n \"Topic :: System :: Networking\",\n \"Topic :: System :: Networking :: Monitoring\",\n ]\n)\n", "path": "setup.py"}], "after_files": [{"content": "#! /usr/bin/env python\n\n\"\"\"\nDistutils setup file for Scapy.\n\"\"\"\n\n\nfrom distutils import archive_util\nfrom distutils import sysconfig\nfrom distutils.core import setup\nfrom distutils.command.sdist import sdist\nimport os\n\n\nEZIP_HEADER = \"\"\"#! /bin/sh\nPYTHONPATH=$0/%s exec python -m scapy\n\"\"\"\n\n\ndef make_ezipfile(base_name, base_dir, verbose=0, dry_run=0, **kwargs):\n fname = archive_util.make_zipfile(base_name, base_dir, verbose, dry_run)\n ofname = fname + \".old\"\n os.rename(fname, ofname)\n of = open(ofname)\n f = open(fname, \"w\")\n f.write(EZIP_HEADER % base_dir)\n while True:\n data = of.read(8192)\n if not data:\n break\n f.write(data)\n f.close()\n os.system(\"zip -A '%s'\" % fname)\n of.close()\n os.unlink(ofname)\n os.chmod(fname, 0o755)\n return fname\n\n\narchive_util.ARCHIVE_FORMATS[\"ezip\"] = (\n make_ezipfile, [], 'Executable ZIP file')\n\nSCRIPTS = ['bin/scapy', 'bin/UTscapy']\n# On Windows we also need additional batch files to run the above scripts\nif os.name == \"nt\":\n SCRIPTS += ['bin/scapy.bat', 'bin/UTscapy.bat']\n\nsetup(\n name='scapy',\n version=__import__('scapy').VERSION,\n packages=[\n 'scapy',\n 'scapy/arch',\n 'scapy/arch/bpf',\n 'scapy/arch/windows',\n 'scapy/contrib',\n 'scapy/layers',\n 'scapy/layers/tls',\n 'scapy/layers/tls/crypto',\n 'scapy/modules',\n 'scapy/modules/krack',\n 'scapy/asn1',\n 'scapy/tools',\n ],\n scripts=SCRIPTS,\n data_files=[('share/man/man1', [\"doc/scapy.1\"])],\n package_data={\n 'scapy': ['VERSION'],\n },\n\n # Metadata\n author='Philippe BIONDI',\n author_email='phil(at)secdev.org',\n maintainer='Pierre LALET, Guillaume VALADON',\n description='Scapy: interactive packet manipulation tool',\n license='GPLv2',\n url='http://www.secdev.org/projects/scapy',\n download_url='https://github.com/secdev/scapy/tarball/master',\n keywords=[\"network\"],\n classifiers=[\n \"Development Status :: 5 - Production/Stable\",\n \"Environment :: Console\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: Information Technology\",\n \"Intended Audience :: Science/Research\",\n \"Intended Audience :: System Administrators\",\n \"Intended Audience :: Telecommunications Industry\",\n \"License :: OSI Approved :: GNU General Public License v2 (GPLv2)\",\n \"Programming Language :: Python :: 2\",\n \"Programming Language :: Python :: 2.7\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.4\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Topic :: Security\",\n \"Topic :: System :: Networking\",\n \"Topic :: System :: Networking :: Monitoring\",\n ]\n)\n", "path": "setup.py"}]} |
gh_patches_debug_266 | rasdani/github-patches | git_diff | evennia__evennia-2900 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
[BUG - Develop] Log rotation infinite-loops
#### Describe the bug
My log file reached the maximum size and when trying to rotate, it hits an infinite loop.
https://github.com/evennia/evennia/blob/3992f37dada8ae9d495b7bdc087ff107e21e29aa/evennia/utils/logger.py#L352-L354
I think maybe it's supposed to be `super().rotate()` instead of `self.rotate()`?
#### Develop-branch commit
3992f37da
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `evennia/utils/logger.py`
Content:
```
1 """
2 Logging facilities
3
4 These are thin wrappers on top of Twisted's logging facilities; logs
5 are all directed either to stdout (if Evennia is running in
6 interactive mode) or to $GAME_DIR/server/logs.
7
8 The log_file() function uses its own threading system to log to
9 arbitrary files in $GAME_DIR/server/logs.
10
11 Note: All logging functions have two aliases, log_type() and
12 log_typemsg(). This is for historical, back-compatible reasons.
13
14 """
15
16
17 import os
18 import time
19 from datetime import datetime
20 from traceback import format_exc
21
22 from twisted import logger as twisted_logger
23 from twisted.internet.threads import deferToThread
24 from twisted.python import logfile
25 from twisted.python import util as twisted_util
26
27 log = twisted_logger.Logger()
28
29 _LOGDIR = None
30 _LOG_ROTATE_SIZE = None
31 _TIMEZONE = None
32 _CHANNEL_LOG_NUM_TAIL_LINES = None
33
34 _TIME_FORMAT = "%Y-%m-%d %H:%M:%S"
35
36
37 def _log(msg, logfunc, prefix="", **kwargs):
38 try:
39 msg = str(msg)
40 except Exception as err:
41 msg = str(e)
42 if kwargs:
43 logfunc(msg, **kwargs)
44 else:
45 try:
46 for line in msg.splitlines():
47 logfunc("{line}", prefix=prefix, line=line)
48 except Exception as err:
49 log.error("Log failure: {err}", err=err)
50
51
52 # log call functions (each has legacy aliases)
53
54
55 def log_info(msg, **kwargs):
56 """
57 Logs any generic debugging/informative info that should appear in the log.
58
59 Args:
60 msg: (string) The message to be logged.
61 **kwargs: If given, The `msg` is parsed as a format string with `{..}`
62 formatting markers that should match the keywords.
63
64 """
65 _log(msg, log.info, **kwargs)
66
67
68 info = log_info
69 log_infomsg = log_info
70 log_msg = log_info
71
72
73 def log_warn(msg, **kwargs):
74 """
75 Logs warnings that aren't critical but should be noted.
76
77 Args:
78 msg (str): The message to be logged.
79 **kwargs: If given, The `msg` is parsed as a format string with `{..}`
80 formatting markers that should match the keywords.
81
82 """
83 _log(msg, log.warn, **kwargs)
84
85
86 warn = log_warn
87 warning = log_warn
88 log_warnmsg = log_warn
89
90
91 def log_err(msg, **kwargs):
92 """
93 Logs an error message to the server log.
94
95 Args:
96 msg (str): The message to be logged.
97 **kwargs: If given, The `msg` is parsed as a format string with `{..}`
98 formatting markers that should match the keywords.
99
100 """
101 _log(msg, log.error, **kwargs)
102
103
104 error = log_err
105 err = log_err
106 log_errmsg = log_err
107
108
109 def log_trace(msg=None, **kwargs):
110 """
111 Log a traceback to the log. This should be called from within an
112 exception.
113
114 Args:
115 msg (str, optional): Adds an extra line with added info
116 at the end of the traceback in the log.
117 **kwargs: If given, The `msg` is parsed as a format string with `{..}`
118 formatting markers that should match the keywords.
119
120 """
121 tracestring = format_exc()
122 if tracestring:
123 _log(tracestring, log.error, prefix="!!", **kwargs)
124 if msg:
125 _log(msg, log.error, prefix="!!", **kwargs)
126
127
128 log_tracemsg = log_trace
129 exception = log_trace
130 critical = log_trace
131 trace = log_trace
132
133
134 def log_dep(msg, **kwargs):
135 """
136 Prints a deprecation message.
137
138 Args:
139 msg (str): The deprecation message to log.
140 **kwargs: If given, The `msg` is parsed as a format string with `{..}`
141 formatting markers that should match the keywords.
142
143 """
144 _log(msg, log.warn, prefix="DP", **kwargs)
145
146
147 dep = log_dep
148 deprecated = log_dep
149 log_depmsg = log_dep
150
151
152 def log_sec(msg, **kwargs):
153 """
154 Prints a security-related message.
155
156 Args:
157 msg (str): The security message to log.
158 **kwargs: If given, The `msg` is parsed as a format string with `{..}`
159 formatting markers that should match the keywords.
160
161 """
162 _log(msg, log.info, prefix="SS", **kwargs)
163
164
165 sec = log_sec
166 security = log_sec
167 log_secmsg = log_sec
168
169
170 def log_server(msg, **kwargs):
171 """
172 This is for the Portal to log captured Server stdout messages (it's
173 usually only used during startup, before Server log is open)
174
175 Args:
176 msg (str): The message to be logged.
177 **kwargs: If given, The `msg` is parsed as a format string with `{..}`
178 formatting markers that should match the keywords.
179 """
180 _log(msg, log.info, prefix="Server", **kwargs)
181
182
183 class GetLogObserver:
184 """
185 Sets up how the system logs are formatted.
186
187 """
188
189 component_prefix = ""
190 event_levels = {
191 twisted_logger.LogLevel.debug: "??",
192 twisted_logger.LogLevel.info: "..",
193 twisted_logger.LogLevel.warn: "WW",
194 twisted_logger.LogLevel.error: "EE",
195 twisted_logger.LogLevel.critical: "!!",
196 }
197
198 def format_log_event(self, event):
199 """
200 By assigning log_system here, we skip the spammy display of namespace/level
201 in the default log output.
202
203 [component_prefix] [date] [system/lvl] [msg]
204
205 """
206 # setting log_system fills the [..] block after the time stamp
207 prefix = event.get("prefix", "")
208 if prefix:
209 event["log_system"] = prefix
210 else:
211 lvl = event.get("log_level", twisted_logger.LogLevel.info)
212 event["log_system"] = self.event_levels.get(lvl, "-")
213 event["log_format"] = str(event.get("log_format", ""))
214 component_prefix = self.component_prefix or ""
215 log_msg = twisted_logger.formatEventAsClassicLogText(
216 event, formatTime=lambda e: twisted_logger.formatTime(e, _TIME_FORMAT)
217 )
218 return f"{component_prefix}{log_msg}"
219
220 def __call__(self, outfile):
221 return twisted_logger.FileLogObserver(outfile, self.format_log_event)
222
223
224 # Called by server/portal on startup
225
226
227 class GetPortalLogObserver(GetLogObserver):
228 component_prefix = "|Portal| "
229
230
231 class GetServerLogObserver(GetLogObserver):
232 component_prefix = ""
233
234
235 # logging overrides
236
237
238 def timeformat(when=None):
239 """
240 This helper function will format the current time in the same
241 way as the twisted logger does, including time zone info. Only
242 difference from official logger is that we only use two digits
243 for the year and don't show timezone for GMT times.
244
245 Args:
246 when (int, optional): This is a time in POSIX seconds on the form
247 given by time.time(). If not given, this function will
248 use the current time.
249
250 Returns:
251 timestring (str): A formatted string of the given time.
252
253 """
254 when = when if when else time.time()
255
256 # time zone offset: UTC - the actual offset
257 tz_offset = datetime.utcfromtimestamp(when) - datetime.fromtimestamp(when)
258 tz_offset = tz_offset.days * 86400 + tz_offset.seconds
259 # correct given time to utc
260 when = datetime.utcfromtimestamp(when - tz_offset)
261
262 if tz_offset == 0:
263 tz = ""
264 else:
265 tz_hour = abs(int(tz_offset // 3600))
266 tz_mins = abs(int(tz_offset // 60 % 60))
267 tz_sign = "-" if tz_offset >= 0 else "+"
268 tz = "%s%02d%s" % (tz_sign, tz_hour, (":%02d" % tz_mins if tz_mins else ""))
269
270 return "%d-%02d-%02d %02d:%02d:%02d%s" % (
271 when.year - 2000,
272 when.month,
273 when.day,
274 when.hour,
275 when.minute,
276 when.second,
277 tz,
278 )
279
280
281 class WeeklyLogFile(logfile.DailyLogFile):
282 """
283 Log file that rotates once per week by default. Overrides key methods to change format.
284
285 """
286
287 def __init__(self, name, directory, defaultMode=None, day_rotation=7, max_size=1000000):
288 """
289 Args:
290 name (str): Name of log file.
291 directory (str): Directory holding the file.
292 defaultMode (str): Permissions used to create file. Defaults to
293 current permissions of this file if it exists.
294 day_rotation (int): How often to rotate the file.
295 max_size (int): Max size of log file before rotation (regardless of
296 time). Defaults to 1M.
297
298 """
299 self.day_rotation = day_rotation
300 self.max_size = max_size
301 self.size = 0
302 logfile.DailyLogFile.__init__(self, name, directory, defaultMode=defaultMode)
303
304 def _openFile(self):
305 logfile.DailyLogFile._openFile(self)
306 self.size = self._file.tell()
307
308 def shouldRotate(self):
309 """Rotate when the date has changed since last write"""
310 # all dates here are tuples (year, month, day)
311 now = self.toDate()
312 then = self.lastDate
313 return (
314 now[0] > then[0]
315 or now[1] > then[1]
316 or now[2] > (then[2] + self.day_rotation)
317 or self.size >= self.max_size
318 )
319
320 def suffix(self, tupledate):
321 """Return the suffix given a (year, month, day) tuple or unixtime.
322 Format changed to have 03 for march instead of 3 etc (retaining unix
323 file order)
324
325 If we get duplicate suffixes in location (due to hitting size limit),
326 we append __1, __2 etc.
327
328 Examples:
329 server.log.2020_01_29
330 server.log.2020_01_29__1
331 server.log.2020_01_29__2
332
333 """
334 suffix = ""
335 copy_suffix = 0
336 while True:
337 try:
338 suffix = "_".join(["{:02d}".format(part) for part in tupledate])
339 except Exception:
340 # try taking a float unixtime
341 suffix = "_".join(["{:02d}".format(part) for part in self.toDate(tupledate)])
342
343 suffix += f"__{copy_suffix}" if copy_suffix else ""
344
345 if os.path.exists(f"{self.path}.{suffix}"):
346 # Append a higher copy_suffix to try to break the tie (starting from 2)
347 copy_suffix += 1
348 else:
349 break
350 return suffix
351
352 def rotate(self):
353 try:
354 self.rotate()
355 except Exception:
356 log_trace(f"Could not rotate the log file {self.name}.")
357
358 def write(self, data):
359 """
360 Write data to log file
361
362 """
363 logfile.BaseLogFile.write(self, data)
364 self.lastDate = max(self.lastDate, self.toDate())
365 self.size += len(data)
366
367
368 # Arbitrary file logger
369
370
371 class EvenniaLogFile(logfile.LogFile):
372 """
373 A rotating logfile based off Twisted's LogFile. It overrides
374 the LogFile's rotate method in order to append some of the last
375 lines of the previous log to the start of the new log, in order
376 to preserve a continuous chat history for channel log files.
377
378 """
379
380 # we delay import of settings to keep logger module as free
381 # from django as possible.
382 global _CHANNEL_LOG_NUM_TAIL_LINES
383 if _CHANNEL_LOG_NUM_TAIL_LINES is None:
384 from django.conf import settings
385
386 _CHANNEL_LOG_NUM_TAIL_LINES = settings.CHANNEL_LOG_NUM_TAIL_LINES
387 num_lines_to_append = _CHANNEL_LOG_NUM_TAIL_LINES
388
389 def rotate(self, num_lines_to_append=None):
390 """
391 Rotates our log file and appends some number of lines from
392 the previous log to the start of the new one.
393
394 """
395 append_tail = (
396 num_lines_to_append if num_lines_to_append is not None else self.num_lines_to_append
397 )
398 if not append_tail:
399 logfile.LogFile.rotate(self)
400 return
401 lines = tail_log_file(self.path, 0, self.num_lines_to_append)
402 super().rotate()
403 for line in lines:
404 self.write(line)
405
406 def seek(self, *args, **kwargs):
407 """
408 Convenience method for accessing our _file attribute's seek method,
409 which is used in tail_log_function.
410
411 Args:
412 *args: Same args as file.seek
413 **kwargs: Same kwargs as file.seek
414
415 """
416 return self._file.seek(*args, **kwargs)
417
418 def readlines(self, *args, **kwargs):
419 """
420 Convenience method for accessing our _file attribute's readlines method,
421 which is used in tail_log_function.
422
423 Args:
424 *args: same args as file.readlines
425 **kwargs: same kwargs as file.readlines
426
427 Returns:
428 lines (list): lines from our _file attribute.
429
430 """
431 lines = []
432 for line in self._file.readlines(*args, **kwargs):
433 try:
434 lines.append(line.decode("utf-8"))
435 except UnicodeDecodeError:
436 try:
437 lines.append(str(line))
438 except Exception:
439 lines.append("")
440 return lines
441
442
443 _LOG_FILE_HANDLES = {} # holds open log handles
444 _LOG_FILE_HANDLE_COUNTS = {}
445 _LOG_FILE_HANDLE_RESET = 500
446
447
448 def _open_log_file(filename):
449 """
450 Helper to open the log file (always in the log dir) and cache its
451 handle. Will create a new file in the log dir if one didn't
452 exist.
453
454 To avoid keeping the filehandle open indefinitely we reset it every
455 _LOG_FILE_HANDLE_RESET accesses. This may help resolve issues for very
456 long uptimes and heavy log use.
457
458 """
459 # we delay import of settings to keep logger module as free
460 # from django as possible.
461 global _LOG_FILE_HANDLES, _LOG_FILE_HANDLE_COUNTS, _LOGDIR, _LOG_ROTATE_SIZE
462 if not _LOGDIR:
463 from django.conf import settings
464
465 _LOGDIR = settings.LOG_DIR
466 _LOG_ROTATE_SIZE = settings.CHANNEL_LOG_ROTATE_SIZE
467
468 filename = os.path.join(_LOGDIR, filename)
469 if filename in _LOG_FILE_HANDLES:
470 _LOG_FILE_HANDLE_COUNTS[filename] += 1
471 if _LOG_FILE_HANDLE_COUNTS[filename] > _LOG_FILE_HANDLE_RESET:
472 # close/refresh handle
473 _LOG_FILE_HANDLES[filename].close()
474 del _LOG_FILE_HANDLES[filename]
475 else:
476 # return cached handle
477 return _LOG_FILE_HANDLES[filename]
478 try:
479 filehandle = EvenniaLogFile.fromFullPath(filename, rotateLength=_LOG_ROTATE_SIZE)
480 # filehandle = open(filename, "a+") # append mode + reading
481 _LOG_FILE_HANDLES[filename] = filehandle
482 _LOG_FILE_HANDLE_COUNTS[filename] = 0
483 return filehandle
484 except IOError:
485 log_trace()
486 return None
487
488
489 def log_file(msg, filename="game.log"):
490 """
491 Arbitrary file logger using threads.
492
493 Args:
494 msg (str): String to append to logfile.
495 filename (str, optional): Defaults to 'game.log'. All logs
496 will appear in the logs directory and log entries will start
497 on new lines following datetime info.
498
499 """
500
501 def callback(filehandle, msg):
502 """Writing to file and flushing result"""
503 msg = "\n%s [-] %s" % (timeformat(), msg.strip())
504 filehandle.write(msg)
505 # since we don't close the handle, we need to flush
506 # manually or log file won't be written to until the
507 # write buffer is full.
508 filehandle.flush()
509
510 def errback(failure):
511 """Catching errors to normal log"""
512 log_trace()
513
514 # save to server/logs/ directory
515 filehandle = _open_log_file(filename)
516 if filehandle:
517 deferToThread(callback, filehandle, msg).addErrback(errback)
518
519
520 def log_file_exists(filename="game.log"):
521 """
522 Determine if a log-file already exists.
523
524 Args:
525 filename (str): The filename (within the log-dir).
526
527 Returns:
528 bool: If the log file exists or not.
529
530 """
531 global _LOGDIR
532 if not _LOGDIR:
533 from django.conf import settings
534
535 _LOGDIR = settings.LOG_DIR
536
537 filename = os.path.join(_LOGDIR, filename)
538 return os.path.exists(filename)
539
540
541 def rotate_log_file(filename="game.log", num_lines_to_append=None):
542 """
543 Force-rotate a log-file, without
544
545 Args:
546 filename (str): The log file, located in settings.LOG_DIR.
547 num_lines_to_append (int, optional): Include N number of
548 lines from previous file in new one. If `None`, use default.
549 Set to 0 to include no lines.
550
551 """
552 if log_file_exists(filename):
553 file_handle = _open_log_file(filename)
554 if file_handle:
555 file_handle.rotate(num_lines_to_append=num_lines_to_append)
556
557
558 def tail_log_file(filename, offset, nlines, callback=None):
559 """
560 Return the tail of the log file.
561
562 Args:
563 filename (str): The name of the log file, presumed to be in
564 the Evennia log dir.
565 offset (int): The line offset *from the end of the file* to start
566 reading from. 0 means to start at the latest entry.
567 nlines (int): How many lines to return, counting backwards
568 from the offset. If file is shorter, will get all lines.
569 callback (callable, optional): A function to manage the result of the
570 asynchronous file access. This will get a list of lines. If unset,
571 the tail will happen synchronously.
572
573 Returns:
574 lines (deferred or list): This will be a deferred if `callable` is given,
575 otherwise it will be a list with The nline entries from the end of the file, or
576 all if the file is shorter than nlines.
577
578 """
579
580 def seek_file(filehandle, offset, nlines, callback):
581 """step backwards in chunks and stop only when we have enough lines"""
582 lines_found = []
583 buffer_size = 4098
584 block_count = -1
585 while len(lines_found) < (offset + nlines):
586 try:
587 # scan backwards in file, starting from the end
588 filehandle.seek(block_count * buffer_size, os.SEEK_END)
589 except IOError:
590 # file too small for this seek, take what we've got
591 filehandle.seek(0)
592 lines_found = filehandle.readlines()
593 break
594 lines_found = filehandle.readlines()
595 block_count -= 1
596 # return the right number of lines
597 lines_found = lines_found[-nlines - offset : -offset if offset else None]
598 if callback:
599 callback(lines_found)
600 return None
601 else:
602 return lines_found
603
604 def errback(failure):
605 """Catching errors to normal log"""
606 log_trace()
607
608 filehandle = _open_log_file(filename)
609 if filehandle:
610 if callback:
611 return deferToThread(seek_file, filehandle, offset, nlines, callback).addErrback(
612 errback
613 )
614 else:
615 return seek_file(filehandle, offset, nlines, callback)
616 else:
617 return None
618
```
--- 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/evennia/utils/logger.py b/evennia/utils/logger.py
--- a/evennia/utils/logger.py
+++ b/evennia/utils/logger.py
@@ -351,7 +351,7 @@
def rotate(self):
try:
- self.rotate()
+ super().rotate()
except Exception:
log_trace(f"Could not rotate the log file {self.name}.")
| {"golden_diff": "diff --git a/evennia/utils/logger.py b/evennia/utils/logger.py\n--- a/evennia/utils/logger.py\n+++ b/evennia/utils/logger.py\n@@ -351,7 +351,7 @@\n \n def rotate(self):\n try:\n- self.rotate()\n+ super().rotate()\n except Exception:\n log_trace(f\"Could not rotate the log file {self.name}.\")\n", "issue": "[BUG - Develop] Log rotation infinite-loops\n#### Describe the bug\r\nMy log file reached the maximum size and when trying to rotate, it hits an infinite loop.\r\n\r\nhttps://github.com/evennia/evennia/blob/3992f37dada8ae9d495b7bdc087ff107e21e29aa/evennia/utils/logger.py#L352-L354\r\n\r\nI think maybe it's supposed to be `super().rotate()` instead of `self.rotate()`?\r\n\r\n#### Develop-branch commit\r\n3992f37da\n", "before_files": [{"content": "\"\"\"\nLogging facilities\n\nThese are thin wrappers on top of Twisted's logging facilities; logs\nare all directed either to stdout (if Evennia is running in\ninteractive mode) or to $GAME_DIR/server/logs.\n\nThe log_file() function uses its own threading system to log to\narbitrary files in $GAME_DIR/server/logs.\n\nNote: All logging functions have two aliases, log_type() and\nlog_typemsg(). This is for historical, back-compatible reasons.\n\n\"\"\"\n\n\nimport os\nimport time\nfrom datetime import datetime\nfrom traceback import format_exc\n\nfrom twisted import logger as twisted_logger\nfrom twisted.internet.threads import deferToThread\nfrom twisted.python import logfile\nfrom twisted.python import util as twisted_util\n\nlog = twisted_logger.Logger()\n\n_LOGDIR = None\n_LOG_ROTATE_SIZE = None\n_TIMEZONE = None\n_CHANNEL_LOG_NUM_TAIL_LINES = None\n\n_TIME_FORMAT = \"%Y-%m-%d %H:%M:%S\"\n\n\ndef _log(msg, logfunc, prefix=\"\", **kwargs):\n try:\n msg = str(msg)\n except Exception as err:\n msg = str(e)\n if kwargs:\n logfunc(msg, **kwargs)\n else:\n try:\n for line in msg.splitlines():\n logfunc(\"{line}\", prefix=prefix, line=line)\n except Exception as err:\n log.error(\"Log failure: {err}\", err=err)\n\n\n# log call functions (each has legacy aliases)\n\n\ndef log_info(msg, **kwargs):\n \"\"\"\n Logs any generic debugging/informative info that should appear in the log.\n\n Args:\n msg: (string) The message to be logged.\n **kwargs: If given, The `msg` is parsed as a format string with `{..}`\n formatting markers that should match the keywords.\n\n \"\"\"\n _log(msg, log.info, **kwargs)\n\n\ninfo = log_info\nlog_infomsg = log_info\nlog_msg = log_info\n\n\ndef log_warn(msg, **kwargs):\n \"\"\"\n Logs warnings that aren't critical but should be noted.\n\n Args:\n msg (str): The message to be logged.\n **kwargs: If given, The `msg` is parsed as a format string with `{..}`\n formatting markers that should match the keywords.\n\n \"\"\"\n _log(msg, log.warn, **kwargs)\n\n\nwarn = log_warn\nwarning = log_warn\nlog_warnmsg = log_warn\n\n\ndef log_err(msg, **kwargs):\n \"\"\"\n Logs an error message to the server log.\n\n Args:\n msg (str): The message to be logged.\n **kwargs: If given, The `msg` is parsed as a format string with `{..}`\n formatting markers that should match the keywords.\n\n \"\"\"\n _log(msg, log.error, **kwargs)\n\n\nerror = log_err\nerr = log_err\nlog_errmsg = log_err\n\n\ndef log_trace(msg=None, **kwargs):\n \"\"\"\n Log a traceback to the log. This should be called from within an\n exception.\n\n Args:\n msg (str, optional): Adds an extra line with added info\n at the end of the traceback in the log.\n **kwargs: If given, The `msg` is parsed as a format string with `{..}`\n formatting markers that should match the keywords.\n\n \"\"\"\n tracestring = format_exc()\n if tracestring:\n _log(tracestring, log.error, prefix=\"!!\", **kwargs)\n if msg:\n _log(msg, log.error, prefix=\"!!\", **kwargs)\n\n\nlog_tracemsg = log_trace\nexception = log_trace\ncritical = log_trace\ntrace = log_trace\n\n\ndef log_dep(msg, **kwargs):\n \"\"\"\n Prints a deprecation message.\n\n Args:\n msg (str): The deprecation message to log.\n **kwargs: If given, The `msg` is parsed as a format string with `{..}`\n formatting markers that should match the keywords.\n\n \"\"\"\n _log(msg, log.warn, prefix=\"DP\", **kwargs)\n\n\ndep = log_dep\ndeprecated = log_dep\nlog_depmsg = log_dep\n\n\ndef log_sec(msg, **kwargs):\n \"\"\"\n Prints a security-related message.\n\n Args:\n msg (str): The security message to log.\n **kwargs: If given, The `msg` is parsed as a format string with `{..}`\n formatting markers that should match the keywords.\n\n \"\"\"\n _log(msg, log.info, prefix=\"SS\", **kwargs)\n\n\nsec = log_sec\nsecurity = log_sec\nlog_secmsg = log_sec\n\n\ndef log_server(msg, **kwargs):\n \"\"\"\n This is for the Portal to log captured Server stdout messages (it's\n usually only used during startup, before Server log is open)\n\n Args:\n msg (str): The message to be logged.\n **kwargs: If given, The `msg` is parsed as a format string with `{..}`\n formatting markers that should match the keywords.\n \"\"\"\n _log(msg, log.info, prefix=\"Server\", **kwargs)\n\n\nclass GetLogObserver:\n \"\"\"\n Sets up how the system logs are formatted.\n\n \"\"\"\n\n component_prefix = \"\"\n event_levels = {\n twisted_logger.LogLevel.debug: \"??\",\n twisted_logger.LogLevel.info: \"..\",\n twisted_logger.LogLevel.warn: \"WW\",\n twisted_logger.LogLevel.error: \"EE\",\n twisted_logger.LogLevel.critical: \"!!\",\n }\n\n def format_log_event(self, event):\n \"\"\"\n By assigning log_system here, we skip the spammy display of namespace/level\n in the default log output.\n\n [component_prefix] [date] [system/lvl] [msg]\n\n \"\"\"\n # setting log_system fills the [..] block after the time stamp\n prefix = event.get(\"prefix\", \"\")\n if prefix:\n event[\"log_system\"] = prefix\n else:\n lvl = event.get(\"log_level\", twisted_logger.LogLevel.info)\n event[\"log_system\"] = self.event_levels.get(lvl, \"-\")\n event[\"log_format\"] = str(event.get(\"log_format\", \"\"))\n component_prefix = self.component_prefix or \"\"\n log_msg = twisted_logger.formatEventAsClassicLogText(\n event, formatTime=lambda e: twisted_logger.formatTime(e, _TIME_FORMAT)\n )\n return f\"{component_prefix}{log_msg}\"\n\n def __call__(self, outfile):\n return twisted_logger.FileLogObserver(outfile, self.format_log_event)\n\n\n# Called by server/portal on startup\n\n\nclass GetPortalLogObserver(GetLogObserver):\n component_prefix = \"|Portal| \"\n\n\nclass GetServerLogObserver(GetLogObserver):\n component_prefix = \"\"\n\n\n# logging overrides\n\n\ndef timeformat(when=None):\n \"\"\"\n This helper function will format the current time in the same\n way as the twisted logger does, including time zone info. Only\n difference from official logger is that we only use two digits\n for the year and don't show timezone for GMT times.\n\n Args:\n when (int, optional): This is a time in POSIX seconds on the form\n given by time.time(). If not given, this function will\n use the current time.\n\n Returns:\n timestring (str): A formatted string of the given time.\n\n \"\"\"\n when = when if when else time.time()\n\n # time zone offset: UTC - the actual offset\n tz_offset = datetime.utcfromtimestamp(when) - datetime.fromtimestamp(when)\n tz_offset = tz_offset.days * 86400 + tz_offset.seconds\n # correct given time to utc\n when = datetime.utcfromtimestamp(when - tz_offset)\n\n if tz_offset == 0:\n tz = \"\"\n else:\n tz_hour = abs(int(tz_offset // 3600))\n tz_mins = abs(int(tz_offset // 60 % 60))\n tz_sign = \"-\" if tz_offset >= 0 else \"+\"\n tz = \"%s%02d%s\" % (tz_sign, tz_hour, (\":%02d\" % tz_mins if tz_mins else \"\"))\n\n return \"%d-%02d-%02d %02d:%02d:%02d%s\" % (\n when.year - 2000,\n when.month,\n when.day,\n when.hour,\n when.minute,\n when.second,\n tz,\n )\n\n\nclass WeeklyLogFile(logfile.DailyLogFile):\n \"\"\"\n Log file that rotates once per week by default. Overrides key methods to change format.\n\n \"\"\"\n\n def __init__(self, name, directory, defaultMode=None, day_rotation=7, max_size=1000000):\n \"\"\"\n Args:\n name (str): Name of log file.\n directory (str): Directory holding the file.\n defaultMode (str): Permissions used to create file. Defaults to\n current permissions of this file if it exists.\n day_rotation (int): How often to rotate the file.\n max_size (int): Max size of log file before rotation (regardless of\n time). Defaults to 1M.\n\n \"\"\"\n self.day_rotation = day_rotation\n self.max_size = max_size\n self.size = 0\n logfile.DailyLogFile.__init__(self, name, directory, defaultMode=defaultMode)\n\n def _openFile(self):\n logfile.DailyLogFile._openFile(self)\n self.size = self._file.tell()\n\n def shouldRotate(self):\n \"\"\"Rotate when the date has changed since last write\"\"\"\n # all dates here are tuples (year, month, day)\n now = self.toDate()\n then = self.lastDate\n return (\n now[0] > then[0]\n or now[1] > then[1]\n or now[2] > (then[2] + self.day_rotation)\n or self.size >= self.max_size\n )\n\n def suffix(self, tupledate):\n \"\"\"Return the suffix given a (year, month, day) tuple or unixtime.\n Format changed to have 03 for march instead of 3 etc (retaining unix\n file order)\n\n If we get duplicate suffixes in location (due to hitting size limit),\n we append __1, __2 etc.\n\n Examples:\n server.log.2020_01_29\n server.log.2020_01_29__1\n server.log.2020_01_29__2\n\n \"\"\"\n suffix = \"\"\n copy_suffix = 0\n while True:\n try:\n suffix = \"_\".join([\"{:02d}\".format(part) for part in tupledate])\n except Exception:\n # try taking a float unixtime\n suffix = \"_\".join([\"{:02d}\".format(part) for part in self.toDate(tupledate)])\n\n suffix += f\"__{copy_suffix}\" if copy_suffix else \"\"\n\n if os.path.exists(f\"{self.path}.{suffix}\"):\n # Append a higher copy_suffix to try to break the tie (starting from 2)\n copy_suffix += 1\n else:\n break\n return suffix\n\n def rotate(self):\n try:\n self.rotate()\n except Exception:\n log_trace(f\"Could not rotate the log file {self.name}.\")\n\n def write(self, data):\n \"\"\"\n Write data to log file\n\n \"\"\"\n logfile.BaseLogFile.write(self, data)\n self.lastDate = max(self.lastDate, self.toDate())\n self.size += len(data)\n\n\n# Arbitrary file logger\n\n\nclass EvenniaLogFile(logfile.LogFile):\n \"\"\"\n A rotating logfile based off Twisted's LogFile. It overrides\n the LogFile's rotate method in order to append some of the last\n lines of the previous log to the start of the new log, in order\n to preserve a continuous chat history for channel log files.\n\n \"\"\"\n\n # we delay import of settings to keep logger module as free\n # from django as possible.\n global _CHANNEL_LOG_NUM_TAIL_LINES\n if _CHANNEL_LOG_NUM_TAIL_LINES is None:\n from django.conf import settings\n\n _CHANNEL_LOG_NUM_TAIL_LINES = settings.CHANNEL_LOG_NUM_TAIL_LINES\n num_lines_to_append = _CHANNEL_LOG_NUM_TAIL_LINES\n\n def rotate(self, num_lines_to_append=None):\n \"\"\"\n Rotates our log file and appends some number of lines from\n the previous log to the start of the new one.\n\n \"\"\"\n append_tail = (\n num_lines_to_append if num_lines_to_append is not None else self.num_lines_to_append\n )\n if not append_tail:\n logfile.LogFile.rotate(self)\n return\n lines = tail_log_file(self.path, 0, self.num_lines_to_append)\n super().rotate()\n for line in lines:\n self.write(line)\n\n def seek(self, *args, **kwargs):\n \"\"\"\n Convenience method for accessing our _file attribute's seek method,\n which is used in tail_log_function.\n\n Args:\n *args: Same args as file.seek\n **kwargs: Same kwargs as file.seek\n\n \"\"\"\n return self._file.seek(*args, **kwargs)\n\n def readlines(self, *args, **kwargs):\n \"\"\"\n Convenience method for accessing our _file attribute's readlines method,\n which is used in tail_log_function.\n\n Args:\n *args: same args as file.readlines\n **kwargs: same kwargs as file.readlines\n\n Returns:\n lines (list): lines from our _file attribute.\n\n \"\"\"\n lines = []\n for line in self._file.readlines(*args, **kwargs):\n try:\n lines.append(line.decode(\"utf-8\"))\n except UnicodeDecodeError:\n try:\n lines.append(str(line))\n except Exception:\n lines.append(\"\")\n return lines\n\n\n_LOG_FILE_HANDLES = {} # holds open log handles\n_LOG_FILE_HANDLE_COUNTS = {}\n_LOG_FILE_HANDLE_RESET = 500\n\n\ndef _open_log_file(filename):\n \"\"\"\n Helper to open the log file (always in the log dir) and cache its\n handle. Will create a new file in the log dir if one didn't\n exist.\n\n To avoid keeping the filehandle open indefinitely we reset it every\n _LOG_FILE_HANDLE_RESET accesses. This may help resolve issues for very\n long uptimes and heavy log use.\n\n \"\"\"\n # we delay import of settings to keep logger module as free\n # from django as possible.\n global _LOG_FILE_HANDLES, _LOG_FILE_HANDLE_COUNTS, _LOGDIR, _LOG_ROTATE_SIZE\n if not _LOGDIR:\n from django.conf import settings\n\n _LOGDIR = settings.LOG_DIR\n _LOG_ROTATE_SIZE = settings.CHANNEL_LOG_ROTATE_SIZE\n\n filename = os.path.join(_LOGDIR, filename)\n if filename in _LOG_FILE_HANDLES:\n _LOG_FILE_HANDLE_COUNTS[filename] += 1\n if _LOG_FILE_HANDLE_COUNTS[filename] > _LOG_FILE_HANDLE_RESET:\n # close/refresh handle\n _LOG_FILE_HANDLES[filename].close()\n del _LOG_FILE_HANDLES[filename]\n else:\n # return cached handle\n return _LOG_FILE_HANDLES[filename]\n try:\n filehandle = EvenniaLogFile.fromFullPath(filename, rotateLength=_LOG_ROTATE_SIZE)\n # filehandle = open(filename, \"a+\") # append mode + reading\n _LOG_FILE_HANDLES[filename] = filehandle\n _LOG_FILE_HANDLE_COUNTS[filename] = 0\n return filehandle\n except IOError:\n log_trace()\n return None\n\n\ndef log_file(msg, filename=\"game.log\"):\n \"\"\"\n Arbitrary file logger using threads.\n\n Args:\n msg (str): String to append to logfile.\n filename (str, optional): Defaults to 'game.log'. All logs\n will appear in the logs directory and log entries will start\n on new lines following datetime info.\n\n \"\"\"\n\n def callback(filehandle, msg):\n \"\"\"Writing to file and flushing result\"\"\"\n msg = \"\\n%s [-] %s\" % (timeformat(), msg.strip())\n filehandle.write(msg)\n # since we don't close the handle, we need to flush\n # manually or log file won't be written to until the\n # write buffer is full.\n filehandle.flush()\n\n def errback(failure):\n \"\"\"Catching errors to normal log\"\"\"\n log_trace()\n\n # save to server/logs/ directory\n filehandle = _open_log_file(filename)\n if filehandle:\n deferToThread(callback, filehandle, msg).addErrback(errback)\n\n\ndef log_file_exists(filename=\"game.log\"):\n \"\"\"\n Determine if a log-file already exists.\n\n Args:\n filename (str): The filename (within the log-dir).\n\n Returns:\n bool: If the log file exists or not.\n\n \"\"\"\n global _LOGDIR\n if not _LOGDIR:\n from django.conf import settings\n\n _LOGDIR = settings.LOG_DIR\n\n filename = os.path.join(_LOGDIR, filename)\n return os.path.exists(filename)\n\n\ndef rotate_log_file(filename=\"game.log\", num_lines_to_append=None):\n \"\"\"\n Force-rotate a log-file, without\n\n Args:\n filename (str): The log file, located in settings.LOG_DIR.\n num_lines_to_append (int, optional): Include N number of\n lines from previous file in new one. If `None`, use default.\n Set to 0 to include no lines.\n\n \"\"\"\n if log_file_exists(filename):\n file_handle = _open_log_file(filename)\n if file_handle:\n file_handle.rotate(num_lines_to_append=num_lines_to_append)\n\n\ndef tail_log_file(filename, offset, nlines, callback=None):\n \"\"\"\n Return the tail of the log file.\n\n Args:\n filename (str): The name of the log file, presumed to be in\n the Evennia log dir.\n offset (int): The line offset *from the end of the file* to start\n reading from. 0 means to start at the latest entry.\n nlines (int): How many lines to return, counting backwards\n from the offset. If file is shorter, will get all lines.\n callback (callable, optional): A function to manage the result of the\n asynchronous file access. This will get a list of lines. If unset,\n the tail will happen synchronously.\n\n Returns:\n lines (deferred or list): This will be a deferred if `callable` is given,\n otherwise it will be a list with The nline entries from the end of the file, or\n all if the file is shorter than nlines.\n\n \"\"\"\n\n def seek_file(filehandle, offset, nlines, callback):\n \"\"\"step backwards in chunks and stop only when we have enough lines\"\"\"\n lines_found = []\n buffer_size = 4098\n block_count = -1\n while len(lines_found) < (offset + nlines):\n try:\n # scan backwards in file, starting from the end\n filehandle.seek(block_count * buffer_size, os.SEEK_END)\n except IOError:\n # file too small for this seek, take what we've got\n filehandle.seek(0)\n lines_found = filehandle.readlines()\n break\n lines_found = filehandle.readlines()\n block_count -= 1\n # return the right number of lines\n lines_found = lines_found[-nlines - offset : -offset if offset else None]\n if callback:\n callback(lines_found)\n return None\n else:\n return lines_found\n\n def errback(failure):\n \"\"\"Catching errors to normal log\"\"\"\n log_trace()\n\n filehandle = _open_log_file(filename)\n if filehandle:\n if callback:\n return deferToThread(seek_file, filehandle, offset, nlines, callback).addErrback(\n errback\n )\n else:\n return seek_file(filehandle, offset, nlines, callback)\n else:\n return None\n", "path": "evennia/utils/logger.py"}], "after_files": [{"content": "\"\"\"\nLogging facilities\n\nThese are thin wrappers on top of Twisted's logging facilities; logs\nare all directed either to stdout (if Evennia is running in\ninteractive mode) or to $GAME_DIR/server/logs.\n\nThe log_file() function uses its own threading system to log to\narbitrary files in $GAME_DIR/server/logs.\n\nNote: All logging functions have two aliases, log_type() and\nlog_typemsg(). This is for historical, back-compatible reasons.\n\n\"\"\"\n\n\nimport os\nimport time\nfrom datetime import datetime\nfrom traceback import format_exc\n\nfrom twisted import logger as twisted_logger\nfrom twisted.internet.threads import deferToThread\nfrom twisted.python import logfile\nfrom twisted.python import util as twisted_util\n\nlog = twisted_logger.Logger()\n\n_LOGDIR = None\n_LOG_ROTATE_SIZE = None\n_TIMEZONE = None\n_CHANNEL_LOG_NUM_TAIL_LINES = None\n\n_TIME_FORMAT = \"%Y-%m-%d %H:%M:%S\"\n\n\ndef _log(msg, logfunc, prefix=\"\", **kwargs):\n try:\n msg = str(msg)\n except Exception as err:\n msg = str(e)\n if kwargs:\n logfunc(msg, **kwargs)\n else:\n try:\n for line in msg.splitlines():\n logfunc(\"{line}\", prefix=prefix, line=line)\n except Exception as err:\n log.error(\"Log failure: {err}\", err=err)\n\n\n# log call functions (each has legacy aliases)\n\n\ndef log_info(msg, **kwargs):\n \"\"\"\n Logs any generic debugging/informative info that should appear in the log.\n\n Args:\n msg: (string) The message to be logged.\n **kwargs: If given, The `msg` is parsed as a format string with `{..}`\n formatting markers that should match the keywords.\n\n \"\"\"\n _log(msg, log.info, **kwargs)\n\n\ninfo = log_info\nlog_infomsg = log_info\nlog_msg = log_info\n\n\ndef log_warn(msg, **kwargs):\n \"\"\"\n Logs warnings that aren't critical but should be noted.\n\n Args:\n msg (str): The message to be logged.\n **kwargs: If given, The `msg` is parsed as a format string with `{..}`\n formatting markers that should match the keywords.\n\n \"\"\"\n _log(msg, log.warn, **kwargs)\n\n\nwarn = log_warn\nwarning = log_warn\nlog_warnmsg = log_warn\n\n\ndef log_err(msg, **kwargs):\n \"\"\"\n Logs an error message to the server log.\n\n Args:\n msg (str): The message to be logged.\n **kwargs: If given, The `msg` is parsed as a format string with `{..}`\n formatting markers that should match the keywords.\n\n \"\"\"\n _log(msg, log.error, **kwargs)\n\n\nerror = log_err\nerr = log_err\nlog_errmsg = log_err\n\n\ndef log_trace(msg=None, **kwargs):\n \"\"\"\n Log a traceback to the log. This should be called from within an\n exception.\n\n Args:\n msg (str, optional): Adds an extra line with added info\n at the end of the traceback in the log.\n **kwargs: If given, The `msg` is parsed as a format string with `{..}`\n formatting markers that should match the keywords.\n\n \"\"\"\n tracestring = format_exc()\n if tracestring:\n _log(tracestring, log.error, prefix=\"!!\", **kwargs)\n if msg:\n _log(msg, log.error, prefix=\"!!\", **kwargs)\n\n\nlog_tracemsg = log_trace\nexception = log_trace\ncritical = log_trace\ntrace = log_trace\n\n\ndef log_dep(msg, **kwargs):\n \"\"\"\n Prints a deprecation message.\n\n Args:\n msg (str): The deprecation message to log.\n **kwargs: If given, The `msg` is parsed as a format string with `{..}`\n formatting markers that should match the keywords.\n\n \"\"\"\n _log(msg, log.warn, prefix=\"DP\", **kwargs)\n\n\ndep = log_dep\ndeprecated = log_dep\nlog_depmsg = log_dep\n\n\ndef log_sec(msg, **kwargs):\n \"\"\"\n Prints a security-related message.\n\n Args:\n msg (str): The security message to log.\n **kwargs: If given, The `msg` is parsed as a format string with `{..}`\n formatting markers that should match the keywords.\n\n \"\"\"\n _log(msg, log.info, prefix=\"SS\", **kwargs)\n\n\nsec = log_sec\nsecurity = log_sec\nlog_secmsg = log_sec\n\n\ndef log_server(msg, **kwargs):\n \"\"\"\n This is for the Portal to log captured Server stdout messages (it's\n usually only used during startup, before Server log is open)\n\n Args:\n msg (str): The message to be logged.\n **kwargs: If given, The `msg` is parsed as a format string with `{..}`\n formatting markers that should match the keywords.\n \"\"\"\n _log(msg, log.info, prefix=\"Server\", **kwargs)\n\n\nclass GetLogObserver:\n \"\"\"\n Sets up how the system logs are formatted.\n\n \"\"\"\n\n component_prefix = \"\"\n event_levels = {\n twisted_logger.LogLevel.debug: \"??\",\n twisted_logger.LogLevel.info: \"..\",\n twisted_logger.LogLevel.warn: \"WW\",\n twisted_logger.LogLevel.error: \"EE\",\n twisted_logger.LogLevel.critical: \"!!\",\n }\n\n def format_log_event(self, event):\n \"\"\"\n By assigning log_system here, we skip the spammy display of namespace/level\n in the default log output.\n\n [component_prefix] [date] [system/lvl] [msg]\n\n \"\"\"\n # setting log_system fills the [..] block after the time stamp\n prefix = event.get(\"prefix\", \"\")\n if prefix:\n event[\"log_system\"] = prefix\n else:\n lvl = event.get(\"log_level\", twisted_logger.LogLevel.info)\n event[\"log_system\"] = self.event_levels.get(lvl, \"-\")\n event[\"log_format\"] = str(event.get(\"log_format\", \"\"))\n component_prefix = self.component_prefix or \"\"\n log_msg = twisted_logger.formatEventAsClassicLogText(\n event, formatTime=lambda e: twisted_logger.formatTime(e, _TIME_FORMAT)\n )\n return f\"{component_prefix}{log_msg}\"\n\n def __call__(self, outfile):\n return twisted_logger.FileLogObserver(outfile, self.format_log_event)\n\n\n# Called by server/portal on startup\n\n\nclass GetPortalLogObserver(GetLogObserver):\n component_prefix = \"|Portal| \"\n\n\nclass GetServerLogObserver(GetLogObserver):\n component_prefix = \"\"\n\n\n# logging overrides\n\n\ndef timeformat(when=None):\n \"\"\"\n This helper function will format the current time in the same\n way as the twisted logger does, including time zone info. Only\n difference from official logger is that we only use two digits\n for the year and don't show timezone for GMT times.\n\n Args:\n when (int, optional): This is a time in POSIX seconds on the form\n given by time.time(). If not given, this function will\n use the current time.\n\n Returns:\n timestring (str): A formatted string of the given time.\n\n \"\"\"\n when = when if when else time.time()\n\n # time zone offset: UTC - the actual offset\n tz_offset = datetime.utcfromtimestamp(when) - datetime.fromtimestamp(when)\n tz_offset = tz_offset.days * 86400 + tz_offset.seconds\n # correct given time to utc\n when = datetime.utcfromtimestamp(when - tz_offset)\n\n if tz_offset == 0:\n tz = \"\"\n else:\n tz_hour = abs(int(tz_offset // 3600))\n tz_mins = abs(int(tz_offset // 60 % 60))\n tz_sign = \"-\" if tz_offset >= 0 else \"+\"\n tz = \"%s%02d%s\" % (tz_sign, tz_hour, (\":%02d\" % tz_mins if tz_mins else \"\"))\n\n return \"%d-%02d-%02d %02d:%02d:%02d%s\" % (\n when.year - 2000,\n when.month,\n when.day,\n when.hour,\n when.minute,\n when.second,\n tz,\n )\n\n\nclass WeeklyLogFile(logfile.DailyLogFile):\n \"\"\"\n Log file that rotates once per week by default. Overrides key methods to change format.\n\n \"\"\"\n\n def __init__(self, name, directory, defaultMode=None, day_rotation=7, max_size=1000000):\n \"\"\"\n Args:\n name (str): Name of log file.\n directory (str): Directory holding the file.\n defaultMode (str): Permissions used to create file. Defaults to\n current permissions of this file if it exists.\n day_rotation (int): How often to rotate the file.\n max_size (int): Max size of log file before rotation (regardless of\n time). Defaults to 1M.\n\n \"\"\"\n self.day_rotation = day_rotation\n self.max_size = max_size\n self.size = 0\n logfile.DailyLogFile.__init__(self, name, directory, defaultMode=defaultMode)\n\n def _openFile(self):\n logfile.DailyLogFile._openFile(self)\n self.size = self._file.tell()\n\n def shouldRotate(self):\n \"\"\"Rotate when the date has changed since last write\"\"\"\n # all dates here are tuples (year, month, day)\n now = self.toDate()\n then = self.lastDate\n return (\n now[0] > then[0]\n or now[1] > then[1]\n or now[2] > (then[2] + self.day_rotation)\n or self.size >= self.max_size\n )\n\n def suffix(self, tupledate):\n \"\"\"Return the suffix given a (year, month, day) tuple or unixtime.\n Format changed to have 03 for march instead of 3 etc (retaining unix\n file order)\n\n If we get duplicate suffixes in location (due to hitting size limit),\n we append __1, __2 etc.\n\n Examples:\n server.log.2020_01_29\n server.log.2020_01_29__1\n server.log.2020_01_29__2\n\n \"\"\"\n suffix = \"\"\n copy_suffix = 0\n while True:\n try:\n suffix = \"_\".join([\"{:02d}\".format(part) for part in tupledate])\n except Exception:\n # try taking a float unixtime\n suffix = \"_\".join([\"{:02d}\".format(part) for part in self.toDate(tupledate)])\n\n suffix += f\"__{copy_suffix}\" if copy_suffix else \"\"\n\n if os.path.exists(f\"{self.path}.{suffix}\"):\n # Append a higher copy_suffix to try to break the tie (starting from 2)\n copy_suffix += 1\n else:\n break\n return suffix\n\n def rotate(self):\n try:\n super().rotate()\n except Exception:\n log_trace(f\"Could not rotate the log file {self.name}.\")\n\n def write(self, data):\n \"\"\"\n Write data to log file\n\n \"\"\"\n logfile.BaseLogFile.write(self, data)\n self.lastDate = max(self.lastDate, self.toDate())\n self.size += len(data)\n\n\n# Arbitrary file logger\n\n\nclass EvenniaLogFile(logfile.LogFile):\n \"\"\"\n A rotating logfile based off Twisted's LogFile. It overrides\n the LogFile's rotate method in order to append some of the last\n lines of the previous log to the start of the new log, in order\n to preserve a continuous chat history for channel log files.\n\n \"\"\"\n\n # we delay import of settings to keep logger module as free\n # from django as possible.\n global _CHANNEL_LOG_NUM_TAIL_LINES\n if _CHANNEL_LOG_NUM_TAIL_LINES is None:\n from django.conf import settings\n\n _CHANNEL_LOG_NUM_TAIL_LINES = settings.CHANNEL_LOG_NUM_TAIL_LINES\n num_lines_to_append = _CHANNEL_LOG_NUM_TAIL_LINES\n\n def rotate(self, num_lines_to_append=None):\n \"\"\"\n Rotates our log file and appends some number of lines from\n the previous log to the start of the new one.\n\n \"\"\"\n append_tail = (\n num_lines_to_append if num_lines_to_append is not None else self.num_lines_to_append\n )\n if not append_tail:\n logfile.LogFile.rotate(self)\n return\n lines = tail_log_file(self.path, 0, self.num_lines_to_append)\n super().rotate()\n for line in lines:\n self.write(line)\n\n def seek(self, *args, **kwargs):\n \"\"\"\n Convenience method for accessing our _file attribute's seek method,\n which is used in tail_log_function.\n\n Args:\n *args: Same args as file.seek\n **kwargs: Same kwargs as file.seek\n\n \"\"\"\n return self._file.seek(*args, **kwargs)\n\n def readlines(self, *args, **kwargs):\n \"\"\"\n Convenience method for accessing our _file attribute's readlines method,\n which is used in tail_log_function.\n\n Args:\n *args: same args as file.readlines\n **kwargs: same kwargs as file.readlines\n\n Returns:\n lines (list): lines from our _file attribute.\n\n \"\"\"\n lines = []\n for line in self._file.readlines(*args, **kwargs):\n try:\n lines.append(line.decode(\"utf-8\"))\n except UnicodeDecodeError:\n try:\n lines.append(str(line))\n except Exception:\n lines.append(\"\")\n return lines\n\n\n_LOG_FILE_HANDLES = {} # holds open log handles\n_LOG_FILE_HANDLE_COUNTS = {}\n_LOG_FILE_HANDLE_RESET = 500\n\n\ndef _open_log_file(filename):\n \"\"\"\n Helper to open the log file (always in the log dir) and cache its\n handle. Will create a new file in the log dir if one didn't\n exist.\n\n To avoid keeping the filehandle open indefinitely we reset it every\n _LOG_FILE_HANDLE_RESET accesses. This may help resolve issues for very\n long uptimes and heavy log use.\n\n \"\"\"\n # we delay import of settings to keep logger module as free\n # from django as possible.\n global _LOG_FILE_HANDLES, _LOG_FILE_HANDLE_COUNTS, _LOGDIR, _LOG_ROTATE_SIZE\n if not _LOGDIR:\n from django.conf import settings\n\n _LOGDIR = settings.LOG_DIR\n _LOG_ROTATE_SIZE = settings.CHANNEL_LOG_ROTATE_SIZE\n\n filename = os.path.join(_LOGDIR, filename)\n if filename in _LOG_FILE_HANDLES:\n _LOG_FILE_HANDLE_COUNTS[filename] += 1\n if _LOG_FILE_HANDLE_COUNTS[filename] > _LOG_FILE_HANDLE_RESET:\n # close/refresh handle\n _LOG_FILE_HANDLES[filename].close()\n del _LOG_FILE_HANDLES[filename]\n else:\n # return cached handle\n return _LOG_FILE_HANDLES[filename]\n try:\n filehandle = EvenniaLogFile.fromFullPath(filename, rotateLength=_LOG_ROTATE_SIZE)\n # filehandle = open(filename, \"a+\") # append mode + reading\n _LOG_FILE_HANDLES[filename] = filehandle\n _LOG_FILE_HANDLE_COUNTS[filename] = 0\n return filehandle\n except IOError:\n log_trace()\n return None\n\n\ndef log_file(msg, filename=\"game.log\"):\n \"\"\"\n Arbitrary file logger using threads.\n\n Args:\n msg (str): String to append to logfile.\n filename (str, optional): Defaults to 'game.log'. All logs\n will appear in the logs directory and log entries will start\n on new lines following datetime info.\n\n \"\"\"\n\n def callback(filehandle, msg):\n \"\"\"Writing to file and flushing result\"\"\"\n msg = \"\\n%s [-] %s\" % (timeformat(), msg.strip())\n filehandle.write(msg)\n # since we don't close the handle, we need to flush\n # manually or log file won't be written to until the\n # write buffer is full.\n filehandle.flush()\n\n def errback(failure):\n \"\"\"Catching errors to normal log\"\"\"\n log_trace()\n\n # save to server/logs/ directory\n filehandle = _open_log_file(filename)\n if filehandle:\n deferToThread(callback, filehandle, msg).addErrback(errback)\n\n\ndef log_file_exists(filename=\"game.log\"):\n \"\"\"\n Determine if a log-file already exists.\n\n Args:\n filename (str): The filename (within the log-dir).\n\n Returns:\n bool: If the log file exists or not.\n\n \"\"\"\n global _LOGDIR\n if not _LOGDIR:\n from django.conf import settings\n\n _LOGDIR = settings.LOG_DIR\n\n filename = os.path.join(_LOGDIR, filename)\n return os.path.exists(filename)\n\n\ndef rotate_log_file(filename=\"game.log\", num_lines_to_append=None):\n \"\"\"\n Force-rotate a log-file, without\n\n Args:\n filename (str): The log file, located in settings.LOG_DIR.\n num_lines_to_append (int, optional): Include N number of\n lines from previous file in new one. If `None`, use default.\n Set to 0 to include no lines.\n\n \"\"\"\n if log_file_exists(filename):\n file_handle = _open_log_file(filename)\n if file_handle:\n file_handle.rotate(num_lines_to_append=num_lines_to_append)\n\n\ndef tail_log_file(filename, offset, nlines, callback=None):\n \"\"\"\n Return the tail of the log file.\n\n Args:\n filename (str): The name of the log file, presumed to be in\n the Evennia log dir.\n offset (int): The line offset *from the end of the file* to start\n reading from. 0 means to start at the latest entry.\n nlines (int): How many lines to return, counting backwards\n from the offset. If file is shorter, will get all lines.\n callback (callable, optional): A function to manage the result of the\n asynchronous file access. This will get a list of lines. If unset,\n the tail will happen synchronously.\n\n Returns:\n lines (deferred or list): This will be a deferred if `callable` is given,\n otherwise it will be a list with The nline entries from the end of the file, or\n all if the file is shorter than nlines.\n\n \"\"\"\n\n def seek_file(filehandle, offset, nlines, callback):\n \"\"\"step backwards in chunks and stop only when we have enough lines\"\"\"\n lines_found = []\n buffer_size = 4098\n block_count = -1\n while len(lines_found) < (offset + nlines):\n try:\n # scan backwards in file, starting from the end\n filehandle.seek(block_count * buffer_size, os.SEEK_END)\n except IOError:\n # file too small for this seek, take what we've got\n filehandle.seek(0)\n lines_found = filehandle.readlines()\n break\n lines_found = filehandle.readlines()\n block_count -= 1\n # return the right number of lines\n lines_found = lines_found[-nlines - offset : -offset if offset else None]\n if callback:\n callback(lines_found)\n return None\n else:\n return lines_found\n\n def errback(failure):\n \"\"\"Catching errors to normal log\"\"\"\n log_trace()\n\n filehandle = _open_log_file(filename)\n if filehandle:\n if callback:\n return deferToThread(seek_file, filehandle, offset, nlines, callback).addErrback(\n errback\n )\n else:\n return seek_file(filehandle, offset, nlines, callback)\n else:\n return None\n", "path": "evennia/utils/logger.py"}]} |
gh_patches_debug_267 | rasdani/github-patches | git_diff | opsdroid__opsdroid-169 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
arrow dep missing
Fresh install of ubuntu 16.04
```
$ sudo apt update && sudo apt install python3-pip
...
$ pip3 install opsdroid
...
$ opsdroid
Traceback (most recent call last):
File "/home/ubuntu/.local/bin/opsdroid", line 7, in <module>
from opsdroid.__main__ import main
File "/home/ubuntu/.local/lib/python3.5/site-packages/opsdroid/__main__.py", line 8, in <module>
from opsdroid.core import OpsDroid
File "/home/ubuntu/.local/lib/python3.5/site-packages/opsdroid/core.py", line 15, in <module>
from opsdroid.parsers.crontab import parse_crontab
File "/home/ubuntu/.local/lib/python3.5/site-packages/opsdroid/parsers/crontab.py", line 6, in <module>
import arrow
ImportError: No module named 'arrow'
```
--- 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 python3
2 import os
3 from setuptools import setup, find_packages
4 from opsdroid.const import __version__
5
6 PACKAGE_NAME = 'opsdroid'
7 HERE = os.path.abspath(os.path.dirname(__file__))
8
9 PACKAGES = find_packages(exclude=['tests', 'tests.*', 'modules',
10 'modules.*', 'docs', 'docs.*'])
11
12 REQUIRES = [
13 'pyyaml>=3.11,<4',
14 'aiohttp>=1.2.0,<2',
15 'pycron>=0.40',
16 ]
17
18 setup(
19 name=PACKAGE_NAME,
20 version=__version__,
21 license='GNU GENERAL PUBLIC LICENSE V3',
22 url='',
23 download_url='',
24 author='Jacob Tomlinson',
25 author_email='[email protected]',
26 description='An open source chat-ops bot.',
27 packages=PACKAGES,
28 include_package_data=True,
29 zip_safe=False,
30 platforms='any',
31 install_requires=REQUIRES,
32 test_suite='tests',
33 keywords=['bot', 'chatops'],
34 entry_points={
35 'console_scripts': [
36 'opsdroid = opsdroid.__main__:main'
37 ]
38 },
39 )
40
```
--- 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
@@ -10,9 +10,10 @@
'modules.*', 'docs', 'docs.*'])
REQUIRES = [
- 'pyyaml>=3.11,<4',
- 'aiohttp>=1.2.0,<2',
- 'pycron>=0.40',
+ 'arrow==0.10.0',
+ 'aiohttp==2.1.0',
+ 'pycron==0.40',
+ 'pyyaml==3.12'
]
setup(
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -10,9 +10,10 @@\n 'modules.*', 'docs', 'docs.*'])\n \n REQUIRES = [\n- 'pyyaml>=3.11,<4',\n- 'aiohttp>=1.2.0,<2',\n- 'pycron>=0.40',\n+ 'arrow==0.10.0',\n+ 'aiohttp==2.1.0',\n+ 'pycron==0.40',\n+ 'pyyaml==3.12'\n ]\n \n setup(\n", "issue": "arrow dep missing\nFresh install of ubuntu 16.04\r\n\r\n```\r\n$ sudo apt update && sudo apt install python3-pip\r\n...\r\n$ pip3 install opsdroid\r\n...\r\n$ opsdroid\r\nTraceback (most recent call last):\r\n File \"/home/ubuntu/.local/bin/opsdroid\", line 7, in <module>\r\n from opsdroid.__main__ import main\r\n File \"/home/ubuntu/.local/lib/python3.5/site-packages/opsdroid/__main__.py\", line 8, in <module>\r\n from opsdroid.core import OpsDroid\r\n File \"/home/ubuntu/.local/lib/python3.5/site-packages/opsdroid/core.py\", line 15, in <module>\r\n from opsdroid.parsers.crontab import parse_crontab\r\n File \"/home/ubuntu/.local/lib/python3.5/site-packages/opsdroid/parsers/crontab.py\", line 6, in <module>\r\n import arrow\r\nImportError: No module named 'arrow'\r\n```\n", "before_files": [{"content": "#!/usr/bin/env python3\nimport os\nfrom setuptools import setup, find_packages\nfrom opsdroid.const import __version__\n\nPACKAGE_NAME = 'opsdroid'\nHERE = os.path.abspath(os.path.dirname(__file__))\n\nPACKAGES = find_packages(exclude=['tests', 'tests.*', 'modules',\n 'modules.*', 'docs', 'docs.*'])\n\nREQUIRES = [\n 'pyyaml>=3.11,<4',\n 'aiohttp>=1.2.0,<2',\n 'pycron>=0.40',\n]\n\nsetup(\n name=PACKAGE_NAME,\n version=__version__,\n license='GNU GENERAL PUBLIC LICENSE V3',\n url='',\n download_url='',\n author='Jacob Tomlinson',\n author_email='[email protected]',\n description='An open source chat-ops bot.',\n packages=PACKAGES,\n include_package_data=True,\n zip_safe=False,\n platforms='any',\n install_requires=REQUIRES,\n test_suite='tests',\n keywords=['bot', 'chatops'],\n entry_points={\n 'console_scripts': [\n 'opsdroid = opsdroid.__main__:main'\n ]\n },\n)\n", "path": "setup.py"}], "after_files": [{"content": "#!/usr/bin/env python3\nimport os\nfrom setuptools import setup, find_packages\nfrom opsdroid.const import __version__\n\nPACKAGE_NAME = 'opsdroid'\nHERE = os.path.abspath(os.path.dirname(__file__))\n\nPACKAGES = find_packages(exclude=['tests', 'tests.*', 'modules',\n 'modules.*', 'docs', 'docs.*'])\n\nREQUIRES = [\n 'arrow==0.10.0',\n 'aiohttp==2.1.0',\n 'pycron==0.40',\n 'pyyaml==3.12'\n]\n\nsetup(\n name=PACKAGE_NAME,\n version=__version__,\n license='GNU GENERAL PUBLIC LICENSE V3',\n url='',\n download_url='',\n author='Jacob Tomlinson',\n author_email='[email protected]',\n description='An open source chat-ops bot.',\n packages=PACKAGES,\n include_package_data=True,\n zip_safe=False,\n platforms='any',\n install_requires=REQUIRES,\n test_suite='tests',\n keywords=['bot', 'chatops'],\n entry_points={\n 'console_scripts': [\n 'opsdroid = opsdroid.__main__:main'\n ]\n },\n)\n", "path": "setup.py"}]} |
gh_patches_debug_268 | rasdani/github-patches | git_diff | nltk__nltk-1219 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Translation metrics in Python 2.7
The [CI Server](https://nltk.ci.cloudbees.com/job/nltk/TOXENV=py27-jenkins,jdk=jdk8latestOnlineInstall/lastCompletedBuild/testReport/) reports test failures for `nltk.translate.ribes_score.kendall_tau` and `nltk.translate.ribes_score.spearman_rho`.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `nltk/translate/ribes_score.py`
Content:
```
1 # -*- coding: utf-8 -*-
2 # Natural Language Toolkit: RIBES Score
3 #
4 # Copyright (C) 2001-2015 NLTK Project
5 # Contributors: Katsuhito Sudoh, Liling Tan, Kasramvd, J.F.Sebastian, Mark Byers, ekhumoro, P. Ortiz
6 # URL: <http://nltk.org/>
7 # For license information, see LICENSE.TXT
8 """ RIBES score implementation """
9
10 from itertools import islice
11 import math
12
13 from nltk.util import ngrams, choose
14
15
16 def ribes(references, hypothesis, alpha=0.25, beta=0.10):
17 """
18 The RIBES (Rank-based Intuitive Bilingual Evaluation Score) from
19 Hideki Isozaki, Tsutomu Hirao, Kevin Duh, Katsuhito Sudoh and
20 Hajime Tsukada. 2010. "Automatic Evaluation of Translation Quality for
21 Distant Language Pairs". In Proceedings of EMNLP.
22 http://www.aclweb.org/anthology/D/D10/D10-1092.pdf
23
24 The generic RIBES scores used in shared task, e.g. Workshop for
25 Asian Translation (WAT) uses the following RIBES calculations:
26
27 RIBES = kendall_tau * (alpha**p1) * (beta**bp)
28
29 Please note that this re-implementation differs from the official
30 RIBES implementation and though it emulates the results as describe
31 in the original paper, there are further optimization implemented
32 in the official RIBES script.
33
34 Users are encouraged to use the official RIBES script instead of this
35 implementation when evaluating your machine translation system. Refer
36 to http://www.kecl.ntt.co.jp/icl/lirg/ribes/ for the official script.
37
38 :param references: a list of reference sentences
39 :type reference: list(list(str))
40 :param hypothesis: a hypothesis sentence
41 :type hypothesis: list(str)
42 :param alpha: hyperparameter used as a prior for the unigram precision.
43 :type alpha: float
44 :param beta: hyperparameter used as a prior for the brevity penalty.
45 :type beta: float
46 :return: The best ribes score from one of the references.
47 :rtype: float
48 """
49 best_ribes = -1.0
50 # Calculates RIBES for each reference and returns the best score.
51 for reference in references:
52 # Collects the *worder* from the ranked correlation alignments.
53 worder = word_rank_alignment(reference, hypothesis)
54 nkt = kendall_tau(worder)
55
56 # Calculates the brevity penalty
57 bp = min(1.0, math.exp(1.0 - 1.0 * len(reference)/len(hypothesis)))
58
59 # Calculates the unigram precision, *p1*
60 p1 = 1.0 * len(worder) / len(hypothesis)
61
62 _ribes = nkt * (p1 ** alpha) * (bp ** beta)
63
64 if _ribes > best_ribes: # Keeps the best score.
65 best_ribes = _ribes
66
67 return best_ribes
68
69
70 def position_of_ngram(ngram, sentence):
71 """
72 This function returns the position of the first instance of the ngram
73 appearing in a sentence.
74
75 Note that one could also use string as follows but the code is a little
76 convoluted with type casting back and forth:
77
78 char_pos = ' '.join(sent)[:' '.join(sent).index(' '.join(ngram))]
79 word_pos = char_pos.count(' ')
80
81 Another way to conceive this is:
82
83 return next(i for i, ng in enumerate(ngrams(sentence, len(ngram)))
84 if ng == ngram)
85
86 :param ngram: The ngram that needs to be searched
87 :type ngram: tuple
88 :param sentence: The list of tokens to search from.
89 :type sentence: list(str)
90 """
91 # Iterates through the ngrams in sentence.
92 for i,sublist in enumerate(ngrams(sentence, len(ngram))):
93 # Returns the index of the word when ngram matches.
94 if ngram == sublist:
95 return i
96
97
98 def word_rank_alignment(reference, hypothesis, character_based=False):
99 """
100 This is the word rank alignment algorithm described in the paper to produce
101 the *worder* list, i.e. a list of word indices of the hypothesis word orders
102 w.r.t. the list of reference words.
103
104 Below is (H0, R0) example from the Isozaki et al. 2010 paper,
105 note the examples are indexed from 1 but the results here are indexed from 0:
106
107 >>> ref = str('he was interested in world history because he '
108 ... 'read the book').split()
109 >>> hyp = str('he read the book because he was interested in world '
110 ... 'history').split()
111 >>> word_rank_alignment(ref, hyp)
112 [7, 8, 9, 10, 6, 0, 1, 2, 3, 4, 5]
113
114 The (H1, R1) example from the paper, note the 0th index:
115
116 >>> ref = 'John hit Bob yesterday'.split()
117 >>> hyp = 'Bob hit John yesterday'.split()
118 >>> word_rank_alignment(ref, hyp)
119 [2, 1, 0, 3]
120
121 Here is the (H2, R2) example from the paper, note the 0th index here too:
122
123 >>> ref = 'the boy read the book'.split()
124 >>> hyp = 'the book was read by the boy'.split()
125 >>> word_rank_alignment(ref, hyp)
126 [3, 4, 2, 0, 1]
127
128 :param reference: a reference sentence
129 :type reference: list(str)
130 :param hypothesis: a hypothesis sentence
131 :type hypothesis: list(str)
132 """
133 worder = []
134 hyp_len = len(hypothesis)
135 # Stores a list of possible ngrams from the reference sentence.
136 # This is used for matching context window later in the algorithm.
137 ref_ngrams = []
138 hyp_ngrams = []
139 for n in range(1, len(reference)+1):
140 for ng in ngrams(reference, n):
141 ref_ngrams.append(ng)
142 for ng in ngrams(hypothesis, n):
143 hyp_ngrams.append(ng)
144 for i, h_word in enumerate(hypothesis):
145 # If word is not in the reference, continue.
146 if h_word not in reference:
147 continue
148 # If we can determine one-to-one word correspondence for unigrams that
149 # only appear once in both the reference and hypothesis.
150 elif hypothesis.count(h_word) == reference.count(h_word) == 1:
151 worder.append(reference.index(h_word))
152 else:
153 max_window_size = max(i, hyp_len-i+1)
154 for window in range(1, max_window_size):
155 if i+window < hyp_len: # If searching the right context is possible.
156 # Retrieve the right context window.
157 right_context_ngram = tuple(islice(hypothesis, i, i+window+1))
158 num_times_in_ref = ref_ngrams.count(right_context_ngram)
159 num_times_in_hyp = hyp_ngrams.count(right_context_ngram)
160 # If ngram appears only once in both ref and hyp.
161 if num_times_in_ref == num_times_in_hyp == 1:
162 # Find the position of ngram that matched the reference.
163 pos = position_of_ngram(right_context_ngram, reference)
164 worder.append(pos) # Add the positions of the ngram.
165 break
166 if window <= i: # If searching the left context is possible.
167 # Retrieve the left context window.
168 left_context_ngram = tuple(islice(hypothesis, i-window, i+1))
169 num_times_in_ref = ref_ngrams.count(left_context_ngram)
170 num_times_in_hyp = hyp_ngrams.count(left_context_ngram)
171 if num_times_in_ref == num_times_in_hyp == 1:
172 # Find the position of ngram that matched the reference.
173 pos = position_of_ngram(left_context_ngram, reference)
174 # Add the positions of the ngram.
175 worder.append(pos+ len(left_context_ngram) -1)
176 break
177 return worder
178
179
180 def find_increasing_sequences(worder):
181 """
182 Given the *worder* list, this function groups monotonic +1 sequences.
183
184 >>> worder = [7, 8, 9, 10, 6, 0, 1, 2, 3, 4, 5]
185 >>> list(find_increasing_sequences(worder))
186 [(7, 8, 9, 10), (0, 1, 2, 3, 4, 5)]
187
188 :param worder: The worder list output from word_rank_alignment
189 :param type: list(int)
190 """
191 items = iter(worder)
192 a, b = None, next(items, None)
193 result = [b]
194 while b is not None:
195 a, b = b, next(items, None)
196 if b is not None and a + 1 == b:
197 result.append(b)
198 else:
199 if len(result) > 1:
200 yield tuple(result)
201 result = [b]
202
203
204 def kendall_tau(worder, normalize=True):
205 """
206 Calculates the Kendall's Tau correlation coefficient given the *worder*
207 list of word alignments from word_rank_alignment(), using the formula:
208
209 tau = 2 * num_increasing_pairs / num_possible pairs -1
210
211 Note that the no. of increasing pairs can be discontinuous in the *worder*
212 list and each each increasing sequence can be tabulated as choose(len(seq), 2)
213 no. of increasing pairs, e.g.
214
215 >>> worder = [7, 8, 9, 10, 6, 0, 1, 2, 3, 4, 5]
216 >>> number_possible_pairs = choose(len(worder), 2)
217 >>> round(kendall_tau(worder, normalize=False),3)
218 -0.236
219 >>> round(kendall_tau(worder),3)
220 0.382
221
222 :param worder: The worder list output from word_rank_alignment
223 :type worder: list(int)
224 :param normalize: Flag to indicate normalization
225 :type normalize: boolean
226 :return: The Kendall's Tau correlation coefficient.
227 :rtype: float
228 """
229 worder_len = len(worder)
230 # Extract the groups of increasing/monotonic sequences.
231 increasing_sequences = find_increasing_sequences(worder)
232 # Calculate no. of increasing_pairs in *worder* list.
233 num_increasing_pairs = sum(choose(len(seq),2) for seq in increasing_sequences)
234 # Calculate no. of possible pairs.
235 num_possible_pairs = choose(worder_len, 2)
236 # Kendall's Tau computation.
237 tau = 2 * num_increasing_pairs / num_possible_pairs -1
238 if normalize: # If normalized, the tau output falls between 0.0 to 1.0
239 return (tau + 1) /2
240 else: # Otherwise, the tau outputs falls between -1.0 to +1.0
241 return tau
242
243
244 def spearman_rho(worder, normalize=True):
245 """
246 Calculates the Spearman's Rho correlation coefficient given the *worder*
247 list of word alignment from word_rank_alignment(), using the formula:
248
249 rho = 1 - sum(d**2) / choose(len(worder)+1, 3)
250
251 Given that d is the sum of difference between the *worder* list of indices
252 and the original word indices from the reference sentence.
253
254 Using the (H0,R0) and (H5, R5) example from the paper
255
256 >>> worder = [7, 8, 9, 10, 6, 0, 1, 2, 3, 4, 5]
257 >>> round(spearman_rho(worder, normalize=False), 3)
258 -0.591
259 >>> round(spearman_rho(worder), 3)
260 0.205
261
262 :param worder: The worder list output from word_rank_alignment
263 :param type: list(int)
264 """
265 worder_len = len(worder)
266 sum_d_square = sum((wi - i)**2 for wi, i in zip(worder, range(worder_len)))
267 rho = 1 - sum_d_square / choose(worder_len+1, 3)
268
269 if normalize: # If normalized, the rho output falls between 0.0 to 1.0
270 return (rho + 1) /2
271 else: # Otherwise, the rho outputs falls between -1.0 to +1.0
272 return rho
273
```
--- 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/nltk/translate/ribes_score.py b/nltk/translate/ribes_score.py
--- a/nltk/translate/ribes_score.py
+++ b/nltk/translate/ribes_score.py
@@ -6,7 +6,7 @@
# URL: <http://nltk.org/>
# For license information, see LICENSE.TXT
""" RIBES score implementation """
-
+from __future__ import division
from itertools import islice
import math
| {"golden_diff": "diff --git a/nltk/translate/ribes_score.py b/nltk/translate/ribes_score.py\n--- a/nltk/translate/ribes_score.py\n+++ b/nltk/translate/ribes_score.py\n@@ -6,7 +6,7 @@\n # URL: <http://nltk.org/>\n # For license information, see LICENSE.TXT\n \"\"\" RIBES score implementation \"\"\"\n-\n+from __future__ import division\n from itertools import islice\n import math\n", "issue": "Translation metrics in Python 2.7\nThe [CI Server](https://nltk.ci.cloudbees.com/job/nltk/TOXENV=py27-jenkins,jdk=jdk8latestOnlineInstall/lastCompletedBuild/testReport/) reports test failures for `nltk.translate.ribes_score.kendall_tau` and `nltk.translate.ribes_score.spearman_rho`.\n\n", "before_files": [{"content": "# -*- coding: utf-8 -*-\n# Natural Language Toolkit: RIBES Score\n#\n# Copyright (C) 2001-2015 NLTK Project\n# Contributors: Katsuhito Sudoh, Liling Tan, Kasramvd, J.F.Sebastian, Mark Byers, ekhumoro, P. Ortiz\n# URL: <http://nltk.org/>\n# For license information, see LICENSE.TXT\n\"\"\" RIBES score implementation \"\"\"\n\nfrom itertools import islice\nimport math\n\nfrom nltk.util import ngrams, choose\n\n\ndef ribes(references, hypothesis, alpha=0.25, beta=0.10):\n \"\"\"\n The RIBES (Rank-based Intuitive Bilingual Evaluation Score) from \n Hideki Isozaki, Tsutomu Hirao, Kevin Duh, Katsuhito Sudoh and \n Hajime Tsukada. 2010. \"Automatic Evaluation of Translation Quality for \n Distant Language Pairs\". In Proceedings of EMNLP. \n http://www.aclweb.org/anthology/D/D10/D10-1092.pdf \n \n The generic RIBES scores used in shared task, e.g. Workshop for \n Asian Translation (WAT) uses the following RIBES calculations:\n \n RIBES = kendall_tau * (alpha**p1) * (beta**bp)\n \n Please note that this re-implementation differs from the official\n RIBES implementation and though it emulates the results as describe\n in the original paper, there are further optimization implemented \n in the official RIBES script.\n \n Users are encouraged to use the official RIBES script instead of this \n implementation when evaluating your machine translation system. Refer\n to http://www.kecl.ntt.co.jp/icl/lirg/ribes/ for the official script.\n \n :param references: a list of reference sentences\n :type reference: list(list(str))\n :param hypothesis: a hypothesis sentence\n :type hypothesis: list(str)\n :param alpha: hyperparameter used as a prior for the unigram precision.\n :type alpha: float\n :param beta: hyperparameter used as a prior for the brevity penalty.\n :type beta: float\n :return: The best ribes score from one of the references.\n :rtype: float\n \"\"\"\n best_ribes = -1.0\n # Calculates RIBES for each reference and returns the best score.\n for reference in references:\n # Collects the *worder* from the ranked correlation alignments.\n worder = word_rank_alignment(reference, hypothesis)\n nkt = kendall_tau(worder)\n \n # Calculates the brevity penalty\n bp = min(1.0, math.exp(1.0 - 1.0 * len(reference)/len(hypothesis)))\n \n # Calculates the unigram precision, *p1*\n p1 = 1.0 * len(worder) / len(hypothesis)\n \n _ribes = nkt * (p1 ** alpha) * (bp ** beta)\n \n if _ribes > best_ribes: # Keeps the best score.\n best_ribes = _ribes\n \n return best_ribes\n\n\ndef position_of_ngram(ngram, sentence):\n \"\"\"\n This function returns the position of the first instance of the ngram \n appearing in a sentence.\n \n Note that one could also use string as follows but the code is a little\n convoluted with type casting back and forth:\n \n char_pos = ' '.join(sent)[:' '.join(sent).index(' '.join(ngram))]\n word_pos = char_pos.count(' ')\n \n Another way to conceive this is:\n \n return next(i for i, ng in enumerate(ngrams(sentence, len(ngram))) \n if ng == ngram)\n \n :param ngram: The ngram that needs to be searched\n :type ngram: tuple\n :param sentence: The list of tokens to search from.\n :type sentence: list(str)\n \"\"\"\n # Iterates through the ngrams in sentence.\n for i,sublist in enumerate(ngrams(sentence, len(ngram))):\n # Returns the index of the word when ngram matches.\n if ngram == sublist:\n return i\n\n\ndef word_rank_alignment(reference, hypothesis, character_based=False):\n \"\"\" \n This is the word rank alignment algorithm described in the paper to produce\n the *worder* list, i.e. a list of word indices of the hypothesis word orders \n w.r.t. the list of reference words.\n \n Below is (H0, R0) example from the Isozaki et al. 2010 paper, \n note the examples are indexed from 1 but the results here are indexed from 0:\n \n >>> ref = str('he was interested in world history because he '\n ... 'read the book').split()\n >>> hyp = str('he read the book because he was interested in world '\n ... 'history').split()\n >>> word_rank_alignment(ref, hyp)\n [7, 8, 9, 10, 6, 0, 1, 2, 3, 4, 5]\n \n The (H1, R1) example from the paper, note the 0th index:\n \n >>> ref = 'John hit Bob yesterday'.split()\n >>> hyp = 'Bob hit John yesterday'.split()\n >>> word_rank_alignment(ref, hyp)\n [2, 1, 0, 3]\n\n Here is the (H2, R2) example from the paper, note the 0th index here too:\n \n >>> ref = 'the boy read the book'.split()\n >>> hyp = 'the book was read by the boy'.split()\n >>> word_rank_alignment(ref, hyp)\n [3, 4, 2, 0, 1]\n \n :param reference: a reference sentence\n :type reference: list(str)\n :param hypothesis: a hypothesis sentence\n :type hypothesis: list(str)\n \"\"\"\n worder = []\n hyp_len = len(hypothesis)\n # Stores a list of possible ngrams from the reference sentence.\n # This is used for matching context window later in the algorithm.\n ref_ngrams = []\n hyp_ngrams = []\n for n in range(1, len(reference)+1):\n for ng in ngrams(reference, n):\n ref_ngrams.append(ng)\n for ng in ngrams(hypothesis, n):\n hyp_ngrams.append(ng)\n for i, h_word in enumerate(hypothesis):\n # If word is not in the reference, continue.\n if h_word not in reference:\n continue\n # If we can determine one-to-one word correspondence for unigrams that \n # only appear once in both the reference and hypothesis.\n elif hypothesis.count(h_word) == reference.count(h_word) == 1:\n worder.append(reference.index(h_word))\n else:\n max_window_size = max(i, hyp_len-i+1)\n for window in range(1, max_window_size):\n if i+window < hyp_len: # If searching the right context is possible.\n # Retrieve the right context window.\n right_context_ngram = tuple(islice(hypothesis, i, i+window+1))\n num_times_in_ref = ref_ngrams.count(right_context_ngram)\n num_times_in_hyp = hyp_ngrams.count(right_context_ngram) \n # If ngram appears only once in both ref and hyp.\n if num_times_in_ref == num_times_in_hyp == 1:\n # Find the position of ngram that matched the reference.\n pos = position_of_ngram(right_context_ngram, reference)\n worder.append(pos) # Add the positions of the ngram.\n break\n if window <= i: # If searching the left context is possible.\n # Retrieve the left context window.\n left_context_ngram = tuple(islice(hypothesis, i-window, i+1))\n num_times_in_ref = ref_ngrams.count(left_context_ngram)\n num_times_in_hyp = hyp_ngrams.count(left_context_ngram)\n if num_times_in_ref == num_times_in_hyp == 1:\n # Find the position of ngram that matched the reference.\n pos = position_of_ngram(left_context_ngram, reference)\n # Add the positions of the ngram.\n worder.append(pos+ len(left_context_ngram) -1) \n break\n return worder\n\n \ndef find_increasing_sequences(worder):\n \"\"\"\n Given the *worder* list, this function groups monotonic +1 sequences. \n \n >>> worder = [7, 8, 9, 10, 6, 0, 1, 2, 3, 4, 5]\n >>> list(find_increasing_sequences(worder))\n [(7, 8, 9, 10), (0, 1, 2, 3, 4, 5)]\n \n :param worder: The worder list output from word_rank_alignment\n :param type: list(int)\n \"\"\"\n items = iter(worder)\n a, b = None, next(items, None)\n result = [b]\n while b is not None:\n a, b = b, next(items, None)\n if b is not None and a + 1 == b:\n result.append(b)\n else:\n if len(result) > 1:\n yield tuple(result)\n result = [b]\n\n\ndef kendall_tau(worder, normalize=True):\n \"\"\"\n Calculates the Kendall's Tau correlation coefficient given the *worder*\n list of word alignments from word_rank_alignment(), using the formula:\n \n tau = 2 * num_increasing_pairs / num_possible pairs -1\n \n Note that the no. of increasing pairs can be discontinuous in the *worder*\n list and each each increasing sequence can be tabulated as choose(len(seq), 2) \n no. of increasing pairs, e.g.\n \n >>> worder = [7, 8, 9, 10, 6, 0, 1, 2, 3, 4, 5]\n >>> number_possible_pairs = choose(len(worder), 2)\n >>> round(kendall_tau(worder, normalize=False),3)\n -0.236\n >>> round(kendall_tau(worder),3)\n 0.382\n \n :param worder: The worder list output from word_rank_alignment\n :type worder: list(int)\n :param normalize: Flag to indicate normalization\n :type normalize: boolean\n :return: The Kendall's Tau correlation coefficient.\n :rtype: float\n \"\"\"\n worder_len = len(worder)\n # Extract the groups of increasing/monotonic sequences.\n increasing_sequences = find_increasing_sequences(worder)\n # Calculate no. of increasing_pairs in *worder* list.\n num_increasing_pairs = sum(choose(len(seq),2) for seq in increasing_sequences) \n # Calculate no. of possible pairs.\n num_possible_pairs = choose(worder_len, 2)\n # Kendall's Tau computation.\n tau = 2 * num_increasing_pairs / num_possible_pairs -1\n if normalize: # If normalized, the tau output falls between 0.0 to 1.0\n return (tau + 1) /2\n else: # Otherwise, the tau outputs falls between -1.0 to +1.0\n return tau\n\n\ndef spearman_rho(worder, normalize=True):\n \"\"\"\n Calculates the Spearman's Rho correlation coefficient given the *worder* \n list of word alignment from word_rank_alignment(), using the formula:\n \n rho = 1 - sum(d**2) / choose(len(worder)+1, 3) \n \n Given that d is the sum of difference between the *worder* list of indices\n and the original word indices from the reference sentence.\n \n Using the (H0,R0) and (H5, R5) example from the paper\n \n >>> worder = [7, 8, 9, 10, 6, 0, 1, 2, 3, 4, 5]\n >>> round(spearman_rho(worder, normalize=False), 3)\n -0.591\n >>> round(spearman_rho(worder), 3)\n 0.205\n \n :param worder: The worder list output from word_rank_alignment\n :param type: list(int)\n \"\"\"\n worder_len = len(worder)\n sum_d_square = sum((wi - i)**2 for wi, i in zip(worder, range(worder_len)))\n rho = 1 - sum_d_square / choose(worder_len+1, 3)\n \n if normalize: # If normalized, the rho output falls between 0.0 to 1.0\n return (rho + 1) /2\n else: # Otherwise, the rho outputs falls between -1.0 to +1.0\n return rho\n", "path": "nltk/translate/ribes_score.py"}], "after_files": [{"content": "# -*- coding: utf-8 -*-\n# Natural Language Toolkit: RIBES Score\n#\n# Copyright (C) 2001-2015 NLTK Project\n# Contributors: Katsuhito Sudoh, Liling Tan, Kasramvd, J.F.Sebastian, Mark Byers, ekhumoro, P. Ortiz\n# URL: <http://nltk.org/>\n# For license information, see LICENSE.TXT\n\"\"\" RIBES score implementation \"\"\"\nfrom __future__ import division\nfrom itertools import islice\nimport math\n\nfrom nltk.util import ngrams, choose\n\n\ndef ribes(references, hypothesis, alpha=0.25, beta=0.10):\n \"\"\"\n The RIBES (Rank-based Intuitive Bilingual Evaluation Score) from \n Hideki Isozaki, Tsutomu Hirao, Kevin Duh, Katsuhito Sudoh and \n Hajime Tsukada. 2010. \"Automatic Evaluation of Translation Quality for \n Distant Language Pairs\". In Proceedings of EMNLP. \n http://www.aclweb.org/anthology/D/D10/D10-1092.pdf \n \n The generic RIBES scores used in shared task, e.g. Workshop for \n Asian Translation (WAT) uses the following RIBES calculations:\n \n RIBES = kendall_tau * (alpha**p1) * (beta**bp)\n \n Please note that this re-implementation differs from the official\n RIBES implementation and though it emulates the results as describe\n in the original paper, there are further optimization implemented \n in the official RIBES script.\n \n Users are encouraged to use the official RIBES script instead of this \n implementation when evaluating your machine translation system. Refer\n to http://www.kecl.ntt.co.jp/icl/lirg/ribes/ for the official script.\n \n :param references: a list of reference sentences\n :type reference: list(list(str))\n :param hypothesis: a hypothesis sentence\n :type hypothesis: list(str)\n :param alpha: hyperparameter used as a prior for the unigram precision.\n :type alpha: float\n :param beta: hyperparameter used as a prior for the brevity penalty.\n :type beta: float\n :return: The best ribes score from one of the references.\n :rtype: float\n \"\"\"\n best_ribes = -1.0\n # Calculates RIBES for each reference and returns the best score.\n for reference in references:\n # Collects the *worder* from the ranked correlation alignments.\n worder = word_rank_alignment(reference, hypothesis)\n nkt = kendall_tau(worder)\n \n # Calculates the brevity penalty\n bp = min(1.0, math.exp(1.0 - 1.0 * len(reference)/len(hypothesis)))\n \n # Calculates the unigram precision, *p1*\n p1 = 1.0 * len(worder) / len(hypothesis)\n \n _ribes = nkt * (p1 ** alpha) * (bp ** beta)\n \n if _ribes > best_ribes: # Keeps the best score.\n best_ribes = _ribes\n \n return best_ribes\n\n\ndef position_of_ngram(ngram, sentence):\n \"\"\"\n This function returns the position of the first instance of the ngram \n appearing in a sentence.\n \n Note that one could also use string as follows but the code is a little\n convoluted with type casting back and forth:\n \n char_pos = ' '.join(sent)[:' '.join(sent).index(' '.join(ngram))]\n word_pos = char_pos.count(' ')\n \n Another way to conceive this is:\n \n return next(i for i, ng in enumerate(ngrams(sentence, len(ngram))) \n if ng == ngram)\n \n :param ngram: The ngram that needs to be searched\n :type ngram: tuple\n :param sentence: The list of tokens to search from.\n :type sentence: list(str)\n \"\"\"\n # Iterates through the ngrams in sentence.\n for i,sublist in enumerate(ngrams(sentence, len(ngram))):\n # Returns the index of the word when ngram matches.\n if ngram == sublist:\n return i\n\n\ndef word_rank_alignment(reference, hypothesis, character_based=False):\n \"\"\" \n This is the word rank alignment algorithm described in the paper to produce\n the *worder* list, i.e. a list of word indices of the hypothesis word orders \n w.r.t. the list of reference words.\n \n Below is (H0, R0) example from the Isozaki et al. 2010 paper, \n note the examples are indexed from 1 but the results here are indexed from 0:\n \n >>> ref = str('he was interested in world history because he '\n ... 'read the book').split()\n >>> hyp = str('he read the book because he was interested in world '\n ... 'history').split()\n >>> word_rank_alignment(ref, hyp)\n [7, 8, 9, 10, 6, 0, 1, 2, 3, 4, 5]\n \n The (H1, R1) example from the paper, note the 0th index:\n \n >>> ref = 'John hit Bob yesterday'.split()\n >>> hyp = 'Bob hit John yesterday'.split()\n >>> word_rank_alignment(ref, hyp)\n [2, 1, 0, 3]\n\n Here is the (H2, R2) example from the paper, note the 0th index here too:\n \n >>> ref = 'the boy read the book'.split()\n >>> hyp = 'the book was read by the boy'.split()\n >>> word_rank_alignment(ref, hyp)\n [3, 4, 2, 0, 1]\n \n :param reference: a reference sentence\n :type reference: list(str)\n :param hypothesis: a hypothesis sentence\n :type hypothesis: list(str)\n \"\"\"\n worder = []\n hyp_len = len(hypothesis)\n # Stores a list of possible ngrams from the reference sentence.\n # This is used for matching context window later in the algorithm.\n ref_ngrams = []\n hyp_ngrams = []\n for n in range(1, len(reference)+1):\n for ng in ngrams(reference, n):\n ref_ngrams.append(ng)\n for ng in ngrams(hypothesis, n):\n hyp_ngrams.append(ng)\n for i, h_word in enumerate(hypothesis):\n # If word is not in the reference, continue.\n if h_word not in reference:\n continue\n # If we can determine one-to-one word correspondence for unigrams that \n # only appear once in both the reference and hypothesis.\n elif hypothesis.count(h_word) == reference.count(h_word) == 1:\n worder.append(reference.index(h_word))\n else:\n max_window_size = max(i, hyp_len-i+1)\n for window in range(1, max_window_size):\n if i+window < hyp_len: # If searching the right context is possible.\n # Retrieve the right context window.\n right_context_ngram = tuple(islice(hypothesis, i, i+window+1))\n num_times_in_ref = ref_ngrams.count(right_context_ngram)\n num_times_in_hyp = hyp_ngrams.count(right_context_ngram) \n # If ngram appears only once in both ref and hyp.\n if num_times_in_ref == num_times_in_hyp == 1:\n # Find the position of ngram that matched the reference.\n pos = position_of_ngram(right_context_ngram, reference)\n worder.append(pos) # Add the positions of the ngram.\n break\n if window <= i: # If searching the left context is possible.\n # Retrieve the left context window.\n left_context_ngram = tuple(islice(hypothesis, i-window, i+1))\n num_times_in_ref = ref_ngrams.count(left_context_ngram)\n num_times_in_hyp = hyp_ngrams.count(left_context_ngram)\n if num_times_in_ref == num_times_in_hyp == 1:\n # Find the position of ngram that matched the reference.\n pos = position_of_ngram(left_context_ngram, reference)\n # Add the positions of the ngram.\n worder.append(pos+ len(left_context_ngram) -1) \n break\n return worder\n\n \ndef find_increasing_sequences(worder):\n \"\"\"\n Given the *worder* list, this function groups monotonic +1 sequences. \n \n >>> worder = [7, 8, 9, 10, 6, 0, 1, 2, 3, 4, 5]\n >>> list(find_increasing_sequences(worder))\n [(7, 8, 9, 10), (0, 1, 2, 3, 4, 5)]\n \n :param worder: The worder list output from word_rank_alignment\n :param type: list(int)\n \"\"\"\n items = iter(worder)\n a, b = None, next(items, None)\n result = [b]\n while b is not None:\n a, b = b, next(items, None)\n if b is not None and a + 1 == b:\n result.append(b)\n else:\n if len(result) > 1:\n yield tuple(result)\n result = [b]\n\n\ndef kendall_tau(worder, normalize=True):\n \"\"\"\n Calculates the Kendall's Tau correlation coefficient given the *worder*\n list of word alignments from word_rank_alignment(), using the formula:\n \n tau = 2 * num_increasing_pairs / num_possible pairs -1\n \n Note that the no. of increasing pairs can be discontinuous in the *worder*\n list and each each increasing sequence can be tabulated as choose(len(seq), 2) \n no. of increasing pairs, e.g.\n \n >>> worder = [7, 8, 9, 10, 6, 0, 1, 2, 3, 4, 5]\n >>> number_possible_pairs = choose(len(worder), 2)\n >>> round(kendall_tau(worder, normalize=False),3)\n -0.236\n >>> round(kendall_tau(worder),3)\n 0.382\n \n :param worder: The worder list output from word_rank_alignment\n :type worder: list(int)\n :param normalize: Flag to indicate normalization\n :type normalize: boolean\n :return: The Kendall's Tau correlation coefficient.\n :rtype: float\n \"\"\"\n worder_len = len(worder)\n # Extract the groups of increasing/monotonic sequences.\n increasing_sequences = find_increasing_sequences(worder)\n # Calculate no. of increasing_pairs in *worder* list.\n num_increasing_pairs = sum(choose(len(seq),2) for seq in increasing_sequences) \n # Calculate no. of possible pairs.\n num_possible_pairs = choose(worder_len, 2)\n # Kendall's Tau computation.\n tau = 2 * num_increasing_pairs / num_possible_pairs -1\n if normalize: # If normalized, the tau output falls between 0.0 to 1.0\n return (tau + 1) /2\n else: # Otherwise, the tau outputs falls between -1.0 to +1.0\n return tau\n\n\ndef spearman_rho(worder, normalize=True):\n \"\"\"\n Calculates the Spearman's Rho correlation coefficient given the *worder* \n list of word alignment from word_rank_alignment(), using the formula:\n \n rho = 1 - sum(d**2) / choose(len(worder)+1, 3) \n \n Given that d is the sum of difference between the *worder* list of indices\n and the original word indices from the reference sentence.\n \n Using the (H0,R0) and (H5, R5) example from the paper\n \n >>> worder = [7, 8, 9, 10, 6, 0, 1, 2, 3, 4, 5]\n >>> round(spearman_rho(worder, normalize=False), 3)\n -0.591\n >>> round(spearman_rho(worder), 3)\n 0.205\n \n :param worder: The worder list output from word_rank_alignment\n :param type: list(int)\n \"\"\"\n worder_len = len(worder)\n sum_d_square = sum((wi - i)**2 for wi, i in zip(worder, range(worder_len)))\n rho = 1 - sum_d_square / choose(worder_len+1, 3)\n \n if normalize: # If normalized, the rho output falls between 0.0 to 1.0\n return (rho + 1) /2\n else: # Otherwise, the rho outputs falls between -1.0 to +1.0\n return rho\n", "path": "nltk/translate/ribes_score.py"}]} |
gh_patches_debug_269 | rasdani/github-patches | git_diff | jupyterhub__zero-to-jupyterhub-k8s-373 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
build.py corrupts yaml
## Description
I ran into an issue with entries in values.yaml file after using the build.py script. My `extraVolume` entries were corrupted.
## Reproduction
```yaml
# create this file and name it values.yaml
root-1:
# offset=2 will indent the dash 2 spaces (default: 2)
# sequence=4 will indent indent-status-2 4 spaces and ignore what offset is used (default: 2)
- indent-status-1: ok
indent-status-2: bad after ./test.py runs
root-2:
# mapping=2 will indent the following entry 2 spaces (default: 2)
name: old-name
```
```python
# create this runnable.py file, and run it
import os
from ruamel.yaml import YAML
def main():
yaml = YAML()
yaml.indent(mapping=2, offset=2, sequence=4)
with open('values.yaml') as f:
values = yaml.load(f)
values['root-2'].update({'name': 'new-name'})
with open('values.yaml', 'w') as f:
yaml.dump(values, f)
main()
```
## Corrupt output
#### Look at `indent-status-2`, it has a indentation causing the yaml to become corrupt.
```yaml
# create this file and name it values.yaml
root-1:
# offset=2 will indent the dash 2 spaces (default: 2)
# sequence=4 will indent indent-status-2 4 spaces and ignore what offset is used (default: 2)
- indent-status-1: ok
indent-status-2: bad after ./test.py runs
root-2:
# mapping=2 will indent the following entry 2 spaces (default: 2)
name: new-name
```
build.py corrupts yaml
## Description
I ran into an issue with entries in values.yaml file after using the build.py script. My `extraVolume` entries were corrupted.
## Reproduction
```yaml
# create this file and name it values.yaml
root-1:
# offset=2 will indent the dash 2 spaces (default: 2)
# sequence=4 will indent indent-status-2 4 spaces and ignore what offset is used (default: 2)
- indent-status-1: ok
indent-status-2: bad after ./test.py runs
root-2:
# mapping=2 will indent the following entry 2 spaces (default: 2)
name: old-name
```
```python
# create this runnable.py file, and run it
import os
from ruamel.yaml import YAML
def main():
yaml = YAML()
yaml.indent(mapping=2, offset=2, sequence=4)
with open('values.yaml') as f:
values = yaml.load(f)
values['root-2'].update({'name': 'new-name'})
with open('values.yaml', 'w') as f:
yaml.dump(values, f)
main()
```
## Corrupt output
#### Look at `indent-status-2`, it has a indentation causing the yaml to become corrupt.
```yaml
# create this file and name it values.yaml
root-1:
# offset=2 will indent the dash 2 spaces (default: 2)
# sequence=4 will indent indent-status-2 4 spaces and ignore what offset is used (default: 2)
- indent-status-1: ok
indent-status-2: bad after ./test.py runs
root-2:
# mapping=2 will indent the following entry 2 spaces (default: 2)
name: new-name
```
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `build.py`
Content:
```
1 #!/usr/bin/env python3
2 import argparse
3 import os
4 import subprocess
5 import shutil
6 from tempfile import TemporaryDirectory
7
8 from ruamel.yaml import YAML
9
10 # use safe roundtrip yaml loader
11 yaml = YAML(typ='rt')
12 yaml.indent(offset=2)
13
14 def last_modified_commit(*paths, **kwargs):
15 return subprocess.check_output([
16 'git',
17 'log',
18 '-n', '1',
19 '--pretty=format:%h',
20 *paths
21 ], **kwargs).decode('utf-8')
22
23 def last_modified_date(*paths, **kwargs):
24 return subprocess.check_output([
25 'git',
26 'log',
27 '-n', '1',
28 '--pretty=format:%cd',
29 '--date=iso',
30 *paths
31 ], **kwargs).decode('utf-8')
32
33 def path_touched(*paths, commit_range):
34 return subprocess.check_output([
35 'git', 'diff', '--name-only', commit_range, *paths
36 ]).decode('utf-8').strip() != ''
37
38
39 def render_build_args(options, ns):
40 """Get docker build args dict, rendering any templated args."""
41 build_args = options.get('buildArgs', {})
42 for key, value in build_args.items():
43 build_args[key] = value.format(**ns)
44 return build_args
45
46 def build_image(image_path, image_spec, build_args):
47 cmd = ['docker', 'build', '-t', image_spec, image_path]
48
49 for k, v in build_args.items():
50 cmd += ['--build-arg', '{}={}'.format(k, v)]
51 subprocess.check_call(cmd)
52
53 def build_images(prefix, images, tag=None, commit_range=None, push=False):
54 value_modifications = {}
55 for name, options in images.items():
56 image_path = os.path.join('images', name)
57 paths = options.get('paths', []) + [image_path]
58 last_commit = last_modified_commit(*paths)
59 if tag is None:
60 tag = last_commit
61 image_name = prefix + name
62 image_spec = '{}:{}'.format(image_name, tag)
63 value_modifications[options['valuesPath']] = {
64 'name': image_name,
65 'tag': tag
66 }
67
68 if commit_range and not path_touched(*paths, commit_range=commit_range):
69 print(f"Skipping {name}, not touched in {commit_range}")
70 continue
71
72 template_namespace = {
73 'LAST_COMMIT': last_commit,
74 'TAG': tag,
75 }
76
77 build_args = render_build_args(options, template_namespace)
78 build_image(image_path, image_spec, build_args)
79
80 if push:
81 subprocess.check_call([
82 'docker', 'push', image_spec
83 ])
84 return value_modifications
85
86 def build_values(name, values_mods):
87 """Update name/values.yaml with modifications"""
88
89 values_file = os.path.join(name, 'values.yaml')
90
91 with open(values_file) as f:
92 values = yaml.load(f)
93
94 for key, value in values_mods.items():
95 parts = key.split('.')
96 mod_obj = values
97 for p in parts:
98 mod_obj = mod_obj[p]
99 mod_obj.update(value)
100
101
102 with open(values_file, 'w') as f:
103 yaml.dump(values, f)
104
105
106 def build_chart(name, version=None, paths=None):
107 """Update chart with specified version or last-modified commit in path(s)"""
108 chart_file = os.path.join(name, 'Chart.yaml')
109 with open(chart_file) as f:
110 chart = yaml.load(f)
111
112 if version is None:
113 if paths is None:
114 paths = ['.']
115 commit = last_modified_commit(*paths)
116 version = chart['version'].split('-')[0] + '-' + commit
117
118 chart['version'] = version
119
120 with open(chart_file, 'w') as f:
121 yaml.dump(chart, f)
122
123
124 def publish_pages(name, paths, git_repo, published_repo):
125 """publish helm chart index to github pages"""
126 version = last_modified_commit(*paths)
127 checkout_dir = '{}-{}'.format(name, version)
128 subprocess.check_call([
129 'git', 'clone', '--no-checkout',
130 '[email protected]:{}'.format(git_repo), checkout_dir],
131 )
132 subprocess.check_call(['git', 'checkout', 'gh-pages'], cwd=checkout_dir)
133
134 # package the latest version into a temporary directory
135 # and run helm repo index with --merge to update index.yaml
136 # without refreshing all of the timestamps
137 with TemporaryDirectory() as td:
138 subprocess.check_call([
139 'helm', 'package', name,
140 '--destination', td + '/',
141 ])
142
143 subprocess.check_call([
144 'helm', 'repo', 'index', td,
145 '--url', published_repo,
146 '--merge', os.path.join(checkout_dir, 'index.yaml'),
147 ])
148
149 # equivalent to `cp td/* checkout/`
150 # copies new helm chart and updated index.yaml
151 for f in os.listdir(td):
152 shutil.copy2(
153 os.path.join(td, f),
154 os.path.join(checkout_dir, f)
155 )
156 subprocess.check_call(['git', 'add', '.'], cwd=checkout_dir)
157 subprocess.check_call([
158 'git',
159 'commit',
160 '-m', '[{}] Automatic update for commit {}'.format(name, version)
161 ], cwd=checkout_dir)
162 subprocess.check_call(
163 ['git', 'push', 'origin', 'gh-pages'],
164 cwd=checkout_dir,
165 )
166
167
168 def main():
169 with open('chartpress.yaml') as f:
170 config = yaml.load(f)
171
172 argparser = argparse.ArgumentParser()
173
174 argparser.add_argument('--commit-range', help='Range of commits to consider when building images')
175 argparser.add_argument('--push', action='store_true')
176 argparser.add_argument('--publish-chart', action='store_true')
177 argparser.add_argument('--tag', default=None, help='Use this tag for images & charts')
178
179 args = argparser.parse_args()
180
181 for chart in config['charts']:
182 value_mods = build_images(chart['imagePrefix'], chart['images'], args.tag, args.commit_range, args.push)
183 build_values(chart['name'], value_mods)
184 chart_paths = ['.'] + chart.get('paths', [])
185 build_chart(chart['name'], paths=chart_paths, version=args.tag)
186 if args.publish_chart:
187 publish_pages(chart['name'],
188 paths=chart_paths,
189 git_repo=chart['repo']['git'],
190 published_repo=chart['repo']['published'],
191 )
192
193 main()
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/build.py b/build.py
--- a/build.py
+++ b/build.py
@@ -9,7 +9,7 @@
# use safe roundtrip yaml loader
yaml = YAML(typ='rt')
-yaml.indent(offset=2)
+yaml.indent(mapping=2, offset=2, sequence=4)
def last_modified_commit(*paths, **kwargs):
return subprocess.check_output([
| {"golden_diff": "diff --git a/build.py b/build.py\n--- a/build.py\n+++ b/build.py\n@@ -9,7 +9,7 @@\n \n # use safe roundtrip yaml loader\n yaml = YAML(typ='rt')\n-yaml.indent(offset=2)\n+yaml.indent(mapping=2, offset=2, sequence=4)\n \n def last_modified_commit(*paths, **kwargs):\n return subprocess.check_output([\n", "issue": "build.py corrupts yaml\n## Description\r\nI ran into an issue with entries in values.yaml file after using the build.py script. My `extraVolume` entries were corrupted.\r\n\r\n## Reproduction\r\n\r\n```yaml\r\n# create this file and name it values.yaml\r\nroot-1:\r\n # offset=2 will indent the dash 2 spaces (default: 2)\r\n # sequence=4 will indent indent-status-2 4 spaces and ignore what offset is used (default: 2)\r\n - indent-status-1: ok\r\n indent-status-2: bad after ./test.py runs\r\nroot-2:\r\n # mapping=2 will indent the following entry 2 spaces (default: 2)\r\n name: old-name\r\n```\r\n\r\n```python\r\n# create this runnable.py file, and run it\r\nimport os\r\nfrom ruamel.yaml import YAML\r\n\r\ndef main():\r\n yaml = YAML()\r\n yaml.indent(mapping=2, offset=2, sequence=4)\r\n\r\n with open('values.yaml') as f:\r\n values = yaml.load(f)\r\n\r\n values['root-2'].update({'name': 'new-name'})\r\n\r\n with open('values.yaml', 'w') as f:\r\n yaml.dump(values, f)\r\n\r\n\r\nmain()\r\n```\r\n\r\n## Corrupt output\r\n\r\n#### Look at `indent-status-2`, it has a indentation causing the yaml to become corrupt.\r\n```yaml\r\n# create this file and name it values.yaml\r\nroot-1:\r\n # offset=2 will indent the dash 2 spaces (default: 2)\r\n # sequence=4 will indent indent-status-2 4 spaces and ignore what offset is used (default: 2)\r\n - indent-status-1: ok\r\n indent-status-2: bad after ./test.py runs\r\nroot-2:\r\n # mapping=2 will indent the following entry 2 spaces (default: 2)\r\n name: new-name\r\n```\nbuild.py corrupts yaml\n## Description\r\nI ran into an issue with entries in values.yaml file after using the build.py script. My `extraVolume` entries were corrupted.\r\n\r\n## Reproduction\r\n\r\n```yaml\r\n# create this file and name it values.yaml\r\nroot-1:\r\n # offset=2 will indent the dash 2 spaces (default: 2)\r\n # sequence=4 will indent indent-status-2 4 spaces and ignore what offset is used (default: 2)\r\n - indent-status-1: ok\r\n indent-status-2: bad after ./test.py runs\r\nroot-2:\r\n # mapping=2 will indent the following entry 2 spaces (default: 2)\r\n name: old-name\r\n```\r\n\r\n```python\r\n# create this runnable.py file, and run it\r\nimport os\r\nfrom ruamel.yaml import YAML\r\n\r\ndef main():\r\n yaml = YAML()\r\n yaml.indent(mapping=2, offset=2, sequence=4)\r\n\r\n with open('values.yaml') as f:\r\n values = yaml.load(f)\r\n\r\n values['root-2'].update({'name': 'new-name'})\r\n\r\n with open('values.yaml', 'w') as f:\r\n yaml.dump(values, f)\r\n\r\n\r\nmain()\r\n```\r\n\r\n## Corrupt output\r\n\r\n#### Look at `indent-status-2`, it has a indentation causing the yaml to become corrupt.\r\n```yaml\r\n# create this file and name it values.yaml\r\nroot-1:\r\n # offset=2 will indent the dash 2 spaces (default: 2)\r\n # sequence=4 will indent indent-status-2 4 spaces and ignore what offset is used (default: 2)\r\n - indent-status-1: ok\r\n indent-status-2: bad after ./test.py runs\r\nroot-2:\r\n # mapping=2 will indent the following entry 2 spaces (default: 2)\r\n name: new-name\r\n```\n", "before_files": [{"content": "#!/usr/bin/env python3\nimport argparse\nimport os\nimport subprocess\nimport shutil\nfrom tempfile import TemporaryDirectory\n\nfrom ruamel.yaml import YAML\n\n# use safe roundtrip yaml loader\nyaml = YAML(typ='rt')\nyaml.indent(offset=2)\n\ndef last_modified_commit(*paths, **kwargs):\n return subprocess.check_output([\n 'git',\n 'log',\n '-n', '1',\n '--pretty=format:%h',\n *paths\n ], **kwargs).decode('utf-8')\n\ndef last_modified_date(*paths, **kwargs):\n return subprocess.check_output([\n 'git',\n 'log',\n '-n', '1',\n '--pretty=format:%cd',\n '--date=iso',\n *paths\n ], **kwargs).decode('utf-8')\n\ndef path_touched(*paths, commit_range):\n return subprocess.check_output([\n 'git', 'diff', '--name-only', commit_range, *paths\n ]).decode('utf-8').strip() != ''\n\n\ndef render_build_args(options, ns):\n \"\"\"Get docker build args dict, rendering any templated args.\"\"\"\n build_args = options.get('buildArgs', {})\n for key, value in build_args.items():\n build_args[key] = value.format(**ns)\n return build_args\n\ndef build_image(image_path, image_spec, build_args):\n cmd = ['docker', 'build', '-t', image_spec, image_path]\n\n for k, v in build_args.items():\n cmd += ['--build-arg', '{}={}'.format(k, v)]\n subprocess.check_call(cmd)\n\ndef build_images(prefix, images, tag=None, commit_range=None, push=False):\n value_modifications = {}\n for name, options in images.items():\n image_path = os.path.join('images', name)\n paths = options.get('paths', []) + [image_path]\n last_commit = last_modified_commit(*paths)\n if tag is None:\n tag = last_commit\n image_name = prefix + name\n image_spec = '{}:{}'.format(image_name, tag)\n value_modifications[options['valuesPath']] = {\n 'name': image_name,\n 'tag': tag\n }\n\n if commit_range and not path_touched(*paths, commit_range=commit_range):\n print(f\"Skipping {name}, not touched in {commit_range}\")\n continue\n\n template_namespace = {\n 'LAST_COMMIT': last_commit,\n 'TAG': tag,\n }\n\n build_args = render_build_args(options, template_namespace)\n build_image(image_path, image_spec, build_args)\n\n if push:\n subprocess.check_call([\n 'docker', 'push', image_spec\n ])\n return value_modifications\n\ndef build_values(name, values_mods):\n \"\"\"Update name/values.yaml with modifications\"\"\"\n\n values_file = os.path.join(name, 'values.yaml')\n\n with open(values_file) as f:\n values = yaml.load(f)\n\n for key, value in values_mods.items():\n parts = key.split('.')\n mod_obj = values\n for p in parts:\n mod_obj = mod_obj[p]\n mod_obj.update(value)\n\n\n with open(values_file, 'w') as f:\n yaml.dump(values, f)\n\n\ndef build_chart(name, version=None, paths=None):\n \"\"\"Update chart with specified version or last-modified commit in path(s)\"\"\"\n chart_file = os.path.join(name, 'Chart.yaml')\n with open(chart_file) as f:\n chart = yaml.load(f)\n\n if version is None:\n if paths is None:\n paths = ['.']\n commit = last_modified_commit(*paths)\n version = chart['version'].split('-')[0] + '-' + commit\n\n chart['version'] = version\n\n with open(chart_file, 'w') as f:\n yaml.dump(chart, f)\n\n\ndef publish_pages(name, paths, git_repo, published_repo):\n \"\"\"publish helm chart index to github pages\"\"\"\n version = last_modified_commit(*paths)\n checkout_dir = '{}-{}'.format(name, version)\n subprocess.check_call([\n 'git', 'clone', '--no-checkout',\n '[email protected]:{}'.format(git_repo), checkout_dir],\n )\n subprocess.check_call(['git', 'checkout', 'gh-pages'], cwd=checkout_dir)\n\n # package the latest version into a temporary directory\n # and run helm repo index with --merge to update index.yaml\n # without refreshing all of the timestamps\n with TemporaryDirectory() as td:\n subprocess.check_call([\n 'helm', 'package', name,\n '--destination', td + '/',\n ])\n\n subprocess.check_call([\n 'helm', 'repo', 'index', td,\n '--url', published_repo,\n '--merge', os.path.join(checkout_dir, 'index.yaml'),\n ])\n\n # equivalent to `cp td/* checkout/`\n # copies new helm chart and updated index.yaml\n for f in os.listdir(td):\n shutil.copy2(\n os.path.join(td, f),\n os.path.join(checkout_dir, f)\n )\n subprocess.check_call(['git', 'add', '.'], cwd=checkout_dir)\n subprocess.check_call([\n 'git',\n 'commit',\n '-m', '[{}] Automatic update for commit {}'.format(name, version)\n ], cwd=checkout_dir)\n subprocess.check_call(\n ['git', 'push', 'origin', 'gh-pages'],\n cwd=checkout_dir,\n )\n\n\ndef main():\n with open('chartpress.yaml') as f:\n config = yaml.load(f)\n\n argparser = argparse.ArgumentParser()\n\n argparser.add_argument('--commit-range', help='Range of commits to consider when building images')\n argparser.add_argument('--push', action='store_true')\n argparser.add_argument('--publish-chart', action='store_true')\n argparser.add_argument('--tag', default=None, help='Use this tag for images & charts')\n\n args = argparser.parse_args()\n\n for chart in config['charts']:\n value_mods = build_images(chart['imagePrefix'], chart['images'], args.tag, args.commit_range, args.push)\n build_values(chart['name'], value_mods)\n chart_paths = ['.'] + chart.get('paths', [])\n build_chart(chart['name'], paths=chart_paths, version=args.tag)\n if args.publish_chart:\n publish_pages(chart['name'],\n paths=chart_paths,\n git_repo=chart['repo']['git'],\n published_repo=chart['repo']['published'],\n )\n\nmain()\n", "path": "build.py"}], "after_files": [{"content": "#!/usr/bin/env python3\nimport argparse\nimport os\nimport subprocess\nimport shutil\nfrom tempfile import TemporaryDirectory\n\nfrom ruamel.yaml import YAML\n\n# use safe roundtrip yaml loader\nyaml = YAML(typ='rt')\nyaml.indent(mapping=2, offset=2, sequence=4)\n\ndef last_modified_commit(*paths, **kwargs):\n return subprocess.check_output([\n 'git',\n 'log',\n '-n', '1',\n '--pretty=format:%h',\n *paths\n ], **kwargs).decode('utf-8')\n\ndef last_modified_date(*paths, **kwargs):\n return subprocess.check_output([\n 'git',\n 'log',\n '-n', '1',\n '--pretty=format:%cd',\n '--date=iso',\n *paths\n ], **kwargs).decode('utf-8')\n\ndef path_touched(*paths, commit_range):\n return subprocess.check_output([\n 'git', 'diff', '--name-only', commit_range, *paths\n ]).decode('utf-8').strip() != ''\n\n\ndef render_build_args(options, ns):\n \"\"\"Get docker build args dict, rendering any templated args.\"\"\"\n build_args = options.get('buildArgs', {})\n for key, value in build_args.items():\n build_args[key] = value.format(**ns)\n return build_args\n\ndef build_image(image_path, image_spec, build_args):\n cmd = ['docker', 'build', '-t', image_spec, image_path]\n\n for k, v in build_args.items():\n cmd += ['--build-arg', '{}={}'.format(k, v)]\n subprocess.check_call(cmd)\n\ndef build_images(prefix, images, tag=None, commit_range=None, push=False):\n value_modifications = {}\n for name, options in images.items():\n image_path = os.path.join('images', name)\n paths = options.get('paths', []) + [image_path]\n last_commit = last_modified_commit(*paths)\n if tag is None:\n tag = last_commit\n image_name = prefix + name\n image_spec = '{}:{}'.format(image_name, tag)\n value_modifications[options['valuesPath']] = {\n 'name': image_name,\n 'tag': tag\n }\n\n if commit_range and not path_touched(*paths, commit_range=commit_range):\n print(f\"Skipping {name}, not touched in {commit_range}\")\n continue\n\n template_namespace = {\n 'LAST_COMMIT': last_commit,\n 'TAG': tag,\n }\n\n build_args = render_build_args(options, template_namespace)\n build_image(image_path, image_spec, build_args)\n\n if push:\n subprocess.check_call([\n 'docker', 'push', image_spec\n ])\n return value_modifications\n\ndef build_values(name, values_mods):\n \"\"\"Update name/values.yaml with modifications\"\"\"\n\n values_file = os.path.join(name, 'values.yaml')\n\n with open(values_file) as f:\n values = yaml.load(f)\n\n for key, value in values_mods.items():\n parts = key.split('.')\n mod_obj = values\n for p in parts:\n mod_obj = mod_obj[p]\n mod_obj.update(value)\n\n\n with open(values_file, 'w') as f:\n yaml.dump(values, f)\n\n\ndef build_chart(name, version=None, paths=None):\n \"\"\"Update chart with specified version or last-modified commit in path(s)\"\"\"\n chart_file = os.path.join(name, 'Chart.yaml')\n with open(chart_file) as f:\n chart = yaml.load(f)\n\n if version is None:\n if paths is None:\n paths = ['.']\n commit = last_modified_commit(*paths)\n version = chart['version'].split('-')[0] + '-' + commit\n\n chart['version'] = version\n\n with open(chart_file, 'w') as f:\n yaml.dump(chart, f)\n\n\ndef publish_pages(name, paths, git_repo, published_repo):\n \"\"\"publish helm chart index to github pages\"\"\"\n version = last_modified_commit(*paths)\n checkout_dir = '{}-{}'.format(name, version)\n subprocess.check_call([\n 'git', 'clone', '--no-checkout',\n '[email protected]:{}'.format(git_repo), checkout_dir],\n )\n subprocess.check_call(['git', 'checkout', 'gh-pages'], cwd=checkout_dir)\n\n # package the latest version into a temporary directory\n # and run helm repo index with --merge to update index.yaml\n # without refreshing all of the timestamps\n with TemporaryDirectory() as td:\n subprocess.check_call([\n 'helm', 'package', name,\n '--destination', td + '/',\n ])\n\n subprocess.check_call([\n 'helm', 'repo', 'index', td,\n '--url', published_repo,\n '--merge', os.path.join(checkout_dir, 'index.yaml'),\n ])\n\n # equivalent to `cp td/* checkout/`\n # copies new helm chart and updated index.yaml\n for f in os.listdir(td):\n shutil.copy2(\n os.path.join(td, f),\n os.path.join(checkout_dir, f)\n )\n subprocess.check_call(['git', 'add', '.'], cwd=checkout_dir)\n subprocess.check_call([\n 'git',\n 'commit',\n '-m', '[{}] Automatic update for commit {}'.format(name, version)\n ], cwd=checkout_dir)\n subprocess.check_call(\n ['git', 'push', 'origin', 'gh-pages'],\n cwd=checkout_dir,\n )\n\n\ndef main():\n with open('chartpress.yaml') as f:\n config = yaml.load(f)\n\n argparser = argparse.ArgumentParser()\n\n argparser.add_argument('--commit-range', help='Range of commits to consider when building images')\n argparser.add_argument('--push', action='store_true')\n argparser.add_argument('--publish-chart', action='store_true')\n argparser.add_argument('--tag', default=None, help='Use this tag for images & charts')\n\n args = argparser.parse_args()\n\n for chart in config['charts']:\n value_mods = build_images(chart['imagePrefix'], chart['images'], args.tag, args.commit_range, args.push)\n build_values(chart['name'], value_mods)\n chart_paths = ['.'] + chart.get('paths', [])\n build_chart(chart['name'], paths=chart_paths, version=args.tag)\n if args.publish_chart:\n publish_pages(chart['name'],\n paths=chart_paths,\n git_repo=chart['repo']['git'],\n published_repo=chart['repo']['published'],\n )\n\nmain()\n", "path": "build.py"}]} |
gh_patches_debug_270 | rasdani/github-patches | git_diff | arviz-devs__arviz-1403 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Error plotting a single variable with plot_density and bokeh backend
**Describe the bug**
Over in ArviZ.jl, we use the Julia equivalent to the below snippet to test Bokeh integration for `plot_density`. It worked fine until recently, where we now get an error with bokeh only but not matplotlib, though I'm not certain whether a change in arviz or bokeh is responsible.
**To Reproduce**
```python
>>> import arviz
>>> import numpy as np
>>> import matplotlib.pyplot as plt
>>> arr1 = np.random.randn(4, 100)
>>> arr2 = np.random.randn(4, 100)
>>> arviz.plot_density([{"x": arr1}, {"x": arr2}], var_names = ["x"]) # matplotlib works fine
>>> plt.show()
```
<img src=https://user-images.githubusercontent.com/8673634/94775414-9bce2480-0374-11eb-8938-f74a486f97de.png width=400></img>
```python
>>> arviz.plot_density([{"x": arr1}, {"x": arr2}], var_names = ["x"], backend="bokeh") # errors
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/Users/saxen/.julia/conda/3/lib/python3.8/site-packages/arviz/plots/densityplot.py", line 252, in plot_density
ax = plot(**plot_density_kwargs)
File "/Users/saxen/.julia/conda/3/lib/python3.8/site-packages/arviz/plots/backends/bokeh/densityplot.py", line 74, in plot_density
for label, ax_ in zip(all_labels, (item for item in ax.flatten() if item is not None))
AttributeError: 'Figure' object has no attribute 'flatten'
```
**Additional context**
Relevant package versions in the conda environment used:
```
arviz 0.10.0 py_0 conda-forge
bokeh 2.2.1 py38h32f6830_0 conda-forge
matplotlib 3.1.3 py38_0 conda-forge
numpy 1.19.1 py38h3b9f5b6_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: `arviz/plots/backends/bokeh/densityplot.py`
Content:
```
1 """Bokeh Densityplot."""
2 from collections import defaultdict
3 from itertools import cycle
4
5 import matplotlib.pyplot as plt
6 import numpy as np
7 from bokeh.models.annotations import Legend, Title
8
9 from ....stats import hdi
10 from ....stats.density_utils import get_bins, histogram, kde
11 from ...plot_utils import _scale_fig_size, calculate_point_estimate, make_label, vectorized_to_hex
12 from .. import show_layout
13 from . import backend_kwarg_defaults, create_axes_grid
14
15
16 def plot_density(
17 ax,
18 all_labels,
19 to_plot,
20 colors,
21 bw,
22 circular,
23 figsize,
24 length_plotters,
25 rows,
26 cols,
27 textsize,
28 hdi_prob,
29 point_estimate,
30 hdi_markers,
31 outline,
32 shade,
33 n_data,
34 data_labels,
35 backend_kwargs,
36 show,
37 ):
38 """Bokeh density plot."""
39 if backend_kwargs is None:
40 backend_kwargs = {}
41
42 backend_kwargs = {
43 **backend_kwarg_defaults(),
44 **backend_kwargs,
45 }
46
47 if colors == "cycle":
48 colors = [
49 prop
50 for _, prop in zip(
51 range(n_data), cycle(plt.rcParams["axes.prop_cycle"].by_key()["color"])
52 )
53 ]
54 elif isinstance(colors, str):
55 colors = [colors for _ in range(n_data)]
56 colors = vectorized_to_hex(colors)
57
58 (figsize, _, _, _, line_width, markersize) = _scale_fig_size(figsize, textsize, rows, cols)
59
60 if ax is None:
61 ax = create_axes_grid(
62 length_plotters,
63 rows,
64 cols,
65 figsize=figsize,
66 squeeze=True,
67 backend_kwargs=backend_kwargs,
68 )
69 else:
70 ax = np.atleast_2d(ax)
71
72 axis_map = {
73 label: ax_
74 for label, ax_ in zip(all_labels, (item for item in ax.flatten() if item is not None))
75 }
76 if data_labels is None:
77 data_labels = {}
78
79 legend_items = defaultdict(list)
80 for m_idx, plotters in enumerate(to_plot):
81 for var_name, selection, values in plotters:
82 label = make_label(var_name, selection)
83
84 if data_labels:
85 data_label = data_labels[m_idx]
86 else:
87 data_label = None
88
89 plotted = _d_helper(
90 values.flatten(),
91 label,
92 colors[m_idx],
93 bw,
94 circular,
95 line_width,
96 markersize,
97 hdi_prob,
98 point_estimate,
99 hdi_markers,
100 outline,
101 shade,
102 axis_map[label],
103 )
104 if data_label is not None:
105 legend_items[axis_map[label]].append((data_label, plotted))
106
107 for ax1, legend in legend_items.items():
108 legend = Legend(
109 items=legend,
110 location="center_right",
111 orientation="horizontal",
112 )
113 ax1.add_layout(legend, "above")
114 ax1.legend.click_policy = "hide"
115
116 show_layout(ax, show)
117
118 return ax
119
120
121 def _d_helper(
122 vec,
123 vname,
124 color,
125 bw,
126 circular,
127 line_width,
128 markersize,
129 hdi_prob,
130 point_estimate,
131 hdi_markers,
132 outline,
133 shade,
134 ax,
135 ):
136
137 extra = dict()
138 plotted = []
139
140 if vec.dtype.kind == "f":
141 if hdi_prob != 1:
142 hdi_ = hdi(vec, hdi_prob, multimodal=False)
143 new_vec = vec[(vec >= hdi_[0]) & (vec <= hdi_[1])]
144 else:
145 new_vec = vec
146
147 x, density = kde(new_vec, circular=circular, bw=bw)
148 density *= hdi_prob
149 xmin, xmax = x[0], x[-1]
150 ymin, ymax = density[0], density[-1]
151
152 if outline:
153 plotted.append(ax.line(x, density, line_color=color, line_width=line_width, **extra))
154 plotted.append(
155 ax.line(
156 [xmin, xmin],
157 [-ymin / 100, ymin],
158 line_color=color,
159 line_dash="solid",
160 line_width=line_width,
161 muted_color=color,
162 muted_alpha=0.2,
163 )
164 )
165 plotted.append(
166 ax.line(
167 [xmax, xmax],
168 [-ymax / 100, ymax],
169 line_color=color,
170 line_dash="solid",
171 line_width=line_width,
172 muted_color=color,
173 muted_alpha=0.2,
174 )
175 )
176
177 if shade:
178 plotted.append(
179 ax.patch(
180 np.r_[x[::-1], x, x[-1:]],
181 np.r_[np.zeros_like(x), density, [0]],
182 fill_color=color,
183 fill_alpha=shade,
184 muted_color=color,
185 muted_alpha=0.2,
186 **extra
187 )
188 )
189
190 else:
191 xmin, xmax = hdi(vec, hdi_prob, multimodal=False)
192 bins = get_bins(vec)
193
194 _, hist, edges = histogram(vec, bins=bins)
195
196 if outline:
197 plotted.append(
198 ax.quad(
199 top=hist,
200 bottom=0,
201 left=edges[:-1],
202 right=edges[1:],
203 line_color=color,
204 fill_color=None,
205 muted_color=color,
206 muted_alpha=0.2,
207 **extra
208 )
209 )
210 else:
211 plotted.append(
212 ax.quad(
213 top=hist,
214 bottom=0,
215 left=edges[:-1],
216 right=edges[1:],
217 line_color=color,
218 fill_color=color,
219 fill_alpha=shade,
220 muted_color=color,
221 muted_alpha=0.2,
222 **extra
223 )
224 )
225
226 if hdi_markers:
227 plotted.append(ax.diamond(xmin, 0, line_color="black", fill_color=color, size=markersize))
228 plotted.append(ax.diamond(xmax, 0, line_color="black", fill_color=color, size=markersize))
229
230 if point_estimate is not None:
231 est = calculate_point_estimate(point_estimate, vec, bw, circular)
232 plotted.append(ax.circle(est, 0, fill_color=color, line_color="black", size=markersize))
233
234 _title = Title()
235 _title.text = vname
236 ax.title = _title
237 ax.title.text_font_size = "13pt"
238
239 return plotted
240
```
--- 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/bokeh/densityplot.py b/arviz/plots/backends/bokeh/densityplot.py
--- a/arviz/plots/backends/bokeh/densityplot.py
+++ b/arviz/plots/backends/bokeh/densityplot.py
@@ -63,7 +63,7 @@
rows,
cols,
figsize=figsize,
- squeeze=True,
+ squeeze=False,
backend_kwargs=backend_kwargs,
)
else:
| {"golden_diff": "diff --git a/arviz/plots/backends/bokeh/densityplot.py b/arviz/plots/backends/bokeh/densityplot.py\n--- a/arviz/plots/backends/bokeh/densityplot.py\n+++ b/arviz/plots/backends/bokeh/densityplot.py\n@@ -63,7 +63,7 @@\n rows,\n cols,\n figsize=figsize,\n- squeeze=True,\n+ squeeze=False,\n backend_kwargs=backend_kwargs,\n )\n else:\n", "issue": "Error plotting a single variable with plot_density and bokeh backend\n**Describe the bug**\r\nOver in ArviZ.jl, we use the Julia equivalent to the below snippet to test Bokeh integration for `plot_density`. It worked fine until recently, where we now get an error with bokeh only but not matplotlib, though I'm not certain whether a change in arviz or bokeh is responsible.\r\n\r\n**To Reproduce**\r\n```python\r\n>>> import arviz\r\n>>> import numpy as np\r\n>>> import matplotlib.pyplot as plt\r\n>>> arr1 = np.random.randn(4, 100)\r\n>>> arr2 = np.random.randn(4, 100)\r\n>>> arviz.plot_density([{\"x\": arr1}, {\"x\": arr2}], var_names = [\"x\"]) # matplotlib works fine\r\n>>> plt.show()\r\n```\r\n<img src=https://user-images.githubusercontent.com/8673634/94775414-9bce2480-0374-11eb-8938-f74a486f97de.png width=400></img>\r\n```python\r\n>>> arviz.plot_density([{\"x\": arr1}, {\"x\": arr2}], var_names = [\"x\"], backend=\"bokeh\") # errors\r\nTraceback (most recent call last):\r\n File \"<stdin>\", line 1, in <module>\r\n File \"/Users/saxen/.julia/conda/3/lib/python3.8/site-packages/arviz/plots/densityplot.py\", line 252, in plot_density\r\n ax = plot(**plot_density_kwargs)\r\n File \"/Users/saxen/.julia/conda/3/lib/python3.8/site-packages/arviz/plots/backends/bokeh/densityplot.py\", line 74, in plot_density\r\n for label, ax_ in zip(all_labels, (item for item in ax.flatten() if item is not None))\r\nAttributeError: 'Figure' object has no attribute 'flatten'\r\n```\r\n\r\n**Additional context**\r\nRelevant package versions in the conda environment used:\r\n```\r\narviz 0.10.0 py_0 conda-forge\r\nbokeh 2.2.1 py38h32f6830_0 conda-forge\r\nmatplotlib 3.1.3 py38_0 conda-forge\r\nnumpy 1.19.1 py38h3b9f5b6_0 \r\n```\n", "before_files": [{"content": "\"\"\"Bokeh Densityplot.\"\"\"\nfrom collections import defaultdict\nfrom itertools import cycle\n\nimport matplotlib.pyplot as plt\nimport numpy as np\nfrom bokeh.models.annotations import Legend, Title\n\nfrom ....stats import hdi\nfrom ....stats.density_utils import get_bins, histogram, kde\nfrom ...plot_utils import _scale_fig_size, calculate_point_estimate, make_label, vectorized_to_hex\nfrom .. import show_layout\nfrom . import backend_kwarg_defaults, create_axes_grid\n\n\ndef plot_density(\n ax,\n all_labels,\n to_plot,\n colors,\n bw,\n circular,\n figsize,\n length_plotters,\n rows,\n cols,\n textsize,\n hdi_prob,\n point_estimate,\n hdi_markers,\n outline,\n shade,\n n_data,\n data_labels,\n backend_kwargs,\n show,\n):\n \"\"\"Bokeh density plot.\"\"\"\n if backend_kwargs is None:\n backend_kwargs = {}\n\n backend_kwargs = {\n **backend_kwarg_defaults(),\n **backend_kwargs,\n }\n\n if colors == \"cycle\":\n colors = [\n prop\n for _, prop in zip(\n range(n_data), cycle(plt.rcParams[\"axes.prop_cycle\"].by_key()[\"color\"])\n )\n ]\n elif isinstance(colors, str):\n colors = [colors for _ in range(n_data)]\n colors = vectorized_to_hex(colors)\n\n (figsize, _, _, _, line_width, markersize) = _scale_fig_size(figsize, textsize, rows, cols)\n\n if ax is None:\n ax = create_axes_grid(\n length_plotters,\n rows,\n cols,\n figsize=figsize,\n squeeze=True,\n backend_kwargs=backend_kwargs,\n )\n else:\n ax = np.atleast_2d(ax)\n\n axis_map = {\n label: ax_\n for label, ax_ in zip(all_labels, (item for item in ax.flatten() if item is not None))\n }\n if data_labels is None:\n data_labels = {}\n\n legend_items = defaultdict(list)\n for m_idx, plotters in enumerate(to_plot):\n for var_name, selection, values in plotters:\n label = make_label(var_name, selection)\n\n if data_labels:\n data_label = data_labels[m_idx]\n else:\n data_label = None\n\n plotted = _d_helper(\n values.flatten(),\n label,\n colors[m_idx],\n bw,\n circular,\n line_width,\n markersize,\n hdi_prob,\n point_estimate,\n hdi_markers,\n outline,\n shade,\n axis_map[label],\n )\n if data_label is not None:\n legend_items[axis_map[label]].append((data_label, plotted))\n\n for ax1, legend in legend_items.items():\n legend = Legend(\n items=legend,\n location=\"center_right\",\n orientation=\"horizontal\",\n )\n ax1.add_layout(legend, \"above\")\n ax1.legend.click_policy = \"hide\"\n\n show_layout(ax, show)\n\n return ax\n\n\ndef _d_helper(\n vec,\n vname,\n color,\n bw,\n circular,\n line_width,\n markersize,\n hdi_prob,\n point_estimate,\n hdi_markers,\n outline,\n shade,\n ax,\n):\n\n extra = dict()\n plotted = []\n\n if vec.dtype.kind == \"f\":\n if hdi_prob != 1:\n hdi_ = hdi(vec, hdi_prob, multimodal=False)\n new_vec = vec[(vec >= hdi_[0]) & (vec <= hdi_[1])]\n else:\n new_vec = vec\n\n x, density = kde(new_vec, circular=circular, bw=bw)\n density *= hdi_prob\n xmin, xmax = x[0], x[-1]\n ymin, ymax = density[0], density[-1]\n\n if outline:\n plotted.append(ax.line(x, density, line_color=color, line_width=line_width, **extra))\n plotted.append(\n ax.line(\n [xmin, xmin],\n [-ymin / 100, ymin],\n line_color=color,\n line_dash=\"solid\",\n line_width=line_width,\n muted_color=color,\n muted_alpha=0.2,\n )\n )\n plotted.append(\n ax.line(\n [xmax, xmax],\n [-ymax / 100, ymax],\n line_color=color,\n line_dash=\"solid\",\n line_width=line_width,\n muted_color=color,\n muted_alpha=0.2,\n )\n )\n\n if shade:\n plotted.append(\n ax.patch(\n np.r_[x[::-1], x, x[-1:]],\n np.r_[np.zeros_like(x), density, [0]],\n fill_color=color,\n fill_alpha=shade,\n muted_color=color,\n muted_alpha=0.2,\n **extra\n )\n )\n\n else:\n xmin, xmax = hdi(vec, hdi_prob, multimodal=False)\n bins = get_bins(vec)\n\n _, hist, edges = histogram(vec, bins=bins)\n\n if outline:\n plotted.append(\n ax.quad(\n top=hist,\n bottom=0,\n left=edges[:-1],\n right=edges[1:],\n line_color=color,\n fill_color=None,\n muted_color=color,\n muted_alpha=0.2,\n **extra\n )\n )\n else:\n plotted.append(\n ax.quad(\n top=hist,\n bottom=0,\n left=edges[:-1],\n right=edges[1:],\n line_color=color,\n fill_color=color,\n fill_alpha=shade,\n muted_color=color,\n muted_alpha=0.2,\n **extra\n )\n )\n\n if hdi_markers:\n plotted.append(ax.diamond(xmin, 0, line_color=\"black\", fill_color=color, size=markersize))\n plotted.append(ax.diamond(xmax, 0, line_color=\"black\", fill_color=color, size=markersize))\n\n if point_estimate is not None:\n est = calculate_point_estimate(point_estimate, vec, bw, circular)\n plotted.append(ax.circle(est, 0, fill_color=color, line_color=\"black\", size=markersize))\n\n _title = Title()\n _title.text = vname\n ax.title = _title\n ax.title.text_font_size = \"13pt\"\n\n return plotted\n", "path": "arviz/plots/backends/bokeh/densityplot.py"}], "after_files": [{"content": "\"\"\"Bokeh Densityplot.\"\"\"\nfrom collections import defaultdict\nfrom itertools import cycle\n\nimport matplotlib.pyplot as plt\nimport numpy as np\nfrom bokeh.models.annotations import Legend, Title\n\nfrom ....stats import hdi\nfrom ....stats.density_utils import get_bins, histogram, kde\nfrom ...plot_utils import _scale_fig_size, calculate_point_estimate, make_label, vectorized_to_hex\nfrom .. import show_layout\nfrom . import backend_kwarg_defaults, create_axes_grid\n\n\ndef plot_density(\n ax,\n all_labels,\n to_plot,\n colors,\n bw,\n circular,\n figsize,\n length_plotters,\n rows,\n cols,\n textsize,\n hdi_prob,\n point_estimate,\n hdi_markers,\n outline,\n shade,\n n_data,\n data_labels,\n backend_kwargs,\n show,\n):\n \"\"\"Bokeh density plot.\"\"\"\n if backend_kwargs is None:\n backend_kwargs = {}\n\n backend_kwargs = {\n **backend_kwarg_defaults(),\n **backend_kwargs,\n }\n\n if colors == \"cycle\":\n colors = [\n prop\n for _, prop in zip(\n range(n_data), cycle(plt.rcParams[\"axes.prop_cycle\"].by_key()[\"color\"])\n )\n ]\n elif isinstance(colors, str):\n colors = [colors for _ in range(n_data)]\n colors = vectorized_to_hex(colors)\n\n (figsize, _, _, _, line_width, markersize) = _scale_fig_size(figsize, textsize, rows, cols)\n\n if ax is None:\n ax = create_axes_grid(\n length_plotters,\n rows,\n cols,\n figsize=figsize,\n squeeze=False,\n backend_kwargs=backend_kwargs,\n )\n else:\n ax = np.atleast_2d(ax)\n\n axis_map = {\n label: ax_\n for label, ax_ in zip(all_labels, (item for item in ax.flatten() if item is not None))\n }\n if data_labels is None:\n data_labels = {}\n\n legend_items = defaultdict(list)\n for m_idx, plotters in enumerate(to_plot):\n for var_name, selection, values in plotters:\n label = make_label(var_name, selection)\n\n if data_labels:\n data_label = data_labels[m_idx]\n else:\n data_label = None\n\n plotted = _d_helper(\n values.flatten(),\n label,\n colors[m_idx],\n bw,\n circular,\n line_width,\n markersize,\n hdi_prob,\n point_estimate,\n hdi_markers,\n outline,\n shade,\n axis_map[label],\n )\n if data_label is not None:\n legend_items[axis_map[label]].append((data_label, plotted))\n\n for ax1, legend in legend_items.items():\n legend = Legend(\n items=legend,\n location=\"center_right\",\n orientation=\"horizontal\",\n )\n ax1.add_layout(legend, \"above\")\n ax1.legend.click_policy = \"hide\"\n\n show_layout(ax, show)\n\n return ax\n\n\ndef _d_helper(\n vec,\n vname,\n color,\n bw,\n circular,\n line_width,\n markersize,\n hdi_prob,\n point_estimate,\n hdi_markers,\n outline,\n shade,\n ax,\n):\n\n extra = dict()\n plotted = []\n\n if vec.dtype.kind == \"f\":\n if hdi_prob != 1:\n hdi_ = hdi(vec, hdi_prob, multimodal=False)\n new_vec = vec[(vec >= hdi_[0]) & (vec <= hdi_[1])]\n else:\n new_vec = vec\n\n x, density = kde(new_vec, circular=circular, bw=bw)\n density *= hdi_prob\n xmin, xmax = x[0], x[-1]\n ymin, ymax = density[0], density[-1]\n\n if outline:\n plotted.append(ax.line(x, density, line_color=color, line_width=line_width, **extra))\n plotted.append(\n ax.line(\n [xmin, xmin],\n [-ymin / 100, ymin],\n line_color=color,\n line_dash=\"solid\",\n line_width=line_width,\n muted_color=color,\n muted_alpha=0.2,\n )\n )\n plotted.append(\n ax.line(\n [xmax, xmax],\n [-ymax / 100, ymax],\n line_color=color,\n line_dash=\"solid\",\n line_width=line_width,\n muted_color=color,\n muted_alpha=0.2,\n )\n )\n\n if shade:\n plotted.append(\n ax.patch(\n np.r_[x[::-1], x, x[-1:]],\n np.r_[np.zeros_like(x), density, [0]],\n fill_color=color,\n fill_alpha=shade,\n muted_color=color,\n muted_alpha=0.2,\n **extra\n )\n )\n\n else:\n xmin, xmax = hdi(vec, hdi_prob, multimodal=False)\n bins = get_bins(vec)\n\n _, hist, edges = histogram(vec, bins=bins)\n\n if outline:\n plotted.append(\n ax.quad(\n top=hist,\n bottom=0,\n left=edges[:-1],\n right=edges[1:],\n line_color=color,\n fill_color=None,\n muted_color=color,\n muted_alpha=0.2,\n **extra\n )\n )\n else:\n plotted.append(\n ax.quad(\n top=hist,\n bottom=0,\n left=edges[:-1],\n right=edges[1:],\n line_color=color,\n fill_color=color,\n fill_alpha=shade,\n muted_color=color,\n muted_alpha=0.2,\n **extra\n )\n )\n\n if hdi_markers:\n plotted.append(ax.diamond(xmin, 0, line_color=\"black\", fill_color=color, size=markersize))\n plotted.append(ax.diamond(xmax, 0, line_color=\"black\", fill_color=color, size=markersize))\n\n if point_estimate is not None:\n est = calculate_point_estimate(point_estimate, vec, bw, circular)\n plotted.append(ax.circle(est, 0, fill_color=color, line_color=\"black\", size=markersize))\n\n _title = Title()\n _title.text = vname\n ax.title = _title\n ax.title.text_font_size = \"13pt\"\n\n return plotted\n", "path": "arviz/plots/backends/bokeh/densityplot.py"}]} |
gh_patches_debug_271 | rasdani/github-patches | git_diff | pytorch__ignite-773 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
progress bar output seems to be off
Soi I am using the Progressbar from the contrib module for indicating progress in the training loop. Currently the batch size is 1 for an exemplary dataset of 16 samples.
But for some reason the progressbar seems to skip the first step and I am not sure if this is due to an issue related to my dataloading or simply a displaying problem.
iter counter 0
Epoch [1/500]: [0/8] 0%| iter counter 1
Epoch [1/500]: [2/8] 25%| iter counter 2
Epoch [1/500]: [3/8] 38%| iter counter 3
Epoch [1/500]: [4/8] 50%| iter counter 4
Epoch [1/500]: [5/8] 62%| iter counter 5
Epoch [1/500]: [6/8] 75%|
iter counter 6
Epoch [1/500]: [7/8] 88%|
iter counter 7
Epoch [1/500]: [8/8] 100%|
is this a known problem or am I missing sth here? the iter counter is taken from the engine _run_once_on_dataset method
--- 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/contrib/handlers/tqdm_logger.py`
Content:
```
1 # -*- coding: utf-8 -*-
2 import warnings
3
4 import torch
5
6 from ignite.engine import Events
7 from ignite.engine.engine import EventWithFilter
8 from ignite.contrib.handlers.base_logger import BaseLogger, BaseOutputHandler
9
10
11 class ProgressBar(BaseLogger):
12 """
13 TQDM progress bar handler to log training progress and computed metrics.
14
15 Args:
16 persist (bool, optional): set to ``True`` to persist the progress bar after completion (default = ``False``)
17 bar_format (str, optional): Specify a custom bar string formatting. May impact performance.
18 [default: '{desc}[{n_fmt}/{total_fmt}] {percentage:3.0f}%|{bar}{postfix} [{elapsed}<{remaining}]'].
19 Set to ``None`` to use ``tqdm`` default bar formatting: '{l_bar}{bar}{r_bar}', where
20 l_bar='{desc}: {percentage:3.0f}%|' and
21 r_bar='| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, {rate_fmt}{postfix}]'. For more details on the
22 formatting, see `tqdm docs <https://tqdm.github.io/docs/tqdm/>`_.
23 **tqdm_kwargs: kwargs passed to tqdm progress bar.
24 By default, progress bar description displays "Epoch [5/10]" where 5 is the current epoch and 10 is the
25 number of epochs. If tqdm_kwargs defines `desc`, e.g. "Predictions", than the description is
26 "Predictions [5/10]" if number of epochs is more than one otherwise it is simply "Predictions".
27
28 Examples:
29
30 Simple progress bar
31
32 .. code-block:: python
33
34 trainer = create_supervised_trainer(model, optimizer, loss)
35
36 pbar = ProgressBar()
37 pbar.attach(trainer)
38
39 # Progress bar will looks like
40 # Epoch [2/50]: [64/128] 50%|█████ [06:17<12:34]
41
42 Log output to a file instead of stderr (tqdm's default output)
43
44 .. code-block:: python
45
46 trainer = create_supervised_trainer(model, optimizer, loss)
47
48 log_file = open("output.log", "w")
49 pbar = ProgressBar(file=log_file)
50 pbar.attach(trainer)
51
52 Attach metrics that already have been computed at :attr:`~ignite.engine.Events.ITERATION_COMPLETED`
53 (such as :class:`~ignite.metrics.RunningAverage`)
54
55 .. code-block:: python
56
57 trainer = create_supervised_trainer(model, optimizer, loss)
58
59 RunningAverage(output_transform=lambda x: x).attach(trainer, 'loss')
60
61 pbar = ProgressBar()
62 pbar.attach(trainer, ['loss'])
63
64 # Progress bar will looks like
65 # Epoch [2/50]: [64/128] 50%|█████ , loss=0.123 [06:17<12:34]
66
67 Directly attach the engine's output
68
69 .. code-block:: python
70
71 trainer = create_supervised_trainer(model, optimizer, loss)
72
73 pbar = ProgressBar()
74 pbar.attach(trainer, output_transform=lambda x: {'loss': x})
75
76 # Progress bar will looks like
77 # Epoch [2/50]: [64/128] 50%|█████ , loss=0.123 [06:17<12:34]
78
79 Note:
80 When adding attaching the progress bar to an engine, it is recommend that you replace
81 every print operation in the engine's handlers triggered every iteration with
82 ``pbar.log_message`` to guarantee the correct format of the stdout.
83
84 Note:
85 When using inside jupyter notebook, `ProgressBar` automatically uses `tqdm_notebook`. For correct rendering,
86 please install `ipywidgets <https://ipywidgets.readthedocs.io/en/stable/user_install.html#installation>`_.
87 Due to `tqdm notebook bugs <https://github.com/tqdm/tqdm/issues/594>`_, bar format may be needed to be set
88 to an empty string value.
89
90 """
91
92 _events_order = [
93 Events.STARTED,
94 Events.EPOCH_STARTED,
95 Events.ITERATION_STARTED,
96 Events.ITERATION_COMPLETED,
97 Events.EPOCH_COMPLETED,
98 Events.COMPLETED
99 ]
100
101 def __init__(self, persist=False,
102 bar_format='{desc}[{n_fmt}/{total_fmt}] {percentage:3.0f}%|{bar}{postfix} [{elapsed}<{remaining}]',
103 **tqdm_kwargs):
104
105 try:
106 from tqdm.autonotebook import tqdm
107 except ImportError:
108 raise RuntimeError("This contrib module requires tqdm to be installed. "
109 "Please install it with command: \n pip install tqdm")
110
111 self.pbar_cls = tqdm
112 self.pbar = None
113 self.persist = persist
114 self.bar_format = bar_format
115 self.tqdm_kwargs = tqdm_kwargs
116
117 def _reset(self, pbar_total):
118 self.pbar = self.pbar_cls(
119 total=pbar_total,
120 leave=self.persist,
121 bar_format=self.bar_format,
122 **self.tqdm_kwargs
123 )
124
125 def _close(self, engine):
126 if self.pbar:
127 self.pbar.close()
128 self.pbar = None
129
130 @staticmethod
131 def _compare_lt(event1, event2):
132 if isinstance(event1, EventWithFilter):
133 event1 = event1.event
134 if isinstance(event2, EventWithFilter):
135 event2 = event2.event
136 i1 = ProgressBar._events_order.index(event1)
137 i2 = ProgressBar._events_order.index(event2)
138 return i1 < i2
139
140 def log_message(self, message):
141 """
142 Logs a message, preserving the progress bar correct output format.
143
144 Args:
145 message (str): string you wish to log.
146 """
147 from tqdm import tqdm
148 tqdm.write(message, **self.tqdm_kwargs)
149
150 def attach(self, engine, metric_names=None, output_transform=None,
151 event_name=Events.ITERATION_COMPLETED,
152 closing_event_name=Events.EPOCH_COMPLETED):
153 """
154 Attaches the progress bar to an engine object.
155
156 Args:
157 engine (Engine): engine object.
158 metric_names (list of str, optional): list of metric names to plot or a string "all" to plot all available
159 metrics.
160 output_transform (callable, optional): a function to select what you want to print from the engine's
161 output. This function may return either a dictionary with entries in the format of ``{name: value}``,
162 or a single scalar, which will be displayed with the default name `output`.
163 event_name: event's name on which the progress bar advances. Valid events are from
164 :class:`~ignite.engine.Events`.
165 closing_event_name: event's name on which the progress bar is closed. Valid events are from
166 :class:`~ignite.engine.Events`.
167
168 Note: accepted output value types are numbers, 0d and 1d torch tensors and strings
169
170 """
171 desc = self.tqdm_kwargs.get("desc", "Epoch")
172
173 if not isinstance(event_name, (Events, EventWithFilter)):
174 raise ValueError("Logging event should be only `ignite.engine.Events`")
175
176 if isinstance(closing_event_name, EventWithFilter):
177 raise ValueError("Closing event should not use any event filter")
178
179 if not self._compare_lt(event_name, closing_event_name):
180 raise ValueError("Logging event {} should be called before closing event {}"
181 .format(event_name, closing_event_name))
182
183 log_handler = _OutputHandler(desc, metric_names, output_transform,
184 closing_event_name=closing_event_name)
185 # if event_name is EventWithFilter, filter is passed here
186 super(ProgressBar, self).attach(engine, log_handler, event_name)
187 engine.add_event_handler(closing_event_name, self._close)
188
189
190 class _OutputHandler(BaseOutputHandler):
191 """Helper handler to log engine's output and/or metrics
192
193 Args:
194 description (str): progress bar description.
195 metric_names (list of str, optional): list of metric names to plot or a string "all" to plot all available
196 metrics.
197 output_transform (callable, optional): output transform function to prepare `engine.state.output` as a number.
198 For example, `output_transform = lambda output: output`
199 This function can also return a dictionary, e.g `{'loss': loss1, 'another_loss': loss2}` to label the plot
200 with corresponding keys.
201 closing_event_name: event's name on which the progress bar is closed. Valid events are from
202 :class:`~ignite.engine.Events` or any `event_name` added by
203 :meth:`~ignite.engine.Engine.register_events`.
204
205 """
206
207 def __init__(self, description, metric_names=None, output_transform=None,
208 closing_event_name=Events.EPOCH_COMPLETED):
209 if metric_names is None and output_transform is None:
210 # This helps to avoid 'Either metric_names or output_transform should be defined' of BaseOutputHandler
211 metric_names = []
212 super(_OutputHandler, self).__init__(description, metric_names, output_transform,
213 another_engine=None, global_step_transform=None)
214 self.closing_event_name = closing_event_name
215
216 @staticmethod
217 def get_max_number_events(event_name, engine):
218 if event_name in (Events.ITERATION_STARTED, Events.ITERATION_COMPLETED):
219 return len(engine.state.dataloader)
220 if event_name in (Events.EPOCH_STARTED, Events.EPOCH_COMPLETED):
221 return engine.state.max_epochs
222 return 1
223
224 def __call__(self, engine, logger, event_name):
225
226 pbar_total = self.get_max_number_events(event_name, engine)
227 if logger.pbar is None:
228 logger._reset(pbar_total=pbar_total)
229
230 desc = self.tag
231 max_num_of_closing_events = self.get_max_number_events(self.closing_event_name, engine)
232 if max_num_of_closing_events > 1:
233 global_step = engine.state.get_event_attrib_value(self.closing_event_name)
234 desc += " [{}/{}]".format(global_step, max_num_of_closing_events)
235 logger.pbar.set_description(desc)
236
237 metrics = self._setup_output_metrics(engine)
238
239 rendered_metrics = {}
240 for key, value in metrics.items():
241 if isinstance(value, torch.Tensor):
242 if value.ndimension() == 0:
243 rendered_metrics[key] = value.item()
244 elif value.ndimension() == 1:
245 for i, v in enumerate(value):
246 k = "{}_{}".format(key, i)
247 rendered_metrics[k] = v.item()
248 else:
249 warnings.warn("ProgressBar can not log "
250 "tensor with {} dimensions".format(value.ndimension()))
251 else:
252 rendered_metrics[key] = value
253
254 if rendered_metrics:
255 logger.pbar.set_postfix(**rendered_metrics)
256
257 global_step = engine.state.get_event_attrib_value(event_name)
258 global_step = (global_step - 1) % pbar_total + 1
259 logger.pbar.update(global_step - logger.pbar.n)
260
```
--- 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/contrib/handlers/tqdm_logger.py b/ignite/contrib/handlers/tqdm_logger.py
--- a/ignite/contrib/handlers/tqdm_logger.py
+++ b/ignite/contrib/handlers/tqdm_logger.py
@@ -119,6 +119,7 @@
total=pbar_total,
leave=self.persist,
bar_format=self.bar_format,
+ initial=1,
**self.tqdm_kwargs
)
| {"golden_diff": "diff --git a/ignite/contrib/handlers/tqdm_logger.py b/ignite/contrib/handlers/tqdm_logger.py\n--- a/ignite/contrib/handlers/tqdm_logger.py\n+++ b/ignite/contrib/handlers/tqdm_logger.py\n@@ -119,6 +119,7 @@\n total=pbar_total,\n leave=self.persist,\n bar_format=self.bar_format,\n+ initial=1,\n **self.tqdm_kwargs\n )\n", "issue": "progress bar output seems to be off\nSoi I am using the Progressbar from the contrib module for indicating progress in the training loop. Currently the batch size is 1 for an exemplary dataset of 16 samples. \r\n\r\nBut for some reason the progressbar seems to skip the first step and I am not sure if this is due to an issue related to my dataloading or simply a displaying problem. \r\n\r\niter counter 0\r\nEpoch [1/500]: [0/8] 0%| iter counter 1\r\nEpoch [1/500]: [2/8] 25%| iter counter 2\r\nEpoch [1/500]: [3/8] 38%| iter counter 3\r\nEpoch [1/500]: [4/8] 50%| iter counter 4\r\nEpoch [1/500]: [5/8] 62%| iter counter 5\r\nEpoch [1/500]: [6/8] 75%| \r\niter counter 6\r\nEpoch [1/500]: [7/8] 88%| \r\niter counter 7\r\nEpoch [1/500]: [8/8] 100%|\r\n\r\nis this a known problem or am I missing sth here? the iter counter is taken from the engine _run_once_on_dataset method\n", "before_files": [{"content": "# -*- coding: utf-8 -*-\nimport warnings\n\nimport torch\n\nfrom ignite.engine import Events\nfrom ignite.engine.engine import EventWithFilter\nfrom ignite.contrib.handlers.base_logger import BaseLogger, BaseOutputHandler\n\n\nclass ProgressBar(BaseLogger):\n \"\"\"\n TQDM progress bar handler to log training progress and computed metrics.\n\n Args:\n persist (bool, optional): set to ``True`` to persist the progress bar after completion (default = ``False``)\n bar_format (str, optional): Specify a custom bar string formatting. May impact performance.\n [default: '{desc}[{n_fmt}/{total_fmt}] {percentage:3.0f}%|{bar}{postfix} [{elapsed}<{remaining}]'].\n Set to ``None`` to use ``tqdm`` default bar formatting: '{l_bar}{bar}{r_bar}', where\n l_bar='{desc}: {percentage:3.0f}%|' and\n r_bar='| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, {rate_fmt}{postfix}]'. For more details on the\n formatting, see `tqdm docs <https://tqdm.github.io/docs/tqdm/>`_.\n **tqdm_kwargs: kwargs passed to tqdm progress bar.\n By default, progress bar description displays \"Epoch [5/10]\" where 5 is the current epoch and 10 is the\n number of epochs. If tqdm_kwargs defines `desc`, e.g. \"Predictions\", than the description is\n \"Predictions [5/10]\" if number of epochs is more than one otherwise it is simply \"Predictions\".\n\n Examples:\n\n Simple progress bar\n\n .. code-block:: python\n\n trainer = create_supervised_trainer(model, optimizer, loss)\n\n pbar = ProgressBar()\n pbar.attach(trainer)\n\n # Progress bar will looks like\n # Epoch [2/50]: [64/128] 50%|\u2588\u2588\u2588\u2588\u2588 [06:17<12:34]\n\n Log output to a file instead of stderr (tqdm's default output)\n\n .. code-block:: python\n\n trainer = create_supervised_trainer(model, optimizer, loss)\n\n log_file = open(\"output.log\", \"w\")\n pbar = ProgressBar(file=log_file)\n pbar.attach(trainer)\n\n Attach metrics that already have been computed at :attr:`~ignite.engine.Events.ITERATION_COMPLETED`\n (such as :class:`~ignite.metrics.RunningAverage`)\n\n .. code-block:: python\n\n trainer = create_supervised_trainer(model, optimizer, loss)\n\n RunningAverage(output_transform=lambda x: x).attach(trainer, 'loss')\n\n pbar = ProgressBar()\n pbar.attach(trainer, ['loss'])\n\n # Progress bar will looks like\n # Epoch [2/50]: [64/128] 50%|\u2588\u2588\u2588\u2588\u2588 , loss=0.123 [06:17<12:34]\n\n Directly attach the engine's output\n\n .. code-block:: python\n\n trainer = create_supervised_trainer(model, optimizer, loss)\n\n pbar = ProgressBar()\n pbar.attach(trainer, output_transform=lambda x: {'loss': x})\n\n # Progress bar will looks like\n # Epoch [2/50]: [64/128] 50%|\u2588\u2588\u2588\u2588\u2588 , loss=0.123 [06:17<12:34]\n\n Note:\n When adding attaching the progress bar to an engine, it is recommend that you replace\n every print operation in the engine's handlers triggered every iteration with\n ``pbar.log_message`` to guarantee the correct format of the stdout.\n\n Note:\n When using inside jupyter notebook, `ProgressBar` automatically uses `tqdm_notebook`. For correct rendering,\n please install `ipywidgets <https://ipywidgets.readthedocs.io/en/stable/user_install.html#installation>`_.\n Due to `tqdm notebook bugs <https://github.com/tqdm/tqdm/issues/594>`_, bar format may be needed to be set\n to an empty string value.\n\n \"\"\"\n\n _events_order = [\n Events.STARTED,\n Events.EPOCH_STARTED,\n Events.ITERATION_STARTED,\n Events.ITERATION_COMPLETED,\n Events.EPOCH_COMPLETED,\n Events.COMPLETED\n ]\n\n def __init__(self, persist=False,\n bar_format='{desc}[{n_fmt}/{total_fmt}] {percentage:3.0f}%|{bar}{postfix} [{elapsed}<{remaining}]',\n **tqdm_kwargs):\n\n try:\n from tqdm.autonotebook import tqdm\n except ImportError:\n raise RuntimeError(\"This contrib module requires tqdm to be installed. \"\n \"Please install it with command: \\n pip install tqdm\")\n\n self.pbar_cls = tqdm\n self.pbar = None\n self.persist = persist\n self.bar_format = bar_format\n self.tqdm_kwargs = tqdm_kwargs\n\n def _reset(self, pbar_total):\n self.pbar = self.pbar_cls(\n total=pbar_total,\n leave=self.persist,\n bar_format=self.bar_format,\n **self.tqdm_kwargs\n )\n\n def _close(self, engine):\n if self.pbar:\n self.pbar.close()\n self.pbar = None\n\n @staticmethod\n def _compare_lt(event1, event2):\n if isinstance(event1, EventWithFilter):\n event1 = event1.event\n if isinstance(event2, EventWithFilter):\n event2 = event2.event\n i1 = ProgressBar._events_order.index(event1)\n i2 = ProgressBar._events_order.index(event2)\n return i1 < i2\n\n def log_message(self, message):\n \"\"\"\n Logs a message, preserving the progress bar correct output format.\n\n Args:\n message (str): string you wish to log.\n \"\"\"\n from tqdm import tqdm\n tqdm.write(message, **self.tqdm_kwargs)\n\n def attach(self, engine, metric_names=None, output_transform=None,\n event_name=Events.ITERATION_COMPLETED,\n closing_event_name=Events.EPOCH_COMPLETED):\n \"\"\"\n Attaches the progress bar to an engine object.\n\n Args:\n engine (Engine): engine object.\n metric_names (list of str, optional): list of metric names to plot or a string \"all\" to plot all available\n metrics.\n output_transform (callable, optional): a function to select what you want to print from the engine's\n output. This function may return either a dictionary with entries in the format of ``{name: value}``,\n or a single scalar, which will be displayed with the default name `output`.\n event_name: event's name on which the progress bar advances. Valid events are from\n :class:`~ignite.engine.Events`.\n closing_event_name: event's name on which the progress bar is closed. Valid events are from\n :class:`~ignite.engine.Events`.\n\n Note: accepted output value types are numbers, 0d and 1d torch tensors and strings\n\n \"\"\"\n desc = self.tqdm_kwargs.get(\"desc\", \"Epoch\")\n\n if not isinstance(event_name, (Events, EventWithFilter)):\n raise ValueError(\"Logging event should be only `ignite.engine.Events`\")\n\n if isinstance(closing_event_name, EventWithFilter):\n raise ValueError(\"Closing event should not use any event filter\")\n\n if not self._compare_lt(event_name, closing_event_name):\n raise ValueError(\"Logging event {} should be called before closing event {}\"\n .format(event_name, closing_event_name))\n\n log_handler = _OutputHandler(desc, metric_names, output_transform,\n closing_event_name=closing_event_name)\n # if event_name is EventWithFilter, filter is passed here\n super(ProgressBar, self).attach(engine, log_handler, event_name)\n engine.add_event_handler(closing_event_name, self._close)\n\n\nclass _OutputHandler(BaseOutputHandler):\n \"\"\"Helper handler to log engine's output and/or metrics\n\n Args:\n description (str): progress bar description.\n metric_names (list of str, optional): list of metric names to plot or a string \"all\" to plot all available\n metrics.\n output_transform (callable, optional): output transform function to prepare `engine.state.output` as a number.\n For example, `output_transform = lambda output: output`\n This function can also return a dictionary, e.g `{'loss': loss1, 'another_loss': loss2}` to label the plot\n with corresponding keys.\n closing_event_name: event's name on which the progress bar is closed. Valid events are from\n :class:`~ignite.engine.Events` or any `event_name` added by\n :meth:`~ignite.engine.Engine.register_events`.\n\n \"\"\"\n\n def __init__(self, description, metric_names=None, output_transform=None,\n closing_event_name=Events.EPOCH_COMPLETED):\n if metric_names is None and output_transform is None:\n # This helps to avoid 'Either metric_names or output_transform should be defined' of BaseOutputHandler\n metric_names = []\n super(_OutputHandler, self).__init__(description, metric_names, output_transform,\n another_engine=None, global_step_transform=None)\n self.closing_event_name = closing_event_name\n\n @staticmethod\n def get_max_number_events(event_name, engine):\n if event_name in (Events.ITERATION_STARTED, Events.ITERATION_COMPLETED):\n return len(engine.state.dataloader)\n if event_name in (Events.EPOCH_STARTED, Events.EPOCH_COMPLETED):\n return engine.state.max_epochs\n return 1\n\n def __call__(self, engine, logger, event_name):\n\n pbar_total = self.get_max_number_events(event_name, engine)\n if logger.pbar is None:\n logger._reset(pbar_total=pbar_total)\n\n desc = self.tag\n max_num_of_closing_events = self.get_max_number_events(self.closing_event_name, engine)\n if max_num_of_closing_events > 1:\n global_step = engine.state.get_event_attrib_value(self.closing_event_name)\n desc += \" [{}/{}]\".format(global_step, max_num_of_closing_events)\n logger.pbar.set_description(desc)\n\n metrics = self._setup_output_metrics(engine)\n\n rendered_metrics = {}\n for key, value in metrics.items():\n if isinstance(value, torch.Tensor):\n if value.ndimension() == 0:\n rendered_metrics[key] = value.item()\n elif value.ndimension() == 1:\n for i, v in enumerate(value):\n k = \"{}_{}\".format(key, i)\n rendered_metrics[k] = v.item()\n else:\n warnings.warn(\"ProgressBar can not log \"\n \"tensor with {} dimensions\".format(value.ndimension()))\n else:\n rendered_metrics[key] = value\n\n if rendered_metrics:\n logger.pbar.set_postfix(**rendered_metrics)\n\n global_step = engine.state.get_event_attrib_value(event_name)\n global_step = (global_step - 1) % pbar_total + 1\n logger.pbar.update(global_step - logger.pbar.n)\n", "path": "ignite/contrib/handlers/tqdm_logger.py"}], "after_files": [{"content": "# -*- coding: utf-8 -*-\nimport warnings\n\nimport torch\n\nfrom ignite.engine import Events\nfrom ignite.engine.engine import EventWithFilter\nfrom ignite.contrib.handlers.base_logger import BaseLogger, BaseOutputHandler\n\n\nclass ProgressBar(BaseLogger):\n \"\"\"\n TQDM progress bar handler to log training progress and computed metrics.\n\n Args:\n persist (bool, optional): set to ``True`` to persist the progress bar after completion (default = ``False``)\n bar_format (str, optional): Specify a custom bar string formatting. May impact performance.\n [default: '{desc}[{n_fmt}/{total_fmt}] {percentage:3.0f}%|{bar}{postfix} [{elapsed}<{remaining}]'].\n Set to ``None`` to use ``tqdm`` default bar formatting: '{l_bar}{bar}{r_bar}', where\n l_bar='{desc}: {percentage:3.0f}%|' and\n r_bar='| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, {rate_fmt}{postfix}]'. For more details on the\n formatting, see `tqdm docs <https://tqdm.github.io/docs/tqdm/>`_.\n **tqdm_kwargs: kwargs passed to tqdm progress bar.\n By default, progress bar description displays \"Epoch [5/10]\" where 5 is the current epoch and 10 is the\n number of epochs. If tqdm_kwargs defines `desc`, e.g. \"Predictions\", than the description is\n \"Predictions [5/10]\" if number of epochs is more than one otherwise it is simply \"Predictions\".\n\n Examples:\n\n Simple progress bar\n\n .. code-block:: python\n\n trainer = create_supervised_trainer(model, optimizer, loss)\n\n pbar = ProgressBar()\n pbar.attach(trainer)\n\n # Progress bar will looks like\n # Epoch [2/50]: [64/128] 50%|\u2588\u2588\u2588\u2588\u2588 [06:17<12:34]\n\n Log output to a file instead of stderr (tqdm's default output)\n\n .. code-block:: python\n\n trainer = create_supervised_trainer(model, optimizer, loss)\n\n log_file = open(\"output.log\", \"w\")\n pbar = ProgressBar(file=log_file)\n pbar.attach(trainer)\n\n Attach metrics that already have been computed at :attr:`~ignite.engine.Events.ITERATION_COMPLETED`\n (such as :class:`~ignite.metrics.RunningAverage`)\n\n .. code-block:: python\n\n trainer = create_supervised_trainer(model, optimizer, loss)\n\n RunningAverage(output_transform=lambda x: x).attach(trainer, 'loss')\n\n pbar = ProgressBar()\n pbar.attach(trainer, ['loss'])\n\n # Progress bar will looks like\n # Epoch [2/50]: [64/128] 50%|\u2588\u2588\u2588\u2588\u2588 , loss=0.123 [06:17<12:34]\n\n Directly attach the engine's output\n\n .. code-block:: python\n\n trainer = create_supervised_trainer(model, optimizer, loss)\n\n pbar = ProgressBar()\n pbar.attach(trainer, output_transform=lambda x: {'loss': x})\n\n # Progress bar will looks like\n # Epoch [2/50]: [64/128] 50%|\u2588\u2588\u2588\u2588\u2588 , loss=0.123 [06:17<12:34]\n\n Note:\n When adding attaching the progress bar to an engine, it is recommend that you replace\n every print operation in the engine's handlers triggered every iteration with\n ``pbar.log_message`` to guarantee the correct format of the stdout.\n\n Note:\n When using inside jupyter notebook, `ProgressBar` automatically uses `tqdm_notebook`. For correct rendering,\n please install `ipywidgets <https://ipywidgets.readthedocs.io/en/stable/user_install.html#installation>`_.\n Due to `tqdm notebook bugs <https://github.com/tqdm/tqdm/issues/594>`_, bar format may be needed to be set\n to an empty string value.\n\n \"\"\"\n\n _events_order = [\n Events.STARTED,\n Events.EPOCH_STARTED,\n Events.ITERATION_STARTED,\n Events.ITERATION_COMPLETED,\n Events.EPOCH_COMPLETED,\n Events.COMPLETED\n ]\n\n def __init__(self, persist=False,\n bar_format='{desc}[{n_fmt}/{total_fmt}] {percentage:3.0f}%|{bar}{postfix} [{elapsed}<{remaining}]',\n **tqdm_kwargs):\n\n try:\n from tqdm.autonotebook import tqdm\n except ImportError:\n raise RuntimeError(\"This contrib module requires tqdm to be installed. \"\n \"Please install it with command: \\n pip install tqdm\")\n\n self.pbar_cls = tqdm\n self.pbar = None\n self.persist = persist\n self.bar_format = bar_format\n self.tqdm_kwargs = tqdm_kwargs\n\n def _reset(self, pbar_total):\n self.pbar = self.pbar_cls(\n total=pbar_total,\n leave=self.persist,\n bar_format=self.bar_format,\n initial=1,\n **self.tqdm_kwargs\n )\n\n def _close(self, engine):\n if self.pbar:\n self.pbar.close()\n self.pbar = None\n\n @staticmethod\n def _compare_lt(event1, event2):\n if isinstance(event1, EventWithFilter):\n event1 = event1.event\n if isinstance(event2, EventWithFilter):\n event2 = event2.event\n i1 = ProgressBar._events_order.index(event1)\n i2 = ProgressBar._events_order.index(event2)\n return i1 < i2\n\n def log_message(self, message):\n \"\"\"\n Logs a message, preserving the progress bar correct output format.\n\n Args:\n message (str): string you wish to log.\n \"\"\"\n from tqdm import tqdm\n tqdm.write(message, **self.tqdm_kwargs)\n\n def attach(self, engine, metric_names=None, output_transform=None,\n event_name=Events.ITERATION_COMPLETED,\n closing_event_name=Events.EPOCH_COMPLETED):\n \"\"\"\n Attaches the progress bar to an engine object.\n\n Args:\n engine (Engine): engine object.\n metric_names (list of str, optional): list of metric names to plot or a string \"all\" to plot all available\n metrics.\n output_transform (callable, optional): a function to select what you want to print from the engine's\n output. This function may return either a dictionary with entries in the format of ``{name: value}``,\n or a single scalar, which will be displayed with the default name `output`.\n event_name: event's name on which the progress bar advances. Valid events are from\n :class:`~ignite.engine.Events`.\n closing_event_name: event's name on which the progress bar is closed. Valid events are from\n :class:`~ignite.engine.Events`.\n\n Note: accepted output value types are numbers, 0d and 1d torch tensors and strings\n\n \"\"\"\n desc = self.tqdm_kwargs.get(\"desc\", \"Epoch\")\n\n if not isinstance(event_name, (Events, EventWithFilter)):\n raise ValueError(\"Logging event should be only `ignite.engine.Events`\")\n\n if isinstance(closing_event_name, EventWithFilter):\n raise ValueError(\"Closing event should not use any event filter\")\n\n if not self._compare_lt(event_name, closing_event_name):\n raise ValueError(\"Logging event {} should be called before closing event {}\"\n .format(event_name, closing_event_name))\n\n log_handler = _OutputHandler(desc, metric_names, output_transform,\n closing_event_name=closing_event_name)\n # if event_name is EventWithFilter, filter is passed here\n super(ProgressBar, self).attach(engine, log_handler, event_name)\n engine.add_event_handler(closing_event_name, self._close)\n\n\nclass _OutputHandler(BaseOutputHandler):\n \"\"\"Helper handler to log engine's output and/or metrics\n\n Args:\n description (str): progress bar description.\n metric_names (list of str, optional): list of metric names to plot or a string \"all\" to plot all available\n metrics.\n output_transform (callable, optional): output transform function to prepare `engine.state.output` as a number.\n For example, `output_transform = lambda output: output`\n This function can also return a dictionary, e.g `{'loss': loss1, 'another_loss': loss2}` to label the plot\n with corresponding keys.\n closing_event_name: event's name on which the progress bar is closed. Valid events are from\n :class:`~ignite.engine.Events` or any `event_name` added by\n :meth:`~ignite.engine.Engine.register_events`.\n\n \"\"\"\n\n def __init__(self, description, metric_names=None, output_transform=None,\n closing_event_name=Events.EPOCH_COMPLETED):\n if metric_names is None and output_transform is None:\n # This helps to avoid 'Either metric_names or output_transform should be defined' of BaseOutputHandler\n metric_names = []\n super(_OutputHandler, self).__init__(description, metric_names, output_transform,\n another_engine=None, global_step_transform=None)\n self.closing_event_name = closing_event_name\n\n @staticmethod\n def get_max_number_events(event_name, engine):\n if event_name in (Events.ITERATION_STARTED, Events.ITERATION_COMPLETED):\n return len(engine.state.dataloader)\n if event_name in (Events.EPOCH_STARTED, Events.EPOCH_COMPLETED):\n return engine.state.max_epochs\n return 1\n\n def __call__(self, engine, logger, event_name):\n\n pbar_total = self.get_max_number_events(event_name, engine)\n if logger.pbar is None:\n logger._reset(pbar_total=pbar_total)\n\n desc = self.tag\n max_num_of_closing_events = self.get_max_number_events(self.closing_event_name, engine)\n if max_num_of_closing_events > 1:\n global_step = engine.state.get_event_attrib_value(self.closing_event_name)\n desc += \" [{}/{}]\".format(global_step, max_num_of_closing_events)\n logger.pbar.set_description(desc)\n\n metrics = self._setup_output_metrics(engine)\n\n rendered_metrics = {}\n for key, value in metrics.items():\n if isinstance(value, torch.Tensor):\n if value.ndimension() == 0:\n rendered_metrics[key] = value.item()\n elif value.ndimension() == 1:\n for i, v in enumerate(value):\n k = \"{}_{}\".format(key, i)\n rendered_metrics[k] = v.item()\n else:\n warnings.warn(\"ProgressBar can not log \"\n \"tensor with {} dimensions\".format(value.ndimension()))\n else:\n rendered_metrics[key] = value\n\n if rendered_metrics:\n logger.pbar.set_postfix(**rendered_metrics)\n\n global_step = engine.state.get_event_attrib_value(event_name)\n global_step = (global_step - 1) % pbar_total + 1\n logger.pbar.update(global_step - logger.pbar.n)\n", "path": "ignite/contrib/handlers/tqdm_logger.py"}]} |
gh_patches_debug_272 | rasdani/github-patches | git_diff | scikit-hep__pyhf-1283 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Change question asking queue to focus on GitHub Discussions over Stack Overflow
# Description
We currently direct users with application questions to the `pyhf` Stack Overflow tag, but should start directing them to GitHub Discussions instead.
This should be done before `v0.6.0` so that this gets propagated out to PyPI.
--- 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 # pyhf documentation build configuration file, created by
3 # sphinx-quickstart on Fri Feb 9 11:58:49 2018.
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 Path('../relative_path_to_dir').resolve() to make it absolute, like shown here.
17
18 from pathlib import Path
19 import sys
20 from pkg_resources import get_distribution
21
22 sys.path.insert(0, str(Path('../src').resolve()))
23 sys.path.insert(1, str(Path('./exts').resolve()))
24
25
26 def setup(app):
27 app.add_css_file(
28 'https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.2/gh-fork-ribbon.min.css'
29 )
30
31
32 # -- General configuration ------------------------------------------------
33
34 # If your documentation needs a minimal Sphinx version, state it here.
35 #
36 # needs_sphinx = '1.0'
37
38 # Add any Sphinx extension module names here, as strings. They can be
39 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40 # ones.
41 extensions = [
42 'sphinx.ext.autodoc',
43 'sphinx.ext.autosummary',
44 'sphinx.ext.coverage',
45 'sphinx.ext.mathjax',
46 'sphinx.ext.ifconfig',
47 'sphinx.ext.viewcode',
48 'sphinx.ext.githubpages',
49 'sphinx.ext.intersphinx',
50 'sphinxcontrib.bibtex',
51 'sphinx.ext.napoleon',
52 'sphinx_click.ext',
53 'nbsphinx',
54 'sphinx_issues',
55 'sphinx_copybutton',
56 'xref',
57 ]
58 bibtex_bibfiles = [
59 "bib/docs.bib",
60 "bib/HEPData_likelihoods.bib",
61 "bib/media.bib",
62 "bib/posters.bib",
63 "bib/preferred.bib",
64 "bib/talks.bib",
65 "bib/tutorials.bib",
66 "bib/use_citations.bib",
67 ]
68
69 # external links
70 xref_links = {"arXiv:1007.1727": ("[1007.1727]", "https://arxiv.org/abs/1007.1727")}
71
72 intersphinx_mapping = {
73 'python': ('https://docs.python.org/3', None),
74 'numpy': ('http://docs.scipy.org/doc/numpy/', None),
75 'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
76 'iminuit': ('https://iminuit.readthedocs.io/en/stable/', None),
77 'uproot': ('https://uproot.readthedocs.io/en/latest/', None),
78 }
79
80 # Github repo
81 issues_github_path = 'scikit-hep/pyhf'
82
83 # Generate the API documentation when building
84 autosummary_generate = True
85 numpydoc_show_class_members = False
86
87 # Add any paths that contain templates here, relative to this directory.
88 templates_path = ['_templates']
89
90 # The suffix(es) of source filenames.
91 # You can specify multiple suffix as a list of string:
92 #
93 source_suffix = ['.rst', '.md']
94 # source_suffix = '.rst'
95
96 # The encoding of source files.
97 #
98 # source_encoding = 'utf-8-sig'
99
100 # The master toctree document.
101 master_doc = 'index'
102
103 # General information about the project.
104 project = 'pyhf'
105 copyright = '2018, Lukas Heinrich, Matthew Feickert, Giordon Stark'
106 author = 'Lukas Heinrich, Matthew Feickert, Giordon Stark'
107
108 # The version info for the project you're documenting, acts as replacement for
109 # |version| and |release|, also used in various other places throughout the
110 # built documents.
111 # The full version, including alpha/beta/rc tags.
112 release = get_distribution('pyhf').version
113 # for example take major/minor/patch
114 version = '.'.join(release.split('.')[:3])
115
116 # The language for content autogenerated by Sphinx. Refer to documentation
117 # for a list of supported languages.
118 #
119 # This is also used if you do content translation via gettext catalogs.
120 # Usually you set "language" from the command line for these cases.
121 language = None
122
123 # There are two options for replacing |today|: either, you set today to some
124 # non-false value, then it is used:
125 #
126 # today = ''
127 #
128 # Else, today_fmt is used as the format for a strftime call.
129 #
130 # today_fmt = '%B %d, %Y'
131
132 autodoc_mock_imports = [
133 'tensorflow',
134 'torch',
135 'jax',
136 'iminuit',
137 'tensorflow_probability',
138 ]
139
140 # List of patterns, relative to source directory, that match files and
141 # directories to ignore when looking for source files.
142 # This patterns also effect to html_static_path and html_extra_path
143 exclude_patterns = [
144 '_build',
145 'JOSS',
146 '**.ipynb_checkpoints',
147 'examples/experiments/edwardpyhf.ipynb',
148 'examples/notebooks/ImpactPlot.ipynb',
149 'examples/notebooks/Recast.ipynb',
150 'examples/notebooks/StatError.ipynb',
151 'examples/notebooks/example-tensorflow.ipynb',
152 'examples/notebooks/histogrammar.ipynb',
153 'examples/notebooks/histosys.ipynb',
154 'examples/notebooks/histosys-pytorch.ipynb',
155 'examples/notebooks/importxml.ipynb',
156 'examples/notebooks/multichannel-coupled-normsys.ipynb',
157 'examples/notebooks/multichannel-normsys.ipynb',
158 'examples/notebooks/normsys.ipynb',
159 'examples/notebooks/pullplot.ipynb',
160 'examples/notebooks/pytorch_tests_onoff.ipynb',
161 'examples/notebooks/tensorflow-limit.ipynb',
162 ]
163
164 # The reST default role (used for this markup: `text`) to use for all
165 # documents.
166 #
167 # default_role = None
168
169 # If true, '()' will be appended to :func: etc. cross-reference text.
170 #
171 # add_function_parentheses = True
172
173 # If true, the current module name will be prepended to all description
174 # unit titles (such as .. function::).
175 #
176 # add_module_names = True
177
178 # If true, sectionauthor and moduleauthor directives will be shown in the
179 # output. They are ignored by default.
180 #
181 # show_authors = False
182
183 # The name of the Pygments (syntax highlighting) style to use.
184 pygments_style = 'sphinx'
185
186 # A list of ignored prefixes for module index sorting.
187 # modindex_common_prefix = []
188
189 # If true, keep warnings as "system message" paragraphs in the built documents.
190 # keep_warnings = False
191
192 # If true, `todo` and `todoList` produce output, else they produce nothing.
193 todo_include_todos = False
194
195
196 # -- Options for HTML output ----------------------------------------------
197
198 # The theme to use for HTML and HTML Help pages. See the documentation for
199 # a list of builtin themes.
200 #
201 html_theme = 'sphinx_rtd_theme'
202
203 # Theme options are theme-specific and customize the look and feel of a theme
204 # further. For a list of options available for each theme, see the
205 # documentation.
206 #
207 html_theme_options = {}
208
209 # Add any paths that contain custom themes here, relative to this directory.
210 html_theme_path = []
211
212 # The name for this set of Sphinx documents.
213 # "<project> v<release> documentation" by default.
214 #
215 # html_title = u'pyhf v0.3.0'
216
217 # A shorter title for the navigation bar. Default is the same as html_title.
218 #
219 # html_short_title = None
220
221 # The name of an image file (relative to this directory) to place at the top
222 # of the sidebar.
223 #
224 # html_logo = None
225
226 # The name of an image file (relative to this directory) to use as a favicon of
227 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
228 # pixels large.
229 #
230 # html_favicon = None
231
232 # Add any paths that contain custom static files (such as style sheets) here,
233 # relative to this directory. They are copied after the builtin static files,
234 # so a file named "default.css" will overwrite the builtin "default.css".
235 html_static_path = ['_static']
236
237 # Add any extra paths that contain custom files (such as robots.txt or
238 # .htaccess) here, relative to this directory. These files are copied
239 # directly to the root of the documentation.
240 #
241 html_extra_path = ['_extras']
242
243 # If not None, a 'Last updated on:' timestamp is inserted at every page
244 # bottom, using the given strftime format.
245 # The empty string is equivalent to '%b %d, %Y'.
246 #
247 # html_last_updated_fmt = None
248
249 # If true, SmartyPants will be used to convert quotes and dashes to
250 # typographically correct entities.
251 #
252 # html_use_smartypants = True
253
254 # Custom sidebar templates, maps document names to template names.
255 #
256 # html_sidebars = {}
257
258 # Additional templates that should be rendered to pages, maps page names to
259 # template names.
260 #
261 # html_additional_pages = {}
262
263 # If false, no module index is generated.
264 #
265 # html_domain_indices = True
266
267 # If false, no index is generated.
268 #
269 # html_use_index = True
270
271 # If true, the index is split into individual pages for each letter.
272 #
273 # html_split_index = False
274
275 # If true, links to the reST sources are added to the pages.
276 #
277 # html_show_sourcelink = True
278
279 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
280 #
281 # html_show_sphinx = True
282
283 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
284 #
285 # html_show_copyright = True
286
287 # If true, an OpenSearch description file will be output, and all pages will
288 # contain a <link> tag referring to it. The value of this option must be the
289 # base URL from which the finished HTML is served.
290 #
291 # html_use_opensearch = ''
292
293 # This is the file name suffix for HTML files (e.g. ".xhtml").
294 # html_file_suffix = None
295
296 # Language to be used for generating the HTML full-text search index.
297 # Sphinx supports the following languages:
298 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
299 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
300 #
301 # html_search_language = 'en'
302
303 # A dictionary with options for the search language support, empty by default.
304 # 'ja' uses this config value.
305 # 'zh' user can custom change `jieba` dictionary path.
306 #
307 # html_search_options = {'type': 'default'}
308
309 # The name of a javascript file (relative to the configuration directory) that
310 # implements a search results scorer. If empty, the default will be used.
311 #
312 # html_search_scorer = 'scorer.js'
313
314 # Output file base name for HTML help builder.
315 htmlhelp_basename = 'pyhfdoc'
316
317 # sphinx-copybutton configuration
318 copybutton_prompt_text = ">>> "
319
320 # -- Options for LaTeX output ---------------------------------------------
321
322 latex_elements = {
323 # The paper size ('letterpaper' or 'a4paper').
324 #
325 # 'papersize': 'letterpaper',
326 # The font size ('10pt', '11pt' or '12pt').
327 #
328 # 'pointsize': '10pt',
329 # Additional stuff for the LaTeX preamble.
330 #
331 # 'preamble': '',
332 # Latex figure (float) alignment
333 #
334 # 'figure_align': 'htbp',
335 }
336
337 # Grouping the document tree into LaTeX files. List of tuples
338 # (source start file, target name, title,
339 # author, documentclass [howto, manual, or own class]).
340 latex_documents = [
341 (
342 master_doc,
343 'pyhf.tex',
344 'pyhf Documentation',
345 'Lukas Heinrich, Matthew Feickert, Giordon Stark',
346 'manual',
347 )
348 ]
349
350 # The name of an image file (relative to this directory) to place at the top of
351 # the title page.
352 #
353 # latex_logo = None
354
355 # For "manual" documents, if this is true, then toplevel headings are parts,
356 # not chapters.
357 #
358 # latex_use_parts = False
359
360 # If true, show page references after internal links.
361 #
362 # latex_show_pagerefs = False
363
364 # If true, show URL addresses after external links.
365 #
366 # latex_show_urls = False
367
368 # Documents to append as an appendix to all manuals.
369 #
370 # latex_appendices = []
371
372 # It false, will not define \strong, \code, itleref, \crossref ... but only
373 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
374 # packages.
375 #
376 # latex_keep_old_macro_names = True
377
378 # If false, no module index is generated.
379 #
380 # latex_domain_indices = True
381
382
383 # -- Options for manual page output ---------------------------------------
384
385 # One entry per manual page. List of tuples
386 # (source start file, name, description, authors, manual section).
387 man_pages = [(master_doc, 'pyhf', 'pyhf Documentation', [author], 1)]
388
389 # If true, show URL addresses after external links.
390 #
391 # man_show_urls = False
392
393
394 # -- Options for Texinfo output -------------------------------------------
395
396 # Grouping the document tree into Texinfo files. List of tuples
397 # (source start file, target name, title, author,
398 # dir menu entry, description, category)
399 texinfo_documents = [
400 (
401 master_doc,
402 'pyhf',
403 'pyhf Documentation',
404 author,
405 'pyhf',
406 'One line description of project.',
407 'Miscellaneous',
408 )
409 ]
410
411 # Documents to append as an appendix to all manuals.
412 #
413 # texinfo_appendices = []
414
415 # If false, no module index is generated.
416 #
417 # texinfo_domain_indices = True
418
419 # How to display URL addresses: 'footnote', 'no', or 'inline'.
420 #
421 # texinfo_show_urls = 'footnote'
422
423 # If true, do not generate a @detailmenu in the "Top" node's menu.
424 #
425 # texinfo_no_detailmenu = False
426
427 mathjax_config = {
428 'tex2jax': {'inlineMath': [['$', '$'], ['\\(', '\\)']]},
429 'TeX': {
430 'Macros': {
431 'bm': ["\\boldsymbol{#1}", 1], # \usepackage{bm}, see mathjax/MathJax#1219
432 'HiFa': r'\texttt{HistFactory}',
433 'Root': r'\texttt{ROOT}',
434 'RooStats': r'\texttt{RooStats}',
435 'RooFit': r'\texttt{RooFit}',
436 'pyhf': r'\texttt{pyhf}',
437 'CLs': r'\mathrm{CL}_{s}',
438 'freeset': r'\bm{\eta}',
439 'constrset': r'\bm{\chi}',
440 'singleconstr': r'\chi',
441 'channelcounts': r'\bm{n}',
442 'auxdata': r'\bm{a}',
443 'poiset': r'\bm{\psi}',
444 'nuisset': r'\bm{\theta}',
445 'fullset': r'\bm{\phi}',
446 'singlefull': r'\phi',
447 'TeV': r'\textrm{TeV}',
448 }
449 },
450 }
451
```
--- 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
@@ -77,7 +77,7 @@
'uproot': ('https://uproot.readthedocs.io/en/latest/', None),
}
-# Github repo
+# GitHub repo
issues_github_path = 'scikit-hep/pyhf'
# Generate the API documentation when building
| {"golden_diff": "diff --git a/docs/conf.py b/docs/conf.py\n--- a/docs/conf.py\n+++ b/docs/conf.py\n@@ -77,7 +77,7 @@\n 'uproot': ('https://uproot.readthedocs.io/en/latest/', None),\n }\n \n-# Github repo\n+# GitHub repo\n issues_github_path = 'scikit-hep/pyhf'\n \n # Generate the API documentation when building\n", "issue": "Change question asking queue to focus on GitHub Discussions over Stack Overflow\n# Description\r\n\r\nWe currently direct users with application questions to the `pyhf` Stack Overflow tag, but should start directing them to GitHub Discussions instead.\r\n\r\nThis should be done before `v0.6.0` so that this gets propagated out to PyPI.\n", "before_files": [{"content": "#\n# pyhf documentation build configuration file, created by\n# sphinx-quickstart on Fri Feb 9 11:58:49 2018.\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 Path('../relative_path_to_dir').resolve() to make it absolute, like shown here.\n\nfrom pathlib import Path\nimport sys\nfrom pkg_resources import get_distribution\n\nsys.path.insert(0, str(Path('../src').resolve()))\nsys.path.insert(1, str(Path('./exts').resolve()))\n\n\ndef setup(app):\n app.add_css_file(\n 'https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.2/gh-fork-ribbon.min.css'\n )\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.autosummary',\n 'sphinx.ext.coverage',\n 'sphinx.ext.mathjax',\n 'sphinx.ext.ifconfig',\n 'sphinx.ext.viewcode',\n 'sphinx.ext.githubpages',\n 'sphinx.ext.intersphinx',\n 'sphinxcontrib.bibtex',\n 'sphinx.ext.napoleon',\n 'sphinx_click.ext',\n 'nbsphinx',\n 'sphinx_issues',\n 'sphinx_copybutton',\n 'xref',\n]\nbibtex_bibfiles = [\n \"bib/docs.bib\",\n \"bib/HEPData_likelihoods.bib\",\n \"bib/media.bib\",\n \"bib/posters.bib\",\n \"bib/preferred.bib\",\n \"bib/talks.bib\",\n \"bib/tutorials.bib\",\n \"bib/use_citations.bib\",\n]\n\n# external links\nxref_links = {\"arXiv:1007.1727\": (\"[1007.1727]\", \"https://arxiv.org/abs/1007.1727\")}\n\nintersphinx_mapping = {\n 'python': ('https://docs.python.org/3', None),\n 'numpy': ('http://docs.scipy.org/doc/numpy/', None),\n 'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),\n 'iminuit': ('https://iminuit.readthedocs.io/en/stable/', None),\n 'uproot': ('https://uproot.readthedocs.io/en/latest/', None),\n}\n\n# Github repo\nissues_github_path = 'scikit-hep/pyhf'\n\n# Generate the API documentation when building\nautosummary_generate = True\nnumpydoc_show_class_members = False\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#\nsource_suffix = ['.rst', '.md']\n# source_suffix = '.rst'\n\n# The encoding of source files.\n#\n# source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = 'pyhf'\ncopyright = '2018, Lukas Heinrich, Matthew Feickert, Giordon Stark'\nauthor = 'Lukas Heinrich, Matthew Feickert, Giordon Stark'\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# The full version, including alpha/beta/rc tags.\nrelease = get_distribution('pyhf').version\n# for example take major/minor/patch\nversion = '.'.join(release.split('.')[:3])\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# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#\n# today = ''\n#\n# Else, today_fmt is used as the format for a strftime call.\n#\n# today_fmt = '%B %d, %Y'\n\nautodoc_mock_imports = [\n 'tensorflow',\n 'torch',\n 'jax',\n 'iminuit',\n 'tensorflow_probability',\n]\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 = [\n '_build',\n 'JOSS',\n '**.ipynb_checkpoints',\n 'examples/experiments/edwardpyhf.ipynb',\n 'examples/notebooks/ImpactPlot.ipynb',\n 'examples/notebooks/Recast.ipynb',\n 'examples/notebooks/StatError.ipynb',\n 'examples/notebooks/example-tensorflow.ipynb',\n 'examples/notebooks/histogrammar.ipynb',\n 'examples/notebooks/histosys.ipynb',\n 'examples/notebooks/histosys-pytorch.ipynb',\n 'examples/notebooks/importxml.ipynb',\n 'examples/notebooks/multichannel-coupled-normsys.ipynb',\n 'examples/notebooks/multichannel-normsys.ipynb',\n 'examples/notebooks/normsys.ipynb',\n 'examples/notebooks/pullplot.ipynb',\n 'examples/notebooks/pytorch_tests_onoff.ipynb',\n 'examples/notebooks/tensorflow-limit.ipynb',\n]\n\n# The reST default role (used for this markup: `text`) to use for all\n# documents.\n#\n# default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#\n# add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#\n# add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#\n# show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n# modindex_common_prefix = []\n\n# If true, keep warnings as \"system message\" paragraphs in the built documents.\n# keep_warnings = False\n\n# If true, `todo` and `todoList` produce output, else they produce nothing.\ntodo_include_todos = False\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#\nhtml_theme = 'sphinx_rtd_theme'\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\n# Add any paths that contain custom themes here, relative to this directory.\nhtml_theme_path = []\n\n# The name for this set of Sphinx documents.\n# \"<project> v<release> documentation\" by default.\n#\n# html_title = u'pyhf v0.3.0'\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#\n# html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#\n# html_logo = None\n\n# The name of an image file (relative to this directory) to use as a favicon of\n# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#\n# html_favicon = None\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# Add any extra paths that contain custom files (such as robots.txt or\n# .htaccess) here, relative to this directory. These files are copied\n# directly to the root of the documentation.\n#\nhtml_extra_path = ['_extras']\n\n# If not None, a 'Last updated on:' timestamp is inserted at every page\n# bottom, using the given strftime format.\n# The empty string is equivalent to '%b %d, %Y'.\n#\n# html_last_updated_fmt = None\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#\n# html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#\n# html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#\n# html_additional_pages = {}\n\n# If false, no module index is generated.\n#\n# html_domain_indices = True\n\n# If false, no index is generated.\n#\n# html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#\n# html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#\n# html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#\n# html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#\n# html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#\n# html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n# html_file_suffix = None\n\n# Language to be used for generating the HTML full-text search index.\n# Sphinx supports the following languages:\n# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'\n# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'\n#\n# html_search_language = 'en'\n\n# A dictionary with options for the search language support, empty by default.\n# 'ja' uses this config value.\n# 'zh' user can custom change `jieba` dictionary path.\n#\n# html_search_options = {'type': 'default'}\n\n# The name of a javascript file (relative to the configuration directory) that\n# implements a search results scorer. If empty, the default will be used.\n#\n# html_search_scorer = 'scorer.js'\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'pyhfdoc'\n\n# sphinx-copybutton configuration\ncopybutton_prompt_text = \">>> \"\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 (\n master_doc,\n 'pyhf.tex',\n 'pyhf Documentation',\n 'Lukas Heinrich, Matthew Feickert, Giordon Stark',\n 'manual',\n )\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#\n# latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#\n# latex_use_parts = False\n\n# If true, show page references after internal links.\n#\n# latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#\n# latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#\n# latex_appendices = []\n\n# It false, will not define \\strong, \\code, \titleref, \\crossref ... but only\n# \\sphinxstrong, ..., \\sphinxtitleref, ... To help avoid clash with user added\n# packages.\n#\n# latex_keep_old_macro_names = True\n\n# If false, no module index is generated.\n#\n# latex_domain_indices = True\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, 'pyhf', 'pyhf Documentation', [author], 1)]\n\n# If true, show URL addresses after external links.\n#\n# man_show_urls = False\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 'pyhf',\n 'pyhf Documentation',\n author,\n 'pyhf',\n 'One line description of project.',\n 'Miscellaneous',\n )\n]\n\n# Documents to append as an appendix to all manuals.\n#\n# texinfo_appendices = []\n\n# If false, no module index is generated.\n#\n# texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#\n# texinfo_show_urls = 'footnote'\n\n# If true, do not generate a @detailmenu in the \"Top\" node's menu.\n#\n# texinfo_no_detailmenu = False\n\nmathjax_config = {\n 'tex2jax': {'inlineMath': [['$', '$'], ['\\\\(', '\\\\)']]},\n 'TeX': {\n 'Macros': {\n 'bm': [\"\\\\boldsymbol{#1}\", 1], # \\usepackage{bm}, see mathjax/MathJax#1219\n 'HiFa': r'\\texttt{HistFactory}',\n 'Root': r'\\texttt{ROOT}',\n 'RooStats': r'\\texttt{RooStats}',\n 'RooFit': r'\\texttt{RooFit}',\n 'pyhf': r'\\texttt{pyhf}',\n 'CLs': r'\\mathrm{CL}_{s}',\n 'freeset': r'\\bm{\\eta}',\n 'constrset': r'\\bm{\\chi}',\n 'singleconstr': r'\\chi',\n 'channelcounts': r'\\bm{n}',\n 'auxdata': r'\\bm{a}',\n 'poiset': r'\\bm{\\psi}',\n 'nuisset': r'\\bm{\\theta}',\n 'fullset': r'\\bm{\\phi}',\n 'singlefull': r'\\phi',\n 'TeV': r'\\textrm{TeV}',\n }\n },\n}\n", "path": "docs/conf.py"}], "after_files": [{"content": "#\n# pyhf documentation build configuration file, created by\n# sphinx-quickstart on Fri Feb 9 11:58:49 2018.\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 Path('../relative_path_to_dir').resolve() to make it absolute, like shown here.\n\nfrom pathlib import Path\nimport sys\nfrom pkg_resources import get_distribution\n\nsys.path.insert(0, str(Path('../src').resolve()))\nsys.path.insert(1, str(Path('./exts').resolve()))\n\n\ndef setup(app):\n app.add_css_file(\n 'https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.2/gh-fork-ribbon.min.css'\n )\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.autosummary',\n 'sphinx.ext.coverage',\n 'sphinx.ext.mathjax',\n 'sphinx.ext.ifconfig',\n 'sphinx.ext.viewcode',\n 'sphinx.ext.githubpages',\n 'sphinx.ext.intersphinx',\n 'sphinxcontrib.bibtex',\n 'sphinx.ext.napoleon',\n 'sphinx_click.ext',\n 'nbsphinx',\n 'sphinx_issues',\n 'sphinx_copybutton',\n 'xref',\n]\nbibtex_bibfiles = [\n \"bib/docs.bib\",\n \"bib/HEPData_likelihoods.bib\",\n \"bib/media.bib\",\n \"bib/posters.bib\",\n \"bib/preferred.bib\",\n \"bib/talks.bib\",\n \"bib/tutorials.bib\",\n \"bib/use_citations.bib\",\n]\n\n# external links\nxref_links = {\"arXiv:1007.1727\": (\"[1007.1727]\", \"https://arxiv.org/abs/1007.1727\")}\n\nintersphinx_mapping = {\n 'python': ('https://docs.python.org/3', None),\n 'numpy': ('http://docs.scipy.org/doc/numpy/', None),\n 'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),\n 'iminuit': ('https://iminuit.readthedocs.io/en/stable/', None),\n 'uproot': ('https://uproot.readthedocs.io/en/latest/', None),\n}\n\n# GitHub repo\nissues_github_path = 'scikit-hep/pyhf'\n\n# Generate the API documentation when building\nautosummary_generate = True\nnumpydoc_show_class_members = False\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#\nsource_suffix = ['.rst', '.md']\n# source_suffix = '.rst'\n\n# The encoding of source files.\n#\n# source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = 'pyhf'\ncopyright = '2018, Lukas Heinrich, Matthew Feickert, Giordon Stark'\nauthor = 'Lukas Heinrich, Matthew Feickert, Giordon Stark'\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# The full version, including alpha/beta/rc tags.\nrelease = get_distribution('pyhf').version\n# for example take major/minor/patch\nversion = '.'.join(release.split('.')[:3])\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# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#\n# today = ''\n#\n# Else, today_fmt is used as the format for a strftime call.\n#\n# today_fmt = '%B %d, %Y'\n\nautodoc_mock_imports = [\n 'tensorflow',\n 'torch',\n 'jax',\n 'iminuit',\n 'tensorflow_probability',\n]\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 = [\n '_build',\n 'JOSS',\n '**.ipynb_checkpoints',\n 'examples/experiments/edwardpyhf.ipynb',\n 'examples/notebooks/ImpactPlot.ipynb',\n 'examples/notebooks/Recast.ipynb',\n 'examples/notebooks/StatError.ipynb',\n 'examples/notebooks/example-tensorflow.ipynb',\n 'examples/notebooks/histogrammar.ipynb',\n 'examples/notebooks/histosys.ipynb',\n 'examples/notebooks/histosys-pytorch.ipynb',\n 'examples/notebooks/importxml.ipynb',\n 'examples/notebooks/multichannel-coupled-normsys.ipynb',\n 'examples/notebooks/multichannel-normsys.ipynb',\n 'examples/notebooks/normsys.ipynb',\n 'examples/notebooks/pullplot.ipynb',\n 'examples/notebooks/pytorch_tests_onoff.ipynb',\n 'examples/notebooks/tensorflow-limit.ipynb',\n]\n\n# The reST default role (used for this markup: `text`) to use for all\n# documents.\n#\n# default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#\n# add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#\n# add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#\n# show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n# modindex_common_prefix = []\n\n# If true, keep warnings as \"system message\" paragraphs in the built documents.\n# keep_warnings = False\n\n# If true, `todo` and `todoList` produce output, else they produce nothing.\ntodo_include_todos = False\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#\nhtml_theme = 'sphinx_rtd_theme'\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\n# Add any paths that contain custom themes here, relative to this directory.\nhtml_theme_path = []\n\n# The name for this set of Sphinx documents.\n# \"<project> v<release> documentation\" by default.\n#\n# html_title = u'pyhf v0.3.0'\n\n# A shorter title for the navigation bar. Default is the same as html_title.\n#\n# html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#\n# html_logo = None\n\n# The name of an image file (relative to this directory) to use as a favicon of\n# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\n#\n# html_favicon = None\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# Add any extra paths that contain custom files (such as robots.txt or\n# .htaccess) here, relative to this directory. These files are copied\n# directly to the root of the documentation.\n#\nhtml_extra_path = ['_extras']\n\n# If not None, a 'Last updated on:' timestamp is inserted at every page\n# bottom, using the given strftime format.\n# The empty string is equivalent to '%b %d, %Y'.\n#\n# html_last_updated_fmt = None\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#\n# html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#\n# html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#\n# html_additional_pages = {}\n\n# If false, no module index is generated.\n#\n# html_domain_indices = True\n\n# If false, no index is generated.\n#\n# html_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#\n# html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#\n# html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#\n# html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#\n# html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it. The value of this option must be the\n# base URL from which the finished HTML is served.\n#\n# html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n# html_file_suffix = None\n\n# Language to be used for generating the HTML full-text search index.\n# Sphinx supports the following languages:\n# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'\n# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'\n#\n# html_search_language = 'en'\n\n# A dictionary with options for the search language support, empty by default.\n# 'ja' uses this config value.\n# 'zh' user can custom change `jieba` dictionary path.\n#\n# html_search_options = {'type': 'default'}\n\n# The name of a javascript file (relative to the configuration directory) that\n# implements a search results scorer. If empty, the default will be used.\n#\n# html_search_scorer = 'scorer.js'\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'pyhfdoc'\n\n# sphinx-copybutton configuration\ncopybutton_prompt_text = \">>> \"\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 (\n master_doc,\n 'pyhf.tex',\n 'pyhf Documentation',\n 'Lukas Heinrich, Matthew Feickert, Giordon Stark',\n 'manual',\n )\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#\n# latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#\n# latex_use_parts = False\n\n# If true, show page references after internal links.\n#\n# latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#\n# latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#\n# latex_appendices = []\n\n# It false, will not define \\strong, \\code, \titleref, \\crossref ... but only\n# \\sphinxstrong, ..., \\sphinxtitleref, ... To help avoid clash with user added\n# packages.\n#\n# latex_keep_old_macro_names = True\n\n# If false, no module index is generated.\n#\n# latex_domain_indices = True\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, 'pyhf', 'pyhf Documentation', [author], 1)]\n\n# If true, show URL addresses after external links.\n#\n# man_show_urls = False\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 'pyhf',\n 'pyhf Documentation',\n author,\n 'pyhf',\n 'One line description of project.',\n 'Miscellaneous',\n )\n]\n\n# Documents to append as an appendix to all manuals.\n#\n# texinfo_appendices = []\n\n# If false, no module index is generated.\n#\n# texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#\n# texinfo_show_urls = 'footnote'\n\n# If true, do not generate a @detailmenu in the \"Top\" node's menu.\n#\n# texinfo_no_detailmenu = False\n\nmathjax_config = {\n 'tex2jax': {'inlineMath': [['$', '$'], ['\\\\(', '\\\\)']]},\n 'TeX': {\n 'Macros': {\n 'bm': [\"\\\\boldsymbol{#1}\", 1], # \\usepackage{bm}, see mathjax/MathJax#1219\n 'HiFa': r'\\texttt{HistFactory}',\n 'Root': r'\\texttt{ROOT}',\n 'RooStats': r'\\texttt{RooStats}',\n 'RooFit': r'\\texttt{RooFit}',\n 'pyhf': r'\\texttt{pyhf}',\n 'CLs': r'\\mathrm{CL}_{s}',\n 'freeset': r'\\bm{\\eta}',\n 'constrset': r'\\bm{\\chi}',\n 'singleconstr': r'\\chi',\n 'channelcounts': r'\\bm{n}',\n 'auxdata': r'\\bm{a}',\n 'poiset': r'\\bm{\\psi}',\n 'nuisset': r'\\bm{\\theta}',\n 'fullset': r'\\bm{\\phi}',\n 'singlefull': r'\\phi',\n 'TeV': r'\\textrm{TeV}',\n }\n },\n}\n", "path": "docs/conf.py"}]} |
gh_patches_debug_273 | rasdani/github-patches | git_diff | huggingface__trl-154 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Error with official examples
Hi, I am running the official example script on t5 using sentiment as reward function, and after 97 iterations the following error is raised:
```
╭───────────────────── Traceback (most recent call last) ──────────────────────╮
│ /home/alejandro.vaca/trl/examples/sentiment/scripts/t5-sentiment.py:126 in │
│ <module> │
│ │
│ 123 │ rewards = [torch.tensor(output[1]["score"]).to(device) for output │
│ 124 │ │
│ 125 │ #### Run PPO step │
│ ❱ 126 │ stats = ppo_trainer.step(query_tensors, response_tensors, rewards) │
│ 127 │ ppo_trainer.log_stats(stats, batch, rewards) │
│ 128 │
│ │
│ /home/alejandro.vaca/trl/trl/trainer/ppo_trainer.py:432 in step │
│ │
│ 429 │ │ """ │
│ 430 │ │ bs = self.config.batch_size │
│ 431 │ │ │
│ ❱ 432 │ │ queries, responses, scores = self._step_safety_checker(bs, que │
│ 433 │ │ │
│ 434 │ │ timing = dict() │
│ 435 │ │ t0 = time.time() │
│ │
│ /home/alejandro.vaca/trl/trl/trainer/ppo_trainer.py:392 in │
│ _step_safety_checker │
│ │
│ 389 │ │ │ if not isinstance(tensor_list[0], torch.Tensor): │
│ 390 │ │ │ │ raise ValueError(f"Elements in {name} must tensors - g │
│ 391 │ │ │ if batch_size is not None and len(tensor_list) != batch_si │
│ ❱ 392 │ │ │ │ raise ValueError( │
│ 393 │ │ │ │ │ f"Batch size ({batch_size}) does not match number │
│ 394 │ │ │ │ ) │
│ 395 │
╰──────────────────────────────────────────────────────────────────────────────╯
ValueError: Batch size (256) does not match number of examples - but got 63 for:
queries
```
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `trl/trainer/ppo_trainer.py`
Content:
```
1 # Copyright 2022 The HuggingFace Team. 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 import inspect
15 import logging
16 import os
17 import random
18 import time
19 import warnings
20 from typing import List, Optional, Union
21
22 import datasets
23 import torch
24 from accelerate import Accelerator
25 from datasets import Dataset
26 from huggingface_hub import whoami
27 from packaging import version
28 from torch.optim import Adam
29 from transformers import DataCollatorForLanguageModeling, PreTrainedTokenizer, PreTrainedTokenizerFast
30
31 from ..core import (
32 WANDB_PADDING,
33 clip_by_value,
34 convert_to_scalar,
35 entropy_from_logits,
36 flatten_dict,
37 logprobs_from_logits,
38 set_seed,
39 stack_dicts,
40 stats_to_np,
41 whiten,
42 )
43 from ..models import SUPPORTED_ARCHITECTURES, PreTrainedModelWrapper, create_reference_model
44 from . import AdaptiveKLController, BaseTrainer, FixedKLController, PPOConfig
45
46
47 MODEL_CARD_TEMPLATE = """---
48 license: apache-2.0
49 tags:
50 - trl
51 - transformers
52 - reinforcement-learning
53 ---
54
55 # {model_name}
56
57 This is a [TRL language model](https://github.com/lvwerra/trl) that has been fine-tuned with reinforcement learning to
58 guide the model outputs according to a value, function, or human feedback. The model can be used for text generation.
59
60 ## Usage
61
62 To use this model for inference, first install the TRL library:
63
64 ```bash
65 python -m pip install trl
66 ```
67
68 You can then generate text as follows:
69
70 ```python
71 from transformers import pipeline
72
73 generator = pipeline("text-generation", model="{model_id}")
74 outputs = generator("Hello, my llama is cute")
75 ```
76
77 If you want to use the model for training or to obtain the outputs from the value head, load the model as follows:
78
79 ```python
80 from transformers import AutoTokenizer
81 from trl import AutoModelForCausalLMWithValueHead
82
83 tokenizer = AutoTokenizer.from_pretrained("{model_id}")
84 model = AutoModelForCausalLMWithValueHead.from_pretrained("{model_id}")
85
86 inputs = tokenizer("Hello, my llama is cute", return_tensors="pt")
87 outputs = model(**inputs, labels=inputs["input_ids"])
88 ```
89 """
90
91
92 class PPOTrainer(BaseTrainer):
93 """
94 The PPOTrainer uses Proximal Policy Optimization to optimise language models.
95 Note, this trainer is heavily inspired by the original OpenAI learning to summarize work here:
96 https://github.com/openai/summarize-from-feedback
97
98 Attributes:
99 **config** (`PPOConfig`) -- Configuration object for PPOTrainer. Check the documentation of `PPOConfig` for more
100 details.
101 **model** (`PreTrainedModelWrapper`) -- Model to be optimized, Hugging Face transformer model with a value head.
102 Check the documentation of `PreTrainedModelWrapper` for more details.
103 **ref_model** (`PreTrainedModelWrapper`, *optional*) -- Reference model to be used for KL penalty, Hugging Face
104 transformer model with a casual language modelling head. Check the documentation of `PreTrainedModelWrapper`
105 for more details. If no reference model is provided, the trainer will create a reference model with the same
106 architecture as the model to be optimized with shared layers.
107 **tokenizer** (`Union[PreTrainedTokenizer, PreTrainedTokenizerFast]`) -- Tokenizer to be used for encoding the
108 data. Check the documentation of `transformers.PreTrainedTokenizer` and
109 `transformers.PreTrainedTokenizerFast` for more details.
110 **dataset** (Union[`torch.utils.data.Dataset`, `datasets.Dataset`], *optional*) -- PyTorch dataset or Hugging
111 Face dataset. This is used to create a PyTorch dataloader. If no dataset is provided, the dataloader must be
112 created outside the trainer users needs to design their own dataloader and make sure the batch
113 size that is used is the same as the one specified in the configuration object.
114 **optimizer** (`torch.optim.Optimizer`, *optional*) -- Optimizer to be used for training. If no optimizer is
115 provided, the trainer will create an Adam optimizer with the learning rate specified in the configuration
116 object.
117 **data_collator** (DataCollatorForLanguageModeling, *optional*) -- Data collator to be used for training and
118 passed along the dataloader
119 **num_shared_layers** (int, *optional*) -- Number of layers to be shared between the model and the reference
120 model, if no reference model is passed. If no number is provided, all the layers will be shared.
121 **lr_scheduler** (`torch.optim.lr_scheduler`, *optional*) -- Learning rate scheduler to be used for training.
122 """
123
124 def __init__(
125 self,
126 config: PPOConfig = None,
127 model: PreTrainedModelWrapper = None,
128 ref_model: PreTrainedModelWrapper = None,
129 tokenizer: Union[PreTrainedTokenizer, PreTrainedTokenizerFast] = None,
130 dataset: Optional[Union[torch.utils.data.Dataset, Dataset]] = None,
131 optimizer: Optional[torch.optim.Optimizer] = None,
132 data_collator=None,
133 num_shared_layers: Optional[int] = None,
134 lr_scheduler: Optional[torch.optim.lr_scheduler._LRScheduler] = None,
135 ):
136 """
137 Initialize PPOTrainer.
138
139 Args:
140 config (`PPOConfig`):
141 Configuration object for PPOTrainer. Check the documentation of `PPOConfig` for more details.
142 model (`PreTrainedModelWrapper`):
143 Hugging Face transformer model with a value head.
144 ref_model (`PreTrainedModelWrapper`):
145 Hugging Face transformer model with a casual language modelling head. Used for KL penalty
146 tokenizer (`transformers.PreTrainedTokenizer`):
147 Hugging Face tokenizer
148 dataset (Union[`torch.utils.data.Dataset`, `datasets.Dataset`], *optional*):
149 PyTorch dataset or Hugging Face dataset. If a Hugging Face dataset is passed, the dataset
150 will be preprocessed by removing the columns that are not used by the model. If none is passed,
151 a warning will be raised in a multi-GPU setting.
152 optimizer (Optional[`torch.optim.Optimizer`]):
153 Optimizer used for training. If `None`, the `Adam` is used as default.
154 data_collator (Optional[function]):
155 Data collator function.
156 num_shared_layers (Optional[int]):
157 Number of shared layers between the model and the reference model. If `None`, all layers are shared.
158 used only if `ref_model` is `None`.
159 lr_scheduler (Optional[`torch.optim.lr_scheduler`]):
160 Learning rate scheduler used for training.
161 """
162 super().__init__(config)
163
164 # initial seed for reproducible experiments
165 set_seed(config.seed)
166
167 # Step 0: check positional arguments validity
168 if not isinstance(config, PPOConfig):
169 raise ValueError(f"config must be a PPOConfig, got {type(config)}")
170 if not isinstance(tokenizer, (PreTrainedTokenizer, PreTrainedTokenizerFast)):
171 raise ValueError(
172 f"tokenizer must be a PreTrainedTokenizer or PreTrainedTokenizerFast, got {type(tokenizer)}"
173 )
174 if not isinstance(model, PreTrainedModelWrapper):
175 raise ValueError(
176 f"model must be a PreTrainedModelWrapper, got {type(model)} - supported architectures are: {SUPPORTED_ARCHITECTURES}"
177 )
178 # Step 1: Initialize Accelerator
179 self.accelerator = Accelerator(log_with=config.log_with, **config.accelerator_kwargs)
180 self.accelerator.init_trackers(config.tracker_project_name, config=config.to_dict(), **config.tracker_kwargs)
181
182 self.model = model
183 self.is_encoder_decoder = hasattr(self.model, "is_encoder_decoder")
184
185 if isinstance(ref_model, PreTrainedModelWrapper):
186 self.ref_model = ref_model
187 if num_shared_layers is not None:
188 warnings.warn(
189 "num_shared_layers is ignored when ref_model is provided. Two different models are used for the "
190 "model and the reference model and no layers are shared.",
191 UserWarning,
192 )
193 elif ref_model is None:
194 self.ref_model = create_reference_model(self.model, num_shared_layers=num_shared_layers)
195 else:
196 raise ValueError(
197 f"ref_model must be a PreTrainedModelWrapper or `None`, got {type(ref_model)} - supported "
198 f"architectures are: {SUPPORTED_ARCHITECTURES} "
199 )
200
201 if not (isinstance(tokenizer, PreTrainedTokenizer) or isinstance(tokenizer, PreTrainedTokenizerFast)):
202 raise ValueError(
203 "tokenizer must be a transformers.PreTrainedTokenizer or transformers.PreTrainedTokenizerFast"
204 )
205 self.tokenizer = tokenizer
206
207 if dataset is not None and not (isinstance(dataset, torch.utils.data.Dataset) or isinstance(dataset, Dataset)):
208 raise ValueError("dataloader must be a torch.utils.data.Dataset or datasets.Dataset")
209 elif dataset is None:
210 warnings.warn(
211 "No dataset is provided. Make sure to set config.batch_size to the correct value before training.",
212 UserWarning,
213 )
214 self.dataset = dataset
215 self._signature_columns = None
216 if self.dataset is not None:
217 self.dataloader = self.prepare_dataloader(self.dataset, data_collator)
218 elif self.dataset is None and self.accelerator.num_processes > 1:
219 warnings.warn(
220 "No dataset is provided. In a multi-GPU setting, this will lead to an error. You should",
221 " prepare your dataloader yourself with `dataloader = ppo_trainer.accelerator.prepare(dataloader)`",
222 " and using `torch.utils.data.DataLoader`, or pass a dataset to the `PPOTrainer`. Please ",
223 " refer to the documentation for more details.",
224 UserWarning,
225 )
226 self.dataloader = None
227 else:
228 self.dataloader = None
229
230 # Step 3: Initialize optimizer and data collator
231 self.data_collator = DataCollatorForLanguageModeling(self.tokenizer, mlm=False)
232 if optimizer is None:
233 self.optimizer = Adam(self.model.parameters(), lr=self.config.learning_rate)
234 else:
235 self.optimizer = optimizer
236
237 self.lr_scheduler = lr_scheduler
238 if self.lr_scheduler is not None:
239 if not isinstance(self.lr_scheduler, torch.optim.lr_scheduler._LRScheduler):
240 raise ValueError("lr_scheduler must be a torch.optim.lr_scheduler._LRScheduler")
241
242 if self.config.adap_kl_ctrl:
243 self.kl_ctl = AdaptiveKLController(self.config.init_kl_coef, self.config.target, self.config.horizon)
244 else:
245 self.kl_ctl = FixedKLController(self.config.init_kl_coef)
246
247 (
248 self.model,
249 self.ref_model,
250 self.optimizer,
251 self.data_collator,
252 self.dataloader,
253 self.lr_scheduler,
254 ) = self.accelerator.prepare(
255 self.model, self.ref_model, self.optimizer, self.data_collator, self.dataloader, self.lr_scheduler
256 )
257
258 # In a distributed setup, only logging needs to be performed on the main process
259 # check: https://pytorch.org/docs/stable/generated/torch.nn.parallel.DistributedDataParallel.html
260 # or: https://discuss.pytorch.org/t/use-distributed-data-parallel-correctly/82500/11
261 self.is_distributed = self.accelerator.distributed_type == "MULTI_GPU"
262
263 # init the current step
264 self.current_step = 0
265
266 # init wandb on the main process:
267 if self.accelerator.is_main_process and self.config.log_with == "wandb":
268 import wandb
269
270 wandb.watch(self.model, log="all")
271
272 if self.config.forward_batch_size > 1 and (self.is_encoder_decoder or self.tokenizer.padding_side == "left"):
273 # warn users that this is not well supported yet
274 logging.warning(
275 "Forward batch size > 1 is not well supported yet for encoder-decoder models and when using `tokenizer.padding_side='left'`. This can lead to unexpected behaviour."
276 " therefore, we recommend using forward_batch_size=1."
277 )
278
279 def _filter_kwargs(self, kwargs, target_func):
280 """
281 filter the keyword arguments that are supported by the target function.
282
283 Args:
284 kwargs (dict):
285 Keyword arguments
286 target_func (function):
287 Target function
288 """
289 return {k: v for k, v in kwargs.items() if k in inspect.signature(target_func).parameters.keys()}
290
291 def prepare_dataloader(self, dataset: Union[torch.utils.data.Dataset, Dataset], data_collator=None):
292 """
293 Prepare the dataloader for training.
294
295 Args:
296 dataset (Union[`torch.utils.data.Dataset`, `datasets.Dataset`]):
297 PyTorch dataset or Hugging Face dataset. If a Hugging Face dataset is passed, the dataset
298 will be preprocessed by removing the columns that are not used by the model.
299 data_collator (Optional[function]):
300 Data collator function.
301
302 Returns:
303 `torch.utils.data.DataLoader`: PyTorch dataloader
304 """
305 if isinstance(dataset, Dataset):
306 dataset = self._remove_unused_columns(dataset)
307 dataloader = torch.utils.data.DataLoader(
308 dataset,
309 batch_size=self.config.batch_size,
310 collate_fn=data_collator,
311 shuffle=True,
312 )
313 return dataloader
314
315 # Adapted from transformers.Trainer._set_signature_columns_if_needed
316 def _set_signature_columns_if_needed(self):
317 if self._signature_columns is None:
318 # Inspect model forward signature to keep only the arguments it accepts.
319 signature = inspect.signature(self.model.forward)
320 self._signature_columns = list(signature.parameters.keys())
321 # label => sentiment | we need query and response for logging purpose
322 self._signature_columns += list(set(["label", "query", "response"]))
323
324 # Adapted from transformers.Trainer._remove_unused_columns
325 def _remove_unused_columns(self, dataset: "Dataset"):
326 if not self.config.remove_unused_columns:
327 return dataset
328 self._set_signature_columns_if_needed()
329 signature_columns = self._signature_columns
330
331 ignored_columns = list(set(dataset.column_names) - set(signature_columns))
332
333 columns = [k for k in signature_columns if k in dataset.column_names]
334
335 if version.parse(datasets.__version__) < version.parse("1.4.0"):
336 dataset.set_format(
337 type=dataset.format["type"], columns=columns, format_kwargs=dataset.format["format_kwargs"]
338 )
339 return dataset
340 else:
341 return dataset.remove_columns(ignored_columns)
342
343 def generate(self, query_tensor: torch.Tensor, **generation_kwargs):
344 """
345 Generate response with the model given the query tensor.
346 call the `generate` method of the model.
347
348 Args:
349 query_tensor (`torch.LongTensor`):
350 A tensor of shape (`batch_size`, `seq_len`) containing query tokens.
351 generation_kwargs (dict[str, Any]):
352 Keyword arguments for generation.
353
354 Returns:
355 `torch.LongTensor`: A tensor of shape (`batch_size`, `gen_len`) containing response tokens.
356 """
357 response = self.accelerator.unwrap_model(self.model).generate(
358 query_tensor.unsqueeze(dim=0), **generation_kwargs
359 )
360
361 return response
362
363 def _step_safety_checker(
364 self,
365 batch_size: int,
366 queries: List[torch.LongTensor],
367 responses: List[torch.LongTensor],
368 scores: List[torch.FloatTensor],
369 ):
370 """
371 Check if the input data is valid for training.
372
373 Args:
374 batch_size (int):
375 Batch size from the config file.
376 queries (List[`torch.LongTensor`]):
377 List of tensors containing the encoded queries of shape (`query_length`)
378 responses (List[`torch.LongTensor`]):
379 List of tensors containing the encoded responses of shape (`response_length`)
380 scores (List[`torch.FloatTensor`]):
381 List of tensors containing the scores.
382 Returns:
383 `tuple`: The input processed data.
384 """
385 for name, tensor_list in zip(["queries", "responses", "scores"], [queries, responses, scores]):
386 if not isinstance(tensor_list, list):
387 raise ValueError(f"{name} must be a list of tensors - got {type(tensor_list)}")
388 if not isinstance(tensor_list[0], torch.Tensor):
389 raise ValueError(f"Elements in {name} must tensors - got {type(tensor_list[0])}")
390 if batch_size is not None and len(tensor_list) != batch_size:
391 raise ValueError(
392 f"Batch size ({batch_size}) does not match number of examples - but got {len(tensor_list)} for: {name}"
393 )
394
395 # add queries, scores and responses on the correct device
396 queries = [tensor.to(self.accelerator.device) for tensor in queries]
397 responses = [tensor.to(self.accelerator.device) for tensor in responses]
398 scores = [tensor.to(self.accelerator.device) for tensor in scores]
399
400 # squeeze scores if needed
401 for i, score in enumerate(scores):
402 if score.dim() > 1:
403 raise ValueError(f"Scores must be 1-dimensional - got {score.dim()} for {score}")
404 elif score.dim() == 1:
405 scores[i] = score.squeeze()
406
407 return queries, responses, scores
408
409 def step(
410 self,
411 queries: List[torch.LongTensor],
412 responses: List[torch.LongTensor],
413 scores: List[torch.FloatTensor],
414 ):
415 """
416 Run a PPO optimisation step given a list of queries, model responses, and rewards.
417
418 Args:
419 queries (List[`torch.LongTensor`]):
420 List of tensors containing the encoded queries of shape (`query_length`)
421 responses (List[`torch.LongTensor`]):
422 List of tensors containing the encoded responses of shape (`response_length`)
423 scores (List[`torch.FloatTensor`]):
424 List of tensors containing the scores.
425
426 Returns:
427 `dict[str, Any]`: A summary of the training statistics
428 """
429 bs = self.config.batch_size
430
431 queries, responses, scores = self._step_safety_checker(bs, queries, responses, scores)
432
433 timing = dict()
434 t0 = time.time()
435
436 t = time.time()
437
438 logprobs, ref_logprobs, values = self.batched_forward_pass(queries, responses)
439 timing["time/ppo/forward_pass"] = time.time() - t
440
441 t = time.time()
442 rewards, non_score_reward = self.compute_rewards(scores, logprobs, ref_logprobs)
443 timing["time/ppo/compute_rewards"] = time.time() - t
444
445 t = time.time()
446 all_stats = []
447 idxs = list(range(bs))
448 for _ in range(self.config.ppo_epochs):
449 random.shuffle(idxs)
450 for i in range(bs):
451 idx = idxs[i]
452 train_stats = self.train_minibatch(
453 logprobs[idx].unsqueeze(0),
454 values[idx].unsqueeze(0),
455 rewards[idx].unsqueeze(0),
456 queries[idx].unsqueeze(0),
457 responses[idx].unsqueeze(0),
458 torch.cat([queries[idx], responses[idx]]).unsqueeze(0),
459 )
460 all_stats.append(train_stats)
461 timing["time/ppo/optimize_step"] = time.time() - t
462
463 t = time.time()
464 train_stats = stack_dicts(all_stats)
465
466 # reshape advantages/ratios such that they are not averaged.
467 train_stats["policy/advantages"] = torch.flatten(train_stats["policy/advantages"]).unsqueeze(0)
468 train_stats["policy/advantages"] = torch.nan_to_num(train_stats["policy/advantages"], WANDB_PADDING)
469 train_stats["policy/ratio"] = torch.flatten(train_stats["policy/ratio"]).unsqueeze(0)
470
471 stats = self.record_step_stats(
472 scores=scores,
473 logprobs=logprobs,
474 ref_logprobs=ref_logprobs,
475 non_score_reward=non_score_reward,
476 train_stats=train_stats,
477 kl_coef=self.kl_ctl.value,
478 )
479 # Gather/Reduce stats from all processes
480 if self.is_distributed:
481 stats = self.gather_stats(stats)
482 stats = stats_to_np(stats)
483 timing["time/ppo/calc_stats"] = time.time() - t
484 stats["ppo/learning_rate"] = self.optimizer.param_groups[0]["lr"]
485
486 # Update the KL control - multiply the batch_size by the number of processes
487 self.kl_ctl.update(stats["objective/kl"], self.config.batch_size * self.accelerator.num_processes)
488
489 # Log the total ppo time
490 timing["time/ppo/total"] = time.time() - t0
491 stats.update(timing)
492
493 # post-process stats for tensorboard and other loggers
494 if self.config.log_with != "wandb":
495 stats = convert_to_scalar(stats)
496
497 if self.lr_scheduler is not None:
498 self.lr_scheduler.step()
499
500 return stats
501
502 def gather_stats(self, stats):
503 """
504 Gather stats from all processes. Useful in the context of distributed training.
505
506 Args:
507 stats (dict[str, Any]):
508 a dictionary of stats to be gathered. The stats should contain torch tensors.
509
510 Returns:
511 `dict[str, Any]`: A dictionary of stats with the tensors gathered.
512 """
513 import torch.distributed as dist
514
515 # Wait for all processes to finish
516 dist.barrier()
517
518 for k, v in stats.items():
519 if isinstance(v, torch.Tensor):
520 dist.all_reduce(v, dist.ReduceOp.SUM)
521 v /= self.accelerator.num_processes
522 stats[k] = v
523 return stats
524
525 def batched_forward_pass(
526 self,
527 queries: torch.Tensor,
528 responses: torch.Tensor,
529 ):
530 """
531 Calculate model outputs in multiple batches.
532
533 Args:
534 queries (`torch.LongTensor`):
535 List of tensors containing the encoded queries, shape (`batch_size`, `query_length`)
536 responses (`torch.LongTensor`):
537 List of tensors containing the encoded responses, shape (`batch_size`, `response_length`)
538 Returns:
539 (tuple):
540 - all_logprobs (`torch.FloatTensor`): Log probabilities of the responses,
541 shape (`batch_size`, `response_length`)
542 - all_ref_logprobs (`torch.FloatTensor`): Log probabilities of the responses,
543 shape (`batch_size`, `response_length`)
544 - all_values (`torch.FloatTensor`): Values of the responses, shape (`batch_size`, `response_length`)
545 """
546 bs = self.config.batch_size
547 fbs = self.config.forward_batch_size
548 all_logprobs = []
549 all_ref_logprobs = []
550 all_values = []
551
552 # attention_masks are create with the same shape as inputs and are
553 # automatically padded by the datacollator to indicate padding tokens
554 if self.is_encoder_decoder:
555 input_data = self.data_collator(
556 [{"input_ids": q, "attention_mask": torch.ones_like(q)} for q in queries]
557 ).to(self.accelerator.device)
558
559 decoder_inputs = self.data_collator(
560 [{"input_ids": r, "attention_mask": torch.ones_like(r)} for r in responses]
561 ).to(self.accelerator.device)
562
563 input_data["decoder_input_ids"] = decoder_inputs["input_ids"]
564 input_data["decoder_attention_mask"] = decoder_inputs["attention_mask"]
565
566 input_data.pop("labels") # we don't want to compute LM losses
567
568 else:
569 input_ids = [torch.cat([q, r]) for q, r in zip(queries, responses)]
570 input_data = self.data_collator(
571 [{"input_ids": ids, "attention_mask": torch.ones_like(ids)} for ids in input_ids]
572 ).to(self.accelerator.device)
573
574 for i in range(int(bs / fbs)):
575 input_kwargs = {key: value[i * fbs : (i + 1) * fbs] for key, value in input_data.items()}
576 query_batch = queries[i * fbs : (i + 1) * fbs]
577 response_batch = responses[i * fbs : (i + 1) * fbs]
578
579 with torch.no_grad():
580 logits, _, v = self.model(**input_kwargs)
581 ref_logits, _, _ = self.ref_model(**input_kwargs)
582
583 if self.is_encoder_decoder:
584 input_ids = input_kwargs["decoder_input_ids"]
585 attention_mask = input_kwargs["decoder_attention_mask"]
586 else:
587 input_ids = input_kwargs["input_ids"]
588 attention_mask = input_kwargs["attention_mask"]
589
590 logprobs = logprobs_from_logits(logits[:, :-1, :], input_ids[:, 1:])
591 ref_logprobs = logprobs_from_logits(ref_logits[:, :-1, :], input_ids[:, 1:])
592
593 for j in range(fbs):
594 if self.is_encoder_decoder:
595 # Decoder sentence starts always in the index 1 after padding in the Enc-Dec Models
596 start = 1
597 end = attention_mask[j, :].sum() - 1
598 else:
599 start = len(query_batch[j]) - 1
600 if attention_mask[j, 0] == 0: # offset left padding
601 start += attention_mask[j, :].nonzero()[0]
602 end = start + len(response_batch[j])
603
604 if len(logprobs[j, start:end]) < 2:
605 raise ValueError("Responses are too short. Make sure they are at least 4 tokens long.")
606
607 all_values.append(v[j, start:end])
608 all_logprobs.append(logprobs[j, start:end])
609 all_ref_logprobs.append(ref_logprobs[j, start:end])
610
611 return all_logprobs, all_ref_logprobs, all_values
612
613 def train_minibatch(
614 self,
615 old_logprobs: torch.FloatTensor,
616 values: torch.FloatTensor,
617 rewards: torch.FloatTensor,
618 query: torch.LongTensor,
619 response: torch.LongTensor,
620 model_input: torch.LongTensor,
621 ):
622 """
623 Train one PPO minibatch
624
625 Args:
626 logprobs (`torch.FloatTensor`):
627 Log probabilities of the model, shape [batch_size, response_length]
628 values (`torch.FloatTensor`):
629 Values of the value head, shape [batch_size, response_length]
630 rewards (`torch.FloatTensor`):
631 Rewards from the reward model, shape [batch_size, response_length]
632 query (`torch.LongTensor`):
633 Encoded queries, shape [batch_size, query_length]
634 response (`torch.LongTensor`):
635 Encoded responses, shape [batch_size, response_length]
636 model_input (`torch.LongTensor`):
637 Concatenated queries and responses, shape [batch_size, query_length+response_length]
638
639 Returns:
640 train_stats (dict[str, `torch.Tensor`]):
641 Dictionary of training statistics
642 """
643 logprobs, vpred, logits = self.compute_logits_vpred(model_input, query, response, rewards)
644
645 loss_p, loss_v, train_stats = self.loss(old_logprobs, values, rewards, logits, vpred, logprobs)
646 loss = loss_p + loss_v
647 self.optimizer.zero_grad()
648 self.accelerator.backward(loss)
649 t = time.time()
650 self.optimizer.step()
651 train_stats["time/ppo/optimizer_step"] = torch.Tensor([time.time() - t]).to(self.accelerator.device)
652 return train_stats
653
654 def compute_rewards(self, scores: torch.FloatTensor, logprobs: torch.FloatTensor, ref_logprobs: torch.FloatTensor):
655 """
656 Compute per token rewards from scores and KL-penalty.
657
658 Args:
659 scores (`torch.FloatTensor`):
660 Scores from the reward model, shape (`batch_size`)
661 logprobs (`torch.FloatTensor`):
662 Log probabilities of the model, shape (`batch_size`, `response_length`)
663 ref_logprobs (`torch.FloatTensor`):
664 Log probabilities of the reference model, shape (`batch_size`, `response_length`)
665 """
666 rewards, non_score_rewards = [], []
667 for score, logprob, ref_logprob in zip(scores, logprobs, ref_logprobs):
668 kl = logprob - ref_logprob
669 non_score_reward = -self.kl_ctl.value * kl
670 non_score_rewards.append(non_score_reward)
671 reward = non_score_reward.clone()
672 reward[-1] += score
673 rewards.append(reward)
674 return rewards, non_score_rewards
675
676 def compute_logits_vpred(
677 self,
678 model_input,
679 query: torch.LongTensor,
680 response: torch.LongTensor,
681 rewards,
682 ):
683 input_kwargs = {
684 "input_ids": model_input,
685 }
686
687 if self.is_encoder_decoder:
688 input_kwargs["input_ids"] = query
689 input_kwargs["decoder_input_ids"] = response
690 model_input = response
691
692 logits, _, vpred = self.model(**input_kwargs)
693 gen_len = rewards.shape[-1]
694
695 if self.is_encoder_decoder:
696 logprob = logprobs_from_logits(logits[:, :-1, :], model_input[:, 1:])
697 start, end = 1, response.shape[-1] - 1
698 vpred = vpred[:, start:end]
699 logprob = logprob[:, start:end]
700 else:
701 logprob = logprobs_from_logits(logits[:, :-1, :], model_input[:, 1:])
702 logprob, vpred = logprob[:, -gen_len:], vpred[:, -gen_len:]
703
704 return logprob, vpred, logits
705
706 def loss(
707 self,
708 old_logprobs: torch.FloatTensor,
709 values: torch.FloatTensor,
710 rewards: torch.FloatTensor,
711 logits: torch.FloatTensor,
712 vpred: torch.FloatTensor,
713 logprob: torch.FloatTensor,
714 ):
715 """
716 Calculate policy and value losses.
717
718 Args:
719 old_logprobs (`torch.FloatTensor`):
720 Log probabilities of the model, shape (`batch_size`, `response_length`)
721 values (`torch.FloatTensor`):
722 Values of the value head, shape (`batch_size`, `hidden_dim`)
723 rewards (`torch.FloatTensor`):
724 Rewards from the reward model, shape (`batch_size`)
725 logits (`torch.FloatTensor`):
726 Logits of the model, shape (`batch_size`, `response_length`, `vocab_size`)
727 v_pred (`torch.FloatTensor`):
728 Values of the value head, shape (`batch_size`, `response_length`)
729 logprobs (`torch.FloatTensor`):
730 Log probabilities of the model, shape (`batch_size`, `response_length`)
731 """
732 lastgaelam = 0
733 advantages_reversed = []
734 gen_len = rewards.shape[-1]
735
736 for t in reversed(range(gen_len)):
737 nextvalues = values[:, t + 1] if t < gen_len - 1 else 0.0
738 delta = rewards[:, t] + self.config.gamma * nextvalues - values[:, t]
739 lastgaelam = delta + self.config.gamma * self.config.lam * lastgaelam
740 advantages_reversed.append(lastgaelam)
741 advantages = torch.stack(advantages_reversed[::-1]).transpose(0, 1)
742
743 returns = advantages + values
744 advantages = whiten(advantages)
745 advantages = advantages.detach()
746
747 vpredclipped = clip_by_value(vpred, values - self.config.cliprange_value, values + self.config.cliprange_value)
748
749 vf_losses1 = (vpred - returns) ** 2
750 vf_losses2 = (vpredclipped - returns) ** 2
751 vf_loss = 0.5 * torch.mean(torch.max(vf_losses1, vf_losses2))
752 vf_clipfrac = torch.mean(torch.gt(vf_losses2, vf_losses1).double())
753
754 ratio = torch.exp(logprob - old_logprobs)
755 pg_losses = -advantages * ratio
756 pg_losses2 = -advantages * torch.clamp(ratio, 1.0 - self.config.cliprange, 1.0 + self.config.cliprange)
757
758 pg_loss = torch.mean(torch.max(pg_losses, pg_losses2))
759 pg_clipfrac = torch.mean(torch.gt(pg_losses2, pg_losses).double())
760
761 loss = pg_loss + self.config.vf_coef * vf_loss
762
763 entropy = torch.mean(entropy_from_logits(logits))
764 approxkl = 0.5 * torch.mean((logprob - old_logprobs) ** 2)
765 policykl = torch.mean(logprob - old_logprobs)
766 return_mean, return_var = torch.mean(returns), torch.var(returns)
767 value_mean, value_var = torch.mean(values), torch.var(values)
768
769 stats = dict(
770 loss=dict(policy=pg_loss, value=vf_loss, total=loss),
771 policy=dict(
772 entropy=entropy,
773 approxkl=approxkl,
774 policykl=policykl,
775 clipfrac=pg_clipfrac,
776 advantages=advantages,
777 advantages_mean=torch.mean(advantages),
778 ratio=ratio,
779 ),
780 returns=dict(mean=return_mean, var=return_var),
781 val=dict(
782 vpred=torch.mean(vpred),
783 error=torch.mean((vpred - returns) ** 2),
784 clipfrac=vf_clipfrac,
785 mean=value_mean,
786 var=value_var,
787 ),
788 )
789 return pg_loss, self.config.vf_coef * vf_loss, flatten_dict(stats)
790
791 def record_step_stats(self, kl_coef: float, **data):
792 """
793 Record training step statistics.
794
795
796 Args:
797 kl_coef (`float`):
798 KL coefficient
799 data (`dict`):
800 Dictionary of training step data
801
802 Returns:
803 stats (`dict`):
804 Dictionary of training step statistics
805 """
806 kl_list = [logprobs - ref_logprobs for logprobs, ref_logprobs in zip(data["logprobs"], data["ref_logprobs"])]
807 mean_kl = torch.mean(torch.stack([torch.sum(kl) for kl in kl_list]))
808 mean_entropy = torch.mean(torch.stack([torch.sum(-log_probs) for log_probs in data["logprobs"]]))
809 mean_non_score_reward = torch.mean(
810 torch.stack([torch.sum(non_score_reward) for non_score_reward in data["non_score_reward"]])
811 )
812 stats = {
813 "objective/kl": mean_kl,
814 "objective/kl_dist": kl_list,
815 "objective/logprobs": data["logprobs"],
816 "objective/ref_logprobs": data["ref_logprobs"],
817 "objective/kl_coef": kl_coef,
818 "objective/entropy": mean_entropy,
819 "ppo/mean_non_score_reward": mean_non_score_reward,
820 }
821
822 for k, v in data["train_stats"].items():
823 stats[f"ppo/{k}"] = torch.mean(v, axis=0)
824 stats["ppo/val/var_explained"] = 1 - stats["ppo/val/error"] / stats["ppo/returns/var"]
825 return stats
826
827 def log_stats(
828 self,
829 stats: dict,
830 batch: dict,
831 rewards: List[torch.FloatTensor],
832 ):
833 """
834 A function that logs all the training stats. Call it at the end of each epoch.
835
836 Args:
837 stats (dict[str, Any]):
838 A dictionary of training stats.
839 batch (dict[str, Any]):
840 A dictionary of batch data, this contains the queries and responses.
841 rewards (`List[torch.FloatTensor]`):
842 A tensor of rewards.
843 """
844 # Log only if we are in the main process
845 if self.accelerator.is_main_process:
846 logs = {}
847
848 # Log stats
849 if not isinstance(rewards, torch.Tensor):
850 rewards = torch.tensor(rewards).to(self.accelerator.device)
851
852 if "query" not in batch.keys() and "response" not in batch.keys():
853 # warn the user that the game logs will not be logged
854 warnings.warn(
855 "The game logs will not be logged because the batch does not contain the keys 'query' and "
856 "'response'. "
857 )
858 elif self.config.log_with == "wandb":
859 import wandb
860
861 table_rows = [list(r) for r in zip(batch["query"], batch["response"], rewards.cpu().tolist())]
862 logs.update({"game_log": wandb.Table(columns=["query", "response", "reward"], rows=table_rows)})
863 # All reduce rewards if distributed
864 if self.is_distributed:
865 import torch.distributed as dist
866
867 dist.barrier()
868
869 dist.all_reduce(rewards, op=torch.distributed.ReduceOp.SUM)
870 rewards /= self.accelerator.num_processes
871
872 logs.update(stats)
873 logs["env/reward_mean"] = torch.mean(rewards).cpu().numpy().item()
874 logs["env/reward_std"] = torch.std(rewards).cpu().numpy().item()
875 logs["env/reward_dist"] = rewards.cpu().numpy()
876
877 if self.config.log_with == "tensorboard":
878 # update the current step
879 self.current_step += 1
880
881 self.accelerator.log(logs, step=self.current_step if self.config.log_with == "tensorboard" else None)
882
883 else:
884 if self.is_distributed:
885 import torch.distributed as dist
886
887 if not isinstance(rewards, torch.Tensor):
888 rewards = torch.tensor(rewards).to(self.accelerator.device)
889
890 dist.barrier()
891 dist.all_reduce(rewards, op=torch.distributed.ReduceOp.SUM)
892
893 def create_model_card(self, path: str, model_name: Optional[str] = "TRL Model") -> None:
894 """Creates and saves a model card for a TRL model.
895
896 Args:
897 path (`str`): The path to save the model card to.
898 model_name (`str`, *optional*): The name of the model, defaults to `TRL Model`.
899 """
900 if not os.path.exists(path):
901 os.makedirs(path)
902
903 user = whoami()["name"]
904 model_card_content = MODEL_CARD_TEMPLATE.format(model_name=model_name, model_id=f"{user}/{path}")
905 with open(os.path.join(path, "README.md"), "w", encoding="utf-8") as f:
906 f.write(model_card_content)
907
908 def _save_pretrained(self, save_directory: str) -> None:
909 self.model.save_pretrained(save_directory)
910 self.tokenizer.save_pretrained(save_directory)
911 self.create_model_card(save_directory)
912
```
--- 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/trl/trainer/ppo_trainer.py b/trl/trainer/ppo_trainer.py
--- a/trl/trainer/ppo_trainer.py
+++ b/trl/trainer/ppo_trainer.py
@@ -309,6 +309,7 @@
batch_size=self.config.batch_size,
collate_fn=data_collator,
shuffle=True,
+ drop_last=True,
)
return dataloader
| {"golden_diff": "diff --git a/trl/trainer/ppo_trainer.py b/trl/trainer/ppo_trainer.py\n--- a/trl/trainer/ppo_trainer.py\n+++ b/trl/trainer/ppo_trainer.py\n@@ -309,6 +309,7 @@\n batch_size=self.config.batch_size,\n collate_fn=data_collator,\n shuffle=True,\n+ drop_last=True,\n )\n return dataloader\n", "issue": "Error with official examples\nHi, I am running the official example script on t5 using sentiment as reward function, and after 97 iterations the following error is raised:\r\n\r\n```\r\n\u256d\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 Traceback (most recent call last) \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\r\n\u2502 /home/alejandro.vaca/trl/examples/sentiment/scripts/t5-sentiment.py:126 in \u2502\r\n\u2502 <module> \u2502\r\n\u2502 \u2502\r\n\u2502 123 \u2502 rewards = [torch.tensor(output[1][\"score\"]).to(device) for output \u2502\r\n\u2502 124 \u2502 \u2502\r\n\u2502 125 \u2502 #### Run PPO step \u2502\r\n\u2502 \u2771 126 \u2502 stats = ppo_trainer.step(query_tensors, response_tensors, rewards) \u2502\r\n\u2502 127 \u2502 ppo_trainer.log_stats(stats, batch, rewards) \u2502\r\n\u2502 128 \u2502\r\n\u2502 \u2502\r\n\u2502 /home/alejandro.vaca/trl/trl/trainer/ppo_trainer.py:432 in step \u2502\r\n\u2502 \u2502\r\n\u2502 429 \u2502 \u2502 \"\"\" \u2502\r\n\u2502 430 \u2502 \u2502 bs = self.config.batch_size \u2502\r\n\u2502 431 \u2502 \u2502 \u2502\r\n\u2502 \u2771 432 \u2502 \u2502 queries, responses, scores = self._step_safety_checker(bs, que \u2502\r\n\u2502 433 \u2502 \u2502 \u2502\r\n\u2502 434 \u2502 \u2502 timing = dict() \u2502\r\n\u2502 435 \u2502 \u2502 t0 = time.time() \u2502\r\n\u2502 \u2502\r\n\u2502 /home/alejandro.vaca/trl/trl/trainer/ppo_trainer.py:392 in \u2502\r\n\u2502 _step_safety_checker \u2502\r\n\u2502 \u2502\r\n\u2502 389 \u2502 \u2502 \u2502 if not isinstance(tensor_list[0], torch.Tensor): \u2502\r\n\u2502 390 \u2502 \u2502 \u2502 \u2502 raise ValueError(f\"Elements in {name} must tensors - g \u2502\r\n\u2502 391 \u2502 \u2502 \u2502 if batch_size is not None and len(tensor_list) != batch_si \u2502\r\n\u2502 \u2771 392 \u2502 \u2502 \u2502 \u2502 raise ValueError( \u2502\r\n\u2502 393 \u2502 \u2502 \u2502 \u2502 \u2502 f\"Batch size ({batch_size}) does not match number \u2502\r\n\u2502 394 \u2502 \u2502 \u2502 \u2502 ) \u2502\r\n\u2502 395 \u2502\r\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\r\nValueError: Batch size (256) does not match number of examples - but got 63 for:\r\nqueries\r\n\r\n```\n", "before_files": [{"content": "# Copyright 2022 The HuggingFace Team. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\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.\nimport inspect\nimport logging\nimport os\nimport random\nimport time\nimport warnings\nfrom typing import List, Optional, Union\n\nimport datasets\nimport torch\nfrom accelerate import Accelerator\nfrom datasets import Dataset\nfrom huggingface_hub import whoami\nfrom packaging import version\nfrom torch.optim import Adam\nfrom transformers import DataCollatorForLanguageModeling, PreTrainedTokenizer, PreTrainedTokenizerFast\n\nfrom ..core import (\n WANDB_PADDING,\n clip_by_value,\n convert_to_scalar,\n entropy_from_logits,\n flatten_dict,\n logprobs_from_logits,\n set_seed,\n stack_dicts,\n stats_to_np,\n whiten,\n)\nfrom ..models import SUPPORTED_ARCHITECTURES, PreTrainedModelWrapper, create_reference_model\nfrom . import AdaptiveKLController, BaseTrainer, FixedKLController, PPOConfig\n\n\nMODEL_CARD_TEMPLATE = \"\"\"---\nlicense: apache-2.0\ntags:\n- trl\n- transformers\n- reinforcement-learning\n---\n\n# {model_name}\n\nThis is a [TRL language model](https://github.com/lvwerra/trl) that has been fine-tuned with reinforcement learning to\n guide the model outputs according to a value, function, or human feedback. The model can be used for text generation.\n\n## Usage\n\nTo use this model for inference, first install the TRL library:\n\n```bash\npython -m pip install trl\n```\n\nYou can then generate text as follows:\n\n```python\nfrom transformers import pipeline\n\ngenerator = pipeline(\"text-generation\", model=\"{model_id}\")\noutputs = generator(\"Hello, my llama is cute\")\n```\n\nIf you want to use the model for training or to obtain the outputs from the value head, load the model as follows:\n\n```python\nfrom transformers import AutoTokenizer\nfrom trl import AutoModelForCausalLMWithValueHead\n\ntokenizer = AutoTokenizer.from_pretrained(\"{model_id}\")\nmodel = AutoModelForCausalLMWithValueHead.from_pretrained(\"{model_id}\")\n\ninputs = tokenizer(\"Hello, my llama is cute\", return_tensors=\"pt\")\noutputs = model(**inputs, labels=inputs[\"input_ids\"])\n```\n\"\"\"\n\n\nclass PPOTrainer(BaseTrainer):\n \"\"\"\n The PPOTrainer uses Proximal Policy Optimization to optimise language models.\n Note, this trainer is heavily inspired by the original OpenAI learning to summarize work here:\n https://github.com/openai/summarize-from-feedback\n\n Attributes:\n **config** (`PPOConfig`) -- Configuration object for PPOTrainer. Check the documentation of `PPOConfig` for more\n details.\n **model** (`PreTrainedModelWrapper`) -- Model to be optimized, Hugging Face transformer model with a value head.\n Check the documentation of `PreTrainedModelWrapper` for more details.\n **ref_model** (`PreTrainedModelWrapper`, *optional*) -- Reference model to be used for KL penalty, Hugging Face\n transformer model with a casual language modelling head. Check the documentation of `PreTrainedModelWrapper`\n for more details. If no reference model is provided, the trainer will create a reference model with the same\n architecture as the model to be optimized with shared layers.\n **tokenizer** (`Union[PreTrainedTokenizer, PreTrainedTokenizerFast]`) -- Tokenizer to be used for encoding the\n data. Check the documentation of `transformers.PreTrainedTokenizer` and\n `transformers.PreTrainedTokenizerFast` for more details.\n **dataset** (Union[`torch.utils.data.Dataset`, `datasets.Dataset`], *optional*) -- PyTorch dataset or Hugging\n Face dataset. This is used to create a PyTorch dataloader. If no dataset is provided, the dataloader must be\n created outside the trainer users needs to design their own dataloader and make sure the batch\n size that is used is the same as the one specified in the configuration object.\n **optimizer** (`torch.optim.Optimizer`, *optional*) -- Optimizer to be used for training. If no optimizer is\n provided, the trainer will create an Adam optimizer with the learning rate specified in the configuration\n object.\n **data_collator** (DataCollatorForLanguageModeling, *optional*) -- Data collator to be used for training and\n passed along the dataloader\n **num_shared_layers** (int, *optional*) -- Number of layers to be shared between the model and the reference\n model, if no reference model is passed. If no number is provided, all the layers will be shared.\n **lr_scheduler** (`torch.optim.lr_scheduler`, *optional*) -- Learning rate scheduler to be used for training.\n \"\"\"\n\n def __init__(\n self,\n config: PPOConfig = None,\n model: PreTrainedModelWrapper = None,\n ref_model: PreTrainedModelWrapper = None,\n tokenizer: Union[PreTrainedTokenizer, PreTrainedTokenizerFast] = None,\n dataset: Optional[Union[torch.utils.data.Dataset, Dataset]] = None,\n optimizer: Optional[torch.optim.Optimizer] = None,\n data_collator=None,\n num_shared_layers: Optional[int] = None,\n lr_scheduler: Optional[torch.optim.lr_scheduler._LRScheduler] = None,\n ):\n \"\"\"\n Initialize PPOTrainer.\n\n Args:\n config (`PPOConfig`):\n Configuration object for PPOTrainer. Check the documentation of `PPOConfig` for more details.\n model (`PreTrainedModelWrapper`):\n Hugging Face transformer model with a value head.\n ref_model (`PreTrainedModelWrapper`):\n Hugging Face transformer model with a casual language modelling head. Used for KL penalty\n tokenizer (`transformers.PreTrainedTokenizer`):\n Hugging Face tokenizer\n dataset (Union[`torch.utils.data.Dataset`, `datasets.Dataset`], *optional*):\n PyTorch dataset or Hugging Face dataset. If a Hugging Face dataset is passed, the dataset\n will be preprocessed by removing the columns that are not used by the model. If none is passed,\n a warning will be raised in a multi-GPU setting.\n optimizer (Optional[`torch.optim.Optimizer`]):\n Optimizer used for training. If `None`, the `Adam` is used as default.\n data_collator (Optional[function]):\n Data collator function.\n num_shared_layers (Optional[int]):\n Number of shared layers between the model and the reference model. If `None`, all layers are shared.\n used only if `ref_model` is `None`.\n lr_scheduler (Optional[`torch.optim.lr_scheduler`]):\n Learning rate scheduler used for training.\n \"\"\"\n super().__init__(config)\n\n # initial seed for reproducible experiments\n set_seed(config.seed)\n\n # Step 0: check positional arguments validity\n if not isinstance(config, PPOConfig):\n raise ValueError(f\"config must be a PPOConfig, got {type(config)}\")\n if not isinstance(tokenizer, (PreTrainedTokenizer, PreTrainedTokenizerFast)):\n raise ValueError(\n f\"tokenizer must be a PreTrainedTokenizer or PreTrainedTokenizerFast, got {type(tokenizer)}\"\n )\n if not isinstance(model, PreTrainedModelWrapper):\n raise ValueError(\n f\"model must be a PreTrainedModelWrapper, got {type(model)} - supported architectures are: {SUPPORTED_ARCHITECTURES}\"\n )\n # Step 1: Initialize Accelerator\n self.accelerator = Accelerator(log_with=config.log_with, **config.accelerator_kwargs)\n self.accelerator.init_trackers(config.tracker_project_name, config=config.to_dict(), **config.tracker_kwargs)\n\n self.model = model\n self.is_encoder_decoder = hasattr(self.model, \"is_encoder_decoder\")\n\n if isinstance(ref_model, PreTrainedModelWrapper):\n self.ref_model = ref_model\n if num_shared_layers is not None:\n warnings.warn(\n \"num_shared_layers is ignored when ref_model is provided. Two different models are used for the \"\n \"model and the reference model and no layers are shared.\",\n UserWarning,\n )\n elif ref_model is None:\n self.ref_model = create_reference_model(self.model, num_shared_layers=num_shared_layers)\n else:\n raise ValueError(\n f\"ref_model must be a PreTrainedModelWrapper or `None`, got {type(ref_model)} - supported \"\n f\"architectures are: {SUPPORTED_ARCHITECTURES} \"\n )\n\n if not (isinstance(tokenizer, PreTrainedTokenizer) or isinstance(tokenizer, PreTrainedTokenizerFast)):\n raise ValueError(\n \"tokenizer must be a transformers.PreTrainedTokenizer or transformers.PreTrainedTokenizerFast\"\n )\n self.tokenizer = tokenizer\n\n if dataset is not None and not (isinstance(dataset, torch.utils.data.Dataset) or isinstance(dataset, Dataset)):\n raise ValueError(\"dataloader must be a torch.utils.data.Dataset or datasets.Dataset\")\n elif dataset is None:\n warnings.warn(\n \"No dataset is provided. Make sure to set config.batch_size to the correct value before training.\",\n UserWarning,\n )\n self.dataset = dataset\n self._signature_columns = None\n if self.dataset is not None:\n self.dataloader = self.prepare_dataloader(self.dataset, data_collator)\n elif self.dataset is None and self.accelerator.num_processes > 1:\n warnings.warn(\n \"No dataset is provided. In a multi-GPU setting, this will lead to an error. You should\",\n \" prepare your dataloader yourself with `dataloader = ppo_trainer.accelerator.prepare(dataloader)`\",\n \" and using `torch.utils.data.DataLoader`, or pass a dataset to the `PPOTrainer`. Please \",\n \" refer to the documentation for more details.\",\n UserWarning,\n )\n self.dataloader = None\n else:\n self.dataloader = None\n\n # Step 3: Initialize optimizer and data collator\n self.data_collator = DataCollatorForLanguageModeling(self.tokenizer, mlm=False)\n if optimizer is None:\n self.optimizer = Adam(self.model.parameters(), lr=self.config.learning_rate)\n else:\n self.optimizer = optimizer\n\n self.lr_scheduler = lr_scheduler\n if self.lr_scheduler is not None:\n if not isinstance(self.lr_scheduler, torch.optim.lr_scheduler._LRScheduler):\n raise ValueError(\"lr_scheduler must be a torch.optim.lr_scheduler._LRScheduler\")\n\n if self.config.adap_kl_ctrl:\n self.kl_ctl = AdaptiveKLController(self.config.init_kl_coef, self.config.target, self.config.horizon)\n else:\n self.kl_ctl = FixedKLController(self.config.init_kl_coef)\n\n (\n self.model,\n self.ref_model,\n self.optimizer,\n self.data_collator,\n self.dataloader,\n self.lr_scheduler,\n ) = self.accelerator.prepare(\n self.model, self.ref_model, self.optimizer, self.data_collator, self.dataloader, self.lr_scheduler\n )\n\n # In a distributed setup, only logging needs to be performed on the main process\n # check: https://pytorch.org/docs/stable/generated/torch.nn.parallel.DistributedDataParallel.html\n # or: https://discuss.pytorch.org/t/use-distributed-data-parallel-correctly/82500/11\n self.is_distributed = self.accelerator.distributed_type == \"MULTI_GPU\"\n\n # init the current step\n self.current_step = 0\n\n # init wandb on the main process:\n if self.accelerator.is_main_process and self.config.log_with == \"wandb\":\n import wandb\n\n wandb.watch(self.model, log=\"all\")\n\n if self.config.forward_batch_size > 1 and (self.is_encoder_decoder or self.tokenizer.padding_side == \"left\"):\n # warn users that this is not well supported yet\n logging.warning(\n \"Forward batch size > 1 is not well supported yet for encoder-decoder models and when using `tokenizer.padding_side='left'`. This can lead to unexpected behaviour.\"\n \" therefore, we recommend using forward_batch_size=1.\"\n )\n\n def _filter_kwargs(self, kwargs, target_func):\n \"\"\"\n filter the keyword arguments that are supported by the target function.\n\n Args:\n kwargs (dict):\n Keyword arguments\n target_func (function):\n Target function\n \"\"\"\n return {k: v for k, v in kwargs.items() if k in inspect.signature(target_func).parameters.keys()}\n\n def prepare_dataloader(self, dataset: Union[torch.utils.data.Dataset, Dataset], data_collator=None):\n \"\"\"\n Prepare the dataloader for training.\n\n Args:\n dataset (Union[`torch.utils.data.Dataset`, `datasets.Dataset`]):\n PyTorch dataset or Hugging Face dataset. If a Hugging Face dataset is passed, the dataset\n will be preprocessed by removing the columns that are not used by the model.\n data_collator (Optional[function]):\n Data collator function.\n\n Returns:\n `torch.utils.data.DataLoader`: PyTorch dataloader\n \"\"\"\n if isinstance(dataset, Dataset):\n dataset = self._remove_unused_columns(dataset)\n dataloader = torch.utils.data.DataLoader(\n dataset,\n batch_size=self.config.batch_size,\n collate_fn=data_collator,\n shuffle=True,\n )\n return dataloader\n\n # Adapted from transformers.Trainer._set_signature_columns_if_needed\n def _set_signature_columns_if_needed(self):\n if self._signature_columns is None:\n # Inspect model forward signature to keep only the arguments it accepts.\n signature = inspect.signature(self.model.forward)\n self._signature_columns = list(signature.parameters.keys())\n # label => sentiment | we need query and response for logging purpose\n self._signature_columns += list(set([\"label\", \"query\", \"response\"]))\n\n # Adapted from transformers.Trainer._remove_unused_columns\n def _remove_unused_columns(self, dataset: \"Dataset\"):\n if not self.config.remove_unused_columns:\n return dataset\n self._set_signature_columns_if_needed()\n signature_columns = self._signature_columns\n\n ignored_columns = list(set(dataset.column_names) - set(signature_columns))\n\n columns = [k for k in signature_columns if k in dataset.column_names]\n\n if version.parse(datasets.__version__) < version.parse(\"1.4.0\"):\n dataset.set_format(\n type=dataset.format[\"type\"], columns=columns, format_kwargs=dataset.format[\"format_kwargs\"]\n )\n return dataset\n else:\n return dataset.remove_columns(ignored_columns)\n\n def generate(self, query_tensor: torch.Tensor, **generation_kwargs):\n \"\"\"\n Generate response with the model given the query tensor.\n call the `generate` method of the model.\n\n Args:\n query_tensor (`torch.LongTensor`):\n A tensor of shape (`batch_size`, `seq_len`) containing query tokens.\n generation_kwargs (dict[str, Any]):\n Keyword arguments for generation.\n\n Returns:\n `torch.LongTensor`: A tensor of shape (`batch_size`, `gen_len`) containing response tokens.\n \"\"\"\n response = self.accelerator.unwrap_model(self.model).generate(\n query_tensor.unsqueeze(dim=0), **generation_kwargs\n )\n\n return response\n\n def _step_safety_checker(\n self,\n batch_size: int,\n queries: List[torch.LongTensor],\n responses: List[torch.LongTensor],\n scores: List[torch.FloatTensor],\n ):\n \"\"\"\n Check if the input data is valid for training.\n\n Args:\n batch_size (int):\n Batch size from the config file.\n queries (List[`torch.LongTensor`]):\n List of tensors containing the encoded queries of shape (`query_length`)\n responses (List[`torch.LongTensor`]):\n List of tensors containing the encoded responses of shape (`response_length`)\n scores (List[`torch.FloatTensor`]):\n List of tensors containing the scores.\n Returns:\n `tuple`: The input processed data.\n \"\"\"\n for name, tensor_list in zip([\"queries\", \"responses\", \"scores\"], [queries, responses, scores]):\n if not isinstance(tensor_list, list):\n raise ValueError(f\"{name} must be a list of tensors - got {type(tensor_list)}\")\n if not isinstance(tensor_list[0], torch.Tensor):\n raise ValueError(f\"Elements in {name} must tensors - got {type(tensor_list[0])}\")\n if batch_size is not None and len(tensor_list) != batch_size:\n raise ValueError(\n f\"Batch size ({batch_size}) does not match number of examples - but got {len(tensor_list)} for: {name}\"\n )\n\n # add queries, scores and responses on the correct device\n queries = [tensor.to(self.accelerator.device) for tensor in queries]\n responses = [tensor.to(self.accelerator.device) for tensor in responses]\n scores = [tensor.to(self.accelerator.device) for tensor in scores]\n\n # squeeze scores if needed\n for i, score in enumerate(scores):\n if score.dim() > 1:\n raise ValueError(f\"Scores must be 1-dimensional - got {score.dim()} for {score}\")\n elif score.dim() == 1:\n scores[i] = score.squeeze()\n\n return queries, responses, scores\n\n def step(\n self,\n queries: List[torch.LongTensor],\n responses: List[torch.LongTensor],\n scores: List[torch.FloatTensor],\n ):\n \"\"\"\n Run a PPO optimisation step given a list of queries, model responses, and rewards.\n\n Args:\n queries (List[`torch.LongTensor`]):\n List of tensors containing the encoded queries of shape (`query_length`)\n responses (List[`torch.LongTensor`]):\n List of tensors containing the encoded responses of shape (`response_length`)\n scores (List[`torch.FloatTensor`]):\n List of tensors containing the scores.\n\n Returns:\n `dict[str, Any]`: A summary of the training statistics\n \"\"\"\n bs = self.config.batch_size\n\n queries, responses, scores = self._step_safety_checker(bs, queries, responses, scores)\n\n timing = dict()\n t0 = time.time()\n\n t = time.time()\n\n logprobs, ref_logprobs, values = self.batched_forward_pass(queries, responses)\n timing[\"time/ppo/forward_pass\"] = time.time() - t\n\n t = time.time()\n rewards, non_score_reward = self.compute_rewards(scores, logprobs, ref_logprobs)\n timing[\"time/ppo/compute_rewards\"] = time.time() - t\n\n t = time.time()\n all_stats = []\n idxs = list(range(bs))\n for _ in range(self.config.ppo_epochs):\n random.shuffle(idxs)\n for i in range(bs):\n idx = idxs[i]\n train_stats = self.train_minibatch(\n logprobs[idx].unsqueeze(0),\n values[idx].unsqueeze(0),\n rewards[idx].unsqueeze(0),\n queries[idx].unsqueeze(0),\n responses[idx].unsqueeze(0),\n torch.cat([queries[idx], responses[idx]]).unsqueeze(0),\n )\n all_stats.append(train_stats)\n timing[\"time/ppo/optimize_step\"] = time.time() - t\n\n t = time.time()\n train_stats = stack_dicts(all_stats)\n\n # reshape advantages/ratios such that they are not averaged.\n train_stats[\"policy/advantages\"] = torch.flatten(train_stats[\"policy/advantages\"]).unsqueeze(0)\n train_stats[\"policy/advantages\"] = torch.nan_to_num(train_stats[\"policy/advantages\"], WANDB_PADDING)\n train_stats[\"policy/ratio\"] = torch.flatten(train_stats[\"policy/ratio\"]).unsqueeze(0)\n\n stats = self.record_step_stats(\n scores=scores,\n logprobs=logprobs,\n ref_logprobs=ref_logprobs,\n non_score_reward=non_score_reward,\n train_stats=train_stats,\n kl_coef=self.kl_ctl.value,\n )\n # Gather/Reduce stats from all processes\n if self.is_distributed:\n stats = self.gather_stats(stats)\n stats = stats_to_np(stats)\n timing[\"time/ppo/calc_stats\"] = time.time() - t\n stats[\"ppo/learning_rate\"] = self.optimizer.param_groups[0][\"lr\"]\n\n # Update the KL control - multiply the batch_size by the number of processes\n self.kl_ctl.update(stats[\"objective/kl\"], self.config.batch_size * self.accelerator.num_processes)\n\n # Log the total ppo time\n timing[\"time/ppo/total\"] = time.time() - t0\n stats.update(timing)\n\n # post-process stats for tensorboard and other loggers\n if self.config.log_with != \"wandb\":\n stats = convert_to_scalar(stats)\n\n if self.lr_scheduler is not None:\n self.lr_scheduler.step()\n\n return stats\n\n def gather_stats(self, stats):\n \"\"\"\n Gather stats from all processes. Useful in the context of distributed training.\n\n Args:\n stats (dict[str, Any]):\n a dictionary of stats to be gathered. The stats should contain torch tensors.\n\n Returns:\n `dict[str, Any]`: A dictionary of stats with the tensors gathered.\n \"\"\"\n import torch.distributed as dist\n\n # Wait for all processes to finish\n dist.barrier()\n\n for k, v in stats.items():\n if isinstance(v, torch.Tensor):\n dist.all_reduce(v, dist.ReduceOp.SUM)\n v /= self.accelerator.num_processes\n stats[k] = v\n return stats\n\n def batched_forward_pass(\n self,\n queries: torch.Tensor,\n responses: torch.Tensor,\n ):\n \"\"\"\n Calculate model outputs in multiple batches.\n\n Args:\n queries (`torch.LongTensor`):\n List of tensors containing the encoded queries, shape (`batch_size`, `query_length`)\n responses (`torch.LongTensor`):\n List of tensors containing the encoded responses, shape (`batch_size`, `response_length`)\n Returns:\n (tuple):\n - all_logprobs (`torch.FloatTensor`): Log probabilities of the responses,\n shape (`batch_size`, `response_length`)\n - all_ref_logprobs (`torch.FloatTensor`): Log probabilities of the responses,\n shape (`batch_size`, `response_length`)\n - all_values (`torch.FloatTensor`): Values of the responses, shape (`batch_size`, `response_length`)\n \"\"\"\n bs = self.config.batch_size\n fbs = self.config.forward_batch_size\n all_logprobs = []\n all_ref_logprobs = []\n all_values = []\n\n # attention_masks are create with the same shape as inputs and are\n # automatically padded by the datacollator to indicate padding tokens\n if self.is_encoder_decoder:\n input_data = self.data_collator(\n [{\"input_ids\": q, \"attention_mask\": torch.ones_like(q)} for q in queries]\n ).to(self.accelerator.device)\n\n decoder_inputs = self.data_collator(\n [{\"input_ids\": r, \"attention_mask\": torch.ones_like(r)} for r in responses]\n ).to(self.accelerator.device)\n\n input_data[\"decoder_input_ids\"] = decoder_inputs[\"input_ids\"]\n input_data[\"decoder_attention_mask\"] = decoder_inputs[\"attention_mask\"]\n\n input_data.pop(\"labels\") # we don't want to compute LM losses\n\n else:\n input_ids = [torch.cat([q, r]) for q, r in zip(queries, responses)]\n input_data = self.data_collator(\n [{\"input_ids\": ids, \"attention_mask\": torch.ones_like(ids)} for ids in input_ids]\n ).to(self.accelerator.device)\n\n for i in range(int(bs / fbs)):\n input_kwargs = {key: value[i * fbs : (i + 1) * fbs] for key, value in input_data.items()}\n query_batch = queries[i * fbs : (i + 1) * fbs]\n response_batch = responses[i * fbs : (i + 1) * fbs]\n\n with torch.no_grad():\n logits, _, v = self.model(**input_kwargs)\n ref_logits, _, _ = self.ref_model(**input_kwargs)\n\n if self.is_encoder_decoder:\n input_ids = input_kwargs[\"decoder_input_ids\"]\n attention_mask = input_kwargs[\"decoder_attention_mask\"]\n else:\n input_ids = input_kwargs[\"input_ids\"]\n attention_mask = input_kwargs[\"attention_mask\"]\n\n logprobs = logprobs_from_logits(logits[:, :-1, :], input_ids[:, 1:])\n ref_logprobs = logprobs_from_logits(ref_logits[:, :-1, :], input_ids[:, 1:])\n\n for j in range(fbs):\n if self.is_encoder_decoder:\n # Decoder sentence starts always in the index 1 after padding in the Enc-Dec Models\n start = 1\n end = attention_mask[j, :].sum() - 1\n else:\n start = len(query_batch[j]) - 1\n if attention_mask[j, 0] == 0: # offset left padding\n start += attention_mask[j, :].nonzero()[0]\n end = start + len(response_batch[j])\n\n if len(logprobs[j, start:end]) < 2:\n raise ValueError(\"Responses are too short. Make sure they are at least 4 tokens long.\")\n\n all_values.append(v[j, start:end])\n all_logprobs.append(logprobs[j, start:end])\n all_ref_logprobs.append(ref_logprobs[j, start:end])\n\n return all_logprobs, all_ref_logprobs, all_values\n\n def train_minibatch(\n self,\n old_logprobs: torch.FloatTensor,\n values: torch.FloatTensor,\n rewards: torch.FloatTensor,\n query: torch.LongTensor,\n response: torch.LongTensor,\n model_input: torch.LongTensor,\n ):\n \"\"\"\n Train one PPO minibatch\n\n Args:\n logprobs (`torch.FloatTensor`):\n Log probabilities of the model, shape [batch_size, response_length]\n values (`torch.FloatTensor`):\n Values of the value head, shape [batch_size, response_length]\n rewards (`torch.FloatTensor`):\n Rewards from the reward model, shape [batch_size, response_length]\n query (`torch.LongTensor`):\n Encoded queries, shape [batch_size, query_length]\n response (`torch.LongTensor`):\n Encoded responses, shape [batch_size, response_length]\n model_input (`torch.LongTensor`):\n Concatenated queries and responses, shape [batch_size, query_length+response_length]\n\n Returns:\n train_stats (dict[str, `torch.Tensor`]):\n Dictionary of training statistics\n \"\"\"\n logprobs, vpred, logits = self.compute_logits_vpred(model_input, query, response, rewards)\n\n loss_p, loss_v, train_stats = self.loss(old_logprobs, values, rewards, logits, vpred, logprobs)\n loss = loss_p + loss_v\n self.optimizer.zero_grad()\n self.accelerator.backward(loss)\n t = time.time()\n self.optimizer.step()\n train_stats[\"time/ppo/optimizer_step\"] = torch.Tensor([time.time() - t]).to(self.accelerator.device)\n return train_stats\n\n def compute_rewards(self, scores: torch.FloatTensor, logprobs: torch.FloatTensor, ref_logprobs: torch.FloatTensor):\n \"\"\"\n Compute per token rewards from scores and KL-penalty.\n\n Args:\n scores (`torch.FloatTensor`):\n Scores from the reward model, shape (`batch_size`)\n logprobs (`torch.FloatTensor`):\n Log probabilities of the model, shape (`batch_size`, `response_length`)\n ref_logprobs (`torch.FloatTensor`):\n Log probabilities of the reference model, shape (`batch_size`, `response_length`)\n \"\"\"\n rewards, non_score_rewards = [], []\n for score, logprob, ref_logprob in zip(scores, logprobs, ref_logprobs):\n kl = logprob - ref_logprob\n non_score_reward = -self.kl_ctl.value * kl\n non_score_rewards.append(non_score_reward)\n reward = non_score_reward.clone()\n reward[-1] += score\n rewards.append(reward)\n return rewards, non_score_rewards\n\n def compute_logits_vpred(\n self,\n model_input,\n query: torch.LongTensor,\n response: torch.LongTensor,\n rewards,\n ):\n input_kwargs = {\n \"input_ids\": model_input,\n }\n\n if self.is_encoder_decoder:\n input_kwargs[\"input_ids\"] = query\n input_kwargs[\"decoder_input_ids\"] = response\n model_input = response\n\n logits, _, vpred = self.model(**input_kwargs)\n gen_len = rewards.shape[-1]\n\n if self.is_encoder_decoder:\n logprob = logprobs_from_logits(logits[:, :-1, :], model_input[:, 1:])\n start, end = 1, response.shape[-1] - 1\n vpred = vpred[:, start:end]\n logprob = logprob[:, start:end]\n else:\n logprob = logprobs_from_logits(logits[:, :-1, :], model_input[:, 1:])\n logprob, vpred = logprob[:, -gen_len:], vpred[:, -gen_len:]\n\n return logprob, vpred, logits\n\n def loss(\n self,\n old_logprobs: torch.FloatTensor,\n values: torch.FloatTensor,\n rewards: torch.FloatTensor,\n logits: torch.FloatTensor,\n vpred: torch.FloatTensor,\n logprob: torch.FloatTensor,\n ):\n \"\"\"\n Calculate policy and value losses.\n\n Args:\n old_logprobs (`torch.FloatTensor`):\n Log probabilities of the model, shape (`batch_size`, `response_length`)\n values (`torch.FloatTensor`):\n Values of the value head, shape (`batch_size`, `hidden_dim`)\n rewards (`torch.FloatTensor`):\n Rewards from the reward model, shape (`batch_size`)\n logits (`torch.FloatTensor`):\n Logits of the model, shape (`batch_size`, `response_length`, `vocab_size`)\n v_pred (`torch.FloatTensor`):\n Values of the value head, shape (`batch_size`, `response_length`)\n logprobs (`torch.FloatTensor`):\n Log probabilities of the model, shape (`batch_size`, `response_length`)\n \"\"\"\n lastgaelam = 0\n advantages_reversed = []\n gen_len = rewards.shape[-1]\n\n for t in reversed(range(gen_len)):\n nextvalues = values[:, t + 1] if t < gen_len - 1 else 0.0\n delta = rewards[:, t] + self.config.gamma * nextvalues - values[:, t]\n lastgaelam = delta + self.config.gamma * self.config.lam * lastgaelam\n advantages_reversed.append(lastgaelam)\n advantages = torch.stack(advantages_reversed[::-1]).transpose(0, 1)\n\n returns = advantages + values\n advantages = whiten(advantages)\n advantages = advantages.detach()\n\n vpredclipped = clip_by_value(vpred, values - self.config.cliprange_value, values + self.config.cliprange_value)\n\n vf_losses1 = (vpred - returns) ** 2\n vf_losses2 = (vpredclipped - returns) ** 2\n vf_loss = 0.5 * torch.mean(torch.max(vf_losses1, vf_losses2))\n vf_clipfrac = torch.mean(torch.gt(vf_losses2, vf_losses1).double())\n\n ratio = torch.exp(logprob - old_logprobs)\n pg_losses = -advantages * ratio\n pg_losses2 = -advantages * torch.clamp(ratio, 1.0 - self.config.cliprange, 1.0 + self.config.cliprange)\n\n pg_loss = torch.mean(torch.max(pg_losses, pg_losses2))\n pg_clipfrac = torch.mean(torch.gt(pg_losses2, pg_losses).double())\n\n loss = pg_loss + self.config.vf_coef * vf_loss\n\n entropy = torch.mean(entropy_from_logits(logits))\n approxkl = 0.5 * torch.mean((logprob - old_logprobs) ** 2)\n policykl = torch.mean(logprob - old_logprobs)\n return_mean, return_var = torch.mean(returns), torch.var(returns)\n value_mean, value_var = torch.mean(values), torch.var(values)\n\n stats = dict(\n loss=dict(policy=pg_loss, value=vf_loss, total=loss),\n policy=dict(\n entropy=entropy,\n approxkl=approxkl,\n policykl=policykl,\n clipfrac=pg_clipfrac,\n advantages=advantages,\n advantages_mean=torch.mean(advantages),\n ratio=ratio,\n ),\n returns=dict(mean=return_mean, var=return_var),\n val=dict(\n vpred=torch.mean(vpred),\n error=torch.mean((vpred - returns) ** 2),\n clipfrac=vf_clipfrac,\n mean=value_mean,\n var=value_var,\n ),\n )\n return pg_loss, self.config.vf_coef * vf_loss, flatten_dict(stats)\n\n def record_step_stats(self, kl_coef: float, **data):\n \"\"\"\n Record training step statistics.\n\n\n Args:\n kl_coef (`float`):\n KL coefficient\n data (`dict`):\n Dictionary of training step data\n\n Returns:\n stats (`dict`):\n Dictionary of training step statistics\n \"\"\"\n kl_list = [logprobs - ref_logprobs for logprobs, ref_logprobs in zip(data[\"logprobs\"], data[\"ref_logprobs\"])]\n mean_kl = torch.mean(torch.stack([torch.sum(kl) for kl in kl_list]))\n mean_entropy = torch.mean(torch.stack([torch.sum(-log_probs) for log_probs in data[\"logprobs\"]]))\n mean_non_score_reward = torch.mean(\n torch.stack([torch.sum(non_score_reward) for non_score_reward in data[\"non_score_reward\"]])\n )\n stats = {\n \"objective/kl\": mean_kl,\n \"objective/kl_dist\": kl_list,\n \"objective/logprobs\": data[\"logprobs\"],\n \"objective/ref_logprobs\": data[\"ref_logprobs\"],\n \"objective/kl_coef\": kl_coef,\n \"objective/entropy\": mean_entropy,\n \"ppo/mean_non_score_reward\": mean_non_score_reward,\n }\n\n for k, v in data[\"train_stats\"].items():\n stats[f\"ppo/{k}\"] = torch.mean(v, axis=0)\n stats[\"ppo/val/var_explained\"] = 1 - stats[\"ppo/val/error\"] / stats[\"ppo/returns/var\"]\n return stats\n\n def log_stats(\n self,\n stats: dict,\n batch: dict,\n rewards: List[torch.FloatTensor],\n ):\n \"\"\"\n A function that logs all the training stats. Call it at the end of each epoch.\n\n Args:\n stats (dict[str, Any]):\n A dictionary of training stats.\n batch (dict[str, Any]):\n A dictionary of batch data, this contains the queries and responses.\n rewards (`List[torch.FloatTensor]`):\n A tensor of rewards.\n \"\"\"\n # Log only if we are in the main process\n if self.accelerator.is_main_process:\n logs = {}\n\n # Log stats\n if not isinstance(rewards, torch.Tensor):\n rewards = torch.tensor(rewards).to(self.accelerator.device)\n\n if \"query\" not in batch.keys() and \"response\" not in batch.keys():\n # warn the user that the game logs will not be logged\n warnings.warn(\n \"The game logs will not be logged because the batch does not contain the keys 'query' and \"\n \"'response'. \"\n )\n elif self.config.log_with == \"wandb\":\n import wandb\n\n table_rows = [list(r) for r in zip(batch[\"query\"], batch[\"response\"], rewards.cpu().tolist())]\n logs.update({\"game_log\": wandb.Table(columns=[\"query\", \"response\", \"reward\"], rows=table_rows)})\n # All reduce rewards if distributed\n if self.is_distributed:\n import torch.distributed as dist\n\n dist.barrier()\n\n dist.all_reduce(rewards, op=torch.distributed.ReduceOp.SUM)\n rewards /= self.accelerator.num_processes\n\n logs.update(stats)\n logs[\"env/reward_mean\"] = torch.mean(rewards).cpu().numpy().item()\n logs[\"env/reward_std\"] = torch.std(rewards).cpu().numpy().item()\n logs[\"env/reward_dist\"] = rewards.cpu().numpy()\n\n if self.config.log_with == \"tensorboard\":\n # update the current step\n self.current_step += 1\n\n self.accelerator.log(logs, step=self.current_step if self.config.log_with == \"tensorboard\" else None)\n\n else:\n if self.is_distributed:\n import torch.distributed as dist\n\n if not isinstance(rewards, torch.Tensor):\n rewards = torch.tensor(rewards).to(self.accelerator.device)\n\n dist.barrier()\n dist.all_reduce(rewards, op=torch.distributed.ReduceOp.SUM)\n\n def create_model_card(self, path: str, model_name: Optional[str] = \"TRL Model\") -> None:\n \"\"\"Creates and saves a model card for a TRL model.\n\n Args:\n path (`str`): The path to save the model card to.\n model_name (`str`, *optional*): The name of the model, defaults to `TRL Model`.\n \"\"\"\n if not os.path.exists(path):\n os.makedirs(path)\n\n user = whoami()[\"name\"]\n model_card_content = MODEL_CARD_TEMPLATE.format(model_name=model_name, model_id=f\"{user}/{path}\")\n with open(os.path.join(path, \"README.md\"), \"w\", encoding=\"utf-8\") as f:\n f.write(model_card_content)\n\n def _save_pretrained(self, save_directory: str) -> None:\n self.model.save_pretrained(save_directory)\n self.tokenizer.save_pretrained(save_directory)\n self.create_model_card(save_directory)\n", "path": "trl/trainer/ppo_trainer.py"}], "after_files": [{"content": "# Copyright 2022 The HuggingFace Team. All rights reserved.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\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.\nimport inspect\nimport logging\nimport os\nimport random\nimport time\nimport warnings\nfrom typing import List, Optional, Union\n\nimport datasets\nimport torch\nfrom accelerate import Accelerator\nfrom datasets import Dataset\nfrom huggingface_hub import whoami\nfrom packaging import version\nfrom torch.optim import Adam\nfrom transformers import DataCollatorForLanguageModeling, PreTrainedTokenizer, PreTrainedTokenizerFast\n\nfrom ..core import (\n WANDB_PADDING,\n clip_by_value,\n convert_to_scalar,\n entropy_from_logits,\n flatten_dict,\n logprobs_from_logits,\n set_seed,\n stack_dicts,\n stats_to_np,\n whiten,\n)\nfrom ..models import SUPPORTED_ARCHITECTURES, PreTrainedModelWrapper, create_reference_model\nfrom . import AdaptiveKLController, BaseTrainer, FixedKLController, PPOConfig\n\n\nMODEL_CARD_TEMPLATE = \"\"\"---\nlicense: apache-2.0\ntags:\n- trl\n- transformers\n- reinforcement-learning\n---\n\n# {model_name}\n\nThis is a [TRL language model](https://github.com/lvwerra/trl) that has been fine-tuned with reinforcement learning to\n guide the model outputs according to a value, function, or human feedback. The model can be used for text generation.\n\n## Usage\n\nTo use this model for inference, first install the TRL library:\n\n```bash\npython -m pip install trl\n```\n\nYou can then generate text as follows:\n\n```python\nfrom transformers import pipeline\n\ngenerator = pipeline(\"text-generation\", model=\"{model_id}\")\noutputs = generator(\"Hello, my llama is cute\")\n```\n\nIf you want to use the model for training or to obtain the outputs from the value head, load the model as follows:\n\n```python\nfrom transformers import AutoTokenizer\nfrom trl import AutoModelForCausalLMWithValueHead\n\ntokenizer = AutoTokenizer.from_pretrained(\"{model_id}\")\nmodel = AutoModelForCausalLMWithValueHead.from_pretrained(\"{model_id}\")\n\ninputs = tokenizer(\"Hello, my llama is cute\", return_tensors=\"pt\")\noutputs = model(**inputs, labels=inputs[\"input_ids\"])\n```\n\"\"\"\n\n\nclass PPOTrainer(BaseTrainer):\n \"\"\"\n The PPOTrainer uses Proximal Policy Optimization to optimise language models.\n Note, this trainer is heavily inspired by the original OpenAI learning to summarize work here:\n https://github.com/openai/summarize-from-feedback\n\n Attributes:\n **config** (`PPOConfig`) -- Configuration object for PPOTrainer. Check the documentation of `PPOConfig` for more\n details.\n **model** (`PreTrainedModelWrapper`) -- Model to be optimized, Hugging Face transformer model with a value head.\n Check the documentation of `PreTrainedModelWrapper` for more details.\n **ref_model** (`PreTrainedModelWrapper`, *optional*) -- Reference model to be used for KL penalty, Hugging Face\n transformer model with a casual language modelling head. Check the documentation of `PreTrainedModelWrapper`\n for more details. If no reference model is provided, the trainer will create a reference model with the same\n architecture as the model to be optimized with shared layers.\n **tokenizer** (`Union[PreTrainedTokenizer, PreTrainedTokenizerFast]`) -- Tokenizer to be used for encoding the\n data. Check the documentation of `transformers.PreTrainedTokenizer` and\n `transformers.PreTrainedTokenizerFast` for more details.\n **dataset** (Union[`torch.utils.data.Dataset`, `datasets.Dataset`], *optional*) -- PyTorch dataset or Hugging\n Face dataset. This is used to create a PyTorch dataloader. If no dataset is provided, the dataloader must be\n created outside the trainer users needs to design their own dataloader and make sure the batch\n size that is used is the same as the one specified in the configuration object.\n **optimizer** (`torch.optim.Optimizer`, *optional*) -- Optimizer to be used for training. If no optimizer is\n provided, the trainer will create an Adam optimizer with the learning rate specified in the configuration\n object.\n **data_collator** (DataCollatorForLanguageModeling, *optional*) -- Data collator to be used for training and\n passed along the dataloader\n **num_shared_layers** (int, *optional*) -- Number of layers to be shared between the model and the reference\n model, if no reference model is passed. If no number is provided, all the layers will be shared.\n **lr_scheduler** (`torch.optim.lr_scheduler`, *optional*) -- Learning rate scheduler to be used for training.\n \"\"\"\n\n def __init__(\n self,\n config: PPOConfig = None,\n model: PreTrainedModelWrapper = None,\n ref_model: PreTrainedModelWrapper = None,\n tokenizer: Union[PreTrainedTokenizer, PreTrainedTokenizerFast] = None,\n dataset: Optional[Union[torch.utils.data.Dataset, Dataset]] = None,\n optimizer: Optional[torch.optim.Optimizer] = None,\n data_collator=None,\n num_shared_layers: Optional[int] = None,\n lr_scheduler: Optional[torch.optim.lr_scheduler._LRScheduler] = None,\n ):\n \"\"\"\n Initialize PPOTrainer.\n\n Args:\n config (`PPOConfig`):\n Configuration object for PPOTrainer. Check the documentation of `PPOConfig` for more details.\n model (`PreTrainedModelWrapper`):\n Hugging Face transformer model with a value head.\n ref_model (`PreTrainedModelWrapper`):\n Hugging Face transformer model with a casual language modelling head. Used for KL penalty\n tokenizer (`transformers.PreTrainedTokenizer`):\n Hugging Face tokenizer\n dataset (Union[`torch.utils.data.Dataset`, `datasets.Dataset`], *optional*):\n PyTorch dataset or Hugging Face dataset. If a Hugging Face dataset is passed, the dataset\n will be preprocessed by removing the columns that are not used by the model. If none is passed,\n a warning will be raised in a multi-GPU setting.\n optimizer (Optional[`torch.optim.Optimizer`]):\n Optimizer used for training. If `None`, the `Adam` is used as default.\n data_collator (Optional[function]):\n Data collator function.\n num_shared_layers (Optional[int]):\n Number of shared layers between the model and the reference model. If `None`, all layers are shared.\n used only if `ref_model` is `None`.\n lr_scheduler (Optional[`torch.optim.lr_scheduler`]):\n Learning rate scheduler used for training.\n \"\"\"\n super().__init__(config)\n\n # initial seed for reproducible experiments\n set_seed(config.seed)\n\n # Step 0: check positional arguments validity\n if not isinstance(config, PPOConfig):\n raise ValueError(f\"config must be a PPOConfig, got {type(config)}\")\n if not isinstance(tokenizer, (PreTrainedTokenizer, PreTrainedTokenizerFast)):\n raise ValueError(\n f\"tokenizer must be a PreTrainedTokenizer or PreTrainedTokenizerFast, got {type(tokenizer)}\"\n )\n if not isinstance(model, PreTrainedModelWrapper):\n raise ValueError(\n f\"model must be a PreTrainedModelWrapper, got {type(model)} - supported architectures are: {SUPPORTED_ARCHITECTURES}\"\n )\n # Step 1: Initialize Accelerator\n self.accelerator = Accelerator(log_with=config.log_with, **config.accelerator_kwargs)\n self.accelerator.init_trackers(config.tracker_project_name, config=config.to_dict(), **config.tracker_kwargs)\n\n self.model = model\n self.is_encoder_decoder = hasattr(self.model, \"is_encoder_decoder\")\n\n if isinstance(ref_model, PreTrainedModelWrapper):\n self.ref_model = ref_model\n if num_shared_layers is not None:\n warnings.warn(\n \"num_shared_layers is ignored when ref_model is provided. Two different models are used for the \"\n \"model and the reference model and no layers are shared.\",\n UserWarning,\n )\n elif ref_model is None:\n self.ref_model = create_reference_model(self.model, num_shared_layers=num_shared_layers)\n else:\n raise ValueError(\n f\"ref_model must be a PreTrainedModelWrapper or `None`, got {type(ref_model)} - supported \"\n f\"architectures are: {SUPPORTED_ARCHITECTURES} \"\n )\n\n if not (isinstance(tokenizer, PreTrainedTokenizer) or isinstance(tokenizer, PreTrainedTokenizerFast)):\n raise ValueError(\n \"tokenizer must be a transformers.PreTrainedTokenizer or transformers.PreTrainedTokenizerFast\"\n )\n self.tokenizer = tokenizer\n\n if dataset is not None and not (isinstance(dataset, torch.utils.data.Dataset) or isinstance(dataset, Dataset)):\n raise ValueError(\"dataloader must be a torch.utils.data.Dataset or datasets.Dataset\")\n elif dataset is None:\n warnings.warn(\n \"No dataset is provided. Make sure to set config.batch_size to the correct value before training.\",\n UserWarning,\n )\n self.dataset = dataset\n self._signature_columns = None\n if self.dataset is not None:\n self.dataloader = self.prepare_dataloader(self.dataset, data_collator)\n elif self.dataset is None and self.accelerator.num_processes > 1:\n warnings.warn(\n \"No dataset is provided. In a multi-GPU setting, this will lead to an error. You should\",\n \" prepare your dataloader yourself with `dataloader = ppo_trainer.accelerator.prepare(dataloader)`\",\n \" and using `torch.utils.data.DataLoader`, or pass a dataset to the `PPOTrainer`. Please \",\n \" refer to the documentation for more details.\",\n UserWarning,\n )\n self.dataloader = None\n else:\n self.dataloader = None\n\n # Step 3: Initialize optimizer and data collator\n self.data_collator = DataCollatorForLanguageModeling(self.tokenizer, mlm=False)\n if optimizer is None:\n self.optimizer = Adam(self.model.parameters(), lr=self.config.learning_rate)\n else:\n self.optimizer = optimizer\n\n self.lr_scheduler = lr_scheduler\n if self.lr_scheduler is not None:\n if not isinstance(self.lr_scheduler, torch.optim.lr_scheduler._LRScheduler):\n raise ValueError(\"lr_scheduler must be a torch.optim.lr_scheduler._LRScheduler\")\n\n if self.config.adap_kl_ctrl:\n self.kl_ctl = AdaptiveKLController(self.config.init_kl_coef, self.config.target, self.config.horizon)\n else:\n self.kl_ctl = FixedKLController(self.config.init_kl_coef)\n\n (\n self.model,\n self.ref_model,\n self.optimizer,\n self.data_collator,\n self.dataloader,\n self.lr_scheduler,\n ) = self.accelerator.prepare(\n self.model, self.ref_model, self.optimizer, self.data_collator, self.dataloader, self.lr_scheduler\n )\n\n # In a distributed setup, only logging needs to be performed on the main process\n # check: https://pytorch.org/docs/stable/generated/torch.nn.parallel.DistributedDataParallel.html\n # or: https://discuss.pytorch.org/t/use-distributed-data-parallel-correctly/82500/11\n self.is_distributed = self.accelerator.distributed_type == \"MULTI_GPU\"\n\n # init the current step\n self.current_step = 0\n\n # init wandb on the main process:\n if self.accelerator.is_main_process and self.config.log_with == \"wandb\":\n import wandb\n\n wandb.watch(self.model, log=\"all\")\n\n if self.config.forward_batch_size > 1 and (self.is_encoder_decoder or self.tokenizer.padding_side == \"left\"):\n # warn users that this is not well supported yet\n logging.warning(\n \"Forward batch size > 1 is not well supported yet for encoder-decoder models and when using `tokenizer.padding_side='left'`. This can lead to unexpected behaviour.\"\n \" therefore, we recommend using forward_batch_size=1.\"\n )\n\n def _filter_kwargs(self, kwargs, target_func):\n \"\"\"\n filter the keyword arguments that are supported by the target function.\n\n Args:\n kwargs (dict):\n Keyword arguments\n target_func (function):\n Target function\n \"\"\"\n return {k: v for k, v in kwargs.items() if k in inspect.signature(target_func).parameters.keys()}\n\n def prepare_dataloader(self, dataset: Union[torch.utils.data.Dataset, Dataset], data_collator=None):\n \"\"\"\n Prepare the dataloader for training.\n\n Args:\n dataset (Union[`torch.utils.data.Dataset`, `datasets.Dataset`]):\n PyTorch dataset or Hugging Face dataset. If a Hugging Face dataset is passed, the dataset\n will be preprocessed by removing the columns that are not used by the model.\n data_collator (Optional[function]):\n Data collator function.\n\n Returns:\n `torch.utils.data.DataLoader`: PyTorch dataloader\n \"\"\"\n if isinstance(dataset, Dataset):\n dataset = self._remove_unused_columns(dataset)\n dataloader = torch.utils.data.DataLoader(\n dataset,\n batch_size=self.config.batch_size,\n collate_fn=data_collator,\n shuffle=True,\n drop_last=True,\n )\n return dataloader\n\n # Adapted from transformers.Trainer._set_signature_columns_if_needed\n def _set_signature_columns_if_needed(self):\n if self._signature_columns is None:\n # Inspect model forward signature to keep only the arguments it accepts.\n signature = inspect.signature(self.model.forward)\n self._signature_columns = list(signature.parameters.keys())\n # label => sentiment | we need query and response for logging purpose\n self._signature_columns += list(set([\"label\", \"query\", \"response\"]))\n\n # Adapted from transformers.Trainer._remove_unused_columns\n def _remove_unused_columns(self, dataset: \"Dataset\"):\n if not self.config.remove_unused_columns:\n return dataset\n self._set_signature_columns_if_needed()\n signature_columns = self._signature_columns\n\n ignored_columns = list(set(dataset.column_names) - set(signature_columns))\n\n columns = [k for k in signature_columns if k in dataset.column_names]\n\n if version.parse(datasets.__version__) < version.parse(\"1.4.0\"):\n dataset.set_format(\n type=dataset.format[\"type\"], columns=columns, format_kwargs=dataset.format[\"format_kwargs\"]\n )\n return dataset\n else:\n return dataset.remove_columns(ignored_columns)\n\n def generate(self, query_tensor: torch.Tensor, **generation_kwargs):\n \"\"\"\n Generate response with the model given the query tensor.\n call the `generate` method of the model.\n\n Args:\n query_tensor (`torch.LongTensor`):\n A tensor of shape (`batch_size`, `seq_len`) containing query tokens.\n generation_kwargs (dict[str, Any]):\n Keyword arguments for generation.\n\n Returns:\n `torch.LongTensor`: A tensor of shape (`batch_size`, `gen_len`) containing response tokens.\n \"\"\"\n response = self.accelerator.unwrap_model(self.model).generate(\n query_tensor.unsqueeze(dim=0), **generation_kwargs\n )\n\n return response\n\n def _step_safety_checker(\n self,\n batch_size: int,\n queries: List[torch.LongTensor],\n responses: List[torch.LongTensor],\n scores: List[torch.FloatTensor],\n ):\n \"\"\"\n Check if the input data is valid for training.\n\n Args:\n batch_size (int):\n Batch size from the config file.\n queries (List[`torch.LongTensor`]):\n List of tensors containing the encoded queries of shape (`query_length`)\n responses (List[`torch.LongTensor`]):\n List of tensors containing the encoded responses of shape (`response_length`)\n scores (List[`torch.FloatTensor`]):\n List of tensors containing the scores.\n Returns:\n `tuple`: The input processed data.\n \"\"\"\n for name, tensor_list in zip([\"queries\", \"responses\", \"scores\"], [queries, responses, scores]):\n if not isinstance(tensor_list, list):\n raise ValueError(f\"{name} must be a list of tensors - got {type(tensor_list)}\")\n if not isinstance(tensor_list[0], torch.Tensor):\n raise ValueError(f\"Elements in {name} must tensors - got {type(tensor_list[0])}\")\n if batch_size is not None and len(tensor_list) != batch_size:\n raise ValueError(\n f\"Batch size ({batch_size}) does not match number of examples - but got {len(tensor_list)} for: {name}\"\n )\n\n # add queries, scores and responses on the correct device\n queries = [tensor.to(self.accelerator.device) for tensor in queries]\n responses = [tensor.to(self.accelerator.device) for tensor in responses]\n scores = [tensor.to(self.accelerator.device) for tensor in scores]\n\n # squeeze scores if needed\n for i, score in enumerate(scores):\n if score.dim() > 1:\n raise ValueError(f\"Scores must be 1-dimensional - got {score.dim()} for {score}\")\n elif score.dim() == 1:\n scores[i] = score.squeeze()\n\n return queries, responses, scores\n\n def step(\n self,\n queries: List[torch.LongTensor],\n responses: List[torch.LongTensor],\n scores: List[torch.FloatTensor],\n ):\n \"\"\"\n Run a PPO optimisation step given a list of queries, model responses, and rewards.\n\n Args:\n queries (List[`torch.LongTensor`]):\n List of tensors containing the encoded queries of shape (`query_length`)\n responses (List[`torch.LongTensor`]):\n List of tensors containing the encoded responses of shape (`response_length`)\n scores (List[`torch.FloatTensor`]):\n List of tensors containing the scores.\n\n Returns:\n `dict[str, Any]`: A summary of the training statistics\n \"\"\"\n bs = self.config.batch_size\n\n queries, responses, scores = self._step_safety_checker(bs, queries, responses, scores)\n\n timing = dict()\n t0 = time.time()\n\n t = time.time()\n\n logprobs, ref_logprobs, values = self.batched_forward_pass(queries, responses)\n timing[\"time/ppo/forward_pass\"] = time.time() - t\n\n t = time.time()\n rewards, non_score_reward = self.compute_rewards(scores, logprobs, ref_logprobs)\n timing[\"time/ppo/compute_rewards\"] = time.time() - t\n\n t = time.time()\n all_stats = []\n idxs = list(range(bs))\n for _ in range(self.config.ppo_epochs):\n random.shuffle(idxs)\n for i in range(bs):\n idx = idxs[i]\n train_stats = self.train_minibatch(\n logprobs[idx].unsqueeze(0),\n values[idx].unsqueeze(0),\n rewards[idx].unsqueeze(0),\n queries[idx].unsqueeze(0),\n responses[idx].unsqueeze(0),\n torch.cat([queries[idx], responses[idx]]).unsqueeze(0),\n )\n all_stats.append(train_stats)\n timing[\"time/ppo/optimize_step\"] = time.time() - t\n\n t = time.time()\n train_stats = stack_dicts(all_stats)\n\n # reshape advantages/ratios such that they are not averaged.\n train_stats[\"policy/advantages\"] = torch.flatten(train_stats[\"policy/advantages\"]).unsqueeze(0)\n train_stats[\"policy/advantages\"] = torch.nan_to_num(train_stats[\"policy/advantages\"], WANDB_PADDING)\n train_stats[\"policy/ratio\"] = torch.flatten(train_stats[\"policy/ratio\"]).unsqueeze(0)\n\n stats = self.record_step_stats(\n scores=scores,\n logprobs=logprobs,\n ref_logprobs=ref_logprobs,\n non_score_reward=non_score_reward,\n train_stats=train_stats,\n kl_coef=self.kl_ctl.value,\n )\n # Gather/Reduce stats from all processes\n if self.is_distributed:\n stats = self.gather_stats(stats)\n stats = stats_to_np(stats)\n timing[\"time/ppo/calc_stats\"] = time.time() - t\n stats[\"ppo/learning_rate\"] = self.optimizer.param_groups[0][\"lr\"]\n\n # Update the KL control - multiply the batch_size by the number of processes\n self.kl_ctl.update(stats[\"objective/kl\"], self.config.batch_size * self.accelerator.num_processes)\n\n # Log the total ppo time\n timing[\"time/ppo/total\"] = time.time() - t0\n stats.update(timing)\n\n # post-process stats for tensorboard and other loggers\n if self.config.log_with != \"wandb\":\n stats = convert_to_scalar(stats)\n\n if self.lr_scheduler is not None:\n self.lr_scheduler.step()\n\n return stats\n\n def gather_stats(self, stats):\n \"\"\"\n Gather stats from all processes. Useful in the context of distributed training.\n\n Args:\n stats (dict[str, Any]):\n a dictionary of stats to be gathered. The stats should contain torch tensors.\n\n Returns:\n `dict[str, Any]`: A dictionary of stats with the tensors gathered.\n \"\"\"\n import torch.distributed as dist\n\n # Wait for all processes to finish\n dist.barrier()\n\n for k, v in stats.items():\n if isinstance(v, torch.Tensor):\n dist.all_reduce(v, dist.ReduceOp.SUM)\n v /= self.accelerator.num_processes\n stats[k] = v\n return stats\n\n def batched_forward_pass(\n self,\n queries: torch.Tensor,\n responses: torch.Tensor,\n ):\n \"\"\"\n Calculate model outputs in multiple batches.\n\n Args:\n queries (`torch.LongTensor`):\n List of tensors containing the encoded queries, shape (`batch_size`, `query_length`)\n responses (`torch.LongTensor`):\n List of tensors containing the encoded responses, shape (`batch_size`, `response_length`)\n Returns:\n (tuple):\n - all_logprobs (`torch.FloatTensor`): Log probabilities of the responses,\n shape (`batch_size`, `response_length`)\n - all_ref_logprobs (`torch.FloatTensor`): Log probabilities of the responses,\n shape (`batch_size`, `response_length`)\n - all_values (`torch.FloatTensor`): Values of the responses, shape (`batch_size`, `response_length`)\n \"\"\"\n bs = self.config.batch_size\n fbs = self.config.forward_batch_size\n all_logprobs = []\n all_ref_logprobs = []\n all_values = []\n\n # attention_masks are create with the same shape as inputs and are\n # automatically padded by the datacollator to indicate padding tokens\n if self.is_encoder_decoder:\n input_data = self.data_collator(\n [{\"input_ids\": q, \"attention_mask\": torch.ones_like(q)} for q in queries]\n ).to(self.accelerator.device)\n\n decoder_inputs = self.data_collator(\n [{\"input_ids\": r, \"attention_mask\": torch.ones_like(r)} for r in responses]\n ).to(self.accelerator.device)\n\n input_data[\"decoder_input_ids\"] = decoder_inputs[\"input_ids\"]\n input_data[\"decoder_attention_mask\"] = decoder_inputs[\"attention_mask\"]\n\n input_data.pop(\"labels\") # we don't want to compute LM losses\n\n else:\n input_ids = [torch.cat([q, r]) for q, r in zip(queries, responses)]\n input_data = self.data_collator(\n [{\"input_ids\": ids, \"attention_mask\": torch.ones_like(ids)} for ids in input_ids]\n ).to(self.accelerator.device)\n\n for i in range(int(bs / fbs)):\n input_kwargs = {key: value[i * fbs : (i + 1) * fbs] for key, value in input_data.items()}\n query_batch = queries[i * fbs : (i + 1) * fbs]\n response_batch = responses[i * fbs : (i + 1) * fbs]\n\n with torch.no_grad():\n logits, _, v = self.model(**input_kwargs)\n ref_logits, _, _ = self.ref_model(**input_kwargs)\n\n if self.is_encoder_decoder:\n input_ids = input_kwargs[\"decoder_input_ids\"]\n attention_mask = input_kwargs[\"decoder_attention_mask\"]\n else:\n input_ids = input_kwargs[\"input_ids\"]\n attention_mask = input_kwargs[\"attention_mask\"]\n\n logprobs = logprobs_from_logits(logits[:, :-1, :], input_ids[:, 1:])\n ref_logprobs = logprobs_from_logits(ref_logits[:, :-1, :], input_ids[:, 1:])\n\n for j in range(fbs):\n if self.is_encoder_decoder:\n # Decoder sentence starts always in the index 1 after padding in the Enc-Dec Models\n start = 1\n end = attention_mask[j, :].sum() - 1\n else:\n start = len(query_batch[j]) - 1\n if attention_mask[j, 0] == 0: # offset left padding\n start += attention_mask[j, :].nonzero()[0]\n end = start + len(response_batch[j])\n\n if len(logprobs[j, start:end]) < 2:\n raise ValueError(\"Responses are too short. Make sure they are at least 4 tokens long.\")\n\n all_values.append(v[j, start:end])\n all_logprobs.append(logprobs[j, start:end])\n all_ref_logprobs.append(ref_logprobs[j, start:end])\n\n return all_logprobs, all_ref_logprobs, all_values\n\n def train_minibatch(\n self,\n old_logprobs: torch.FloatTensor,\n values: torch.FloatTensor,\n rewards: torch.FloatTensor,\n query: torch.LongTensor,\n response: torch.LongTensor,\n model_input: torch.LongTensor,\n ):\n \"\"\"\n Train one PPO minibatch\n\n Args:\n logprobs (`torch.FloatTensor`):\n Log probabilities of the model, shape [batch_size, response_length]\n values (`torch.FloatTensor`):\n Values of the value head, shape [batch_size, response_length]\n rewards (`torch.FloatTensor`):\n Rewards from the reward model, shape [batch_size, response_length]\n query (`torch.LongTensor`):\n Encoded queries, shape [batch_size, query_length]\n response (`torch.LongTensor`):\n Encoded responses, shape [batch_size, response_length]\n model_input (`torch.LongTensor`):\n Concatenated queries and responses, shape [batch_size, query_length+response_length]\n\n Returns:\n train_stats (dict[str, `torch.Tensor`]):\n Dictionary of training statistics\n \"\"\"\n logprobs, vpred, logits = self.compute_logits_vpred(model_input, query, response, rewards)\n\n loss_p, loss_v, train_stats = self.loss(old_logprobs, values, rewards, logits, vpred, logprobs)\n loss = loss_p + loss_v\n self.optimizer.zero_grad()\n self.accelerator.backward(loss)\n t = time.time()\n self.optimizer.step()\n train_stats[\"time/ppo/optimizer_step\"] = torch.Tensor([time.time() - t]).to(self.accelerator.device)\n return train_stats\n\n def compute_rewards(self, scores: torch.FloatTensor, logprobs: torch.FloatTensor, ref_logprobs: torch.FloatTensor):\n \"\"\"\n Compute per token rewards from scores and KL-penalty.\n\n Args:\n scores (`torch.FloatTensor`):\n Scores from the reward model, shape (`batch_size`)\n logprobs (`torch.FloatTensor`):\n Log probabilities of the model, shape (`batch_size`, `response_length`)\n ref_logprobs (`torch.FloatTensor`):\n Log probabilities of the reference model, shape (`batch_size`, `response_length`)\n \"\"\"\n rewards, non_score_rewards = [], []\n for score, logprob, ref_logprob in zip(scores, logprobs, ref_logprobs):\n kl = logprob - ref_logprob\n non_score_reward = -self.kl_ctl.value * kl\n non_score_rewards.append(non_score_reward)\n reward = non_score_reward.clone()\n reward[-1] += score\n rewards.append(reward)\n return rewards, non_score_rewards\n\n def compute_logits_vpred(\n self,\n model_input,\n query: torch.LongTensor,\n response: torch.LongTensor,\n rewards,\n ):\n input_kwargs = {\n \"input_ids\": model_input,\n }\n\n if self.is_encoder_decoder:\n input_kwargs[\"input_ids\"] = query\n input_kwargs[\"decoder_input_ids\"] = response\n model_input = response\n\n logits, _, vpred = self.model(**input_kwargs)\n gen_len = rewards.shape[-1]\n\n if self.is_encoder_decoder:\n logprob = logprobs_from_logits(logits[:, :-1, :], model_input[:, 1:])\n start, end = 1, response.shape[-1] - 1\n vpred = vpred[:, start:end]\n logprob = logprob[:, start:end]\n else:\n logprob = logprobs_from_logits(logits[:, :-1, :], model_input[:, 1:])\n logprob, vpred = logprob[:, -gen_len:], vpred[:, -gen_len:]\n\n return logprob, vpred, logits\n\n def loss(\n self,\n old_logprobs: torch.FloatTensor,\n values: torch.FloatTensor,\n rewards: torch.FloatTensor,\n logits: torch.FloatTensor,\n vpred: torch.FloatTensor,\n logprob: torch.FloatTensor,\n ):\n \"\"\"\n Calculate policy and value losses.\n\n Args:\n old_logprobs (`torch.FloatTensor`):\n Log probabilities of the model, shape (`batch_size`, `response_length`)\n values (`torch.FloatTensor`):\n Values of the value head, shape (`batch_size`, `hidden_dim`)\n rewards (`torch.FloatTensor`):\n Rewards from the reward model, shape (`batch_size`)\n logits (`torch.FloatTensor`):\n Logits of the model, shape (`batch_size`, `response_length`, `vocab_size`)\n v_pred (`torch.FloatTensor`):\n Values of the value head, shape (`batch_size`, `response_length`)\n logprobs (`torch.FloatTensor`):\n Log probabilities of the model, shape (`batch_size`, `response_length`)\n \"\"\"\n lastgaelam = 0\n advantages_reversed = []\n gen_len = rewards.shape[-1]\n\n for t in reversed(range(gen_len)):\n nextvalues = values[:, t + 1] if t < gen_len - 1 else 0.0\n delta = rewards[:, t] + self.config.gamma * nextvalues - values[:, t]\n lastgaelam = delta + self.config.gamma * self.config.lam * lastgaelam\n advantages_reversed.append(lastgaelam)\n advantages = torch.stack(advantages_reversed[::-1]).transpose(0, 1)\n\n returns = advantages + values\n advantages = whiten(advantages)\n advantages = advantages.detach()\n\n vpredclipped = clip_by_value(vpred, values - self.config.cliprange_value, values + self.config.cliprange_value)\n\n vf_losses1 = (vpred - returns) ** 2\n vf_losses2 = (vpredclipped - returns) ** 2\n vf_loss = 0.5 * torch.mean(torch.max(vf_losses1, vf_losses2))\n vf_clipfrac = torch.mean(torch.gt(vf_losses2, vf_losses1).double())\n\n ratio = torch.exp(logprob - old_logprobs)\n pg_losses = -advantages * ratio\n pg_losses2 = -advantages * torch.clamp(ratio, 1.0 - self.config.cliprange, 1.0 + self.config.cliprange)\n\n pg_loss = torch.mean(torch.max(pg_losses, pg_losses2))\n pg_clipfrac = torch.mean(torch.gt(pg_losses2, pg_losses).double())\n\n loss = pg_loss + self.config.vf_coef * vf_loss\n\n entropy = torch.mean(entropy_from_logits(logits))\n approxkl = 0.5 * torch.mean((logprob - old_logprobs) ** 2)\n policykl = torch.mean(logprob - old_logprobs)\n return_mean, return_var = torch.mean(returns), torch.var(returns)\n value_mean, value_var = torch.mean(values), torch.var(values)\n\n stats = dict(\n loss=dict(policy=pg_loss, value=vf_loss, total=loss),\n policy=dict(\n entropy=entropy,\n approxkl=approxkl,\n policykl=policykl,\n clipfrac=pg_clipfrac,\n advantages=advantages,\n advantages_mean=torch.mean(advantages),\n ratio=ratio,\n ),\n returns=dict(mean=return_mean, var=return_var),\n val=dict(\n vpred=torch.mean(vpred),\n error=torch.mean((vpred - returns) ** 2),\n clipfrac=vf_clipfrac,\n mean=value_mean,\n var=value_var,\n ),\n )\n return pg_loss, self.config.vf_coef * vf_loss, flatten_dict(stats)\n\n def record_step_stats(self, kl_coef: float, **data):\n \"\"\"\n Record training step statistics.\n\n\n Args:\n kl_coef (`float`):\n KL coefficient\n data (`dict`):\n Dictionary of training step data\n\n Returns:\n stats (`dict`):\n Dictionary of training step statistics\n \"\"\"\n kl_list = [logprobs - ref_logprobs for logprobs, ref_logprobs in zip(data[\"logprobs\"], data[\"ref_logprobs\"])]\n mean_kl = torch.mean(torch.stack([torch.sum(kl) for kl in kl_list]))\n mean_entropy = torch.mean(torch.stack([torch.sum(-log_probs) for log_probs in data[\"logprobs\"]]))\n mean_non_score_reward = torch.mean(\n torch.stack([torch.sum(non_score_reward) for non_score_reward in data[\"non_score_reward\"]])\n )\n stats = {\n \"objective/kl\": mean_kl,\n \"objective/kl_dist\": kl_list,\n \"objective/logprobs\": data[\"logprobs\"],\n \"objective/ref_logprobs\": data[\"ref_logprobs\"],\n \"objective/kl_coef\": kl_coef,\n \"objective/entropy\": mean_entropy,\n \"ppo/mean_non_score_reward\": mean_non_score_reward,\n }\n\n for k, v in data[\"train_stats\"].items():\n stats[f\"ppo/{k}\"] = torch.mean(v, axis=0)\n stats[\"ppo/val/var_explained\"] = 1 - stats[\"ppo/val/error\"] / stats[\"ppo/returns/var\"]\n return stats\n\n def log_stats(\n self,\n stats: dict,\n batch: dict,\n rewards: List[torch.FloatTensor],\n ):\n \"\"\"\n A function that logs all the training stats. Call it at the end of each epoch.\n\n Args:\n stats (dict[str, Any]):\n A dictionary of training stats.\n batch (dict[str, Any]):\n A dictionary of batch data, this contains the queries and responses.\n rewards (`List[torch.FloatTensor]`):\n A tensor of rewards.\n \"\"\"\n # Log only if we are in the main process\n if self.accelerator.is_main_process:\n logs = {}\n\n # Log stats\n if not isinstance(rewards, torch.Tensor):\n rewards = torch.tensor(rewards).to(self.accelerator.device)\n\n if \"query\" not in batch.keys() and \"response\" not in batch.keys():\n # warn the user that the game logs will not be logged\n warnings.warn(\n \"The game logs will not be logged because the batch does not contain the keys 'query' and \"\n \"'response'. \"\n )\n elif self.config.log_with == \"wandb\":\n import wandb\n\n table_rows = [list(r) for r in zip(batch[\"query\"], batch[\"response\"], rewards.cpu().tolist())]\n logs.update({\"game_log\": wandb.Table(columns=[\"query\", \"response\", \"reward\"], rows=table_rows)})\n # All reduce rewards if distributed\n if self.is_distributed:\n import torch.distributed as dist\n\n dist.barrier()\n\n dist.all_reduce(rewards, op=torch.distributed.ReduceOp.SUM)\n rewards /= self.accelerator.num_processes\n\n logs.update(stats)\n logs[\"env/reward_mean\"] = torch.mean(rewards).cpu().numpy().item()\n logs[\"env/reward_std\"] = torch.std(rewards).cpu().numpy().item()\n logs[\"env/reward_dist\"] = rewards.cpu().numpy()\n\n if self.config.log_with == \"tensorboard\":\n # update the current step\n self.current_step += 1\n\n self.accelerator.log(logs, step=self.current_step if self.config.log_with == \"tensorboard\" else None)\n\n else:\n if self.is_distributed:\n import torch.distributed as dist\n\n if not isinstance(rewards, torch.Tensor):\n rewards = torch.tensor(rewards).to(self.accelerator.device)\n\n dist.barrier()\n dist.all_reduce(rewards, op=torch.distributed.ReduceOp.SUM)\n\n def create_model_card(self, path: str, model_name: Optional[str] = \"TRL Model\") -> None:\n \"\"\"Creates and saves a model card for a TRL model.\n\n Args:\n path (`str`): The path to save the model card to.\n model_name (`str`, *optional*): The name of the model, defaults to `TRL Model`.\n \"\"\"\n if not os.path.exists(path):\n os.makedirs(path)\n\n user = whoami()[\"name\"]\n model_card_content = MODEL_CARD_TEMPLATE.format(model_name=model_name, model_id=f\"{user}/{path}\")\n with open(os.path.join(path, \"README.md\"), \"w\", encoding=\"utf-8\") as f:\n f.write(model_card_content)\n\n def _save_pretrained(self, save_directory: str) -> None:\n self.model.save_pretrained(save_directory)\n self.tokenizer.save_pretrained(save_directory)\n self.create_model_card(save_directory)\n", "path": "trl/trainer/ppo_trainer.py"}]} |
gh_patches_debug_274 | rasdani/github-patches | git_diff | google__flax-270 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
`typing._ClassVar` cannot be accessed in the iPython shell – dataclasses package seems to mess up on Python 3.7
### Problem you have encountered:
I just installed flax and tried to import it from the iPython shell. But it raises an `AttributeError`.
```
In [1]: import flax
*snip*
~/.virtualenvs/flax2/lib/python3.7/site-packages/dataclasses.py in _is_classvar(a_type, typing)
548 # This test uses a typing internal class, but it's the best way to
549 # test if this is a ClassVar.
--> 550 return type(a_type) is typing._ClassVar
551
552
AttributeError: module 'typing' has no attribute '_ClassVar'
```
This does not happen in the normal interpreter, where everything goes fine.
### What you expected to happen:
I expected the import to work the same in iPython and the normal python shell.
### Logs, error messages, etc:
Full traceback in this gist: https://gist.github.com/bayerj/96f096c7fb09a7c9b758dabdbca32671
### Steps to reproduce:
On Mac OS X with Python 3.7.6, not anaconda, virtuelenvwrapper installed.
```
❯❯❯ mkvirtualenv flax2
❯❯❯ pip install jaxlib
*snip*
❯❯❯ pip install flax
*snip*
❯❯❯ ipython
*snip*
In [1]: import flax
```
### Workaround
The problem seems to be in the `dataclasses` package–not python's own one–from PyPI. If I uninstall it...
```
❯❯❯ pip uninstall dataclasses
Found existing installation: dataclasses 0.6
Uninstalling dataclasses-0.6:
Would remove:
/Users/bayerj/.virtualenvs/debug2/lib/python3.7/site-packages/dataclasses-0.6.dist-info/*
/Users/bayerj/.virtualenvs/debug2/lib/python3.7/site-packages/dataclasses.py
Proceed (y/n)? y
Successfully uninstalled dataclasses-0.6
❯❯❯ ipython
/usr/local/lib/python3.7/site-packages/IPython/core/interactiveshell.py:931: UserWarning: Attempting to work in a virtualenv. If you encounter problems, please install IPython inside the virtualenv.
warn("Attempting to work in a virtualenv. If you encounter problems, please "
Python 3.7.6 (default, Dec 30 2019, 19:38:28)
Type 'copyright', 'credits' or 'license' for more information
IPython 7.9.0 -- An enhanced Interactive Python. Type '?' for help.
In [1]: import flax
```
... this goes fine.
--- 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 # Copyright 2020 The Flax 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 """setup.py for Flax."""
16
17 import os
18 from setuptools import find_packages
19 from setuptools import setup
20
21 version = "0.1.0"
22
23 here = os.path.abspath(os.path.dirname(__file__))
24 try:
25 README = open(os.path.join(here, "README.md"), encoding='utf-8').read()
26 except IOError:
27 README = ""
28
29 install_requires = [
30 "numpy>=1.12",
31 "jax>=0.1.59",
32 "matplotlib", # only needed for tensorboard export
33 "dataclasses", # will only install on py3.6
34 "msgpack",
35 ]
36
37 tests_require = [
38 "jaxlib",
39 "pytest",
40 "pytest-cov",
41 "pytest-xdist",
42 "tensorflow",
43 "tensorflow_datasets",
44 ]
45
46 setup(
47 name="flax",
48 version=version,
49 description="Flax: A neural network library for JAX designed for flexibility",
50 long_description="\n\n".join([README]),
51 long_description_content_type='text/markdown',
52 classifiers=[
53 "Development Status :: 3 - Alpha",
54 "Intended Audience :: Developers",
55 "Intended Audience :: Science/Research",
56 "License :: OSI Approved :: MIT License",
57 "Programming Language :: Python :: 3.7",
58 "Topic :: Scientific/Engineering :: Artificial Intelligence",
59 ],
60 keywords="",
61 author="Flax team",
62 author_email="[email protected]",
63 url="https://github.com/google/flax",
64 license="Apache",
65 packages=find_packages(),
66 include_package_data=False,
67 zip_safe=False,
68 install_requires=install_requires,
69 extras_require={
70 "testing": tests_require,
71 },
72 )
73
```
--- 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
@@ -30,7 +30,7 @@
"numpy>=1.12",
"jax>=0.1.59",
"matplotlib", # only needed for tensorboard export
- "dataclasses", # will only install on py3.6
+ "dataclasses;python_version<'3.7'", # will only install on py3.6
"msgpack",
]
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -30,7 +30,7 @@\n \"numpy>=1.12\",\n \"jax>=0.1.59\",\n \"matplotlib\", # only needed for tensorboard export\n- \"dataclasses\", # will only install on py3.6\n+ \"dataclasses;python_version<'3.7'\", # will only install on py3.6\n \"msgpack\",\n ]\n", "issue": "`typing._ClassVar` cannot be accessed in the iPython shell \u2013 dataclasses package seems to mess up on Python 3.7\n### Problem you have encountered:\r\n\r\nI just installed flax and tried to import it from the iPython shell. But it raises an `AttributeError`.\r\n\r\n```\r\nIn [1]: import flax\r\n\r\n*snip*\r\n\r\n~/.virtualenvs/flax2/lib/python3.7/site-packages/dataclasses.py in _is_classvar(a_type, typing)\r\n 548 # This test uses a typing internal class, but it's the best way to\r\n 549 # test if this is a ClassVar.\r\n--> 550 return type(a_type) is typing._ClassVar\r\n 551\r\n 552\r\n\r\nAttributeError: module 'typing' has no attribute '_ClassVar'\r\n```\r\nThis does not happen in the normal interpreter, where everything goes fine. \r\n\r\n### What you expected to happen:\r\n\r\nI expected the import to work the same in iPython and the normal python shell.\r\n\r\n### Logs, error messages, etc:\r\n\r\nFull traceback in this gist: https://gist.github.com/bayerj/96f096c7fb09a7c9b758dabdbca32671\r\n\r\n### Steps to reproduce:\r\n\r\nOn Mac OS X with Python 3.7.6, not anaconda, virtuelenvwrapper installed.\r\n\r\n```\r\n\u276f\u276f\u276f mkvirtualenv flax2\r\n\u276f\u276f\u276f pip install jaxlib\r\n*snip*\r\n\u276f\u276f\u276f pip install flax\r\n*snip*\r\n\u276f\u276f\u276f ipython\r\n\r\n*snip*\r\n\r\nIn [1]: import flax\r\n```\r\n\r\n### Workaround\r\n\r\nThe problem seems to be in the `dataclasses` package\u2013not python's own one\u2013from PyPI. If I uninstall it...\r\n\r\n```\r\n\u276f\u276f\u276f pip uninstall dataclasses\r\nFound existing installation: dataclasses 0.6\r\nUninstalling dataclasses-0.6:\r\n Would remove:\r\n /Users/bayerj/.virtualenvs/debug2/lib/python3.7/site-packages/dataclasses-0.6.dist-info/*\r\n /Users/bayerj/.virtualenvs/debug2/lib/python3.7/site-packages/dataclasses.py\r\nProceed (y/n)? y\r\n Successfully uninstalled dataclasses-0.6\r\n\u276f\u276f\u276f ipython\r\n/usr/local/lib/python3.7/site-packages/IPython/core/interactiveshell.py:931: UserWarning: Attempting to work in a virtualenv. If you encounter problems, please install IPython inside the virtualenv.\r\n warn(\"Attempting to work in a virtualenv. If you encounter problems, please \"\r\nPython 3.7.6 (default, Dec 30 2019, 19:38:28)\r\nType 'copyright', 'credits' or 'license' for more information\r\nIPython 7.9.0 -- An enhanced Interactive Python. Type '?' for help.\r\n\r\nIn [1]: import flax\r\n```\r\n... this goes fine.\r\n\r\n\r\n\r\n\n", "before_files": [{"content": "# Copyright 2020 The Flax 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\"\"\"setup.py for Flax.\"\"\"\n\nimport os\nfrom setuptools import find_packages\nfrom setuptools import setup\n\nversion = \"0.1.0\"\n\nhere = os.path.abspath(os.path.dirname(__file__))\ntry:\n README = open(os.path.join(here, \"README.md\"), encoding='utf-8').read()\nexcept IOError:\n README = \"\"\n\ninstall_requires = [\n \"numpy>=1.12\",\n \"jax>=0.1.59\",\n \"matplotlib\", # only needed for tensorboard export\n \"dataclasses\", # will only install on py3.6\n \"msgpack\",\n]\n\ntests_require = [\n \"jaxlib\",\n \"pytest\",\n \"pytest-cov\",\n \"pytest-xdist\",\n \"tensorflow\",\n \"tensorflow_datasets\",\n]\n\nsetup(\n name=\"flax\",\n version=version,\n description=\"Flax: A neural network library for JAX designed for flexibility\",\n long_description=\"\\n\\n\".join([README]),\n long_description_content_type='text/markdown',\n classifiers=[\n \"Development Status :: 3 - Alpha\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: Science/Research\",\n \"License :: OSI Approved :: MIT License\",\n \"Programming Language :: Python :: 3.7\",\n \"Topic :: Scientific/Engineering :: Artificial Intelligence\",\n ],\n keywords=\"\",\n author=\"Flax team\",\n author_email=\"[email protected]\",\n url=\"https://github.com/google/flax\",\n license=\"Apache\",\n packages=find_packages(),\n include_package_data=False,\n zip_safe=False,\n install_requires=install_requires,\n extras_require={\n \"testing\": tests_require,\n },\n )\n", "path": "setup.py"}], "after_files": [{"content": "# Copyright 2020 The Flax 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\"\"\"setup.py for Flax.\"\"\"\n\nimport os\nfrom setuptools import find_packages\nfrom setuptools import setup\n\nversion = \"0.1.0\"\n\nhere = os.path.abspath(os.path.dirname(__file__))\ntry:\n README = open(os.path.join(here, \"README.md\"), encoding='utf-8').read()\nexcept IOError:\n README = \"\"\n\ninstall_requires = [\n \"numpy>=1.12\",\n \"jax>=0.1.59\",\n \"matplotlib\", # only needed for tensorboard export\n \"dataclasses;python_version<'3.7'\", # will only install on py3.6\n \"msgpack\",\n]\n\ntests_require = [\n \"jaxlib\",\n \"pytest\",\n \"pytest-cov\",\n \"pytest-xdist\",\n \"tensorflow\",\n \"tensorflow_datasets\",\n]\n\nsetup(\n name=\"flax\",\n version=version,\n description=\"Flax: A neural network library for JAX designed for flexibility\",\n long_description=\"\\n\\n\".join([README]),\n long_description_content_type='text/markdown',\n classifiers=[\n \"Development Status :: 3 - Alpha\",\n \"Intended Audience :: Developers\",\n \"Intended Audience :: Science/Research\",\n \"License :: OSI Approved :: MIT License\",\n \"Programming Language :: Python :: 3.7\",\n \"Topic :: Scientific/Engineering :: Artificial Intelligence\",\n ],\n keywords=\"\",\n author=\"Flax team\",\n author_email=\"[email protected]\",\n url=\"https://github.com/google/flax\",\n license=\"Apache\",\n packages=find_packages(),\n include_package_data=False,\n zip_safe=False,\n install_requires=install_requires,\n extras_require={\n \"testing\": tests_require,\n },\n )\n", "path": "setup.py"}]} |
gh_patches_debug_275 | rasdani/github-patches | git_diff | fossasia__open-event-server-2599 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Import not working on Kubernetes deployment
The file upload for import is not working on Kubernetes deployment. (but works locally and on heroku)
--- 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/helpers/storage.py`
Content:
```
1 import os
2 from base64 import b64encode
3 from shutil import copyfile, rmtree
4
5 from boto.gs.connection import GSConnection
6 from flask.ext.scrypt import generate_password_hash
7 from boto.s3.connection import S3Connection
8 from boto.s3.key import Key
9 from werkzeug.utils import secure_filename
10 import magic
11
12 from app.settings import get_settings
13
14 #################
15 # STORAGE SCHEMA
16 #################
17
18 UPLOAD_PATHS = {
19 'sessions': {
20 'video': 'events/{event_id}/sessions/{id}/video',
21 'audio': 'events/{event_id}/audios/{id}/audio',
22 'slides': 'events/{event_id}/slides/{id}/slides'
23 },
24 'speakers': {
25 'photo': 'events/{event_id}/speakers/{id}/photo',
26 'thumbnail': 'events/{event_id}/speakers/{id}/thumbnail',
27 'small': 'events/{event_id}/speakers/{id}/small',
28 'icon': 'events/{event_id}/speakers/{id}/icon'
29 },
30 'event': {
31 'logo': 'events/{event_id}/logo',
32 'background_url': 'events/{event_id}/background',
33 'thumbnail': 'events/{event_id}/thumbnail',
34 'large': 'events/{event_id}/large',
35 'icon': 'events/{event_id}/icon'
36 },
37 'sponsors': {
38 'logo': 'events/{event_id}/sponsors/{id}/logo'
39 },
40 'tracks': {
41 'track_image_url': 'events/{event_id}/tracks/{id}/track_image'
42 },
43 'user': {
44 'avatar': 'users/{user_id}/avatar',
45 'thumbnail': 'users/{user_id}/thumbnail',
46 'small': 'users/{user_id}/small',
47 'icon': 'users/{user_id}/icon'
48 },
49 'temp': {
50 'event': 'events/temp/{uuid}'
51 }
52 }
53
54
55 ################
56 # HELPER CLASSES
57 ################
58
59 class UploadedFile(object):
60 """
61 Helper for a disk-file to replicate request.files[ITEM] class
62 """
63 def __init__(self, file_path, filename):
64 self.file_path = file_path
65 self.filename = filename
66 self.file = open(file_path)
67
68 def save(self, new_path):
69 copyfile(self.file_path, new_path)
70
71 def read(self):
72 return self.file.read()
73
74 def __exit__(self, *args, **kwargs):
75 self.file.close()
76
77
78 class UploadedMemory(object):
79 """
80 Helper for a memory file to replicate request.files[ITEM] class
81 """
82 def __init__(self, data, filename):
83 self.data = data
84 self.filename = filename
85
86 def read(self):
87 return self.data
88
89 def save(self, path):
90 f = open(path, 'w')
91 f.write(self.data)
92 f.close()
93
94
95 #########
96 # MAIN
97 #########
98
99 def upload(uploaded_file, key, **kwargs):
100 """
101 Upload handler
102 """
103 # refresh settings
104 aws_bucket_name = get_settings()['aws_bucket_name']
105 aws_key = get_settings()['aws_key']
106 aws_secret = get_settings()['aws_secret']
107
108 gs_bucket_name = get_settings()['gs_bucket_name']
109 gs_key = get_settings()['gs_key']
110 gs_secret = get_settings()['gs_secret']
111
112 storage_place = get_settings()['storage_place']
113
114 # upload
115 if aws_bucket_name and aws_key and aws_secret and storage_place == 's3':
116 return upload_to_aws(aws_bucket_name, aws_key, aws_secret, uploaded_file, key, **kwargs)
117 elif gs_bucket_name and gs_key and gs_secret and storage_place == 'gs':
118 return upload_to_gs(gs_bucket_name, gs_key, gs_secret, uploaded_file, key, **kwargs)
119 else:
120 return upload_local(uploaded_file, key, **kwargs)
121
122
123 def upload_local(uploaded_file, key, **kwargs):
124 """
125 Uploads file locally. Base dir - static/media/
126 """
127 filename = secure_filename(uploaded_file.filename)
128 file_path = 'static/media/' + key + '/' + generate_hash(key) + '/' + filename
129 dir_path = file_path.rsplit('/', 1)[0]
130 # delete current
131 try:
132 rmtree(dir_path)
133 except OSError:
134 pass
135 # create dirs
136 if not os.path.isdir(dir_path):
137 os.makedirs(dir_path)
138 uploaded_file.save(file_path)
139 return '/serve_' + file_path
140
141
142 def upload_to_aws(bucket_name, aws_key, aws_secret, file, key, acl='public-read'):
143 """
144 Uploads to AWS at key
145 http://{bucket}.s3.amazonaws.com/{key}
146 """
147 conn = S3Connection(aws_key, aws_secret)
148 bucket = conn.get_bucket(bucket_name)
149 k = Key(bucket)
150 # generate key
151 filename = secure_filename(file.filename)
152 key_dir = key + '/' + generate_hash(key) + '/'
153 k.key = key_dir + filename
154 # delete old data
155 for item in bucket.list(prefix='/' + key_dir):
156 item.delete()
157 # set object settings
158
159 file_data = file.read()
160 file_mime = magic.from_buffer(file_data, mime=True)
161 size = len(file_data)
162 sent = k.set_contents_from_string(
163 file_data,
164 headers={
165 'Content-Disposition': 'attachment; filename=%s' % filename,
166 'Content-Type': '%s' % file_mime
167 }
168 )
169 k.set_acl(acl)
170 s3_url = 'https://%s.s3.amazonaws.com/' % bucket_name
171 if sent == size:
172 return s3_url + k.key
173 return False
174
175
176 def upload_to_gs(bucket_name, client_id, client_secret, file, key, acl='public-read'):
177 conn = GSConnection(client_id, client_secret)
178 bucket = conn.get_bucket(bucket_name)
179 k = Key(bucket)
180 # generate key
181 filename = secure_filename(file.filename)
182 key_dir = key + '/' + generate_hash(key) + '/'
183 k.key = key_dir + filename
184 # delete old data
185 for item in bucket.list(prefix='/' + key_dir):
186 item.delete()
187 # set object settings
188
189 file_data = file.read()
190 file_mime = magic.from_buffer(file_data, mime=True)
191 size = len(file_data)
192 sent = k.set_contents_from_string(
193 file_data,
194 headers={
195 'Content-Disposition': 'attachment; filename=%s' % filename,
196 'Content-Type': '%s' % file_mime
197 }
198 )
199 k.set_acl(acl)
200 gs_url = 'https://storage.googleapis.com/%s/' % bucket_name
201 if sent == size:
202 return gs_url + key
203 return False
204
205 # ########
206 # HELPERS
207 # ########
208
209
210 def generate_hash(key):
211 """
212 Generate hash for key
213 """
214 phash = generate_password_hash(key, get_settings()['secret'])
215 return b64encode(phash)[:10] # limit len to 10, is sufficient
216
```
--- 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/helpers/storage.py b/app/helpers/storage.py
--- a/app/helpers/storage.py
+++ b/app/helpers/storage.py
@@ -199,7 +199,7 @@
k.set_acl(acl)
gs_url = 'https://storage.googleapis.com/%s/' % bucket_name
if sent == size:
- return gs_url + key
+ return gs_url + k.key
return False
# ########
| {"golden_diff": "diff --git a/app/helpers/storage.py b/app/helpers/storage.py\n--- a/app/helpers/storage.py\n+++ b/app/helpers/storage.py\n@@ -199,7 +199,7 @@\n k.set_acl(acl)\n gs_url = 'https://storage.googleapis.com/%s/' % bucket_name\n if sent == size:\n- return gs_url + key\n+ return gs_url + k.key\n return False\n \n # ########\n", "issue": "Import not working on Kubernetes deployment\nThe file upload for import is not working on Kubernetes deployment. (but works locally and on heroku)\r\n\r\n\n", "before_files": [{"content": "import os\nfrom base64 import b64encode\nfrom shutil import copyfile, rmtree\n\nfrom boto.gs.connection import GSConnection\nfrom flask.ext.scrypt import generate_password_hash\nfrom boto.s3.connection import S3Connection\nfrom boto.s3.key import Key\nfrom werkzeug.utils import secure_filename\nimport magic\n\nfrom app.settings import get_settings\n\n#################\n# STORAGE SCHEMA\n#################\n\nUPLOAD_PATHS = {\n 'sessions': {\n 'video': 'events/{event_id}/sessions/{id}/video',\n 'audio': 'events/{event_id}/audios/{id}/audio',\n 'slides': 'events/{event_id}/slides/{id}/slides'\n },\n 'speakers': {\n 'photo': 'events/{event_id}/speakers/{id}/photo',\n 'thumbnail': 'events/{event_id}/speakers/{id}/thumbnail',\n 'small': 'events/{event_id}/speakers/{id}/small',\n 'icon': 'events/{event_id}/speakers/{id}/icon'\n },\n 'event': {\n 'logo': 'events/{event_id}/logo',\n 'background_url': 'events/{event_id}/background',\n 'thumbnail': 'events/{event_id}/thumbnail',\n 'large': 'events/{event_id}/large',\n 'icon': 'events/{event_id}/icon'\n },\n 'sponsors': {\n 'logo': 'events/{event_id}/sponsors/{id}/logo'\n },\n 'tracks': {\n 'track_image_url': 'events/{event_id}/tracks/{id}/track_image'\n },\n 'user': {\n 'avatar': 'users/{user_id}/avatar',\n 'thumbnail': 'users/{user_id}/thumbnail',\n 'small': 'users/{user_id}/small',\n 'icon': 'users/{user_id}/icon'\n },\n 'temp': {\n 'event': 'events/temp/{uuid}'\n }\n}\n\n\n################\n# HELPER CLASSES\n################\n\nclass UploadedFile(object):\n \"\"\"\n Helper for a disk-file to replicate request.files[ITEM] class\n \"\"\"\n def __init__(self, file_path, filename):\n self.file_path = file_path\n self.filename = filename\n self.file = open(file_path)\n\n def save(self, new_path):\n copyfile(self.file_path, new_path)\n\n def read(self):\n return self.file.read()\n\n def __exit__(self, *args, **kwargs):\n self.file.close()\n\n\nclass UploadedMemory(object):\n \"\"\"\n Helper for a memory file to replicate request.files[ITEM] class\n \"\"\"\n def __init__(self, data, filename):\n self.data = data\n self.filename = filename\n\n def read(self):\n return self.data\n\n def save(self, path):\n f = open(path, 'w')\n f.write(self.data)\n f.close()\n\n\n#########\n# MAIN\n#########\n\ndef upload(uploaded_file, key, **kwargs):\n \"\"\"\n Upload handler\n \"\"\"\n # refresh settings\n aws_bucket_name = get_settings()['aws_bucket_name']\n aws_key = get_settings()['aws_key']\n aws_secret = get_settings()['aws_secret']\n\n gs_bucket_name = get_settings()['gs_bucket_name']\n gs_key = get_settings()['gs_key']\n gs_secret = get_settings()['gs_secret']\n\n storage_place = get_settings()['storage_place']\n\n # upload\n if aws_bucket_name and aws_key and aws_secret and storage_place == 's3':\n return upload_to_aws(aws_bucket_name, aws_key, aws_secret, uploaded_file, key, **kwargs)\n elif gs_bucket_name and gs_key and gs_secret and storage_place == 'gs':\n return upload_to_gs(gs_bucket_name, gs_key, gs_secret, uploaded_file, key, **kwargs)\n else:\n return upload_local(uploaded_file, key, **kwargs)\n\n\ndef upload_local(uploaded_file, key, **kwargs):\n \"\"\"\n Uploads file locally. Base dir - static/media/\n \"\"\"\n filename = secure_filename(uploaded_file.filename)\n file_path = 'static/media/' + key + '/' + generate_hash(key) + '/' + filename\n dir_path = file_path.rsplit('/', 1)[0]\n # delete current\n try:\n rmtree(dir_path)\n except OSError:\n pass\n # create dirs\n if not os.path.isdir(dir_path):\n os.makedirs(dir_path)\n uploaded_file.save(file_path)\n return '/serve_' + file_path\n\n\ndef upload_to_aws(bucket_name, aws_key, aws_secret, file, key, acl='public-read'):\n \"\"\"\n Uploads to AWS at key\n http://{bucket}.s3.amazonaws.com/{key}\n \"\"\"\n conn = S3Connection(aws_key, aws_secret)\n bucket = conn.get_bucket(bucket_name)\n k = Key(bucket)\n # generate key\n filename = secure_filename(file.filename)\n key_dir = key + '/' + generate_hash(key) + '/'\n k.key = key_dir + filename\n # delete old data\n for item in bucket.list(prefix='/' + key_dir):\n item.delete()\n # set object settings\n\n file_data = file.read()\n file_mime = magic.from_buffer(file_data, mime=True)\n size = len(file_data)\n sent = k.set_contents_from_string(\n file_data,\n headers={\n 'Content-Disposition': 'attachment; filename=%s' % filename,\n 'Content-Type': '%s' % file_mime\n }\n )\n k.set_acl(acl)\n s3_url = 'https://%s.s3.amazonaws.com/' % bucket_name\n if sent == size:\n return s3_url + k.key\n return False\n\n\ndef upload_to_gs(bucket_name, client_id, client_secret, file, key, acl='public-read'):\n conn = GSConnection(client_id, client_secret)\n bucket = conn.get_bucket(bucket_name)\n k = Key(bucket)\n # generate key\n filename = secure_filename(file.filename)\n key_dir = key + '/' + generate_hash(key) + '/'\n k.key = key_dir + filename\n # delete old data\n for item in bucket.list(prefix='/' + key_dir):\n item.delete()\n # set object settings\n\n file_data = file.read()\n file_mime = magic.from_buffer(file_data, mime=True)\n size = len(file_data)\n sent = k.set_contents_from_string(\n file_data,\n headers={\n 'Content-Disposition': 'attachment; filename=%s' % filename,\n 'Content-Type': '%s' % file_mime\n }\n )\n k.set_acl(acl)\n gs_url = 'https://storage.googleapis.com/%s/' % bucket_name\n if sent == size:\n return gs_url + key\n return False\n\n# ########\n# HELPERS\n# ########\n\n\ndef generate_hash(key):\n \"\"\"\n Generate hash for key\n \"\"\"\n phash = generate_password_hash(key, get_settings()['secret'])\n return b64encode(phash)[:10] # limit len to 10, is sufficient\n", "path": "app/helpers/storage.py"}], "after_files": [{"content": "import os\nfrom base64 import b64encode\nfrom shutil import copyfile, rmtree\n\nfrom boto.gs.connection import GSConnection\nfrom flask.ext.scrypt import generate_password_hash\nfrom boto.s3.connection import S3Connection\nfrom boto.s3.key import Key\nfrom werkzeug.utils import secure_filename\nimport magic\n\nfrom app.settings import get_settings\n\n#################\n# STORAGE SCHEMA\n#################\n\nUPLOAD_PATHS = {\n 'sessions': {\n 'video': 'events/{event_id}/sessions/{id}/video',\n 'audio': 'events/{event_id}/audios/{id}/audio',\n 'slides': 'events/{event_id}/slides/{id}/slides'\n },\n 'speakers': {\n 'photo': 'events/{event_id}/speakers/{id}/photo',\n 'thumbnail': 'events/{event_id}/speakers/{id}/thumbnail',\n 'small': 'events/{event_id}/speakers/{id}/small',\n 'icon': 'events/{event_id}/speakers/{id}/icon'\n },\n 'event': {\n 'logo': 'events/{event_id}/logo',\n 'background_url': 'events/{event_id}/background',\n 'thumbnail': 'events/{event_id}/thumbnail',\n 'large': 'events/{event_id}/large',\n 'icon': 'events/{event_id}/icon'\n },\n 'sponsors': {\n 'logo': 'events/{event_id}/sponsors/{id}/logo'\n },\n 'tracks': {\n 'track_image_url': 'events/{event_id}/tracks/{id}/track_image'\n },\n 'user': {\n 'avatar': 'users/{user_id}/avatar',\n 'thumbnail': 'users/{user_id}/thumbnail',\n 'small': 'users/{user_id}/small',\n 'icon': 'users/{user_id}/icon'\n },\n 'temp': {\n 'event': 'events/temp/{uuid}'\n }\n}\n\n\n################\n# HELPER CLASSES\n################\n\nclass UploadedFile(object):\n \"\"\"\n Helper for a disk-file to replicate request.files[ITEM] class\n \"\"\"\n def __init__(self, file_path, filename):\n self.file_path = file_path\n self.filename = filename\n self.file = open(file_path)\n\n def save(self, new_path):\n copyfile(self.file_path, new_path)\n\n def read(self):\n return self.file.read()\n\n def __exit__(self, *args, **kwargs):\n self.file.close()\n\n\nclass UploadedMemory(object):\n \"\"\"\n Helper for a memory file to replicate request.files[ITEM] class\n \"\"\"\n def __init__(self, data, filename):\n self.data = data\n self.filename = filename\n\n def read(self):\n return self.data\n\n def save(self, path):\n f = open(path, 'w')\n f.write(self.data)\n f.close()\n\n\n#########\n# MAIN\n#########\n\ndef upload(uploaded_file, key, **kwargs):\n \"\"\"\n Upload handler\n \"\"\"\n # refresh settings\n aws_bucket_name = get_settings()['aws_bucket_name']\n aws_key = get_settings()['aws_key']\n aws_secret = get_settings()['aws_secret']\n\n gs_bucket_name = get_settings()['gs_bucket_name']\n gs_key = get_settings()['gs_key']\n gs_secret = get_settings()['gs_secret']\n\n storage_place = get_settings()['storage_place']\n\n # upload\n if aws_bucket_name and aws_key and aws_secret and storage_place == 's3':\n return upload_to_aws(aws_bucket_name, aws_key, aws_secret, uploaded_file, key, **kwargs)\n elif gs_bucket_name and gs_key and gs_secret and storage_place == 'gs':\n return upload_to_gs(gs_bucket_name, gs_key, gs_secret, uploaded_file, key, **kwargs)\n else:\n return upload_local(uploaded_file, key, **kwargs)\n\n\ndef upload_local(uploaded_file, key, **kwargs):\n \"\"\"\n Uploads file locally. Base dir - static/media/\n \"\"\"\n filename = secure_filename(uploaded_file.filename)\n file_path = 'static/media/' + key + '/' + generate_hash(key) + '/' + filename\n dir_path = file_path.rsplit('/', 1)[0]\n # delete current\n try:\n rmtree(dir_path)\n except OSError:\n pass\n # create dirs\n if not os.path.isdir(dir_path):\n os.makedirs(dir_path)\n uploaded_file.save(file_path)\n return '/serve_' + file_path\n\n\ndef upload_to_aws(bucket_name, aws_key, aws_secret, file, key, acl='public-read'):\n \"\"\"\n Uploads to AWS at key\n http://{bucket}.s3.amazonaws.com/{key}\n \"\"\"\n conn = S3Connection(aws_key, aws_secret)\n bucket = conn.get_bucket(bucket_name)\n k = Key(bucket)\n # generate key\n filename = secure_filename(file.filename)\n key_dir = key + '/' + generate_hash(key) + '/'\n k.key = key_dir + filename\n # delete old data\n for item in bucket.list(prefix='/' + key_dir):\n item.delete()\n # set object settings\n\n file_data = file.read()\n file_mime = magic.from_buffer(file_data, mime=True)\n size = len(file_data)\n sent = k.set_contents_from_string(\n file_data,\n headers={\n 'Content-Disposition': 'attachment; filename=%s' % filename,\n 'Content-Type': '%s' % file_mime\n }\n )\n k.set_acl(acl)\n s3_url = 'https://%s.s3.amazonaws.com/' % bucket_name\n if sent == size:\n return s3_url + k.key\n return False\n\n\ndef upload_to_gs(bucket_name, client_id, client_secret, file, key, acl='public-read'):\n conn = GSConnection(client_id, client_secret)\n bucket = conn.get_bucket(bucket_name)\n k = Key(bucket)\n # generate key\n filename = secure_filename(file.filename)\n key_dir = key + '/' + generate_hash(key) + '/'\n k.key = key_dir + filename\n # delete old data\n for item in bucket.list(prefix='/' + key_dir):\n item.delete()\n # set object settings\n\n file_data = file.read()\n file_mime = magic.from_buffer(file_data, mime=True)\n size = len(file_data)\n sent = k.set_contents_from_string(\n file_data,\n headers={\n 'Content-Disposition': 'attachment; filename=%s' % filename,\n 'Content-Type': '%s' % file_mime\n }\n )\n k.set_acl(acl)\n gs_url = 'https://storage.googleapis.com/%s/' % bucket_name\n if sent == size:\n return gs_url + k.key\n return False\n\n# ########\n# HELPERS\n# ########\n\n\ndef generate_hash(key):\n \"\"\"\n Generate hash for key\n \"\"\"\n phash = generate_password_hash(key, get_settings()['secret'])\n return b64encode(phash)[:10] # limit len to 10, is sufficient\n", "path": "app/helpers/storage.py"}]} |
gh_patches_debug_276 | rasdani/github-patches | git_diff | kivy__python-for-android-615 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
OpenSSL 1.0.2e outdated (replaced by 1.0.2f)
A new version has been published today. The recipe no longer can download version 1.0.2e.
Does `disable-solver.patch` still apply?
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `pythonforandroid/recipes/openssl/__init__.py`
Content:
```
1 from functools import partial
2
3 from pythonforandroid.toolchain import Recipe, shprint, current_directory
4 import sh
5
6
7 class OpenSSLRecipe(Recipe):
8 version = '1.0.2e'
9 url = 'https://www.openssl.org/source/openssl-{version}.tar.gz'
10
11 def should_build(self, arch):
12 return not self.has_libs(arch, 'libssl.so', 'libcrypto.so')
13
14 def check_symbol(self, env, sofile, symbol):
15 nm = env.get('NM', 'nm')
16 syms = sh.sh('-c', "{} -gp {} | cut -d' ' -f3".format(
17 nm, sofile), _env=env).splitlines()
18 if symbol in syms:
19 return True
20 print('{} missing symbol {}; rebuilding'.format(sofile, symbol))
21 return False
22
23 def get_recipe_env(self, arch=None):
24 env = super(OpenSSLRecipe, self).get_recipe_env(arch)
25 env['CFLAGS'] += ' ' + env['LDFLAGS']
26 env['CC'] += ' ' + env['LDFLAGS']
27 return env
28
29 def select_build_arch(self, arch):
30 aname = arch.arch
31 if 'arm64' in aname:
32 return 'linux-aarch64'
33 if 'v7a' in aname:
34 return 'android-armv7'
35 if 'arm' in aname:
36 return 'android'
37 return 'linux-armv4'
38
39 def build_arch(self, arch):
40 env = self.get_recipe_env(arch)
41 with current_directory(self.get_build_dir(arch.arch)):
42 # sh fails with code 255 trying to execute ./Configure
43 # so instead we manually run perl passing in Configure
44 perl = sh.Command('perl')
45 buildarch = self.select_build_arch(arch)
46 shprint(perl, 'Configure', 'shared', 'no-dso', 'no-krb5', buildarch, _env=env)
47 self.apply_patch('disable-sover.patch', arch.arch)
48
49 check_crypto = partial(self.check_symbol, env, 'libcrypto.so')
50 # check_ssl = partial(self.check_symbol, env, 'libssl.so')
51 while True:
52 shprint(sh.make, 'build_libs', _env=env)
53 if all(map(check_crypto, ('SSLeay', 'MD5_Transform', 'MD4_Init'))):
54 break
55 shprint(sh.make, 'clean', _env=env)
56
57 self.install_libs(arch, 'libssl.so', 'libcrypto.so')
58
59 recipe = OpenSSLRecipe()
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/pythonforandroid/recipes/openssl/__init__.py b/pythonforandroid/recipes/openssl/__init__.py
--- a/pythonforandroid/recipes/openssl/__init__.py
+++ b/pythonforandroid/recipes/openssl/__init__.py
@@ -5,7 +5,7 @@
class OpenSSLRecipe(Recipe):
- version = '1.0.2e'
+ version = '1.0.2f'
url = 'https://www.openssl.org/source/openssl-{version}.tar.gz'
def should_build(self, arch):
| {"golden_diff": "diff --git a/pythonforandroid/recipes/openssl/__init__.py b/pythonforandroid/recipes/openssl/__init__.py\n--- a/pythonforandroid/recipes/openssl/__init__.py\n+++ b/pythonforandroid/recipes/openssl/__init__.py\n@@ -5,7 +5,7 @@\n \n \n class OpenSSLRecipe(Recipe):\n- version = '1.0.2e'\n+ version = '1.0.2f'\n url = 'https://www.openssl.org/source/openssl-{version}.tar.gz'\n \n def should_build(self, arch):\n", "issue": "OpenSSL 1.0.2e outdated (replaced by 1.0.2f)\nA new version has been published today. The recipe no longer can download version 1.0.2e.\n\nDoes `disable-solver.patch` still apply?\n\n", "before_files": [{"content": "from functools import partial\n\nfrom pythonforandroid.toolchain import Recipe, shprint, current_directory\nimport sh\n\n\nclass OpenSSLRecipe(Recipe):\n version = '1.0.2e'\n url = 'https://www.openssl.org/source/openssl-{version}.tar.gz'\n\n def should_build(self, arch):\n return not self.has_libs(arch, 'libssl.so', 'libcrypto.so')\n\n def check_symbol(self, env, sofile, symbol):\n nm = env.get('NM', 'nm')\n syms = sh.sh('-c', \"{} -gp {} | cut -d' ' -f3\".format(\n nm, sofile), _env=env).splitlines()\n if symbol in syms:\n return True\n print('{} missing symbol {}; rebuilding'.format(sofile, symbol))\n return False\n\n def get_recipe_env(self, arch=None):\n env = super(OpenSSLRecipe, self).get_recipe_env(arch)\n env['CFLAGS'] += ' ' + env['LDFLAGS']\n env['CC'] += ' ' + env['LDFLAGS']\n return env\n\n def select_build_arch(self, arch):\n aname = arch.arch\n if 'arm64' in aname:\n return 'linux-aarch64'\n if 'v7a' in aname:\n return 'android-armv7'\n if 'arm' in aname:\n return 'android'\n return 'linux-armv4'\n\n def build_arch(self, arch):\n env = self.get_recipe_env(arch)\n with current_directory(self.get_build_dir(arch.arch)):\n # sh fails with code 255 trying to execute ./Configure\n # so instead we manually run perl passing in Configure\n perl = sh.Command('perl')\n buildarch = self.select_build_arch(arch)\n shprint(perl, 'Configure', 'shared', 'no-dso', 'no-krb5', buildarch, _env=env)\n self.apply_patch('disable-sover.patch', arch.arch)\n\n check_crypto = partial(self.check_symbol, env, 'libcrypto.so')\n # check_ssl = partial(self.check_symbol, env, 'libssl.so')\n while True:\n shprint(sh.make, 'build_libs', _env=env)\n if all(map(check_crypto, ('SSLeay', 'MD5_Transform', 'MD4_Init'))):\n break\n shprint(sh.make, 'clean', _env=env)\n\n self.install_libs(arch, 'libssl.so', 'libcrypto.so')\n\nrecipe = OpenSSLRecipe()\n", "path": "pythonforandroid/recipes/openssl/__init__.py"}], "after_files": [{"content": "from functools import partial\n\nfrom pythonforandroid.toolchain import Recipe, shprint, current_directory\nimport sh\n\n\nclass OpenSSLRecipe(Recipe):\n version = '1.0.2f'\n url = 'https://www.openssl.org/source/openssl-{version}.tar.gz'\n\n def should_build(self, arch):\n return not self.has_libs(arch, 'libssl.so', 'libcrypto.so')\n\n def check_symbol(self, env, sofile, symbol):\n nm = env.get('NM', 'nm')\n syms = sh.sh('-c', \"{} -gp {} | cut -d' ' -f3\".format(\n nm, sofile), _env=env).splitlines()\n if symbol in syms:\n return True\n print('{} missing symbol {}; rebuilding'.format(sofile, symbol))\n return False\n\n def get_recipe_env(self, arch=None):\n env = super(OpenSSLRecipe, self).get_recipe_env(arch)\n env['CFLAGS'] += ' ' + env['LDFLAGS']\n env['CC'] += ' ' + env['LDFLAGS']\n return env\n\n def select_build_arch(self, arch):\n aname = arch.arch\n if 'arm64' in aname:\n return 'linux-aarch64'\n if 'v7a' in aname:\n return 'android-armv7'\n if 'arm' in aname:\n return 'android'\n return 'linux-armv4'\n\n def build_arch(self, arch):\n env = self.get_recipe_env(arch)\n with current_directory(self.get_build_dir(arch.arch)):\n # sh fails with code 255 trying to execute ./Configure\n # so instead we manually run perl passing in Configure\n perl = sh.Command('perl')\n buildarch = self.select_build_arch(arch)\n shprint(perl, 'Configure', 'shared', 'no-dso', 'no-krb5', buildarch, _env=env)\n self.apply_patch('disable-sover.patch', arch.arch)\n\n check_crypto = partial(self.check_symbol, env, 'libcrypto.so')\n # check_ssl = partial(self.check_symbol, env, 'libssl.so')\n while True:\n shprint(sh.make, 'build_libs', _env=env)\n if all(map(check_crypto, ('SSLeay', 'MD5_Transform', 'MD4_Init'))):\n break\n shprint(sh.make, 'clean', _env=env)\n\n self.install_libs(arch, 'libssl.so', 'libcrypto.so')\n\nrecipe = OpenSSLRecipe()\n", "path": "pythonforandroid/recipes/openssl/__init__.py"}]} |
gh_patches_debug_277 | rasdani/github-patches | git_diff | chainer__chainer-5463 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
CaffeFunction ignores pad_w from Convolution
# Problem description
Trying to import inception from [Caffe model](https://github.com/soeaver/caffe-model/tree/master/cls) fails.
1. download and unzip files from https://drive.google.com/open?id=0B9mkjlmP0d7zTEJmNEh6c0RfYzg
2. Run following python script (should fail)
test_inception_v3.py:
```python
import chainer
from chainer.links.caffe import CaffeFunction
import numpy as np
func = CaffeFunction('inception-v3/inception-v3.caffemodel')
# Image size as specified in inception-v3/deploy_inception-v3.prototxt
x_data = np.random.uniform(size=(1, 3, 299, 299)).astype(np.float32)
x = chainer.Variable(x_data)
y, = func(inputs={'data': x}, outputs=['prob'])
print(y)
```
This will raise following error.
```
/home/koreyou/.pyenv/versions/chainer-inception-v3/lib/python3.6/site-packages/chainer/links/caffe/caffe_function.py:166: UserWarning: Skip the layer "input", since CaffeFunction does notsupport Input layer
'support %s layer' % (layer.name, layer.type))
Traceback (most recent call last):
File "test_inception_v3.py", line 14, in <module>
y, = func(inputs={'data': x}, outputs=['prob'])
...
File "/home/koreyou/.pyenv/versions/chainer-inception-v3/lib/python3.6/site-packages/chainer/functions/array/concat.py", line 41, in check_type_forward
type_check.expect(in_types[0].shape[d] == in_types[i].shape[d])
File "/home/koreyou/.pyenv/versions/chainer-inception-v3/lib/python3.6/site-packages/chainer/utils/type_check.py", line 546, in expect
expr.expect()
File "/home/koreyou/.pyenv/versions/chainer-inception-v3/lib/python3.6/site-packages/chainer/utils/type_check.py", line 483, in expect
'{0} {1} {2}'.format(left, self.inv, right))
chainer.utils.type_check.InvalidType:
Invalid operation is performed in: Concat (Forward)
Expect: in_types[0].shape[3] == in_types[1].shape[3]
Actual: 17 != 11
```
## Environment
```
Platform: Linux-4.4.0-135-generic-x86_64-with-debian-stretch-sid
Chainer: 5.0.0rc1
NumPy: 1.15.2
CuPy: Not Available
```
# Reason for failure
By running debugger, I figured out that problem was that `pad_w` in caffe model was ignored (it was 7x1 convolution on 17x17 features -> wrong padding resulted in the size of 11). I also noticed that [only pad_h was being checked to apply padding](https://github.com/chainer/chainer/blob/v4.5.0/chainer/links/caffe/caffe_function.py#L524-L525). Thus, applying check for `pad_w` will fix the problem.
```diff
def _get_pad(param):
- if param.pad_h > 0:
+ if param.pad_h > 0 or param.pad_w > 0:
return param.pad_h, param.pad_w
elif type(param.pad) == int:
return param.pad
```
## Checking
```bash
pip uninstall chainer
pip install git+https://github.com/koreyou/chainer.git@fix-caffe-pad_w
# should run without a problem
python test_inception_v3.py
```
I will send merge request for this problem. Please check and see if it can be merged.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `chainer/links/caffe/caffe_function.py`
Content:
```
1 import warnings
2
3 import numpy
4 import six
5
6 from chainer import configuration
7 from chainer import functions
8 from chainer import initializer
9 from chainer import link
10 from chainer.links.caffe.protobuf3 import caffe_pb2 as caffe_pb
11 from chainer.links.connection import convolution_2d
12 from chainer.links.connection import deconvolution_2d
13 from chainer.links.connection import linear
14 from chainer.links.connection import scale
15 from chainer.links.normalization import batch_normalization
16 from chainer.utils import argument
17 from chainer.utils import collections_abc
18
19
20 try:
21 # This method is undocumented, but is required to read large size of
22 # model files when a user uses cpp-implementation.
23 from google.protobuf.pyext import _message
24 _message.SetAllowOversizeProtos(True)
25 except ImportError:
26 pass
27
28 _type_to_method = {}
29 _oldname_to_method = {}
30
31
32 def _layer(typ, oldname):
33 def decorator(meth):
34 global _type_to_method
35 _type_to_method[typ] = meth
36 if oldname is not None:
37 typevalue = getattr(caffe_pb.V1LayerParameter, oldname)
38 _oldname_to_method[typevalue] = meth
39 return meth
40 return decorator
41
42
43 class _Blob(initializer.Initializer):
44
45 chunk_size = 1024 * 1024
46
47 def __init__(self, blob):
48 super(_Blob, self).__init__()
49 self.data = blob.data
50
51 def __call__(self, array):
52 array = array.ravel()
53 size = len(array)
54 indices = list(range(0, size, self.chunk_size))
55
56 # Rather than accessing Protobuf's RepeatedScalar fields directly,
57 # creating a intermediate list by indexing is more efficifent due to
58 # the implementation of the Python extension of Protobuf.
59 # To avoid allocating excessively large lists, we limit the length
60 # of lists by `chunk_size`.
61 for start, end in zip(indices, indices[1:] + [size]):
62 array[start:end] = self.data[start:end]
63
64
65 class _ConvolutionBlob(_Blob):
66
67 def __init__(self, blob, group):
68 super(_ConvolutionBlob, self).__init__(blob)
69 self.group = group
70
71 def __call__(self, array):
72 n_out, n_in = array.shape[:2]
73
74 part_out = n_out // self.group
75 part_in = n_in // self.group
76
77 array[...] = 0
78
79 part_size = len(self.data) // self.group
80 for i in six.moves.range(self.group):
81 out_slice = slice(i * part_out, (i + 1) * part_out)
82 in_slice = slice(i * part_in, (i + 1) * part_in)
83 w = array[out_slice, in_slice]
84
85 data = numpy.array(self.data[i * part_size:(i + 1) * part_size])
86 w[:] = data.reshape(w.shape)
87
88
89 class CaffeFunction(link.Chain):
90
91 """Caffe emulator based on the model file of Caffe.
92
93 Given a protocol buffers file of a Caffe model, this class loads and
94 emulates it on :class:`~chainer.Variable` objects. It supports the official
95 reference models provided by BVLC.
96
97 .. note::
98
99 CaffeFunction ignores the following layers:
100
101 - Layers that CaffeFunction does not support (including data layers)
102 - Layers that have no top blobs
103 - Layers whose bottom blobs are incomplete (i.e., some or all of them
104 are not given nor computed)
105
106 .. warning::
107
108 It does not support full compatibility against Caffe. Some layers and
109 configurations are not implemented in Chainer yet, though the reference
110 models provided by the BVLC team are supported except data layers.
111
112 .. admonition:: Example
113
114 Consider we want to extract the (unnormalized) log class probability
115 of given images using BVLC reference CaffeNet. The model can be
116 downloaded from:
117
118 http://dl.caffe.berkeleyvision.org/bvlc_reference_caffenet.caffemodel
119
120 We want to compute the ``fc8`` blob from the ``data`` blob. It is simply
121 written as follows::
122
123 # Load the model
124 func = CaffeFunction('path/to/bvlc_reference_caffenet.caffemodel')
125
126 # Minibatch of size 10
127 x_data = numpy.ndarray((10, 3, 227, 227), dtype=numpy.float32)
128 ... # (Fill the minibatch here)
129
130 # Forward the pre-trained net
131 x = Variable(x_data)
132 y, = func(inputs={'data': x}, outputs=['fc8'])
133
134 The result ``y`` contains the Variable corresponding to the ``fc8``
135 blob. The computational graph is memorized as a usual forward
136 computation in Chainer, so we can run backprop through this pre-trained
137 net.
138
139 Args:
140 model_path (str): Path to the binary-proto model file of Caffe.
141
142 Attributes:
143 forwards (dict): A mapping from layer names to corresponding functions.
144
145 """
146
147 def __init__(self, model_path):
148 super(CaffeFunction, self).__init__()
149
150 net = caffe_pb.NetParameter()
151 with open(model_path, 'rb') as model_file:
152 net.MergeFromString(model_file.read())
153
154 self.forwards = {}
155 self.split_map = {}
156 self.layers = []
157
158 if net.layer:
159 for layer in net.layer:
160 meth = _type_to_method.get(layer.type)
161 if meth:
162 meth(self, layer)
163 else:
164 warnings.warn(
165 'Skip the layer "%s", since CaffeFunction does not'
166 'support %s layer' % (layer.name, layer.type))
167 else: # v1 format
168 for layer in net.layers:
169 meth = _oldname_to_method.get(layer.type)
170 if meth:
171 meth(self, layer)
172 else:
173 warnings.warn(
174 'Skip the layer "%s", since CaffeFunction does not'
175 'support it' % layer.name)
176
177 def forward(self, inputs, outputs, disable=(), **kwargs):
178 """forward(self, inputs, outputs, disable=())
179
180 Executes a sub-network of the network.
181
182 This function acts as an interpreter of the network definition for
183 Caffe. On execution, it interprets each layer one by one, and if the
184 bottom blobs are already computed, then emulates the layer and stores
185 output blobs as :class:`~chainer.Variable` objects.
186
187 .. warning::
188
189 ``train`` argument is not supported anymore since v2.
190 Instead, use ``chainer.using_config('train', train)``.
191 See :func:`chainer.using_config`.
192
193 Args:
194 inputs (dict): A dictionary whose key-value pairs indicate initial
195 correspondences between blob names and
196 :class:`~chainer.Variable` objects.
197 outputs (Iterable): A list of blob names whose corresponding
198 :class:`~chainer.Variable` objects are returned.
199 disable (Iterable): A list of layer names that will be ignored
200 during the forward computation.
201
202 Returns:
203 tuple: A tuple of output :class:`~chainer.Variable` objects
204 corresponding to elements of the `outputs` argument.
205
206 """
207 if kwargs:
208 argument.check_unexpected_kwargs(
209 kwargs, train='train argument is not supported anymore. '
210 'Use chainer.using_config')
211 argument.assert_kwargs_empty(kwargs)
212
213 variables = dict(inputs)
214 disable = set(disable)
215 for func_name, bottom, top in self.layers:
216 if (func_name in disable or
217 func_name not in self.forwards or
218 any(blob not in variables for blob in bottom)):
219 continue
220
221 func = self.forwards[func_name]
222 input_vars = tuple(variables[blob] for blob in bottom)
223 output_vars = func(*input_vars)
224 if not isinstance(output_vars, collections_abc.Iterable):
225 output_vars = output_vars,
226 for var, name in zip(output_vars, top):
227 variables[name] = var
228
229 self.variables = variables
230 return tuple(variables[blob] for blob in outputs)
231
232 def _add_layer(self, layer):
233 bottom = []
234 for blob_name in layer.bottom:
235 bottom.append(self.split_map.get(blob_name, blob_name))
236 self.layers.append((layer.name, bottom, list(layer.top)))
237
238 @_layer('Concat', 'CONCAT')
239 def _setup_concat(self, layer):
240 param = layer.concat_param
241 axis = param.axis
242 if axis == 1 and param.concat_dim != 1:
243 axis = param.concat_dim
244
245 self.forwards[layer.name] = _ListArgumentFcuntion(
246 functions.concat, axis=axis)
247 self._add_layer(layer)
248
249 @_layer('Convolution', 'CONVOLUTION')
250 def _setup_convolution(self, layer):
251 blobs = layer.blobs
252 param = layer.convolution_param
253 ksize = _get_ksize(param)
254 stride = _get_stride(param)
255 pad = _get_pad(param)
256 num = _get_num(blobs[0])
257 channels = _get_channels(blobs[0])
258 bias_term = param.bias_term
259
260 n_in = channels * param.group
261 n_out = num
262
263 func = convolution_2d.Convolution2D(
264 n_in, n_out, ksize, stride, pad, nobias=not bias_term,
265 initialW=_ConvolutionBlob(blobs[0], param.group),
266 initial_bias=_Blob(blobs[1]) if bias_term else None)
267
268 with self.init_scope():
269 setattr(self, layer.name, func)
270 self.forwards[layer.name] = _CallChildLink(self, layer.name)
271 self._add_layer(layer)
272
273 @_layer('Deconvolution', 'DECONVOLUTION')
274 def _setup_deconvolution(self, layer):
275 blobs = layer.blobs
276 param = layer.convolution_param
277 ksize = _get_ksize(param)
278 stride = _get_stride(param)
279 pad = _get_pad(param)
280 num = _get_num(blobs[0])
281 channels = _get_channels(blobs[0])
282 bias_term = param.bias_term
283
284 n_in = num
285 n_out = channels * param.group
286
287 func = deconvolution_2d.Deconvolution2D(
288 n_in, n_out, ksize, stride, pad, nobias=not bias_term,
289 initialW=_ConvolutionBlob(blobs[0], param.group),
290 initial_bias=_Blob(blobs[1]) if bias_term else None)
291
292 with self.init_scope():
293 setattr(self, layer.name, func)
294 self.forwards[layer.name] = _CallChildLink(self, layer.name)
295 self._add_layer(layer)
296
297 @_layer('Data', 'DATA')
298 def _setup_data(self, layer):
299 # We silently skip the data layer.
300 pass
301
302 @_layer('Dropout', 'DROPOUT')
303 def _setup_dropout(self, layer):
304 param = layer.dropout_param
305
306 self.forwards[layer.name] = _SingleArgumentFunction(
307 functions.dropout, ratio=param.dropout_ratio)
308 self._add_layer(layer)
309
310 @_layer('InnerProduct', 'INNER_PRODUCT')
311 def _setup_inner_product(self, layer):
312 param = layer.inner_product_param
313 bias_term = param.bias_term
314 if param.axis != 1:
315 raise RuntimeError(
316 'Non-default axis in InnerProduct is not supported')
317
318 blobs = layer.blobs
319 width, height = _get_width(blobs[0]), _get_height(blobs[0])
320
321 func = linear.Linear(
322 width, height, nobias=not bias_term,
323 initialW=_Blob(blobs[0]),
324 initial_bias=_Blob(blobs[1]) if bias_term else None)
325
326 with self.init_scope():
327 setattr(self, layer.name, func)
328 self.forwards[layer.name] = _CallChildLink(self, layer.name)
329 self._add_layer(layer)
330
331 @_layer('LRN', 'LRN')
332 def _setup_lrn(self, layer):
333 param = layer.lrn_param
334 if param.norm_region != param.ACROSS_CHANNELS:
335 raise RuntimeError('Within-channel LRN is not supported')
336
337 fwd = _SingleArgumentFunction(
338 functions.local_response_normalization,
339 n=param.local_size, k=param.k,
340 alpha=param.alpha / param.local_size, beta=param.beta)
341 self.forwards[layer.name] = fwd
342 self._add_layer(layer)
343
344 @_layer('Pooling', 'POOLING')
345 def _setup_pooling(self, layer):
346 param = layer.pooling_param
347 ksize = _get_ksize(param)
348 stride = _get_stride(param)
349 pad = _get_pad(param)
350
351 if param.pool == param.MAX:
352 func = functions.max_pooling_2d
353 elif param.pool == param.AVE:
354 func = functions.average_pooling_2d
355 else:
356 raise RuntimeError('Stochastic pooling is not supported')
357
358 if param.global_pooling and not ksize:
359 # if global_pooling is set but no kernel size, the kernel size
360 # is computed dynamically to cover the whole input feature map
361 def _func(x, stride, pad):
362 return func(x, x.shape[2:], stride=stride, pad=pad)
363 fw = _SingleArgumentFunction(_func, stride=stride, pad=pad)
364 else:
365 fw = _SingleArgumentFunction(func, ksize, stride=stride, pad=pad)
366 self.forwards[layer.name] = fw
367 self._add_layer(layer)
368
369 @_layer('ReLU', 'RELU')
370 def _setup_relu(self, layer):
371 slope = layer.relu_param.negative_slope
372
373 if slope != 0:
374 fw = _SingleArgumentFunction(functions.leaky_relu, slope=slope)
375 else:
376 fw = functions.relu
377
378 self.forwards[layer.name] = fw
379 self._add_layer(layer)
380
381 @_layer('Reshape', None)
382 def _setup_reshape(self, layer):
383 shape = layer.reshape_param.shape.dim
384
385 fw = _SingleArgumentFunction(functions.reshape, shape=shape)
386
387 self.forwards[layer.name] = fw
388 self._add_layer(layer)
389
390 @_layer('BatchNorm', None)
391 def _setup_batchnorm(self, layer):
392 # Get layer parameters.
393 blobs = layer.blobs
394 param = layer.batch_norm_param
395 use_global_stats = param.use_global_stats
396 decay = param.moving_average_fraction
397 eps = param.eps
398 size = int(blobs[0].shape.dim[0]) # Get channel dim from mean blob.
399
400 # Make BatchNormalization link.
401 func = batch_normalization.BatchNormalization(
402 size, decay=decay, eps=eps, use_gamma=False, use_beta=False)
403
404 _Blob(blobs[0])(func.avg_mean)
405 _Blob(blobs[1])(func.avg_var)
406
407 # Scale the means and variances if a scaling factor is appended to the
408 # blobs to correctly mimic to the behavior of Caffe. See
409 # https://github.com/BVLC/caffe/issues/4885
410 if len(blobs) >= 3:
411 scaling_factor = blobs[2].data
412 func.avg_mean /= scaling_factor[0]
413 func.avg_var /= scaling_factor[0]
414
415 with self.init_scope():
416 setattr(self, layer.name, func)
417
418 # Add layer.
419 if use_global_stats:
420 func_class = _SingleArgumentFunctionTestMode
421 else:
422 func_class = _SingleArgumentFunction
423 fwd = func_class(_CallChildLink(self, layer.name), finetune=False)
424 self.forwards[layer.name] = fwd
425 self._add_layer(layer)
426
427 @_layer('Eltwise', 'ELTWISE')
428 def _setup_eltwise(self, layer):
429 # stable_prod_grad parameter is not supported now.
430 operation = layer.eltwise_param.operation
431 coeffs = layer.eltwise_param.coeff or None
432 self.forwards[layer.name] = _EltwiseFunction(operation, coeffs)
433 self._add_layer(layer)
434
435 @_layer('Scale', None)
436 def _setup_scale(self, layer):
437 # Following parameters are not supported now:
438 # - negative axis
439 # - num_axes
440 # - filler
441 # - bias_filler
442
443 # Get layer parameters.
444 bottom = layer.bottom
445 blobs = layer.blobs
446 axis = layer.scale_param.axis
447 bias_term = layer.scale_param.bias_term
448
449 # Case of only one bottom where W is learnt parameter.
450 if len(bottom) == 1:
451 W_shape = blobs[0].shape.dim
452 func = scale.Scale(axis, W_shape, bias_term)
453 _Blob(blobs[0])(func.W.data)
454 if bias_term:
455 _Blob(blobs[1])(func.bias.b.data)
456 # Case of two bottoms where W is given as a bottom.
457 else:
458 shape = blobs[0].shape.dim if bias_term else None
459 func = scale.Scale(
460 axis, bias_term=bias_term, bias_shape=shape)
461 if bias_term:
462 _Blob(blobs[0])(func.bias.b.data)
463
464 # Add layer.
465 with self.init_scope():
466 setattr(self, layer.name, func)
467 self.forwards[layer.name] = _CallChildLink(self, layer.name)
468 self._add_layer(layer)
469
470 @_layer('Slice', 'SLICE')
471 def _setup_slice(self, layer):
472 if layer.slice_param.HasField('axis'):
473 axis = layer.slice_param.axis
474 elif layer.slice_param.HasField('slice_dim'):
475 axis = layer.slice_param.slice_dim
476 else:
477 axis = 1
478
479 if layer.slice_param.slice_point:
480 indices_or_sections = list(layer.slice_param.slice_point)
481 else:
482 indices_or_sections = len(list(layer.top))
483
484 self.forwards[layer.name] = _SingleArgumentFunction(
485 functions.split_axis,
486 indices_or_sections=indices_or_sections,
487 axis=axis
488 )
489
490 self._add_layer(layer)
491
492 @_layer('Softmax', 'SOFTMAX')
493 def _setup_softmax(self, layer):
494 if layer.softmax_param.axis != 1:
495 raise RuntimeError(
496 'Softmax along non-channel axis is not supported')
497
498 if layer.softmax_param.engine == 0: # DEFAULT
499 fw = functions.softmax
500 elif layer.softmax_param.engine == 1: # CAFFE
501 fw = _SingleArgumentFunctionWithCudnn(False, functions.softmax)
502 elif layer.softmax_param.engine == 2: # CUDNN
503 fw = _SingleArgumentFunctionWithCudnn(True, functions.softmax)
504
505 self.forwards[layer.name] = fw
506 self._add_layer(layer)
507
508 @_layer('SoftmaxWithLoss', 'SOFTMAX_LOSS')
509 def _setup_softmax_with_loss(self, layer):
510 if layer.softmax_param.axis != 1:
511 raise RuntimeError(
512 'Softmax along non-channel axis is not supported')
513
514 self.forwards[layer.name] = functions.softmax_cross_entropy
515 self._add_layer(layer)
516
517 @_layer('Split', 'SPLIT')
518 def _setup_split(self, layer):
519 for top in layer.top:
520 self.split_map[top] = layer.bottom[0]
521
522
523 # Internal functions
524
525 def _get_ksize(param):
526 if param.kernel_h > 0:
527 return param.kernel_h, param.kernel_w
528 elif type(param.kernel_size) == int:
529 return param.kernel_size
530 elif len(param.kernel_size) == 1:
531 return param.kernel_size[0]
532 else:
533 return param.kernel_size
534
535
536 def _get_stride(param):
537 if param.stride_h > 0:
538 return param.stride_h, param.stride_w
539 elif type(param.stride) == int:
540 return param.stride
541 elif len(param.stride) == 0:
542 return 1
543 elif len(param.stride) == 1:
544 return param.stride[0]
545 else:
546 return param.stride
547
548
549 def _get_pad(param):
550 if param.pad_h > 0:
551 return param.pad_h, param.pad_w
552 elif type(param.pad) == int:
553 return param.pad
554 elif len(param.pad) == 0:
555 return 0
556 elif len(param.pad) == 1:
557 return param.pad[0]
558 else:
559 return param.pad
560
561
562 def _get_num(blob):
563 if blob.num > 0:
564 return blob.num
565 else:
566 return blob.shape.dim[0]
567
568
569 def _get_channels(blob):
570 if blob.channels > 0:
571 return blob.channels
572 else:
573 return blob.shape.dim[1]
574
575
576 def _get_height(blob):
577 if blob.height > 0:
578 return blob.height
579 elif len(blob.shape.dim) == 2:
580 return blob.shape.dim[0]
581 elif len(blob.shape.dim) == 4:
582 return blob.shape.dim[2]
583 else:
584 raise RuntimeError(
585 '{}-dimentional array is not supported'.format(
586 len(blob.shape.dim)))
587
588
589 def _get_width(blob):
590 if blob.width > 0:
591 return blob.width
592 elif len(blob.shape.dim) == 2:
593 return blob.shape.dim[1]
594 elif len(blob.shape.dim) == 4:
595 return blob.shape.dim[3]
596 else:
597 raise RuntimeError(
598 '{}-dimentional array is not supported'.format(
599 len(blob.shape.dim)))
600
601
602 # Internal class
603
604 class _SingleArgumentFunction(object):
605
606 def __init__(self, func, *args, **kwargs):
607 self.func = func
608 self.args = args
609 self.kwargs = kwargs
610
611 def __call__(self, x):
612 return self.func(x, *self.args, **self.kwargs)
613
614
615 class _SingleArgumentFunctionTestMode(_SingleArgumentFunction):
616
617 def __call__(self, x):
618 with configuration.using_config('train', False):
619 return super(_SingleArgumentFunctionTestMode, self).__call__(x)
620
621
622 class _ListArgumentFcuntion(object):
623
624 def __init__(self, func, **kwargs):
625 self.func = func
626 self.kwargs = kwargs
627
628 def __call__(self, *xs):
629 return self.func(xs, **self.kwargs)
630
631
632 class _SingleArgumentFunctionWithCudnn(_SingleArgumentFunction):
633
634 def __init__(self, use_cudnn, func, *args, **kwargs):
635 super(_SingleArgumentFunctionWithCudnn, self).__init__(
636 func, *args, **kwargs)
637 self.use_cudnn = use_cudnn
638
639 def __call__(self, x):
640 with configuration.using_config('use_cudnn', self.use_cudnn):
641 return super(_SingleArgumentFunctionWithCudnn, self).__call__(x)
642
643
644 class _CallChildLink(object):
645
646 def __init__(self, caffe_func, name):
647 self.name = name
648 self.caffe_func = caffe_func
649
650 def __call__(self, *xs, **kwargs):
651 return self.caffe_func[self.name](*xs, **kwargs)
652
653
654 class _EltwiseFunction(object):
655
656 def __init__(self, operation, coeffs=None):
657 if coeffs is not None:
658 assert len(coeffs) > 0
659 self.operation = operation
660 self.coeffs = coeffs
661
662 def __call__(self, *xs):
663 operation = self.operation
664
665 if operation == 0: # PROD
666 return six.moves.reduce(lambda x, y: x * y, xs),
667
668 elif operation == 1: # SUM
669 coeffs = self.coeffs
670 if coeffs is not None:
671 assert len(xs) == len(coeffs)
672 xs = [x * coeff for x, coeff in zip(xs, coeffs)]
673 return six.moves.reduce(lambda x, y: x + y, xs),
674
675 elif operation == 2: # MAX
676 return six.moves.reduce(lambda x, y: functions.maximum(x, y), xs),
677
678 else:
679 raise ValueError('Invalid EltwiseParameter.EltwiseOp value.')
680
```
--- 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/chainer/links/caffe/caffe_function.py b/chainer/links/caffe/caffe_function.py
--- a/chainer/links/caffe/caffe_function.py
+++ b/chainer/links/caffe/caffe_function.py
@@ -547,7 +547,7 @@
def _get_pad(param):
- if param.pad_h > 0:
+ if param.pad_h > 0 or param.pad_w > 0:
return param.pad_h, param.pad_w
elif type(param.pad) == int:
return param.pad
| {"golden_diff": "diff --git a/chainer/links/caffe/caffe_function.py b/chainer/links/caffe/caffe_function.py\n--- a/chainer/links/caffe/caffe_function.py\n+++ b/chainer/links/caffe/caffe_function.py\n@@ -547,7 +547,7 @@\n \n \n def _get_pad(param):\n- if param.pad_h > 0:\n+ if param.pad_h > 0 or param.pad_w > 0:\n return param.pad_h, param.pad_w\n elif type(param.pad) == int:\n return param.pad\n", "issue": "CaffeFunction ignores pad_w from Convolution\n# Problem description\r\n\r\nTrying to import inception from [Caffe model](https://github.com/soeaver/caffe-model/tree/master/cls) fails.\r\n\r\n1. download and unzip files from https://drive.google.com/open?id=0B9mkjlmP0d7zTEJmNEh6c0RfYzg\r\n2. Run following python script (should fail)\r\n\r\ntest_inception_v3.py:\r\n```python\r\nimport chainer\r\nfrom chainer.links.caffe import CaffeFunction\r\nimport numpy as np\r\n\r\nfunc = CaffeFunction('inception-v3/inception-v3.caffemodel')\r\n\r\n# Image size as specified in inception-v3/deploy_inception-v3.prototxt\r\nx_data = np.random.uniform(size=(1, 3, 299, 299)).astype(np.float32)\r\n\r\nx = chainer.Variable(x_data)\r\ny, = func(inputs={'data': x}, outputs=['prob'])\r\nprint(y)\r\n```\r\n\r\nThis will raise following error.\r\n\r\n\r\n```\r\n/home/koreyou/.pyenv/versions/chainer-inception-v3/lib/python3.6/site-packages/chainer/links/caffe/caffe_function.py:166: UserWarning: Skip the layer \"input\", since CaffeFunction does notsupport Input layer\r\n 'support %s layer' % (layer.name, layer.type))\r\nTraceback (most recent call last):\r\n File \"test_inception_v3.py\", line 14, in <module>\r\n y, = func(inputs={'data': x}, outputs=['prob'])\r\n...\r\n File \"/home/koreyou/.pyenv/versions/chainer-inception-v3/lib/python3.6/site-packages/chainer/functions/array/concat.py\", line 41, in check_type_forward\r\n type_check.expect(in_types[0].shape[d] == in_types[i].shape[d])\r\n File \"/home/koreyou/.pyenv/versions/chainer-inception-v3/lib/python3.6/site-packages/chainer/utils/type_check.py\", line 546, in expect\r\n expr.expect()\r\n File \"/home/koreyou/.pyenv/versions/chainer-inception-v3/lib/python3.6/site-packages/chainer/utils/type_check.py\", line 483, in expect\r\n '{0} {1} {2}'.format(left, self.inv, right))\r\nchainer.utils.type_check.InvalidType:\r\nInvalid operation is performed in: Concat (Forward)\r\n\r\nExpect: in_types[0].shape[3] == in_types[1].shape[3]\r\nActual: 17 != 11\r\n```\r\n\r\n## Environment\r\n\r\n```\r\nPlatform: Linux-4.4.0-135-generic-x86_64-with-debian-stretch-sid\r\nChainer: 5.0.0rc1\r\nNumPy: 1.15.2\r\nCuPy: Not Available\r\n```\r\n\r\n# Reason for failure\r\n\r\nBy running debugger, I figured out that problem was that `pad_w` in caffe model was ignored (it was 7x1 convolution on 17x17 features -> wrong padding resulted in the size of 11). I also noticed that [only pad_h was being checked to apply padding](https://github.com/chainer/chainer/blob/v4.5.0/chainer/links/caffe/caffe_function.py#L524-L525). Thus, applying check for `pad_w` will fix the problem.\r\n\r\n```diff\r\n def _get_pad(param):\r\n- if param.pad_h > 0:\r\n+ if param.pad_h > 0 or param.pad_w > 0:\r\n return param.pad_h, param.pad_w\r\n elif type(param.pad) == int:\r\n return param.pad \r\n```\r\n\r\n## Checking\r\n\r\n```bash\r\npip uninstall chainer\r\npip install git+https://github.com/koreyou/chainer.git@fix-caffe-pad_w\r\n# should run without a problem\r\npython test_inception_v3.py\r\n```\r\n\r\nI will send merge request for this problem. Please check and see if it can be merged.\r\n\n", "before_files": [{"content": "import warnings\n\nimport numpy\nimport six\n\nfrom chainer import configuration\nfrom chainer import functions\nfrom chainer import initializer\nfrom chainer import link\nfrom chainer.links.caffe.protobuf3 import caffe_pb2 as caffe_pb\nfrom chainer.links.connection import convolution_2d\nfrom chainer.links.connection import deconvolution_2d\nfrom chainer.links.connection import linear\nfrom chainer.links.connection import scale\nfrom chainer.links.normalization import batch_normalization\nfrom chainer.utils import argument\nfrom chainer.utils import collections_abc\n\n\ntry:\n # This method is undocumented, but is required to read large size of\n # model files when a user uses cpp-implementation.\n from google.protobuf.pyext import _message\n _message.SetAllowOversizeProtos(True)\nexcept ImportError:\n pass\n\n_type_to_method = {}\n_oldname_to_method = {}\n\n\ndef _layer(typ, oldname):\n def decorator(meth):\n global _type_to_method\n _type_to_method[typ] = meth\n if oldname is not None:\n typevalue = getattr(caffe_pb.V1LayerParameter, oldname)\n _oldname_to_method[typevalue] = meth\n return meth\n return decorator\n\n\nclass _Blob(initializer.Initializer):\n\n chunk_size = 1024 * 1024\n\n def __init__(self, blob):\n super(_Blob, self).__init__()\n self.data = blob.data\n\n def __call__(self, array):\n array = array.ravel()\n size = len(array)\n indices = list(range(0, size, self.chunk_size))\n\n # Rather than accessing Protobuf's RepeatedScalar fields directly,\n # creating a intermediate list by indexing is more efficifent due to\n # the implementation of the Python extension of Protobuf.\n # To avoid allocating excessively large lists, we limit the length\n # of lists by `chunk_size`.\n for start, end in zip(indices, indices[1:] + [size]):\n array[start:end] = self.data[start:end]\n\n\nclass _ConvolutionBlob(_Blob):\n\n def __init__(self, blob, group):\n super(_ConvolutionBlob, self).__init__(blob)\n self.group = group\n\n def __call__(self, array):\n n_out, n_in = array.shape[:2]\n\n part_out = n_out // self.group\n part_in = n_in // self.group\n\n array[...] = 0\n\n part_size = len(self.data) // self.group\n for i in six.moves.range(self.group):\n out_slice = slice(i * part_out, (i + 1) * part_out)\n in_slice = slice(i * part_in, (i + 1) * part_in)\n w = array[out_slice, in_slice]\n\n data = numpy.array(self.data[i * part_size:(i + 1) * part_size])\n w[:] = data.reshape(w.shape)\n\n\nclass CaffeFunction(link.Chain):\n\n \"\"\"Caffe emulator based on the model file of Caffe.\n\n Given a protocol buffers file of a Caffe model, this class loads and\n emulates it on :class:`~chainer.Variable` objects. It supports the official\n reference models provided by BVLC.\n\n .. note::\n\n CaffeFunction ignores the following layers:\n\n - Layers that CaffeFunction does not support (including data layers)\n - Layers that have no top blobs\n - Layers whose bottom blobs are incomplete (i.e., some or all of them\n are not given nor computed)\n\n .. warning::\n\n It does not support full compatibility against Caffe. Some layers and\n configurations are not implemented in Chainer yet, though the reference\n models provided by the BVLC team are supported except data layers.\n\n .. admonition:: Example\n\n Consider we want to extract the (unnormalized) log class probability\n of given images using BVLC reference CaffeNet. The model can be\n downloaded from:\n\n http://dl.caffe.berkeleyvision.org/bvlc_reference_caffenet.caffemodel\n\n We want to compute the ``fc8`` blob from the ``data`` blob. It is simply\n written as follows::\n\n # Load the model\n func = CaffeFunction('path/to/bvlc_reference_caffenet.caffemodel')\n\n # Minibatch of size 10\n x_data = numpy.ndarray((10, 3, 227, 227), dtype=numpy.float32)\n ... # (Fill the minibatch here)\n\n # Forward the pre-trained net\n x = Variable(x_data)\n y, = func(inputs={'data': x}, outputs=['fc8'])\n\n The result ``y`` contains the Variable corresponding to the ``fc8``\n blob. The computational graph is memorized as a usual forward\n computation in Chainer, so we can run backprop through this pre-trained\n net.\n\n Args:\n model_path (str): Path to the binary-proto model file of Caffe.\n\n Attributes:\n forwards (dict): A mapping from layer names to corresponding functions.\n\n \"\"\"\n\n def __init__(self, model_path):\n super(CaffeFunction, self).__init__()\n\n net = caffe_pb.NetParameter()\n with open(model_path, 'rb') as model_file:\n net.MergeFromString(model_file.read())\n\n self.forwards = {}\n self.split_map = {}\n self.layers = []\n\n if net.layer:\n for layer in net.layer:\n meth = _type_to_method.get(layer.type)\n if meth:\n meth(self, layer)\n else:\n warnings.warn(\n 'Skip the layer \"%s\", since CaffeFunction does not'\n 'support %s layer' % (layer.name, layer.type))\n else: # v1 format\n for layer in net.layers:\n meth = _oldname_to_method.get(layer.type)\n if meth:\n meth(self, layer)\n else:\n warnings.warn(\n 'Skip the layer \"%s\", since CaffeFunction does not'\n 'support it' % layer.name)\n\n def forward(self, inputs, outputs, disable=(), **kwargs):\n \"\"\"forward(self, inputs, outputs, disable=())\n\n Executes a sub-network of the network.\n\n This function acts as an interpreter of the network definition for\n Caffe. On execution, it interprets each layer one by one, and if the\n bottom blobs are already computed, then emulates the layer and stores\n output blobs as :class:`~chainer.Variable` objects.\n\n .. warning::\n\n ``train`` argument is not supported anymore since v2.\n Instead, use ``chainer.using_config('train', train)``.\n See :func:`chainer.using_config`.\n\n Args:\n inputs (dict): A dictionary whose key-value pairs indicate initial\n correspondences between blob names and\n :class:`~chainer.Variable` objects.\n outputs (Iterable): A list of blob names whose corresponding\n :class:`~chainer.Variable` objects are returned.\n disable (Iterable): A list of layer names that will be ignored\n during the forward computation.\n\n Returns:\n tuple: A tuple of output :class:`~chainer.Variable` objects\n corresponding to elements of the `outputs` argument.\n\n \"\"\"\n if kwargs:\n argument.check_unexpected_kwargs(\n kwargs, train='train argument is not supported anymore. '\n 'Use chainer.using_config')\n argument.assert_kwargs_empty(kwargs)\n\n variables = dict(inputs)\n disable = set(disable)\n for func_name, bottom, top in self.layers:\n if (func_name in disable or\n func_name not in self.forwards or\n any(blob not in variables for blob in bottom)):\n continue\n\n func = self.forwards[func_name]\n input_vars = tuple(variables[blob] for blob in bottom)\n output_vars = func(*input_vars)\n if not isinstance(output_vars, collections_abc.Iterable):\n output_vars = output_vars,\n for var, name in zip(output_vars, top):\n variables[name] = var\n\n self.variables = variables\n return tuple(variables[blob] for blob in outputs)\n\n def _add_layer(self, layer):\n bottom = []\n for blob_name in layer.bottom:\n bottom.append(self.split_map.get(blob_name, blob_name))\n self.layers.append((layer.name, bottom, list(layer.top)))\n\n @_layer('Concat', 'CONCAT')\n def _setup_concat(self, layer):\n param = layer.concat_param\n axis = param.axis\n if axis == 1 and param.concat_dim != 1:\n axis = param.concat_dim\n\n self.forwards[layer.name] = _ListArgumentFcuntion(\n functions.concat, axis=axis)\n self._add_layer(layer)\n\n @_layer('Convolution', 'CONVOLUTION')\n def _setup_convolution(self, layer):\n blobs = layer.blobs\n param = layer.convolution_param\n ksize = _get_ksize(param)\n stride = _get_stride(param)\n pad = _get_pad(param)\n num = _get_num(blobs[0])\n channels = _get_channels(blobs[0])\n bias_term = param.bias_term\n\n n_in = channels * param.group\n n_out = num\n\n func = convolution_2d.Convolution2D(\n n_in, n_out, ksize, stride, pad, nobias=not bias_term,\n initialW=_ConvolutionBlob(blobs[0], param.group),\n initial_bias=_Blob(blobs[1]) if bias_term else None)\n\n with self.init_scope():\n setattr(self, layer.name, func)\n self.forwards[layer.name] = _CallChildLink(self, layer.name)\n self._add_layer(layer)\n\n @_layer('Deconvolution', 'DECONVOLUTION')\n def _setup_deconvolution(self, layer):\n blobs = layer.blobs\n param = layer.convolution_param\n ksize = _get_ksize(param)\n stride = _get_stride(param)\n pad = _get_pad(param)\n num = _get_num(blobs[0])\n channels = _get_channels(blobs[0])\n bias_term = param.bias_term\n\n n_in = num\n n_out = channels * param.group\n\n func = deconvolution_2d.Deconvolution2D(\n n_in, n_out, ksize, stride, pad, nobias=not bias_term,\n initialW=_ConvolutionBlob(blobs[0], param.group),\n initial_bias=_Blob(blobs[1]) if bias_term else None)\n\n with self.init_scope():\n setattr(self, layer.name, func)\n self.forwards[layer.name] = _CallChildLink(self, layer.name)\n self._add_layer(layer)\n\n @_layer('Data', 'DATA')\n def _setup_data(self, layer):\n # We silently skip the data layer.\n pass\n\n @_layer('Dropout', 'DROPOUT')\n def _setup_dropout(self, layer):\n param = layer.dropout_param\n\n self.forwards[layer.name] = _SingleArgumentFunction(\n functions.dropout, ratio=param.dropout_ratio)\n self._add_layer(layer)\n\n @_layer('InnerProduct', 'INNER_PRODUCT')\n def _setup_inner_product(self, layer):\n param = layer.inner_product_param\n bias_term = param.bias_term\n if param.axis != 1:\n raise RuntimeError(\n 'Non-default axis in InnerProduct is not supported')\n\n blobs = layer.blobs\n width, height = _get_width(blobs[0]), _get_height(blobs[0])\n\n func = linear.Linear(\n width, height, nobias=not bias_term,\n initialW=_Blob(blobs[0]),\n initial_bias=_Blob(blobs[1]) if bias_term else None)\n\n with self.init_scope():\n setattr(self, layer.name, func)\n self.forwards[layer.name] = _CallChildLink(self, layer.name)\n self._add_layer(layer)\n\n @_layer('LRN', 'LRN')\n def _setup_lrn(self, layer):\n param = layer.lrn_param\n if param.norm_region != param.ACROSS_CHANNELS:\n raise RuntimeError('Within-channel LRN is not supported')\n\n fwd = _SingleArgumentFunction(\n functions.local_response_normalization,\n n=param.local_size, k=param.k,\n alpha=param.alpha / param.local_size, beta=param.beta)\n self.forwards[layer.name] = fwd\n self._add_layer(layer)\n\n @_layer('Pooling', 'POOLING')\n def _setup_pooling(self, layer):\n param = layer.pooling_param\n ksize = _get_ksize(param)\n stride = _get_stride(param)\n pad = _get_pad(param)\n\n if param.pool == param.MAX:\n func = functions.max_pooling_2d\n elif param.pool == param.AVE:\n func = functions.average_pooling_2d\n else:\n raise RuntimeError('Stochastic pooling is not supported')\n\n if param.global_pooling and not ksize:\n # if global_pooling is set but no kernel size, the kernel size\n # is computed dynamically to cover the whole input feature map\n def _func(x, stride, pad):\n return func(x, x.shape[2:], stride=stride, pad=pad)\n fw = _SingleArgumentFunction(_func, stride=stride, pad=pad)\n else:\n fw = _SingleArgumentFunction(func, ksize, stride=stride, pad=pad)\n self.forwards[layer.name] = fw\n self._add_layer(layer)\n\n @_layer('ReLU', 'RELU')\n def _setup_relu(self, layer):\n slope = layer.relu_param.negative_slope\n\n if slope != 0:\n fw = _SingleArgumentFunction(functions.leaky_relu, slope=slope)\n else:\n fw = functions.relu\n\n self.forwards[layer.name] = fw\n self._add_layer(layer)\n\n @_layer('Reshape', None)\n def _setup_reshape(self, layer):\n shape = layer.reshape_param.shape.dim\n\n fw = _SingleArgumentFunction(functions.reshape, shape=shape)\n\n self.forwards[layer.name] = fw\n self._add_layer(layer)\n\n @_layer('BatchNorm', None)\n def _setup_batchnorm(self, layer):\n # Get layer parameters.\n blobs = layer.blobs\n param = layer.batch_norm_param\n use_global_stats = param.use_global_stats\n decay = param.moving_average_fraction\n eps = param.eps\n size = int(blobs[0].shape.dim[0]) # Get channel dim from mean blob.\n\n # Make BatchNormalization link.\n func = batch_normalization.BatchNormalization(\n size, decay=decay, eps=eps, use_gamma=False, use_beta=False)\n\n _Blob(blobs[0])(func.avg_mean)\n _Blob(blobs[1])(func.avg_var)\n\n # Scale the means and variances if a scaling factor is appended to the\n # blobs to correctly mimic to the behavior of Caffe. See\n # https://github.com/BVLC/caffe/issues/4885\n if len(blobs) >= 3:\n scaling_factor = blobs[2].data\n func.avg_mean /= scaling_factor[0]\n func.avg_var /= scaling_factor[0]\n\n with self.init_scope():\n setattr(self, layer.name, func)\n\n # Add layer.\n if use_global_stats:\n func_class = _SingleArgumentFunctionTestMode\n else:\n func_class = _SingleArgumentFunction\n fwd = func_class(_CallChildLink(self, layer.name), finetune=False)\n self.forwards[layer.name] = fwd\n self._add_layer(layer)\n\n @_layer('Eltwise', 'ELTWISE')\n def _setup_eltwise(self, layer):\n # stable_prod_grad parameter is not supported now.\n operation = layer.eltwise_param.operation\n coeffs = layer.eltwise_param.coeff or None\n self.forwards[layer.name] = _EltwiseFunction(operation, coeffs)\n self._add_layer(layer)\n\n @_layer('Scale', None)\n def _setup_scale(self, layer):\n # Following parameters are not supported now:\n # - negative axis\n # - num_axes\n # - filler\n # - bias_filler\n\n # Get layer parameters.\n bottom = layer.bottom\n blobs = layer.blobs\n axis = layer.scale_param.axis\n bias_term = layer.scale_param.bias_term\n\n # Case of only one bottom where W is learnt parameter.\n if len(bottom) == 1:\n W_shape = blobs[0].shape.dim\n func = scale.Scale(axis, W_shape, bias_term)\n _Blob(blobs[0])(func.W.data)\n if bias_term:\n _Blob(blobs[1])(func.bias.b.data)\n # Case of two bottoms where W is given as a bottom.\n else:\n shape = blobs[0].shape.dim if bias_term else None\n func = scale.Scale(\n axis, bias_term=bias_term, bias_shape=shape)\n if bias_term:\n _Blob(blobs[0])(func.bias.b.data)\n\n # Add layer.\n with self.init_scope():\n setattr(self, layer.name, func)\n self.forwards[layer.name] = _CallChildLink(self, layer.name)\n self._add_layer(layer)\n\n @_layer('Slice', 'SLICE')\n def _setup_slice(self, layer):\n if layer.slice_param.HasField('axis'):\n axis = layer.slice_param.axis\n elif layer.slice_param.HasField('slice_dim'):\n axis = layer.slice_param.slice_dim\n else:\n axis = 1\n\n if layer.slice_param.slice_point:\n indices_or_sections = list(layer.slice_param.slice_point)\n else:\n indices_or_sections = len(list(layer.top))\n\n self.forwards[layer.name] = _SingleArgumentFunction(\n functions.split_axis,\n indices_or_sections=indices_or_sections,\n axis=axis\n )\n\n self._add_layer(layer)\n\n @_layer('Softmax', 'SOFTMAX')\n def _setup_softmax(self, layer):\n if layer.softmax_param.axis != 1:\n raise RuntimeError(\n 'Softmax along non-channel axis is not supported')\n\n if layer.softmax_param.engine == 0: # DEFAULT\n fw = functions.softmax\n elif layer.softmax_param.engine == 1: # CAFFE\n fw = _SingleArgumentFunctionWithCudnn(False, functions.softmax)\n elif layer.softmax_param.engine == 2: # CUDNN\n fw = _SingleArgumentFunctionWithCudnn(True, functions.softmax)\n\n self.forwards[layer.name] = fw\n self._add_layer(layer)\n\n @_layer('SoftmaxWithLoss', 'SOFTMAX_LOSS')\n def _setup_softmax_with_loss(self, layer):\n if layer.softmax_param.axis != 1:\n raise RuntimeError(\n 'Softmax along non-channel axis is not supported')\n\n self.forwards[layer.name] = functions.softmax_cross_entropy\n self._add_layer(layer)\n\n @_layer('Split', 'SPLIT')\n def _setup_split(self, layer):\n for top in layer.top:\n self.split_map[top] = layer.bottom[0]\n\n\n# Internal functions\n\ndef _get_ksize(param):\n if param.kernel_h > 0:\n return param.kernel_h, param.kernel_w\n elif type(param.kernel_size) == int:\n return param.kernel_size\n elif len(param.kernel_size) == 1:\n return param.kernel_size[0]\n else:\n return param.kernel_size\n\n\ndef _get_stride(param):\n if param.stride_h > 0:\n return param.stride_h, param.stride_w\n elif type(param.stride) == int:\n return param.stride\n elif len(param.stride) == 0:\n return 1\n elif len(param.stride) == 1:\n return param.stride[0]\n else:\n return param.stride\n\n\ndef _get_pad(param):\n if param.pad_h > 0:\n return param.pad_h, param.pad_w\n elif type(param.pad) == int:\n return param.pad\n elif len(param.pad) == 0:\n return 0\n elif len(param.pad) == 1:\n return param.pad[0]\n else:\n return param.pad\n\n\ndef _get_num(blob):\n if blob.num > 0:\n return blob.num\n else:\n return blob.shape.dim[0]\n\n\ndef _get_channels(blob):\n if blob.channels > 0:\n return blob.channels\n else:\n return blob.shape.dim[1]\n\n\ndef _get_height(blob):\n if blob.height > 0:\n return blob.height\n elif len(blob.shape.dim) == 2:\n return blob.shape.dim[0]\n elif len(blob.shape.dim) == 4:\n return blob.shape.dim[2]\n else:\n raise RuntimeError(\n '{}-dimentional array is not supported'.format(\n len(blob.shape.dim)))\n\n\ndef _get_width(blob):\n if blob.width > 0:\n return blob.width\n elif len(blob.shape.dim) == 2:\n return blob.shape.dim[1]\n elif len(blob.shape.dim) == 4:\n return blob.shape.dim[3]\n else:\n raise RuntimeError(\n '{}-dimentional array is not supported'.format(\n len(blob.shape.dim)))\n\n\n# Internal class\n\nclass _SingleArgumentFunction(object):\n\n def __init__(self, func, *args, **kwargs):\n self.func = func\n self.args = args\n self.kwargs = kwargs\n\n def __call__(self, x):\n return self.func(x, *self.args, **self.kwargs)\n\n\nclass _SingleArgumentFunctionTestMode(_SingleArgumentFunction):\n\n def __call__(self, x):\n with configuration.using_config('train', False):\n return super(_SingleArgumentFunctionTestMode, self).__call__(x)\n\n\nclass _ListArgumentFcuntion(object):\n\n def __init__(self, func, **kwargs):\n self.func = func\n self.kwargs = kwargs\n\n def __call__(self, *xs):\n return self.func(xs, **self.kwargs)\n\n\nclass _SingleArgumentFunctionWithCudnn(_SingleArgumentFunction):\n\n def __init__(self, use_cudnn, func, *args, **kwargs):\n super(_SingleArgumentFunctionWithCudnn, self).__init__(\n func, *args, **kwargs)\n self.use_cudnn = use_cudnn\n\n def __call__(self, x):\n with configuration.using_config('use_cudnn', self.use_cudnn):\n return super(_SingleArgumentFunctionWithCudnn, self).__call__(x)\n\n\nclass _CallChildLink(object):\n\n def __init__(self, caffe_func, name):\n self.name = name\n self.caffe_func = caffe_func\n\n def __call__(self, *xs, **kwargs):\n return self.caffe_func[self.name](*xs, **kwargs)\n\n\nclass _EltwiseFunction(object):\n\n def __init__(self, operation, coeffs=None):\n if coeffs is not None:\n assert len(coeffs) > 0\n self.operation = operation\n self.coeffs = coeffs\n\n def __call__(self, *xs):\n operation = self.operation\n\n if operation == 0: # PROD\n return six.moves.reduce(lambda x, y: x * y, xs),\n\n elif operation == 1: # SUM\n coeffs = self.coeffs\n if coeffs is not None:\n assert len(xs) == len(coeffs)\n xs = [x * coeff for x, coeff in zip(xs, coeffs)]\n return six.moves.reduce(lambda x, y: x + y, xs),\n\n elif operation == 2: # MAX\n return six.moves.reduce(lambda x, y: functions.maximum(x, y), xs),\n\n else:\n raise ValueError('Invalid EltwiseParameter.EltwiseOp value.')\n", "path": "chainer/links/caffe/caffe_function.py"}], "after_files": [{"content": "import warnings\n\nimport numpy\nimport six\n\nfrom chainer import configuration\nfrom chainer import functions\nfrom chainer import initializer\nfrom chainer import link\nfrom chainer.links.caffe.protobuf3 import caffe_pb2 as caffe_pb\nfrom chainer.links.connection import convolution_2d\nfrom chainer.links.connection import deconvolution_2d\nfrom chainer.links.connection import linear\nfrom chainer.links.connection import scale\nfrom chainer.links.normalization import batch_normalization\nfrom chainer.utils import argument\nfrom chainer.utils import collections_abc\n\n\ntry:\n # This method is undocumented, but is required to read large size of\n # model files when a user uses cpp-implementation.\n from google.protobuf.pyext import _message\n _message.SetAllowOversizeProtos(True)\nexcept ImportError:\n pass\n\n_type_to_method = {}\n_oldname_to_method = {}\n\n\ndef _layer(typ, oldname):\n def decorator(meth):\n global _type_to_method\n _type_to_method[typ] = meth\n if oldname is not None:\n typevalue = getattr(caffe_pb.V1LayerParameter, oldname)\n _oldname_to_method[typevalue] = meth\n return meth\n return decorator\n\n\nclass _Blob(initializer.Initializer):\n\n chunk_size = 1024 * 1024\n\n def __init__(self, blob):\n super(_Blob, self).__init__()\n self.data = blob.data\n\n def __call__(self, array):\n array = array.ravel()\n size = len(array)\n indices = list(range(0, size, self.chunk_size))\n\n # Rather than accessing Protobuf's RepeatedScalar fields directly,\n # creating a intermediate list by indexing is more efficifent due to\n # the implementation of the Python extension of Protobuf.\n # To avoid allocating excessively large lists, we limit the length\n # of lists by `chunk_size`.\n for start, end in zip(indices, indices[1:] + [size]):\n array[start:end] = self.data[start:end]\n\n\nclass _ConvolutionBlob(_Blob):\n\n def __init__(self, blob, group):\n super(_ConvolutionBlob, self).__init__(blob)\n self.group = group\n\n def __call__(self, array):\n n_out, n_in = array.shape[:2]\n\n part_out = n_out // self.group\n part_in = n_in // self.group\n\n array[...] = 0\n\n part_size = len(self.data) // self.group\n for i in six.moves.range(self.group):\n out_slice = slice(i * part_out, (i + 1) * part_out)\n in_slice = slice(i * part_in, (i + 1) * part_in)\n w = array[out_slice, in_slice]\n\n data = numpy.array(self.data[i * part_size:(i + 1) * part_size])\n w[:] = data.reshape(w.shape)\n\n\nclass CaffeFunction(link.Chain):\n\n \"\"\"Caffe emulator based on the model file of Caffe.\n\n Given a protocol buffers file of a Caffe model, this class loads and\n emulates it on :class:`~chainer.Variable` objects. It supports the official\n reference models provided by BVLC.\n\n .. note::\n\n CaffeFunction ignores the following layers:\n\n - Layers that CaffeFunction does not support (including data layers)\n - Layers that have no top blobs\n - Layers whose bottom blobs are incomplete (i.e., some or all of them\n are not given nor computed)\n\n .. warning::\n\n It does not support full compatibility against Caffe. Some layers and\n configurations are not implemented in Chainer yet, though the reference\n models provided by the BVLC team are supported except data layers.\n\n .. admonition:: Example\n\n Consider we want to extract the (unnormalized) log class probability\n of given images using BVLC reference CaffeNet. The model can be\n downloaded from:\n\n http://dl.caffe.berkeleyvision.org/bvlc_reference_caffenet.caffemodel\n\n We want to compute the ``fc8`` blob from the ``data`` blob. It is simply\n written as follows::\n\n # Load the model\n func = CaffeFunction('path/to/bvlc_reference_caffenet.caffemodel')\n\n # Minibatch of size 10\n x_data = numpy.ndarray((10, 3, 227, 227), dtype=numpy.float32)\n ... # (Fill the minibatch here)\n\n # Forward the pre-trained net\n x = Variable(x_data)\n y, = func(inputs={'data': x}, outputs=['fc8'])\n\n The result ``y`` contains the Variable corresponding to the ``fc8``\n blob. The computational graph is memorized as a usual forward\n computation in Chainer, so we can run backprop through this pre-trained\n net.\n\n Args:\n model_path (str): Path to the binary-proto model file of Caffe.\n\n Attributes:\n forwards (dict): A mapping from layer names to corresponding functions.\n\n \"\"\"\n\n def __init__(self, model_path):\n super(CaffeFunction, self).__init__()\n\n net = caffe_pb.NetParameter()\n with open(model_path, 'rb') as model_file:\n net.MergeFromString(model_file.read())\n\n self.forwards = {}\n self.split_map = {}\n self.layers = []\n\n if net.layer:\n for layer in net.layer:\n meth = _type_to_method.get(layer.type)\n if meth:\n meth(self, layer)\n else:\n warnings.warn(\n 'Skip the layer \"%s\", since CaffeFunction does not'\n 'support %s layer' % (layer.name, layer.type))\n else: # v1 format\n for layer in net.layers:\n meth = _oldname_to_method.get(layer.type)\n if meth:\n meth(self, layer)\n else:\n warnings.warn(\n 'Skip the layer \"%s\", since CaffeFunction does not'\n 'support it' % layer.name)\n\n def forward(self, inputs, outputs, disable=(), **kwargs):\n \"\"\"forward(self, inputs, outputs, disable=())\n\n Executes a sub-network of the network.\n\n This function acts as an interpreter of the network definition for\n Caffe. On execution, it interprets each layer one by one, and if the\n bottom blobs are already computed, then emulates the layer and stores\n output blobs as :class:`~chainer.Variable` objects.\n\n .. warning::\n\n ``train`` argument is not supported anymore since v2.\n Instead, use ``chainer.using_config('train', train)``.\n See :func:`chainer.using_config`.\n\n Args:\n inputs (dict): A dictionary whose key-value pairs indicate initial\n correspondences between blob names and\n :class:`~chainer.Variable` objects.\n outputs (Iterable): A list of blob names whose corresponding\n :class:`~chainer.Variable` objects are returned.\n disable (Iterable): A list of layer names that will be ignored\n during the forward computation.\n\n Returns:\n tuple: A tuple of output :class:`~chainer.Variable` objects\n corresponding to elements of the `outputs` argument.\n\n \"\"\"\n if kwargs:\n argument.check_unexpected_kwargs(\n kwargs, train='train argument is not supported anymore. '\n 'Use chainer.using_config')\n argument.assert_kwargs_empty(kwargs)\n\n variables = dict(inputs)\n disable = set(disable)\n for func_name, bottom, top in self.layers:\n if (func_name in disable or\n func_name not in self.forwards or\n any(blob not in variables for blob in bottom)):\n continue\n\n func = self.forwards[func_name]\n input_vars = tuple(variables[blob] for blob in bottom)\n output_vars = func(*input_vars)\n if not isinstance(output_vars, collections_abc.Iterable):\n output_vars = output_vars,\n for var, name in zip(output_vars, top):\n variables[name] = var\n\n self.variables = variables\n return tuple(variables[blob] for blob in outputs)\n\n def _add_layer(self, layer):\n bottom = []\n for blob_name in layer.bottom:\n bottom.append(self.split_map.get(blob_name, blob_name))\n self.layers.append((layer.name, bottom, list(layer.top)))\n\n @_layer('Concat', 'CONCAT')\n def _setup_concat(self, layer):\n param = layer.concat_param\n axis = param.axis\n if axis == 1 and param.concat_dim != 1:\n axis = param.concat_dim\n\n self.forwards[layer.name] = _ListArgumentFcuntion(\n functions.concat, axis=axis)\n self._add_layer(layer)\n\n @_layer('Convolution', 'CONVOLUTION')\n def _setup_convolution(self, layer):\n blobs = layer.blobs\n param = layer.convolution_param\n ksize = _get_ksize(param)\n stride = _get_stride(param)\n pad = _get_pad(param)\n num = _get_num(blobs[0])\n channels = _get_channels(blobs[0])\n bias_term = param.bias_term\n\n n_in = channels * param.group\n n_out = num\n\n func = convolution_2d.Convolution2D(\n n_in, n_out, ksize, stride, pad, nobias=not bias_term,\n initialW=_ConvolutionBlob(blobs[0], param.group),\n initial_bias=_Blob(blobs[1]) if bias_term else None)\n\n with self.init_scope():\n setattr(self, layer.name, func)\n self.forwards[layer.name] = _CallChildLink(self, layer.name)\n self._add_layer(layer)\n\n @_layer('Deconvolution', 'DECONVOLUTION')\n def _setup_deconvolution(self, layer):\n blobs = layer.blobs\n param = layer.convolution_param\n ksize = _get_ksize(param)\n stride = _get_stride(param)\n pad = _get_pad(param)\n num = _get_num(blobs[0])\n channels = _get_channels(blobs[0])\n bias_term = param.bias_term\n\n n_in = num\n n_out = channels * param.group\n\n func = deconvolution_2d.Deconvolution2D(\n n_in, n_out, ksize, stride, pad, nobias=not bias_term,\n initialW=_ConvolutionBlob(blobs[0], param.group),\n initial_bias=_Blob(blobs[1]) if bias_term else None)\n\n with self.init_scope():\n setattr(self, layer.name, func)\n self.forwards[layer.name] = _CallChildLink(self, layer.name)\n self._add_layer(layer)\n\n @_layer('Data', 'DATA')\n def _setup_data(self, layer):\n # We silently skip the data layer.\n pass\n\n @_layer('Dropout', 'DROPOUT')\n def _setup_dropout(self, layer):\n param = layer.dropout_param\n\n self.forwards[layer.name] = _SingleArgumentFunction(\n functions.dropout, ratio=param.dropout_ratio)\n self._add_layer(layer)\n\n @_layer('InnerProduct', 'INNER_PRODUCT')\n def _setup_inner_product(self, layer):\n param = layer.inner_product_param\n bias_term = param.bias_term\n if param.axis != 1:\n raise RuntimeError(\n 'Non-default axis in InnerProduct is not supported')\n\n blobs = layer.blobs\n width, height = _get_width(blobs[0]), _get_height(blobs[0])\n\n func = linear.Linear(\n width, height, nobias=not bias_term,\n initialW=_Blob(blobs[0]),\n initial_bias=_Blob(blobs[1]) if bias_term else None)\n\n with self.init_scope():\n setattr(self, layer.name, func)\n self.forwards[layer.name] = _CallChildLink(self, layer.name)\n self._add_layer(layer)\n\n @_layer('LRN', 'LRN')\n def _setup_lrn(self, layer):\n param = layer.lrn_param\n if param.norm_region != param.ACROSS_CHANNELS:\n raise RuntimeError('Within-channel LRN is not supported')\n\n fwd = _SingleArgumentFunction(\n functions.local_response_normalization,\n n=param.local_size, k=param.k,\n alpha=param.alpha / param.local_size, beta=param.beta)\n self.forwards[layer.name] = fwd\n self._add_layer(layer)\n\n @_layer('Pooling', 'POOLING')\n def _setup_pooling(self, layer):\n param = layer.pooling_param\n ksize = _get_ksize(param)\n stride = _get_stride(param)\n pad = _get_pad(param)\n\n if param.pool == param.MAX:\n func = functions.max_pooling_2d\n elif param.pool == param.AVE:\n func = functions.average_pooling_2d\n else:\n raise RuntimeError('Stochastic pooling is not supported')\n\n if param.global_pooling and not ksize:\n # if global_pooling is set but no kernel size, the kernel size\n # is computed dynamically to cover the whole input feature map\n def _func(x, stride, pad):\n return func(x, x.shape[2:], stride=stride, pad=pad)\n fw = _SingleArgumentFunction(_func, stride=stride, pad=pad)\n else:\n fw = _SingleArgumentFunction(func, ksize, stride=stride, pad=pad)\n self.forwards[layer.name] = fw\n self._add_layer(layer)\n\n @_layer('ReLU', 'RELU')\n def _setup_relu(self, layer):\n slope = layer.relu_param.negative_slope\n\n if slope != 0:\n fw = _SingleArgumentFunction(functions.leaky_relu, slope=slope)\n else:\n fw = functions.relu\n\n self.forwards[layer.name] = fw\n self._add_layer(layer)\n\n @_layer('Reshape', None)\n def _setup_reshape(self, layer):\n shape = layer.reshape_param.shape.dim\n\n fw = _SingleArgumentFunction(functions.reshape, shape=shape)\n\n self.forwards[layer.name] = fw\n self._add_layer(layer)\n\n @_layer('BatchNorm', None)\n def _setup_batchnorm(self, layer):\n # Get layer parameters.\n blobs = layer.blobs\n param = layer.batch_norm_param\n use_global_stats = param.use_global_stats\n decay = param.moving_average_fraction\n eps = param.eps\n size = int(blobs[0].shape.dim[0]) # Get channel dim from mean blob.\n\n # Make BatchNormalization link.\n func = batch_normalization.BatchNormalization(\n size, decay=decay, eps=eps, use_gamma=False, use_beta=False)\n\n _Blob(blobs[0])(func.avg_mean)\n _Blob(blobs[1])(func.avg_var)\n\n # Scale the means and variances if a scaling factor is appended to the\n # blobs to correctly mimic to the behavior of Caffe. See\n # https://github.com/BVLC/caffe/issues/4885\n if len(blobs) >= 3:\n scaling_factor = blobs[2].data\n func.avg_mean /= scaling_factor[0]\n func.avg_var /= scaling_factor[0]\n\n with self.init_scope():\n setattr(self, layer.name, func)\n\n # Add layer.\n if use_global_stats:\n func_class = _SingleArgumentFunctionTestMode\n else:\n func_class = _SingleArgumentFunction\n fwd = func_class(_CallChildLink(self, layer.name), finetune=False)\n self.forwards[layer.name] = fwd\n self._add_layer(layer)\n\n @_layer('Eltwise', 'ELTWISE')\n def _setup_eltwise(self, layer):\n # stable_prod_grad parameter is not supported now.\n operation = layer.eltwise_param.operation\n coeffs = layer.eltwise_param.coeff or None\n self.forwards[layer.name] = _EltwiseFunction(operation, coeffs)\n self._add_layer(layer)\n\n @_layer('Scale', None)\n def _setup_scale(self, layer):\n # Following parameters are not supported now:\n # - negative axis\n # - num_axes\n # - filler\n # - bias_filler\n\n # Get layer parameters.\n bottom = layer.bottom\n blobs = layer.blobs\n axis = layer.scale_param.axis\n bias_term = layer.scale_param.bias_term\n\n # Case of only one bottom where W is learnt parameter.\n if len(bottom) == 1:\n W_shape = blobs[0].shape.dim\n func = scale.Scale(axis, W_shape, bias_term)\n _Blob(blobs[0])(func.W.data)\n if bias_term:\n _Blob(blobs[1])(func.bias.b.data)\n # Case of two bottoms where W is given as a bottom.\n else:\n shape = blobs[0].shape.dim if bias_term else None\n func = scale.Scale(\n axis, bias_term=bias_term, bias_shape=shape)\n if bias_term:\n _Blob(blobs[0])(func.bias.b.data)\n\n # Add layer.\n with self.init_scope():\n setattr(self, layer.name, func)\n self.forwards[layer.name] = _CallChildLink(self, layer.name)\n self._add_layer(layer)\n\n @_layer('Slice', 'SLICE')\n def _setup_slice(self, layer):\n if layer.slice_param.HasField('axis'):\n axis = layer.slice_param.axis\n elif layer.slice_param.HasField('slice_dim'):\n axis = layer.slice_param.slice_dim\n else:\n axis = 1\n\n if layer.slice_param.slice_point:\n indices_or_sections = list(layer.slice_param.slice_point)\n else:\n indices_or_sections = len(list(layer.top))\n\n self.forwards[layer.name] = _SingleArgumentFunction(\n functions.split_axis,\n indices_or_sections=indices_or_sections,\n axis=axis\n )\n\n self._add_layer(layer)\n\n @_layer('Softmax', 'SOFTMAX')\n def _setup_softmax(self, layer):\n if layer.softmax_param.axis != 1:\n raise RuntimeError(\n 'Softmax along non-channel axis is not supported')\n\n if layer.softmax_param.engine == 0: # DEFAULT\n fw = functions.softmax\n elif layer.softmax_param.engine == 1: # CAFFE\n fw = _SingleArgumentFunctionWithCudnn(False, functions.softmax)\n elif layer.softmax_param.engine == 2: # CUDNN\n fw = _SingleArgumentFunctionWithCudnn(True, functions.softmax)\n\n self.forwards[layer.name] = fw\n self._add_layer(layer)\n\n @_layer('SoftmaxWithLoss', 'SOFTMAX_LOSS')\n def _setup_softmax_with_loss(self, layer):\n if layer.softmax_param.axis != 1:\n raise RuntimeError(\n 'Softmax along non-channel axis is not supported')\n\n self.forwards[layer.name] = functions.softmax_cross_entropy\n self._add_layer(layer)\n\n @_layer('Split', 'SPLIT')\n def _setup_split(self, layer):\n for top in layer.top:\n self.split_map[top] = layer.bottom[0]\n\n\n# Internal functions\n\ndef _get_ksize(param):\n if param.kernel_h > 0:\n return param.kernel_h, param.kernel_w\n elif type(param.kernel_size) == int:\n return param.kernel_size\n elif len(param.kernel_size) == 1:\n return param.kernel_size[0]\n else:\n return param.kernel_size\n\n\ndef _get_stride(param):\n if param.stride_h > 0:\n return param.stride_h, param.stride_w\n elif type(param.stride) == int:\n return param.stride\n elif len(param.stride) == 0:\n return 1\n elif len(param.stride) == 1:\n return param.stride[0]\n else:\n return param.stride\n\n\ndef _get_pad(param):\n if param.pad_h > 0 or param.pad_w > 0:\n return param.pad_h, param.pad_w\n elif type(param.pad) == int:\n return param.pad\n elif len(param.pad) == 0:\n return 0\n elif len(param.pad) == 1:\n return param.pad[0]\n else:\n return param.pad\n\n\ndef _get_num(blob):\n if blob.num > 0:\n return blob.num\n else:\n return blob.shape.dim[0]\n\n\ndef _get_channels(blob):\n if blob.channels > 0:\n return blob.channels\n else:\n return blob.shape.dim[1]\n\n\ndef _get_height(blob):\n if blob.height > 0:\n return blob.height\n elif len(blob.shape.dim) == 2:\n return blob.shape.dim[0]\n elif len(blob.shape.dim) == 4:\n return blob.shape.dim[2]\n else:\n raise RuntimeError(\n '{}-dimentional array is not supported'.format(\n len(blob.shape.dim)))\n\n\ndef _get_width(blob):\n if blob.width > 0:\n return blob.width\n elif len(blob.shape.dim) == 2:\n return blob.shape.dim[1]\n elif len(blob.shape.dim) == 4:\n return blob.shape.dim[3]\n else:\n raise RuntimeError(\n '{}-dimentional array is not supported'.format(\n len(blob.shape.dim)))\n\n\n# Internal class\n\nclass _SingleArgumentFunction(object):\n\n def __init__(self, func, *args, **kwargs):\n self.func = func\n self.args = args\n self.kwargs = kwargs\n\n def __call__(self, x):\n return self.func(x, *self.args, **self.kwargs)\n\n\nclass _SingleArgumentFunctionTestMode(_SingleArgumentFunction):\n\n def __call__(self, x):\n with configuration.using_config('train', False):\n return super(_SingleArgumentFunctionTestMode, self).__call__(x)\n\n\nclass _ListArgumentFcuntion(object):\n\n def __init__(self, func, **kwargs):\n self.func = func\n self.kwargs = kwargs\n\n def __call__(self, *xs):\n return self.func(xs, **self.kwargs)\n\n\nclass _SingleArgumentFunctionWithCudnn(_SingleArgumentFunction):\n\n def __init__(self, use_cudnn, func, *args, **kwargs):\n super(_SingleArgumentFunctionWithCudnn, self).__init__(\n func, *args, **kwargs)\n self.use_cudnn = use_cudnn\n\n def __call__(self, x):\n with configuration.using_config('use_cudnn', self.use_cudnn):\n return super(_SingleArgumentFunctionWithCudnn, self).__call__(x)\n\n\nclass _CallChildLink(object):\n\n def __init__(self, caffe_func, name):\n self.name = name\n self.caffe_func = caffe_func\n\n def __call__(self, *xs, **kwargs):\n return self.caffe_func[self.name](*xs, **kwargs)\n\n\nclass _EltwiseFunction(object):\n\n def __init__(self, operation, coeffs=None):\n if coeffs is not None:\n assert len(coeffs) > 0\n self.operation = operation\n self.coeffs = coeffs\n\n def __call__(self, *xs):\n operation = self.operation\n\n if operation == 0: # PROD\n return six.moves.reduce(lambda x, y: x * y, xs),\n\n elif operation == 1: # SUM\n coeffs = self.coeffs\n if coeffs is not None:\n assert len(xs) == len(coeffs)\n xs = [x * coeff for x, coeff in zip(xs, coeffs)]\n return six.moves.reduce(lambda x, y: x + y, xs),\n\n elif operation == 2: # MAX\n return six.moves.reduce(lambda x, y: functions.maximum(x, y), xs),\n\n else:\n raise ValueError('Invalid EltwiseParameter.EltwiseOp value.')\n", "path": "chainer/links/caffe/caffe_function.py"}]} |
gh_patches_debug_278 | rasdani/github-patches | git_diff | kivy__kivy-5627 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
No module named kivy.setupconfig
Hi,
When installing Kivy 1.9.1 as a dependency of one of my packages I get the error
`ImportError: No module named 'kivy.setupconfig`.
My setup.py file looks like this and installs without errors:
```
from setuptools import setup
CYTHON_REQ = "cython==0.23.4"
setup(
name = 'MyApp',
version = "0.1.0",
author = "MelleB",
setup_requires = [ CYTHON_REQ ],
install_requires = [ CYTHON_REQ, 'kivy==1.9.1' ]
)
```
During the build, the following line is displayed:
`Updated /tmp/easy_install-4drozlb6/kivy-1.9.1/kivy/setupconfig.py`
After digging into kivy's setup.py, I noticed the setupconfig.py file is generated.
From my understanding it seems the setupconfig.py isn't part of the mItanifest.
A possible solution might be to add a 'setupconfig.py' entry to the setup's package_data (In https://github.com/kivy/kivy/blob/fddade6ce3b8a3be77d22cd3f973c9c930799874/setup.py#L959)
I found a possibliy related bug + PR in #2850
# Environment
Platform: Ubuntu 16.04LTS
Kivy: 1.9.1
Python: 3.5.1
# Steps to reproduce
```
$ pyenv intall 3.5.1
$ pyenv virtualenv 3.5.1 kivy-setupconfig-issue
$ mkdir kivy-setupconfig-issue && cd kivy-setupconfig-issue
$ pyenv local kivy-setupconfig-issue
$ cat > setup.py
from setuptools import setup
CYTHON_REQ = "cython==0.23.4"
setup(
name = 'MyApp',
version = "0.1.0",
author = "MelleB",
setup_requires = [ CYTHON_REQ ],
install_requires = [ CYTHON_REQ, 'kivy==1.9.1' ]
)
$ python setup.py install
```
After that, the issue can be confirmed with:
```
$ python
Python 3.5.1 (default, May 30 2016, 14:49:00)
[GCC 5.3.1 20160413] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import kivy
[INFO ] [Logger ] Record log in /home/melle/.kivy/logs/kivy_16-06-02_1.txt
[INFO ] [Kivy ] v1.9.1
[INFO ] [Python ] v3.5.1 (default, May 30 2016, 14:49:00)
[GCC 5.3.1 20160413]
>>> import kivy.setupconfig
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
ImportError: No module named 'kivy.setupconfig'
>>>
```
If you have any further questions, please let me know.
--- 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 #
2 # Kivy - Cross-platform UI framework
3 # https://kivy.org/
4 #
5 from __future__ import print_function
6
7 import sys
8 build_examples = False
9 if "--build_examples" in sys.argv:
10 build_examples = True
11 sys.argv.remove("--build_examples")
12
13 from copy import deepcopy
14 import os
15 from os.path import join, dirname, sep, exists, basename, isdir
16 from os import walk, environ
17 from distutils.version import LooseVersion
18 from distutils.sysconfig import get_python_inc
19 from collections import OrderedDict
20 from time import sleep
21 from subprocess import check_output, CalledProcessError
22 from datetime import datetime
23
24 if environ.get('KIVY_USE_SETUPTOOLS'):
25 from setuptools import setup, Extension
26 print('Using setuptools')
27 else:
28 from distutils.core import setup
29 from distutils.extension import Extension
30 print('Using distutils')
31
32
33 PY3 = sys.version > '3'
34
35 if PY3: # fix error with py3's LooseVersion comparisons
36 def ver_equal(self, other):
37 return self.version == other
38
39 LooseVersion.__eq__ = ver_equal
40
41
42 def get_version(filename='kivy/version.py'):
43 VERSION = kivy.__version__
44 DATE = datetime.utcnow().strftime('%Y%m%d')
45 try:
46 GIT_REVISION = check_output(
47 ['git', 'rev-parse', 'HEAD']
48 ).strip().decode('ascii')
49 except (CalledProcessError, OSError, IOError) as e:
50 # CalledProcessError has no errno
51 errno = getattr(e, 'errno', None)
52 if errno != 2 and 'CalledProcessError' not in repr(e):
53 raise
54 GIT_REVISION = "Unknown"
55
56 cnt = (
57 "# THIS FILE IS GENERATED FROM KIVY SETUP.PY\n"
58 "__version__ = '%(version)s'\n"
59 "__hash__ = '%(hash)s'\n"
60 "__date__ = '%(date)s'\n"
61 )
62
63 with open(filename, 'w') as f:
64 f.write(cnt % {
65 'version': VERSION,
66 'hash': GIT_REVISION,
67 'date': DATE
68 })
69 return VERSION
70
71
72 MIN_CYTHON_STRING = '0.23'
73 MIN_CYTHON_VERSION = LooseVersion(MIN_CYTHON_STRING)
74 MAX_CYTHON_STRING = '0.27.3'
75 MAX_CYTHON_VERSION = LooseVersion(MAX_CYTHON_STRING)
76 CYTHON_UNSUPPORTED = (
77 # ref https://github.com/cython/cython/issues/1968
78 '0.27', '0.27.2'
79 )
80
81
82 def getoutput(cmd, env=None):
83 import subprocess
84 p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE,
85 stderr=subprocess.PIPE, env=env)
86 p.wait()
87 if p.returncode: # if not returncode == 0
88 print('WARNING: A problem occurred while running {0} (code {1})\n'
89 .format(cmd, p.returncode))
90 stderr_content = p.stderr.read()
91 if stderr_content:
92 print('{0}\n'.format(stderr_content))
93 return ""
94 return p.stdout.read()
95
96
97 def pkgconfig(*packages, **kw):
98 flag_map = {'-I': 'include_dirs', '-L': 'library_dirs', '-l': 'libraries'}
99 lenviron = None
100 pconfig = join(sys.prefix, 'libs', 'pkgconfig')
101
102 if isdir(pconfig):
103 lenviron = environ.copy()
104 lenviron['PKG_CONFIG_PATH'] = '{};{}'.format(
105 environ.get('PKG_CONFIG_PATH', ''), pconfig)
106 cmd = 'pkg-config --libs --cflags {}'.format(' '.join(packages))
107 results = getoutput(cmd, lenviron).split()
108 for token in results:
109 ext = token[:2].decode('utf-8')
110 flag = flag_map.get(ext)
111 if not flag:
112 continue
113 kw.setdefault(flag, []).append(token[2:].decode('utf-8'))
114 return kw
115
116
117 # -----------------------------------------------------------------------------
118 # Determine on which platform we are
119
120 platform = sys.platform
121
122 # Detect 32/64bit for OSX (http://stackoverflow.com/a/1405971/798575)
123 if sys.platform == 'darwin':
124 if sys.maxsize > 2 ** 32:
125 osx_arch = 'x86_64'
126 else:
127 osx_arch = 'i386'
128
129 # Detect Python for android project (http://github.com/kivy/python-for-android)
130 ndkplatform = environ.get('NDKPLATFORM')
131 if ndkplatform is not None and environ.get('LIBLINK'):
132 platform = 'android'
133 kivy_ios_root = environ.get('KIVYIOSROOT', None)
134 if kivy_ios_root is not None:
135 platform = 'ios'
136 if exists('/opt/vc/include/bcm_host.h'):
137 platform = 'rpi'
138 if exists('/usr/lib/arm-linux-gnueabihf/libMali.so'):
139 platform = 'mali'
140
141 # -----------------------------------------------------------------------------
142 # Detect options
143 #
144 c_options = OrderedDict()
145 c_options['use_rpi'] = platform == 'rpi'
146 c_options['use_mali'] = platform == 'mali'
147 c_options['use_egl'] = False
148 c_options['use_opengl_es2'] = None
149 c_options['use_opengl_mock'] = environ.get('READTHEDOCS', None) == 'True'
150 c_options['use_sdl2'] = None
151 c_options['use_ios'] = False
152 c_options['use_mesagl'] = False
153 c_options['use_x11'] = False
154 c_options['use_wayland'] = False
155 c_options['use_gstreamer'] = None
156 c_options['use_avfoundation'] = platform == 'darwin'
157 c_options['use_osx_frameworks'] = platform == 'darwin'
158 c_options['debug_gl'] = False
159
160 # now check if environ is changing the default values
161 for key in list(c_options.keys()):
162 ukey = key.upper()
163 if ukey in environ:
164 value = bool(int(environ[ukey]))
165 print('Environ change {0} -> {1}'.format(key, value))
166 c_options[key] = value
167
168
169 # -----------------------------------------------------------------------------
170 # Cython check
171 # on python-for-android and kivy-ios, cython usage is external
172
173 cython_unsupported_append = '''
174
175 Please note that the following versions of Cython are not supported
176 at all: {}
177 '''.format(', '.join(map(str, CYTHON_UNSUPPORTED)))
178
179 cython_min = '''\
180 This version of Cython is not compatible with Kivy. Please upgrade to
181 at least version {0}, preferably the newest supported version {1}.
182
183 If your platform provides a Cython package, make sure you have upgraded
184 to the newest version. If the newest version available is still too low,
185 please remove it and install the newest supported Cython via pip:
186
187 pip install -I Cython=={1}{2}\
188 '''.format(MIN_CYTHON_STRING, MAX_CYTHON_STRING,
189 cython_unsupported_append if CYTHON_UNSUPPORTED else '')
190
191 cython_max = '''\
192 This version of Cython is untested with Kivy. While this version may
193 work perfectly fine, it is possible that you may experience issues. If
194 you do have issues, please downgrade to a supported version. It is
195 best to use the newest supported version, {1}, but the minimum
196 supported version is {0}.
197
198 If your platform provides a Cython package, check if you can downgrade
199 to a supported version. Otherwise, uninstall the platform package and
200 install Cython via pip:
201
202 pip install -I Cython=={1}{2}\
203 '''.format(MIN_CYTHON_STRING, MAX_CYTHON_STRING,
204 cython_unsupported_append if CYTHON_UNSUPPORTED else '')
205
206 cython_unsupported = '''\
207 This version of Cython suffers from known bugs and is unsupported.
208 Please install the newest supported version, {1}, if possible, but
209 the minimum supported version is {0}.
210
211 If your platform provides a Cython package, check if you can install
212 a supported version. Otherwise, uninstall the platform package and
213 install Cython via pip:
214
215 pip install -I Cython=={1}{2}\
216 '''.format(MIN_CYTHON_STRING, MAX_CYTHON_STRING,
217 cython_unsupported_append)
218
219 have_cython = False
220 skip_cython = False
221 if platform in ('ios', 'android'):
222 print('\nCython check avoided.')
223 skip_cython = True
224 else:
225 try:
226 # check for cython
227 from Cython.Distutils import build_ext
228 have_cython = True
229 import Cython
230 cy_version_str = Cython.__version__
231 cy_ver = LooseVersion(cy_version_str)
232 print('\nDetected Cython version {}'.format(cy_version_str))
233 if cy_ver < MIN_CYTHON_VERSION:
234 print(cython_min)
235 raise ImportError('Incompatible Cython Version')
236 if cy_ver in CYTHON_UNSUPPORTED:
237 print(cython_unsupported)
238 raise ImportError('Incompatible Cython Version')
239 if cy_ver > MAX_CYTHON_VERSION:
240 print(cython_max)
241 sleep(1)
242 except ImportError:
243 print("\nCython is missing, it's required for compiling kivy !\n\n")
244 raise
245
246 if not have_cython:
247 from distutils.command.build_ext import build_ext
248
249 # -----------------------------------------------------------------------------
250 # Setup classes
251
252 # the build path where kivy is being compiled
253 src_path = build_path = dirname(__file__)
254
255
256 class KivyBuildExt(build_ext):
257
258 def finalize_options(self):
259 retval = build_ext.finalize_options(self)
260 global build_path
261 if (self.build_lib is not None and exists(self.build_lib) and
262 not self.inplace):
263 build_path = self.build_lib
264 return retval
265
266 def build_extensions(self):
267 # build files
268 config_h_fn = ('include', 'config.h')
269 config_pxi_fn = ('include', 'config.pxi')
270 config_py_fn = ('setupconfig.py', )
271
272 # generate headers
273 config_h = '// Autogenerated file for Kivy C configuration\n'
274 config_h += '#define __PY3 {0}\n'.format(int(PY3))
275 config_pxi = '# Autogenerated file for Kivy Cython configuration\n'
276 config_pxi += 'DEF PY3 = {0}\n'.format(int(PY3))
277 config_py = '# Autogenerated file for Kivy configuration\n'
278 config_py += 'PY3 = {0}\n'.format(int(PY3))
279 config_py += 'CYTHON_MIN = {0}\nCYTHON_MAX = {1}\n'.format(
280 repr(MIN_CYTHON_STRING), repr(MAX_CYTHON_STRING))
281 config_py += 'CYTHON_BAD = {0}\n'.format(repr(', '.join(map(
282 str, CYTHON_UNSUPPORTED))))
283
284 # generate content
285 print('Build configuration is:')
286 for opt, value in c_options.items():
287 value = int(bool(value))
288 print(' * {0} = {1}'.format(opt, value))
289 opt = opt.upper()
290 config_h += '#define __{0} {1}\n'.format(opt, value)
291 config_pxi += 'DEF {0} = {1}\n'.format(opt, value)
292 config_py += '{0} = {1}\n'.format(opt, value)
293 debug = bool(self.debug)
294 print(' * debug = {0}'.format(debug))
295
296 config_pxi += 'DEF DEBUG = {0}\n'.format(debug)
297 config_py += 'DEBUG = {0}\n'.format(debug)
298 config_pxi += 'DEF PLATFORM = "{0}"\n'.format(platform)
299 config_py += 'PLATFORM = "{0}"\n'.format(platform)
300 for fn, content in (
301 (config_h_fn, config_h), (config_pxi_fn, config_pxi),
302 (config_py_fn, config_py)):
303 build_fn = expand(build_path, *fn)
304 if self.update_if_changed(build_fn, content):
305 print('Updated {}'.format(build_fn))
306 src_fn = expand(src_path, *fn)
307 if src_fn != build_fn and self.update_if_changed(src_fn, content):
308 print('Updated {}'.format(src_fn))
309
310 c = self.compiler.compiler_type
311 print('Detected compiler is {}'.format(c))
312 if c != 'msvc':
313 for e in self.extensions:
314 e.extra_link_args += ['-lm']
315
316 build_ext.build_extensions(self)
317
318 def update_if_changed(self, fn, content):
319 need_update = True
320 if exists(fn):
321 with open(fn) as fd:
322 need_update = fd.read() != content
323 if need_update:
324 with open(fn, 'w') as fd:
325 fd.write(content)
326 return need_update
327
328
329 def _check_and_fix_sdl2_mixer(f_path):
330 print("Check if SDL2_mixer smpeg2 have an @executable_path")
331 rpath_from = ("@executable_path/../Frameworks/SDL2.framework"
332 "/Versions/A/SDL2")
333 rpath_to = "@rpath/../../../../SDL2.framework/Versions/A/SDL2"
334 smpeg2_path = ("{}/Versions/A/Frameworks/smpeg2.framework"
335 "/Versions/A/smpeg2").format(f_path)
336 output = getoutput(("otool -L '{}'").format(smpeg2_path)).decode('utf-8')
337 if "@executable_path" not in output:
338 return
339
340 print("WARNING: Your SDL2_mixer version is invalid")
341 print("WARNING: The smpeg2 framework embedded in SDL2_mixer contains a")
342 print("WARNING: reference to @executable_path that will fail the")
343 print("WARNING: execution of your application.")
344 print("WARNING: We are going to change:")
345 print("WARNING: from: {}".format(rpath_from))
346 print("WARNING: to: {}".format(rpath_to))
347 getoutput("install_name_tool -change {} {} {}".format(
348 rpath_from, rpath_to, smpeg2_path))
349
350 output = getoutput(("otool -L '{}'").format(smpeg2_path))
351 if b"@executable_path" not in output:
352 print("WARNING: Change successfully applied!")
353 print("WARNING: You'll never see this message again.")
354 else:
355 print("WARNING: Unable to apply the changes, sorry.")
356
357
358 # -----------------------------------------------------------------------------
359 # extract version (simulate doc generation, kivy will be not imported)
360 environ['KIVY_DOC_INCLUDE'] = '1'
361 import kivy
362
363 # extra build commands go in the cmdclass dict {'command-name': CommandClass}
364 # see tools.packaging.{platform}.build.py for custom build commands for
365 # portable packages. Also e.g. we use build_ext command from cython if its
366 # installed for c extensions.
367 from kivy.tools.packaging.factory import FactoryBuild
368 cmdclass = {
369 'build_factory': FactoryBuild,
370 'build_ext': KivyBuildExt}
371
372 try:
373 # add build rules for portable packages to cmdclass
374 if platform == 'win32':
375 from kivy.tools.packaging.win32.build import WindowsPortableBuild
376 cmdclass['build_portable'] = WindowsPortableBuild
377 elif platform == 'darwin':
378 from kivy.tools.packaging.osx.build import OSXPortableBuild
379 cmdclass['build_portable'] = OSXPortableBuild
380 except ImportError:
381 print('User distribution detected, avoid portable command.')
382
383 # Detect which opengl version headers to use
384 if platform in ('android', 'darwin', 'ios', 'rpi', 'mali'):
385 c_options['use_opengl_es2'] = True
386 elif c_options['use_opengl_es2'] is None:
387 c_options['use_opengl_es2'] = \
388 environ.get('KIVY_GRAPHICS', '').lower() == 'gles'
389
390 print('Using this graphics system: {}'.format(
391 ['OpenGL', 'OpenGL ES 2'][int(c_options['use_opengl_es2'] or False)]))
392
393 # check if we are in a kivy-ios build
394 if platform == 'ios':
395 print('Kivy-IOS project environment detect, use it.')
396 print('Kivy-IOS project located at {0}'.format(kivy_ios_root))
397 c_options['use_ios'] = True
398 c_options['use_sdl2'] = True
399
400 elif platform == 'darwin':
401 if c_options['use_osx_frameworks']:
402 if osx_arch == "i386":
403 print("Warning: building with frameworks fail on i386")
404 else:
405 print("OSX framework used, force to x86_64 only")
406 environ["ARCHFLAGS"] = environ.get("ARCHFLAGS", "-arch x86_64")
407 print("OSX ARCHFLAGS are: {}".format(environ["ARCHFLAGS"]))
408
409 # detect gstreamer, only on desktop
410 # works if we forced the options or in autodetection
411 if platform not in ('ios', 'android') and (c_options['use_gstreamer']
412 in (None, True)):
413 gstreamer_valid = False
414 if c_options['use_osx_frameworks'] and platform == 'darwin':
415 # check the existence of frameworks
416 f_path = '/Library/Frameworks/GStreamer.framework'
417 if not exists(f_path):
418 c_options['use_gstreamer'] = False
419 print('GStreamer framework not found, fallback on pkg-config')
420 else:
421 print('GStreamer framework found')
422 gstreamer_valid = True
423 c_options['use_gstreamer'] = True
424 gst_flags = {
425 'extra_link_args': [
426 '-F/Library/Frameworks',
427 '-Xlinker', '-rpath',
428 '-Xlinker', '/Library/Frameworks',
429 '-Xlinker', '-headerpad',
430 '-Xlinker', '190',
431 '-framework', 'GStreamer'],
432 'include_dirs': [join(f_path, 'Headers')]}
433
434 if not gstreamer_valid:
435 # use pkg-config approach instead
436 gst_flags = pkgconfig('gstreamer-1.0')
437 if 'libraries' in gst_flags:
438 print('GStreamer found via pkg-config')
439 c_options['use_gstreamer'] = True
440
441
442 # detect SDL2, only on desktop and iOS, or android if explicitly enabled
443 # works if we forced the options or in autodetection
444 sdl2_flags = {}
445 if c_options['use_sdl2'] or (
446 platform not in ('android',) and c_options['use_sdl2'] is None):
447
448 sdl2_valid = False
449 if c_options['use_osx_frameworks'] and platform == 'darwin':
450 # check the existence of frameworks
451 sdl2_valid = True
452 sdl2_flags = {
453 'extra_link_args': [
454 '-F/Library/Frameworks',
455 '-Xlinker', '-rpath',
456 '-Xlinker', '/Library/Frameworks',
457 '-Xlinker', '-headerpad',
458 '-Xlinker', '190'],
459 'include_dirs': [],
460 'extra_compile_args': ['-F/Library/Frameworks']
461 }
462 for name in ('SDL2', 'SDL2_ttf', 'SDL2_image', 'SDL2_mixer'):
463 f_path = '/Library/Frameworks/{}.framework'.format(name)
464 if not exists(f_path):
465 print('Missing framework {}'.format(f_path))
466 sdl2_valid = False
467 continue
468 sdl2_flags['extra_link_args'] += ['-framework', name]
469 sdl2_flags['include_dirs'] += [join(f_path, 'Headers')]
470 print('Found sdl2 frameworks: {}'.format(f_path))
471 if name == 'SDL2_mixer':
472 _check_and_fix_sdl2_mixer(f_path)
473
474 if not sdl2_valid:
475 c_options['use_sdl2'] = False
476 print('SDL2 frameworks not found, fallback on pkg-config')
477 else:
478 c_options['use_sdl2'] = True
479 print('Activate SDL2 compilation')
480
481 if not sdl2_valid and platform != "ios":
482 # use pkg-config approach instead
483 sdl2_flags = pkgconfig('sdl2', 'SDL2_ttf', 'SDL2_image', 'SDL2_mixer')
484 if 'libraries' in sdl2_flags:
485 print('SDL2 found via pkg-config')
486 c_options['use_sdl2'] = True
487
488
489 # -----------------------------------------------------------------------------
490 # declare flags
491
492
493 def get_modulename_from_file(filename):
494 filename = filename.replace(sep, '/')
495 pyx = '.'.join(filename.split('.')[:-1])
496 pyxl = pyx.split('/')
497 while pyxl[0] != 'kivy':
498 pyxl.pop(0)
499 if pyxl[1] == 'kivy':
500 pyxl.pop(0)
501 return '.'.join(pyxl)
502
503
504 def expand(root, *args):
505 return join(root, 'kivy', *args)
506
507
508 class CythonExtension(Extension):
509
510 def __init__(self, *args, **kwargs):
511 Extension.__init__(self, *args, **kwargs)
512 self.cython_directives = {
513 'c_string_encoding': 'utf-8',
514 'profile': 'USE_PROFILE' in environ,
515 'embedsignature': 'USE_EMBEDSIGNATURE' in environ}
516 # XXX with pip, setuptools is imported before distutils, and change
517 # our pyx to c, then, cythonize doesn't happen. So force again our
518 # sources
519 self.sources = args[1]
520
521
522 def merge(d1, *args):
523 d1 = deepcopy(d1)
524 for d2 in args:
525 for key, value in d2.items():
526 value = deepcopy(value)
527 if key in d1:
528 d1[key].extend(value)
529 else:
530 d1[key] = value
531 return d1
532
533
534 def determine_base_flags():
535 flags = {
536 'libraries': [],
537 'include_dirs': [join(src_path, 'kivy', 'include')],
538 'library_dirs': [],
539 'extra_link_args': [],
540 'extra_compile_args': []}
541 if c_options['use_ios']:
542 sysroot = environ.get('IOSSDKROOT', environ.get('SDKROOT'))
543 if not sysroot:
544 raise Exception('IOSSDKROOT is not set')
545 flags['include_dirs'] += [sysroot]
546 flags['extra_compile_args'] += ['-isysroot', sysroot]
547 flags['extra_link_args'] += ['-isysroot', sysroot]
548 elif platform.startswith('freebsd'):
549 flags['include_dirs'] += [join(
550 environ.get('LOCALBASE', '/usr/local'), 'include')]
551 flags['library_dirs'] += [join(
552 environ.get('LOCALBASE', '/usr/local'), 'lib')]
553 elif platform == 'darwin':
554 v = os.uname()
555 if v[2] >= '13.0.0':
556 # use xcode-select to search on the right Xcode path
557 # XXX use the best SDK available instead of a specific one
558 import platform as _platform
559 xcode_dev = getoutput('xcode-select -p').splitlines()[0]
560 sdk_mac_ver = '.'.join(_platform.mac_ver()[0].split('.')[:2])
561 print('Xcode detected at {}, and using OS X{} sdk'.format(
562 xcode_dev, sdk_mac_ver))
563 sysroot = join(
564 xcode_dev.decode('utf-8'),
565 'Platforms/MacOSX.platform/Developer/SDKs',
566 'MacOSX{}.sdk'.format(sdk_mac_ver),
567 'System/Library/Frameworks')
568 else:
569 sysroot = ('/System/Library/Frameworks/'
570 'ApplicationServices.framework/Frameworks')
571 flags['extra_compile_args'] += ['-F%s' % sysroot]
572 flags['extra_link_args'] += ['-F%s' % sysroot]
573 elif platform == 'win32':
574 flags['include_dirs'] += [get_python_inc(prefix=sys.prefix)]
575 flags['library_dirs'] += [join(sys.prefix, "libs")]
576 return flags
577
578
579 def determine_gl_flags():
580 kivy_graphics_include = join(src_path, 'kivy', 'include')
581 flags = {'include_dirs': [kivy_graphics_include], 'libraries': []}
582 base_flags = {'include_dirs': [kivy_graphics_include], 'libraries': []}
583 if c_options['use_opengl_mock']:
584 return flags, base_flags
585 if platform == 'win32':
586 flags['libraries'] = ['opengl32', 'glew32']
587 elif platform == 'ios':
588 flags['libraries'] = ['GLESv2']
589 flags['extra_link_args'] = ['-framework', 'OpenGLES']
590 elif platform == 'darwin':
591 flags['extra_link_args'] = ['-framework', 'OpenGL', '-arch', osx_arch]
592 flags['extra_compile_args'] = ['-arch', osx_arch]
593 elif platform.startswith('freebsd'):
594 flags['libraries'] = ['GL']
595 elif platform.startswith('openbsd'):
596 flags['include_dirs'] = ['/usr/X11R6/include']
597 flags['library_dirs'] = ['/usr/X11R6/lib']
598 flags['libraries'] = ['GL']
599 elif platform == 'android':
600 flags['include_dirs'] = [join(ndkplatform, 'usr', 'include')]
601 flags['library_dirs'] = [join(ndkplatform, 'usr', 'lib')]
602 flags['libraries'] = ['GLESv2']
603 elif platform == 'rpi':
604 flags['include_dirs'] = [
605 '/opt/vc/include',
606 '/opt/vc/include/interface/vcos/pthreads',
607 '/opt/vc/include/interface/vmcs_host/linux']
608 flags['library_dirs'] = ['/opt/vc/lib']
609 brcm_lib_files = (
610 '/opt/vc/lib/libbrcmEGL.so',
611 '/opt/vc/lib/libbrcmGLESv2.so')
612 if all((exists(lib) for lib in brcm_lib_files)):
613 print(
614 'Found brcmEGL and brcmGLES library files'
615 'for rpi platform at /opt/vc/lib/')
616 gl_libs = ['brcmEGL', 'brcmGLESv2']
617 else:
618 print(
619 'Failed to find brcmEGL and brcmGLESv2 library files'
620 'for rpi platform, falling back to EGL and GLESv2.')
621 gl_libs = ['EGL', 'GLESv2']
622 flags['libraries'] = ['bcm_host'] + gl_libs
623 elif platform == 'mali':
624 flags['include_dirs'] = ['/usr/include/']
625 flags['library_dirs'] = ['/usr/lib/arm-linux-gnueabihf']
626 flags['libraries'] = ['GLESv2']
627 c_options['use_x11'] = True
628 c_options['use_egl'] = True
629 else:
630 flags['libraries'] = ['GL']
631 return flags, base_flags
632
633
634 def determine_sdl2():
635 flags = {}
636 if not c_options['use_sdl2']:
637 return flags
638
639 sdl2_path = environ.get('KIVY_SDL2_PATH', None)
640
641 if sdl2_flags and not sdl2_path and platform == 'darwin':
642 return sdl2_flags
643
644 # no pkgconfig info, or we want to use a specific sdl2 path, so perform
645 # manual configuration
646 flags['libraries'] = ['SDL2', 'SDL2_ttf', 'SDL2_image', 'SDL2_mixer']
647 split_chr = ';' if platform == 'win32' else ':'
648 sdl2_paths = sdl2_path.split(split_chr) if sdl2_path else []
649
650 if not sdl2_paths:
651 sdl_inc = join(sys.prefix, 'include', 'SDL2')
652 if isdir(sdl_inc):
653 sdl2_paths = [sdl_inc]
654 sdl2_paths.extend(['/usr/local/include/SDL2', '/usr/include/SDL2'])
655
656 flags['include_dirs'] = sdl2_paths
657 flags['extra_link_args'] = []
658 flags['extra_compile_args'] = []
659 flags['library_dirs'] = (
660 sdl2_paths if sdl2_paths else
661 ['/usr/local/lib/'])
662
663 if sdl2_flags:
664 flags = merge(flags, sdl2_flags)
665
666 # ensure headers for all the SDL2 and sub libraries are available
667 libs_to_check = ['SDL', 'SDL_mixer', 'SDL_ttf', 'SDL_image']
668 can_compile = True
669 for lib in libs_to_check:
670 found = False
671 for d in flags['include_dirs']:
672 fn = join(d, '{}.h'.format(lib))
673 if exists(fn):
674 found = True
675 print('SDL2: found {} header at {}'.format(lib, fn))
676 break
677
678 if not found:
679 print('SDL2: missing sub library {}'.format(lib))
680 can_compile = False
681
682 if not can_compile:
683 c_options['use_sdl2'] = False
684 return {}
685
686 return flags
687
688
689 base_flags = determine_base_flags()
690 gl_flags, gl_flags_base = determine_gl_flags()
691
692 # -----------------------------------------------------------------------------
693 # sources to compile
694 # all the dependencies have been found manually with:
695 # grep -inr -E '(cimport|include)' kivy/graphics/context_instructions.{pxd,pyx}
696 graphics_dependencies = {
697 'buffer.pyx': ['common.pxi'],
698 'context.pxd': ['instructions.pxd', 'texture.pxd', 'vbo.pxd', 'cgl.pxd'],
699 'cgl.pxd': ['common.pxi', 'config.pxi', 'gl_redirect.h'],
700 'compiler.pxd': ['instructions.pxd'],
701 'compiler.pyx': ['context_instructions.pxd'],
702 'cgl.pyx': ['cgl.pxd'],
703 'cgl_mock.pyx': ['cgl.pxd'],
704 'cgl_sdl2.pyx': ['cgl.pxd'],
705 'cgl_gl.pyx': ['cgl.pxd'],
706 'cgl_glew.pyx': ['cgl.pxd'],
707 'context_instructions.pxd': [
708 'transformation.pxd', 'instructions.pxd', 'texture.pxd'],
709 'fbo.pxd': ['cgl.pxd', 'instructions.pxd', 'texture.pxd'],
710 'fbo.pyx': [
711 'config.pxi', 'opcodes.pxi', 'transformation.pxd', 'context.pxd'],
712 'gl_instructions.pyx': [
713 'config.pxi', 'opcodes.pxi', 'cgl.pxd', 'instructions.pxd'],
714 'instructions.pxd': [
715 'vbo.pxd', 'context_instructions.pxd', 'compiler.pxd', 'shader.pxd',
716 'texture.pxd', '../_event.pxd'],
717 'instructions.pyx': [
718 'config.pxi', 'opcodes.pxi', 'cgl.pxd',
719 'context.pxd', 'common.pxi', 'vertex.pxd', 'transformation.pxd'],
720 'opengl.pyx': [
721 'config.pxi', 'common.pxi', 'cgl.pxd', 'gl_redirect.h'],
722 'opengl_utils.pyx': [
723 'opengl_utils_def.pxi', 'cgl.pxd', ],
724 'shader.pxd': ['cgl.pxd', 'transformation.pxd', 'vertex.pxd'],
725 'shader.pyx': [
726 'config.pxi', 'common.pxi', 'cgl.pxd',
727 'vertex.pxd', 'transformation.pxd', 'context.pxd',
728 'gl_debug_logger.pxi'],
729 'stencil_instructions.pxd': ['instructions.pxd'],
730 'stencil_instructions.pyx': [
731 'config.pxi', 'opcodes.pxi', 'cgl.pxd',
732 'gl_debug_logger.pxi'],
733 'scissor_instructions.pyx': [
734 'config.pxi', 'opcodes.pxi', 'cgl.pxd'],
735 'svg.pyx': ['config.pxi', 'common.pxi', 'texture.pxd', 'instructions.pxd',
736 'vertex_instructions.pxd', 'tesselator.pxd'],
737 'texture.pxd': ['cgl.pxd'],
738 'texture.pyx': [
739 'config.pxi', 'common.pxi', 'opengl_utils_def.pxi', 'context.pxd',
740 'cgl.pxd', 'opengl_utils.pxd',
741 'img_tools.pxi', 'gl_debug_logger.pxi'],
742 'vbo.pxd': ['buffer.pxd', 'cgl.pxd', 'vertex.pxd'],
743 'vbo.pyx': [
744 'config.pxi', 'common.pxi', 'context.pxd',
745 'instructions.pxd', 'shader.pxd', 'gl_debug_logger.pxi'],
746 'vertex.pxd': ['cgl.pxd'],
747 'vertex.pyx': ['config.pxi', 'common.pxi'],
748 'vertex_instructions.pyx': [
749 'config.pxi', 'common.pxi', 'vbo.pxd', 'vertex.pxd',
750 'instructions.pxd', 'vertex_instructions.pxd',
751 'cgl.pxd', 'texture.pxd', 'vertex_instructions_line.pxi'],
752 'vertex_instructions_line.pxi': ['stencil_instructions.pxd']}
753
754 sources = {
755 '_event.pyx': merge(base_flags, {'depends': ['properties.pxd']}),
756 '_clock.pyx': {},
757 'weakproxy.pyx': {},
758 'properties.pyx': merge(base_flags, {'depends': ['_event.pxd']}),
759 'graphics/buffer.pyx': merge(base_flags, gl_flags_base),
760 'graphics/context.pyx': merge(base_flags, gl_flags_base),
761 'graphics/compiler.pyx': merge(base_flags, gl_flags_base),
762 'graphics/context_instructions.pyx': merge(base_flags, gl_flags_base),
763 'graphics/fbo.pyx': merge(base_flags, gl_flags_base),
764 'graphics/gl_instructions.pyx': merge(base_flags, gl_flags_base),
765 'graphics/instructions.pyx': merge(base_flags, gl_flags_base),
766 'graphics/opengl.pyx': merge(base_flags, gl_flags_base),
767 'graphics/opengl_utils.pyx': merge(base_flags, gl_flags_base),
768 'graphics/shader.pyx': merge(base_flags, gl_flags_base),
769 'graphics/stencil_instructions.pyx': merge(base_flags, gl_flags_base),
770 'graphics/scissor_instructions.pyx': merge(base_flags, gl_flags_base),
771 'graphics/texture.pyx': merge(base_flags, gl_flags_base),
772 'graphics/transformation.pyx': merge(base_flags, gl_flags_base),
773 'graphics/vbo.pyx': merge(base_flags, gl_flags_base),
774 'graphics/vertex.pyx': merge(base_flags, gl_flags_base),
775 'graphics/vertex_instructions.pyx': merge(base_flags, gl_flags_base),
776 'graphics/cgl.pyx': merge(base_flags, gl_flags_base),
777 'graphics/cgl_backend/cgl_mock.pyx': merge(base_flags, gl_flags_base),
778 'graphics/cgl_backend/cgl_gl.pyx': merge(base_flags, gl_flags),
779 'graphics/cgl_backend/cgl_glew.pyx': merge(base_flags, gl_flags),
780 'graphics/cgl_backend/cgl_sdl2.pyx': merge(base_flags, gl_flags_base),
781 'graphics/cgl_backend/cgl_debug.pyx': merge(base_flags, gl_flags_base),
782 'core/text/text_layout.pyx': base_flags,
783 'core/window/window_info.pyx': base_flags,
784 'graphics/tesselator.pyx': merge(base_flags, {
785 'include_dirs': ['kivy/lib/libtess2/Include'],
786 'c_depends': [
787 'lib/libtess2/Source/bucketalloc.c',
788 'lib/libtess2/Source/dict.c',
789 'lib/libtess2/Source/geom.c',
790 'lib/libtess2/Source/mesh.c',
791 'lib/libtess2/Source/priorityq.c',
792 'lib/libtess2/Source/sweep.c',
793 'lib/libtess2/Source/tess.c'
794 ]
795 }),
796 'graphics/svg.pyx': merge(base_flags, gl_flags_base)
797 }
798
799 if c_options["use_sdl2"]:
800 sdl2_flags = determine_sdl2()
801
802 if c_options['use_sdl2'] and sdl2_flags:
803 sources['graphics/cgl_backend/cgl_sdl2.pyx'] = merge(
804 sources['graphics/cgl_backend/cgl_sdl2.pyx'], sdl2_flags)
805 sdl2_depends = {'depends': ['lib/sdl2.pxi']}
806 for source_file in ('core/window/_window_sdl2.pyx',
807 'core/image/_img_sdl2.pyx',
808 'core/text/_text_sdl2.pyx',
809 'core/audio/audio_sdl2.pyx',
810 'core/clipboard/_clipboard_sdl2.pyx'):
811 sources[source_file] = merge(
812 base_flags, sdl2_flags, sdl2_depends)
813
814 if platform in ('darwin', 'ios'):
815 # activate ImageIO provider for our core image
816 if platform == 'ios':
817 osx_flags = {'extra_link_args': [
818 '-framework', 'Foundation',
819 '-framework', 'UIKit',
820 '-framework', 'AudioToolbox',
821 '-framework', 'CoreGraphics',
822 '-framework', 'QuartzCore',
823 '-framework', 'ImageIO',
824 '-framework', 'Accelerate']}
825 else:
826 osx_flags = {'extra_link_args': [
827 '-framework', 'ApplicationServices']}
828 sources['core/image/img_imageio.pyx'] = merge(
829 base_flags, osx_flags)
830
831 if c_options['use_avfoundation']:
832 import platform as _platform
833 mac_ver = [int(x) for x in _platform.mac_ver()[0].split('.')[:2]]
834 if mac_ver >= [10, 7]:
835 osx_flags = {
836 'extra_link_args': ['-framework', 'AVFoundation'],
837 'extra_compile_args': ['-ObjC++'],
838 'depends': ['core/camera/camera_avfoundation_implem.m']}
839 sources['core/camera/camera_avfoundation.pyx'] = merge(
840 base_flags, osx_flags)
841 else:
842 print('AVFoundation cannot be used, OSX >= 10.7 is required')
843
844 if c_options['use_rpi']:
845 sources['lib/vidcore_lite/egl.pyx'] = merge(
846 base_flags, gl_flags)
847 sources['lib/vidcore_lite/bcm.pyx'] = merge(
848 base_flags, gl_flags)
849
850 if c_options['use_x11']:
851 libs = ['Xrender', 'X11']
852 if c_options['use_egl']:
853 libs += ['EGL']
854 else:
855 libs += ['GL']
856 sources['core/window/window_x11.pyx'] = merge(
857 base_flags, gl_flags, {
858 # FIXME add an option to depend on them but not compile them
859 # cause keytab is included in core, and core is included in
860 # window_x11
861 #
862 # 'depends': [
863 # 'core/window/window_x11_keytab.c',
864 # 'core/window/window_x11_core.c'],
865 'libraries': libs})
866
867 if c_options['use_gstreamer']:
868 sources['lib/gstplayer/_gstplayer.pyx'] = merge(
869 base_flags, gst_flags, {
870 'depends': ['lib/gstplayer/_gstplayer.h']})
871
872
873 # -----------------------------------------------------------------------------
874 # extension modules
875
876 def get_dependencies(name, deps=None):
877 if deps is None:
878 deps = []
879 for dep in graphics_dependencies.get(name, []):
880 if dep not in deps:
881 deps.append(dep)
882 get_dependencies(dep, deps)
883 return deps
884
885
886 def resolve_dependencies(fn, depends):
887 fn = basename(fn)
888 deps = []
889 get_dependencies(fn, deps)
890 get_dependencies(fn.replace('.pyx', '.pxd'), deps)
891
892 deps_final = []
893 paths_to_test = ['graphics', 'include']
894 for dep in deps:
895 found = False
896 for path in paths_to_test:
897 filename = expand(src_path, path, dep)
898 if exists(filename):
899 deps_final.append(filename)
900 found = True
901 break
902 if not found:
903 print('ERROR: Dependency for {} not resolved: {}'.format(
904 fn, dep
905 ))
906
907 return deps_final
908
909
910 def get_extensions_from_sources(sources):
911 ext_modules = []
912 if environ.get('KIVY_FAKE_BUILDEXT'):
913 print('Fake build_ext asked, will generate only .h/.c')
914 return ext_modules
915 for pyx, flags in sources.items():
916 is_graphics = pyx.startswith('graphics')
917 pyx = expand(src_path, pyx)
918 depends = [expand(src_path, x) for x in flags.pop('depends', [])]
919 c_depends = [expand(src_path, x) for x in flags.pop('c_depends', [])]
920 if not have_cython:
921 pyx = '%s.c' % pyx[:-4]
922 if is_graphics:
923 depends = resolve_dependencies(pyx, depends)
924 f_depends = [x for x in depends if x.rsplit('.', 1)[-1] in (
925 'c', 'cpp', 'm')]
926 module_name = get_modulename_from_file(pyx)
927 flags_clean = {'depends': depends}
928 for key, value in flags.items():
929 if len(value):
930 flags_clean[key] = value
931 ext_modules.append(CythonExtension(
932 module_name, [pyx] + f_depends + c_depends, **flags_clean))
933 return ext_modules
934
935
936 ext_modules = get_extensions_from_sources(sources)
937
938
939 # -----------------------------------------------------------------------------
940 # automatically detect data files
941 split_examples = int(environ.get('KIVY_SPLIT_EXAMPLES', '0'))
942 data_file_prefix = 'share/kivy-'
943 examples = {}
944 examples_allowed_ext = ('readme', 'py', 'wav', 'png', 'jpg', 'svg', 'json',
945 'avi', 'gif', 'txt', 'ttf', 'obj', 'mtl', 'kv', 'mpg',
946 'glsl', 'zip')
947 for root, subFolders, files in walk('examples'):
948 for fn in files:
949 ext = fn.split('.')[-1].lower()
950 if ext not in examples_allowed_ext:
951 continue
952 filename = join(root, fn)
953 directory = '%s%s' % (data_file_prefix, dirname(filename))
954 if directory not in examples:
955 examples[directory] = []
956 examples[directory].append(filename)
957
958 binary_deps = []
959 binary_deps_path = join(src_path, 'kivy', 'binary_deps')
960 if isdir(binary_deps_path):
961 for root, dirnames, filenames in walk(binary_deps_path):
962 for fname in filenames:
963 binary_deps.append(
964 join(root.replace(binary_deps_path, 'binary_deps'), fname))
965
966 # -----------------------------------------------------------------------------
967 # setup !
968 if not build_examples:
969 setup(
970 name='Kivy',
971 version=get_version(),
972 author='Kivy Team and other contributors',
973 author_email='[email protected]',
974 url='http://kivy.org',
975 license='MIT',
976 description=(
977 'A software library for rapid development of '
978 'hardware-accelerated multitouch applications.'),
979 ext_modules=ext_modules,
980 cmdclass=cmdclass,
981 packages=[
982 'kivy',
983 'kivy.adapters',
984 'kivy.core',
985 'kivy.core.audio',
986 'kivy.core.camera',
987 'kivy.core.clipboard',
988 'kivy.core.image',
989 'kivy.core.gl',
990 'kivy.core.spelling',
991 'kivy.core.text',
992 'kivy.core.video',
993 'kivy.core.window',
994 'kivy.deps',
995 'kivy.effects',
996 'kivy.graphics',
997 'kivy.graphics.cgl_backend',
998 'kivy.garden',
999 'kivy.input',
1000 'kivy.input.postproc',
1001 'kivy.input.providers',
1002 'kivy.lang',
1003 'kivy.lib',
1004 'kivy.lib.osc',
1005 'kivy.lib.gstplayer',
1006 'kivy.lib.vidcore_lite',
1007 'kivy.modules',
1008 'kivy.network',
1009 'kivy.storage',
1010 'kivy.tests',
1011 'kivy.tools',
1012 'kivy.tools.packaging',
1013 'kivy.tools.packaging.pyinstaller_hooks',
1014 'kivy.tools.highlight',
1015 'kivy.extras',
1016 'kivy.uix',
1017 'kivy.uix.behaviors',
1018 'kivy.uix.recycleview',
1019 ],
1020 package_dir={'kivy': 'kivy'},
1021 package_data={'kivy': [
1022 '*.pxd',
1023 '*.pxi',
1024 'core/text/*.pxd',
1025 'core/text/*.pxi',
1026 'core/window/*.pxi',
1027 'core/window/*.pxd',
1028 'graphics/*.pxd',
1029 'graphics/*.pxi',
1030 'graphics/*.h',
1031 'include/*',
1032 'lib/vidcore_lite/*.pxd',
1033 'lib/vidcore_lite/*.pxi',
1034 'data/*.kv',
1035 'data/*.json',
1036 'data/fonts/*.ttf',
1037 'data/images/*.png',
1038 'data/images/*.jpg',
1039 'data/images/*.gif',
1040 'data/images/*.atlas',
1041 'data/keyboards/*.json',
1042 'data/logo/*.png',
1043 'data/glsl/*.png',
1044 'data/glsl/*.vs',
1045 'data/glsl/*.fs',
1046 'tests/*.zip',
1047 'tests/*.kv',
1048 'tests/*.png',
1049 'tests/*.ttf',
1050 'tests/*.ogg',
1051 'tools/gles_compat/*',
1052 'tools/highlight/*',
1053 'tools/packaging/README.txt',
1054 'tools/packaging/win32/kivy.bat',
1055 'tools/packaging/win32/kivyenv.sh',
1056 'tools/packaging/win32/README.txt',
1057 'tools/packaging/osx/Info.plist',
1058 'tools/packaging/osx/InfoPlist.strings',
1059 'tools/packaging/osx/kivy.sh',
1060 'tools/pep8checker/*',
1061 'tools/theming/defaulttheme/*',
1062 ] + binary_deps},
1063 data_files=[] if split_examples else list(examples.items()),
1064 classifiers=[
1065 'Development Status :: 5 - Production/Stable',
1066 'Environment :: MacOS X',
1067 'Environment :: Win32 (MS Windows)',
1068 'Environment :: X11 Applications',
1069 'Intended Audience :: Developers',
1070 'Intended Audience :: End Users/Desktop',
1071 'Intended Audience :: Information Technology',
1072 'Intended Audience :: Science/Research',
1073 'License :: OSI Approved :: MIT License',
1074 'Natural Language :: English',
1075 'Operating System :: MacOS :: MacOS X',
1076 'Operating System :: Microsoft :: Windows',
1077 'Operating System :: POSIX :: BSD :: FreeBSD',
1078 'Operating System :: POSIX :: Linux',
1079 'Programming Language :: Python :: 2.7',
1080 'Programming Language :: Python :: 3.3',
1081 'Programming Language :: Python :: 3.4',
1082 'Programming Language :: Python :: 3.5',
1083 'Programming Language :: Python :: 3.6',
1084 'Topic :: Artistic Software',
1085 'Topic :: Games/Entertainment',
1086 'Topic :: Multimedia :: Graphics :: 3D Rendering',
1087 'Topic :: Multimedia :: Graphics :: Capture :: Digital Camera',
1088 'Topic :: Multimedia :: Graphics :: Presentation',
1089 'Topic :: Multimedia :: Graphics :: Viewers',
1090 'Topic :: Multimedia :: Sound/Audio :: Players :: MP3',
1091 'Topic :: Multimedia :: Video :: Display',
1092 'Topic :: Scientific/Engineering :: Human Machine Interfaces',
1093 'Topic :: Scientific/Engineering :: Visualization',
1094 ('Topic :: Software Development :: Libraries :: '
1095 'Application Frameworks'),
1096 'Topic :: Software Development :: User Interfaces'],
1097 dependency_links=[
1098 'https://github.com/kivy-garden/garden/archive/master.zip'],
1099 install_requires=['Kivy-Garden>=0.1.4', 'docutils', 'pygments'],
1100 setup_requires=[
1101 'cython>=' + MIN_CYTHON_STRING
1102 ] if not skip_cython else [])
1103 else:
1104 setup(
1105 name='Kivy-examples',
1106 version=get_version(),
1107 author='Kivy Team and other contributors',
1108 author_email='[email protected]',
1109 url='http://kivy.org',
1110 license='MIT',
1111 description=('Kivy examples.'),
1112 data_files=list(examples.items()))
1113
```
--- 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
@@ -1019,6 +1019,7 @@
],
package_dir={'kivy': 'kivy'},
package_data={'kivy': [
+ 'setupconfig.py'
'*.pxd',
'*.pxi',
'core/text/*.pxd',
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -1019,6 +1019,7 @@\n ],\n package_dir={'kivy': 'kivy'},\n package_data={'kivy': [\n+ 'setupconfig.py'\n '*.pxd',\n '*.pxi',\n 'core/text/*.pxd',\n", "issue": "No module named kivy.setupconfig\nHi,\n\nWhen installing Kivy 1.9.1 as a dependency of one of my packages I get the error\n`ImportError: No module named 'kivy.setupconfig`.\n\nMy setup.py file looks like this and installs without errors:\n\n```\nfrom setuptools import setup\nCYTHON_REQ = \"cython==0.23.4\"\nsetup(\n name = 'MyApp',\n version = \"0.1.0\",\n author = \"MelleB\",\n setup_requires = [ CYTHON_REQ ],\n install_requires = [ CYTHON_REQ, 'kivy==1.9.1' ]\n)\n```\n\nDuring the build, the following line is displayed:\n`Updated /tmp/easy_install-4drozlb6/kivy-1.9.1/kivy/setupconfig.py`\n\nAfter digging into kivy's setup.py, I noticed the setupconfig.py file is generated. \nFrom my understanding it seems the setupconfig.py isn't part of the mItanifest.\n\nA possible solution might be to add a 'setupconfig.py' entry to the setup's package_data (In https://github.com/kivy/kivy/blob/fddade6ce3b8a3be77d22cd3f973c9c930799874/setup.py#L959)\n\nI found a possibliy related bug + PR in #2850\n# Environment\n\nPlatform: Ubuntu 16.04LTS\nKivy: 1.9.1\nPython: 3.5.1\n# Steps to reproduce\n\n```\n$ pyenv intall 3.5.1\n$ pyenv virtualenv 3.5.1 kivy-setupconfig-issue\n$ mkdir kivy-setupconfig-issue && cd kivy-setupconfig-issue\n$ pyenv local kivy-setupconfig-issue\n$ cat > setup.py\nfrom setuptools import setup\nCYTHON_REQ = \"cython==0.23.4\"\nsetup(\n name = 'MyApp',\n version = \"0.1.0\",\n author = \"MelleB\",\n setup_requires = [ CYTHON_REQ ],\n install_requires = [ CYTHON_REQ, 'kivy==1.9.1' ]\n)\n\n$ python setup.py install\n```\n\nAfter that, the issue can be confirmed with:\n\n```\n$ python\nPython 3.5.1 (default, May 30 2016, 14:49:00) \n[GCC 5.3.1 20160413] on linux\nType \"help\", \"copyright\", \"credits\" or \"license\" for more information.\n>>> import kivy\n[INFO ] [Logger ] Record log in /home/melle/.kivy/logs/kivy_16-06-02_1.txt\n[INFO ] [Kivy ] v1.9.1\n[INFO ] [Python ] v3.5.1 (default, May 30 2016, 14:49:00) \n[GCC 5.3.1 20160413]\n>>> import kivy.setupconfig\n Traceback (most recent call last):\n File \"<stdin>\", line 1, in <module>\n ImportError: No module named 'kivy.setupconfig'\n>>>\n```\n\nIf you have any further questions, please let me know.\n\n", "before_files": [{"content": "#\n# Kivy - Cross-platform UI framework\n# https://kivy.org/\n#\nfrom __future__ import print_function\n\nimport sys\nbuild_examples = False\nif \"--build_examples\" in sys.argv:\n build_examples = True\n sys.argv.remove(\"--build_examples\")\n\nfrom copy import deepcopy\nimport os\nfrom os.path import join, dirname, sep, exists, basename, isdir\nfrom os import walk, environ\nfrom distutils.version import LooseVersion\nfrom distutils.sysconfig import get_python_inc\nfrom collections import OrderedDict\nfrom time import sleep\nfrom subprocess import check_output, CalledProcessError\nfrom datetime import datetime\n\nif environ.get('KIVY_USE_SETUPTOOLS'):\n from setuptools import setup, Extension\n print('Using setuptools')\nelse:\n from distutils.core import setup\n from distutils.extension import Extension\n print('Using distutils')\n\n\nPY3 = sys.version > '3'\n\nif PY3: # fix error with py3's LooseVersion comparisons\n def ver_equal(self, other):\n return self.version == other\n\n LooseVersion.__eq__ = ver_equal\n\n\ndef get_version(filename='kivy/version.py'):\n VERSION = kivy.__version__\n DATE = datetime.utcnow().strftime('%Y%m%d')\n try:\n GIT_REVISION = check_output(\n ['git', 'rev-parse', 'HEAD']\n ).strip().decode('ascii')\n except (CalledProcessError, OSError, IOError) as e:\n # CalledProcessError has no errno\n errno = getattr(e, 'errno', None)\n if errno != 2 and 'CalledProcessError' not in repr(e):\n raise\n GIT_REVISION = \"Unknown\"\n\n cnt = (\n \"# THIS FILE IS GENERATED FROM KIVY SETUP.PY\\n\"\n \"__version__ = '%(version)s'\\n\"\n \"__hash__ = '%(hash)s'\\n\"\n \"__date__ = '%(date)s'\\n\"\n )\n\n with open(filename, 'w') as f:\n f.write(cnt % {\n 'version': VERSION,\n 'hash': GIT_REVISION,\n 'date': DATE\n })\n return VERSION\n\n\nMIN_CYTHON_STRING = '0.23'\nMIN_CYTHON_VERSION = LooseVersion(MIN_CYTHON_STRING)\nMAX_CYTHON_STRING = '0.27.3'\nMAX_CYTHON_VERSION = LooseVersion(MAX_CYTHON_STRING)\nCYTHON_UNSUPPORTED = (\n # ref https://github.com/cython/cython/issues/1968\n '0.27', '0.27.2'\n)\n\n\ndef getoutput(cmd, env=None):\n import subprocess\n p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE,\n stderr=subprocess.PIPE, env=env)\n p.wait()\n if p.returncode: # if not returncode == 0\n print('WARNING: A problem occurred while running {0} (code {1})\\n'\n .format(cmd, p.returncode))\n stderr_content = p.stderr.read()\n if stderr_content:\n print('{0}\\n'.format(stderr_content))\n return \"\"\n return p.stdout.read()\n\n\ndef pkgconfig(*packages, **kw):\n flag_map = {'-I': 'include_dirs', '-L': 'library_dirs', '-l': 'libraries'}\n lenviron = None\n pconfig = join(sys.prefix, 'libs', 'pkgconfig')\n\n if isdir(pconfig):\n lenviron = environ.copy()\n lenviron['PKG_CONFIG_PATH'] = '{};{}'.format(\n environ.get('PKG_CONFIG_PATH', ''), pconfig)\n cmd = 'pkg-config --libs --cflags {}'.format(' '.join(packages))\n results = getoutput(cmd, lenviron).split()\n for token in results:\n ext = token[:2].decode('utf-8')\n flag = flag_map.get(ext)\n if not flag:\n continue\n kw.setdefault(flag, []).append(token[2:].decode('utf-8'))\n return kw\n\n\n# -----------------------------------------------------------------------------\n# Determine on which platform we are\n\nplatform = sys.platform\n\n# Detect 32/64bit for OSX (http://stackoverflow.com/a/1405971/798575)\nif sys.platform == 'darwin':\n if sys.maxsize > 2 ** 32:\n osx_arch = 'x86_64'\n else:\n osx_arch = 'i386'\n\n# Detect Python for android project (http://github.com/kivy/python-for-android)\nndkplatform = environ.get('NDKPLATFORM')\nif ndkplatform is not None and environ.get('LIBLINK'):\n platform = 'android'\nkivy_ios_root = environ.get('KIVYIOSROOT', None)\nif kivy_ios_root is not None:\n platform = 'ios'\nif exists('/opt/vc/include/bcm_host.h'):\n platform = 'rpi'\nif exists('/usr/lib/arm-linux-gnueabihf/libMali.so'):\n platform = 'mali'\n\n# -----------------------------------------------------------------------------\n# Detect options\n#\nc_options = OrderedDict()\nc_options['use_rpi'] = platform == 'rpi'\nc_options['use_mali'] = platform == 'mali'\nc_options['use_egl'] = False\nc_options['use_opengl_es2'] = None\nc_options['use_opengl_mock'] = environ.get('READTHEDOCS', None) == 'True'\nc_options['use_sdl2'] = None\nc_options['use_ios'] = False\nc_options['use_mesagl'] = False\nc_options['use_x11'] = False\nc_options['use_wayland'] = False\nc_options['use_gstreamer'] = None\nc_options['use_avfoundation'] = platform == 'darwin'\nc_options['use_osx_frameworks'] = platform == 'darwin'\nc_options['debug_gl'] = False\n\n# now check if environ is changing the default values\nfor key in list(c_options.keys()):\n ukey = key.upper()\n if ukey in environ:\n value = bool(int(environ[ukey]))\n print('Environ change {0} -> {1}'.format(key, value))\n c_options[key] = value\n\n\n# -----------------------------------------------------------------------------\n# Cython check\n# on python-for-android and kivy-ios, cython usage is external\n\ncython_unsupported_append = '''\n\n Please note that the following versions of Cython are not supported\n at all: {}\n'''.format(', '.join(map(str, CYTHON_UNSUPPORTED)))\n\ncython_min = '''\\\n This version of Cython is not compatible with Kivy. Please upgrade to\n at least version {0}, preferably the newest supported version {1}.\n\n If your platform provides a Cython package, make sure you have upgraded\n to the newest version. If the newest version available is still too low,\n please remove it and install the newest supported Cython via pip:\n\n pip install -I Cython=={1}{2}\\\n'''.format(MIN_CYTHON_STRING, MAX_CYTHON_STRING,\n cython_unsupported_append if CYTHON_UNSUPPORTED else '')\n\ncython_max = '''\\\n This version of Cython is untested with Kivy. While this version may\n work perfectly fine, it is possible that you may experience issues. If\n you do have issues, please downgrade to a supported version. It is\n best to use the newest supported version, {1}, but the minimum\n supported version is {0}.\n\n If your platform provides a Cython package, check if you can downgrade\n to a supported version. Otherwise, uninstall the platform package and\n install Cython via pip:\n\n pip install -I Cython=={1}{2}\\\n'''.format(MIN_CYTHON_STRING, MAX_CYTHON_STRING,\n cython_unsupported_append if CYTHON_UNSUPPORTED else '')\n\ncython_unsupported = '''\\\n This version of Cython suffers from known bugs and is unsupported.\n Please install the newest supported version, {1}, if possible, but\n the minimum supported version is {0}.\n\n If your platform provides a Cython package, check if you can install\n a supported version. Otherwise, uninstall the platform package and\n install Cython via pip:\n\n pip install -I Cython=={1}{2}\\\n'''.format(MIN_CYTHON_STRING, MAX_CYTHON_STRING,\n cython_unsupported_append)\n\nhave_cython = False\nskip_cython = False\nif platform in ('ios', 'android'):\n print('\\nCython check avoided.')\n skip_cython = True\nelse:\n try:\n # check for cython\n from Cython.Distutils import build_ext\n have_cython = True\n import Cython\n cy_version_str = Cython.__version__\n cy_ver = LooseVersion(cy_version_str)\n print('\\nDetected Cython version {}'.format(cy_version_str))\n if cy_ver < MIN_CYTHON_VERSION:\n print(cython_min)\n raise ImportError('Incompatible Cython Version')\n if cy_ver in CYTHON_UNSUPPORTED:\n print(cython_unsupported)\n raise ImportError('Incompatible Cython Version')\n if cy_ver > MAX_CYTHON_VERSION:\n print(cython_max)\n sleep(1)\n except ImportError:\n print(\"\\nCython is missing, it's required for compiling kivy !\\n\\n\")\n raise\n\nif not have_cython:\n from distutils.command.build_ext import build_ext\n\n# -----------------------------------------------------------------------------\n# Setup classes\n\n# the build path where kivy is being compiled\nsrc_path = build_path = dirname(__file__)\n\n\nclass KivyBuildExt(build_ext):\n\n def finalize_options(self):\n retval = build_ext.finalize_options(self)\n global build_path\n if (self.build_lib is not None and exists(self.build_lib) and\n not self.inplace):\n build_path = self.build_lib\n return retval\n\n def build_extensions(self):\n # build files\n config_h_fn = ('include', 'config.h')\n config_pxi_fn = ('include', 'config.pxi')\n config_py_fn = ('setupconfig.py', )\n\n # generate headers\n config_h = '// Autogenerated file for Kivy C configuration\\n'\n config_h += '#define __PY3 {0}\\n'.format(int(PY3))\n config_pxi = '# Autogenerated file for Kivy Cython configuration\\n'\n config_pxi += 'DEF PY3 = {0}\\n'.format(int(PY3))\n config_py = '# Autogenerated file for Kivy configuration\\n'\n config_py += 'PY3 = {0}\\n'.format(int(PY3))\n config_py += 'CYTHON_MIN = {0}\\nCYTHON_MAX = {1}\\n'.format(\n repr(MIN_CYTHON_STRING), repr(MAX_CYTHON_STRING))\n config_py += 'CYTHON_BAD = {0}\\n'.format(repr(', '.join(map(\n str, CYTHON_UNSUPPORTED))))\n\n # generate content\n print('Build configuration is:')\n for opt, value in c_options.items():\n value = int(bool(value))\n print(' * {0} = {1}'.format(opt, value))\n opt = opt.upper()\n config_h += '#define __{0} {1}\\n'.format(opt, value)\n config_pxi += 'DEF {0} = {1}\\n'.format(opt, value)\n config_py += '{0} = {1}\\n'.format(opt, value)\n debug = bool(self.debug)\n print(' * debug = {0}'.format(debug))\n\n config_pxi += 'DEF DEBUG = {0}\\n'.format(debug)\n config_py += 'DEBUG = {0}\\n'.format(debug)\n config_pxi += 'DEF PLATFORM = \"{0}\"\\n'.format(platform)\n config_py += 'PLATFORM = \"{0}\"\\n'.format(platform)\n for fn, content in (\n (config_h_fn, config_h), (config_pxi_fn, config_pxi),\n (config_py_fn, config_py)):\n build_fn = expand(build_path, *fn)\n if self.update_if_changed(build_fn, content):\n print('Updated {}'.format(build_fn))\n src_fn = expand(src_path, *fn)\n if src_fn != build_fn and self.update_if_changed(src_fn, content):\n print('Updated {}'.format(src_fn))\n\n c = self.compiler.compiler_type\n print('Detected compiler is {}'.format(c))\n if c != 'msvc':\n for e in self.extensions:\n e.extra_link_args += ['-lm']\n\n build_ext.build_extensions(self)\n\n def update_if_changed(self, fn, content):\n need_update = True\n if exists(fn):\n with open(fn) as fd:\n need_update = fd.read() != content\n if need_update:\n with open(fn, 'w') as fd:\n fd.write(content)\n return need_update\n\n\ndef _check_and_fix_sdl2_mixer(f_path):\n print(\"Check if SDL2_mixer smpeg2 have an @executable_path\")\n rpath_from = (\"@executable_path/../Frameworks/SDL2.framework\"\n \"/Versions/A/SDL2\")\n rpath_to = \"@rpath/../../../../SDL2.framework/Versions/A/SDL2\"\n smpeg2_path = (\"{}/Versions/A/Frameworks/smpeg2.framework\"\n \"/Versions/A/smpeg2\").format(f_path)\n output = getoutput((\"otool -L '{}'\").format(smpeg2_path)).decode('utf-8')\n if \"@executable_path\" not in output:\n return\n\n print(\"WARNING: Your SDL2_mixer version is invalid\")\n print(\"WARNING: The smpeg2 framework embedded in SDL2_mixer contains a\")\n print(\"WARNING: reference to @executable_path that will fail the\")\n print(\"WARNING: execution of your application.\")\n print(\"WARNING: We are going to change:\")\n print(\"WARNING: from: {}\".format(rpath_from))\n print(\"WARNING: to: {}\".format(rpath_to))\n getoutput(\"install_name_tool -change {} {} {}\".format(\n rpath_from, rpath_to, smpeg2_path))\n\n output = getoutput((\"otool -L '{}'\").format(smpeg2_path))\n if b\"@executable_path\" not in output:\n print(\"WARNING: Change successfully applied!\")\n print(\"WARNING: You'll never see this message again.\")\n else:\n print(\"WARNING: Unable to apply the changes, sorry.\")\n\n\n# -----------------------------------------------------------------------------\n# extract version (simulate doc generation, kivy will be not imported)\nenviron['KIVY_DOC_INCLUDE'] = '1'\nimport kivy\n\n# extra build commands go in the cmdclass dict {'command-name': CommandClass}\n# see tools.packaging.{platform}.build.py for custom build commands for\n# portable packages. Also e.g. we use build_ext command from cython if its\n# installed for c extensions.\nfrom kivy.tools.packaging.factory import FactoryBuild\ncmdclass = {\n 'build_factory': FactoryBuild,\n 'build_ext': KivyBuildExt}\n\ntry:\n # add build rules for portable packages to cmdclass\n if platform == 'win32':\n from kivy.tools.packaging.win32.build import WindowsPortableBuild\n cmdclass['build_portable'] = WindowsPortableBuild\n elif platform == 'darwin':\n from kivy.tools.packaging.osx.build import OSXPortableBuild\n cmdclass['build_portable'] = OSXPortableBuild\nexcept ImportError:\n print('User distribution detected, avoid portable command.')\n\n# Detect which opengl version headers to use\nif platform in ('android', 'darwin', 'ios', 'rpi', 'mali'):\n c_options['use_opengl_es2'] = True\nelif c_options['use_opengl_es2'] is None:\n c_options['use_opengl_es2'] = \\\n environ.get('KIVY_GRAPHICS', '').lower() == 'gles'\n\nprint('Using this graphics system: {}'.format(\n ['OpenGL', 'OpenGL ES 2'][int(c_options['use_opengl_es2'] or False)]))\n\n# check if we are in a kivy-ios build\nif platform == 'ios':\n print('Kivy-IOS project environment detect, use it.')\n print('Kivy-IOS project located at {0}'.format(kivy_ios_root))\n c_options['use_ios'] = True\n c_options['use_sdl2'] = True\n\nelif platform == 'darwin':\n if c_options['use_osx_frameworks']:\n if osx_arch == \"i386\":\n print(\"Warning: building with frameworks fail on i386\")\n else:\n print(\"OSX framework used, force to x86_64 only\")\n environ[\"ARCHFLAGS\"] = environ.get(\"ARCHFLAGS\", \"-arch x86_64\")\n print(\"OSX ARCHFLAGS are: {}\".format(environ[\"ARCHFLAGS\"]))\n\n# detect gstreamer, only on desktop\n# works if we forced the options or in autodetection\nif platform not in ('ios', 'android') and (c_options['use_gstreamer']\n in (None, True)):\n gstreamer_valid = False\n if c_options['use_osx_frameworks'] and platform == 'darwin':\n # check the existence of frameworks\n f_path = '/Library/Frameworks/GStreamer.framework'\n if not exists(f_path):\n c_options['use_gstreamer'] = False\n print('GStreamer framework not found, fallback on pkg-config')\n else:\n print('GStreamer framework found')\n gstreamer_valid = True\n c_options['use_gstreamer'] = True\n gst_flags = {\n 'extra_link_args': [\n '-F/Library/Frameworks',\n '-Xlinker', '-rpath',\n '-Xlinker', '/Library/Frameworks',\n '-Xlinker', '-headerpad',\n '-Xlinker', '190',\n '-framework', 'GStreamer'],\n 'include_dirs': [join(f_path, 'Headers')]}\n\n if not gstreamer_valid:\n # use pkg-config approach instead\n gst_flags = pkgconfig('gstreamer-1.0')\n if 'libraries' in gst_flags:\n print('GStreamer found via pkg-config')\n c_options['use_gstreamer'] = True\n\n\n# detect SDL2, only on desktop and iOS, or android if explicitly enabled\n# works if we forced the options or in autodetection\nsdl2_flags = {}\nif c_options['use_sdl2'] or (\n platform not in ('android',) and c_options['use_sdl2'] is None):\n\n sdl2_valid = False\n if c_options['use_osx_frameworks'] and platform == 'darwin':\n # check the existence of frameworks\n sdl2_valid = True\n sdl2_flags = {\n 'extra_link_args': [\n '-F/Library/Frameworks',\n '-Xlinker', '-rpath',\n '-Xlinker', '/Library/Frameworks',\n '-Xlinker', '-headerpad',\n '-Xlinker', '190'],\n 'include_dirs': [],\n 'extra_compile_args': ['-F/Library/Frameworks']\n }\n for name in ('SDL2', 'SDL2_ttf', 'SDL2_image', 'SDL2_mixer'):\n f_path = '/Library/Frameworks/{}.framework'.format(name)\n if not exists(f_path):\n print('Missing framework {}'.format(f_path))\n sdl2_valid = False\n continue\n sdl2_flags['extra_link_args'] += ['-framework', name]\n sdl2_flags['include_dirs'] += [join(f_path, 'Headers')]\n print('Found sdl2 frameworks: {}'.format(f_path))\n if name == 'SDL2_mixer':\n _check_and_fix_sdl2_mixer(f_path)\n\n if not sdl2_valid:\n c_options['use_sdl2'] = False\n print('SDL2 frameworks not found, fallback on pkg-config')\n else:\n c_options['use_sdl2'] = True\n print('Activate SDL2 compilation')\n\n if not sdl2_valid and platform != \"ios\":\n # use pkg-config approach instead\n sdl2_flags = pkgconfig('sdl2', 'SDL2_ttf', 'SDL2_image', 'SDL2_mixer')\n if 'libraries' in sdl2_flags:\n print('SDL2 found via pkg-config')\n c_options['use_sdl2'] = True\n\n\n# -----------------------------------------------------------------------------\n# declare flags\n\n\ndef get_modulename_from_file(filename):\n filename = filename.replace(sep, '/')\n pyx = '.'.join(filename.split('.')[:-1])\n pyxl = pyx.split('/')\n while pyxl[0] != 'kivy':\n pyxl.pop(0)\n if pyxl[1] == 'kivy':\n pyxl.pop(0)\n return '.'.join(pyxl)\n\n\ndef expand(root, *args):\n return join(root, 'kivy', *args)\n\n\nclass CythonExtension(Extension):\n\n def __init__(self, *args, **kwargs):\n Extension.__init__(self, *args, **kwargs)\n self.cython_directives = {\n 'c_string_encoding': 'utf-8',\n 'profile': 'USE_PROFILE' in environ,\n 'embedsignature': 'USE_EMBEDSIGNATURE' in environ}\n # XXX with pip, setuptools is imported before distutils, and change\n # our pyx to c, then, cythonize doesn't happen. So force again our\n # sources\n self.sources = args[1]\n\n\ndef merge(d1, *args):\n d1 = deepcopy(d1)\n for d2 in args:\n for key, value in d2.items():\n value = deepcopy(value)\n if key in d1:\n d1[key].extend(value)\n else:\n d1[key] = value\n return d1\n\n\ndef determine_base_flags():\n flags = {\n 'libraries': [],\n 'include_dirs': [join(src_path, 'kivy', 'include')],\n 'library_dirs': [],\n 'extra_link_args': [],\n 'extra_compile_args': []}\n if c_options['use_ios']:\n sysroot = environ.get('IOSSDKROOT', environ.get('SDKROOT'))\n if not sysroot:\n raise Exception('IOSSDKROOT is not set')\n flags['include_dirs'] += [sysroot]\n flags['extra_compile_args'] += ['-isysroot', sysroot]\n flags['extra_link_args'] += ['-isysroot', sysroot]\n elif platform.startswith('freebsd'):\n flags['include_dirs'] += [join(\n environ.get('LOCALBASE', '/usr/local'), 'include')]\n flags['library_dirs'] += [join(\n environ.get('LOCALBASE', '/usr/local'), 'lib')]\n elif platform == 'darwin':\n v = os.uname()\n if v[2] >= '13.0.0':\n # use xcode-select to search on the right Xcode path\n # XXX use the best SDK available instead of a specific one\n import platform as _platform\n xcode_dev = getoutput('xcode-select -p').splitlines()[0]\n sdk_mac_ver = '.'.join(_platform.mac_ver()[0].split('.')[:2])\n print('Xcode detected at {}, and using OS X{} sdk'.format(\n xcode_dev, sdk_mac_ver))\n sysroot = join(\n xcode_dev.decode('utf-8'),\n 'Platforms/MacOSX.platform/Developer/SDKs',\n 'MacOSX{}.sdk'.format(sdk_mac_ver),\n 'System/Library/Frameworks')\n else:\n sysroot = ('/System/Library/Frameworks/'\n 'ApplicationServices.framework/Frameworks')\n flags['extra_compile_args'] += ['-F%s' % sysroot]\n flags['extra_link_args'] += ['-F%s' % sysroot]\n elif platform == 'win32':\n flags['include_dirs'] += [get_python_inc(prefix=sys.prefix)]\n flags['library_dirs'] += [join(sys.prefix, \"libs\")]\n return flags\n\n\ndef determine_gl_flags():\n kivy_graphics_include = join(src_path, 'kivy', 'include')\n flags = {'include_dirs': [kivy_graphics_include], 'libraries': []}\n base_flags = {'include_dirs': [kivy_graphics_include], 'libraries': []}\n if c_options['use_opengl_mock']:\n return flags, base_flags\n if platform == 'win32':\n flags['libraries'] = ['opengl32', 'glew32']\n elif platform == 'ios':\n flags['libraries'] = ['GLESv2']\n flags['extra_link_args'] = ['-framework', 'OpenGLES']\n elif platform == 'darwin':\n flags['extra_link_args'] = ['-framework', 'OpenGL', '-arch', osx_arch]\n flags['extra_compile_args'] = ['-arch', osx_arch]\n elif platform.startswith('freebsd'):\n flags['libraries'] = ['GL']\n elif platform.startswith('openbsd'):\n flags['include_dirs'] = ['/usr/X11R6/include']\n flags['library_dirs'] = ['/usr/X11R6/lib']\n flags['libraries'] = ['GL']\n elif platform == 'android':\n flags['include_dirs'] = [join(ndkplatform, 'usr', 'include')]\n flags['library_dirs'] = [join(ndkplatform, 'usr', 'lib')]\n flags['libraries'] = ['GLESv2']\n elif platform == 'rpi':\n flags['include_dirs'] = [\n '/opt/vc/include',\n '/opt/vc/include/interface/vcos/pthreads',\n '/opt/vc/include/interface/vmcs_host/linux']\n flags['library_dirs'] = ['/opt/vc/lib']\n brcm_lib_files = (\n '/opt/vc/lib/libbrcmEGL.so',\n '/opt/vc/lib/libbrcmGLESv2.so')\n if all((exists(lib) for lib in brcm_lib_files)):\n print(\n 'Found brcmEGL and brcmGLES library files'\n 'for rpi platform at /opt/vc/lib/')\n gl_libs = ['brcmEGL', 'brcmGLESv2']\n else:\n print(\n 'Failed to find brcmEGL and brcmGLESv2 library files'\n 'for rpi platform, falling back to EGL and GLESv2.')\n gl_libs = ['EGL', 'GLESv2']\n flags['libraries'] = ['bcm_host'] + gl_libs\n elif platform == 'mali':\n flags['include_dirs'] = ['/usr/include/']\n flags['library_dirs'] = ['/usr/lib/arm-linux-gnueabihf']\n flags['libraries'] = ['GLESv2']\n c_options['use_x11'] = True\n c_options['use_egl'] = True\n else:\n flags['libraries'] = ['GL']\n return flags, base_flags\n\n\ndef determine_sdl2():\n flags = {}\n if not c_options['use_sdl2']:\n return flags\n\n sdl2_path = environ.get('KIVY_SDL2_PATH', None)\n\n if sdl2_flags and not sdl2_path and platform == 'darwin':\n return sdl2_flags\n\n # no pkgconfig info, or we want to use a specific sdl2 path, so perform\n # manual configuration\n flags['libraries'] = ['SDL2', 'SDL2_ttf', 'SDL2_image', 'SDL2_mixer']\n split_chr = ';' if platform == 'win32' else ':'\n sdl2_paths = sdl2_path.split(split_chr) if sdl2_path else []\n\n if not sdl2_paths:\n sdl_inc = join(sys.prefix, 'include', 'SDL2')\n if isdir(sdl_inc):\n sdl2_paths = [sdl_inc]\n sdl2_paths.extend(['/usr/local/include/SDL2', '/usr/include/SDL2'])\n\n flags['include_dirs'] = sdl2_paths\n flags['extra_link_args'] = []\n flags['extra_compile_args'] = []\n flags['library_dirs'] = (\n sdl2_paths if sdl2_paths else\n ['/usr/local/lib/'])\n\n if sdl2_flags:\n flags = merge(flags, sdl2_flags)\n\n # ensure headers for all the SDL2 and sub libraries are available\n libs_to_check = ['SDL', 'SDL_mixer', 'SDL_ttf', 'SDL_image']\n can_compile = True\n for lib in libs_to_check:\n found = False\n for d in flags['include_dirs']:\n fn = join(d, '{}.h'.format(lib))\n if exists(fn):\n found = True\n print('SDL2: found {} header at {}'.format(lib, fn))\n break\n\n if not found:\n print('SDL2: missing sub library {}'.format(lib))\n can_compile = False\n\n if not can_compile:\n c_options['use_sdl2'] = False\n return {}\n\n return flags\n\n\nbase_flags = determine_base_flags()\ngl_flags, gl_flags_base = determine_gl_flags()\n\n# -----------------------------------------------------------------------------\n# sources to compile\n# all the dependencies have been found manually with:\n# grep -inr -E '(cimport|include)' kivy/graphics/context_instructions.{pxd,pyx}\ngraphics_dependencies = {\n 'buffer.pyx': ['common.pxi'],\n 'context.pxd': ['instructions.pxd', 'texture.pxd', 'vbo.pxd', 'cgl.pxd'],\n 'cgl.pxd': ['common.pxi', 'config.pxi', 'gl_redirect.h'],\n 'compiler.pxd': ['instructions.pxd'],\n 'compiler.pyx': ['context_instructions.pxd'],\n 'cgl.pyx': ['cgl.pxd'],\n 'cgl_mock.pyx': ['cgl.pxd'],\n 'cgl_sdl2.pyx': ['cgl.pxd'],\n 'cgl_gl.pyx': ['cgl.pxd'],\n 'cgl_glew.pyx': ['cgl.pxd'],\n 'context_instructions.pxd': [\n 'transformation.pxd', 'instructions.pxd', 'texture.pxd'],\n 'fbo.pxd': ['cgl.pxd', 'instructions.pxd', 'texture.pxd'],\n 'fbo.pyx': [\n 'config.pxi', 'opcodes.pxi', 'transformation.pxd', 'context.pxd'],\n 'gl_instructions.pyx': [\n 'config.pxi', 'opcodes.pxi', 'cgl.pxd', 'instructions.pxd'],\n 'instructions.pxd': [\n 'vbo.pxd', 'context_instructions.pxd', 'compiler.pxd', 'shader.pxd',\n 'texture.pxd', '../_event.pxd'],\n 'instructions.pyx': [\n 'config.pxi', 'opcodes.pxi', 'cgl.pxd',\n 'context.pxd', 'common.pxi', 'vertex.pxd', 'transformation.pxd'],\n 'opengl.pyx': [\n 'config.pxi', 'common.pxi', 'cgl.pxd', 'gl_redirect.h'],\n 'opengl_utils.pyx': [\n 'opengl_utils_def.pxi', 'cgl.pxd', ],\n 'shader.pxd': ['cgl.pxd', 'transformation.pxd', 'vertex.pxd'],\n 'shader.pyx': [\n 'config.pxi', 'common.pxi', 'cgl.pxd',\n 'vertex.pxd', 'transformation.pxd', 'context.pxd',\n 'gl_debug_logger.pxi'],\n 'stencil_instructions.pxd': ['instructions.pxd'],\n 'stencil_instructions.pyx': [\n 'config.pxi', 'opcodes.pxi', 'cgl.pxd',\n 'gl_debug_logger.pxi'],\n 'scissor_instructions.pyx': [\n 'config.pxi', 'opcodes.pxi', 'cgl.pxd'],\n 'svg.pyx': ['config.pxi', 'common.pxi', 'texture.pxd', 'instructions.pxd',\n 'vertex_instructions.pxd', 'tesselator.pxd'],\n 'texture.pxd': ['cgl.pxd'],\n 'texture.pyx': [\n 'config.pxi', 'common.pxi', 'opengl_utils_def.pxi', 'context.pxd',\n 'cgl.pxd', 'opengl_utils.pxd',\n 'img_tools.pxi', 'gl_debug_logger.pxi'],\n 'vbo.pxd': ['buffer.pxd', 'cgl.pxd', 'vertex.pxd'],\n 'vbo.pyx': [\n 'config.pxi', 'common.pxi', 'context.pxd',\n 'instructions.pxd', 'shader.pxd', 'gl_debug_logger.pxi'],\n 'vertex.pxd': ['cgl.pxd'],\n 'vertex.pyx': ['config.pxi', 'common.pxi'],\n 'vertex_instructions.pyx': [\n 'config.pxi', 'common.pxi', 'vbo.pxd', 'vertex.pxd',\n 'instructions.pxd', 'vertex_instructions.pxd',\n 'cgl.pxd', 'texture.pxd', 'vertex_instructions_line.pxi'],\n 'vertex_instructions_line.pxi': ['stencil_instructions.pxd']}\n\nsources = {\n '_event.pyx': merge(base_flags, {'depends': ['properties.pxd']}),\n '_clock.pyx': {},\n 'weakproxy.pyx': {},\n 'properties.pyx': merge(base_flags, {'depends': ['_event.pxd']}),\n 'graphics/buffer.pyx': merge(base_flags, gl_flags_base),\n 'graphics/context.pyx': merge(base_flags, gl_flags_base),\n 'graphics/compiler.pyx': merge(base_flags, gl_flags_base),\n 'graphics/context_instructions.pyx': merge(base_flags, gl_flags_base),\n 'graphics/fbo.pyx': merge(base_flags, gl_flags_base),\n 'graphics/gl_instructions.pyx': merge(base_flags, gl_flags_base),\n 'graphics/instructions.pyx': merge(base_flags, gl_flags_base),\n 'graphics/opengl.pyx': merge(base_flags, gl_flags_base),\n 'graphics/opengl_utils.pyx': merge(base_flags, gl_flags_base),\n 'graphics/shader.pyx': merge(base_flags, gl_flags_base),\n 'graphics/stencil_instructions.pyx': merge(base_flags, gl_flags_base),\n 'graphics/scissor_instructions.pyx': merge(base_flags, gl_flags_base),\n 'graphics/texture.pyx': merge(base_flags, gl_flags_base),\n 'graphics/transformation.pyx': merge(base_flags, gl_flags_base),\n 'graphics/vbo.pyx': merge(base_flags, gl_flags_base),\n 'graphics/vertex.pyx': merge(base_flags, gl_flags_base),\n 'graphics/vertex_instructions.pyx': merge(base_flags, gl_flags_base),\n 'graphics/cgl.pyx': merge(base_flags, gl_flags_base),\n 'graphics/cgl_backend/cgl_mock.pyx': merge(base_flags, gl_flags_base),\n 'graphics/cgl_backend/cgl_gl.pyx': merge(base_flags, gl_flags),\n 'graphics/cgl_backend/cgl_glew.pyx': merge(base_flags, gl_flags),\n 'graphics/cgl_backend/cgl_sdl2.pyx': merge(base_flags, gl_flags_base),\n 'graphics/cgl_backend/cgl_debug.pyx': merge(base_flags, gl_flags_base),\n 'core/text/text_layout.pyx': base_flags,\n 'core/window/window_info.pyx': base_flags,\n 'graphics/tesselator.pyx': merge(base_flags, {\n 'include_dirs': ['kivy/lib/libtess2/Include'],\n 'c_depends': [\n 'lib/libtess2/Source/bucketalloc.c',\n 'lib/libtess2/Source/dict.c',\n 'lib/libtess2/Source/geom.c',\n 'lib/libtess2/Source/mesh.c',\n 'lib/libtess2/Source/priorityq.c',\n 'lib/libtess2/Source/sweep.c',\n 'lib/libtess2/Source/tess.c'\n ]\n }),\n 'graphics/svg.pyx': merge(base_flags, gl_flags_base)\n}\n\nif c_options[\"use_sdl2\"]:\n sdl2_flags = determine_sdl2()\n\nif c_options['use_sdl2'] and sdl2_flags:\n sources['graphics/cgl_backend/cgl_sdl2.pyx'] = merge(\n sources['graphics/cgl_backend/cgl_sdl2.pyx'], sdl2_flags)\n sdl2_depends = {'depends': ['lib/sdl2.pxi']}\n for source_file in ('core/window/_window_sdl2.pyx',\n 'core/image/_img_sdl2.pyx',\n 'core/text/_text_sdl2.pyx',\n 'core/audio/audio_sdl2.pyx',\n 'core/clipboard/_clipboard_sdl2.pyx'):\n sources[source_file] = merge(\n base_flags, sdl2_flags, sdl2_depends)\n\nif platform in ('darwin', 'ios'):\n # activate ImageIO provider for our core image\n if platform == 'ios':\n osx_flags = {'extra_link_args': [\n '-framework', 'Foundation',\n '-framework', 'UIKit',\n '-framework', 'AudioToolbox',\n '-framework', 'CoreGraphics',\n '-framework', 'QuartzCore',\n '-framework', 'ImageIO',\n '-framework', 'Accelerate']}\n else:\n osx_flags = {'extra_link_args': [\n '-framework', 'ApplicationServices']}\n sources['core/image/img_imageio.pyx'] = merge(\n base_flags, osx_flags)\n\nif c_options['use_avfoundation']:\n import platform as _platform\n mac_ver = [int(x) for x in _platform.mac_ver()[0].split('.')[:2]]\n if mac_ver >= [10, 7]:\n osx_flags = {\n 'extra_link_args': ['-framework', 'AVFoundation'],\n 'extra_compile_args': ['-ObjC++'],\n 'depends': ['core/camera/camera_avfoundation_implem.m']}\n sources['core/camera/camera_avfoundation.pyx'] = merge(\n base_flags, osx_flags)\n else:\n print('AVFoundation cannot be used, OSX >= 10.7 is required')\n\nif c_options['use_rpi']:\n sources['lib/vidcore_lite/egl.pyx'] = merge(\n base_flags, gl_flags)\n sources['lib/vidcore_lite/bcm.pyx'] = merge(\n base_flags, gl_flags)\n\nif c_options['use_x11']:\n libs = ['Xrender', 'X11']\n if c_options['use_egl']:\n libs += ['EGL']\n else:\n libs += ['GL']\n sources['core/window/window_x11.pyx'] = merge(\n base_flags, gl_flags, {\n # FIXME add an option to depend on them but not compile them\n # cause keytab is included in core, and core is included in\n # window_x11\n #\n # 'depends': [\n # 'core/window/window_x11_keytab.c',\n # 'core/window/window_x11_core.c'],\n 'libraries': libs})\n\nif c_options['use_gstreamer']:\n sources['lib/gstplayer/_gstplayer.pyx'] = merge(\n base_flags, gst_flags, {\n 'depends': ['lib/gstplayer/_gstplayer.h']})\n\n\n# -----------------------------------------------------------------------------\n# extension modules\n\ndef get_dependencies(name, deps=None):\n if deps is None:\n deps = []\n for dep in graphics_dependencies.get(name, []):\n if dep not in deps:\n deps.append(dep)\n get_dependencies(dep, deps)\n return deps\n\n\ndef resolve_dependencies(fn, depends):\n fn = basename(fn)\n deps = []\n get_dependencies(fn, deps)\n get_dependencies(fn.replace('.pyx', '.pxd'), deps)\n\n deps_final = []\n paths_to_test = ['graphics', 'include']\n for dep in deps:\n found = False\n for path in paths_to_test:\n filename = expand(src_path, path, dep)\n if exists(filename):\n deps_final.append(filename)\n found = True\n break\n if not found:\n print('ERROR: Dependency for {} not resolved: {}'.format(\n fn, dep\n ))\n\n return deps_final\n\n\ndef get_extensions_from_sources(sources):\n ext_modules = []\n if environ.get('KIVY_FAKE_BUILDEXT'):\n print('Fake build_ext asked, will generate only .h/.c')\n return ext_modules\n for pyx, flags in sources.items():\n is_graphics = pyx.startswith('graphics')\n pyx = expand(src_path, pyx)\n depends = [expand(src_path, x) for x in flags.pop('depends', [])]\n c_depends = [expand(src_path, x) for x in flags.pop('c_depends', [])]\n if not have_cython:\n pyx = '%s.c' % pyx[:-4]\n if is_graphics:\n depends = resolve_dependencies(pyx, depends)\n f_depends = [x for x in depends if x.rsplit('.', 1)[-1] in (\n 'c', 'cpp', 'm')]\n module_name = get_modulename_from_file(pyx)\n flags_clean = {'depends': depends}\n for key, value in flags.items():\n if len(value):\n flags_clean[key] = value\n ext_modules.append(CythonExtension(\n module_name, [pyx] + f_depends + c_depends, **flags_clean))\n return ext_modules\n\n\next_modules = get_extensions_from_sources(sources)\n\n\n# -----------------------------------------------------------------------------\n# automatically detect data files\nsplit_examples = int(environ.get('KIVY_SPLIT_EXAMPLES', '0'))\ndata_file_prefix = 'share/kivy-'\nexamples = {}\nexamples_allowed_ext = ('readme', 'py', 'wav', 'png', 'jpg', 'svg', 'json',\n 'avi', 'gif', 'txt', 'ttf', 'obj', 'mtl', 'kv', 'mpg',\n 'glsl', 'zip')\nfor root, subFolders, files in walk('examples'):\n for fn in files:\n ext = fn.split('.')[-1].lower()\n if ext not in examples_allowed_ext:\n continue\n filename = join(root, fn)\n directory = '%s%s' % (data_file_prefix, dirname(filename))\n if directory not in examples:\n examples[directory] = []\n examples[directory].append(filename)\n\nbinary_deps = []\nbinary_deps_path = join(src_path, 'kivy', 'binary_deps')\nif isdir(binary_deps_path):\n for root, dirnames, filenames in walk(binary_deps_path):\n for fname in filenames:\n binary_deps.append(\n join(root.replace(binary_deps_path, 'binary_deps'), fname))\n\n# -----------------------------------------------------------------------------\n# setup !\nif not build_examples:\n setup(\n name='Kivy',\n version=get_version(),\n author='Kivy Team and other contributors',\n author_email='[email protected]',\n url='http://kivy.org',\n license='MIT',\n description=(\n 'A software library for rapid development of '\n 'hardware-accelerated multitouch applications.'),\n ext_modules=ext_modules,\n cmdclass=cmdclass,\n packages=[\n 'kivy',\n 'kivy.adapters',\n 'kivy.core',\n 'kivy.core.audio',\n 'kivy.core.camera',\n 'kivy.core.clipboard',\n 'kivy.core.image',\n 'kivy.core.gl',\n 'kivy.core.spelling',\n 'kivy.core.text',\n 'kivy.core.video',\n 'kivy.core.window',\n 'kivy.deps',\n 'kivy.effects',\n 'kivy.graphics',\n 'kivy.graphics.cgl_backend',\n 'kivy.garden',\n 'kivy.input',\n 'kivy.input.postproc',\n 'kivy.input.providers',\n 'kivy.lang',\n 'kivy.lib',\n 'kivy.lib.osc',\n 'kivy.lib.gstplayer',\n 'kivy.lib.vidcore_lite',\n 'kivy.modules',\n 'kivy.network',\n 'kivy.storage',\n 'kivy.tests',\n 'kivy.tools',\n 'kivy.tools.packaging',\n 'kivy.tools.packaging.pyinstaller_hooks',\n 'kivy.tools.highlight',\n 'kivy.extras',\n 'kivy.uix',\n 'kivy.uix.behaviors',\n 'kivy.uix.recycleview',\n ],\n package_dir={'kivy': 'kivy'},\n package_data={'kivy': [\n '*.pxd',\n '*.pxi',\n 'core/text/*.pxd',\n 'core/text/*.pxi',\n 'core/window/*.pxi',\n 'core/window/*.pxd',\n 'graphics/*.pxd',\n 'graphics/*.pxi',\n 'graphics/*.h',\n 'include/*',\n 'lib/vidcore_lite/*.pxd',\n 'lib/vidcore_lite/*.pxi',\n 'data/*.kv',\n 'data/*.json',\n 'data/fonts/*.ttf',\n 'data/images/*.png',\n 'data/images/*.jpg',\n 'data/images/*.gif',\n 'data/images/*.atlas',\n 'data/keyboards/*.json',\n 'data/logo/*.png',\n 'data/glsl/*.png',\n 'data/glsl/*.vs',\n 'data/glsl/*.fs',\n 'tests/*.zip',\n 'tests/*.kv',\n 'tests/*.png',\n 'tests/*.ttf',\n 'tests/*.ogg',\n 'tools/gles_compat/*',\n 'tools/highlight/*',\n 'tools/packaging/README.txt',\n 'tools/packaging/win32/kivy.bat',\n 'tools/packaging/win32/kivyenv.sh',\n 'tools/packaging/win32/README.txt',\n 'tools/packaging/osx/Info.plist',\n 'tools/packaging/osx/InfoPlist.strings',\n 'tools/packaging/osx/kivy.sh',\n 'tools/pep8checker/*',\n 'tools/theming/defaulttheme/*',\n ] + binary_deps},\n data_files=[] if split_examples else list(examples.items()),\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'Environment :: MacOS X',\n 'Environment :: Win32 (MS Windows)',\n 'Environment :: X11 Applications',\n 'Intended Audience :: Developers',\n 'Intended Audience :: End Users/Desktop',\n 'Intended Audience :: Information Technology',\n 'Intended Audience :: Science/Research',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: MacOS :: MacOS X',\n 'Operating System :: Microsoft :: Windows',\n 'Operating System :: POSIX :: BSD :: FreeBSD',\n 'Operating System :: POSIX :: Linux',\n 'Programming Language :: Python :: 2.7',\n 'Programming Language :: Python :: 3.3',\n 'Programming Language :: Python :: 3.4',\n 'Programming Language :: Python :: 3.5',\n 'Programming Language :: Python :: 3.6',\n 'Topic :: Artistic Software',\n 'Topic :: Games/Entertainment',\n 'Topic :: Multimedia :: Graphics :: 3D Rendering',\n 'Topic :: Multimedia :: Graphics :: Capture :: Digital Camera',\n 'Topic :: Multimedia :: Graphics :: Presentation',\n 'Topic :: Multimedia :: Graphics :: Viewers',\n 'Topic :: Multimedia :: Sound/Audio :: Players :: MP3',\n 'Topic :: Multimedia :: Video :: Display',\n 'Topic :: Scientific/Engineering :: Human Machine Interfaces',\n 'Topic :: Scientific/Engineering :: Visualization',\n ('Topic :: Software Development :: Libraries :: '\n 'Application Frameworks'),\n 'Topic :: Software Development :: User Interfaces'],\n dependency_links=[\n 'https://github.com/kivy-garden/garden/archive/master.zip'],\n install_requires=['Kivy-Garden>=0.1.4', 'docutils', 'pygments'],\n setup_requires=[\n 'cython>=' + MIN_CYTHON_STRING\n ] if not skip_cython else [])\nelse:\n setup(\n name='Kivy-examples',\n version=get_version(),\n author='Kivy Team and other contributors',\n author_email='[email protected]',\n url='http://kivy.org',\n license='MIT',\n description=('Kivy examples.'),\n data_files=list(examples.items()))\n", "path": "setup.py"}], "after_files": [{"content": "#\n# Kivy - Cross-platform UI framework\n# https://kivy.org/\n#\nfrom __future__ import print_function\n\nimport sys\nbuild_examples = False\nif \"--build_examples\" in sys.argv:\n build_examples = True\n sys.argv.remove(\"--build_examples\")\n\nfrom copy import deepcopy\nimport os\nfrom os.path import join, dirname, sep, exists, basename, isdir\nfrom os import walk, environ\nfrom distutils.version import LooseVersion\nfrom distutils.sysconfig import get_python_inc\nfrom collections import OrderedDict\nfrom time import sleep\nfrom subprocess import check_output, CalledProcessError\nfrom datetime import datetime\n\nif environ.get('KIVY_USE_SETUPTOOLS'):\n from setuptools import setup, Extension\n print('Using setuptools')\nelse:\n from distutils.core import setup\n from distutils.extension import Extension\n print('Using distutils')\n\n\nPY3 = sys.version > '3'\n\nif PY3: # fix error with py3's LooseVersion comparisons\n def ver_equal(self, other):\n return self.version == other\n\n LooseVersion.__eq__ = ver_equal\n\n\ndef get_version(filename='kivy/version.py'):\n VERSION = kivy.__version__\n DATE = datetime.utcnow().strftime('%Y%m%d')\n try:\n GIT_REVISION = check_output(\n ['git', 'rev-parse', 'HEAD']\n ).strip().decode('ascii')\n except (CalledProcessError, OSError, IOError) as e:\n # CalledProcessError has no errno\n errno = getattr(e, 'errno', None)\n if errno != 2 and 'CalledProcessError' not in repr(e):\n raise\n GIT_REVISION = \"Unknown\"\n\n cnt = (\n \"# THIS FILE IS GENERATED FROM KIVY SETUP.PY\\n\"\n \"__version__ = '%(version)s'\\n\"\n \"__hash__ = '%(hash)s'\\n\"\n \"__date__ = '%(date)s'\\n\"\n )\n\n with open(filename, 'w') as f:\n f.write(cnt % {\n 'version': VERSION,\n 'hash': GIT_REVISION,\n 'date': DATE\n })\n return VERSION\n\n\nMIN_CYTHON_STRING = '0.23'\nMIN_CYTHON_VERSION = LooseVersion(MIN_CYTHON_STRING)\nMAX_CYTHON_STRING = '0.27.3'\nMAX_CYTHON_VERSION = LooseVersion(MAX_CYTHON_STRING)\nCYTHON_UNSUPPORTED = (\n # ref https://github.com/cython/cython/issues/1968\n '0.27', '0.27.2'\n)\n\n\ndef getoutput(cmd, env=None):\n import subprocess\n p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE,\n stderr=subprocess.PIPE, env=env)\n p.wait()\n if p.returncode: # if not returncode == 0\n print('WARNING: A problem occurred while running {0} (code {1})\\n'\n .format(cmd, p.returncode))\n stderr_content = p.stderr.read()\n if stderr_content:\n print('{0}\\n'.format(stderr_content))\n return \"\"\n return p.stdout.read()\n\n\ndef pkgconfig(*packages, **kw):\n flag_map = {'-I': 'include_dirs', '-L': 'library_dirs', '-l': 'libraries'}\n lenviron = None\n pconfig = join(sys.prefix, 'libs', 'pkgconfig')\n\n if isdir(pconfig):\n lenviron = environ.copy()\n lenviron['PKG_CONFIG_PATH'] = '{};{}'.format(\n environ.get('PKG_CONFIG_PATH', ''), pconfig)\n cmd = 'pkg-config --libs --cflags {}'.format(' '.join(packages))\n results = getoutput(cmd, lenviron).split()\n for token in results:\n ext = token[:2].decode('utf-8')\n flag = flag_map.get(ext)\n if not flag:\n continue\n kw.setdefault(flag, []).append(token[2:].decode('utf-8'))\n return kw\n\n\n# -----------------------------------------------------------------------------\n# Determine on which platform we are\n\nplatform = sys.platform\n\n# Detect 32/64bit for OSX (http://stackoverflow.com/a/1405971/798575)\nif sys.platform == 'darwin':\n if sys.maxsize > 2 ** 32:\n osx_arch = 'x86_64'\n else:\n osx_arch = 'i386'\n\n# Detect Python for android project (http://github.com/kivy/python-for-android)\nndkplatform = environ.get('NDKPLATFORM')\nif ndkplatform is not None and environ.get('LIBLINK'):\n platform = 'android'\nkivy_ios_root = environ.get('KIVYIOSROOT', None)\nif kivy_ios_root is not None:\n platform = 'ios'\nif exists('/opt/vc/include/bcm_host.h'):\n platform = 'rpi'\nif exists('/usr/lib/arm-linux-gnueabihf/libMali.so'):\n platform = 'mali'\n\n# -----------------------------------------------------------------------------\n# Detect options\n#\nc_options = OrderedDict()\nc_options['use_rpi'] = platform == 'rpi'\nc_options['use_mali'] = platform == 'mali'\nc_options['use_egl'] = False\nc_options['use_opengl_es2'] = None\nc_options['use_opengl_mock'] = environ.get('READTHEDOCS', None) == 'True'\nc_options['use_sdl2'] = None\nc_options['use_ios'] = False\nc_options['use_mesagl'] = False\nc_options['use_x11'] = False\nc_options['use_wayland'] = False\nc_options['use_gstreamer'] = None\nc_options['use_avfoundation'] = platform == 'darwin'\nc_options['use_osx_frameworks'] = platform == 'darwin'\nc_options['debug_gl'] = False\n\n# now check if environ is changing the default values\nfor key in list(c_options.keys()):\n ukey = key.upper()\n if ukey in environ:\n value = bool(int(environ[ukey]))\n print('Environ change {0} -> {1}'.format(key, value))\n c_options[key] = value\n\n\n# -----------------------------------------------------------------------------\n# Cython check\n# on python-for-android and kivy-ios, cython usage is external\n\ncython_unsupported_append = '''\n\n Please note that the following versions of Cython are not supported\n at all: {}\n'''.format(', '.join(map(str, CYTHON_UNSUPPORTED)))\n\ncython_min = '''\\\n This version of Cython is not compatible with Kivy. Please upgrade to\n at least version {0}, preferably the newest supported version {1}.\n\n If your platform provides a Cython package, make sure you have upgraded\n to the newest version. If the newest version available is still too low,\n please remove it and install the newest supported Cython via pip:\n\n pip install -I Cython=={1}{2}\\\n'''.format(MIN_CYTHON_STRING, MAX_CYTHON_STRING,\n cython_unsupported_append if CYTHON_UNSUPPORTED else '')\n\ncython_max = '''\\\n This version of Cython is untested with Kivy. While this version may\n work perfectly fine, it is possible that you may experience issues. If\n you do have issues, please downgrade to a supported version. It is\n best to use the newest supported version, {1}, but the minimum\n supported version is {0}.\n\n If your platform provides a Cython package, check if you can downgrade\n to a supported version. Otherwise, uninstall the platform package and\n install Cython via pip:\n\n pip install -I Cython=={1}{2}\\\n'''.format(MIN_CYTHON_STRING, MAX_CYTHON_STRING,\n cython_unsupported_append if CYTHON_UNSUPPORTED else '')\n\ncython_unsupported = '''\\\n This version of Cython suffers from known bugs and is unsupported.\n Please install the newest supported version, {1}, if possible, but\n the minimum supported version is {0}.\n\n If your platform provides a Cython package, check if you can install\n a supported version. Otherwise, uninstall the platform package and\n install Cython via pip:\n\n pip install -I Cython=={1}{2}\\\n'''.format(MIN_CYTHON_STRING, MAX_CYTHON_STRING,\n cython_unsupported_append)\n\nhave_cython = False\nskip_cython = False\nif platform in ('ios', 'android'):\n print('\\nCython check avoided.')\n skip_cython = True\nelse:\n try:\n # check for cython\n from Cython.Distutils import build_ext\n have_cython = True\n import Cython\n cy_version_str = Cython.__version__\n cy_ver = LooseVersion(cy_version_str)\n print('\\nDetected Cython version {}'.format(cy_version_str))\n if cy_ver < MIN_CYTHON_VERSION:\n print(cython_min)\n raise ImportError('Incompatible Cython Version')\n if cy_ver in CYTHON_UNSUPPORTED:\n print(cython_unsupported)\n raise ImportError('Incompatible Cython Version')\n if cy_ver > MAX_CYTHON_VERSION:\n print(cython_max)\n sleep(1)\n except ImportError:\n print(\"\\nCython is missing, it's required for compiling kivy !\\n\\n\")\n raise\n\nif not have_cython:\n from distutils.command.build_ext import build_ext\n\n# -----------------------------------------------------------------------------\n# Setup classes\n\n# the build path where kivy is being compiled\nsrc_path = build_path = dirname(__file__)\n\n\nclass KivyBuildExt(build_ext):\n\n def finalize_options(self):\n retval = build_ext.finalize_options(self)\n global build_path\n if (self.build_lib is not None and exists(self.build_lib) and\n not self.inplace):\n build_path = self.build_lib\n return retval\n\n def build_extensions(self):\n # build files\n config_h_fn = ('include', 'config.h')\n config_pxi_fn = ('include', 'config.pxi')\n config_py_fn = ('setupconfig.py', )\n\n # generate headers\n config_h = '// Autogenerated file for Kivy C configuration\\n'\n config_h += '#define __PY3 {0}\\n'.format(int(PY3))\n config_pxi = '# Autogenerated file for Kivy Cython configuration\\n'\n config_pxi += 'DEF PY3 = {0}\\n'.format(int(PY3))\n config_py = '# Autogenerated file for Kivy configuration\\n'\n config_py += 'PY3 = {0}\\n'.format(int(PY3))\n config_py += 'CYTHON_MIN = {0}\\nCYTHON_MAX = {1}\\n'.format(\n repr(MIN_CYTHON_STRING), repr(MAX_CYTHON_STRING))\n config_py += 'CYTHON_BAD = {0}\\n'.format(repr(', '.join(map(\n str, CYTHON_UNSUPPORTED))))\n\n # generate content\n print('Build configuration is:')\n for opt, value in c_options.items():\n value = int(bool(value))\n print(' * {0} = {1}'.format(opt, value))\n opt = opt.upper()\n config_h += '#define __{0} {1}\\n'.format(opt, value)\n config_pxi += 'DEF {0} = {1}\\n'.format(opt, value)\n config_py += '{0} = {1}\\n'.format(opt, value)\n debug = bool(self.debug)\n print(' * debug = {0}'.format(debug))\n\n config_pxi += 'DEF DEBUG = {0}\\n'.format(debug)\n config_py += 'DEBUG = {0}\\n'.format(debug)\n config_pxi += 'DEF PLATFORM = \"{0}\"\\n'.format(platform)\n config_py += 'PLATFORM = \"{0}\"\\n'.format(platform)\n for fn, content in (\n (config_h_fn, config_h), (config_pxi_fn, config_pxi),\n (config_py_fn, config_py)):\n build_fn = expand(build_path, *fn)\n if self.update_if_changed(build_fn, content):\n print('Updated {}'.format(build_fn))\n src_fn = expand(src_path, *fn)\n if src_fn != build_fn and self.update_if_changed(src_fn, content):\n print('Updated {}'.format(src_fn))\n\n c = self.compiler.compiler_type\n print('Detected compiler is {}'.format(c))\n if c != 'msvc':\n for e in self.extensions:\n e.extra_link_args += ['-lm']\n\n build_ext.build_extensions(self)\n\n def update_if_changed(self, fn, content):\n need_update = True\n if exists(fn):\n with open(fn) as fd:\n need_update = fd.read() != content\n if need_update:\n with open(fn, 'w') as fd:\n fd.write(content)\n return need_update\n\n\ndef _check_and_fix_sdl2_mixer(f_path):\n print(\"Check if SDL2_mixer smpeg2 have an @executable_path\")\n rpath_from = (\"@executable_path/../Frameworks/SDL2.framework\"\n \"/Versions/A/SDL2\")\n rpath_to = \"@rpath/../../../../SDL2.framework/Versions/A/SDL2\"\n smpeg2_path = (\"{}/Versions/A/Frameworks/smpeg2.framework\"\n \"/Versions/A/smpeg2\").format(f_path)\n output = getoutput((\"otool -L '{}'\").format(smpeg2_path)).decode('utf-8')\n if \"@executable_path\" not in output:\n return\n\n print(\"WARNING: Your SDL2_mixer version is invalid\")\n print(\"WARNING: The smpeg2 framework embedded in SDL2_mixer contains a\")\n print(\"WARNING: reference to @executable_path that will fail the\")\n print(\"WARNING: execution of your application.\")\n print(\"WARNING: We are going to change:\")\n print(\"WARNING: from: {}\".format(rpath_from))\n print(\"WARNING: to: {}\".format(rpath_to))\n getoutput(\"install_name_tool -change {} {} {}\".format(\n rpath_from, rpath_to, smpeg2_path))\n\n output = getoutput((\"otool -L '{}'\").format(smpeg2_path))\n if b\"@executable_path\" not in output:\n print(\"WARNING: Change successfully applied!\")\n print(\"WARNING: You'll never see this message again.\")\n else:\n print(\"WARNING: Unable to apply the changes, sorry.\")\n\n\n# -----------------------------------------------------------------------------\n# extract version (simulate doc generation, kivy will be not imported)\nenviron['KIVY_DOC_INCLUDE'] = '1'\nimport kivy\n\n# extra build commands go in the cmdclass dict {'command-name': CommandClass}\n# see tools.packaging.{platform}.build.py for custom build commands for\n# portable packages. Also e.g. we use build_ext command from cython if its\n# installed for c extensions.\nfrom kivy.tools.packaging.factory import FactoryBuild\ncmdclass = {\n 'build_factory': FactoryBuild,\n 'build_ext': KivyBuildExt}\n\ntry:\n # add build rules for portable packages to cmdclass\n if platform == 'win32':\n from kivy.tools.packaging.win32.build import WindowsPortableBuild\n cmdclass['build_portable'] = WindowsPortableBuild\n elif platform == 'darwin':\n from kivy.tools.packaging.osx.build import OSXPortableBuild\n cmdclass['build_portable'] = OSXPortableBuild\nexcept ImportError:\n print('User distribution detected, avoid portable command.')\n\n# Detect which opengl version headers to use\nif platform in ('android', 'darwin', 'ios', 'rpi', 'mali'):\n c_options['use_opengl_es2'] = True\nelif c_options['use_opengl_es2'] is None:\n c_options['use_opengl_es2'] = \\\n environ.get('KIVY_GRAPHICS', '').lower() == 'gles'\n\nprint('Using this graphics system: {}'.format(\n ['OpenGL', 'OpenGL ES 2'][int(c_options['use_opengl_es2'] or False)]))\n\n# check if we are in a kivy-ios build\nif platform == 'ios':\n print('Kivy-IOS project environment detect, use it.')\n print('Kivy-IOS project located at {0}'.format(kivy_ios_root))\n c_options['use_ios'] = True\n c_options['use_sdl2'] = True\n\nelif platform == 'darwin':\n if c_options['use_osx_frameworks']:\n if osx_arch == \"i386\":\n print(\"Warning: building with frameworks fail on i386\")\n else:\n print(\"OSX framework used, force to x86_64 only\")\n environ[\"ARCHFLAGS\"] = environ.get(\"ARCHFLAGS\", \"-arch x86_64\")\n print(\"OSX ARCHFLAGS are: {}\".format(environ[\"ARCHFLAGS\"]))\n\n# detect gstreamer, only on desktop\n# works if we forced the options or in autodetection\nif platform not in ('ios', 'android') and (c_options['use_gstreamer']\n in (None, True)):\n gstreamer_valid = False\n if c_options['use_osx_frameworks'] and platform == 'darwin':\n # check the existence of frameworks\n f_path = '/Library/Frameworks/GStreamer.framework'\n if not exists(f_path):\n c_options['use_gstreamer'] = False\n print('GStreamer framework not found, fallback on pkg-config')\n else:\n print('GStreamer framework found')\n gstreamer_valid = True\n c_options['use_gstreamer'] = True\n gst_flags = {\n 'extra_link_args': [\n '-F/Library/Frameworks',\n '-Xlinker', '-rpath',\n '-Xlinker', '/Library/Frameworks',\n '-Xlinker', '-headerpad',\n '-Xlinker', '190',\n '-framework', 'GStreamer'],\n 'include_dirs': [join(f_path, 'Headers')]}\n\n if not gstreamer_valid:\n # use pkg-config approach instead\n gst_flags = pkgconfig('gstreamer-1.0')\n if 'libraries' in gst_flags:\n print('GStreamer found via pkg-config')\n c_options['use_gstreamer'] = True\n\n\n# detect SDL2, only on desktop and iOS, or android if explicitly enabled\n# works if we forced the options or in autodetection\nsdl2_flags = {}\nif c_options['use_sdl2'] or (\n platform not in ('android',) and c_options['use_sdl2'] is None):\n\n sdl2_valid = False\n if c_options['use_osx_frameworks'] and platform == 'darwin':\n # check the existence of frameworks\n sdl2_valid = True\n sdl2_flags = {\n 'extra_link_args': [\n '-F/Library/Frameworks',\n '-Xlinker', '-rpath',\n '-Xlinker', '/Library/Frameworks',\n '-Xlinker', '-headerpad',\n '-Xlinker', '190'],\n 'include_dirs': [],\n 'extra_compile_args': ['-F/Library/Frameworks']\n }\n for name in ('SDL2', 'SDL2_ttf', 'SDL2_image', 'SDL2_mixer'):\n f_path = '/Library/Frameworks/{}.framework'.format(name)\n if not exists(f_path):\n print('Missing framework {}'.format(f_path))\n sdl2_valid = False\n continue\n sdl2_flags['extra_link_args'] += ['-framework', name]\n sdl2_flags['include_dirs'] += [join(f_path, 'Headers')]\n print('Found sdl2 frameworks: {}'.format(f_path))\n if name == 'SDL2_mixer':\n _check_and_fix_sdl2_mixer(f_path)\n\n if not sdl2_valid:\n c_options['use_sdl2'] = False\n print('SDL2 frameworks not found, fallback on pkg-config')\n else:\n c_options['use_sdl2'] = True\n print('Activate SDL2 compilation')\n\n if not sdl2_valid and platform != \"ios\":\n # use pkg-config approach instead\n sdl2_flags = pkgconfig('sdl2', 'SDL2_ttf', 'SDL2_image', 'SDL2_mixer')\n if 'libraries' in sdl2_flags:\n print('SDL2 found via pkg-config')\n c_options['use_sdl2'] = True\n\n\n# -----------------------------------------------------------------------------\n# declare flags\n\n\ndef get_modulename_from_file(filename):\n filename = filename.replace(sep, '/')\n pyx = '.'.join(filename.split('.')[:-1])\n pyxl = pyx.split('/')\n while pyxl[0] != 'kivy':\n pyxl.pop(0)\n if pyxl[1] == 'kivy':\n pyxl.pop(0)\n return '.'.join(pyxl)\n\n\ndef expand(root, *args):\n return join(root, 'kivy', *args)\n\n\nclass CythonExtension(Extension):\n\n def __init__(self, *args, **kwargs):\n Extension.__init__(self, *args, **kwargs)\n self.cython_directives = {\n 'c_string_encoding': 'utf-8',\n 'profile': 'USE_PROFILE' in environ,\n 'embedsignature': 'USE_EMBEDSIGNATURE' in environ}\n # XXX with pip, setuptools is imported before distutils, and change\n # our pyx to c, then, cythonize doesn't happen. So force again our\n # sources\n self.sources = args[1]\n\n\ndef merge(d1, *args):\n d1 = deepcopy(d1)\n for d2 in args:\n for key, value in d2.items():\n value = deepcopy(value)\n if key in d1:\n d1[key].extend(value)\n else:\n d1[key] = value\n return d1\n\n\ndef determine_base_flags():\n flags = {\n 'libraries': [],\n 'include_dirs': [join(src_path, 'kivy', 'include')],\n 'library_dirs': [],\n 'extra_link_args': [],\n 'extra_compile_args': []}\n if c_options['use_ios']:\n sysroot = environ.get('IOSSDKROOT', environ.get('SDKROOT'))\n if not sysroot:\n raise Exception('IOSSDKROOT is not set')\n flags['include_dirs'] += [sysroot]\n flags['extra_compile_args'] += ['-isysroot', sysroot]\n flags['extra_link_args'] += ['-isysroot', sysroot]\n elif platform.startswith('freebsd'):\n flags['include_dirs'] += [join(\n environ.get('LOCALBASE', '/usr/local'), 'include')]\n flags['library_dirs'] += [join(\n environ.get('LOCALBASE', '/usr/local'), 'lib')]\n elif platform == 'darwin':\n v = os.uname()\n if v[2] >= '13.0.0':\n # use xcode-select to search on the right Xcode path\n # XXX use the best SDK available instead of a specific one\n import platform as _platform\n xcode_dev = getoutput('xcode-select -p').splitlines()[0]\n sdk_mac_ver = '.'.join(_platform.mac_ver()[0].split('.')[:2])\n print('Xcode detected at {}, and using OS X{} sdk'.format(\n xcode_dev, sdk_mac_ver))\n sysroot = join(\n xcode_dev.decode('utf-8'),\n 'Platforms/MacOSX.platform/Developer/SDKs',\n 'MacOSX{}.sdk'.format(sdk_mac_ver),\n 'System/Library/Frameworks')\n else:\n sysroot = ('/System/Library/Frameworks/'\n 'ApplicationServices.framework/Frameworks')\n flags['extra_compile_args'] += ['-F%s' % sysroot]\n flags['extra_link_args'] += ['-F%s' % sysroot]\n elif platform == 'win32':\n flags['include_dirs'] += [get_python_inc(prefix=sys.prefix)]\n flags['library_dirs'] += [join(sys.prefix, \"libs\")]\n return flags\n\n\ndef determine_gl_flags():\n kivy_graphics_include = join(src_path, 'kivy', 'include')\n flags = {'include_dirs': [kivy_graphics_include], 'libraries': []}\n base_flags = {'include_dirs': [kivy_graphics_include], 'libraries': []}\n if c_options['use_opengl_mock']:\n return flags, base_flags\n if platform == 'win32':\n flags['libraries'] = ['opengl32', 'glew32']\n elif platform == 'ios':\n flags['libraries'] = ['GLESv2']\n flags['extra_link_args'] = ['-framework', 'OpenGLES']\n elif platform == 'darwin':\n flags['extra_link_args'] = ['-framework', 'OpenGL', '-arch', osx_arch]\n flags['extra_compile_args'] = ['-arch', osx_arch]\n elif platform.startswith('freebsd'):\n flags['libraries'] = ['GL']\n elif platform.startswith('openbsd'):\n flags['include_dirs'] = ['/usr/X11R6/include']\n flags['library_dirs'] = ['/usr/X11R6/lib']\n flags['libraries'] = ['GL']\n elif platform == 'android':\n flags['include_dirs'] = [join(ndkplatform, 'usr', 'include')]\n flags['library_dirs'] = [join(ndkplatform, 'usr', 'lib')]\n flags['libraries'] = ['GLESv2']\n elif platform == 'rpi':\n flags['include_dirs'] = [\n '/opt/vc/include',\n '/opt/vc/include/interface/vcos/pthreads',\n '/opt/vc/include/interface/vmcs_host/linux']\n flags['library_dirs'] = ['/opt/vc/lib']\n brcm_lib_files = (\n '/opt/vc/lib/libbrcmEGL.so',\n '/opt/vc/lib/libbrcmGLESv2.so')\n if all((exists(lib) for lib in brcm_lib_files)):\n print(\n 'Found brcmEGL and brcmGLES library files'\n 'for rpi platform at /opt/vc/lib/')\n gl_libs = ['brcmEGL', 'brcmGLESv2']\n else:\n print(\n 'Failed to find brcmEGL and brcmGLESv2 library files'\n 'for rpi platform, falling back to EGL and GLESv2.')\n gl_libs = ['EGL', 'GLESv2']\n flags['libraries'] = ['bcm_host'] + gl_libs\n elif platform == 'mali':\n flags['include_dirs'] = ['/usr/include/']\n flags['library_dirs'] = ['/usr/lib/arm-linux-gnueabihf']\n flags['libraries'] = ['GLESv2']\n c_options['use_x11'] = True\n c_options['use_egl'] = True\n else:\n flags['libraries'] = ['GL']\n return flags, base_flags\n\n\ndef determine_sdl2():\n flags = {}\n if not c_options['use_sdl2']:\n return flags\n\n sdl2_path = environ.get('KIVY_SDL2_PATH', None)\n\n if sdl2_flags and not sdl2_path and platform == 'darwin':\n return sdl2_flags\n\n # no pkgconfig info, or we want to use a specific sdl2 path, so perform\n # manual configuration\n flags['libraries'] = ['SDL2', 'SDL2_ttf', 'SDL2_image', 'SDL2_mixer']\n split_chr = ';' if platform == 'win32' else ':'\n sdl2_paths = sdl2_path.split(split_chr) if sdl2_path else []\n\n if not sdl2_paths:\n sdl_inc = join(sys.prefix, 'include', 'SDL2')\n if isdir(sdl_inc):\n sdl2_paths = [sdl_inc]\n sdl2_paths.extend(['/usr/local/include/SDL2', '/usr/include/SDL2'])\n\n flags['include_dirs'] = sdl2_paths\n flags['extra_link_args'] = []\n flags['extra_compile_args'] = []\n flags['library_dirs'] = (\n sdl2_paths if sdl2_paths else\n ['/usr/local/lib/'])\n\n if sdl2_flags:\n flags = merge(flags, sdl2_flags)\n\n # ensure headers for all the SDL2 and sub libraries are available\n libs_to_check = ['SDL', 'SDL_mixer', 'SDL_ttf', 'SDL_image']\n can_compile = True\n for lib in libs_to_check:\n found = False\n for d in flags['include_dirs']:\n fn = join(d, '{}.h'.format(lib))\n if exists(fn):\n found = True\n print('SDL2: found {} header at {}'.format(lib, fn))\n break\n\n if not found:\n print('SDL2: missing sub library {}'.format(lib))\n can_compile = False\n\n if not can_compile:\n c_options['use_sdl2'] = False\n return {}\n\n return flags\n\n\nbase_flags = determine_base_flags()\ngl_flags, gl_flags_base = determine_gl_flags()\n\n# -----------------------------------------------------------------------------\n# sources to compile\n# all the dependencies have been found manually with:\n# grep -inr -E '(cimport|include)' kivy/graphics/context_instructions.{pxd,pyx}\ngraphics_dependencies = {\n 'buffer.pyx': ['common.pxi'],\n 'context.pxd': ['instructions.pxd', 'texture.pxd', 'vbo.pxd', 'cgl.pxd'],\n 'cgl.pxd': ['common.pxi', 'config.pxi', 'gl_redirect.h'],\n 'compiler.pxd': ['instructions.pxd'],\n 'compiler.pyx': ['context_instructions.pxd'],\n 'cgl.pyx': ['cgl.pxd'],\n 'cgl_mock.pyx': ['cgl.pxd'],\n 'cgl_sdl2.pyx': ['cgl.pxd'],\n 'cgl_gl.pyx': ['cgl.pxd'],\n 'cgl_glew.pyx': ['cgl.pxd'],\n 'context_instructions.pxd': [\n 'transformation.pxd', 'instructions.pxd', 'texture.pxd'],\n 'fbo.pxd': ['cgl.pxd', 'instructions.pxd', 'texture.pxd'],\n 'fbo.pyx': [\n 'config.pxi', 'opcodes.pxi', 'transformation.pxd', 'context.pxd'],\n 'gl_instructions.pyx': [\n 'config.pxi', 'opcodes.pxi', 'cgl.pxd', 'instructions.pxd'],\n 'instructions.pxd': [\n 'vbo.pxd', 'context_instructions.pxd', 'compiler.pxd', 'shader.pxd',\n 'texture.pxd', '../_event.pxd'],\n 'instructions.pyx': [\n 'config.pxi', 'opcodes.pxi', 'cgl.pxd',\n 'context.pxd', 'common.pxi', 'vertex.pxd', 'transformation.pxd'],\n 'opengl.pyx': [\n 'config.pxi', 'common.pxi', 'cgl.pxd', 'gl_redirect.h'],\n 'opengl_utils.pyx': [\n 'opengl_utils_def.pxi', 'cgl.pxd', ],\n 'shader.pxd': ['cgl.pxd', 'transformation.pxd', 'vertex.pxd'],\n 'shader.pyx': [\n 'config.pxi', 'common.pxi', 'cgl.pxd',\n 'vertex.pxd', 'transformation.pxd', 'context.pxd',\n 'gl_debug_logger.pxi'],\n 'stencil_instructions.pxd': ['instructions.pxd'],\n 'stencil_instructions.pyx': [\n 'config.pxi', 'opcodes.pxi', 'cgl.pxd',\n 'gl_debug_logger.pxi'],\n 'scissor_instructions.pyx': [\n 'config.pxi', 'opcodes.pxi', 'cgl.pxd'],\n 'svg.pyx': ['config.pxi', 'common.pxi', 'texture.pxd', 'instructions.pxd',\n 'vertex_instructions.pxd', 'tesselator.pxd'],\n 'texture.pxd': ['cgl.pxd'],\n 'texture.pyx': [\n 'config.pxi', 'common.pxi', 'opengl_utils_def.pxi', 'context.pxd',\n 'cgl.pxd', 'opengl_utils.pxd',\n 'img_tools.pxi', 'gl_debug_logger.pxi'],\n 'vbo.pxd': ['buffer.pxd', 'cgl.pxd', 'vertex.pxd'],\n 'vbo.pyx': [\n 'config.pxi', 'common.pxi', 'context.pxd',\n 'instructions.pxd', 'shader.pxd', 'gl_debug_logger.pxi'],\n 'vertex.pxd': ['cgl.pxd'],\n 'vertex.pyx': ['config.pxi', 'common.pxi'],\n 'vertex_instructions.pyx': [\n 'config.pxi', 'common.pxi', 'vbo.pxd', 'vertex.pxd',\n 'instructions.pxd', 'vertex_instructions.pxd',\n 'cgl.pxd', 'texture.pxd', 'vertex_instructions_line.pxi'],\n 'vertex_instructions_line.pxi': ['stencil_instructions.pxd']}\n\nsources = {\n '_event.pyx': merge(base_flags, {'depends': ['properties.pxd']}),\n '_clock.pyx': {},\n 'weakproxy.pyx': {},\n 'properties.pyx': merge(base_flags, {'depends': ['_event.pxd']}),\n 'graphics/buffer.pyx': merge(base_flags, gl_flags_base),\n 'graphics/context.pyx': merge(base_flags, gl_flags_base),\n 'graphics/compiler.pyx': merge(base_flags, gl_flags_base),\n 'graphics/context_instructions.pyx': merge(base_flags, gl_flags_base),\n 'graphics/fbo.pyx': merge(base_flags, gl_flags_base),\n 'graphics/gl_instructions.pyx': merge(base_flags, gl_flags_base),\n 'graphics/instructions.pyx': merge(base_flags, gl_flags_base),\n 'graphics/opengl.pyx': merge(base_flags, gl_flags_base),\n 'graphics/opengl_utils.pyx': merge(base_flags, gl_flags_base),\n 'graphics/shader.pyx': merge(base_flags, gl_flags_base),\n 'graphics/stencil_instructions.pyx': merge(base_flags, gl_flags_base),\n 'graphics/scissor_instructions.pyx': merge(base_flags, gl_flags_base),\n 'graphics/texture.pyx': merge(base_flags, gl_flags_base),\n 'graphics/transformation.pyx': merge(base_flags, gl_flags_base),\n 'graphics/vbo.pyx': merge(base_flags, gl_flags_base),\n 'graphics/vertex.pyx': merge(base_flags, gl_flags_base),\n 'graphics/vertex_instructions.pyx': merge(base_flags, gl_flags_base),\n 'graphics/cgl.pyx': merge(base_flags, gl_flags_base),\n 'graphics/cgl_backend/cgl_mock.pyx': merge(base_flags, gl_flags_base),\n 'graphics/cgl_backend/cgl_gl.pyx': merge(base_flags, gl_flags),\n 'graphics/cgl_backend/cgl_glew.pyx': merge(base_flags, gl_flags),\n 'graphics/cgl_backend/cgl_sdl2.pyx': merge(base_flags, gl_flags_base),\n 'graphics/cgl_backend/cgl_debug.pyx': merge(base_flags, gl_flags_base),\n 'core/text/text_layout.pyx': base_flags,\n 'core/window/window_info.pyx': base_flags,\n 'graphics/tesselator.pyx': merge(base_flags, {\n 'include_dirs': ['kivy/lib/libtess2/Include'],\n 'c_depends': [\n 'lib/libtess2/Source/bucketalloc.c',\n 'lib/libtess2/Source/dict.c',\n 'lib/libtess2/Source/geom.c',\n 'lib/libtess2/Source/mesh.c',\n 'lib/libtess2/Source/priorityq.c',\n 'lib/libtess2/Source/sweep.c',\n 'lib/libtess2/Source/tess.c'\n ]\n }),\n 'graphics/svg.pyx': merge(base_flags, gl_flags_base)\n}\n\nif c_options[\"use_sdl2\"]:\n sdl2_flags = determine_sdl2()\n\nif c_options['use_sdl2'] and sdl2_flags:\n sources['graphics/cgl_backend/cgl_sdl2.pyx'] = merge(\n sources['graphics/cgl_backend/cgl_sdl2.pyx'], sdl2_flags)\n sdl2_depends = {'depends': ['lib/sdl2.pxi']}\n for source_file in ('core/window/_window_sdl2.pyx',\n 'core/image/_img_sdl2.pyx',\n 'core/text/_text_sdl2.pyx',\n 'core/audio/audio_sdl2.pyx',\n 'core/clipboard/_clipboard_sdl2.pyx'):\n sources[source_file] = merge(\n base_flags, sdl2_flags, sdl2_depends)\n\nif platform in ('darwin', 'ios'):\n # activate ImageIO provider for our core image\n if platform == 'ios':\n osx_flags = {'extra_link_args': [\n '-framework', 'Foundation',\n '-framework', 'UIKit',\n '-framework', 'AudioToolbox',\n '-framework', 'CoreGraphics',\n '-framework', 'QuartzCore',\n '-framework', 'ImageIO',\n '-framework', 'Accelerate']}\n else:\n osx_flags = {'extra_link_args': [\n '-framework', 'ApplicationServices']}\n sources['core/image/img_imageio.pyx'] = merge(\n base_flags, osx_flags)\n\nif c_options['use_avfoundation']:\n import platform as _platform\n mac_ver = [int(x) for x in _platform.mac_ver()[0].split('.')[:2]]\n if mac_ver >= [10, 7]:\n osx_flags = {\n 'extra_link_args': ['-framework', 'AVFoundation'],\n 'extra_compile_args': ['-ObjC++'],\n 'depends': ['core/camera/camera_avfoundation_implem.m']}\n sources['core/camera/camera_avfoundation.pyx'] = merge(\n base_flags, osx_flags)\n else:\n print('AVFoundation cannot be used, OSX >= 10.7 is required')\n\nif c_options['use_rpi']:\n sources['lib/vidcore_lite/egl.pyx'] = merge(\n base_flags, gl_flags)\n sources['lib/vidcore_lite/bcm.pyx'] = merge(\n base_flags, gl_flags)\n\nif c_options['use_x11']:\n libs = ['Xrender', 'X11']\n if c_options['use_egl']:\n libs += ['EGL']\n else:\n libs += ['GL']\n sources['core/window/window_x11.pyx'] = merge(\n base_flags, gl_flags, {\n # FIXME add an option to depend on them but not compile them\n # cause keytab is included in core, and core is included in\n # window_x11\n #\n # 'depends': [\n # 'core/window/window_x11_keytab.c',\n # 'core/window/window_x11_core.c'],\n 'libraries': libs})\n\nif c_options['use_gstreamer']:\n sources['lib/gstplayer/_gstplayer.pyx'] = merge(\n base_flags, gst_flags, {\n 'depends': ['lib/gstplayer/_gstplayer.h']})\n\n\n# -----------------------------------------------------------------------------\n# extension modules\n\ndef get_dependencies(name, deps=None):\n if deps is None:\n deps = []\n for dep in graphics_dependencies.get(name, []):\n if dep not in deps:\n deps.append(dep)\n get_dependencies(dep, deps)\n return deps\n\n\ndef resolve_dependencies(fn, depends):\n fn = basename(fn)\n deps = []\n get_dependencies(fn, deps)\n get_dependencies(fn.replace('.pyx', '.pxd'), deps)\n\n deps_final = []\n paths_to_test = ['graphics', 'include']\n for dep in deps:\n found = False\n for path in paths_to_test:\n filename = expand(src_path, path, dep)\n if exists(filename):\n deps_final.append(filename)\n found = True\n break\n if not found:\n print('ERROR: Dependency for {} not resolved: {}'.format(\n fn, dep\n ))\n\n return deps_final\n\n\ndef get_extensions_from_sources(sources):\n ext_modules = []\n if environ.get('KIVY_FAKE_BUILDEXT'):\n print('Fake build_ext asked, will generate only .h/.c')\n return ext_modules\n for pyx, flags in sources.items():\n is_graphics = pyx.startswith('graphics')\n pyx = expand(src_path, pyx)\n depends = [expand(src_path, x) for x in flags.pop('depends', [])]\n c_depends = [expand(src_path, x) for x in flags.pop('c_depends', [])]\n if not have_cython:\n pyx = '%s.c' % pyx[:-4]\n if is_graphics:\n depends = resolve_dependencies(pyx, depends)\n f_depends = [x for x in depends if x.rsplit('.', 1)[-1] in (\n 'c', 'cpp', 'm')]\n module_name = get_modulename_from_file(pyx)\n flags_clean = {'depends': depends}\n for key, value in flags.items():\n if len(value):\n flags_clean[key] = value\n ext_modules.append(CythonExtension(\n module_name, [pyx] + f_depends + c_depends, **flags_clean))\n return ext_modules\n\n\next_modules = get_extensions_from_sources(sources)\n\n\n# -----------------------------------------------------------------------------\n# automatically detect data files\nsplit_examples = int(environ.get('KIVY_SPLIT_EXAMPLES', '0'))\ndata_file_prefix = 'share/kivy-'\nexamples = {}\nexamples_allowed_ext = ('readme', 'py', 'wav', 'png', 'jpg', 'svg', 'json',\n 'avi', 'gif', 'txt', 'ttf', 'obj', 'mtl', 'kv', 'mpg',\n 'glsl', 'zip')\nfor root, subFolders, files in walk('examples'):\n for fn in files:\n ext = fn.split('.')[-1].lower()\n if ext not in examples_allowed_ext:\n continue\n filename = join(root, fn)\n directory = '%s%s' % (data_file_prefix, dirname(filename))\n if directory not in examples:\n examples[directory] = []\n examples[directory].append(filename)\n\nbinary_deps = []\nbinary_deps_path = join(src_path, 'kivy', 'binary_deps')\nif isdir(binary_deps_path):\n for root, dirnames, filenames in walk(binary_deps_path):\n for fname in filenames:\n binary_deps.append(\n join(root.replace(binary_deps_path, 'binary_deps'), fname))\n\n# -----------------------------------------------------------------------------\n# setup !\nif not build_examples:\n setup(\n name='Kivy',\n version=get_version(),\n author='Kivy Team and other contributors',\n author_email='[email protected]',\n url='http://kivy.org',\n license='MIT',\n description=(\n 'A software library for rapid development of '\n 'hardware-accelerated multitouch applications.'),\n ext_modules=ext_modules,\n cmdclass=cmdclass,\n packages=[\n 'kivy',\n 'kivy.adapters',\n 'kivy.core',\n 'kivy.core.audio',\n 'kivy.core.camera',\n 'kivy.core.clipboard',\n 'kivy.core.image',\n 'kivy.core.gl',\n 'kivy.core.spelling',\n 'kivy.core.text',\n 'kivy.core.video',\n 'kivy.core.window',\n 'kivy.deps',\n 'kivy.effects',\n 'kivy.graphics',\n 'kivy.graphics.cgl_backend',\n 'kivy.garden',\n 'kivy.input',\n 'kivy.input.postproc',\n 'kivy.input.providers',\n 'kivy.lang',\n 'kivy.lib',\n 'kivy.lib.osc',\n 'kivy.lib.gstplayer',\n 'kivy.lib.vidcore_lite',\n 'kivy.modules',\n 'kivy.network',\n 'kivy.storage',\n 'kivy.tests',\n 'kivy.tools',\n 'kivy.tools.packaging',\n 'kivy.tools.packaging.pyinstaller_hooks',\n 'kivy.tools.highlight',\n 'kivy.extras',\n 'kivy.uix',\n 'kivy.uix.behaviors',\n 'kivy.uix.recycleview',\n ],\n package_dir={'kivy': 'kivy'},\n package_data={'kivy': [\n 'setupconfig.py'\n '*.pxd',\n '*.pxi',\n 'core/text/*.pxd',\n 'core/text/*.pxi',\n 'core/window/*.pxi',\n 'core/window/*.pxd',\n 'graphics/*.pxd',\n 'graphics/*.pxi',\n 'graphics/*.h',\n 'include/*',\n 'lib/vidcore_lite/*.pxd',\n 'lib/vidcore_lite/*.pxi',\n 'data/*.kv',\n 'data/*.json',\n 'data/fonts/*.ttf',\n 'data/images/*.png',\n 'data/images/*.jpg',\n 'data/images/*.gif',\n 'data/images/*.atlas',\n 'data/keyboards/*.json',\n 'data/logo/*.png',\n 'data/glsl/*.png',\n 'data/glsl/*.vs',\n 'data/glsl/*.fs',\n 'tests/*.zip',\n 'tests/*.kv',\n 'tests/*.png',\n 'tests/*.ttf',\n 'tests/*.ogg',\n 'tools/gles_compat/*',\n 'tools/highlight/*',\n 'tools/packaging/README.txt',\n 'tools/packaging/win32/kivy.bat',\n 'tools/packaging/win32/kivyenv.sh',\n 'tools/packaging/win32/README.txt',\n 'tools/packaging/osx/Info.plist',\n 'tools/packaging/osx/InfoPlist.strings',\n 'tools/packaging/osx/kivy.sh',\n 'tools/pep8checker/*',\n 'tools/theming/defaulttheme/*',\n ] + binary_deps},\n data_files=[] if split_examples else list(examples.items()),\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'Environment :: MacOS X',\n 'Environment :: Win32 (MS Windows)',\n 'Environment :: X11 Applications',\n 'Intended Audience :: Developers',\n 'Intended Audience :: End Users/Desktop',\n 'Intended Audience :: Information Technology',\n 'Intended Audience :: Science/Research',\n 'License :: OSI Approved :: MIT License',\n 'Natural Language :: English',\n 'Operating System :: MacOS :: MacOS X',\n 'Operating System :: Microsoft :: Windows',\n 'Operating System :: POSIX :: BSD :: FreeBSD',\n 'Operating System :: POSIX :: Linux',\n 'Programming Language :: Python :: 2.7',\n 'Programming Language :: Python :: 3.3',\n 'Programming Language :: Python :: 3.4',\n 'Programming Language :: Python :: 3.5',\n 'Programming Language :: Python :: 3.6',\n 'Topic :: Artistic Software',\n 'Topic :: Games/Entertainment',\n 'Topic :: Multimedia :: Graphics :: 3D Rendering',\n 'Topic :: Multimedia :: Graphics :: Capture :: Digital Camera',\n 'Topic :: Multimedia :: Graphics :: Presentation',\n 'Topic :: Multimedia :: Graphics :: Viewers',\n 'Topic :: Multimedia :: Sound/Audio :: Players :: MP3',\n 'Topic :: Multimedia :: Video :: Display',\n 'Topic :: Scientific/Engineering :: Human Machine Interfaces',\n 'Topic :: Scientific/Engineering :: Visualization',\n ('Topic :: Software Development :: Libraries :: '\n 'Application Frameworks'),\n 'Topic :: Software Development :: User Interfaces'],\n dependency_links=[\n 'https://github.com/kivy-garden/garden/archive/master.zip'],\n install_requires=['Kivy-Garden>=0.1.4', 'docutils', 'pygments'],\n setup_requires=[\n 'cython>=' + MIN_CYTHON_STRING\n ] if not skip_cython else [])\nelse:\n setup(\n name='Kivy-examples',\n version=get_version(),\n author='Kivy Team and other contributors',\n author_email='[email protected]',\n url='http://kivy.org',\n license='MIT',\n description=('Kivy examples.'),\n data_files=list(examples.items()))\n", "path": "setup.py"}]} |
gh_patches_debug_279 | rasdani/github-patches | git_diff | DDMAL__CantusDB-1043 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Admin Area: Hide "Volpiano notes" and "Volpiano interval" fields
We currently display these fields in the admin area, but they are only for internal use. Instead, we should hide these fields (i.e., exclude, instead of readonly_fields).
--- 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/main_app/admin.py`
Content:
```
1 from django.contrib import admin
2 from main_app.models import *
3 from main_app.forms import (
4 AdminCenturyForm,
5 AdminChantForm,
6 AdminFeastForm,
7 AdminGenreForm,
8 AdminNotationForm,
9 AdminOfficeForm,
10 AdminProvenanceForm,
11 AdminRismSiglumForm,
12 AdminSegmentForm,
13 AdminSequenceForm,
14 AdminSourceForm,
15 )
16
17 # these fields should not be editable by all classes
18 EXCLUDE = (
19 "created_by",
20 "last_updated_by",
21 "json_info",
22 )
23
24
25 class BaseModelAdmin(admin.ModelAdmin):
26 exclude = EXCLUDE
27
28 # if an object is created in the admin interface, assign the user to the created_by field
29 # else if an object is updated in the admin interface, assign the user to the last_updated_by field
30 def save_model(self, request, obj, form, change):
31 if change:
32 obj.last_updated_by = request.user
33 else:
34 obj.created_by = request.user
35 super().save_model(request, obj, form, change)
36
37
38 class CenturyAdmin(BaseModelAdmin):
39 search_fields = ("name",)
40 form = AdminCenturyForm
41
42
43 class ChantAdmin(BaseModelAdmin):
44 @admin.display(description="Source Siglum")
45 def get_source_siglum(self, obj):
46 if obj.source:
47 return obj.source.siglum
48
49 list_display = (
50 "incipit",
51 "get_source_siglum",
52 "genre",
53 )
54 search_fields = (
55 "title",
56 "incipit",
57 "cantus_id",
58 "id",
59 )
60
61 readonly_fields = (
62 "date_created",
63 "date_updated",
64 )
65
66 list_filter = (
67 "genre",
68 "office",
69 )
70 exclude = EXCLUDE + (
71 "col1",
72 "col2",
73 "col3",
74 "next_chant",
75 "s_sequence",
76 "is_last_chant_in_feast",
77 "visible_status",
78 "date",
79 )
80 form = AdminChantForm
81 raw_id_fields = (
82 "source",
83 "feast",
84 )
85 ordering = ("source__siglum",)
86
87
88 class FeastAdmin(BaseModelAdmin):
89 search_fields = (
90 "name",
91 "feast_code",
92 )
93 list_display = (
94 "name",
95 "month",
96 "day",
97 "feast_code",
98 )
99 form = AdminFeastForm
100
101
102 class GenreAdmin(BaseModelAdmin):
103 search_fields = ("name",)
104 form = AdminGenreForm
105
106
107 class NotationAdmin(BaseModelAdmin):
108 search_fields = ("name",)
109 form = AdminNotationForm
110
111
112 class OfficeAdmin(BaseModelAdmin):
113 search_fields = ("name",)
114 form = AdminOfficeForm
115
116
117 class ProvenanceAdmin(BaseModelAdmin):
118 search_fields = ("name",)
119 form = AdminProvenanceForm
120
121
122 class RismSiglumAdmin(BaseModelAdmin):
123 search_fields = ("name",)
124 form = AdminRismSiglumForm
125
126
127 class SegmentAdmin(BaseModelAdmin):
128 search_fields = ("name",)
129 form = AdminSegmentForm
130
131
132 class SequenceAdmin(BaseModelAdmin):
133 @admin.display(description="Source Siglum")
134 def get_source_siglum(self, obj):
135 if obj.source:
136 return obj.source.siglum
137
138 search_fields = (
139 "title",
140 "incipit",
141 "cantus_id",
142 "id",
143 )
144 exclude = EXCLUDE + (
145 "c_sequence",
146 "next_chant",
147 "is_last_chant_in_feast",
148 "visible_status",
149 )
150 list_display = ("incipit", "get_source_siglum", "genre")
151 list_filter = (
152 "genre",
153 "office",
154 )
155 raw_id_fields = (
156 "source",
157 "feast",
158 )
159 ordering = ("source__siglum",)
160 form = AdminSequenceForm
161
162
163 class SourceAdmin(BaseModelAdmin):
164 # These search fields are also available on the user-source inline relationship in the user admin page
165 search_fields = (
166 "siglum",
167 "title",
168 "id",
169 )
170 readonly_fields = (
171 "number_of_chants",
172 "number_of_melodies",
173 "date_created",
174 "date_updated",
175 )
176 # from the Django docs:
177 # Adding a ManyToManyField to this list will instead use a nifty unobtrusive JavaScript “filter” interface
178 # that allows searching within the options. The unselected and selected options appear in two boxes side by side.
179 filter_horizontal = (
180 "century",
181 "notation",
182 "current_editors",
183 "inventoried_by",
184 "full_text_entered_by",
185 "melodies_entered_by",
186 "proofreaders",
187 "other_editors",
188 )
189
190 list_display = (
191 "title",
192 "siglum",
193 "id",
194 )
195
196 list_filter = (
197 "full_source",
198 "segment",
199 "source_status",
200 "published",
201 "century",
202 )
203
204 ordering = ("siglum",)
205
206 form = AdminSourceForm
207
208
209 admin.site.register(Century, CenturyAdmin)
210 admin.site.register(Chant, ChantAdmin)
211 admin.site.register(Feast, FeastAdmin)
212 admin.site.register(Genre, GenreAdmin)
213 admin.site.register(Notation, NotationAdmin)
214 admin.site.register(Office, OfficeAdmin)
215 admin.site.register(Provenance, ProvenanceAdmin)
216 admin.site.register(RismSiglum, RismSiglumAdmin)
217 admin.site.register(Segment, SegmentAdmin)
218 admin.site.register(Sequence, SequenceAdmin)
219 admin.site.register(Source, SourceAdmin)
220
```
--- 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/main_app/admin.py b/django/cantusdb_project/main_app/admin.py
--- a/django/cantusdb_project/main_app/admin.py
+++ b/django/cantusdb_project/main_app/admin.py
@@ -76,6 +76,8 @@
"is_last_chant_in_feast",
"visible_status",
"date",
+ "volpiano_notes",
+ "volpiano_intervals",
)
form = AdminChantForm
raw_id_fields = (
| {"golden_diff": "diff --git a/django/cantusdb_project/main_app/admin.py b/django/cantusdb_project/main_app/admin.py\n--- a/django/cantusdb_project/main_app/admin.py\n+++ b/django/cantusdb_project/main_app/admin.py\n@@ -76,6 +76,8 @@\n \"is_last_chant_in_feast\",\n \"visible_status\",\n \"date\",\n+ \"volpiano_notes\",\n+ \"volpiano_intervals\",\n )\n form = AdminChantForm\n raw_id_fields = (\n", "issue": "Admin Area: Hide \"Volpiano notes\" and \"Volpiano interval\" fields\nWe currently display these fields in the admin area, but they are only for internal use. Instead, we should hide these fields (i.e., exclude, instead of readonly_fields).\n", "before_files": [{"content": "from django.contrib import admin\nfrom main_app.models import *\nfrom main_app.forms import (\n AdminCenturyForm,\n AdminChantForm,\n AdminFeastForm,\n AdminGenreForm,\n AdminNotationForm,\n AdminOfficeForm,\n AdminProvenanceForm,\n AdminRismSiglumForm,\n AdminSegmentForm,\n AdminSequenceForm,\n AdminSourceForm,\n)\n\n# these fields should not be editable by all classes\nEXCLUDE = (\n \"created_by\",\n \"last_updated_by\",\n \"json_info\",\n)\n\n\nclass BaseModelAdmin(admin.ModelAdmin):\n exclude = EXCLUDE\n\n # if an object is created in the admin interface, assign the user to the created_by field\n # else if an object is updated in the admin interface, assign the user to the last_updated_by field\n def save_model(self, request, obj, form, change):\n if change:\n obj.last_updated_by = request.user\n else:\n obj.created_by = request.user\n super().save_model(request, obj, form, change)\n\n\nclass CenturyAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminCenturyForm\n\n\nclass ChantAdmin(BaseModelAdmin):\n @admin.display(description=\"Source Siglum\")\n def get_source_siglum(self, obj):\n if obj.source:\n return obj.source.siglum\n\n list_display = (\n \"incipit\",\n \"get_source_siglum\",\n \"genre\",\n )\n search_fields = (\n \"title\",\n \"incipit\",\n \"cantus_id\",\n \"id\",\n )\n\n readonly_fields = (\n \"date_created\",\n \"date_updated\",\n )\n\n list_filter = (\n \"genre\",\n \"office\",\n )\n exclude = EXCLUDE + (\n \"col1\",\n \"col2\",\n \"col3\",\n \"next_chant\",\n \"s_sequence\",\n \"is_last_chant_in_feast\",\n \"visible_status\",\n \"date\",\n )\n form = AdminChantForm\n raw_id_fields = (\n \"source\",\n \"feast\",\n )\n ordering = (\"source__siglum\",)\n\n\nclass FeastAdmin(BaseModelAdmin):\n search_fields = (\n \"name\",\n \"feast_code\",\n )\n list_display = (\n \"name\",\n \"month\",\n \"day\",\n \"feast_code\",\n )\n form = AdminFeastForm\n\n\nclass GenreAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminGenreForm\n\n\nclass NotationAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminNotationForm\n\n\nclass OfficeAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminOfficeForm\n\n\nclass ProvenanceAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminProvenanceForm\n\n\nclass RismSiglumAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminRismSiglumForm\n\n\nclass SegmentAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminSegmentForm\n\n\nclass SequenceAdmin(BaseModelAdmin):\n @admin.display(description=\"Source Siglum\")\n def get_source_siglum(self, obj):\n if obj.source:\n return obj.source.siglum\n\n search_fields = (\n \"title\",\n \"incipit\",\n \"cantus_id\",\n \"id\",\n )\n exclude = EXCLUDE + (\n \"c_sequence\",\n \"next_chant\",\n \"is_last_chant_in_feast\",\n \"visible_status\",\n )\n list_display = (\"incipit\", \"get_source_siglum\", \"genre\")\n list_filter = (\n \"genre\",\n \"office\",\n )\n raw_id_fields = (\n \"source\",\n \"feast\",\n )\n ordering = (\"source__siglum\",)\n form = AdminSequenceForm\n\n\nclass SourceAdmin(BaseModelAdmin):\n # These search fields are also available on the user-source inline relationship in the user admin page\n search_fields = (\n \"siglum\",\n \"title\",\n \"id\",\n )\n readonly_fields = (\n \"number_of_chants\",\n \"number_of_melodies\",\n \"date_created\",\n \"date_updated\",\n )\n # from the Django docs:\n # Adding a ManyToManyField to this list will instead use a nifty unobtrusive JavaScript \u201cfilter\u201d interface\n # that allows searching within the options. The unselected and selected options appear in two boxes side by side.\n filter_horizontal = (\n \"century\",\n \"notation\",\n \"current_editors\",\n \"inventoried_by\",\n \"full_text_entered_by\",\n \"melodies_entered_by\",\n \"proofreaders\",\n \"other_editors\",\n )\n\n list_display = (\n \"title\",\n \"siglum\",\n \"id\",\n )\n\n list_filter = (\n \"full_source\",\n \"segment\",\n \"source_status\",\n \"published\",\n \"century\",\n )\n\n ordering = (\"siglum\",)\n\n form = AdminSourceForm\n\n\nadmin.site.register(Century, CenturyAdmin)\nadmin.site.register(Chant, ChantAdmin)\nadmin.site.register(Feast, FeastAdmin)\nadmin.site.register(Genre, GenreAdmin)\nadmin.site.register(Notation, NotationAdmin)\nadmin.site.register(Office, OfficeAdmin)\nadmin.site.register(Provenance, ProvenanceAdmin)\nadmin.site.register(RismSiglum, RismSiglumAdmin)\nadmin.site.register(Segment, SegmentAdmin)\nadmin.site.register(Sequence, SequenceAdmin)\nadmin.site.register(Source, SourceAdmin)\n", "path": "django/cantusdb_project/main_app/admin.py"}], "after_files": [{"content": "from django.contrib import admin\nfrom main_app.models import *\nfrom main_app.forms import (\n AdminCenturyForm,\n AdminChantForm,\n AdminFeastForm,\n AdminGenreForm,\n AdminNotationForm,\n AdminOfficeForm,\n AdminProvenanceForm,\n AdminRismSiglumForm,\n AdminSegmentForm,\n AdminSequenceForm,\n AdminSourceForm,\n)\n\n# these fields should not be editable by all classes\nEXCLUDE = (\n \"created_by\",\n \"last_updated_by\",\n \"json_info\",\n)\n\n\nclass BaseModelAdmin(admin.ModelAdmin):\n exclude = EXCLUDE\n\n # if an object is created in the admin interface, assign the user to the created_by field\n # else if an object is updated in the admin interface, assign the user to the last_updated_by field\n def save_model(self, request, obj, form, change):\n if change:\n obj.last_updated_by = request.user\n else:\n obj.created_by = request.user\n super().save_model(request, obj, form, change)\n\n\nclass CenturyAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminCenturyForm\n\n\nclass ChantAdmin(BaseModelAdmin):\n @admin.display(description=\"Source Siglum\")\n def get_source_siglum(self, obj):\n if obj.source:\n return obj.source.siglum\n\n list_display = (\n \"incipit\",\n \"get_source_siglum\",\n \"genre\",\n )\n search_fields = (\n \"title\",\n \"incipit\",\n \"cantus_id\",\n \"id\",\n )\n\n readonly_fields = (\n \"date_created\",\n \"date_updated\",\n )\n\n list_filter = (\n \"genre\",\n \"office\",\n )\n exclude = EXCLUDE + (\n \"col1\",\n \"col2\",\n \"col3\",\n \"next_chant\",\n \"s_sequence\",\n \"is_last_chant_in_feast\",\n \"visible_status\",\n \"date\",\n \"volpiano_notes\",\n \"volpiano_intervals\",\n )\n form = AdminChantForm\n raw_id_fields = (\n \"source\",\n \"feast\",\n )\n ordering = (\"source__siglum\",)\n\n\nclass FeastAdmin(BaseModelAdmin):\n search_fields = (\n \"name\",\n \"feast_code\",\n )\n list_display = (\n \"name\",\n \"month\",\n \"day\",\n \"feast_code\",\n )\n form = AdminFeastForm\n\n\nclass GenreAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminGenreForm\n\n\nclass NotationAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminNotationForm\n\n\nclass OfficeAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminOfficeForm\n\n\nclass ProvenanceAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminProvenanceForm\n\n\nclass RismSiglumAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminRismSiglumForm\n\n\nclass SegmentAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminSegmentForm\n\n\nclass SequenceAdmin(BaseModelAdmin):\n @admin.display(description=\"Source Siglum\")\n def get_source_siglum(self, obj):\n if obj.source:\n return obj.source.siglum\n\n search_fields = (\n \"title\",\n \"incipit\",\n \"cantus_id\",\n \"id\",\n )\n exclude = EXCLUDE + (\n \"c_sequence\",\n \"next_chant\",\n \"is_last_chant_in_feast\",\n \"visible_status\",\n )\n list_display = (\"incipit\", \"get_source_siglum\", \"genre\")\n list_filter = (\n \"genre\",\n \"office\",\n )\n raw_id_fields = (\n \"source\",\n \"feast\",\n )\n ordering = (\"source__siglum\",)\n form = AdminSequenceForm\n\n\nclass SourceAdmin(BaseModelAdmin):\n # These search fields are also available on the user-source inline relationship in the user admin page\n search_fields = (\n \"siglum\",\n \"title\",\n \"id\",\n )\n readonly_fields = (\n \"number_of_chants\",\n \"number_of_melodies\",\n \"date_created\",\n \"date_updated\",\n )\n # from the Django docs:\n # Adding a ManyToManyField to this list will instead use a nifty unobtrusive JavaScript \u201cfilter\u201d interface\n # that allows searching within the options. The unselected and selected options appear in two boxes side by side.\n filter_horizontal = (\n \"century\",\n \"notation\",\n \"current_editors\",\n \"inventoried_by\",\n \"full_text_entered_by\",\n \"melodies_entered_by\",\n \"proofreaders\",\n \"other_editors\",\n )\n\n list_display = (\n \"title\",\n \"siglum\",\n \"id\",\n )\n\n list_filter = (\n \"full_source\",\n \"segment\",\n \"source_status\",\n \"published\",\n \"century\",\n )\n\n ordering = (\"siglum\",)\n\n form = AdminSourceForm\n\n\nadmin.site.register(Century, CenturyAdmin)\nadmin.site.register(Chant, ChantAdmin)\nadmin.site.register(Feast, FeastAdmin)\nadmin.site.register(Genre, GenreAdmin)\nadmin.site.register(Notation, NotationAdmin)\nadmin.site.register(Office, OfficeAdmin)\nadmin.site.register(Provenance, ProvenanceAdmin)\nadmin.site.register(RismSiglum, RismSiglumAdmin)\nadmin.site.register(Segment, SegmentAdmin)\nadmin.site.register(Sequence, SequenceAdmin)\nadmin.site.register(Source, SourceAdmin)\n", "path": "django/cantusdb_project/main_app/admin.py"}]} |
gh_patches_debug_280 | rasdani/github-patches | git_diff | streamlit__streamlit-7257 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Changing start_time of st.video() doesn't work for the same video
### 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
Changing start_time of st.video() doesn't work for the same video.
### Reproducible Code Example
```Python
import streamlit as st
timestamp = st.text_input('timestamp', '6')
st.video('local video path', start_time=int(timestamp))
```
### Steps To Reproduce
1. Replace 'local video path' with your own video path in the provided code, and run the code
2. Type different timestamp in the text input box
3. The video timestamp doesn't change
### Expected Behavior
The timestamp should change as start_time changes.
### Current Behavior
The video timestamp doesn't change. It always shows the initial timestamp. However, if you change the video to a different one in the source code and rerun the app, the timestamp will change correctly.
### Is this a regression?
- [ ] Yes, this used to work in a previous version.
### Debug info
- Streamlit version: 1.25.0
- Python version: Python 3.10.11
- Operating System: Windows 11 Home 22H2
- Browser: Microsoft Edge Version 115.0.1901.188 (Official build) (64-bit)
### Additional Information
_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: `e2e/scripts/st_video.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 requests
16
17 import streamlit as st
18
19 url = "https://www.w3schools.com/html/mov_bbb.mp4"
20 file = requests.get(url).content
21 st.video(file)
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/e2e/scripts/st_video.py b/e2e/scripts/st_video.py
--- a/e2e/scripts/st_video.py
+++ b/e2e/scripts/st_video.py
@@ -19,3 +19,7 @@
url = "https://www.w3schools.com/html/mov_bbb.mp4"
file = requests.get(url).content
st.video(file)
+
+# Test start time with widget
+timestamp = st.number_input("Start Time (in seconds)", min_value=0, value=6)
+st.video(url, start_time=int(timestamp))
| {"golden_diff": "diff --git a/e2e/scripts/st_video.py b/e2e/scripts/st_video.py\n--- a/e2e/scripts/st_video.py\n+++ b/e2e/scripts/st_video.py\n@@ -19,3 +19,7 @@\n url = \"https://www.w3schools.com/html/mov_bbb.mp4\"\n file = requests.get(url).content\n st.video(file)\n+\n+# Test start time with widget\n+timestamp = st.number_input(\"Start Time (in seconds)\", min_value=0, value=6)\n+st.video(url, start_time=int(timestamp))\n", "issue": "Changing start_time of st.video() doesn't work for the same video\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\nChanging start_time of st.video() doesn't work for the same video.\r\n\r\n### Reproducible Code Example\r\n\r\n```Python\r\nimport streamlit as st\r\n\r\ntimestamp = st.text_input('timestamp', '6')\r\nst.video('local video path', start_time=int(timestamp))\r\n```\r\n\r\n\r\n### Steps To Reproduce\r\n\r\n1. Replace 'local video path' with your own video path in the provided code, and run the code\r\n2. Type different timestamp in the text input box\r\n3. The video timestamp doesn't change\r\n\r\n### Expected Behavior\r\n\r\nThe timestamp should change as start_time changes.\r\n\r\n### Current Behavior\r\n\r\nThe video timestamp doesn't change. It always shows the initial timestamp. However, if you change the video to a different one in the source code and rerun the app, the timestamp will change correctly.\r\n\r\n### Is this a regression?\r\n\r\n- [ ] Yes, this used to work in a previous version.\r\n\r\n### Debug info\r\n\r\n- Streamlit version: 1.25.0\r\n- Python version: Python 3.10.11\r\n- Operating System: Windows 11 Home 22H2\r\n- Browser: Microsoft Edge Version 115.0.1901.188 (Official build) (64-bit)\r\n\r\n\r\n### Additional Information\r\n\r\n_No response_\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 requests\n\nimport streamlit as st\n\nurl = \"https://www.w3schools.com/html/mov_bbb.mp4\"\nfile = requests.get(url).content\nst.video(file)\n", "path": "e2e/scripts/st_video.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 requests\n\nimport streamlit as st\n\nurl = \"https://www.w3schools.com/html/mov_bbb.mp4\"\nfile = requests.get(url).content\nst.video(file)\n\n# Test start time with widget\ntimestamp = st.number_input(\"Start Time (in seconds)\", min_value=0, value=6)\nst.video(url, start_time=int(timestamp))\n", "path": "e2e/scripts/st_video.py"}]} |
gh_patches_debug_281 | rasdani/github-patches | git_diff | aio-libs__aiohttp-7245 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Websocket client send wrong Connection header
### Describe the bug
In websocket standard , the `Connection` header shoule be `Upgrade`, but we send a `upgrade` .
It's a lowercase word.
### To Reproduce
connect to server with strict case sensitive checking will failed
### Expected behavior
Send a
`Connection: Upgrade`
header
### Logs/tracebacks
```python-traceback
no traceback
```
### Python Version
```console
Python 3.8.16
```
### aiohttp Version
```console
Name: aiohttp
Version: 3.8.4
Summary: Async http client/server framework (asyncio)
Home-page: https://github.com/aio-libs/aiohttp
Author:
Author-email:
License: Apache 2
Location: /opt/homebrew/lib/python3.8/site-packages
Requires: aiosignal, async-timeout, attrs, charset-normalizer, frozenlist, multidict, yarl
Required-by: web3
```
### multidict Version
```console
Name: multidict
Version: 6.0.4
Summary: multidict implementation
Home-page: https://github.com/aio-libs/multidict
Author: Andrew Svetlov
Author-email: [email protected]
License: Apache 2
Location: /opt/homebrew/lib/python3.8/site-packages
Requires:
Required-by: aiohttp, yarl
```
### yarl Version
```console
Name: yarl
Version: 1.8.2
Summary: Yet another URL library
Home-page: https://github.com/aio-libs/yarl/
Author: Andrew Svetlov
Author-email: [email protected]
License: Apache 2
Location: /opt/homebrew/lib/python3.8/site-packages
Requires: idna, multidict
Required-by: aiohttp, gql
```
### OS
MacOs
### Related component
Client
### Additional context
_No response_
### Code of Conduct
- [X] I agree to follow the aio-libs 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: `aiohttp/client.py`
Content:
```
1 """HTTP Client for asyncio."""
2
3 import asyncio
4 import base64
5 import hashlib
6 import json
7 import os
8 import sys
9 import traceback
10 import warnings
11 from contextlib import suppress
12 from types import SimpleNamespace, TracebackType
13 from typing import (
14 Any,
15 Awaitable,
16 Callable,
17 Coroutine,
18 FrozenSet,
19 Generator,
20 Generic,
21 Iterable,
22 List,
23 Mapping,
24 Optional,
25 Set,
26 Tuple,
27 Type,
28 TypeVar,
29 Union,
30 )
31
32 import attr
33 from multidict import CIMultiDict, MultiDict, MultiDictProxy, istr
34 from yarl import URL
35
36 from . import hdrs, http, payload
37 from .abc import AbstractCookieJar
38 from .client_exceptions import (
39 ClientConnectionError as ClientConnectionError,
40 ClientConnectorCertificateError as ClientConnectorCertificateError,
41 ClientConnectorError as ClientConnectorError,
42 ClientConnectorSSLError as ClientConnectorSSLError,
43 ClientError as ClientError,
44 ClientHttpProxyError as ClientHttpProxyError,
45 ClientOSError as ClientOSError,
46 ClientPayloadError as ClientPayloadError,
47 ClientProxyConnectionError as ClientProxyConnectionError,
48 ClientResponseError as ClientResponseError,
49 ClientSSLError as ClientSSLError,
50 ContentTypeError as ContentTypeError,
51 InvalidURL as InvalidURL,
52 ServerConnectionError as ServerConnectionError,
53 ServerDisconnectedError as ServerDisconnectedError,
54 ServerFingerprintMismatch as ServerFingerprintMismatch,
55 ServerTimeoutError as ServerTimeoutError,
56 TooManyRedirects as TooManyRedirects,
57 WSServerHandshakeError as WSServerHandshakeError,
58 )
59 from .client_reqrep import (
60 ClientRequest as ClientRequest,
61 ClientResponse as ClientResponse,
62 Fingerprint as Fingerprint,
63 RequestInfo as RequestInfo,
64 _merge_ssl_params,
65 )
66 from .client_ws import ClientWebSocketResponse as ClientWebSocketResponse
67 from .connector import (
68 BaseConnector as BaseConnector,
69 NamedPipeConnector as NamedPipeConnector,
70 TCPConnector as TCPConnector,
71 UnixConnector as UnixConnector,
72 )
73 from .cookiejar import CookieJar
74 from .helpers import (
75 _SENTINEL,
76 DEBUG,
77 BasicAuth,
78 TimeoutHandle,
79 ceil_timeout,
80 get_env_proxy_for_url,
81 get_running_loop,
82 sentinel,
83 strip_auth_from_url,
84 )
85 from .http import WS_KEY, HttpVersion, WebSocketReader, WebSocketWriter
86 from .http_websocket import WSHandshakeError, WSMessage, ws_ext_gen, ws_ext_parse
87 from .streams import FlowControlDataQueue
88 from .tracing import Trace, TraceConfig
89 from .typedefs import Final, JSONEncoder, LooseCookies, LooseHeaders, StrOrURL
90
91 __all__ = (
92 # client_exceptions
93 "ClientConnectionError",
94 "ClientConnectorCertificateError",
95 "ClientConnectorError",
96 "ClientConnectorSSLError",
97 "ClientError",
98 "ClientHttpProxyError",
99 "ClientOSError",
100 "ClientPayloadError",
101 "ClientProxyConnectionError",
102 "ClientResponseError",
103 "ClientSSLError",
104 "ContentTypeError",
105 "InvalidURL",
106 "ServerConnectionError",
107 "ServerDisconnectedError",
108 "ServerFingerprintMismatch",
109 "ServerTimeoutError",
110 "TooManyRedirects",
111 "WSServerHandshakeError",
112 # client_reqrep
113 "ClientRequest",
114 "ClientResponse",
115 "Fingerprint",
116 "RequestInfo",
117 # connector
118 "BaseConnector",
119 "TCPConnector",
120 "UnixConnector",
121 "NamedPipeConnector",
122 # client_ws
123 "ClientWebSocketResponse",
124 # client
125 "ClientSession",
126 "ClientTimeout",
127 "request",
128 )
129
130
131 try:
132 from ssl import SSLContext
133 except ImportError: # pragma: no cover
134 SSLContext = object # type: ignore[misc,assignment]
135
136
137 @attr.s(auto_attribs=True, frozen=True, slots=True)
138 class ClientTimeout:
139 total: Optional[float] = None
140 connect: Optional[float] = None
141 sock_read: Optional[float] = None
142 sock_connect: Optional[float] = None
143 ceil_threshold: float = 5
144
145 # pool_queue_timeout: Optional[float] = None
146 # dns_resolution_timeout: Optional[float] = None
147 # socket_connect_timeout: Optional[float] = None
148 # connection_acquiring_timeout: Optional[float] = None
149 # new_connection_timeout: Optional[float] = None
150 # http_header_timeout: Optional[float] = None
151 # response_body_timeout: Optional[float] = None
152
153 # to create a timeout specific for a single request, either
154 # - create a completely new one to overwrite the default
155 # - or use http://www.attrs.org/en/stable/api.html#attr.evolve
156 # to overwrite the defaults
157
158
159 # 5 Minute default read timeout
160 DEFAULT_TIMEOUT: Final[ClientTimeout] = ClientTimeout(total=5 * 60)
161
162 _RetType = TypeVar("_RetType")
163
164
165 class ClientSession:
166 """First-class interface for making HTTP requests."""
167
168 ATTRS = frozenset(
169 [
170 "_base_url",
171 "_source_traceback",
172 "_connector",
173 "requote_redirect_url",
174 "_loop",
175 "_cookie_jar",
176 "_connector_owner",
177 "_default_auth",
178 "_version",
179 "_json_serialize",
180 "_requote_redirect_url",
181 "_timeout",
182 "_raise_for_status",
183 "_auto_decompress",
184 "_trust_env",
185 "_default_headers",
186 "_skip_auto_headers",
187 "_request_class",
188 "_response_class",
189 "_ws_response_class",
190 "_trace_configs",
191 "_read_bufsize",
192 ]
193 )
194
195 _source_traceback: Optional[traceback.StackSummary] = None
196 _connector: Optional[BaseConnector] = None
197
198 def __init__(
199 self,
200 base_url: Optional[StrOrURL] = None,
201 *,
202 connector: Optional[BaseConnector] = None,
203 loop: Optional[asyncio.AbstractEventLoop] = None,
204 cookies: Optional[LooseCookies] = None,
205 headers: Optional[LooseHeaders] = None,
206 skip_auto_headers: Optional[Iterable[str]] = None,
207 auth: Optional[BasicAuth] = None,
208 json_serialize: JSONEncoder = json.dumps,
209 request_class: Type[ClientRequest] = ClientRequest,
210 response_class: Type[ClientResponse] = ClientResponse,
211 ws_response_class: Type[ClientWebSocketResponse] = ClientWebSocketResponse,
212 version: HttpVersion = http.HttpVersion11,
213 cookie_jar: Optional[AbstractCookieJar] = None,
214 connector_owner: bool = True,
215 raise_for_status: Union[
216 bool, Callable[[ClientResponse], Awaitable[None]]
217 ] = False,
218 read_timeout: Union[float, object] = sentinel,
219 conn_timeout: Optional[float] = None,
220 timeout: Union[object, ClientTimeout] = sentinel,
221 auto_decompress: bool = True,
222 trust_env: bool = False,
223 requote_redirect_url: bool = True,
224 trace_configs: Optional[List[TraceConfig]] = None,
225 read_bufsize: int = 2**16,
226 ) -> None:
227 if loop is None:
228 if connector is not None:
229 loop = connector._loop
230
231 loop = get_running_loop(loop)
232
233 if base_url is None or isinstance(base_url, URL):
234 self._base_url: Optional[URL] = base_url
235 else:
236 self._base_url = URL(base_url)
237 assert (
238 self._base_url.origin() == self._base_url
239 ), "Only absolute URLs without path part are supported"
240
241 if connector is None:
242 connector = TCPConnector(loop=loop)
243
244 if connector._loop is not loop:
245 raise RuntimeError("Session and connector has to use same event loop")
246
247 self._loop = loop
248
249 if loop.get_debug():
250 self._source_traceback = traceback.extract_stack(sys._getframe(1))
251
252 if cookie_jar is None:
253 cookie_jar = CookieJar(loop=loop)
254 self._cookie_jar = cookie_jar
255
256 if cookies is not None:
257 self._cookie_jar.update_cookies(cookies)
258
259 self._connector = connector
260 self._connector_owner = connector_owner
261 self._default_auth = auth
262 self._version = version
263 self._json_serialize = json_serialize
264 if timeout is sentinel:
265 self._timeout = DEFAULT_TIMEOUT
266 if read_timeout is not sentinel:
267 warnings.warn(
268 "read_timeout is deprecated, " "use timeout argument instead",
269 DeprecationWarning,
270 stacklevel=2,
271 )
272 self._timeout = attr.evolve(self._timeout, total=read_timeout)
273 if conn_timeout is not None:
274 self._timeout = attr.evolve(self._timeout, connect=conn_timeout)
275 warnings.warn(
276 "conn_timeout is deprecated, " "use timeout argument instead",
277 DeprecationWarning,
278 stacklevel=2,
279 )
280 else:
281 self._timeout = timeout # type: ignore[assignment]
282 if read_timeout is not sentinel:
283 raise ValueError(
284 "read_timeout and timeout parameters "
285 "conflict, please setup "
286 "timeout.read"
287 )
288 if conn_timeout is not None:
289 raise ValueError(
290 "conn_timeout and timeout parameters "
291 "conflict, please setup "
292 "timeout.connect"
293 )
294 self._raise_for_status = raise_for_status
295 self._auto_decompress = auto_decompress
296 self._trust_env = trust_env
297 self._requote_redirect_url = requote_redirect_url
298 self._read_bufsize = read_bufsize
299
300 # Convert to list of tuples
301 if headers:
302 real_headers: CIMultiDict[str] = CIMultiDict(headers)
303 else:
304 real_headers = CIMultiDict()
305 self._default_headers: CIMultiDict[str] = real_headers
306 if skip_auto_headers is not None:
307 self._skip_auto_headers = frozenset(istr(i) for i in skip_auto_headers)
308 else:
309 self._skip_auto_headers = frozenset()
310
311 self._request_class = request_class
312 self._response_class = response_class
313 self._ws_response_class = ws_response_class
314
315 self._trace_configs = trace_configs or []
316 for trace_config in self._trace_configs:
317 trace_config.freeze()
318
319 def __init_subclass__(cls: Type["ClientSession"]) -> None:
320 warnings.warn(
321 "Inheritance class {} from ClientSession "
322 "is discouraged".format(cls.__name__),
323 DeprecationWarning,
324 stacklevel=2,
325 )
326
327 if DEBUG:
328
329 def __setattr__(self, name: str, val: Any) -> None:
330 if name not in self.ATTRS:
331 warnings.warn(
332 "Setting custom ClientSession.{} attribute "
333 "is discouraged".format(name),
334 DeprecationWarning,
335 stacklevel=2,
336 )
337 super().__setattr__(name, val)
338
339 def __del__(self, _warnings: Any = warnings) -> None:
340 if not self.closed:
341 kwargs = {"source": self}
342 _warnings.warn(
343 f"Unclosed client session {self!r}", ResourceWarning, **kwargs
344 )
345 context = {"client_session": self, "message": "Unclosed client session"}
346 if self._source_traceback is not None:
347 context["source_traceback"] = self._source_traceback
348 self._loop.call_exception_handler(context)
349
350 def request(
351 self, method: str, url: StrOrURL, **kwargs: Any
352 ) -> "_RequestContextManager":
353 """Perform HTTP request."""
354 return _RequestContextManager(self._request(method, url, **kwargs))
355
356 def _build_url(self, str_or_url: StrOrURL) -> URL:
357 url = URL(str_or_url)
358 if self._base_url is None:
359 return url
360 else:
361 assert not url.is_absolute() and url.path.startswith("/")
362 return self._base_url.join(url)
363
364 async def _request(
365 self,
366 method: str,
367 str_or_url: StrOrURL,
368 *,
369 params: Optional[Mapping[str, str]] = None,
370 data: Any = None,
371 json: Any = None,
372 cookies: Optional[LooseCookies] = None,
373 headers: Optional[LooseHeaders] = None,
374 skip_auto_headers: Optional[Iterable[str]] = None,
375 auth: Optional[BasicAuth] = None,
376 allow_redirects: bool = True,
377 max_redirects: int = 10,
378 compress: Optional[str] = None,
379 chunked: Optional[bool] = None,
380 expect100: bool = False,
381 raise_for_status: Union[
382 None, bool, Callable[[ClientResponse], Awaitable[None]]
383 ] = None,
384 read_until_eof: bool = True,
385 proxy: Optional[StrOrURL] = None,
386 proxy_auth: Optional[BasicAuth] = None,
387 timeout: Union[ClientTimeout, _SENTINEL] = sentinel,
388 verify_ssl: Optional[bool] = None,
389 fingerprint: Optional[bytes] = None,
390 ssl_context: Optional[SSLContext] = None,
391 ssl: Optional[Union[SSLContext, bool, Fingerprint]] = None,
392 proxy_headers: Optional[LooseHeaders] = None,
393 trace_request_ctx: Optional[SimpleNamespace] = None,
394 read_bufsize: Optional[int] = None,
395 auto_decompress: Optional[bool] = None,
396 ) -> ClientResponse:
397
398 # NOTE: timeout clamps existing connect and read timeouts. We cannot
399 # set the default to None because we need to detect if the user wants
400 # to use the existing timeouts by setting timeout to None.
401
402 if self.closed:
403 raise RuntimeError("Session is closed")
404
405 ssl = _merge_ssl_params(ssl, verify_ssl, ssl_context, fingerprint)
406
407 if data is not None and json is not None:
408 raise ValueError(
409 "data and json parameters can not be used at the same time"
410 )
411 elif json is not None:
412 data = payload.JsonPayload(json, dumps=self._json_serialize)
413
414 if not isinstance(chunked, bool) and chunked is not None:
415 warnings.warn("Chunk size is deprecated #1615", DeprecationWarning)
416
417 redirects = 0
418 history = []
419 version = self._version
420
421 # Merge with default headers and transform to CIMultiDict
422 headers = self._prepare_headers(headers)
423 proxy_headers = self._prepare_headers(proxy_headers)
424
425 try:
426 url = self._build_url(str_or_url)
427 except ValueError as e:
428 raise InvalidURL(str_or_url) from e
429
430 skip_headers = set(self._skip_auto_headers)
431 if skip_auto_headers is not None:
432 for i in skip_auto_headers:
433 skip_headers.add(istr(i))
434
435 if proxy is not None:
436 try:
437 proxy = URL(proxy)
438 except ValueError as e:
439 raise InvalidURL(proxy) from e
440
441 if timeout is sentinel:
442 real_timeout: ClientTimeout = self._timeout
443 else:
444 if not isinstance(timeout, ClientTimeout):
445 real_timeout = ClientTimeout(total=timeout)
446 else:
447 real_timeout = timeout
448 # timeout is cumulative for all request operations
449 # (request, redirects, responses, data consuming)
450 tm = TimeoutHandle(
451 self._loop, real_timeout.total, ceil_threshold=real_timeout.ceil_threshold
452 )
453 handle = tm.start()
454
455 if read_bufsize is None:
456 read_bufsize = self._read_bufsize
457
458 if auto_decompress is None:
459 auto_decompress = self._auto_decompress
460
461 traces = [
462 Trace(
463 self,
464 trace_config,
465 trace_config.trace_config_ctx(trace_request_ctx=trace_request_ctx),
466 )
467 for trace_config in self._trace_configs
468 ]
469
470 for trace in traces:
471 await trace.send_request_start(method, url.update_query(params), headers)
472
473 timer = tm.timer()
474 try:
475 with timer:
476 while True:
477 url, auth_from_url = strip_auth_from_url(url)
478 if auth and auth_from_url:
479 raise ValueError(
480 "Cannot combine AUTH argument with "
481 "credentials encoded in URL"
482 )
483
484 if auth is None:
485 auth = auth_from_url
486 if auth is None:
487 auth = self._default_auth
488 # It would be confusing if we support explicit
489 # Authorization header with auth argument
490 if (
491 headers is not None
492 and auth is not None
493 and hdrs.AUTHORIZATION in headers
494 ):
495 raise ValueError(
496 "Cannot combine AUTHORIZATION header "
497 "with AUTH argument or credentials "
498 "encoded in URL"
499 )
500
501 all_cookies = self._cookie_jar.filter_cookies(url)
502
503 if cookies is not None:
504 tmp_cookie_jar = CookieJar()
505 tmp_cookie_jar.update_cookies(cookies)
506 req_cookies = tmp_cookie_jar.filter_cookies(url)
507 if req_cookies:
508 all_cookies.load(req_cookies)
509
510 if proxy is not None:
511 proxy = URL(proxy)
512 elif self._trust_env:
513 with suppress(LookupError):
514 proxy, proxy_auth = get_env_proxy_for_url(url)
515
516 req = self._request_class(
517 method,
518 url,
519 params=params,
520 headers=headers,
521 skip_auto_headers=skip_headers,
522 data=data,
523 cookies=all_cookies,
524 auth=auth,
525 version=version,
526 compress=compress,
527 chunked=chunked,
528 expect100=expect100,
529 loop=self._loop,
530 response_class=self._response_class,
531 proxy=proxy,
532 proxy_auth=proxy_auth,
533 timer=timer,
534 session=self,
535 ssl=ssl,
536 proxy_headers=proxy_headers,
537 traces=traces,
538 )
539
540 # connection timeout
541 try:
542 async with ceil_timeout(
543 real_timeout.connect,
544 ceil_threshold=real_timeout.ceil_threshold,
545 ):
546 assert self._connector is not None
547 conn = await self._connector.connect(
548 req, traces=traces, timeout=real_timeout
549 )
550 except asyncio.TimeoutError as exc:
551 raise ServerTimeoutError(
552 "Connection timeout " "to host {}".format(url)
553 ) from exc
554
555 assert conn.transport is not None
556
557 assert conn.protocol is not None
558 conn.protocol.set_response_params(
559 timer=timer,
560 skip_payload=method.upper() == "HEAD",
561 read_until_eof=read_until_eof,
562 auto_decompress=auto_decompress,
563 read_timeout=real_timeout.sock_read,
564 read_bufsize=read_bufsize,
565 timeout_ceil_threshold=self._connector._timeout_ceil_threshold,
566 )
567
568 try:
569 try:
570 resp = await req.send(conn)
571 try:
572 await resp.start(conn)
573 except BaseException:
574 resp.close()
575 raise
576 except BaseException:
577 conn.close()
578 raise
579 except ClientError:
580 raise
581 except OSError as exc:
582 if exc.errno is None and isinstance(exc, asyncio.TimeoutError):
583 raise
584 raise ClientOSError(*exc.args) from exc
585
586 self._cookie_jar.update_cookies(resp.cookies, resp.url)
587
588 # redirects
589 if resp.status in (301, 302, 303, 307, 308) and allow_redirects:
590
591 for trace in traces:
592 await trace.send_request_redirect(
593 method, url.update_query(params), headers, resp
594 )
595
596 redirects += 1
597 history.append(resp)
598 if max_redirects and redirects >= max_redirects:
599 resp.close()
600 raise TooManyRedirects(
601 history[0].request_info, tuple(history)
602 )
603
604 # For 301 and 302, mimic IE, now changed in RFC
605 # https://github.com/kennethreitz/requests/pull/269
606 if (resp.status == 303 and resp.method != hdrs.METH_HEAD) or (
607 resp.status in (301, 302) and resp.method == hdrs.METH_POST
608 ):
609 method = hdrs.METH_GET
610 data = None
611 if headers.get(hdrs.CONTENT_LENGTH):
612 headers.pop(hdrs.CONTENT_LENGTH)
613
614 r_url = resp.headers.get(hdrs.LOCATION) or resp.headers.get(
615 hdrs.URI
616 )
617 if r_url is None:
618 # see github.com/aio-libs/aiohttp/issues/2022
619 break
620 else:
621 # reading from correct redirection
622 # response is forbidden
623 resp.release()
624
625 try:
626 parsed_url = URL(
627 r_url, encoded=not self._requote_redirect_url
628 )
629
630 except ValueError as e:
631 raise InvalidURL(r_url) from e
632
633 scheme = parsed_url.scheme
634 if scheme not in ("http", "https", ""):
635 resp.close()
636 raise ValueError("Can redirect only to http or https")
637 elif not scheme:
638 parsed_url = url.join(parsed_url)
639
640 if url.origin() != parsed_url.origin():
641 auth = None
642 headers.pop(hdrs.AUTHORIZATION, None)
643
644 url = parsed_url
645 params = None
646 resp.release()
647 continue
648
649 break
650
651 # check response status
652 if raise_for_status is None:
653 raise_for_status = self._raise_for_status
654
655 if raise_for_status is None:
656 pass
657 elif callable(raise_for_status):
658 await raise_for_status(resp)
659 elif raise_for_status:
660 resp.raise_for_status()
661
662 # register connection
663 if handle is not None:
664 if resp.connection is not None:
665 resp.connection.add_callback(handle.cancel)
666 else:
667 handle.cancel()
668
669 resp._history = tuple(history)
670
671 for trace in traces:
672 await trace.send_request_end(
673 method, url.update_query(params), headers, resp
674 )
675 return resp
676
677 except BaseException as e:
678 # cleanup timer
679 tm.close()
680 if handle:
681 handle.cancel()
682 handle = None
683
684 for trace in traces:
685 await trace.send_request_exception(
686 method, url.update_query(params), headers, e
687 )
688 raise
689
690 def ws_connect(
691 self,
692 url: StrOrURL,
693 *,
694 method: str = hdrs.METH_GET,
695 protocols: Iterable[str] = (),
696 timeout: float = 10.0,
697 receive_timeout: Optional[float] = None,
698 autoclose: bool = True,
699 autoping: bool = True,
700 heartbeat: Optional[float] = None,
701 auth: Optional[BasicAuth] = None,
702 origin: Optional[str] = None,
703 params: Optional[Mapping[str, str]] = None,
704 headers: Optional[LooseHeaders] = None,
705 proxy: Optional[StrOrURL] = None,
706 proxy_auth: Optional[BasicAuth] = None,
707 ssl: Union[SSLContext, bool, None, Fingerprint] = None,
708 verify_ssl: Optional[bool] = None,
709 fingerprint: Optional[bytes] = None,
710 ssl_context: Optional[SSLContext] = None,
711 proxy_headers: Optional[LooseHeaders] = None,
712 compress: int = 0,
713 max_msg_size: int = 4 * 1024 * 1024,
714 ) -> "_WSRequestContextManager":
715 """Initiate websocket connection."""
716 return _WSRequestContextManager(
717 self._ws_connect(
718 url,
719 method=method,
720 protocols=protocols,
721 timeout=timeout,
722 receive_timeout=receive_timeout,
723 autoclose=autoclose,
724 autoping=autoping,
725 heartbeat=heartbeat,
726 auth=auth,
727 origin=origin,
728 params=params,
729 headers=headers,
730 proxy=proxy,
731 proxy_auth=proxy_auth,
732 ssl=ssl,
733 verify_ssl=verify_ssl,
734 fingerprint=fingerprint,
735 ssl_context=ssl_context,
736 proxy_headers=proxy_headers,
737 compress=compress,
738 max_msg_size=max_msg_size,
739 )
740 )
741
742 async def _ws_connect(
743 self,
744 url: StrOrURL,
745 *,
746 method: str = hdrs.METH_GET,
747 protocols: Iterable[str] = (),
748 timeout: float = 10.0,
749 receive_timeout: Optional[float] = None,
750 autoclose: bool = True,
751 autoping: bool = True,
752 heartbeat: Optional[float] = None,
753 auth: Optional[BasicAuth] = None,
754 origin: Optional[str] = None,
755 params: Optional[Mapping[str, str]] = None,
756 headers: Optional[LooseHeaders] = None,
757 proxy: Optional[StrOrURL] = None,
758 proxy_auth: Optional[BasicAuth] = None,
759 ssl: Union[SSLContext, bool, None, Fingerprint] = None,
760 verify_ssl: Optional[bool] = None,
761 fingerprint: Optional[bytes] = None,
762 ssl_context: Optional[SSLContext] = None,
763 proxy_headers: Optional[LooseHeaders] = None,
764 compress: int = 0,
765 max_msg_size: int = 4 * 1024 * 1024,
766 ) -> ClientWebSocketResponse:
767
768 if headers is None:
769 real_headers: CIMultiDict[str] = CIMultiDict()
770 else:
771 real_headers = CIMultiDict(headers)
772
773 default_headers = {
774 hdrs.UPGRADE: "websocket",
775 hdrs.CONNECTION: "upgrade",
776 hdrs.SEC_WEBSOCKET_VERSION: "13",
777 }
778
779 for key, value in default_headers.items():
780 real_headers.setdefault(key, value)
781
782 sec_key = base64.b64encode(os.urandom(16))
783 real_headers[hdrs.SEC_WEBSOCKET_KEY] = sec_key.decode()
784
785 if protocols:
786 real_headers[hdrs.SEC_WEBSOCKET_PROTOCOL] = ",".join(protocols)
787 if origin is not None:
788 real_headers[hdrs.ORIGIN] = origin
789 if compress:
790 extstr = ws_ext_gen(compress=compress)
791 real_headers[hdrs.SEC_WEBSOCKET_EXTENSIONS] = extstr
792
793 ssl = _merge_ssl_params(ssl, verify_ssl, ssl_context, fingerprint)
794
795 # send request
796 resp = await self.request(
797 method,
798 url,
799 params=params,
800 headers=real_headers,
801 read_until_eof=False,
802 auth=auth,
803 proxy=proxy,
804 proxy_auth=proxy_auth,
805 ssl=ssl,
806 proxy_headers=proxy_headers,
807 )
808
809 try:
810 # check handshake
811 if resp.status != 101:
812 raise WSServerHandshakeError(
813 resp.request_info,
814 resp.history,
815 message="Invalid response status",
816 status=resp.status,
817 headers=resp.headers,
818 )
819
820 if resp.headers.get(hdrs.UPGRADE, "").lower() != "websocket":
821 raise WSServerHandshakeError(
822 resp.request_info,
823 resp.history,
824 message="Invalid upgrade header",
825 status=resp.status,
826 headers=resp.headers,
827 )
828
829 if resp.headers.get(hdrs.CONNECTION, "").lower() != "upgrade":
830 raise WSServerHandshakeError(
831 resp.request_info,
832 resp.history,
833 message="Invalid connection header",
834 status=resp.status,
835 headers=resp.headers,
836 )
837
838 # key calculation
839 r_key = resp.headers.get(hdrs.SEC_WEBSOCKET_ACCEPT, "")
840 match = base64.b64encode(hashlib.sha1(sec_key + WS_KEY).digest()).decode()
841 if r_key != match:
842 raise WSServerHandshakeError(
843 resp.request_info,
844 resp.history,
845 message="Invalid challenge response",
846 status=resp.status,
847 headers=resp.headers,
848 )
849
850 # websocket protocol
851 protocol = None
852 if protocols and hdrs.SEC_WEBSOCKET_PROTOCOL in resp.headers:
853 resp_protocols = [
854 proto.strip()
855 for proto in resp.headers[hdrs.SEC_WEBSOCKET_PROTOCOL].split(",")
856 ]
857
858 for proto in resp_protocols:
859 if proto in protocols:
860 protocol = proto
861 break
862
863 # websocket compress
864 notakeover = False
865 if compress:
866 compress_hdrs = resp.headers.get(hdrs.SEC_WEBSOCKET_EXTENSIONS)
867 if compress_hdrs:
868 try:
869 compress, notakeover = ws_ext_parse(compress_hdrs)
870 except WSHandshakeError as exc:
871 raise WSServerHandshakeError(
872 resp.request_info,
873 resp.history,
874 message=exc.args[0],
875 status=resp.status,
876 headers=resp.headers,
877 ) from exc
878 else:
879 compress = 0
880 notakeover = False
881
882 conn = resp.connection
883 assert conn is not None
884 conn_proto = conn.protocol
885 assert conn_proto is not None
886 transport = conn.transport
887 assert transport is not None
888 reader: FlowControlDataQueue[WSMessage] = FlowControlDataQueue(
889 conn_proto, 2**16, loop=self._loop
890 )
891 conn_proto.set_parser(WebSocketReader(reader, max_msg_size), reader)
892 writer = WebSocketWriter(
893 conn_proto,
894 transport,
895 use_mask=True,
896 compress=compress,
897 notakeover=notakeover,
898 )
899 except BaseException:
900 resp.close()
901 raise
902 else:
903 return self._ws_response_class(
904 reader,
905 writer,
906 protocol,
907 resp,
908 timeout,
909 autoclose,
910 autoping,
911 self._loop,
912 receive_timeout=receive_timeout,
913 heartbeat=heartbeat,
914 compress=compress,
915 client_notakeover=notakeover,
916 )
917
918 def _prepare_headers(self, headers: Optional[LooseHeaders]) -> "CIMultiDict[str]":
919 """Add default headers and transform it to CIMultiDict"""
920 # Convert headers to MultiDict
921 result = CIMultiDict(self._default_headers)
922 if headers:
923 if not isinstance(headers, (MultiDictProxy, MultiDict)):
924 headers = CIMultiDict(headers)
925 added_names: Set[str] = set()
926 for key, value in headers.items():
927 if key in added_names:
928 result.add(key, value)
929 else:
930 result[key] = value
931 added_names.add(key)
932 return result
933
934 def get(
935 self, url: StrOrURL, *, allow_redirects: bool = True, **kwargs: Any
936 ) -> "_RequestContextManager":
937 """Perform HTTP GET request."""
938 return _RequestContextManager(
939 self._request(hdrs.METH_GET, url, allow_redirects=allow_redirects, **kwargs)
940 )
941
942 def options(
943 self, url: StrOrURL, *, allow_redirects: bool = True, **kwargs: Any
944 ) -> "_RequestContextManager":
945 """Perform HTTP OPTIONS request."""
946 return _RequestContextManager(
947 self._request(
948 hdrs.METH_OPTIONS, url, allow_redirects=allow_redirects, **kwargs
949 )
950 )
951
952 def head(
953 self, url: StrOrURL, *, allow_redirects: bool = False, **kwargs: Any
954 ) -> "_RequestContextManager":
955 """Perform HTTP HEAD request."""
956 return _RequestContextManager(
957 self._request(
958 hdrs.METH_HEAD, url, allow_redirects=allow_redirects, **kwargs
959 )
960 )
961
962 def post(
963 self, url: StrOrURL, *, data: Any = None, **kwargs: Any
964 ) -> "_RequestContextManager":
965 """Perform HTTP POST request."""
966 return _RequestContextManager(
967 self._request(hdrs.METH_POST, url, data=data, **kwargs)
968 )
969
970 def put(
971 self, url: StrOrURL, *, data: Any = None, **kwargs: Any
972 ) -> "_RequestContextManager":
973 """Perform HTTP PUT request."""
974 return _RequestContextManager(
975 self._request(hdrs.METH_PUT, url, data=data, **kwargs)
976 )
977
978 def patch(
979 self, url: StrOrURL, *, data: Any = None, **kwargs: Any
980 ) -> "_RequestContextManager":
981 """Perform HTTP PATCH request."""
982 return _RequestContextManager(
983 self._request(hdrs.METH_PATCH, url, data=data, **kwargs)
984 )
985
986 def delete(self, url: StrOrURL, **kwargs: Any) -> "_RequestContextManager":
987 """Perform HTTP DELETE request."""
988 return _RequestContextManager(self._request(hdrs.METH_DELETE, url, **kwargs))
989
990 async def close(self) -> None:
991 """Close underlying connector.
992
993 Release all acquired resources.
994 """
995 if not self.closed:
996 if self._connector is not None and self._connector_owner:
997 await self._connector.close()
998 self._connector = None
999
1000 @property
1001 def closed(self) -> bool:
1002 """Is client session closed.
1003
1004 A readonly property.
1005 """
1006 return self._connector is None or self._connector.closed
1007
1008 @property
1009 def connector(self) -> Optional[BaseConnector]:
1010 """Connector instance used for the session."""
1011 return self._connector
1012
1013 @property
1014 def cookie_jar(self) -> AbstractCookieJar:
1015 """The session cookies."""
1016 return self._cookie_jar
1017
1018 @property
1019 def version(self) -> Tuple[int, int]:
1020 """The session HTTP protocol version."""
1021 return self._version
1022
1023 @property
1024 def requote_redirect_url(self) -> bool:
1025 """Do URL requoting on redirection handling."""
1026 return self._requote_redirect_url
1027
1028 @requote_redirect_url.setter
1029 def requote_redirect_url(self, val: bool) -> None:
1030 """Do URL requoting on redirection handling."""
1031 warnings.warn(
1032 "session.requote_redirect_url modification " "is deprecated #2778",
1033 DeprecationWarning,
1034 stacklevel=2,
1035 )
1036 self._requote_redirect_url = val
1037
1038 @property
1039 def loop(self) -> asyncio.AbstractEventLoop:
1040 """Session's loop."""
1041 warnings.warn(
1042 "client.loop property is deprecated", DeprecationWarning, stacklevel=2
1043 )
1044 return self._loop
1045
1046 @property
1047 def timeout(self) -> ClientTimeout:
1048 """Timeout for the session."""
1049 return self._timeout
1050
1051 @property
1052 def headers(self) -> "CIMultiDict[str]":
1053 """The default headers of the client session."""
1054 return self._default_headers
1055
1056 @property
1057 def skip_auto_headers(self) -> FrozenSet[istr]:
1058 """Headers for which autogeneration should be skipped"""
1059 return self._skip_auto_headers
1060
1061 @property
1062 def auth(self) -> Optional[BasicAuth]:
1063 """An object that represents HTTP Basic Authorization"""
1064 return self._default_auth
1065
1066 @property
1067 def json_serialize(self) -> JSONEncoder:
1068 """Json serializer callable"""
1069 return self._json_serialize
1070
1071 @property
1072 def connector_owner(self) -> bool:
1073 """Should connector be closed on session closing"""
1074 return self._connector_owner
1075
1076 @property
1077 def raise_for_status(
1078 self,
1079 ) -> Union[bool, Callable[[ClientResponse], Awaitable[None]]]:
1080 """Should `ClientResponse.raise_for_status()` be called for each response."""
1081 return self._raise_for_status
1082
1083 @property
1084 def auto_decompress(self) -> bool:
1085 """Should the body response be automatically decompressed."""
1086 return self._auto_decompress
1087
1088 @property
1089 def trust_env(self) -> bool:
1090 """
1091 Should proxies information from environment or netrc be trusted.
1092
1093 Information is from HTTP_PROXY / HTTPS_PROXY environment variables
1094 or ~/.netrc file if present.
1095 """
1096 return self._trust_env
1097
1098 @property
1099 def trace_configs(self) -> List[TraceConfig]:
1100 """A list of TraceConfig instances used for client tracing"""
1101 return self._trace_configs
1102
1103 def detach(self) -> None:
1104 """Detach connector from session without closing the former.
1105
1106 Session is switched to closed state anyway.
1107 """
1108 self._connector = None
1109
1110 def __enter__(self) -> None:
1111 raise TypeError("Use async with instead")
1112
1113 def __exit__(
1114 self,
1115 exc_type: Optional[Type[BaseException]],
1116 exc_val: Optional[BaseException],
1117 exc_tb: Optional[TracebackType],
1118 ) -> None:
1119 # __exit__ should exist in pair with __enter__ but never executed
1120 pass # pragma: no cover
1121
1122 async def __aenter__(self) -> "ClientSession":
1123 return self
1124
1125 async def __aexit__(
1126 self,
1127 exc_type: Optional[Type[BaseException]],
1128 exc_val: Optional[BaseException],
1129 exc_tb: Optional[TracebackType],
1130 ) -> None:
1131 await self.close()
1132
1133
1134 class _BaseRequestContextManager(Coroutine[Any, Any, _RetType], Generic[_RetType]):
1135
1136 __slots__ = ("_coro", "_resp")
1137
1138 def __init__(self, coro: Coroutine["asyncio.Future[Any]", None, _RetType]) -> None:
1139 self._coro = coro
1140
1141 def send(self, arg: None) -> "asyncio.Future[Any]":
1142 return self._coro.send(arg)
1143
1144 def throw(self, arg: BaseException) -> None: # type: ignore[override]
1145 self._coro.throw(arg)
1146
1147 def close(self) -> None:
1148 return self._coro.close()
1149
1150 def __await__(self) -> Generator[Any, None, _RetType]:
1151 ret = self._coro.__await__()
1152 return ret
1153
1154 def __iter__(self) -> Generator[Any, None, _RetType]:
1155 return self.__await__()
1156
1157 async def __aenter__(self) -> _RetType:
1158 self._resp = await self._coro
1159 return self._resp
1160
1161
1162 class _RequestContextManager(_BaseRequestContextManager[ClientResponse]):
1163 __slots__ = ()
1164
1165 async def __aexit__(
1166 self,
1167 exc_type: Optional[Type[BaseException]],
1168 exc: Optional[BaseException],
1169 tb: Optional[TracebackType],
1170 ) -> None:
1171 # We're basing behavior on the exception as it can be caused by
1172 # user code unrelated to the status of the connection. If you
1173 # would like to close a connection you must do that
1174 # explicitly. Otherwise connection error handling should kick in
1175 # and close/recycle the connection as required.
1176 self._resp.release()
1177
1178
1179 class _WSRequestContextManager(_BaseRequestContextManager[ClientWebSocketResponse]):
1180 __slots__ = ()
1181
1182 async def __aexit__(
1183 self,
1184 exc_type: Optional[Type[BaseException]],
1185 exc: Optional[BaseException],
1186 tb: Optional[TracebackType],
1187 ) -> None:
1188 await self._resp.close()
1189
1190
1191 class _SessionRequestContextManager:
1192
1193 __slots__ = ("_coro", "_resp", "_session")
1194
1195 def __init__(
1196 self,
1197 coro: Coroutine["asyncio.Future[Any]", None, ClientResponse],
1198 session: ClientSession,
1199 ) -> None:
1200 self._coro = coro
1201 self._resp: Optional[ClientResponse] = None
1202 self._session = session
1203
1204 async def __aenter__(self) -> ClientResponse:
1205 try:
1206 self._resp = await self._coro
1207 except BaseException:
1208 await self._session.close()
1209 raise
1210 else:
1211 return self._resp
1212
1213 async def __aexit__(
1214 self,
1215 exc_type: Optional[Type[BaseException]],
1216 exc: Optional[BaseException],
1217 tb: Optional[TracebackType],
1218 ) -> None:
1219 assert self._resp is not None
1220 self._resp.close()
1221 await self._session.close()
1222
1223
1224 def request(
1225 method: str,
1226 url: StrOrURL,
1227 *,
1228 params: Optional[Mapping[str, str]] = None,
1229 data: Any = None,
1230 json: Any = None,
1231 headers: Optional[LooseHeaders] = None,
1232 skip_auto_headers: Optional[Iterable[str]] = None,
1233 auth: Optional[BasicAuth] = None,
1234 allow_redirects: bool = True,
1235 max_redirects: int = 10,
1236 compress: Optional[str] = None,
1237 chunked: Optional[bool] = None,
1238 expect100: bool = False,
1239 raise_for_status: Optional[bool] = None,
1240 read_until_eof: bool = True,
1241 proxy: Optional[StrOrURL] = None,
1242 proxy_auth: Optional[BasicAuth] = None,
1243 timeout: Union[ClientTimeout, object] = sentinel,
1244 cookies: Optional[LooseCookies] = None,
1245 version: HttpVersion = http.HttpVersion11,
1246 connector: Optional[BaseConnector] = None,
1247 read_bufsize: Optional[int] = None,
1248 loop: Optional[asyncio.AbstractEventLoop] = None,
1249 ) -> _SessionRequestContextManager:
1250 """Constructs and sends a request.
1251
1252 Returns response object.
1253 method - HTTP method
1254 url - request url
1255 params - (optional) Dictionary or bytes to be sent in the query
1256 string of the new request
1257 data - (optional) Dictionary, bytes, or file-like object to
1258 send in the body of the request
1259 json - (optional) Any json compatible python object
1260 headers - (optional) Dictionary of HTTP Headers to send with
1261 the request
1262 cookies - (optional) Dict object to send with the request
1263 auth - (optional) BasicAuth named tuple represent HTTP Basic Auth
1264 auth - aiohttp.helpers.BasicAuth
1265 allow_redirects - (optional) If set to False, do not follow
1266 redirects
1267 version - Request HTTP version.
1268 compress - Set to True if request has to be compressed
1269 with deflate encoding.
1270 chunked - Set to chunk size for chunked transfer encoding.
1271 expect100 - Expect 100-continue response from server.
1272 connector - BaseConnector sub-class instance to support
1273 connection pooling.
1274 read_until_eof - Read response until eof if response
1275 does not have Content-Length header.
1276 loop - Optional event loop.
1277 timeout - Optional ClientTimeout settings structure, 5min
1278 total timeout by default.
1279 Usage::
1280 >>> import aiohttp
1281 >>> resp = await aiohttp.request('GET', 'http://python.org/')
1282 >>> resp
1283 <ClientResponse(python.org/) [200]>
1284 >>> data = await resp.read()
1285 """
1286 connector_owner = False
1287 if connector is None:
1288 connector_owner = True
1289 connector = TCPConnector(loop=loop, force_close=True)
1290
1291 session = ClientSession(
1292 loop=loop,
1293 cookies=cookies,
1294 version=version,
1295 timeout=timeout,
1296 connector=connector,
1297 connector_owner=connector_owner,
1298 )
1299
1300 return _SessionRequestContextManager(
1301 session._request(
1302 method,
1303 url,
1304 params=params,
1305 data=data,
1306 json=json,
1307 headers=headers,
1308 skip_auto_headers=skip_auto_headers,
1309 auth=auth,
1310 allow_redirects=allow_redirects,
1311 max_redirects=max_redirects,
1312 compress=compress,
1313 chunked=chunked,
1314 expect100=expect100,
1315 raise_for_status=raise_for_status,
1316 read_until_eof=read_until_eof,
1317 proxy=proxy,
1318 proxy_auth=proxy_auth,
1319 read_bufsize=read_bufsize,
1320 ),
1321 session,
1322 )
1323
```
--- 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/aiohttp/client.py b/aiohttp/client.py
--- a/aiohttp/client.py
+++ b/aiohttp/client.py
@@ -772,7 +772,7 @@
default_headers = {
hdrs.UPGRADE: "websocket",
- hdrs.CONNECTION: "upgrade",
+ hdrs.CONNECTION: "Upgrade",
hdrs.SEC_WEBSOCKET_VERSION: "13",
}
| {"golden_diff": "diff --git a/aiohttp/client.py b/aiohttp/client.py\n--- a/aiohttp/client.py\n+++ b/aiohttp/client.py\n@@ -772,7 +772,7 @@\n \n default_headers = {\n hdrs.UPGRADE: \"websocket\",\n- hdrs.CONNECTION: \"upgrade\",\n+ hdrs.CONNECTION: \"Upgrade\",\n hdrs.SEC_WEBSOCKET_VERSION: \"13\",\n }\n", "issue": "Websocket client send wrong Connection header\n### Describe the bug\n\nIn websocket standard , the `Connection` header shoule be `Upgrade`, but we send a `upgrade` . \r\nIt's a lowercase word.\n\n### To Reproduce\n\nconnect to server with strict case sensitive checking will failed\n\n### Expected behavior\n\nSend a \r\n`Connection: Upgrade`\r\nheader\n\n### Logs/tracebacks\n\n```python-traceback\nno traceback\n```\n\n\n### Python Version\n\n```console\nPython 3.8.16\n```\n\n\n### aiohttp Version\n\n```console\nName: aiohttp\r\nVersion: 3.8.4\r\nSummary: Async http client/server framework (asyncio)\r\nHome-page: https://github.com/aio-libs/aiohttp\r\nAuthor: \r\nAuthor-email: \r\nLicense: Apache 2\r\nLocation: /opt/homebrew/lib/python3.8/site-packages\r\nRequires: aiosignal, async-timeout, attrs, charset-normalizer, frozenlist, multidict, yarl\r\nRequired-by: web3\n```\n\n\n### multidict Version\n\n```console\nName: multidict\r\nVersion: 6.0.4\r\nSummary: multidict implementation\r\nHome-page: https://github.com/aio-libs/multidict\r\nAuthor: Andrew Svetlov\r\nAuthor-email: [email protected]\r\nLicense: Apache 2\r\nLocation: /opt/homebrew/lib/python3.8/site-packages\r\nRequires: \r\nRequired-by: aiohttp, yarl\n```\n\n\n### yarl Version\n\n```console\nName: yarl\r\nVersion: 1.8.2\r\nSummary: Yet another URL library\r\nHome-page: https://github.com/aio-libs/yarl/\r\nAuthor: Andrew Svetlov\r\nAuthor-email: [email protected]\r\nLicense: Apache 2\r\nLocation: /opt/homebrew/lib/python3.8/site-packages\r\nRequires: idna, multidict\r\nRequired-by: aiohttp, gql\n```\n\n\n### OS\n\nMacOs\n\n### Related component\n\nClient\n\n### Additional context\n\n_No response_\n\n### Code of Conduct\n\n- [X] I agree to follow the aio-libs Code of Conduct\n", "before_files": [{"content": "\"\"\"HTTP Client for asyncio.\"\"\"\n\nimport asyncio\nimport base64\nimport hashlib\nimport json\nimport os\nimport sys\nimport traceback\nimport warnings\nfrom contextlib import suppress\nfrom types import SimpleNamespace, TracebackType\nfrom typing import (\n Any,\n Awaitable,\n Callable,\n Coroutine,\n FrozenSet,\n Generator,\n Generic,\n Iterable,\n List,\n Mapping,\n Optional,\n Set,\n Tuple,\n Type,\n TypeVar,\n Union,\n)\n\nimport attr\nfrom multidict import CIMultiDict, MultiDict, MultiDictProxy, istr\nfrom yarl import URL\n\nfrom . import hdrs, http, payload\nfrom .abc import AbstractCookieJar\nfrom .client_exceptions import (\n ClientConnectionError as ClientConnectionError,\n ClientConnectorCertificateError as ClientConnectorCertificateError,\n ClientConnectorError as ClientConnectorError,\n ClientConnectorSSLError as ClientConnectorSSLError,\n ClientError as ClientError,\n ClientHttpProxyError as ClientHttpProxyError,\n ClientOSError as ClientOSError,\n ClientPayloadError as ClientPayloadError,\n ClientProxyConnectionError as ClientProxyConnectionError,\n ClientResponseError as ClientResponseError,\n ClientSSLError as ClientSSLError,\n ContentTypeError as ContentTypeError,\n InvalidURL as InvalidURL,\n ServerConnectionError as ServerConnectionError,\n ServerDisconnectedError as ServerDisconnectedError,\n ServerFingerprintMismatch as ServerFingerprintMismatch,\n ServerTimeoutError as ServerTimeoutError,\n TooManyRedirects as TooManyRedirects,\n WSServerHandshakeError as WSServerHandshakeError,\n)\nfrom .client_reqrep import (\n ClientRequest as ClientRequest,\n ClientResponse as ClientResponse,\n Fingerprint as Fingerprint,\n RequestInfo as RequestInfo,\n _merge_ssl_params,\n)\nfrom .client_ws import ClientWebSocketResponse as ClientWebSocketResponse\nfrom .connector import (\n BaseConnector as BaseConnector,\n NamedPipeConnector as NamedPipeConnector,\n TCPConnector as TCPConnector,\n UnixConnector as UnixConnector,\n)\nfrom .cookiejar import CookieJar\nfrom .helpers import (\n _SENTINEL,\n DEBUG,\n BasicAuth,\n TimeoutHandle,\n ceil_timeout,\n get_env_proxy_for_url,\n get_running_loop,\n sentinel,\n strip_auth_from_url,\n)\nfrom .http import WS_KEY, HttpVersion, WebSocketReader, WebSocketWriter\nfrom .http_websocket import WSHandshakeError, WSMessage, ws_ext_gen, ws_ext_parse\nfrom .streams import FlowControlDataQueue\nfrom .tracing import Trace, TraceConfig\nfrom .typedefs import Final, JSONEncoder, LooseCookies, LooseHeaders, StrOrURL\n\n__all__ = (\n # client_exceptions\n \"ClientConnectionError\",\n \"ClientConnectorCertificateError\",\n \"ClientConnectorError\",\n \"ClientConnectorSSLError\",\n \"ClientError\",\n \"ClientHttpProxyError\",\n \"ClientOSError\",\n \"ClientPayloadError\",\n \"ClientProxyConnectionError\",\n \"ClientResponseError\",\n \"ClientSSLError\",\n \"ContentTypeError\",\n \"InvalidURL\",\n \"ServerConnectionError\",\n \"ServerDisconnectedError\",\n \"ServerFingerprintMismatch\",\n \"ServerTimeoutError\",\n \"TooManyRedirects\",\n \"WSServerHandshakeError\",\n # client_reqrep\n \"ClientRequest\",\n \"ClientResponse\",\n \"Fingerprint\",\n \"RequestInfo\",\n # connector\n \"BaseConnector\",\n \"TCPConnector\",\n \"UnixConnector\",\n \"NamedPipeConnector\",\n # client_ws\n \"ClientWebSocketResponse\",\n # client\n \"ClientSession\",\n \"ClientTimeout\",\n \"request\",\n)\n\n\ntry:\n from ssl import SSLContext\nexcept ImportError: # pragma: no cover\n SSLContext = object # type: ignore[misc,assignment]\n\n\[email protected](auto_attribs=True, frozen=True, slots=True)\nclass ClientTimeout:\n total: Optional[float] = None\n connect: Optional[float] = None\n sock_read: Optional[float] = None\n sock_connect: Optional[float] = None\n ceil_threshold: float = 5\n\n # pool_queue_timeout: Optional[float] = None\n # dns_resolution_timeout: Optional[float] = None\n # socket_connect_timeout: Optional[float] = None\n # connection_acquiring_timeout: Optional[float] = None\n # new_connection_timeout: Optional[float] = None\n # http_header_timeout: Optional[float] = None\n # response_body_timeout: Optional[float] = None\n\n # to create a timeout specific for a single request, either\n # - create a completely new one to overwrite the default\n # - or use http://www.attrs.org/en/stable/api.html#attr.evolve\n # to overwrite the defaults\n\n\n# 5 Minute default read timeout\nDEFAULT_TIMEOUT: Final[ClientTimeout] = ClientTimeout(total=5 * 60)\n\n_RetType = TypeVar(\"_RetType\")\n\n\nclass ClientSession:\n \"\"\"First-class interface for making HTTP requests.\"\"\"\n\n ATTRS = frozenset(\n [\n \"_base_url\",\n \"_source_traceback\",\n \"_connector\",\n \"requote_redirect_url\",\n \"_loop\",\n \"_cookie_jar\",\n \"_connector_owner\",\n \"_default_auth\",\n \"_version\",\n \"_json_serialize\",\n \"_requote_redirect_url\",\n \"_timeout\",\n \"_raise_for_status\",\n \"_auto_decompress\",\n \"_trust_env\",\n \"_default_headers\",\n \"_skip_auto_headers\",\n \"_request_class\",\n \"_response_class\",\n \"_ws_response_class\",\n \"_trace_configs\",\n \"_read_bufsize\",\n ]\n )\n\n _source_traceback: Optional[traceback.StackSummary] = None\n _connector: Optional[BaseConnector] = None\n\n def __init__(\n self,\n base_url: Optional[StrOrURL] = None,\n *,\n connector: Optional[BaseConnector] = None,\n loop: Optional[asyncio.AbstractEventLoop] = None,\n cookies: Optional[LooseCookies] = None,\n headers: Optional[LooseHeaders] = None,\n skip_auto_headers: Optional[Iterable[str]] = None,\n auth: Optional[BasicAuth] = None,\n json_serialize: JSONEncoder = json.dumps,\n request_class: Type[ClientRequest] = ClientRequest,\n response_class: Type[ClientResponse] = ClientResponse,\n ws_response_class: Type[ClientWebSocketResponse] = ClientWebSocketResponse,\n version: HttpVersion = http.HttpVersion11,\n cookie_jar: Optional[AbstractCookieJar] = None,\n connector_owner: bool = True,\n raise_for_status: Union[\n bool, Callable[[ClientResponse], Awaitable[None]]\n ] = False,\n read_timeout: Union[float, object] = sentinel,\n conn_timeout: Optional[float] = None,\n timeout: Union[object, ClientTimeout] = sentinel,\n auto_decompress: bool = True,\n trust_env: bool = False,\n requote_redirect_url: bool = True,\n trace_configs: Optional[List[TraceConfig]] = None,\n read_bufsize: int = 2**16,\n ) -> None:\n if loop is None:\n if connector is not None:\n loop = connector._loop\n\n loop = get_running_loop(loop)\n\n if base_url is None or isinstance(base_url, URL):\n self._base_url: Optional[URL] = base_url\n else:\n self._base_url = URL(base_url)\n assert (\n self._base_url.origin() == self._base_url\n ), \"Only absolute URLs without path part are supported\"\n\n if connector is None:\n connector = TCPConnector(loop=loop)\n\n if connector._loop is not loop:\n raise RuntimeError(\"Session and connector has to use same event loop\")\n\n self._loop = loop\n\n if loop.get_debug():\n self._source_traceback = traceback.extract_stack(sys._getframe(1))\n\n if cookie_jar is None:\n cookie_jar = CookieJar(loop=loop)\n self._cookie_jar = cookie_jar\n\n if cookies is not None:\n self._cookie_jar.update_cookies(cookies)\n\n self._connector = connector\n self._connector_owner = connector_owner\n self._default_auth = auth\n self._version = version\n self._json_serialize = json_serialize\n if timeout is sentinel:\n self._timeout = DEFAULT_TIMEOUT\n if read_timeout is not sentinel:\n warnings.warn(\n \"read_timeout is deprecated, \" \"use timeout argument instead\",\n DeprecationWarning,\n stacklevel=2,\n )\n self._timeout = attr.evolve(self._timeout, total=read_timeout)\n if conn_timeout is not None:\n self._timeout = attr.evolve(self._timeout, connect=conn_timeout)\n warnings.warn(\n \"conn_timeout is deprecated, \" \"use timeout argument instead\",\n DeprecationWarning,\n stacklevel=2,\n )\n else:\n self._timeout = timeout # type: ignore[assignment]\n if read_timeout is not sentinel:\n raise ValueError(\n \"read_timeout and timeout parameters \"\n \"conflict, please setup \"\n \"timeout.read\"\n )\n if conn_timeout is not None:\n raise ValueError(\n \"conn_timeout and timeout parameters \"\n \"conflict, please setup \"\n \"timeout.connect\"\n )\n self._raise_for_status = raise_for_status\n self._auto_decompress = auto_decompress\n self._trust_env = trust_env\n self._requote_redirect_url = requote_redirect_url\n self._read_bufsize = read_bufsize\n\n # Convert to list of tuples\n if headers:\n real_headers: CIMultiDict[str] = CIMultiDict(headers)\n else:\n real_headers = CIMultiDict()\n self._default_headers: CIMultiDict[str] = real_headers\n if skip_auto_headers is not None:\n self._skip_auto_headers = frozenset(istr(i) for i in skip_auto_headers)\n else:\n self._skip_auto_headers = frozenset()\n\n self._request_class = request_class\n self._response_class = response_class\n self._ws_response_class = ws_response_class\n\n self._trace_configs = trace_configs or []\n for trace_config in self._trace_configs:\n trace_config.freeze()\n\n def __init_subclass__(cls: Type[\"ClientSession\"]) -> None:\n warnings.warn(\n \"Inheritance class {} from ClientSession \"\n \"is discouraged\".format(cls.__name__),\n DeprecationWarning,\n stacklevel=2,\n )\n\n if DEBUG:\n\n def __setattr__(self, name: str, val: Any) -> None:\n if name not in self.ATTRS:\n warnings.warn(\n \"Setting custom ClientSession.{} attribute \"\n \"is discouraged\".format(name),\n DeprecationWarning,\n stacklevel=2,\n )\n super().__setattr__(name, val)\n\n def __del__(self, _warnings: Any = warnings) -> None:\n if not self.closed:\n kwargs = {\"source\": self}\n _warnings.warn(\n f\"Unclosed client session {self!r}\", ResourceWarning, **kwargs\n )\n context = {\"client_session\": self, \"message\": \"Unclosed client session\"}\n if self._source_traceback is not None:\n context[\"source_traceback\"] = self._source_traceback\n self._loop.call_exception_handler(context)\n\n def request(\n self, method: str, url: StrOrURL, **kwargs: Any\n ) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP request.\"\"\"\n return _RequestContextManager(self._request(method, url, **kwargs))\n\n def _build_url(self, str_or_url: StrOrURL) -> URL:\n url = URL(str_or_url)\n if self._base_url is None:\n return url\n else:\n assert not url.is_absolute() and url.path.startswith(\"/\")\n return self._base_url.join(url)\n\n async def _request(\n self,\n method: str,\n str_or_url: StrOrURL,\n *,\n params: Optional[Mapping[str, str]] = None,\n data: Any = None,\n json: Any = None,\n cookies: Optional[LooseCookies] = None,\n headers: Optional[LooseHeaders] = None,\n skip_auto_headers: Optional[Iterable[str]] = None,\n auth: Optional[BasicAuth] = None,\n allow_redirects: bool = True,\n max_redirects: int = 10,\n compress: Optional[str] = None,\n chunked: Optional[bool] = None,\n expect100: bool = False,\n raise_for_status: Union[\n None, bool, Callable[[ClientResponse], Awaitable[None]]\n ] = None,\n read_until_eof: bool = True,\n proxy: Optional[StrOrURL] = None,\n proxy_auth: Optional[BasicAuth] = None,\n timeout: Union[ClientTimeout, _SENTINEL] = sentinel,\n verify_ssl: Optional[bool] = None,\n fingerprint: Optional[bytes] = None,\n ssl_context: Optional[SSLContext] = None,\n ssl: Optional[Union[SSLContext, bool, Fingerprint]] = None,\n proxy_headers: Optional[LooseHeaders] = None,\n trace_request_ctx: Optional[SimpleNamespace] = None,\n read_bufsize: Optional[int] = None,\n auto_decompress: Optional[bool] = None,\n ) -> ClientResponse:\n\n # NOTE: timeout clamps existing connect and read timeouts. We cannot\n # set the default to None because we need to detect if the user wants\n # to use the existing timeouts by setting timeout to None.\n\n if self.closed:\n raise RuntimeError(\"Session is closed\")\n\n ssl = _merge_ssl_params(ssl, verify_ssl, ssl_context, fingerprint)\n\n if data is not None and json is not None:\n raise ValueError(\n \"data and json parameters can not be used at the same time\"\n )\n elif json is not None:\n data = payload.JsonPayload(json, dumps=self._json_serialize)\n\n if not isinstance(chunked, bool) and chunked is not None:\n warnings.warn(\"Chunk size is deprecated #1615\", DeprecationWarning)\n\n redirects = 0\n history = []\n version = self._version\n\n # Merge with default headers and transform to CIMultiDict\n headers = self._prepare_headers(headers)\n proxy_headers = self._prepare_headers(proxy_headers)\n\n try:\n url = self._build_url(str_or_url)\n except ValueError as e:\n raise InvalidURL(str_or_url) from e\n\n skip_headers = set(self._skip_auto_headers)\n if skip_auto_headers is not None:\n for i in skip_auto_headers:\n skip_headers.add(istr(i))\n\n if proxy is not None:\n try:\n proxy = URL(proxy)\n except ValueError as e:\n raise InvalidURL(proxy) from e\n\n if timeout is sentinel:\n real_timeout: ClientTimeout = self._timeout\n else:\n if not isinstance(timeout, ClientTimeout):\n real_timeout = ClientTimeout(total=timeout)\n else:\n real_timeout = timeout\n # timeout is cumulative for all request operations\n # (request, redirects, responses, data consuming)\n tm = TimeoutHandle(\n self._loop, real_timeout.total, ceil_threshold=real_timeout.ceil_threshold\n )\n handle = tm.start()\n\n if read_bufsize is None:\n read_bufsize = self._read_bufsize\n\n if auto_decompress is None:\n auto_decompress = self._auto_decompress\n\n traces = [\n Trace(\n self,\n trace_config,\n trace_config.trace_config_ctx(trace_request_ctx=trace_request_ctx),\n )\n for trace_config in self._trace_configs\n ]\n\n for trace in traces:\n await trace.send_request_start(method, url.update_query(params), headers)\n\n timer = tm.timer()\n try:\n with timer:\n while True:\n url, auth_from_url = strip_auth_from_url(url)\n if auth and auth_from_url:\n raise ValueError(\n \"Cannot combine AUTH argument with \"\n \"credentials encoded in URL\"\n )\n\n if auth is None:\n auth = auth_from_url\n if auth is None:\n auth = self._default_auth\n # It would be confusing if we support explicit\n # Authorization header with auth argument\n if (\n headers is not None\n and auth is not None\n and hdrs.AUTHORIZATION in headers\n ):\n raise ValueError(\n \"Cannot combine AUTHORIZATION header \"\n \"with AUTH argument or credentials \"\n \"encoded in URL\"\n )\n\n all_cookies = self._cookie_jar.filter_cookies(url)\n\n if cookies is not None:\n tmp_cookie_jar = CookieJar()\n tmp_cookie_jar.update_cookies(cookies)\n req_cookies = tmp_cookie_jar.filter_cookies(url)\n if req_cookies:\n all_cookies.load(req_cookies)\n\n if proxy is not None:\n proxy = URL(proxy)\n elif self._trust_env:\n with suppress(LookupError):\n proxy, proxy_auth = get_env_proxy_for_url(url)\n\n req = self._request_class(\n method,\n url,\n params=params,\n headers=headers,\n skip_auto_headers=skip_headers,\n data=data,\n cookies=all_cookies,\n auth=auth,\n version=version,\n compress=compress,\n chunked=chunked,\n expect100=expect100,\n loop=self._loop,\n response_class=self._response_class,\n proxy=proxy,\n proxy_auth=proxy_auth,\n timer=timer,\n session=self,\n ssl=ssl,\n proxy_headers=proxy_headers,\n traces=traces,\n )\n\n # connection timeout\n try:\n async with ceil_timeout(\n real_timeout.connect,\n ceil_threshold=real_timeout.ceil_threshold,\n ):\n assert self._connector is not None\n conn = await self._connector.connect(\n req, traces=traces, timeout=real_timeout\n )\n except asyncio.TimeoutError as exc:\n raise ServerTimeoutError(\n \"Connection timeout \" \"to host {}\".format(url)\n ) from exc\n\n assert conn.transport is not None\n\n assert conn.protocol is not None\n conn.protocol.set_response_params(\n timer=timer,\n skip_payload=method.upper() == \"HEAD\",\n read_until_eof=read_until_eof,\n auto_decompress=auto_decompress,\n read_timeout=real_timeout.sock_read,\n read_bufsize=read_bufsize,\n timeout_ceil_threshold=self._connector._timeout_ceil_threshold,\n )\n\n try:\n try:\n resp = await req.send(conn)\n try:\n await resp.start(conn)\n except BaseException:\n resp.close()\n raise\n except BaseException:\n conn.close()\n raise\n except ClientError:\n raise\n except OSError as exc:\n if exc.errno is None and isinstance(exc, asyncio.TimeoutError):\n raise\n raise ClientOSError(*exc.args) from exc\n\n self._cookie_jar.update_cookies(resp.cookies, resp.url)\n\n # redirects\n if resp.status in (301, 302, 303, 307, 308) and allow_redirects:\n\n for trace in traces:\n await trace.send_request_redirect(\n method, url.update_query(params), headers, resp\n )\n\n redirects += 1\n history.append(resp)\n if max_redirects and redirects >= max_redirects:\n resp.close()\n raise TooManyRedirects(\n history[0].request_info, tuple(history)\n )\n\n # For 301 and 302, mimic IE, now changed in RFC\n # https://github.com/kennethreitz/requests/pull/269\n if (resp.status == 303 and resp.method != hdrs.METH_HEAD) or (\n resp.status in (301, 302) and resp.method == hdrs.METH_POST\n ):\n method = hdrs.METH_GET\n data = None\n if headers.get(hdrs.CONTENT_LENGTH):\n headers.pop(hdrs.CONTENT_LENGTH)\n\n r_url = resp.headers.get(hdrs.LOCATION) or resp.headers.get(\n hdrs.URI\n )\n if r_url is None:\n # see github.com/aio-libs/aiohttp/issues/2022\n break\n else:\n # reading from correct redirection\n # response is forbidden\n resp.release()\n\n try:\n parsed_url = URL(\n r_url, encoded=not self._requote_redirect_url\n )\n\n except ValueError as e:\n raise InvalidURL(r_url) from e\n\n scheme = parsed_url.scheme\n if scheme not in (\"http\", \"https\", \"\"):\n resp.close()\n raise ValueError(\"Can redirect only to http or https\")\n elif not scheme:\n parsed_url = url.join(parsed_url)\n\n if url.origin() != parsed_url.origin():\n auth = None\n headers.pop(hdrs.AUTHORIZATION, None)\n\n url = parsed_url\n params = None\n resp.release()\n continue\n\n break\n\n # check response status\n if raise_for_status is None:\n raise_for_status = self._raise_for_status\n\n if raise_for_status is None:\n pass\n elif callable(raise_for_status):\n await raise_for_status(resp)\n elif raise_for_status:\n resp.raise_for_status()\n\n # register connection\n if handle is not None:\n if resp.connection is not None:\n resp.connection.add_callback(handle.cancel)\n else:\n handle.cancel()\n\n resp._history = tuple(history)\n\n for trace in traces:\n await trace.send_request_end(\n method, url.update_query(params), headers, resp\n )\n return resp\n\n except BaseException as e:\n # cleanup timer\n tm.close()\n if handle:\n handle.cancel()\n handle = None\n\n for trace in traces:\n await trace.send_request_exception(\n method, url.update_query(params), headers, e\n )\n raise\n\n def ws_connect(\n self,\n url: StrOrURL,\n *,\n method: str = hdrs.METH_GET,\n protocols: Iterable[str] = (),\n timeout: float = 10.0,\n receive_timeout: Optional[float] = None,\n autoclose: bool = True,\n autoping: bool = True,\n heartbeat: Optional[float] = None,\n auth: Optional[BasicAuth] = None,\n origin: Optional[str] = None,\n params: Optional[Mapping[str, str]] = None,\n headers: Optional[LooseHeaders] = None,\n proxy: Optional[StrOrURL] = None,\n proxy_auth: Optional[BasicAuth] = None,\n ssl: Union[SSLContext, bool, None, Fingerprint] = None,\n verify_ssl: Optional[bool] = None,\n fingerprint: Optional[bytes] = None,\n ssl_context: Optional[SSLContext] = None,\n proxy_headers: Optional[LooseHeaders] = None,\n compress: int = 0,\n max_msg_size: int = 4 * 1024 * 1024,\n ) -> \"_WSRequestContextManager\":\n \"\"\"Initiate websocket connection.\"\"\"\n return _WSRequestContextManager(\n self._ws_connect(\n url,\n method=method,\n protocols=protocols,\n timeout=timeout,\n receive_timeout=receive_timeout,\n autoclose=autoclose,\n autoping=autoping,\n heartbeat=heartbeat,\n auth=auth,\n origin=origin,\n params=params,\n headers=headers,\n proxy=proxy,\n proxy_auth=proxy_auth,\n ssl=ssl,\n verify_ssl=verify_ssl,\n fingerprint=fingerprint,\n ssl_context=ssl_context,\n proxy_headers=proxy_headers,\n compress=compress,\n max_msg_size=max_msg_size,\n )\n )\n\n async def _ws_connect(\n self,\n url: StrOrURL,\n *,\n method: str = hdrs.METH_GET,\n protocols: Iterable[str] = (),\n timeout: float = 10.0,\n receive_timeout: Optional[float] = None,\n autoclose: bool = True,\n autoping: bool = True,\n heartbeat: Optional[float] = None,\n auth: Optional[BasicAuth] = None,\n origin: Optional[str] = None,\n params: Optional[Mapping[str, str]] = None,\n headers: Optional[LooseHeaders] = None,\n proxy: Optional[StrOrURL] = None,\n proxy_auth: Optional[BasicAuth] = None,\n ssl: Union[SSLContext, bool, None, Fingerprint] = None,\n verify_ssl: Optional[bool] = None,\n fingerprint: Optional[bytes] = None,\n ssl_context: Optional[SSLContext] = None,\n proxy_headers: Optional[LooseHeaders] = None,\n compress: int = 0,\n max_msg_size: int = 4 * 1024 * 1024,\n ) -> ClientWebSocketResponse:\n\n if headers is None:\n real_headers: CIMultiDict[str] = CIMultiDict()\n else:\n real_headers = CIMultiDict(headers)\n\n default_headers = {\n hdrs.UPGRADE: \"websocket\",\n hdrs.CONNECTION: \"upgrade\",\n hdrs.SEC_WEBSOCKET_VERSION: \"13\",\n }\n\n for key, value in default_headers.items():\n real_headers.setdefault(key, value)\n\n sec_key = base64.b64encode(os.urandom(16))\n real_headers[hdrs.SEC_WEBSOCKET_KEY] = sec_key.decode()\n\n if protocols:\n real_headers[hdrs.SEC_WEBSOCKET_PROTOCOL] = \",\".join(protocols)\n if origin is not None:\n real_headers[hdrs.ORIGIN] = origin\n if compress:\n extstr = ws_ext_gen(compress=compress)\n real_headers[hdrs.SEC_WEBSOCKET_EXTENSIONS] = extstr\n\n ssl = _merge_ssl_params(ssl, verify_ssl, ssl_context, fingerprint)\n\n # send request\n resp = await self.request(\n method,\n url,\n params=params,\n headers=real_headers,\n read_until_eof=False,\n auth=auth,\n proxy=proxy,\n proxy_auth=proxy_auth,\n ssl=ssl,\n proxy_headers=proxy_headers,\n )\n\n try:\n # check handshake\n if resp.status != 101:\n raise WSServerHandshakeError(\n resp.request_info,\n resp.history,\n message=\"Invalid response status\",\n status=resp.status,\n headers=resp.headers,\n )\n\n if resp.headers.get(hdrs.UPGRADE, \"\").lower() != \"websocket\":\n raise WSServerHandshakeError(\n resp.request_info,\n resp.history,\n message=\"Invalid upgrade header\",\n status=resp.status,\n headers=resp.headers,\n )\n\n if resp.headers.get(hdrs.CONNECTION, \"\").lower() != \"upgrade\":\n raise WSServerHandshakeError(\n resp.request_info,\n resp.history,\n message=\"Invalid connection header\",\n status=resp.status,\n headers=resp.headers,\n )\n\n # key calculation\n r_key = resp.headers.get(hdrs.SEC_WEBSOCKET_ACCEPT, \"\")\n match = base64.b64encode(hashlib.sha1(sec_key + WS_KEY).digest()).decode()\n if r_key != match:\n raise WSServerHandshakeError(\n resp.request_info,\n resp.history,\n message=\"Invalid challenge response\",\n status=resp.status,\n headers=resp.headers,\n )\n\n # websocket protocol\n protocol = None\n if protocols and hdrs.SEC_WEBSOCKET_PROTOCOL in resp.headers:\n resp_protocols = [\n proto.strip()\n for proto in resp.headers[hdrs.SEC_WEBSOCKET_PROTOCOL].split(\",\")\n ]\n\n for proto in resp_protocols:\n if proto in protocols:\n protocol = proto\n break\n\n # websocket compress\n notakeover = False\n if compress:\n compress_hdrs = resp.headers.get(hdrs.SEC_WEBSOCKET_EXTENSIONS)\n if compress_hdrs:\n try:\n compress, notakeover = ws_ext_parse(compress_hdrs)\n except WSHandshakeError as exc:\n raise WSServerHandshakeError(\n resp.request_info,\n resp.history,\n message=exc.args[0],\n status=resp.status,\n headers=resp.headers,\n ) from exc\n else:\n compress = 0\n notakeover = False\n\n conn = resp.connection\n assert conn is not None\n conn_proto = conn.protocol\n assert conn_proto is not None\n transport = conn.transport\n assert transport is not None\n reader: FlowControlDataQueue[WSMessage] = FlowControlDataQueue(\n conn_proto, 2**16, loop=self._loop\n )\n conn_proto.set_parser(WebSocketReader(reader, max_msg_size), reader)\n writer = WebSocketWriter(\n conn_proto,\n transport,\n use_mask=True,\n compress=compress,\n notakeover=notakeover,\n )\n except BaseException:\n resp.close()\n raise\n else:\n return self._ws_response_class(\n reader,\n writer,\n protocol,\n resp,\n timeout,\n autoclose,\n autoping,\n self._loop,\n receive_timeout=receive_timeout,\n heartbeat=heartbeat,\n compress=compress,\n client_notakeover=notakeover,\n )\n\n def _prepare_headers(self, headers: Optional[LooseHeaders]) -> \"CIMultiDict[str]\":\n \"\"\"Add default headers and transform it to CIMultiDict\"\"\"\n # Convert headers to MultiDict\n result = CIMultiDict(self._default_headers)\n if headers:\n if not isinstance(headers, (MultiDictProxy, MultiDict)):\n headers = CIMultiDict(headers)\n added_names: Set[str] = set()\n for key, value in headers.items():\n if key in added_names:\n result.add(key, value)\n else:\n result[key] = value\n added_names.add(key)\n return result\n\n def get(\n self, url: StrOrURL, *, allow_redirects: bool = True, **kwargs: Any\n ) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP GET request.\"\"\"\n return _RequestContextManager(\n self._request(hdrs.METH_GET, url, allow_redirects=allow_redirects, **kwargs)\n )\n\n def options(\n self, url: StrOrURL, *, allow_redirects: bool = True, **kwargs: Any\n ) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP OPTIONS request.\"\"\"\n return _RequestContextManager(\n self._request(\n hdrs.METH_OPTIONS, url, allow_redirects=allow_redirects, **kwargs\n )\n )\n\n def head(\n self, url: StrOrURL, *, allow_redirects: bool = False, **kwargs: Any\n ) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP HEAD request.\"\"\"\n return _RequestContextManager(\n self._request(\n hdrs.METH_HEAD, url, allow_redirects=allow_redirects, **kwargs\n )\n )\n\n def post(\n self, url: StrOrURL, *, data: Any = None, **kwargs: Any\n ) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP POST request.\"\"\"\n return _RequestContextManager(\n self._request(hdrs.METH_POST, url, data=data, **kwargs)\n )\n\n def put(\n self, url: StrOrURL, *, data: Any = None, **kwargs: Any\n ) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP PUT request.\"\"\"\n return _RequestContextManager(\n self._request(hdrs.METH_PUT, url, data=data, **kwargs)\n )\n\n def patch(\n self, url: StrOrURL, *, data: Any = None, **kwargs: Any\n ) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP PATCH request.\"\"\"\n return _RequestContextManager(\n self._request(hdrs.METH_PATCH, url, data=data, **kwargs)\n )\n\n def delete(self, url: StrOrURL, **kwargs: Any) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP DELETE request.\"\"\"\n return _RequestContextManager(self._request(hdrs.METH_DELETE, url, **kwargs))\n\n async def close(self) -> None:\n \"\"\"Close underlying connector.\n\n Release all acquired resources.\n \"\"\"\n if not self.closed:\n if self._connector is not None and self._connector_owner:\n await self._connector.close()\n self._connector = None\n\n @property\n def closed(self) -> bool:\n \"\"\"Is client session closed.\n\n A readonly property.\n \"\"\"\n return self._connector is None or self._connector.closed\n\n @property\n def connector(self) -> Optional[BaseConnector]:\n \"\"\"Connector instance used for the session.\"\"\"\n return self._connector\n\n @property\n def cookie_jar(self) -> AbstractCookieJar:\n \"\"\"The session cookies.\"\"\"\n return self._cookie_jar\n\n @property\n def version(self) -> Tuple[int, int]:\n \"\"\"The session HTTP protocol version.\"\"\"\n return self._version\n\n @property\n def requote_redirect_url(self) -> bool:\n \"\"\"Do URL requoting on redirection handling.\"\"\"\n return self._requote_redirect_url\n\n @requote_redirect_url.setter\n def requote_redirect_url(self, val: bool) -> None:\n \"\"\"Do URL requoting on redirection handling.\"\"\"\n warnings.warn(\n \"session.requote_redirect_url modification \" \"is deprecated #2778\",\n DeprecationWarning,\n stacklevel=2,\n )\n self._requote_redirect_url = val\n\n @property\n def loop(self) -> asyncio.AbstractEventLoop:\n \"\"\"Session's loop.\"\"\"\n warnings.warn(\n \"client.loop property is deprecated\", DeprecationWarning, stacklevel=2\n )\n return self._loop\n\n @property\n def timeout(self) -> ClientTimeout:\n \"\"\"Timeout for the session.\"\"\"\n return self._timeout\n\n @property\n def headers(self) -> \"CIMultiDict[str]\":\n \"\"\"The default headers of the client session.\"\"\"\n return self._default_headers\n\n @property\n def skip_auto_headers(self) -> FrozenSet[istr]:\n \"\"\"Headers for which autogeneration should be skipped\"\"\"\n return self._skip_auto_headers\n\n @property\n def auth(self) -> Optional[BasicAuth]:\n \"\"\"An object that represents HTTP Basic Authorization\"\"\"\n return self._default_auth\n\n @property\n def json_serialize(self) -> JSONEncoder:\n \"\"\"Json serializer callable\"\"\"\n return self._json_serialize\n\n @property\n def connector_owner(self) -> bool:\n \"\"\"Should connector be closed on session closing\"\"\"\n return self._connector_owner\n\n @property\n def raise_for_status(\n self,\n ) -> Union[bool, Callable[[ClientResponse], Awaitable[None]]]:\n \"\"\"Should `ClientResponse.raise_for_status()` be called for each response.\"\"\"\n return self._raise_for_status\n\n @property\n def auto_decompress(self) -> bool:\n \"\"\"Should the body response be automatically decompressed.\"\"\"\n return self._auto_decompress\n\n @property\n def trust_env(self) -> bool:\n \"\"\"\n Should proxies information from environment or netrc be trusted.\n\n Information is from HTTP_PROXY / HTTPS_PROXY environment variables\n or ~/.netrc file if present.\n \"\"\"\n return self._trust_env\n\n @property\n def trace_configs(self) -> List[TraceConfig]:\n \"\"\"A list of TraceConfig instances used for client tracing\"\"\"\n return self._trace_configs\n\n def detach(self) -> None:\n \"\"\"Detach connector from session without closing the former.\n\n Session is switched to closed state anyway.\n \"\"\"\n self._connector = None\n\n def __enter__(self) -> None:\n raise TypeError(\"Use async with instead\")\n\n def __exit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc_val: Optional[BaseException],\n exc_tb: Optional[TracebackType],\n ) -> None:\n # __exit__ should exist in pair with __enter__ but never executed\n pass # pragma: no cover\n\n async def __aenter__(self) -> \"ClientSession\":\n return self\n\n async def __aexit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc_val: Optional[BaseException],\n exc_tb: Optional[TracebackType],\n ) -> None:\n await self.close()\n\n\nclass _BaseRequestContextManager(Coroutine[Any, Any, _RetType], Generic[_RetType]):\n\n __slots__ = (\"_coro\", \"_resp\")\n\n def __init__(self, coro: Coroutine[\"asyncio.Future[Any]\", None, _RetType]) -> None:\n self._coro = coro\n\n def send(self, arg: None) -> \"asyncio.Future[Any]\":\n return self._coro.send(arg)\n\n def throw(self, arg: BaseException) -> None: # type: ignore[override]\n self._coro.throw(arg)\n\n def close(self) -> None:\n return self._coro.close()\n\n def __await__(self) -> Generator[Any, None, _RetType]:\n ret = self._coro.__await__()\n return ret\n\n def __iter__(self) -> Generator[Any, None, _RetType]:\n return self.__await__()\n\n async def __aenter__(self) -> _RetType:\n self._resp = await self._coro\n return self._resp\n\n\nclass _RequestContextManager(_BaseRequestContextManager[ClientResponse]):\n __slots__ = ()\n\n async def __aexit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc: Optional[BaseException],\n tb: Optional[TracebackType],\n ) -> None:\n # We're basing behavior on the exception as it can be caused by\n # user code unrelated to the status of the connection. If you\n # would like to close a connection you must do that\n # explicitly. Otherwise connection error handling should kick in\n # and close/recycle the connection as required.\n self._resp.release()\n\n\nclass _WSRequestContextManager(_BaseRequestContextManager[ClientWebSocketResponse]):\n __slots__ = ()\n\n async def __aexit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc: Optional[BaseException],\n tb: Optional[TracebackType],\n ) -> None:\n await self._resp.close()\n\n\nclass _SessionRequestContextManager:\n\n __slots__ = (\"_coro\", \"_resp\", \"_session\")\n\n def __init__(\n self,\n coro: Coroutine[\"asyncio.Future[Any]\", None, ClientResponse],\n session: ClientSession,\n ) -> None:\n self._coro = coro\n self._resp: Optional[ClientResponse] = None\n self._session = session\n\n async def __aenter__(self) -> ClientResponse:\n try:\n self._resp = await self._coro\n except BaseException:\n await self._session.close()\n raise\n else:\n return self._resp\n\n async def __aexit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc: Optional[BaseException],\n tb: Optional[TracebackType],\n ) -> None:\n assert self._resp is not None\n self._resp.close()\n await self._session.close()\n\n\ndef request(\n method: str,\n url: StrOrURL,\n *,\n params: Optional[Mapping[str, str]] = None,\n data: Any = None,\n json: Any = None,\n headers: Optional[LooseHeaders] = None,\n skip_auto_headers: Optional[Iterable[str]] = None,\n auth: Optional[BasicAuth] = None,\n allow_redirects: bool = True,\n max_redirects: int = 10,\n compress: Optional[str] = None,\n chunked: Optional[bool] = None,\n expect100: bool = False,\n raise_for_status: Optional[bool] = None,\n read_until_eof: bool = True,\n proxy: Optional[StrOrURL] = None,\n proxy_auth: Optional[BasicAuth] = None,\n timeout: Union[ClientTimeout, object] = sentinel,\n cookies: Optional[LooseCookies] = None,\n version: HttpVersion = http.HttpVersion11,\n connector: Optional[BaseConnector] = None,\n read_bufsize: Optional[int] = None,\n loop: Optional[asyncio.AbstractEventLoop] = None,\n) -> _SessionRequestContextManager:\n \"\"\"Constructs and sends a request.\n\n Returns response object.\n method - HTTP method\n url - request url\n params - (optional) Dictionary or bytes to be sent in the query\n string of the new request\n data - (optional) Dictionary, bytes, or file-like object to\n send in the body of the request\n json - (optional) Any json compatible python object\n headers - (optional) Dictionary of HTTP Headers to send with\n the request\n cookies - (optional) Dict object to send with the request\n auth - (optional) BasicAuth named tuple represent HTTP Basic Auth\n auth - aiohttp.helpers.BasicAuth\n allow_redirects - (optional) If set to False, do not follow\n redirects\n version - Request HTTP version.\n compress - Set to True if request has to be compressed\n with deflate encoding.\n chunked - Set to chunk size for chunked transfer encoding.\n expect100 - Expect 100-continue response from server.\n connector - BaseConnector sub-class instance to support\n connection pooling.\n read_until_eof - Read response until eof if response\n does not have Content-Length header.\n loop - Optional event loop.\n timeout - Optional ClientTimeout settings structure, 5min\n total timeout by default.\n Usage::\n >>> import aiohttp\n >>> resp = await aiohttp.request('GET', 'http://python.org/')\n >>> resp\n <ClientResponse(python.org/) [200]>\n >>> data = await resp.read()\n \"\"\"\n connector_owner = False\n if connector is None:\n connector_owner = True\n connector = TCPConnector(loop=loop, force_close=True)\n\n session = ClientSession(\n loop=loop,\n cookies=cookies,\n version=version,\n timeout=timeout,\n connector=connector,\n connector_owner=connector_owner,\n )\n\n return _SessionRequestContextManager(\n session._request(\n method,\n url,\n params=params,\n data=data,\n json=json,\n headers=headers,\n skip_auto_headers=skip_auto_headers,\n auth=auth,\n allow_redirects=allow_redirects,\n max_redirects=max_redirects,\n compress=compress,\n chunked=chunked,\n expect100=expect100,\n raise_for_status=raise_for_status,\n read_until_eof=read_until_eof,\n proxy=proxy,\n proxy_auth=proxy_auth,\n read_bufsize=read_bufsize,\n ),\n session,\n )\n", "path": "aiohttp/client.py"}], "after_files": [{"content": "\"\"\"HTTP Client for asyncio.\"\"\"\n\nimport asyncio\nimport base64\nimport hashlib\nimport json\nimport os\nimport sys\nimport traceback\nimport warnings\nfrom contextlib import suppress\nfrom types import SimpleNamespace, TracebackType\nfrom typing import (\n Any,\n Awaitable,\n Callable,\n Coroutine,\n FrozenSet,\n Generator,\n Generic,\n Iterable,\n List,\n Mapping,\n Optional,\n Set,\n Tuple,\n Type,\n TypeVar,\n Union,\n)\n\nimport attr\nfrom multidict import CIMultiDict, MultiDict, MultiDictProxy, istr\nfrom yarl import URL\n\nfrom . import hdrs, http, payload\nfrom .abc import AbstractCookieJar\nfrom .client_exceptions import (\n ClientConnectionError as ClientConnectionError,\n ClientConnectorCertificateError as ClientConnectorCertificateError,\n ClientConnectorError as ClientConnectorError,\n ClientConnectorSSLError as ClientConnectorSSLError,\n ClientError as ClientError,\n ClientHttpProxyError as ClientHttpProxyError,\n ClientOSError as ClientOSError,\n ClientPayloadError as ClientPayloadError,\n ClientProxyConnectionError as ClientProxyConnectionError,\n ClientResponseError as ClientResponseError,\n ClientSSLError as ClientSSLError,\n ContentTypeError as ContentTypeError,\n InvalidURL as InvalidURL,\n ServerConnectionError as ServerConnectionError,\n ServerDisconnectedError as ServerDisconnectedError,\n ServerFingerprintMismatch as ServerFingerprintMismatch,\n ServerTimeoutError as ServerTimeoutError,\n TooManyRedirects as TooManyRedirects,\n WSServerHandshakeError as WSServerHandshakeError,\n)\nfrom .client_reqrep import (\n ClientRequest as ClientRequest,\n ClientResponse as ClientResponse,\n Fingerprint as Fingerprint,\n RequestInfo as RequestInfo,\n _merge_ssl_params,\n)\nfrom .client_ws import ClientWebSocketResponse as ClientWebSocketResponse\nfrom .connector import (\n BaseConnector as BaseConnector,\n NamedPipeConnector as NamedPipeConnector,\n TCPConnector as TCPConnector,\n UnixConnector as UnixConnector,\n)\nfrom .cookiejar import CookieJar\nfrom .helpers import (\n _SENTINEL,\n DEBUG,\n BasicAuth,\n TimeoutHandle,\n ceil_timeout,\n get_env_proxy_for_url,\n get_running_loop,\n sentinel,\n strip_auth_from_url,\n)\nfrom .http import WS_KEY, HttpVersion, WebSocketReader, WebSocketWriter\nfrom .http_websocket import WSHandshakeError, WSMessage, ws_ext_gen, ws_ext_parse\nfrom .streams import FlowControlDataQueue\nfrom .tracing import Trace, TraceConfig\nfrom .typedefs import Final, JSONEncoder, LooseCookies, LooseHeaders, StrOrURL\n\n__all__ = (\n # client_exceptions\n \"ClientConnectionError\",\n \"ClientConnectorCertificateError\",\n \"ClientConnectorError\",\n \"ClientConnectorSSLError\",\n \"ClientError\",\n \"ClientHttpProxyError\",\n \"ClientOSError\",\n \"ClientPayloadError\",\n \"ClientProxyConnectionError\",\n \"ClientResponseError\",\n \"ClientSSLError\",\n \"ContentTypeError\",\n \"InvalidURL\",\n \"ServerConnectionError\",\n \"ServerDisconnectedError\",\n \"ServerFingerprintMismatch\",\n \"ServerTimeoutError\",\n \"TooManyRedirects\",\n \"WSServerHandshakeError\",\n # client_reqrep\n \"ClientRequest\",\n \"ClientResponse\",\n \"Fingerprint\",\n \"RequestInfo\",\n # connector\n \"BaseConnector\",\n \"TCPConnector\",\n \"UnixConnector\",\n \"NamedPipeConnector\",\n # client_ws\n \"ClientWebSocketResponse\",\n # client\n \"ClientSession\",\n \"ClientTimeout\",\n \"request\",\n)\n\n\ntry:\n from ssl import SSLContext\nexcept ImportError: # pragma: no cover\n SSLContext = object # type: ignore[misc,assignment]\n\n\[email protected](auto_attribs=True, frozen=True, slots=True)\nclass ClientTimeout:\n total: Optional[float] = None\n connect: Optional[float] = None\n sock_read: Optional[float] = None\n sock_connect: Optional[float] = None\n ceil_threshold: float = 5\n\n # pool_queue_timeout: Optional[float] = None\n # dns_resolution_timeout: Optional[float] = None\n # socket_connect_timeout: Optional[float] = None\n # connection_acquiring_timeout: Optional[float] = None\n # new_connection_timeout: Optional[float] = None\n # http_header_timeout: Optional[float] = None\n # response_body_timeout: Optional[float] = None\n\n # to create a timeout specific for a single request, either\n # - create a completely new one to overwrite the default\n # - or use http://www.attrs.org/en/stable/api.html#attr.evolve\n # to overwrite the defaults\n\n\n# 5 Minute default read timeout\nDEFAULT_TIMEOUT: Final[ClientTimeout] = ClientTimeout(total=5 * 60)\n\n_RetType = TypeVar(\"_RetType\")\n\n\nclass ClientSession:\n \"\"\"First-class interface for making HTTP requests.\"\"\"\n\n ATTRS = frozenset(\n [\n \"_base_url\",\n \"_source_traceback\",\n \"_connector\",\n \"requote_redirect_url\",\n \"_loop\",\n \"_cookie_jar\",\n \"_connector_owner\",\n \"_default_auth\",\n \"_version\",\n \"_json_serialize\",\n \"_requote_redirect_url\",\n \"_timeout\",\n \"_raise_for_status\",\n \"_auto_decompress\",\n \"_trust_env\",\n \"_default_headers\",\n \"_skip_auto_headers\",\n \"_request_class\",\n \"_response_class\",\n \"_ws_response_class\",\n \"_trace_configs\",\n \"_read_bufsize\",\n ]\n )\n\n _source_traceback: Optional[traceback.StackSummary] = None\n _connector: Optional[BaseConnector] = None\n\n def __init__(\n self,\n base_url: Optional[StrOrURL] = None,\n *,\n connector: Optional[BaseConnector] = None,\n loop: Optional[asyncio.AbstractEventLoop] = None,\n cookies: Optional[LooseCookies] = None,\n headers: Optional[LooseHeaders] = None,\n skip_auto_headers: Optional[Iterable[str]] = None,\n auth: Optional[BasicAuth] = None,\n json_serialize: JSONEncoder = json.dumps,\n request_class: Type[ClientRequest] = ClientRequest,\n response_class: Type[ClientResponse] = ClientResponse,\n ws_response_class: Type[ClientWebSocketResponse] = ClientWebSocketResponse,\n version: HttpVersion = http.HttpVersion11,\n cookie_jar: Optional[AbstractCookieJar] = None,\n connector_owner: bool = True,\n raise_for_status: Union[\n bool, Callable[[ClientResponse], Awaitable[None]]\n ] = False,\n read_timeout: Union[float, object] = sentinel,\n conn_timeout: Optional[float] = None,\n timeout: Union[object, ClientTimeout] = sentinel,\n auto_decompress: bool = True,\n trust_env: bool = False,\n requote_redirect_url: bool = True,\n trace_configs: Optional[List[TraceConfig]] = None,\n read_bufsize: int = 2**16,\n ) -> None:\n if loop is None:\n if connector is not None:\n loop = connector._loop\n\n loop = get_running_loop(loop)\n\n if base_url is None or isinstance(base_url, URL):\n self._base_url: Optional[URL] = base_url\n else:\n self._base_url = URL(base_url)\n assert (\n self._base_url.origin() == self._base_url\n ), \"Only absolute URLs without path part are supported\"\n\n if connector is None:\n connector = TCPConnector(loop=loop)\n\n if connector._loop is not loop:\n raise RuntimeError(\"Session and connector has to use same event loop\")\n\n self._loop = loop\n\n if loop.get_debug():\n self._source_traceback = traceback.extract_stack(sys._getframe(1))\n\n if cookie_jar is None:\n cookie_jar = CookieJar(loop=loop)\n self._cookie_jar = cookie_jar\n\n if cookies is not None:\n self._cookie_jar.update_cookies(cookies)\n\n self._connector = connector\n self._connector_owner = connector_owner\n self._default_auth = auth\n self._version = version\n self._json_serialize = json_serialize\n if timeout is sentinel:\n self._timeout = DEFAULT_TIMEOUT\n if read_timeout is not sentinel:\n warnings.warn(\n \"read_timeout is deprecated, \" \"use timeout argument instead\",\n DeprecationWarning,\n stacklevel=2,\n )\n self._timeout = attr.evolve(self._timeout, total=read_timeout)\n if conn_timeout is not None:\n self._timeout = attr.evolve(self._timeout, connect=conn_timeout)\n warnings.warn(\n \"conn_timeout is deprecated, \" \"use timeout argument instead\",\n DeprecationWarning,\n stacklevel=2,\n )\n else:\n self._timeout = timeout # type: ignore[assignment]\n if read_timeout is not sentinel:\n raise ValueError(\n \"read_timeout and timeout parameters \"\n \"conflict, please setup \"\n \"timeout.read\"\n )\n if conn_timeout is not None:\n raise ValueError(\n \"conn_timeout and timeout parameters \"\n \"conflict, please setup \"\n \"timeout.connect\"\n )\n self._raise_for_status = raise_for_status\n self._auto_decompress = auto_decompress\n self._trust_env = trust_env\n self._requote_redirect_url = requote_redirect_url\n self._read_bufsize = read_bufsize\n\n # Convert to list of tuples\n if headers:\n real_headers: CIMultiDict[str] = CIMultiDict(headers)\n else:\n real_headers = CIMultiDict()\n self._default_headers: CIMultiDict[str] = real_headers\n if skip_auto_headers is not None:\n self._skip_auto_headers = frozenset(istr(i) for i in skip_auto_headers)\n else:\n self._skip_auto_headers = frozenset()\n\n self._request_class = request_class\n self._response_class = response_class\n self._ws_response_class = ws_response_class\n\n self._trace_configs = trace_configs or []\n for trace_config in self._trace_configs:\n trace_config.freeze()\n\n def __init_subclass__(cls: Type[\"ClientSession\"]) -> None:\n warnings.warn(\n \"Inheritance class {} from ClientSession \"\n \"is discouraged\".format(cls.__name__),\n DeprecationWarning,\n stacklevel=2,\n )\n\n if DEBUG:\n\n def __setattr__(self, name: str, val: Any) -> None:\n if name not in self.ATTRS:\n warnings.warn(\n \"Setting custom ClientSession.{} attribute \"\n \"is discouraged\".format(name),\n DeprecationWarning,\n stacklevel=2,\n )\n super().__setattr__(name, val)\n\n def __del__(self, _warnings: Any = warnings) -> None:\n if not self.closed:\n kwargs = {\"source\": self}\n _warnings.warn(\n f\"Unclosed client session {self!r}\", ResourceWarning, **kwargs\n )\n context = {\"client_session\": self, \"message\": \"Unclosed client session\"}\n if self._source_traceback is not None:\n context[\"source_traceback\"] = self._source_traceback\n self._loop.call_exception_handler(context)\n\n def request(\n self, method: str, url: StrOrURL, **kwargs: Any\n ) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP request.\"\"\"\n return _RequestContextManager(self._request(method, url, **kwargs))\n\n def _build_url(self, str_or_url: StrOrURL) -> URL:\n url = URL(str_or_url)\n if self._base_url is None:\n return url\n else:\n assert not url.is_absolute() and url.path.startswith(\"/\")\n return self._base_url.join(url)\n\n async def _request(\n self,\n method: str,\n str_or_url: StrOrURL,\n *,\n params: Optional[Mapping[str, str]] = None,\n data: Any = None,\n json: Any = None,\n cookies: Optional[LooseCookies] = None,\n headers: Optional[LooseHeaders] = None,\n skip_auto_headers: Optional[Iterable[str]] = None,\n auth: Optional[BasicAuth] = None,\n allow_redirects: bool = True,\n max_redirects: int = 10,\n compress: Optional[str] = None,\n chunked: Optional[bool] = None,\n expect100: bool = False,\n raise_for_status: Union[\n None, bool, Callable[[ClientResponse], Awaitable[None]]\n ] = None,\n read_until_eof: bool = True,\n proxy: Optional[StrOrURL] = None,\n proxy_auth: Optional[BasicAuth] = None,\n timeout: Union[ClientTimeout, _SENTINEL] = sentinel,\n verify_ssl: Optional[bool] = None,\n fingerprint: Optional[bytes] = None,\n ssl_context: Optional[SSLContext] = None,\n ssl: Optional[Union[SSLContext, bool, Fingerprint]] = None,\n proxy_headers: Optional[LooseHeaders] = None,\n trace_request_ctx: Optional[SimpleNamespace] = None,\n read_bufsize: Optional[int] = None,\n auto_decompress: Optional[bool] = None,\n ) -> ClientResponse:\n\n # NOTE: timeout clamps existing connect and read timeouts. We cannot\n # set the default to None because we need to detect if the user wants\n # to use the existing timeouts by setting timeout to None.\n\n if self.closed:\n raise RuntimeError(\"Session is closed\")\n\n ssl = _merge_ssl_params(ssl, verify_ssl, ssl_context, fingerprint)\n\n if data is not None and json is not None:\n raise ValueError(\n \"data and json parameters can not be used at the same time\"\n )\n elif json is not None:\n data = payload.JsonPayload(json, dumps=self._json_serialize)\n\n if not isinstance(chunked, bool) and chunked is not None:\n warnings.warn(\"Chunk size is deprecated #1615\", DeprecationWarning)\n\n redirects = 0\n history = []\n version = self._version\n\n # Merge with default headers and transform to CIMultiDict\n headers = self._prepare_headers(headers)\n proxy_headers = self._prepare_headers(proxy_headers)\n\n try:\n url = self._build_url(str_or_url)\n except ValueError as e:\n raise InvalidURL(str_or_url) from e\n\n skip_headers = set(self._skip_auto_headers)\n if skip_auto_headers is not None:\n for i in skip_auto_headers:\n skip_headers.add(istr(i))\n\n if proxy is not None:\n try:\n proxy = URL(proxy)\n except ValueError as e:\n raise InvalidURL(proxy) from e\n\n if timeout is sentinel:\n real_timeout: ClientTimeout = self._timeout\n else:\n if not isinstance(timeout, ClientTimeout):\n real_timeout = ClientTimeout(total=timeout)\n else:\n real_timeout = timeout\n # timeout is cumulative for all request operations\n # (request, redirects, responses, data consuming)\n tm = TimeoutHandle(\n self._loop, real_timeout.total, ceil_threshold=real_timeout.ceil_threshold\n )\n handle = tm.start()\n\n if read_bufsize is None:\n read_bufsize = self._read_bufsize\n\n if auto_decompress is None:\n auto_decompress = self._auto_decompress\n\n traces = [\n Trace(\n self,\n trace_config,\n trace_config.trace_config_ctx(trace_request_ctx=trace_request_ctx),\n )\n for trace_config in self._trace_configs\n ]\n\n for trace in traces:\n await trace.send_request_start(method, url.update_query(params), headers)\n\n timer = tm.timer()\n try:\n with timer:\n while True:\n url, auth_from_url = strip_auth_from_url(url)\n if auth and auth_from_url:\n raise ValueError(\n \"Cannot combine AUTH argument with \"\n \"credentials encoded in URL\"\n )\n\n if auth is None:\n auth = auth_from_url\n if auth is None:\n auth = self._default_auth\n # It would be confusing if we support explicit\n # Authorization header with auth argument\n if (\n headers is not None\n and auth is not None\n and hdrs.AUTHORIZATION in headers\n ):\n raise ValueError(\n \"Cannot combine AUTHORIZATION header \"\n \"with AUTH argument or credentials \"\n \"encoded in URL\"\n )\n\n all_cookies = self._cookie_jar.filter_cookies(url)\n\n if cookies is not None:\n tmp_cookie_jar = CookieJar()\n tmp_cookie_jar.update_cookies(cookies)\n req_cookies = tmp_cookie_jar.filter_cookies(url)\n if req_cookies:\n all_cookies.load(req_cookies)\n\n if proxy is not None:\n proxy = URL(proxy)\n elif self._trust_env:\n with suppress(LookupError):\n proxy, proxy_auth = get_env_proxy_for_url(url)\n\n req = self._request_class(\n method,\n url,\n params=params,\n headers=headers,\n skip_auto_headers=skip_headers,\n data=data,\n cookies=all_cookies,\n auth=auth,\n version=version,\n compress=compress,\n chunked=chunked,\n expect100=expect100,\n loop=self._loop,\n response_class=self._response_class,\n proxy=proxy,\n proxy_auth=proxy_auth,\n timer=timer,\n session=self,\n ssl=ssl,\n proxy_headers=proxy_headers,\n traces=traces,\n )\n\n # connection timeout\n try:\n async with ceil_timeout(\n real_timeout.connect,\n ceil_threshold=real_timeout.ceil_threshold,\n ):\n assert self._connector is not None\n conn = await self._connector.connect(\n req, traces=traces, timeout=real_timeout\n )\n except asyncio.TimeoutError as exc:\n raise ServerTimeoutError(\n \"Connection timeout \" \"to host {}\".format(url)\n ) from exc\n\n assert conn.transport is not None\n\n assert conn.protocol is not None\n conn.protocol.set_response_params(\n timer=timer,\n skip_payload=method.upper() == \"HEAD\",\n read_until_eof=read_until_eof,\n auto_decompress=auto_decompress,\n read_timeout=real_timeout.sock_read,\n read_bufsize=read_bufsize,\n timeout_ceil_threshold=self._connector._timeout_ceil_threshold,\n )\n\n try:\n try:\n resp = await req.send(conn)\n try:\n await resp.start(conn)\n except BaseException:\n resp.close()\n raise\n except BaseException:\n conn.close()\n raise\n except ClientError:\n raise\n except OSError as exc:\n if exc.errno is None and isinstance(exc, asyncio.TimeoutError):\n raise\n raise ClientOSError(*exc.args) from exc\n\n self._cookie_jar.update_cookies(resp.cookies, resp.url)\n\n # redirects\n if resp.status in (301, 302, 303, 307, 308) and allow_redirects:\n\n for trace in traces:\n await trace.send_request_redirect(\n method, url.update_query(params), headers, resp\n )\n\n redirects += 1\n history.append(resp)\n if max_redirects and redirects >= max_redirects:\n resp.close()\n raise TooManyRedirects(\n history[0].request_info, tuple(history)\n )\n\n # For 301 and 302, mimic IE, now changed in RFC\n # https://github.com/kennethreitz/requests/pull/269\n if (resp.status == 303 and resp.method != hdrs.METH_HEAD) or (\n resp.status in (301, 302) and resp.method == hdrs.METH_POST\n ):\n method = hdrs.METH_GET\n data = None\n if headers.get(hdrs.CONTENT_LENGTH):\n headers.pop(hdrs.CONTENT_LENGTH)\n\n r_url = resp.headers.get(hdrs.LOCATION) or resp.headers.get(\n hdrs.URI\n )\n if r_url is None:\n # see github.com/aio-libs/aiohttp/issues/2022\n break\n else:\n # reading from correct redirection\n # response is forbidden\n resp.release()\n\n try:\n parsed_url = URL(\n r_url, encoded=not self._requote_redirect_url\n )\n\n except ValueError as e:\n raise InvalidURL(r_url) from e\n\n scheme = parsed_url.scheme\n if scheme not in (\"http\", \"https\", \"\"):\n resp.close()\n raise ValueError(\"Can redirect only to http or https\")\n elif not scheme:\n parsed_url = url.join(parsed_url)\n\n if url.origin() != parsed_url.origin():\n auth = None\n headers.pop(hdrs.AUTHORIZATION, None)\n\n url = parsed_url\n params = None\n resp.release()\n continue\n\n break\n\n # check response status\n if raise_for_status is None:\n raise_for_status = self._raise_for_status\n\n if raise_for_status is None:\n pass\n elif callable(raise_for_status):\n await raise_for_status(resp)\n elif raise_for_status:\n resp.raise_for_status()\n\n # register connection\n if handle is not None:\n if resp.connection is not None:\n resp.connection.add_callback(handle.cancel)\n else:\n handle.cancel()\n\n resp._history = tuple(history)\n\n for trace in traces:\n await trace.send_request_end(\n method, url.update_query(params), headers, resp\n )\n return resp\n\n except BaseException as e:\n # cleanup timer\n tm.close()\n if handle:\n handle.cancel()\n handle = None\n\n for trace in traces:\n await trace.send_request_exception(\n method, url.update_query(params), headers, e\n )\n raise\n\n def ws_connect(\n self,\n url: StrOrURL,\n *,\n method: str = hdrs.METH_GET,\n protocols: Iterable[str] = (),\n timeout: float = 10.0,\n receive_timeout: Optional[float] = None,\n autoclose: bool = True,\n autoping: bool = True,\n heartbeat: Optional[float] = None,\n auth: Optional[BasicAuth] = None,\n origin: Optional[str] = None,\n params: Optional[Mapping[str, str]] = None,\n headers: Optional[LooseHeaders] = None,\n proxy: Optional[StrOrURL] = None,\n proxy_auth: Optional[BasicAuth] = None,\n ssl: Union[SSLContext, bool, None, Fingerprint] = None,\n verify_ssl: Optional[bool] = None,\n fingerprint: Optional[bytes] = None,\n ssl_context: Optional[SSLContext] = None,\n proxy_headers: Optional[LooseHeaders] = None,\n compress: int = 0,\n max_msg_size: int = 4 * 1024 * 1024,\n ) -> \"_WSRequestContextManager\":\n \"\"\"Initiate websocket connection.\"\"\"\n return _WSRequestContextManager(\n self._ws_connect(\n url,\n method=method,\n protocols=protocols,\n timeout=timeout,\n receive_timeout=receive_timeout,\n autoclose=autoclose,\n autoping=autoping,\n heartbeat=heartbeat,\n auth=auth,\n origin=origin,\n params=params,\n headers=headers,\n proxy=proxy,\n proxy_auth=proxy_auth,\n ssl=ssl,\n verify_ssl=verify_ssl,\n fingerprint=fingerprint,\n ssl_context=ssl_context,\n proxy_headers=proxy_headers,\n compress=compress,\n max_msg_size=max_msg_size,\n )\n )\n\n async def _ws_connect(\n self,\n url: StrOrURL,\n *,\n method: str = hdrs.METH_GET,\n protocols: Iterable[str] = (),\n timeout: float = 10.0,\n receive_timeout: Optional[float] = None,\n autoclose: bool = True,\n autoping: bool = True,\n heartbeat: Optional[float] = None,\n auth: Optional[BasicAuth] = None,\n origin: Optional[str] = None,\n params: Optional[Mapping[str, str]] = None,\n headers: Optional[LooseHeaders] = None,\n proxy: Optional[StrOrURL] = None,\n proxy_auth: Optional[BasicAuth] = None,\n ssl: Union[SSLContext, bool, None, Fingerprint] = None,\n verify_ssl: Optional[bool] = None,\n fingerprint: Optional[bytes] = None,\n ssl_context: Optional[SSLContext] = None,\n proxy_headers: Optional[LooseHeaders] = None,\n compress: int = 0,\n max_msg_size: int = 4 * 1024 * 1024,\n ) -> ClientWebSocketResponse:\n\n if headers is None:\n real_headers: CIMultiDict[str] = CIMultiDict()\n else:\n real_headers = CIMultiDict(headers)\n\n default_headers = {\n hdrs.UPGRADE: \"websocket\",\n hdrs.CONNECTION: \"Upgrade\",\n hdrs.SEC_WEBSOCKET_VERSION: \"13\",\n }\n\n for key, value in default_headers.items():\n real_headers.setdefault(key, value)\n\n sec_key = base64.b64encode(os.urandom(16))\n real_headers[hdrs.SEC_WEBSOCKET_KEY] = sec_key.decode()\n\n if protocols:\n real_headers[hdrs.SEC_WEBSOCKET_PROTOCOL] = \",\".join(protocols)\n if origin is not None:\n real_headers[hdrs.ORIGIN] = origin\n if compress:\n extstr = ws_ext_gen(compress=compress)\n real_headers[hdrs.SEC_WEBSOCKET_EXTENSIONS] = extstr\n\n ssl = _merge_ssl_params(ssl, verify_ssl, ssl_context, fingerprint)\n\n # send request\n resp = await self.request(\n method,\n url,\n params=params,\n headers=real_headers,\n read_until_eof=False,\n auth=auth,\n proxy=proxy,\n proxy_auth=proxy_auth,\n ssl=ssl,\n proxy_headers=proxy_headers,\n )\n\n try:\n # check handshake\n if resp.status != 101:\n raise WSServerHandshakeError(\n resp.request_info,\n resp.history,\n message=\"Invalid response status\",\n status=resp.status,\n headers=resp.headers,\n )\n\n if resp.headers.get(hdrs.UPGRADE, \"\").lower() != \"websocket\":\n raise WSServerHandshakeError(\n resp.request_info,\n resp.history,\n message=\"Invalid upgrade header\",\n status=resp.status,\n headers=resp.headers,\n )\n\n if resp.headers.get(hdrs.CONNECTION, \"\").lower() != \"upgrade\":\n raise WSServerHandshakeError(\n resp.request_info,\n resp.history,\n message=\"Invalid connection header\",\n status=resp.status,\n headers=resp.headers,\n )\n\n # key calculation\n r_key = resp.headers.get(hdrs.SEC_WEBSOCKET_ACCEPT, \"\")\n match = base64.b64encode(hashlib.sha1(sec_key + WS_KEY).digest()).decode()\n if r_key != match:\n raise WSServerHandshakeError(\n resp.request_info,\n resp.history,\n message=\"Invalid challenge response\",\n status=resp.status,\n headers=resp.headers,\n )\n\n # websocket protocol\n protocol = None\n if protocols and hdrs.SEC_WEBSOCKET_PROTOCOL in resp.headers:\n resp_protocols = [\n proto.strip()\n for proto in resp.headers[hdrs.SEC_WEBSOCKET_PROTOCOL].split(\",\")\n ]\n\n for proto in resp_protocols:\n if proto in protocols:\n protocol = proto\n break\n\n # websocket compress\n notakeover = False\n if compress:\n compress_hdrs = resp.headers.get(hdrs.SEC_WEBSOCKET_EXTENSIONS)\n if compress_hdrs:\n try:\n compress, notakeover = ws_ext_parse(compress_hdrs)\n except WSHandshakeError as exc:\n raise WSServerHandshakeError(\n resp.request_info,\n resp.history,\n message=exc.args[0],\n status=resp.status,\n headers=resp.headers,\n ) from exc\n else:\n compress = 0\n notakeover = False\n\n conn = resp.connection\n assert conn is not None\n conn_proto = conn.protocol\n assert conn_proto is not None\n transport = conn.transport\n assert transport is not None\n reader: FlowControlDataQueue[WSMessage] = FlowControlDataQueue(\n conn_proto, 2**16, loop=self._loop\n )\n conn_proto.set_parser(WebSocketReader(reader, max_msg_size), reader)\n writer = WebSocketWriter(\n conn_proto,\n transport,\n use_mask=True,\n compress=compress,\n notakeover=notakeover,\n )\n except BaseException:\n resp.close()\n raise\n else:\n return self._ws_response_class(\n reader,\n writer,\n protocol,\n resp,\n timeout,\n autoclose,\n autoping,\n self._loop,\n receive_timeout=receive_timeout,\n heartbeat=heartbeat,\n compress=compress,\n client_notakeover=notakeover,\n )\n\n def _prepare_headers(self, headers: Optional[LooseHeaders]) -> \"CIMultiDict[str]\":\n \"\"\"Add default headers and transform it to CIMultiDict\"\"\"\n # Convert headers to MultiDict\n result = CIMultiDict(self._default_headers)\n if headers:\n if not isinstance(headers, (MultiDictProxy, MultiDict)):\n headers = CIMultiDict(headers)\n added_names: Set[str] = set()\n for key, value in headers.items():\n if key in added_names:\n result.add(key, value)\n else:\n result[key] = value\n added_names.add(key)\n return result\n\n def get(\n self, url: StrOrURL, *, allow_redirects: bool = True, **kwargs: Any\n ) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP GET request.\"\"\"\n return _RequestContextManager(\n self._request(hdrs.METH_GET, url, allow_redirects=allow_redirects, **kwargs)\n )\n\n def options(\n self, url: StrOrURL, *, allow_redirects: bool = True, **kwargs: Any\n ) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP OPTIONS request.\"\"\"\n return _RequestContextManager(\n self._request(\n hdrs.METH_OPTIONS, url, allow_redirects=allow_redirects, **kwargs\n )\n )\n\n def head(\n self, url: StrOrURL, *, allow_redirects: bool = False, **kwargs: Any\n ) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP HEAD request.\"\"\"\n return _RequestContextManager(\n self._request(\n hdrs.METH_HEAD, url, allow_redirects=allow_redirects, **kwargs\n )\n )\n\n def post(\n self, url: StrOrURL, *, data: Any = None, **kwargs: Any\n ) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP POST request.\"\"\"\n return _RequestContextManager(\n self._request(hdrs.METH_POST, url, data=data, **kwargs)\n )\n\n def put(\n self, url: StrOrURL, *, data: Any = None, **kwargs: Any\n ) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP PUT request.\"\"\"\n return _RequestContextManager(\n self._request(hdrs.METH_PUT, url, data=data, **kwargs)\n )\n\n def patch(\n self, url: StrOrURL, *, data: Any = None, **kwargs: Any\n ) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP PATCH request.\"\"\"\n return _RequestContextManager(\n self._request(hdrs.METH_PATCH, url, data=data, **kwargs)\n )\n\n def delete(self, url: StrOrURL, **kwargs: Any) -> \"_RequestContextManager\":\n \"\"\"Perform HTTP DELETE request.\"\"\"\n return _RequestContextManager(self._request(hdrs.METH_DELETE, url, **kwargs))\n\n async def close(self) -> None:\n \"\"\"Close underlying connector.\n\n Release all acquired resources.\n \"\"\"\n if not self.closed:\n if self._connector is not None and self._connector_owner:\n await self._connector.close()\n self._connector = None\n\n @property\n def closed(self) -> bool:\n \"\"\"Is client session closed.\n\n A readonly property.\n \"\"\"\n return self._connector is None or self._connector.closed\n\n @property\n def connector(self) -> Optional[BaseConnector]:\n \"\"\"Connector instance used for the session.\"\"\"\n return self._connector\n\n @property\n def cookie_jar(self) -> AbstractCookieJar:\n \"\"\"The session cookies.\"\"\"\n return self._cookie_jar\n\n @property\n def version(self) -> Tuple[int, int]:\n \"\"\"The session HTTP protocol version.\"\"\"\n return self._version\n\n @property\n def requote_redirect_url(self) -> bool:\n \"\"\"Do URL requoting on redirection handling.\"\"\"\n return self._requote_redirect_url\n\n @requote_redirect_url.setter\n def requote_redirect_url(self, val: bool) -> None:\n \"\"\"Do URL requoting on redirection handling.\"\"\"\n warnings.warn(\n \"session.requote_redirect_url modification \" \"is deprecated #2778\",\n DeprecationWarning,\n stacklevel=2,\n )\n self._requote_redirect_url = val\n\n @property\n def loop(self) -> asyncio.AbstractEventLoop:\n \"\"\"Session's loop.\"\"\"\n warnings.warn(\n \"client.loop property is deprecated\", DeprecationWarning, stacklevel=2\n )\n return self._loop\n\n @property\n def timeout(self) -> ClientTimeout:\n \"\"\"Timeout for the session.\"\"\"\n return self._timeout\n\n @property\n def headers(self) -> \"CIMultiDict[str]\":\n \"\"\"The default headers of the client session.\"\"\"\n return self._default_headers\n\n @property\n def skip_auto_headers(self) -> FrozenSet[istr]:\n \"\"\"Headers for which autogeneration should be skipped\"\"\"\n return self._skip_auto_headers\n\n @property\n def auth(self) -> Optional[BasicAuth]:\n \"\"\"An object that represents HTTP Basic Authorization\"\"\"\n return self._default_auth\n\n @property\n def json_serialize(self) -> JSONEncoder:\n \"\"\"Json serializer callable\"\"\"\n return self._json_serialize\n\n @property\n def connector_owner(self) -> bool:\n \"\"\"Should connector be closed on session closing\"\"\"\n return self._connector_owner\n\n @property\n def raise_for_status(\n self,\n ) -> Union[bool, Callable[[ClientResponse], Awaitable[None]]]:\n \"\"\"Should `ClientResponse.raise_for_status()` be called for each response.\"\"\"\n return self._raise_for_status\n\n @property\n def auto_decompress(self) -> bool:\n \"\"\"Should the body response be automatically decompressed.\"\"\"\n return self._auto_decompress\n\n @property\n def trust_env(self) -> bool:\n \"\"\"\n Should proxies information from environment or netrc be trusted.\n\n Information is from HTTP_PROXY / HTTPS_PROXY environment variables\n or ~/.netrc file if present.\n \"\"\"\n return self._trust_env\n\n @property\n def trace_configs(self) -> List[TraceConfig]:\n \"\"\"A list of TraceConfig instances used for client tracing\"\"\"\n return self._trace_configs\n\n def detach(self) -> None:\n \"\"\"Detach connector from session without closing the former.\n\n Session is switched to closed state anyway.\n \"\"\"\n self._connector = None\n\n def __enter__(self) -> None:\n raise TypeError(\"Use async with instead\")\n\n def __exit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc_val: Optional[BaseException],\n exc_tb: Optional[TracebackType],\n ) -> None:\n # __exit__ should exist in pair with __enter__ but never executed\n pass # pragma: no cover\n\n async def __aenter__(self) -> \"ClientSession\":\n return self\n\n async def __aexit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc_val: Optional[BaseException],\n exc_tb: Optional[TracebackType],\n ) -> None:\n await self.close()\n\n\nclass _BaseRequestContextManager(Coroutine[Any, Any, _RetType], Generic[_RetType]):\n\n __slots__ = (\"_coro\", \"_resp\")\n\n def __init__(self, coro: Coroutine[\"asyncio.Future[Any]\", None, _RetType]) -> None:\n self._coro = coro\n\n def send(self, arg: None) -> \"asyncio.Future[Any]\":\n return self._coro.send(arg)\n\n def throw(self, arg: BaseException) -> None: # type: ignore[override]\n self._coro.throw(arg)\n\n def close(self) -> None:\n return self._coro.close()\n\n def __await__(self) -> Generator[Any, None, _RetType]:\n ret = self._coro.__await__()\n return ret\n\n def __iter__(self) -> Generator[Any, None, _RetType]:\n return self.__await__()\n\n async def __aenter__(self) -> _RetType:\n self._resp = await self._coro\n return self._resp\n\n\nclass _RequestContextManager(_BaseRequestContextManager[ClientResponse]):\n __slots__ = ()\n\n async def __aexit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc: Optional[BaseException],\n tb: Optional[TracebackType],\n ) -> None:\n # We're basing behavior on the exception as it can be caused by\n # user code unrelated to the status of the connection. If you\n # would like to close a connection you must do that\n # explicitly. Otherwise connection error handling should kick in\n # and close/recycle the connection as required.\n self._resp.release()\n\n\nclass _WSRequestContextManager(_BaseRequestContextManager[ClientWebSocketResponse]):\n __slots__ = ()\n\n async def __aexit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc: Optional[BaseException],\n tb: Optional[TracebackType],\n ) -> None:\n await self._resp.close()\n\n\nclass _SessionRequestContextManager:\n\n __slots__ = (\"_coro\", \"_resp\", \"_session\")\n\n def __init__(\n self,\n coro: Coroutine[\"asyncio.Future[Any]\", None, ClientResponse],\n session: ClientSession,\n ) -> None:\n self._coro = coro\n self._resp: Optional[ClientResponse] = None\n self._session = session\n\n async def __aenter__(self) -> ClientResponse:\n try:\n self._resp = await self._coro\n except BaseException:\n await self._session.close()\n raise\n else:\n return self._resp\n\n async def __aexit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc: Optional[BaseException],\n tb: Optional[TracebackType],\n ) -> None:\n assert self._resp is not None\n self._resp.close()\n await self._session.close()\n\n\ndef request(\n method: str,\n url: StrOrURL,\n *,\n params: Optional[Mapping[str, str]] = None,\n data: Any = None,\n json: Any = None,\n headers: Optional[LooseHeaders] = None,\n skip_auto_headers: Optional[Iterable[str]] = None,\n auth: Optional[BasicAuth] = None,\n allow_redirects: bool = True,\n max_redirects: int = 10,\n compress: Optional[str] = None,\n chunked: Optional[bool] = None,\n expect100: bool = False,\n raise_for_status: Optional[bool] = None,\n read_until_eof: bool = True,\n proxy: Optional[StrOrURL] = None,\n proxy_auth: Optional[BasicAuth] = None,\n timeout: Union[ClientTimeout, object] = sentinel,\n cookies: Optional[LooseCookies] = None,\n version: HttpVersion = http.HttpVersion11,\n connector: Optional[BaseConnector] = None,\n read_bufsize: Optional[int] = None,\n loop: Optional[asyncio.AbstractEventLoop] = None,\n) -> _SessionRequestContextManager:\n \"\"\"Constructs and sends a request.\n\n Returns response object.\n method - HTTP method\n url - request url\n params - (optional) Dictionary or bytes to be sent in the query\n string of the new request\n data - (optional) Dictionary, bytes, or file-like object to\n send in the body of the request\n json - (optional) Any json compatible python object\n headers - (optional) Dictionary of HTTP Headers to send with\n the request\n cookies - (optional) Dict object to send with the request\n auth - (optional) BasicAuth named tuple represent HTTP Basic Auth\n auth - aiohttp.helpers.BasicAuth\n allow_redirects - (optional) If set to False, do not follow\n redirects\n version - Request HTTP version.\n compress - Set to True if request has to be compressed\n with deflate encoding.\n chunked - Set to chunk size for chunked transfer encoding.\n expect100 - Expect 100-continue response from server.\n connector - BaseConnector sub-class instance to support\n connection pooling.\n read_until_eof - Read response until eof if response\n does not have Content-Length header.\n loop - Optional event loop.\n timeout - Optional ClientTimeout settings structure, 5min\n total timeout by default.\n Usage::\n >>> import aiohttp\n >>> resp = await aiohttp.request('GET', 'http://python.org/')\n >>> resp\n <ClientResponse(python.org/) [200]>\n >>> data = await resp.read()\n \"\"\"\n connector_owner = False\n if connector is None:\n connector_owner = True\n connector = TCPConnector(loop=loop, force_close=True)\n\n session = ClientSession(\n loop=loop,\n cookies=cookies,\n version=version,\n timeout=timeout,\n connector=connector,\n connector_owner=connector_owner,\n )\n\n return _SessionRequestContextManager(\n session._request(\n method,\n url,\n params=params,\n data=data,\n json=json,\n headers=headers,\n skip_auto_headers=skip_auto_headers,\n auth=auth,\n allow_redirects=allow_redirects,\n max_redirects=max_redirects,\n compress=compress,\n chunked=chunked,\n expect100=expect100,\n raise_for_status=raise_for_status,\n read_until_eof=read_until_eof,\n proxy=proxy,\n proxy_auth=proxy_auth,\n read_bufsize=read_bufsize,\n ),\n session,\n )\n", "path": "aiohttp/client.py"}]} |
gh_patches_debug_282 | rasdani/github-patches | git_diff | python__mypy-11823 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Regression in mypy 0.930: Cannot override writable attribute "__module__" with a final one
**Bug Report**
The following code is reported as error by mypy 0.930 (Python 3.8). It seems correct, and was considered correct so far:
```python
from enum import Enum
class PyFormat(str, Enum):
__module__ = "psycopg.adapt"
AUTO = "s"
TEXT = "t"
BINARY = "b"
```
The error reported is:
```
$ mypy test_mypy.py
test_mypy.py:4: error: Cannot override writable attribute "__module__" with a final one [misc]
```
which I don't even know what means...
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `mypy/semanal_enum.py`
Content:
```
1 """Semantic analysis of call-based Enum definitions.
2
3 This is conceptually part of mypy.semanal (semantic analyzer pass 2).
4 """
5
6 from typing import List, Tuple, Optional, Union, cast
7 from typing_extensions import Final
8
9 from mypy.nodes import (
10 Expression, Context, TypeInfo, AssignmentStmt, NameExpr, CallExpr, RefExpr, StrExpr,
11 UnicodeExpr, TupleExpr, ListExpr, DictExpr, Var, SymbolTableNode, MDEF, ARG_POS,
12 ARG_NAMED, EnumCallExpr, MemberExpr
13 )
14 from mypy.semanal_shared import SemanticAnalyzerInterface
15 from mypy.options import Options
16
17 # Note: 'enum.EnumMeta' is deliberately excluded from this list. Classes that directly use
18 # enum.EnumMeta do not necessarily automatically have the 'name' and 'value' attributes.
19 ENUM_BASES: Final = frozenset((
20 'enum.Enum', 'enum.IntEnum', 'enum.Flag', 'enum.IntFlag',
21 ))
22 ENUM_SPECIAL_PROPS: Final = frozenset((
23 'name', 'value', '_name_', '_value_', '_order_', '__order__',
24 ))
25
26
27 class EnumCallAnalyzer:
28 def __init__(self, options: Options, api: SemanticAnalyzerInterface) -> None:
29 self.options = options
30 self.api = api
31
32 def process_enum_call(self, s: AssignmentStmt, is_func_scope: bool) -> bool:
33 """Check if s defines an Enum; if yes, store the definition in symbol table.
34
35 Return True if this looks like an Enum definition (but maybe with errors),
36 otherwise return False.
37 """
38 if len(s.lvalues) != 1 or not isinstance(s.lvalues[0], (NameExpr, MemberExpr)):
39 return False
40 lvalue = s.lvalues[0]
41 name = lvalue.name
42 enum_call = self.check_enum_call(s.rvalue, name, is_func_scope)
43 if enum_call is None:
44 return False
45 if isinstance(lvalue, MemberExpr):
46 self.fail("Enum type as attribute is not supported", lvalue)
47 return False
48 # Yes, it's a valid Enum definition. Add it to the symbol table.
49 self.api.add_symbol(name, enum_call, s)
50 return True
51
52 def check_enum_call(self,
53 node: Expression,
54 var_name: str,
55 is_func_scope: bool) -> Optional[TypeInfo]:
56 """Check if a call defines an Enum.
57
58 Example:
59
60 A = enum.Enum('A', 'foo bar')
61
62 is equivalent to:
63
64 class A(enum.Enum):
65 foo = 1
66 bar = 2
67 """
68 if not isinstance(node, CallExpr):
69 return None
70 call = node
71 callee = call.callee
72 if not isinstance(callee, RefExpr):
73 return None
74 fullname = callee.fullname
75 if fullname not in ENUM_BASES:
76 return None
77 items, values, ok = self.parse_enum_call_args(call, fullname.split('.')[-1])
78 if not ok:
79 # Error. Construct dummy return value.
80 info = self.build_enum_call_typeinfo(var_name, [], fullname, node.line)
81 else:
82 name = cast(Union[StrExpr, UnicodeExpr], call.args[0]).value
83 if name != var_name or is_func_scope:
84 # Give it a unique name derived from the line number.
85 name += '@' + str(call.line)
86 info = self.build_enum_call_typeinfo(name, items, fullname, call.line)
87 # Store generated TypeInfo under both names, see semanal_namedtuple for more details.
88 if name != var_name or is_func_scope:
89 self.api.add_symbol_skip_local(name, info)
90 call.analyzed = EnumCallExpr(info, items, values)
91 call.analyzed.set_line(call.line, call.column)
92 info.line = node.line
93 return info
94
95 def build_enum_call_typeinfo(self, name: str, items: List[str], fullname: str,
96 line: int) -> TypeInfo:
97 base = self.api.named_type_or_none(fullname)
98 assert base is not None
99 info = self.api.basic_new_typeinfo(name, base, line)
100 info.metaclass_type = info.calculate_metaclass_type()
101 info.is_enum = True
102 for item in items:
103 var = Var(item)
104 var.info = info
105 var.is_property = True
106 var._fullname = '{}.{}'.format(info.fullname, item)
107 info.names[item] = SymbolTableNode(MDEF, var)
108 return info
109
110 def parse_enum_call_args(self, call: CallExpr,
111 class_name: str) -> Tuple[List[str],
112 List[Optional[Expression]], bool]:
113 """Parse arguments of an Enum call.
114
115 Return a tuple of fields, values, was there an error.
116 """
117 args = call.args
118 if not all([arg_kind in [ARG_POS, ARG_NAMED] for arg_kind in call.arg_kinds]):
119 return self.fail_enum_call_arg("Unexpected arguments to %s()" % class_name, call)
120 if len(args) < 2:
121 return self.fail_enum_call_arg("Too few arguments for %s()" % class_name, call)
122 if len(args) > 6:
123 return self.fail_enum_call_arg("Too many arguments for %s()" % class_name, call)
124 valid_name = [None, 'value', 'names', 'module', 'qualname', 'type', 'start']
125 for arg_name in call.arg_names:
126 if arg_name not in valid_name:
127 self.fail_enum_call_arg('Unexpected keyword argument "{}"'.format(arg_name), call)
128 value, names = None, None
129 for arg_name, arg in zip(call.arg_names, args):
130 if arg_name == 'value':
131 value = arg
132 if arg_name == 'names':
133 names = arg
134 if value is None:
135 value = args[0]
136 if names is None:
137 names = args[1]
138 if not isinstance(value, (StrExpr, UnicodeExpr)):
139 return self.fail_enum_call_arg(
140 "%s() expects a string literal as the first argument" % class_name, call)
141 items = []
142 values: List[Optional[Expression]] = []
143 if isinstance(names, (StrExpr, UnicodeExpr)):
144 fields = names.value
145 for field in fields.replace(',', ' ').split():
146 items.append(field)
147 elif isinstance(names, (TupleExpr, ListExpr)):
148 seq_items = names.items
149 if all(isinstance(seq_item, (StrExpr, UnicodeExpr)) for seq_item in seq_items):
150 items = [cast(Union[StrExpr, UnicodeExpr], seq_item).value
151 for seq_item in seq_items]
152 elif all(isinstance(seq_item, (TupleExpr, ListExpr))
153 and len(seq_item.items) == 2
154 and isinstance(seq_item.items[0], (StrExpr, UnicodeExpr))
155 for seq_item in seq_items):
156 for seq_item in seq_items:
157 assert isinstance(seq_item, (TupleExpr, ListExpr))
158 name, value = seq_item.items
159 assert isinstance(name, (StrExpr, UnicodeExpr))
160 items.append(name.value)
161 values.append(value)
162 else:
163 return self.fail_enum_call_arg(
164 "%s() with tuple or list expects strings or (name, value) pairs" %
165 class_name,
166 call)
167 elif isinstance(names, DictExpr):
168 for key, value in names.items:
169 if not isinstance(key, (StrExpr, UnicodeExpr)):
170 return self.fail_enum_call_arg(
171 "%s() with dict literal requires string literals" % class_name, call)
172 items.append(key.value)
173 values.append(value)
174 else:
175 # TODO: Allow dict(x=1, y=2) as a substitute for {'x': 1, 'y': 2}?
176 return self.fail_enum_call_arg(
177 "%s() expects a string, tuple, list or dict literal as the second argument" %
178 class_name,
179 call)
180 if len(items) == 0:
181 return self.fail_enum_call_arg("%s() needs at least one item" % class_name, call)
182 if not values:
183 values = [None] * len(items)
184 assert len(items) == len(values)
185 return items, values, True
186
187 def fail_enum_call_arg(self, message: str,
188 context: Context) -> Tuple[List[str],
189 List[Optional[Expression]], bool]:
190 self.fail(message, context)
191 return [], [], False
192
193 # Helpers
194
195 def fail(self, msg: str, ctx: Context) -> None:
196 self.api.fail(msg, ctx)
197
```
--- 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/mypy/semanal_enum.py b/mypy/semanal_enum.py
--- a/mypy/semanal_enum.py
+++ b/mypy/semanal_enum.py
@@ -21,6 +21,8 @@
))
ENUM_SPECIAL_PROPS: Final = frozenset((
'name', 'value', '_name_', '_value_', '_order_', '__order__',
+ # Also attributes from `object`:
+ '__module__', '__annotations__', '__doc__', '__slots__', '__dict__',
))
| {"golden_diff": "diff --git a/mypy/semanal_enum.py b/mypy/semanal_enum.py\n--- a/mypy/semanal_enum.py\n+++ b/mypy/semanal_enum.py\n@@ -21,6 +21,8 @@\n ))\n ENUM_SPECIAL_PROPS: Final = frozenset((\n 'name', 'value', '_name_', '_value_', '_order_', '__order__',\n+ # Also attributes from `object`:\n+ '__module__', '__annotations__', '__doc__', '__slots__', '__dict__',\n ))\n", "issue": "Regression in mypy 0.930: Cannot override writable attribute \"__module__\" with a final one\n**Bug Report**\r\n\r\nThe following code is reported as error by mypy 0.930 (Python 3.8). It seems correct, and was considered correct so far:\r\n\r\n```python\r\nfrom enum import Enum\r\n\r\nclass PyFormat(str, Enum):\r\n __module__ = \"psycopg.adapt\"\r\n AUTO = \"s\"\r\n TEXT = \"t\"\r\n BINARY = \"b\"\r\n```\r\n\r\nThe error reported is:\r\n```\r\n$ mypy test_mypy.py \r\ntest_mypy.py:4: error: Cannot override writable attribute \"__module__\" with a final one [misc]\r\n```\r\n\r\nwhich I don't even know what means...\n", "before_files": [{"content": "\"\"\"Semantic analysis of call-based Enum definitions.\n\nThis is conceptually part of mypy.semanal (semantic analyzer pass 2).\n\"\"\"\n\nfrom typing import List, Tuple, Optional, Union, cast\nfrom typing_extensions import Final\n\nfrom mypy.nodes import (\n Expression, Context, TypeInfo, AssignmentStmt, NameExpr, CallExpr, RefExpr, StrExpr,\n UnicodeExpr, TupleExpr, ListExpr, DictExpr, Var, SymbolTableNode, MDEF, ARG_POS,\n ARG_NAMED, EnumCallExpr, MemberExpr\n)\nfrom mypy.semanal_shared import SemanticAnalyzerInterface\nfrom mypy.options import Options\n\n# Note: 'enum.EnumMeta' is deliberately excluded from this list. Classes that directly use\n# enum.EnumMeta do not necessarily automatically have the 'name' and 'value' attributes.\nENUM_BASES: Final = frozenset((\n 'enum.Enum', 'enum.IntEnum', 'enum.Flag', 'enum.IntFlag',\n))\nENUM_SPECIAL_PROPS: Final = frozenset((\n 'name', 'value', '_name_', '_value_', '_order_', '__order__',\n))\n\n\nclass EnumCallAnalyzer:\n def __init__(self, options: Options, api: SemanticAnalyzerInterface) -> None:\n self.options = options\n self.api = api\n\n def process_enum_call(self, s: AssignmentStmt, is_func_scope: bool) -> bool:\n \"\"\"Check if s defines an Enum; if yes, store the definition in symbol table.\n\n Return True if this looks like an Enum definition (but maybe with errors),\n otherwise return False.\n \"\"\"\n if len(s.lvalues) != 1 or not isinstance(s.lvalues[0], (NameExpr, MemberExpr)):\n return False\n lvalue = s.lvalues[0]\n name = lvalue.name\n enum_call = self.check_enum_call(s.rvalue, name, is_func_scope)\n if enum_call is None:\n return False\n if isinstance(lvalue, MemberExpr):\n self.fail(\"Enum type as attribute is not supported\", lvalue)\n return False\n # Yes, it's a valid Enum definition. Add it to the symbol table.\n self.api.add_symbol(name, enum_call, s)\n return True\n\n def check_enum_call(self,\n node: Expression,\n var_name: str,\n is_func_scope: bool) -> Optional[TypeInfo]:\n \"\"\"Check if a call defines an Enum.\n\n Example:\n\n A = enum.Enum('A', 'foo bar')\n\n is equivalent to:\n\n class A(enum.Enum):\n foo = 1\n bar = 2\n \"\"\"\n if not isinstance(node, CallExpr):\n return None\n call = node\n callee = call.callee\n if not isinstance(callee, RefExpr):\n return None\n fullname = callee.fullname\n if fullname not in ENUM_BASES:\n return None\n items, values, ok = self.parse_enum_call_args(call, fullname.split('.')[-1])\n if not ok:\n # Error. Construct dummy return value.\n info = self.build_enum_call_typeinfo(var_name, [], fullname, node.line)\n else:\n name = cast(Union[StrExpr, UnicodeExpr], call.args[0]).value\n if name != var_name or is_func_scope:\n # Give it a unique name derived from the line number.\n name += '@' + str(call.line)\n info = self.build_enum_call_typeinfo(name, items, fullname, call.line)\n # Store generated TypeInfo under both names, see semanal_namedtuple for more details.\n if name != var_name or is_func_scope:\n self.api.add_symbol_skip_local(name, info)\n call.analyzed = EnumCallExpr(info, items, values)\n call.analyzed.set_line(call.line, call.column)\n info.line = node.line\n return info\n\n def build_enum_call_typeinfo(self, name: str, items: List[str], fullname: str,\n line: int) -> TypeInfo:\n base = self.api.named_type_or_none(fullname)\n assert base is not None\n info = self.api.basic_new_typeinfo(name, base, line)\n info.metaclass_type = info.calculate_metaclass_type()\n info.is_enum = True\n for item in items:\n var = Var(item)\n var.info = info\n var.is_property = True\n var._fullname = '{}.{}'.format(info.fullname, item)\n info.names[item] = SymbolTableNode(MDEF, var)\n return info\n\n def parse_enum_call_args(self, call: CallExpr,\n class_name: str) -> Tuple[List[str],\n List[Optional[Expression]], bool]:\n \"\"\"Parse arguments of an Enum call.\n\n Return a tuple of fields, values, was there an error.\n \"\"\"\n args = call.args\n if not all([arg_kind in [ARG_POS, ARG_NAMED] for arg_kind in call.arg_kinds]):\n return self.fail_enum_call_arg(\"Unexpected arguments to %s()\" % class_name, call)\n if len(args) < 2:\n return self.fail_enum_call_arg(\"Too few arguments for %s()\" % class_name, call)\n if len(args) > 6:\n return self.fail_enum_call_arg(\"Too many arguments for %s()\" % class_name, call)\n valid_name = [None, 'value', 'names', 'module', 'qualname', 'type', 'start']\n for arg_name in call.arg_names:\n if arg_name not in valid_name:\n self.fail_enum_call_arg('Unexpected keyword argument \"{}\"'.format(arg_name), call)\n value, names = None, None\n for arg_name, arg in zip(call.arg_names, args):\n if arg_name == 'value':\n value = arg\n if arg_name == 'names':\n names = arg\n if value is None:\n value = args[0]\n if names is None:\n names = args[1]\n if not isinstance(value, (StrExpr, UnicodeExpr)):\n return self.fail_enum_call_arg(\n \"%s() expects a string literal as the first argument\" % class_name, call)\n items = []\n values: List[Optional[Expression]] = []\n if isinstance(names, (StrExpr, UnicodeExpr)):\n fields = names.value\n for field in fields.replace(',', ' ').split():\n items.append(field)\n elif isinstance(names, (TupleExpr, ListExpr)):\n seq_items = names.items\n if all(isinstance(seq_item, (StrExpr, UnicodeExpr)) for seq_item in seq_items):\n items = [cast(Union[StrExpr, UnicodeExpr], seq_item).value\n for seq_item in seq_items]\n elif all(isinstance(seq_item, (TupleExpr, ListExpr))\n and len(seq_item.items) == 2\n and isinstance(seq_item.items[0], (StrExpr, UnicodeExpr))\n for seq_item in seq_items):\n for seq_item in seq_items:\n assert isinstance(seq_item, (TupleExpr, ListExpr))\n name, value = seq_item.items\n assert isinstance(name, (StrExpr, UnicodeExpr))\n items.append(name.value)\n values.append(value)\n else:\n return self.fail_enum_call_arg(\n \"%s() with tuple or list expects strings or (name, value) pairs\" %\n class_name,\n call)\n elif isinstance(names, DictExpr):\n for key, value in names.items:\n if not isinstance(key, (StrExpr, UnicodeExpr)):\n return self.fail_enum_call_arg(\n \"%s() with dict literal requires string literals\" % class_name, call)\n items.append(key.value)\n values.append(value)\n else:\n # TODO: Allow dict(x=1, y=2) as a substitute for {'x': 1, 'y': 2}?\n return self.fail_enum_call_arg(\n \"%s() expects a string, tuple, list or dict literal as the second argument\" %\n class_name,\n call)\n if len(items) == 0:\n return self.fail_enum_call_arg(\"%s() needs at least one item\" % class_name, call)\n if not values:\n values = [None] * len(items)\n assert len(items) == len(values)\n return items, values, True\n\n def fail_enum_call_arg(self, message: str,\n context: Context) -> Tuple[List[str],\n List[Optional[Expression]], bool]:\n self.fail(message, context)\n return [], [], False\n\n # Helpers\n\n def fail(self, msg: str, ctx: Context) -> None:\n self.api.fail(msg, ctx)\n", "path": "mypy/semanal_enum.py"}], "after_files": [{"content": "\"\"\"Semantic analysis of call-based Enum definitions.\n\nThis is conceptually part of mypy.semanal (semantic analyzer pass 2).\n\"\"\"\n\nfrom typing import List, Tuple, Optional, Union, cast\nfrom typing_extensions import Final\n\nfrom mypy.nodes import (\n Expression, Context, TypeInfo, AssignmentStmt, NameExpr, CallExpr, RefExpr, StrExpr,\n UnicodeExpr, TupleExpr, ListExpr, DictExpr, Var, SymbolTableNode, MDEF, ARG_POS,\n ARG_NAMED, EnumCallExpr, MemberExpr\n)\nfrom mypy.semanal_shared import SemanticAnalyzerInterface\nfrom mypy.options import Options\n\n# Note: 'enum.EnumMeta' is deliberately excluded from this list. Classes that directly use\n# enum.EnumMeta do not necessarily automatically have the 'name' and 'value' attributes.\nENUM_BASES: Final = frozenset((\n 'enum.Enum', 'enum.IntEnum', 'enum.Flag', 'enum.IntFlag',\n))\nENUM_SPECIAL_PROPS: Final = frozenset((\n 'name', 'value', '_name_', '_value_', '_order_', '__order__',\n # Also attributes from `object`:\n '__module__', '__annotations__', '__doc__', '__slots__', '__dict__',\n))\n\n\nclass EnumCallAnalyzer:\n def __init__(self, options: Options, api: SemanticAnalyzerInterface) -> None:\n self.options = options\n self.api = api\n\n def process_enum_call(self, s: AssignmentStmt, is_func_scope: bool) -> bool:\n \"\"\"Check if s defines an Enum; if yes, store the definition in symbol table.\n\n Return True if this looks like an Enum definition (but maybe with errors),\n otherwise return False.\n \"\"\"\n if len(s.lvalues) != 1 or not isinstance(s.lvalues[0], (NameExpr, MemberExpr)):\n return False\n lvalue = s.lvalues[0]\n name = lvalue.name\n enum_call = self.check_enum_call(s.rvalue, name, is_func_scope)\n if enum_call is None:\n return False\n if isinstance(lvalue, MemberExpr):\n self.fail(\"Enum type as attribute is not supported\", lvalue)\n return False\n # Yes, it's a valid Enum definition. Add it to the symbol table.\n self.api.add_symbol(name, enum_call, s)\n return True\n\n def check_enum_call(self,\n node: Expression,\n var_name: str,\n is_func_scope: bool) -> Optional[TypeInfo]:\n \"\"\"Check if a call defines an Enum.\n\n Example:\n\n A = enum.Enum('A', 'foo bar')\n\n is equivalent to:\n\n class A(enum.Enum):\n foo = 1\n bar = 2\n \"\"\"\n if not isinstance(node, CallExpr):\n return None\n call = node\n callee = call.callee\n if not isinstance(callee, RefExpr):\n return None\n fullname = callee.fullname\n if fullname not in ENUM_BASES:\n return None\n items, values, ok = self.parse_enum_call_args(call, fullname.split('.')[-1])\n if not ok:\n # Error. Construct dummy return value.\n info = self.build_enum_call_typeinfo(var_name, [], fullname, node.line)\n else:\n name = cast(Union[StrExpr, UnicodeExpr], call.args[0]).value\n if name != var_name or is_func_scope:\n # Give it a unique name derived from the line number.\n name += '@' + str(call.line)\n info = self.build_enum_call_typeinfo(name, items, fullname, call.line)\n # Store generated TypeInfo under both names, see semanal_namedtuple for more details.\n if name != var_name or is_func_scope:\n self.api.add_symbol_skip_local(name, info)\n call.analyzed = EnumCallExpr(info, items, values)\n call.analyzed.set_line(call.line, call.column)\n info.line = node.line\n return info\n\n def build_enum_call_typeinfo(self, name: str, items: List[str], fullname: str,\n line: int) -> TypeInfo:\n base = self.api.named_type_or_none(fullname)\n assert base is not None\n info = self.api.basic_new_typeinfo(name, base, line)\n info.metaclass_type = info.calculate_metaclass_type()\n info.is_enum = True\n for item in items:\n var = Var(item)\n var.info = info\n var.is_property = True\n var._fullname = '{}.{}'.format(info.fullname, item)\n info.names[item] = SymbolTableNode(MDEF, var)\n return info\n\n def parse_enum_call_args(self, call: CallExpr,\n class_name: str) -> Tuple[List[str],\n List[Optional[Expression]], bool]:\n \"\"\"Parse arguments of an Enum call.\n\n Return a tuple of fields, values, was there an error.\n \"\"\"\n args = call.args\n if not all([arg_kind in [ARG_POS, ARG_NAMED] for arg_kind in call.arg_kinds]):\n return self.fail_enum_call_arg(\"Unexpected arguments to %s()\" % class_name, call)\n if len(args) < 2:\n return self.fail_enum_call_arg(\"Too few arguments for %s()\" % class_name, call)\n if len(args) > 6:\n return self.fail_enum_call_arg(\"Too many arguments for %s()\" % class_name, call)\n valid_name = [None, 'value', 'names', 'module', 'qualname', 'type', 'start']\n for arg_name in call.arg_names:\n if arg_name not in valid_name:\n self.fail_enum_call_arg('Unexpected keyword argument \"{}\"'.format(arg_name), call)\n value, names = None, None\n for arg_name, arg in zip(call.arg_names, args):\n if arg_name == 'value':\n value = arg\n if arg_name == 'names':\n names = arg\n if value is None:\n value = args[0]\n if names is None:\n names = args[1]\n if not isinstance(value, (StrExpr, UnicodeExpr)):\n return self.fail_enum_call_arg(\n \"%s() expects a string literal as the first argument\" % class_name, call)\n items = []\n values: List[Optional[Expression]] = []\n if isinstance(names, (StrExpr, UnicodeExpr)):\n fields = names.value\n for field in fields.replace(',', ' ').split():\n items.append(field)\n elif isinstance(names, (TupleExpr, ListExpr)):\n seq_items = names.items\n if all(isinstance(seq_item, (StrExpr, UnicodeExpr)) for seq_item in seq_items):\n items = [cast(Union[StrExpr, UnicodeExpr], seq_item).value\n for seq_item in seq_items]\n elif all(isinstance(seq_item, (TupleExpr, ListExpr))\n and len(seq_item.items) == 2\n and isinstance(seq_item.items[0], (StrExpr, UnicodeExpr))\n for seq_item in seq_items):\n for seq_item in seq_items:\n assert isinstance(seq_item, (TupleExpr, ListExpr))\n name, value = seq_item.items\n assert isinstance(name, (StrExpr, UnicodeExpr))\n items.append(name.value)\n values.append(value)\n else:\n return self.fail_enum_call_arg(\n \"%s() with tuple or list expects strings or (name, value) pairs\" %\n class_name,\n call)\n elif isinstance(names, DictExpr):\n for key, value in names.items:\n if not isinstance(key, (StrExpr, UnicodeExpr)):\n return self.fail_enum_call_arg(\n \"%s() with dict literal requires string literals\" % class_name, call)\n items.append(key.value)\n values.append(value)\n else:\n # TODO: Allow dict(x=1, y=2) as a substitute for {'x': 1, 'y': 2}?\n return self.fail_enum_call_arg(\n \"%s() expects a string, tuple, list or dict literal as the second argument\" %\n class_name,\n call)\n if len(items) == 0:\n return self.fail_enum_call_arg(\"%s() needs at least one item\" % class_name, call)\n if not values:\n values = [None] * len(items)\n assert len(items) == len(values)\n return items, values, True\n\n def fail_enum_call_arg(self, message: str,\n context: Context) -> Tuple[List[str],\n List[Optional[Expression]], bool]:\n self.fail(message, context)\n return [], [], False\n\n # Helpers\n\n def fail(self, msg: str, ctx: Context) -> None:\n self.api.fail(msg, ctx)\n", "path": "mypy/semanal_enum.py"}]} |
gh_patches_debug_283 | rasdani/github-patches | git_diff | psf__black-3276 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Bump pypa/cibuildwheel from 2.8.1 to 2.9.0
Bumps [pypa/cibuildwheel](https://github.com/pypa/cibuildwheel) from 2.8.1 to 2.9.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a href="https://github.com/pypa/cibuildwheel/releases">pypa/cibuildwheel's releases</a>.</em></p>
<blockquote>
<h2>v2.9.0</h2>
<ul>
<li>🌟 CPython 3.11 wheels are now built by default - without the CIBW_PRERELEASE_PYTHONS flag. It's time to build and upload these wheels to PyPI! This release includes CPython 3.11.0rc1, which is guaranteed to be ABI compatible with the final release. (<a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1226">#1226</a>)</li>
<li>⚠️ Removed support for running cibuildwheel in Python 3.6. Python 3.6 is EOL. However, cibuildwheel continues to build CPython 3.6 wheels for the moment. (<a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1175">#1175</a>)</li>
<li>✨ Improved error messages when misspelling TOML options, suggesting close matches (<a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1205">#1205</a>)</li>
<li>🛠 When running on Apple Silicon (so far, an unsupported mode of operation), cibuildwheel no longer builds universal2 wheels by default - just arm64. See <a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1204">#1204</a> for discussion. We hope to release official support for native builds on Apple Silicon soon! (<a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1217">#1217</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a href="https://github.com/pypa/cibuildwheel/blob/main/docs/changelog.md">pypa/cibuildwheel's changelog</a>.</em></p>
<blockquote>
<h3>v2.9.0</h3>
<p><em>11 August 2022</em></p>
<ul>
<li>🌟 CPython 3.11 wheels are now built by default - without the CIBW_PRERELEASE_PYTHONS flag. It's time to build and upload these wheels to PyPI! This release includes CPython 3.11.0rc1, which is guaranteed to be ABI compatible with the final release. (<a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1226">#1226</a>)</li>
<li>⚠️ Removed support for running cibuildwheel in Python 3.6. Python 3.6 is EOL. However, cibuildwheel continues to build CPython 3.6 wheels for the moment. (<a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1175">#1175</a>)</li>
<li>✨ Improved error messages when misspelling TOML options, suggesting close matches (<a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1205">#1205</a>)</li>
<li>🛠 When running on Apple Silicon (so far, an unsupported mode of operation), cibuildwheel no longer builds universal2 wheels by default - just arm64. See <a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1204">#1204</a> for discussion. We hope to release official support for native builds on Apple Silicon soon! (<a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1217">#1217</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/pypa/cibuildwheel/commit/0abd6c205d5baf3066155b5bf85219147d770c61"><code>0abd6c2</code></a> Bump version: v2.9.0</li>
<li><a href="https://github.com/pypa/cibuildwheel/commit/71cebdaca4706e16ba3c44f1325acd6e98b51897"><code>71cebda</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1219">#1219</a> from pypa/disable-pytest-azurepipelines-plugin</li>
<li><a href="https://github.com/pypa/cibuildwheel/commit/5b0d8e7d485738a82e054f8ee888f9038b5919f8"><code>5b0d8e7</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1220">#1220</a> from pypa/henryiii/ci/noxaction</li>
<li><a href="https://github.com/pypa/cibuildwheel/commit/bed97dbe5f730ad9e7cd47d371842f27569c5ff9"><code>bed97db</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1224">#1224</a> from kemingy/add_example_proj</li>
<li><a href="https://github.com/pypa/cibuildwheel/commit/72e1fec0a4cfd88efee77efc56f27990ca719d62"><code>72e1fec</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1226">#1226</a> from minrk/unprerelease-311</li>
<li><a href="https://github.com/pypa/cibuildwheel/commit/046df7d44eb7e897420d87292b306180526b40b4"><code>046df7d</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1223">#1223</a> from pypa/update-dependencies-pr</li>
<li><a href="https://github.com/pypa/cibuildwheel/commit/2d155c01b574ce6903a7d76d22e8f2b0fd24ec22"><code>2d155c0</code></a> Build cp311 without setting prerelease_pythons</li>
<li><a href="https://github.com/pypa/cibuildwheel/commit/30bfc7b2b2253ed668afb3bc77e7820e7588c27f"><code>30bfc7b</code></a> chore: add two ML example projects</li>
<li><a href="https://github.com/pypa/cibuildwheel/commit/e2c0d6831d53fffca56770a0f7db9fa9480f8448"><code>e2c0d68</code></a> Update dependencies</li>
<li><a href="https://github.com/pypa/cibuildwheel/commit/6549a90991c8d1fe135402fede048bc9d9572e54"><code>6549a90</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1217">#1217</a> from mayeut/no-universal2</li>
<li>Additional commits viewable in <a href="https://github.com/pypa/cibuildwheel/compare/v2.8.1...v2.9.0">compare view</a></li>
</ul>
</details>
<br />
[](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
<details>
<summary>Dependabot commands and options</summary>
<br />
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
</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: `src/black/files.py`
Content:
```
1 import io
2 import os
3 import sys
4 from functools import lru_cache
5 from pathlib import Path
6 from typing import (
7 TYPE_CHECKING,
8 Any,
9 Dict,
10 Iterable,
11 Iterator,
12 List,
13 Optional,
14 Pattern,
15 Sequence,
16 Tuple,
17 Union,
18 )
19
20 from mypy_extensions import mypyc_attr
21 from pathspec import PathSpec
22 from pathspec.patterns.gitwildmatch import GitWildMatchPatternError
23
24 if sys.version_info >= (3, 11):
25 try:
26 import tomllib
27 except ImportError:
28 # Help users on older alphas
29 import tomli as tomllib
30 else:
31 import tomli as tomllib
32
33 from black.handle_ipynb_magics import jupyter_dependencies_are_installed
34 from black.output import err
35 from black.report import Report
36
37 if TYPE_CHECKING:
38 import colorama # noqa: F401
39
40
41 @lru_cache()
42 def find_project_root(
43 srcs: Sequence[str], stdin_filename: Optional[str] = None
44 ) -> Tuple[Path, str]:
45 """Return a directory containing .git, .hg, or pyproject.toml.
46
47 That directory will be a common parent of all files and directories
48 passed in `srcs`.
49
50 If no directory in the tree contains a marker that would specify it's the
51 project root, the root of the file system is returned.
52
53 Returns a two-tuple with the first element as the project root path and
54 the second element as a string describing the method by which the
55 project root was discovered.
56 """
57 if stdin_filename is not None:
58 srcs = tuple(stdin_filename if s == "-" else s for s in srcs)
59 if not srcs:
60 srcs = [str(Path.cwd().resolve())]
61
62 path_srcs = [Path(Path.cwd(), src).resolve() for src in srcs]
63
64 # A list of lists of parents for each 'src'. 'src' is included as a
65 # "parent" of itself if it is a directory
66 src_parents = [
67 list(path.parents) + ([path] if path.is_dir() else []) for path in path_srcs
68 ]
69
70 common_base = max(
71 set.intersection(*(set(parents) for parents in src_parents)),
72 key=lambda path: path.parts,
73 )
74
75 for directory in (common_base, *common_base.parents):
76 if (directory / ".git").exists():
77 return directory, ".git directory"
78
79 if (directory / ".hg").is_dir():
80 return directory, ".hg directory"
81
82 if (directory / "pyproject.toml").is_file():
83 return directory, "pyproject.toml"
84
85 return directory, "file system root"
86
87
88 def find_pyproject_toml(path_search_start: Tuple[str, ...]) -> Optional[str]:
89 """Find the absolute filepath to a pyproject.toml if it exists"""
90 path_project_root, _ = find_project_root(path_search_start)
91 path_pyproject_toml = path_project_root / "pyproject.toml"
92 if path_pyproject_toml.is_file():
93 return str(path_pyproject_toml)
94
95 try:
96 path_user_pyproject_toml = find_user_pyproject_toml()
97 return (
98 str(path_user_pyproject_toml)
99 if path_user_pyproject_toml.is_file()
100 else None
101 )
102 except (PermissionError, RuntimeError) as e:
103 # We do not have access to the user-level config directory, so ignore it.
104 err(f"Ignoring user configuration directory due to {e!r}")
105 return None
106
107
108 @mypyc_attr(patchable=True)
109 def parse_pyproject_toml(path_config: str) -> Dict[str, Any]:
110 """Parse a pyproject toml file, pulling out relevant parts for Black
111
112 If parsing fails, will raise a tomllib.TOMLDecodeError
113 """
114 with open(path_config, "rb") as f:
115 pyproject_toml = tomllib.load(f)
116 config = pyproject_toml.get("tool", {}).get("black", {})
117 return {k.replace("--", "").replace("-", "_"): v for k, v in config.items()}
118
119
120 @lru_cache()
121 def find_user_pyproject_toml() -> Path:
122 r"""Return the path to the top-level user configuration for black.
123
124 This looks for ~\.black on Windows and ~/.config/black on Linux and other
125 Unix systems.
126
127 May raise:
128 - RuntimeError: if the current user has no homedir
129 - PermissionError: if the current process cannot access the user's homedir
130 """
131 if sys.platform == "win32":
132 # Windows
133 user_config_path = Path.home() / ".black"
134 else:
135 config_root = os.environ.get("XDG_CONFIG_HOME", "~/.config")
136 user_config_path = Path(config_root).expanduser() / "black"
137 return user_config_path.resolve()
138
139
140 @lru_cache()
141 def get_gitignore(root: Path) -> PathSpec:
142 """Return a PathSpec matching gitignore content if present."""
143 gitignore = root / ".gitignore"
144 lines: List[str] = []
145 if gitignore.is_file():
146 with gitignore.open(encoding="utf-8") as gf:
147 lines = gf.readlines()
148 try:
149 return PathSpec.from_lines("gitwildmatch", lines)
150 except GitWildMatchPatternError as e:
151 err(f"Could not parse {gitignore}: {e}")
152 raise
153
154
155 def normalize_path_maybe_ignore(
156 path: Path,
157 root: Path,
158 report: Optional[Report] = None,
159 ) -> Optional[str]:
160 """Normalize `path`. May return `None` if `path` was ignored.
161
162 `report` is where "path ignored" output goes.
163 """
164 try:
165 abspath = path if path.is_absolute() else Path.cwd() / path
166 normalized_path = abspath.resolve()
167 try:
168 root_relative_path = normalized_path.relative_to(root).as_posix()
169 except ValueError:
170 if report:
171 report.path_ignored(
172 path, f"is a symbolic link that points outside {root}"
173 )
174 return None
175
176 except OSError as e:
177 if report:
178 report.path_ignored(path, f"cannot be read because {e}")
179 return None
180
181 return root_relative_path
182
183
184 def path_is_excluded(
185 normalized_path: str,
186 pattern: Optional[Pattern[str]],
187 ) -> bool:
188 match = pattern.search(normalized_path) if pattern else None
189 return bool(match and match.group(0))
190
191
192 def gen_python_files(
193 paths: Iterable[Path],
194 root: Path,
195 include: Pattern[str],
196 exclude: Pattern[str],
197 extend_exclude: Optional[Pattern[str]],
198 force_exclude: Optional[Pattern[str]],
199 report: Report,
200 gitignore: Optional[PathSpec],
201 *,
202 verbose: bool,
203 quiet: bool,
204 ) -> Iterator[Path]:
205 """Generate all files under `path` whose paths are not excluded by the
206 `exclude_regex`, `extend_exclude`, or `force_exclude` regexes,
207 but are included by the `include` regex.
208
209 Symbolic links pointing outside of the `root` directory are ignored.
210
211 `report` is where output about exclusions goes.
212 """
213 assert root.is_absolute(), f"INTERNAL ERROR: `root` must be absolute but is {root}"
214 for child in paths:
215 normalized_path = normalize_path_maybe_ignore(child, root, report)
216 if normalized_path is None:
217 continue
218
219 # First ignore files matching .gitignore, if passed
220 if gitignore is not None and gitignore.match_file(normalized_path):
221 report.path_ignored(child, "matches the .gitignore file content")
222 continue
223
224 # Then ignore with `--exclude` `--extend-exclude` and `--force-exclude` options.
225 normalized_path = "/" + normalized_path
226 if child.is_dir():
227 normalized_path += "/"
228
229 if path_is_excluded(normalized_path, exclude):
230 report.path_ignored(child, "matches the --exclude regular expression")
231 continue
232
233 if path_is_excluded(normalized_path, extend_exclude):
234 report.path_ignored(
235 child, "matches the --extend-exclude regular expression"
236 )
237 continue
238
239 if path_is_excluded(normalized_path, force_exclude):
240 report.path_ignored(child, "matches the --force-exclude regular expression")
241 continue
242
243 if child.is_dir():
244 # If gitignore is None, gitignore usage is disabled, while a Falsey
245 # gitignore is when the directory doesn't have a .gitignore file.
246 yield from gen_python_files(
247 child.iterdir(),
248 root,
249 include,
250 exclude,
251 extend_exclude,
252 force_exclude,
253 report,
254 gitignore + get_gitignore(child) if gitignore is not None else None,
255 verbose=verbose,
256 quiet=quiet,
257 )
258
259 elif child.is_file():
260 if child.suffix == ".ipynb" and not jupyter_dependencies_are_installed(
261 verbose=verbose, quiet=quiet
262 ):
263 continue
264 include_match = include.search(normalized_path) if include else True
265 if include_match:
266 yield child
267
268
269 def wrap_stream_for_windows(
270 f: io.TextIOWrapper,
271 ) -> Union[io.TextIOWrapper, "colorama.AnsiToWin32"]:
272 """
273 Wrap stream with colorama's wrap_stream so colors are shown on Windows.
274
275 If `colorama` is unavailable, the original stream is returned unmodified.
276 Otherwise, the `wrap_stream()` function determines whether the stream needs
277 to be wrapped for a Windows environment and will accordingly either return
278 an `AnsiToWin32` wrapper or the original stream.
279 """
280 try:
281 from colorama.initialise import wrap_stream
282 except ImportError:
283 return f
284 else:
285 # Set `strip=False` to avoid needing to modify test_express_diff_with_color.
286 return wrap_stream(f, convert=None, strip=False, autoreset=False, wrap=True)
287
```
--- 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/black/files.py b/src/black/files.py
--- a/src/black/files.py
+++ b/src/black/files.py
@@ -26,7 +26,8 @@
import tomllib
except ImportError:
# Help users on older alphas
- import tomli as tomllib
+ if not TYPE_CHECKING:
+ import tomli as tomllib
else:
import tomli as tomllib
| {"golden_diff": "diff --git a/src/black/files.py b/src/black/files.py\n--- a/src/black/files.py\n+++ b/src/black/files.py\n@@ -26,7 +26,8 @@\n import tomllib\n except ImportError:\n # Help users on older alphas\n- import tomli as tomllib\n+ if not TYPE_CHECKING:\n+ import tomli as tomllib\n else:\n import tomli as tomllib\n", "issue": "Bump pypa/cibuildwheel from 2.8.1 to 2.9.0\nBumps [pypa/cibuildwheel](https://github.com/pypa/cibuildwheel) from 2.8.1 to 2.9.0.\n<details>\n<summary>Release notes</summary>\n<p><em>Sourced from <a href=\"https://github.com/pypa/cibuildwheel/releases\">pypa/cibuildwheel's releases</a>.</em></p>\n<blockquote>\n<h2>v2.9.0</h2>\n<ul>\n<li>\ud83c\udf1f CPython 3.11 wheels are now built by default - without the CIBW_PRERELEASE_PYTHONS flag. It's time to build and upload these wheels to PyPI! This release includes CPython 3.11.0rc1, which is guaranteed to be ABI compatible with the final release. (<a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1226\">#1226</a>)</li>\n<li>\u26a0\ufe0f Removed support for running cibuildwheel in Python 3.6. Python 3.6 is EOL. However, cibuildwheel continues to build CPython 3.6 wheels for the moment. (<a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1175\">#1175</a>)</li>\n<li>\u2728 Improved error messages when misspelling TOML options, suggesting close matches (<a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1205\">#1205</a>)</li>\n<li>\ud83d\udee0 When running on Apple Silicon (so far, an unsupported mode of operation), cibuildwheel no longer builds universal2 wheels by default - just arm64. See <a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1204\">#1204</a> for discussion. We hope to release official support for native builds on Apple Silicon soon! (<a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1217\">#1217</a>)</li>\n</ul>\n</blockquote>\n</details>\n<details>\n<summary>Changelog</summary>\n<p><em>Sourced from <a href=\"https://github.com/pypa/cibuildwheel/blob/main/docs/changelog.md\">pypa/cibuildwheel's changelog</a>.</em></p>\n<blockquote>\n<h3>v2.9.0</h3>\n<p><em>11 August 2022</em></p>\n<ul>\n<li>\ud83c\udf1f CPython 3.11 wheels are now built by default - without the CIBW_PRERELEASE_PYTHONS flag. It's time to build and upload these wheels to PyPI! This release includes CPython 3.11.0rc1, which is guaranteed to be ABI compatible with the final release. (<a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1226\">#1226</a>)</li>\n<li>\u26a0\ufe0f Removed support for running cibuildwheel in Python 3.6. Python 3.6 is EOL. However, cibuildwheel continues to build CPython 3.6 wheels for the moment. (<a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1175\">#1175</a>)</li>\n<li>\u2728 Improved error messages when misspelling TOML options, suggesting close matches (<a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1205\">#1205</a>)</li>\n<li>\ud83d\udee0 When running on Apple Silicon (so far, an unsupported mode of operation), cibuildwheel no longer builds universal2 wheels by default - just arm64. See <a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1204\">#1204</a> for discussion. We hope to release official support for native builds on Apple Silicon soon! (<a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1217\">#1217</a>)</li>\n</ul>\n</blockquote>\n</details>\n<details>\n<summary>Commits</summary>\n<ul>\n<li><a href=\"https://github.com/pypa/cibuildwheel/commit/0abd6c205d5baf3066155b5bf85219147d770c61\"><code>0abd6c2</code></a> Bump version: v2.9.0</li>\n<li><a href=\"https://github.com/pypa/cibuildwheel/commit/71cebdaca4706e16ba3c44f1325acd6e98b51897\"><code>71cebda</code></a> Merge pull request <a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1219\">#1219</a> from pypa/disable-pytest-azurepipelines-plugin</li>\n<li><a href=\"https://github.com/pypa/cibuildwheel/commit/5b0d8e7d485738a82e054f8ee888f9038b5919f8\"><code>5b0d8e7</code></a> Merge pull request <a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1220\">#1220</a> from pypa/henryiii/ci/noxaction</li>\n<li><a href=\"https://github.com/pypa/cibuildwheel/commit/bed97dbe5f730ad9e7cd47d371842f27569c5ff9\"><code>bed97db</code></a> Merge pull request <a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1224\">#1224</a> from kemingy/add_example_proj</li>\n<li><a href=\"https://github.com/pypa/cibuildwheel/commit/72e1fec0a4cfd88efee77efc56f27990ca719d62\"><code>72e1fec</code></a> Merge pull request <a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1226\">#1226</a> from minrk/unprerelease-311</li>\n<li><a href=\"https://github.com/pypa/cibuildwheel/commit/046df7d44eb7e897420d87292b306180526b40b4\"><code>046df7d</code></a> Merge pull request <a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1223\">#1223</a> from pypa/update-dependencies-pr</li>\n<li><a href=\"https://github.com/pypa/cibuildwheel/commit/2d155c01b574ce6903a7d76d22e8f2b0fd24ec22\"><code>2d155c0</code></a> Build cp311 without setting prerelease_pythons</li>\n<li><a href=\"https://github.com/pypa/cibuildwheel/commit/30bfc7b2b2253ed668afb3bc77e7820e7588c27f\"><code>30bfc7b</code></a> chore: add two ML example projects</li>\n<li><a href=\"https://github.com/pypa/cibuildwheel/commit/e2c0d6831d53fffca56770a0f7db9fa9480f8448\"><code>e2c0d68</code></a> Update dependencies</li>\n<li><a href=\"https://github.com/pypa/cibuildwheel/commit/6549a90991c8d1fe135402fede048bc9d9572e54\"><code>6549a90</code></a> Merge pull request <a href=\"https://github-redirect.dependabot.com/pypa/cibuildwheel/issues/1217\">#1217</a> from mayeut/no-universal2</li>\n<li>Additional commits viewable in <a href=\"https://github.com/pypa/cibuildwheel/compare/v2.8.1...v2.9.0\">compare view</a></li>\n</ul>\n</details>\n<br />\n\n\n[](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)\n\nDependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.\n\n[//]: # (dependabot-automerge-start)\n[//]: # (dependabot-automerge-end)\n\n---\n\n<details>\n<summary>Dependabot commands and options</summary>\n<br />\n\nYou can trigger Dependabot actions by commenting on this PR:\n- `@dependabot rebase` will rebase this PR\n- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it\n- `@dependabot merge` will merge this PR after your CI passes on it\n- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it\n- `@dependabot cancel merge` will cancel a previously requested merge and block automerging\n- `@dependabot reopen` will reopen this PR if it is closed\n- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually\n- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)\n- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)\n- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)\n\n\n</details>\n", "before_files": [{"content": "import io\nimport os\nimport sys\nfrom functools import lru_cache\nfrom pathlib import Path\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n Iterable,\n Iterator,\n List,\n Optional,\n Pattern,\n Sequence,\n Tuple,\n Union,\n)\n\nfrom mypy_extensions import mypyc_attr\nfrom pathspec import PathSpec\nfrom pathspec.patterns.gitwildmatch import GitWildMatchPatternError\n\nif sys.version_info >= (3, 11):\n try:\n import tomllib\n except ImportError:\n # Help users on older alphas\n import tomli as tomllib\nelse:\n import tomli as tomllib\n\nfrom black.handle_ipynb_magics import jupyter_dependencies_are_installed\nfrom black.output import err\nfrom black.report import Report\n\nif TYPE_CHECKING:\n import colorama # noqa: F401\n\n\n@lru_cache()\ndef find_project_root(\n srcs: Sequence[str], stdin_filename: Optional[str] = None\n) -> Tuple[Path, str]:\n \"\"\"Return a directory containing .git, .hg, or pyproject.toml.\n\n That directory will be a common parent of all files and directories\n passed in `srcs`.\n\n If no directory in the tree contains a marker that would specify it's the\n project root, the root of the file system is returned.\n\n Returns a two-tuple with the first element as the project root path and\n the second element as a string describing the method by which the\n project root was discovered.\n \"\"\"\n if stdin_filename is not None:\n srcs = tuple(stdin_filename if s == \"-\" else s for s in srcs)\n if not srcs:\n srcs = [str(Path.cwd().resolve())]\n\n path_srcs = [Path(Path.cwd(), src).resolve() for src in srcs]\n\n # A list of lists of parents for each 'src'. 'src' is included as a\n # \"parent\" of itself if it is a directory\n src_parents = [\n list(path.parents) + ([path] if path.is_dir() else []) for path in path_srcs\n ]\n\n common_base = max(\n set.intersection(*(set(parents) for parents in src_parents)),\n key=lambda path: path.parts,\n )\n\n for directory in (common_base, *common_base.parents):\n if (directory / \".git\").exists():\n return directory, \".git directory\"\n\n if (directory / \".hg\").is_dir():\n return directory, \".hg directory\"\n\n if (directory / \"pyproject.toml\").is_file():\n return directory, \"pyproject.toml\"\n\n return directory, \"file system root\"\n\n\ndef find_pyproject_toml(path_search_start: Tuple[str, ...]) -> Optional[str]:\n \"\"\"Find the absolute filepath to a pyproject.toml if it exists\"\"\"\n path_project_root, _ = find_project_root(path_search_start)\n path_pyproject_toml = path_project_root / \"pyproject.toml\"\n if path_pyproject_toml.is_file():\n return str(path_pyproject_toml)\n\n try:\n path_user_pyproject_toml = find_user_pyproject_toml()\n return (\n str(path_user_pyproject_toml)\n if path_user_pyproject_toml.is_file()\n else None\n )\n except (PermissionError, RuntimeError) as e:\n # We do not have access to the user-level config directory, so ignore it.\n err(f\"Ignoring user configuration directory due to {e!r}\")\n return None\n\n\n@mypyc_attr(patchable=True)\ndef parse_pyproject_toml(path_config: str) -> Dict[str, Any]:\n \"\"\"Parse a pyproject toml file, pulling out relevant parts for Black\n\n If parsing fails, will raise a tomllib.TOMLDecodeError\n \"\"\"\n with open(path_config, \"rb\") as f:\n pyproject_toml = tomllib.load(f)\n config = pyproject_toml.get(\"tool\", {}).get(\"black\", {})\n return {k.replace(\"--\", \"\").replace(\"-\", \"_\"): v for k, v in config.items()}\n\n\n@lru_cache()\ndef find_user_pyproject_toml() -> Path:\n r\"\"\"Return the path to the top-level user configuration for black.\n\n This looks for ~\\.black on Windows and ~/.config/black on Linux and other\n Unix systems.\n\n May raise:\n - RuntimeError: if the current user has no homedir\n - PermissionError: if the current process cannot access the user's homedir\n \"\"\"\n if sys.platform == \"win32\":\n # Windows\n user_config_path = Path.home() / \".black\"\n else:\n config_root = os.environ.get(\"XDG_CONFIG_HOME\", \"~/.config\")\n user_config_path = Path(config_root).expanduser() / \"black\"\n return user_config_path.resolve()\n\n\n@lru_cache()\ndef get_gitignore(root: Path) -> PathSpec:\n \"\"\"Return a PathSpec matching gitignore content if present.\"\"\"\n gitignore = root / \".gitignore\"\n lines: List[str] = []\n if gitignore.is_file():\n with gitignore.open(encoding=\"utf-8\") as gf:\n lines = gf.readlines()\n try:\n return PathSpec.from_lines(\"gitwildmatch\", lines)\n except GitWildMatchPatternError as e:\n err(f\"Could not parse {gitignore}: {e}\")\n raise\n\n\ndef normalize_path_maybe_ignore(\n path: Path,\n root: Path,\n report: Optional[Report] = None,\n) -> Optional[str]:\n \"\"\"Normalize `path`. May return `None` if `path` was ignored.\n\n `report` is where \"path ignored\" output goes.\n \"\"\"\n try:\n abspath = path if path.is_absolute() else Path.cwd() / path\n normalized_path = abspath.resolve()\n try:\n root_relative_path = normalized_path.relative_to(root).as_posix()\n except ValueError:\n if report:\n report.path_ignored(\n path, f\"is a symbolic link that points outside {root}\"\n )\n return None\n\n except OSError as e:\n if report:\n report.path_ignored(path, f\"cannot be read because {e}\")\n return None\n\n return root_relative_path\n\n\ndef path_is_excluded(\n normalized_path: str,\n pattern: Optional[Pattern[str]],\n) -> bool:\n match = pattern.search(normalized_path) if pattern else None\n return bool(match and match.group(0))\n\n\ndef gen_python_files(\n paths: Iterable[Path],\n root: Path,\n include: Pattern[str],\n exclude: Pattern[str],\n extend_exclude: Optional[Pattern[str]],\n force_exclude: Optional[Pattern[str]],\n report: Report,\n gitignore: Optional[PathSpec],\n *,\n verbose: bool,\n quiet: bool,\n) -> Iterator[Path]:\n \"\"\"Generate all files under `path` whose paths are not excluded by the\n `exclude_regex`, `extend_exclude`, or `force_exclude` regexes,\n but are included by the `include` regex.\n\n Symbolic links pointing outside of the `root` directory are ignored.\n\n `report` is where output about exclusions goes.\n \"\"\"\n assert root.is_absolute(), f\"INTERNAL ERROR: `root` must be absolute but is {root}\"\n for child in paths:\n normalized_path = normalize_path_maybe_ignore(child, root, report)\n if normalized_path is None:\n continue\n\n # First ignore files matching .gitignore, if passed\n if gitignore is not None and gitignore.match_file(normalized_path):\n report.path_ignored(child, \"matches the .gitignore file content\")\n continue\n\n # Then ignore with `--exclude` `--extend-exclude` and `--force-exclude` options.\n normalized_path = \"/\" + normalized_path\n if child.is_dir():\n normalized_path += \"/\"\n\n if path_is_excluded(normalized_path, exclude):\n report.path_ignored(child, \"matches the --exclude regular expression\")\n continue\n\n if path_is_excluded(normalized_path, extend_exclude):\n report.path_ignored(\n child, \"matches the --extend-exclude regular expression\"\n )\n continue\n\n if path_is_excluded(normalized_path, force_exclude):\n report.path_ignored(child, \"matches the --force-exclude regular expression\")\n continue\n\n if child.is_dir():\n # If gitignore is None, gitignore usage is disabled, while a Falsey\n # gitignore is when the directory doesn't have a .gitignore file.\n yield from gen_python_files(\n child.iterdir(),\n root,\n include,\n exclude,\n extend_exclude,\n force_exclude,\n report,\n gitignore + get_gitignore(child) if gitignore is not None else None,\n verbose=verbose,\n quiet=quiet,\n )\n\n elif child.is_file():\n if child.suffix == \".ipynb\" and not jupyter_dependencies_are_installed(\n verbose=verbose, quiet=quiet\n ):\n continue\n include_match = include.search(normalized_path) if include else True\n if include_match:\n yield child\n\n\ndef wrap_stream_for_windows(\n f: io.TextIOWrapper,\n) -> Union[io.TextIOWrapper, \"colorama.AnsiToWin32\"]:\n \"\"\"\n Wrap stream with colorama's wrap_stream so colors are shown on Windows.\n\n If `colorama` is unavailable, the original stream is returned unmodified.\n Otherwise, the `wrap_stream()` function determines whether the stream needs\n to be wrapped for a Windows environment and will accordingly either return\n an `AnsiToWin32` wrapper or the original stream.\n \"\"\"\n try:\n from colorama.initialise import wrap_stream\n except ImportError:\n return f\n else:\n # Set `strip=False` to avoid needing to modify test_express_diff_with_color.\n return wrap_stream(f, convert=None, strip=False, autoreset=False, wrap=True)\n", "path": "src/black/files.py"}], "after_files": [{"content": "import io\nimport os\nimport sys\nfrom functools import lru_cache\nfrom pathlib import Path\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n Iterable,\n Iterator,\n List,\n Optional,\n Pattern,\n Sequence,\n Tuple,\n Union,\n)\n\nfrom mypy_extensions import mypyc_attr\nfrom pathspec import PathSpec\nfrom pathspec.patterns.gitwildmatch import GitWildMatchPatternError\n\nif sys.version_info >= (3, 11):\n try:\n import tomllib\n except ImportError:\n # Help users on older alphas\n if not TYPE_CHECKING:\n import tomli as tomllib\nelse:\n import tomli as tomllib\n\nfrom black.handle_ipynb_magics import jupyter_dependencies_are_installed\nfrom black.output import err\nfrom black.report import Report\n\nif TYPE_CHECKING:\n import colorama # noqa: F401\n\n\n@lru_cache()\ndef find_project_root(\n srcs: Sequence[str], stdin_filename: Optional[str] = None\n) -> Tuple[Path, str]:\n \"\"\"Return a directory containing .git, .hg, or pyproject.toml.\n\n That directory will be a common parent of all files and directories\n passed in `srcs`.\n\n If no directory in the tree contains a marker that would specify it's the\n project root, the root of the file system is returned.\n\n Returns a two-tuple with the first element as the project root path and\n the second element as a string describing the method by which the\n project root was discovered.\n \"\"\"\n if stdin_filename is not None:\n srcs = tuple(stdin_filename if s == \"-\" else s for s in srcs)\n if not srcs:\n srcs = [str(Path.cwd().resolve())]\n\n path_srcs = [Path(Path.cwd(), src).resolve() for src in srcs]\n\n # A list of lists of parents for each 'src'. 'src' is included as a\n # \"parent\" of itself if it is a directory\n src_parents = [\n list(path.parents) + ([path] if path.is_dir() else []) for path in path_srcs\n ]\n\n common_base = max(\n set.intersection(*(set(parents) for parents in src_parents)),\n key=lambda path: path.parts,\n )\n\n for directory in (common_base, *common_base.parents):\n if (directory / \".git\").exists():\n return directory, \".git directory\"\n\n if (directory / \".hg\").is_dir():\n return directory, \".hg directory\"\n\n if (directory / \"pyproject.toml\").is_file():\n return directory, \"pyproject.toml\"\n\n return directory, \"file system root\"\n\n\ndef find_pyproject_toml(path_search_start: Tuple[str, ...]) -> Optional[str]:\n \"\"\"Find the absolute filepath to a pyproject.toml if it exists\"\"\"\n path_project_root, _ = find_project_root(path_search_start)\n path_pyproject_toml = path_project_root / \"pyproject.toml\"\n if path_pyproject_toml.is_file():\n return str(path_pyproject_toml)\n\n try:\n path_user_pyproject_toml = find_user_pyproject_toml()\n return (\n str(path_user_pyproject_toml)\n if path_user_pyproject_toml.is_file()\n else None\n )\n except (PermissionError, RuntimeError) as e:\n # We do not have access to the user-level config directory, so ignore it.\n err(f\"Ignoring user configuration directory due to {e!r}\")\n return None\n\n\n@mypyc_attr(patchable=True)\ndef parse_pyproject_toml(path_config: str) -> Dict[str, Any]:\n \"\"\"Parse a pyproject toml file, pulling out relevant parts for Black\n\n If parsing fails, will raise a tomllib.TOMLDecodeError\n \"\"\"\n with open(path_config, \"rb\") as f:\n pyproject_toml = tomllib.load(f)\n config = pyproject_toml.get(\"tool\", {}).get(\"black\", {})\n return {k.replace(\"--\", \"\").replace(\"-\", \"_\"): v for k, v in config.items()}\n\n\n@lru_cache()\ndef find_user_pyproject_toml() -> Path:\n r\"\"\"Return the path to the top-level user configuration for black.\n\n This looks for ~\\.black on Windows and ~/.config/black on Linux and other\n Unix systems.\n\n May raise:\n - RuntimeError: if the current user has no homedir\n - PermissionError: if the current process cannot access the user's homedir\n \"\"\"\n if sys.platform == \"win32\":\n # Windows\n user_config_path = Path.home() / \".black\"\n else:\n config_root = os.environ.get(\"XDG_CONFIG_HOME\", \"~/.config\")\n user_config_path = Path(config_root).expanduser() / \"black\"\n return user_config_path.resolve()\n\n\n@lru_cache()\ndef get_gitignore(root: Path) -> PathSpec:\n \"\"\"Return a PathSpec matching gitignore content if present.\"\"\"\n gitignore = root / \".gitignore\"\n lines: List[str] = []\n if gitignore.is_file():\n with gitignore.open(encoding=\"utf-8\") as gf:\n lines = gf.readlines()\n try:\n return PathSpec.from_lines(\"gitwildmatch\", lines)\n except GitWildMatchPatternError as e:\n err(f\"Could not parse {gitignore}: {e}\")\n raise\n\n\ndef normalize_path_maybe_ignore(\n path: Path,\n root: Path,\n report: Optional[Report] = None,\n) -> Optional[str]:\n \"\"\"Normalize `path`. May return `None` if `path` was ignored.\n\n `report` is where \"path ignored\" output goes.\n \"\"\"\n try:\n abspath = path if path.is_absolute() else Path.cwd() / path\n normalized_path = abspath.resolve()\n try:\n root_relative_path = normalized_path.relative_to(root).as_posix()\n except ValueError:\n if report:\n report.path_ignored(\n path, f\"is a symbolic link that points outside {root}\"\n )\n return None\n\n except OSError as e:\n if report:\n report.path_ignored(path, f\"cannot be read because {e}\")\n return None\n\n return root_relative_path\n\n\ndef path_is_excluded(\n normalized_path: str,\n pattern: Optional[Pattern[str]],\n) -> bool:\n match = pattern.search(normalized_path) if pattern else None\n return bool(match and match.group(0))\n\n\ndef gen_python_files(\n paths: Iterable[Path],\n root: Path,\n include: Pattern[str],\n exclude: Pattern[str],\n extend_exclude: Optional[Pattern[str]],\n force_exclude: Optional[Pattern[str]],\n report: Report,\n gitignore: Optional[PathSpec],\n *,\n verbose: bool,\n quiet: bool,\n) -> Iterator[Path]:\n \"\"\"Generate all files under `path` whose paths are not excluded by the\n `exclude_regex`, `extend_exclude`, or `force_exclude` regexes,\n but are included by the `include` regex.\n\n Symbolic links pointing outside of the `root` directory are ignored.\n\n `report` is where output about exclusions goes.\n \"\"\"\n assert root.is_absolute(), f\"INTERNAL ERROR: `root` must be absolute but is {root}\"\n for child in paths:\n normalized_path = normalize_path_maybe_ignore(child, root, report)\n if normalized_path is None:\n continue\n\n # First ignore files matching .gitignore, if passed\n if gitignore is not None and gitignore.match_file(normalized_path):\n report.path_ignored(child, \"matches the .gitignore file content\")\n continue\n\n # Then ignore with `--exclude` `--extend-exclude` and `--force-exclude` options.\n normalized_path = \"/\" + normalized_path\n if child.is_dir():\n normalized_path += \"/\"\n\n if path_is_excluded(normalized_path, exclude):\n report.path_ignored(child, \"matches the --exclude regular expression\")\n continue\n\n if path_is_excluded(normalized_path, extend_exclude):\n report.path_ignored(\n child, \"matches the --extend-exclude regular expression\"\n )\n continue\n\n if path_is_excluded(normalized_path, force_exclude):\n report.path_ignored(child, \"matches the --force-exclude regular expression\")\n continue\n\n if child.is_dir():\n # If gitignore is None, gitignore usage is disabled, while a Falsey\n # gitignore is when the directory doesn't have a .gitignore file.\n yield from gen_python_files(\n child.iterdir(),\n root,\n include,\n exclude,\n extend_exclude,\n force_exclude,\n report,\n gitignore + get_gitignore(child) if gitignore is not None else None,\n verbose=verbose,\n quiet=quiet,\n )\n\n elif child.is_file():\n if child.suffix == \".ipynb\" and not jupyter_dependencies_are_installed(\n verbose=verbose, quiet=quiet\n ):\n continue\n include_match = include.search(normalized_path) if include else True\n if include_match:\n yield child\n\n\ndef wrap_stream_for_windows(\n f: io.TextIOWrapper,\n) -> Union[io.TextIOWrapper, \"colorama.AnsiToWin32\"]:\n \"\"\"\n Wrap stream with colorama's wrap_stream so colors are shown on Windows.\n\n If `colorama` is unavailable, the original stream is returned unmodified.\n Otherwise, the `wrap_stream()` function determines whether the stream needs\n to be wrapped for a Windows environment and will accordingly either return\n an `AnsiToWin32` wrapper or the original stream.\n \"\"\"\n try:\n from colorama.initialise import wrap_stream\n except ImportError:\n return f\n else:\n # Set `strip=False` to avoid needing to modify test_express_diff_with_color.\n return wrap_stream(f, convert=None, strip=False, autoreset=False, wrap=True)\n", "path": "src/black/files.py"}]} |
gh_patches_debug_284 | rasdani/github-patches | git_diff | gratipay__gratipay.com-1975 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
/about/stats.json is broken
[stats.json](https://www.gittip.com/about/stats.json) is broken, I guess because of commit https://github.com/gittip/www.gittip.com/commit/892b1c28d127a18858032c88bd3d065cae973c34 by @clone1018.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `configure-aspen.py`
Content:
```
1 from __future__ import division
2
3 from importlib import import_module
4 import os
5 import sys
6 import threading
7 import time
8 import traceback
9
10 import gittip
11 import gittip.wireup
12 from gittip import canonize, configure_payments
13 from gittip.security import authentication, csrf, x_frame_options
14 from gittip.utils import cache_static, timer
15 from gittip.elsewhere import platform_classes
16
17
18 from aspen import log_dammit
19
20 # Wireup Algorithm
21 # ================
22
23 version_file = os.path.join(website.www_root, 'version.txt')
24 __version__ = open(version_file).read().strip()
25 website.version = os.environ['__VERSION__'] = __version__
26
27
28 website.renderer_default = "jinja2"
29 website.default_renderers_by_media_type['application/json'] = 'stdlib_format'
30
31 website.renderer_factories['jinja2'].Renderer.global_context = {
32 'range': range,
33 'unicode': unicode,
34 'enumerate': enumerate,
35 'len': len,
36 'float': float,
37 'type': type,
38 'str': str
39 }
40
41
42 gittip.wireup.canonical()
43 website.db = gittip.wireup.db()
44 gittip.wireup.billing()
45 gittip.wireup.username_restrictions(website)
46 gittip.wireup.nanswers()
47 gittip.wireup.envvars(website)
48 tell_sentry = gittip.wireup.make_sentry_teller(website)
49
50 # this serves two purposes:
51 # 1) ensure all platform classes are created (and thus added to platform_classes)
52 # 2) keep the platform modules around to be added to the context below
53 platform_modules = {platform: import_module("gittip.elsewhere.%s" % platform)
54 for platform in platform_classes}
55
56 # The homepage wants expensive queries. Let's periodically select into an
57 # intermediate table.
58
59 UPDATE_HOMEPAGE_EVERY = int(os.environ['UPDATE_HOMEPAGE_EVERY'])
60 def update_homepage_queries():
61 from gittip import utils
62 while 1:
63 try:
64 utils.update_global_stats(website)
65 utils.update_homepage_queries_once(website.db)
66 website.db.self_check()
67 except:
68 exception = sys.exc_info()[0]
69 tell_sentry(exception)
70 tb = traceback.format_exc().strip()
71 log_dammit(tb)
72 time.sleep(UPDATE_HOMEPAGE_EVERY)
73
74 if UPDATE_HOMEPAGE_EVERY > 0:
75 homepage_updater = threading.Thread(target=update_homepage_queries)
76 homepage_updater.daemon = True
77 homepage_updater.start()
78 else:
79 from gittip import utils
80 utils.update_global_stats(website)
81
82
83 # Server Algorithm
84 # ================
85
86 def up_minthreads(website):
87 # https://github.com/gittip/www.gittip.com/issues/1098
88 # Discovered the following API by inspecting in pdb and browsing source.
89 # This requires network_engine.bind to have already been called.
90 request_queue = website.network_engine.cheroot_server.requests
91 request_queue.min = website.min_threads
92
93
94 def setup_busy_threads_logging(website):
95 # https://github.com/gittip/www.gittip.com/issues/1572
96 log_every = website.log_busy_threads_every
97 if log_every == 0:
98 return
99
100 pool = website.network_engine.cheroot_server.requests
101 def log_busy_threads():
102 time.sleep(0.5) # without this we get a single log message where all threads are busy
103 while 1:
104
105 # Use pool.min and not pool.max because of the semantics of these
106 # inside of Cheroot. (Max is a hard limit used only when pool.grow
107 # is called, and it's never called except when the pool starts up,
108 # when it's called with pool.min.)
109
110 nbusy_threads = pool.min - pool.idle
111 print("sample#aspen.busy_threads={}".format(nbusy_threads))
112 time.sleep(log_every)
113
114 thread = threading.Thread(target=log_busy_threads)
115 thread.daemon = True
116 thread.start()
117
118
119 website.server_algorithm.insert_before('start', up_minthreads)
120 website.server_algorithm.insert_before('start', setup_busy_threads_logging)
121
122
123 # Website Algorithm
124 # =================
125
126 def add_stuff_to_context(request):
127 request.context['username'] = None
128 request.context.update(platform_modules)
129
130 def scab_body_onto_response(response):
131
132 # This is a workaround for a Cheroot bug, where the connection is closed
133 # too early if there is no body:
134 #
135 # https://bitbucket.org/cherrypy/cheroot/issue/1/fail-if-passed-zero-bytes
136 #
137 # This Cheroot bug is manifesting because of a change in Aspen's behavior
138 # with the algorithm.py refactor in 0.27+: Aspen no longer sets a body for
139 # 302s as it used to. This means that all redirects are breaking
140 # intermittently (sometimes the client seems not to care that the
141 # connection is closed too early, so I guess there's some timing
142 # involved?), which is affecting a number of parts of Gittip, notably
143 # around logging in (#1859).
144
145 if not response.body:
146 response.body = '*sigh*'
147
148
149 algorithm = website.algorithm
150 algorithm.functions = [ timer.start
151 , algorithm['parse_environ_into_request']
152 , algorithm['tack_website_onto_request']
153 , algorithm['raise_200_for_OPTIONS']
154
155 , canonize
156 , configure_payments
157 , authentication.inbound
158 , csrf.inbound
159 , add_stuff_to_context
160
161 , algorithm['dispatch_request_to_filesystem']
162 , algorithm['apply_typecasters_to_path']
163
164 , cache_static.inbound
165
166 , algorithm['get_response_for_socket']
167 , algorithm['get_resource_for_request']
168 , algorithm['get_response_for_resource']
169
170 , tell_sentry
171 , algorithm['get_response_for_exception']
172
173 , gittip.outbound
174 , authentication.outbound
175 , csrf.outbound
176 , cache_static.outbound
177 , x_frame_options
178
179 , algorithm['log_traceback_for_5xx']
180 , algorithm['delegate_error_to_simplate']
181 , tell_sentry
182 , algorithm['log_traceback_for_exception']
183 , algorithm['log_result_of_request']
184
185 , scab_body_onto_response
186 , timer.end
187 , tell_sentry
188 ]
189
```
--- 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/configure-aspen.py b/configure-aspen.py
--- a/configure-aspen.py
+++ b/configure-aspen.py
@@ -26,7 +26,6 @@
website.renderer_default = "jinja2"
-website.default_renderers_by_media_type['application/json'] = 'stdlib_format'
website.renderer_factories['jinja2'].Renderer.global_context = {
'range': range,
| {"golden_diff": "diff --git a/configure-aspen.py b/configure-aspen.py\n--- a/configure-aspen.py\n+++ b/configure-aspen.py\n@@ -26,7 +26,6 @@\n \n \n website.renderer_default = \"jinja2\"\n-website.default_renderers_by_media_type['application/json'] = 'stdlib_format'\n \n website.renderer_factories['jinja2'].Renderer.global_context = {\n 'range': range,\n", "issue": "/about/stats.json is broken\n[stats.json](https://www.gittip.com/about/stats.json) is broken, I guess because of commit https://github.com/gittip/www.gittip.com/commit/892b1c28d127a18858032c88bd3d065cae973c34 by @clone1018.\n\n", "before_files": [{"content": "from __future__ import division\n\nfrom importlib import import_module\nimport os\nimport sys\nimport threading\nimport time\nimport traceback\n\nimport gittip\nimport gittip.wireup\nfrom gittip import canonize, configure_payments\nfrom gittip.security import authentication, csrf, x_frame_options\nfrom gittip.utils import cache_static, timer\nfrom gittip.elsewhere import platform_classes\n\n\nfrom aspen import log_dammit\n\n# Wireup Algorithm\n# ================\n\nversion_file = os.path.join(website.www_root, 'version.txt')\n__version__ = open(version_file).read().strip()\nwebsite.version = os.environ['__VERSION__'] = __version__\n\n\nwebsite.renderer_default = \"jinja2\"\nwebsite.default_renderers_by_media_type['application/json'] = 'stdlib_format'\n\nwebsite.renderer_factories['jinja2'].Renderer.global_context = {\n 'range': range,\n 'unicode': unicode,\n 'enumerate': enumerate,\n 'len': len,\n 'float': float,\n 'type': type,\n 'str': str\n}\n\n\ngittip.wireup.canonical()\nwebsite.db = gittip.wireup.db()\ngittip.wireup.billing()\ngittip.wireup.username_restrictions(website)\ngittip.wireup.nanswers()\ngittip.wireup.envvars(website)\ntell_sentry = gittip.wireup.make_sentry_teller(website)\n\n# this serves two purposes:\n# 1) ensure all platform classes are created (and thus added to platform_classes)\n# 2) keep the platform modules around to be added to the context below\nplatform_modules = {platform: import_module(\"gittip.elsewhere.%s\" % platform)\n for platform in platform_classes}\n\n# The homepage wants expensive queries. Let's periodically select into an\n# intermediate table.\n\nUPDATE_HOMEPAGE_EVERY = int(os.environ['UPDATE_HOMEPAGE_EVERY'])\ndef update_homepage_queries():\n from gittip import utils\n while 1:\n try:\n utils.update_global_stats(website)\n utils.update_homepage_queries_once(website.db)\n website.db.self_check()\n except:\n exception = sys.exc_info()[0]\n tell_sentry(exception)\n tb = traceback.format_exc().strip()\n log_dammit(tb)\n time.sleep(UPDATE_HOMEPAGE_EVERY)\n\nif UPDATE_HOMEPAGE_EVERY > 0:\n homepage_updater = threading.Thread(target=update_homepage_queries)\n homepage_updater.daemon = True\n homepage_updater.start()\nelse:\n from gittip import utils\n utils.update_global_stats(website)\n\n\n# Server Algorithm\n# ================\n\ndef up_minthreads(website):\n # https://github.com/gittip/www.gittip.com/issues/1098\n # Discovered the following API by inspecting in pdb and browsing source.\n # This requires network_engine.bind to have already been called.\n request_queue = website.network_engine.cheroot_server.requests\n request_queue.min = website.min_threads\n\n\ndef setup_busy_threads_logging(website):\n # https://github.com/gittip/www.gittip.com/issues/1572\n log_every = website.log_busy_threads_every\n if log_every == 0:\n return\n\n pool = website.network_engine.cheroot_server.requests\n def log_busy_threads():\n time.sleep(0.5) # without this we get a single log message where all threads are busy\n while 1:\n\n # Use pool.min and not pool.max because of the semantics of these\n # inside of Cheroot. (Max is a hard limit used only when pool.grow\n # is called, and it's never called except when the pool starts up,\n # when it's called with pool.min.)\n\n nbusy_threads = pool.min - pool.idle\n print(\"sample#aspen.busy_threads={}\".format(nbusy_threads))\n time.sleep(log_every)\n\n thread = threading.Thread(target=log_busy_threads)\n thread.daemon = True\n thread.start()\n\n\nwebsite.server_algorithm.insert_before('start', up_minthreads)\nwebsite.server_algorithm.insert_before('start', setup_busy_threads_logging)\n\n\n# Website Algorithm\n# =================\n\ndef add_stuff_to_context(request):\n request.context['username'] = None\n request.context.update(platform_modules)\n\ndef scab_body_onto_response(response):\n\n # This is a workaround for a Cheroot bug, where the connection is closed\n # too early if there is no body:\n #\n # https://bitbucket.org/cherrypy/cheroot/issue/1/fail-if-passed-zero-bytes\n #\n # This Cheroot bug is manifesting because of a change in Aspen's behavior\n # with the algorithm.py refactor in 0.27+: Aspen no longer sets a body for\n # 302s as it used to. This means that all redirects are breaking\n # intermittently (sometimes the client seems not to care that the\n # connection is closed too early, so I guess there's some timing\n # involved?), which is affecting a number of parts of Gittip, notably\n # around logging in (#1859).\n\n if not response.body:\n response.body = '*sigh*'\n\n\nalgorithm = website.algorithm\nalgorithm.functions = [ timer.start\n , algorithm['parse_environ_into_request']\n , algorithm['tack_website_onto_request']\n , algorithm['raise_200_for_OPTIONS']\n\n , canonize\n , configure_payments\n , authentication.inbound\n , csrf.inbound\n , add_stuff_to_context\n\n , algorithm['dispatch_request_to_filesystem']\n , algorithm['apply_typecasters_to_path']\n\n , cache_static.inbound\n\n , algorithm['get_response_for_socket']\n , algorithm['get_resource_for_request']\n , algorithm['get_response_for_resource']\n\n , tell_sentry\n , algorithm['get_response_for_exception']\n\n , gittip.outbound\n , authentication.outbound\n , csrf.outbound\n , cache_static.outbound\n , x_frame_options\n\n , algorithm['log_traceback_for_5xx']\n , algorithm['delegate_error_to_simplate']\n , tell_sentry\n , algorithm['log_traceback_for_exception']\n , algorithm['log_result_of_request']\n\n , scab_body_onto_response\n , timer.end\n , tell_sentry\n ]\n", "path": "configure-aspen.py"}], "after_files": [{"content": "from __future__ import division\n\nfrom importlib import import_module\nimport os\nimport sys\nimport threading\nimport time\nimport traceback\n\nimport gittip\nimport gittip.wireup\nfrom gittip import canonize, configure_payments\nfrom gittip.security import authentication, csrf, x_frame_options\nfrom gittip.utils import cache_static, timer\nfrom gittip.elsewhere import platform_classes\n\n\nfrom aspen import log_dammit\n\n# Wireup Algorithm\n# ================\n\nversion_file = os.path.join(website.www_root, 'version.txt')\n__version__ = open(version_file).read().strip()\nwebsite.version = os.environ['__VERSION__'] = __version__\n\n\nwebsite.renderer_default = \"jinja2\"\n\nwebsite.renderer_factories['jinja2'].Renderer.global_context = {\n 'range': range,\n 'unicode': unicode,\n 'enumerate': enumerate,\n 'len': len,\n 'float': float,\n 'type': type,\n 'str': str\n}\n\n\ngittip.wireup.canonical()\nwebsite.db = gittip.wireup.db()\ngittip.wireup.billing()\ngittip.wireup.username_restrictions(website)\ngittip.wireup.nanswers()\ngittip.wireup.envvars(website)\ntell_sentry = gittip.wireup.make_sentry_teller(website)\n\n# this serves two purposes:\n# 1) ensure all platform classes are created (and thus added to platform_classes)\n# 2) keep the platform modules around to be added to the context below\nplatform_modules = {platform: import_module(\"gittip.elsewhere.%s\" % platform)\n for platform in platform_classes}\n\n# The homepage wants expensive queries. Let's periodically select into an\n# intermediate table.\n\nUPDATE_HOMEPAGE_EVERY = int(os.environ['UPDATE_HOMEPAGE_EVERY'])\ndef update_homepage_queries():\n from gittip import utils\n while 1:\n try:\n utils.update_global_stats(website)\n utils.update_homepage_queries_once(website.db)\n website.db.self_check()\n except:\n exception = sys.exc_info()[0]\n tell_sentry(exception)\n tb = traceback.format_exc().strip()\n log_dammit(tb)\n time.sleep(UPDATE_HOMEPAGE_EVERY)\n\nif UPDATE_HOMEPAGE_EVERY > 0:\n homepage_updater = threading.Thread(target=update_homepage_queries)\n homepage_updater.daemon = True\n homepage_updater.start()\nelse:\n from gittip import utils\n utils.update_global_stats(website)\n\n\n# Server Algorithm\n# ================\n\ndef up_minthreads(website):\n # https://github.com/gittip/www.gittip.com/issues/1098\n # Discovered the following API by inspecting in pdb and browsing source.\n # This requires network_engine.bind to have already been called.\n request_queue = website.network_engine.cheroot_server.requests\n request_queue.min = website.min_threads\n\n\ndef setup_busy_threads_logging(website):\n # https://github.com/gittip/www.gittip.com/issues/1572\n log_every = website.log_busy_threads_every\n if log_every == 0:\n return\n\n pool = website.network_engine.cheroot_server.requests\n def log_busy_threads():\n time.sleep(0.5) # without this we get a single log message where all threads are busy\n while 1:\n\n # Use pool.min and not pool.max because of the semantics of these\n # inside of Cheroot. (Max is a hard limit used only when pool.grow\n # is called, and it's never called except when the pool starts up,\n # when it's called with pool.min.)\n\n nbusy_threads = pool.min - pool.idle\n print(\"sample#aspen.busy_threads={}\".format(nbusy_threads))\n time.sleep(log_every)\n\n thread = threading.Thread(target=log_busy_threads)\n thread.daemon = True\n thread.start()\n\n\nwebsite.server_algorithm.insert_before('start', up_minthreads)\nwebsite.server_algorithm.insert_before('start', setup_busy_threads_logging)\n\n\n# Website Algorithm\n# =================\n\ndef add_stuff_to_context(request):\n request.context['username'] = None\n request.context.update(platform_modules)\n\ndef scab_body_onto_response(response):\n\n # This is a workaround for a Cheroot bug, where the connection is closed\n # too early if there is no body:\n #\n # https://bitbucket.org/cherrypy/cheroot/issue/1/fail-if-passed-zero-bytes\n #\n # This Cheroot bug is manifesting because of a change in Aspen's behavior\n # with the algorithm.py refactor in 0.27+: Aspen no longer sets a body for\n # 302s as it used to. This means that all redirects are breaking\n # intermittently (sometimes the client seems not to care that the\n # connection is closed too early, so I guess there's some timing\n # involved?), which is affecting a number of parts of Gittip, notably\n # around logging in (#1859).\n\n if not response.body:\n response.body = '*sigh*'\n\n\nalgorithm = website.algorithm\nalgorithm.functions = [ timer.start\n , algorithm['parse_environ_into_request']\n , algorithm['tack_website_onto_request']\n , algorithm['raise_200_for_OPTIONS']\n\n , canonize\n , configure_payments\n , authentication.inbound\n , csrf.inbound\n , add_stuff_to_context\n\n , algorithm['dispatch_request_to_filesystem']\n , algorithm['apply_typecasters_to_path']\n\n , cache_static.inbound\n\n , algorithm['get_response_for_socket']\n , algorithm['get_resource_for_request']\n , algorithm['get_response_for_resource']\n\n , tell_sentry\n , algorithm['get_response_for_exception']\n\n , gittip.outbound\n , authentication.outbound\n , csrf.outbound\n , cache_static.outbound\n , x_frame_options\n\n , algorithm['log_traceback_for_5xx']\n , algorithm['delegate_error_to_simplate']\n , tell_sentry\n , algorithm['log_traceback_for_exception']\n , algorithm['log_result_of_request']\n\n , scab_body_onto_response\n , timer.end\n , tell_sentry\n ]\n", "path": "configure-aspen.py"}]} |
gh_patches_debug_285 | rasdani/github-patches | git_diff | kivy__kivy-5951 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
enchant - ImportError: No module named 'enchant'
<!--
The issue tracker is a tool to address bugs.
Please use the #kivy IRC channel on freenode or Stack Overflow for
support questions, more information at https://git.io/vM1yQ.
Before opening a new issue, make sure you do the following:
* check that your issue isn't already filed: https://git.io/vM1iE
* prepare a short, runnable example that reproduces the issue
* reproduce the problem with the latest development version of Kivy
* double-check that the issue is indeed a bug and not a support request
-->
### Versions
* Python: 3.5.2
* OS:Windows-10-10.0.17134-SP0
* Kivy:v1.10.0
* Kivy installation method: follow wiki of kivy on github
### Description
Try to build an app on windows, I'll encounter the problem "No module named 'enchant'"
so I search everwhere I can only to find out that the maintainer have gave up on supporting pyenchant for windows x64 + python3.5 ([here](https://github.com/rfk/pyenchant/issues/42))
So I need to know is there any way to fix this for win10x64+python35
PS: this will not affect the function for my current build, it runs normally, but it is still a potential problem for further development ....
### Code and Logs
```build log
PS G:\Projects\LANRemoteController\LANRemoteController> python3 -m PyInstaller .\server.spec
3730 INFO: PyInstaller: 3.3.1
3730 INFO: Python: 3.5.2
3730 INFO: Platform: Windows-10-10.0.17134-SP0
3730 INFO: UPX is not available.
[INFO ] [Logger ] Record log in C:\Users\Administrator\.kivy\logs\kivy_18-06-21_7.txt
4246 INFO: [Logger ] Record log in C:\Users\Administrator\.kivy\logs\kivy_18-06-21_7.txt
[INFO ] [Kivy ] v1.10.0
4246 INFO: [Kivy ] v1.10.0
[INFO ] [Python ] v3.5.2 (v3.5.2:4def2a2901a5, Jun 25 2016, 22:18:55) [MSC v.1900 64 bit (AMD64)]
4261 INFO: [Python ] v3.5.2 (v3.5.2:4def2a2901a5, Jun 25 2016, 22:18:55) [MSC v.1900 64 bit (AMD64)]
4261 INFO: Extending PYTHONPATH with paths
['G:\\Projects\\LANRemoteController\\LANRemoteController',
'G:\\Projects\\LANRemoteController\\LANRemoteController']
4261 INFO: checking Analysis
4386 INFO: Building because inputs changed
4386 INFO: Initializing module dependency graph...
4465 INFO: Initializing module graph hooks...
4543 INFO: Analyzing base_library.zip ...
11617 INFO: running Analysis out00-Analysis.toc
13446 INFO: Caching module hooks...
13539 INFO: Analyzing Server\ServerUI.py
18071 INFO: Loading module hooks...
18071 INFO: Loading module hook "hook-kivy.py"...
[INFO ] [Factory ] 194 symbols loaded
18290 INFO: [Factory ] 194 symbols loaded
[INFO ] [Logger ] Record log in C:\Users\Administrator\.kivy\logs\kivy_18-06-21_8.txt
[INFO ] [Kivy ] v1.10.0
[INFO ] [Python ] v3.5.2 (v3.5.2:4def2a2901a5, Jun 25 2016, 22:18:55) [MSC v.1900 64 bit (AMD64)]
[INFO ] [Image ] Providers: img_tex, img_dds, img_sdl2, img_gif (img_pil, img_ffpyplayer ignored)
[INFO ] [Logger ] Record log in C:\Users\Administrator\.kivy\logs\kivy_18-06-21_9.txt
[INFO ] [Kivy ] v1.10.0
[INFO ] [Python ] v3.5.2 (v3.5.2:4def2a2901a5, Jun 25 2016, 22:18:55) [MSC v.1900 64 bit (AMD64)]
[INFO ] [AudioGstplayer] Using Gstreamer 1.10.2.0
[INFO ] [Audio ] Providers: audio_gstplayer, audio_sdl2 (audio_ffpyplayer ignored)
[INFO ] [Image ] Providers: img_tex, img_dds, img_sdl2, img_gif (img_pil, img_ffpyplayer ignored)
[INFO ] [Camera ] Provider: opencv
[INFO ] [Clipboard ] Provider: winctypes
[INFO ] [Factory ] 194 symbols loaded
[INFO ] [OSC ] using <thread> for socket
[INFO ] [Window ] Provider: sdl2
[INFO ] [GL ] Using the "OpenGL" graphics system
[INFO ] [GL ] GLEW initialization succeeded
[INFO ] [GL ] Backend used <glew>
[INFO ] [GL ] OpenGL version <b'4.6.0 NVIDIA 390.77'>
[INFO ] [GL ] OpenGL vendor <b'NVIDIA Corporation'>
[INFO ] [GL ] OpenGL renderer <b'GeForce GTX 970/PCIe/SSE2'>
[INFO ] [GL ] OpenGL parsed version: 4, 6
[INFO ] [GL ] Shading version <b'4.60 NVIDIA'>
[INFO ] [GL ] Texture max size <16384>
[INFO ] [GL ] Texture max units <32>
[INFO ] [Window ] auto add sdl2 input provider
[INFO ] [Window ] virtual keyboard allowed, single mode, docked
[CRITICAL] [Spelling ] Unable to find any valuable Spelling provider.
enchant - ImportError: No module named 'enchant'
File "F:\Develop\Python35\lib\site-packages\kivy\core\__init__.py", line 59, in core_select_lib
fromlist=[modulename], level=0)
File "F:\Develop\Python35\lib\site-packages\kivy\core\spelling\spelling_enchant.py", line 6, in <module>
import enchant
[INFO ] [Text ] Provider: sdl2
[INFO ] [VideoGstplayer] Using Gstreamer 1.10.2.0
[INFO ] [Video ] Provider: gstplayer
33203 WARNING: Hidden import "fired." not found!
33797 WARNING: Hidden import "34" not found!
33797 WARNING: Hidden import "Analysing..." not found!
33797 WARNING: Hidden import "files" not found!
35141 WARNING: Hidden import "log" not found!
35234 WARNING: Hidden import "Purge" not found!
35297 WARNING: Hidden import "finished!" not found!
38000 INFO: Processing pre-find module path hook distutils
45919 INFO: Processing pre-find module path hook site
45935 INFO: site: retargeting to fake-dir 'F:\\Develop\\Python35\\lib\\site-packages\\PyInstaller\\fake-modules'
53387 INFO: Excluding import 'twisted'
53392 INFO: Removing import of twisted from module kivy.support
53394 INFO: Import to be excluded not found: '_tkinter'
53395 INFO: Import to be excluded not found: 'tkinter'
53395 INFO: Loading module hook "hook-sysconfig.py"...
53478 INFO: Loading module hook "hook-xml.dom.domreg.py"...
53489 INFO: Loading module hook "hook-pydoc.py"...
53514 INFO: Loading module hook "hook-lib2to3.py"...
53736 INFO: Loading module hook "hook-xml.py"...
53740 INFO: Loading module hook "hook-xml.etree.cElementTree.py"...
53744 INFO: Loading module hook "hook-distutils.py"...
53764 INFO: Loading module hook "hook-setuptools.py"...
53826 INFO: Loading module hook "hook-docutils.py"...
60180 INFO: Loading module hook "hook-cv2.py"...
60203 INFO: Loading module hook "hook-pygments.py"...
63610 INFO: Loading module hook "hook-pkg_resources.py"...
64177 INFO: Processing pre-safe import module hook win32com
64400 INFO: Loading module hook "hook-numpy.core.py"...
64494 INFO: Loading module hook "hook-encodings.py"...
64569 INFO: Loading module hook "hook-pywintypes.py"...
64748 INFO: Loading module hook "hook-win32com.py"...
65425 INFO: Loading module hook "hook-pythoncom.py"...
65662 INFO: Looking for ctypes DLLs
65721 INFO: Analyzing run-time hooks ...
65728 INFO: Including run-time hook 'pyi_rth_kivy.py'
65732 INFO: Including run-time hook 'pyi_rth_pkgres.py'
65767 INFO: Including run-time hook 'pyi_rth_win32comgenpy.py'
65788 INFO: Including run-time hook 'pyi_rth_gstreamer.py'
65796 INFO: Including run-time hook 'pyi_rth_multiprocessing.py'
65821 INFO: Looking for dynamic libraries
80778 INFO: Looking for eggs
80778 INFO: Using Python library F:\Develop\Python35\python35.dll
80793 INFO: Found binding redirects:
[]
80809 INFO: Warnings written to G:\Projects\LANRemoteController\LANRemoteController\build\server\warnserver.txt
80965 INFO: Graph cross-reference written to G:\Projects\LANRemoteController\LANRemoteController\build\server\xref-server.html
81059 INFO: checking PYZ
81074 INFO: Building because toc changed
81074 INFO: Building PYZ (ZlibArchive) G:\Projects\LANRemoteController\LANRemoteController\build\server\out00-PYZ.pyz
82788 INFO: Building PYZ (ZlibArchive) G:\Projects\LANRemoteController\LANRemoteController\build\server\out00-PYZ.pyz completed successfully.
82819 INFO: checking PKG
82819 INFO: Building because G:\Projects\LANRemoteController\LANRemoteController\build\server\out00-PYZ.pyz changed
82819 INFO: Building PKG (CArchive) out00-PKG.pkg
83022 INFO: Building PKG (CArchive) out00-PKG.pkg completed successfully.
83022 INFO: Bootloader F:\Develop\Python35\lib\site-packages\PyInstaller\bootloader\Windows-64bit\run.exe
83022 INFO: checking EXE
83022 INFO: Building because manifest changed
83022 INFO: Building EXE from out00-EXE.toc
83085 INFO: Appending archive to EXE G:\Projects\LANRemoteController\LANRemoteController\build\server\server.exe
83335 INFO: Building EXE from out00-EXE.toc completed successfully.
83335 INFO: checking Tree
83335 INFO: Building Tree because out00-Tree.toc is non existent
83335 INFO: Building Tree out00-Tree.toc
83366 INFO: checking Tree
83366 INFO: Building Tree because out01-Tree.toc is non existent
83366 INFO: Building Tree out01-Tree.toc
83382 INFO: checking COLLECT
WARNING: The output directory "G:\Projects\LANRemoteController\LANRemoteController\dist\server" and ALL ITS CONTENTS will be REMOVED! Continue? (y/n)y
134948 INFO: Removing dir G:\Projects\LANRemoteController\LANRemoteController\dist\server
135183 INFO: Building COLLECT out00-COLLECT.toc
136730 INFO: Updating manifest in C:\Users\Administrator\AppData\Roaming\pyinstaller\bincache00_py35_64bit\cv2.cv2.pyd
136730 INFO: Updating resource type 24 name 2 language 1033
137402 INFO: Updating manifest in C:\Users\Administrator\AppData\Roaming\pyinstaller\bincache00_py35_64bit\numpy.core.multiarray.pyd
137402 INFO: Updating resource type 24 name 2 language 1033
137464 INFO: Updating manifest in C:\Users\Administrator\AppData\Roaming\pyinstaller\bincache00_py35_64bit\numpy.core.umath.pyd
137464 INFO: Updating resource type 24 name 2 language 1033
137511 INFO: Updating manifest in C:\Users\Administrator\AppData\Roaming\pyinstaller\bincache00_py35_64bit\numpy.core.multiarray_tests.pyd
137511 INFO: Updating resource type 24 name 2 language 1033
137574 INFO: Updating manifest in C:\Users\Administrator\AppData\Roaming\pyinstaller\bincache00_py35_64bit\numpy.random.mtrand.pyd
137574 INFO: Updating resource type 24 name 2 language 1033
137605 INFO: Updating manifest in C:\Users\Administrator\AppData\Roaming\pyinstaller\bincache00_py35_64bit\numpy.fft.fftpack_lite.pyd
137605 INFO: Updating resource type 24 name 2 language 1033
137636 INFO: Updating manifest in C:\Users\Administrator\AppData\Roaming\pyinstaller\bincache00_py35_64bit\numpy.linalg._umath_linalg.pyd
137636 INFO: Updating resource type 24 name 2 language 1033
137683 INFO: Updating manifest in C:\Users\Administrator\AppData\Roaming\pyinstaller\bincache00_py35_64bit\numpy.linalg.lapack_lite.pyd
137683 INFO: Updating resource type 24 name 2 language 1033
141453 INFO: Building COLLECT out00-COLLECT.toc completed successfully.
```
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `kivy/core/spelling/spelling_enchant.py`
Content:
```
1 '''
2 Enchant Spelling: Implements spelling backend based on enchant.
3 '''
4
5
6 import enchant
7
8 from kivy.core.spelling import SpellingBase, NoSuchLangError
9 from kivy.compat import PY2
10
11
12 class SpellingEnchant(SpellingBase):
13 '''
14 Spelling backend based on the enchant library.
15 '''
16
17 def __init__(self, language=None):
18 self._language = None
19 super(SpellingEnchant, self).__init__(language)
20
21 def select_language(self, language):
22 try:
23 self._language = enchant.Dict(language)
24 except enchant.DictNotFoundError:
25 err = 'Enchant Backend: No language for "%s"' % (language, )
26 raise NoSuchLangError(err)
27
28 def list_languages(self):
29 # Note: We do NOT return enchant.list_dicts because that also returns
30 # the enchant dict objects and not only the language identifiers.
31 return enchant.list_languages()
32
33 def check(self, word):
34 if not word:
35 return None
36 return self._language.check(word)
37
38 def suggest(self, fragment):
39 suggestions = self._language.suggest(fragment)
40 # Don't show suggestions that are invalid
41 suggestions = [s for s in suggestions if self.check(s)]
42 if PY2:
43 suggestions = [s.decode('utf-8') for s in suggestions]
44 return suggestions
45
```
--- 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/kivy/core/spelling/spelling_enchant.py b/kivy/core/spelling/spelling_enchant.py
--- a/kivy/core/spelling/spelling_enchant.py
+++ b/kivy/core/spelling/spelling_enchant.py
@@ -1,5 +1,11 @@
'''
-Enchant Spelling: Implements spelling backend based on enchant.
+Enchant Spelling
+================
+
+Implementation spelling backend based on enchant.
+
+.. warning:: pyenchant doesn't have dedicated build anymore for Windows/x64.
+ See https://github.com/kivy/kivy/issues/5816 for more informations
'''
| {"golden_diff": "diff --git a/kivy/core/spelling/spelling_enchant.py b/kivy/core/spelling/spelling_enchant.py\n--- a/kivy/core/spelling/spelling_enchant.py\n+++ b/kivy/core/spelling/spelling_enchant.py\n@@ -1,5 +1,11 @@\n '''\n-Enchant Spelling: Implements spelling backend based on enchant.\n+Enchant Spelling\n+================\n+\n+Implementation spelling backend based on enchant.\n+\n+.. warning:: pyenchant doesn't have dedicated build anymore for Windows/x64.\n+ See https://github.com/kivy/kivy/issues/5816 for more informations\n '''\n", "issue": "enchant - ImportError: No module named 'enchant'\n<!--\r\nThe issue tracker is a tool to address bugs.\r\nPlease use the #kivy IRC channel on freenode or Stack Overflow for\r\nsupport questions, more information at https://git.io/vM1yQ.\r\n\r\nBefore opening a new issue, make sure you do the following:\r\n * check that your issue isn't already filed: https://git.io/vM1iE\r\n * prepare a short, runnable example that reproduces the issue\r\n * reproduce the problem with the latest development version of Kivy\r\n * double-check that the issue is indeed a bug and not a support request\r\n-->\r\n\r\n### Versions\r\n\r\n* Python: 3.5.2\r\n* OS:Windows-10-10.0.17134-SP0\r\n* Kivy:v1.10.0\r\n* Kivy installation method: follow wiki of kivy on github\r\n\r\n### Description\r\n\r\nTry to build an app on windows, I'll encounter the problem \"No module named 'enchant'\"\r\nso I search everwhere I can only to find out that the maintainer have gave up on supporting pyenchant for windows x64 + python3.5 ([here](https://github.com/rfk/pyenchant/issues/42))\r\nSo I need to know is there any way to fix this for win10x64+python35\r\n\r\nPS: this will not affect the function for my current build, it runs normally, but it is still a potential problem for further development ....\r\n\r\n### Code and Logs\r\n\r\n```build log\r\nPS G:\\Projects\\LANRemoteController\\LANRemoteController> python3 -m PyInstaller .\\server.spec\r\n3730 INFO: PyInstaller: 3.3.1\r\n3730 INFO: Python: 3.5.2\r\n3730 INFO: Platform: Windows-10-10.0.17134-SP0\r\n3730 INFO: UPX is not available.\r\n[INFO ] [Logger ] Record log in C:\\Users\\Administrator\\.kivy\\logs\\kivy_18-06-21_7.txt\r\n4246 INFO: [Logger ] Record log in C:\\Users\\Administrator\\.kivy\\logs\\kivy_18-06-21_7.txt\r\n[INFO ] [Kivy ] v1.10.0\r\n4246 INFO: [Kivy ] v1.10.0\r\n[INFO ] [Python ] v3.5.2 (v3.5.2:4def2a2901a5, Jun 25 2016, 22:18:55) [MSC v.1900 64 bit (AMD64)]\r\n4261 INFO: [Python ] v3.5.2 (v3.5.2:4def2a2901a5, Jun 25 2016, 22:18:55) [MSC v.1900 64 bit (AMD64)]\r\n4261 INFO: Extending PYTHONPATH with paths\r\n['G:\\\\Projects\\\\LANRemoteController\\\\LANRemoteController',\r\n 'G:\\\\Projects\\\\LANRemoteController\\\\LANRemoteController']\r\n4261 INFO: checking Analysis\r\n4386 INFO: Building because inputs changed\r\n4386 INFO: Initializing module dependency graph...\r\n4465 INFO: Initializing module graph hooks...\r\n4543 INFO: Analyzing base_library.zip ...\r\n11617 INFO: running Analysis out00-Analysis.toc\r\n13446 INFO: Caching module hooks...\r\n13539 INFO: Analyzing Server\\ServerUI.py\r\n18071 INFO: Loading module hooks...\r\n18071 INFO: Loading module hook \"hook-kivy.py\"...\r\n[INFO ] [Factory ] 194 symbols loaded\r\n18290 INFO: [Factory ] 194 symbols loaded\r\n[INFO ] [Logger ] Record log in C:\\Users\\Administrator\\.kivy\\logs\\kivy_18-06-21_8.txt\r\n[INFO ] [Kivy ] v1.10.0\r\n[INFO ] [Python ] v3.5.2 (v3.5.2:4def2a2901a5, Jun 25 2016, 22:18:55) [MSC v.1900 64 bit (AMD64)]\r\n[INFO ] [Image ] Providers: img_tex, img_dds, img_sdl2, img_gif (img_pil, img_ffpyplayer ignored)\r\n[INFO ] [Logger ] Record log in C:\\Users\\Administrator\\.kivy\\logs\\kivy_18-06-21_9.txt\r\n[INFO ] [Kivy ] v1.10.0\r\n[INFO ] [Python ] v3.5.2 (v3.5.2:4def2a2901a5, Jun 25 2016, 22:18:55) [MSC v.1900 64 bit (AMD64)]\r\n[INFO ] [AudioGstplayer] Using Gstreamer 1.10.2.0\r\n[INFO ] [Audio ] Providers: audio_gstplayer, audio_sdl2 (audio_ffpyplayer ignored)\r\n[INFO ] [Image ] Providers: img_tex, img_dds, img_sdl2, img_gif (img_pil, img_ffpyplayer ignored)\r\n[INFO ] [Camera ] Provider: opencv\r\n[INFO ] [Clipboard ] Provider: winctypes\r\n[INFO ] [Factory ] 194 symbols loaded\r\n[INFO ] [OSC ] using <thread> for socket\r\n[INFO ] [Window ] Provider: sdl2\r\n[INFO ] [GL ] Using the \"OpenGL\" graphics system\r\n[INFO ] [GL ] GLEW initialization succeeded\r\n[INFO ] [GL ] Backend used <glew>\r\n[INFO ] [GL ] OpenGL version <b'4.6.0 NVIDIA 390.77'>\r\n[INFO ] [GL ] OpenGL vendor <b'NVIDIA Corporation'>\r\n[INFO ] [GL ] OpenGL renderer <b'GeForce GTX 970/PCIe/SSE2'>\r\n[INFO ] [GL ] OpenGL parsed version: 4, 6\r\n[INFO ] [GL ] Shading version <b'4.60 NVIDIA'>\r\n[INFO ] [GL ] Texture max size <16384>\r\n[INFO ] [GL ] Texture max units <32>\r\n[INFO ] [Window ] auto add sdl2 input provider\r\n[INFO ] [Window ] virtual keyboard allowed, single mode, docked\r\n[CRITICAL] [Spelling ] Unable to find any valuable Spelling provider.\r\nenchant - ImportError: No module named 'enchant'\r\n File \"F:\\Develop\\Python35\\lib\\site-packages\\kivy\\core\\__init__.py\", line 59, in core_select_lib\r\n fromlist=[modulename], level=0)\r\n File \"F:\\Develop\\Python35\\lib\\site-packages\\kivy\\core\\spelling\\spelling_enchant.py\", line 6, in <module>\r\n import enchant\r\n\r\n[INFO ] [Text ] Provider: sdl2\r\n[INFO ] [VideoGstplayer] Using Gstreamer 1.10.2.0\r\n[INFO ] [Video ] Provider: gstplayer\r\n33203 WARNING: Hidden import \"fired.\" not found!\r\n33797 WARNING: Hidden import \"34\" not found!\r\n33797 WARNING: Hidden import \"Analysing...\" not found!\r\n33797 WARNING: Hidden import \"files\" not found!\r\n35141 WARNING: Hidden import \"log\" not found!\r\n35234 WARNING: Hidden import \"Purge\" not found!\r\n35297 WARNING: Hidden import \"finished!\" not found!\r\n38000 INFO: Processing pre-find module path hook distutils\r\n45919 INFO: Processing pre-find module path hook site\r\n45935 INFO: site: retargeting to fake-dir 'F:\\\\Develop\\\\Python35\\\\lib\\\\site-packages\\\\PyInstaller\\\\fake-modules'\r\n53387 INFO: Excluding import 'twisted'\r\n53392 INFO: Removing import of twisted from module kivy.support\r\n53394 INFO: Import to be excluded not found: '_tkinter'\r\n53395 INFO: Import to be excluded not found: 'tkinter'\r\n53395 INFO: Loading module hook \"hook-sysconfig.py\"...\r\n53478 INFO: Loading module hook \"hook-xml.dom.domreg.py\"...\r\n53489 INFO: Loading module hook \"hook-pydoc.py\"...\r\n53514 INFO: Loading module hook \"hook-lib2to3.py\"...\r\n53736 INFO: Loading module hook \"hook-xml.py\"...\r\n53740 INFO: Loading module hook \"hook-xml.etree.cElementTree.py\"...\r\n53744 INFO: Loading module hook \"hook-distutils.py\"...\r\n53764 INFO: Loading module hook \"hook-setuptools.py\"...\r\n53826 INFO: Loading module hook \"hook-docutils.py\"...\r\n60180 INFO: Loading module hook \"hook-cv2.py\"...\r\n60203 INFO: Loading module hook \"hook-pygments.py\"...\r\n63610 INFO: Loading module hook \"hook-pkg_resources.py\"...\r\n64177 INFO: Processing pre-safe import module hook win32com\r\n64400 INFO: Loading module hook \"hook-numpy.core.py\"...\r\n64494 INFO: Loading module hook \"hook-encodings.py\"...\r\n64569 INFO: Loading module hook \"hook-pywintypes.py\"...\r\n64748 INFO: Loading module hook \"hook-win32com.py\"...\r\n65425 INFO: Loading module hook \"hook-pythoncom.py\"...\r\n65662 INFO: Looking for ctypes DLLs\r\n65721 INFO: Analyzing run-time hooks ...\r\n65728 INFO: Including run-time hook 'pyi_rth_kivy.py'\r\n65732 INFO: Including run-time hook 'pyi_rth_pkgres.py'\r\n65767 INFO: Including run-time hook 'pyi_rth_win32comgenpy.py'\r\n65788 INFO: Including run-time hook 'pyi_rth_gstreamer.py'\r\n65796 INFO: Including run-time hook 'pyi_rth_multiprocessing.py'\r\n65821 INFO: Looking for dynamic libraries\r\n80778 INFO: Looking for eggs\r\n80778 INFO: Using Python library F:\\Develop\\Python35\\python35.dll\r\n80793 INFO: Found binding redirects:\r\n[]\r\n80809 INFO: Warnings written to G:\\Projects\\LANRemoteController\\LANRemoteController\\build\\server\\warnserver.txt\r\n80965 INFO: Graph cross-reference written to G:\\Projects\\LANRemoteController\\LANRemoteController\\build\\server\\xref-server.html\r\n81059 INFO: checking PYZ\r\n81074 INFO: Building because toc changed\r\n81074 INFO: Building PYZ (ZlibArchive) G:\\Projects\\LANRemoteController\\LANRemoteController\\build\\server\\out00-PYZ.pyz\r\n82788 INFO: Building PYZ (ZlibArchive) G:\\Projects\\LANRemoteController\\LANRemoteController\\build\\server\\out00-PYZ.pyz completed successfully.\r\n82819 INFO: checking PKG\r\n82819 INFO: Building because G:\\Projects\\LANRemoteController\\LANRemoteController\\build\\server\\out00-PYZ.pyz changed\r\n82819 INFO: Building PKG (CArchive) out00-PKG.pkg\r\n83022 INFO: Building PKG (CArchive) out00-PKG.pkg completed successfully.\r\n83022 INFO: Bootloader F:\\Develop\\Python35\\lib\\site-packages\\PyInstaller\\bootloader\\Windows-64bit\\run.exe\r\n83022 INFO: checking EXE\r\n83022 INFO: Building because manifest changed\r\n83022 INFO: Building EXE from out00-EXE.toc\r\n83085 INFO: Appending archive to EXE G:\\Projects\\LANRemoteController\\LANRemoteController\\build\\server\\server.exe\r\n83335 INFO: Building EXE from out00-EXE.toc completed successfully.\r\n83335 INFO: checking Tree\r\n83335 INFO: Building Tree because out00-Tree.toc is non existent\r\n83335 INFO: Building Tree out00-Tree.toc\r\n83366 INFO: checking Tree\r\n83366 INFO: Building Tree because out01-Tree.toc is non existent\r\n83366 INFO: Building Tree out01-Tree.toc\r\n83382 INFO: checking COLLECT\r\nWARNING: The output directory \"G:\\Projects\\LANRemoteController\\LANRemoteController\\dist\\server\" and ALL ITS CONTENTS will be REMOVED! Continue? (y/n)y\r\n134948 INFO: Removing dir G:\\Projects\\LANRemoteController\\LANRemoteController\\dist\\server\r\n135183 INFO: Building COLLECT out00-COLLECT.toc\r\n136730 INFO: Updating manifest in C:\\Users\\Administrator\\AppData\\Roaming\\pyinstaller\\bincache00_py35_64bit\\cv2.cv2.pyd\r\n136730 INFO: Updating resource type 24 name 2 language 1033\r\n137402 INFO: Updating manifest in C:\\Users\\Administrator\\AppData\\Roaming\\pyinstaller\\bincache00_py35_64bit\\numpy.core.multiarray.pyd\r\n137402 INFO: Updating resource type 24 name 2 language 1033\r\n137464 INFO: Updating manifest in C:\\Users\\Administrator\\AppData\\Roaming\\pyinstaller\\bincache00_py35_64bit\\numpy.core.umath.pyd\r\n137464 INFO: Updating resource type 24 name 2 language 1033\r\n137511 INFO: Updating manifest in C:\\Users\\Administrator\\AppData\\Roaming\\pyinstaller\\bincache00_py35_64bit\\numpy.core.multiarray_tests.pyd\r\n137511 INFO: Updating resource type 24 name 2 language 1033\r\n137574 INFO: Updating manifest in C:\\Users\\Administrator\\AppData\\Roaming\\pyinstaller\\bincache00_py35_64bit\\numpy.random.mtrand.pyd\r\n137574 INFO: Updating resource type 24 name 2 language 1033\r\n137605 INFO: Updating manifest in C:\\Users\\Administrator\\AppData\\Roaming\\pyinstaller\\bincache00_py35_64bit\\numpy.fft.fftpack_lite.pyd\r\n137605 INFO: Updating resource type 24 name 2 language 1033\r\n137636 INFO: Updating manifest in C:\\Users\\Administrator\\AppData\\Roaming\\pyinstaller\\bincache00_py35_64bit\\numpy.linalg._umath_linalg.pyd\r\n137636 INFO: Updating resource type 24 name 2 language 1033\r\n137683 INFO: Updating manifest in C:\\Users\\Administrator\\AppData\\Roaming\\pyinstaller\\bincache00_py35_64bit\\numpy.linalg.lapack_lite.pyd\r\n137683 INFO: Updating resource type 24 name 2 language 1033\r\n141453 INFO: Building COLLECT out00-COLLECT.toc completed successfully.\r\n```\r\n\n", "before_files": [{"content": "'''\nEnchant Spelling: Implements spelling backend based on enchant.\n'''\n\n\nimport enchant\n\nfrom kivy.core.spelling import SpellingBase, NoSuchLangError\nfrom kivy.compat import PY2\n\n\nclass SpellingEnchant(SpellingBase):\n '''\n Spelling backend based on the enchant library.\n '''\n\n def __init__(self, language=None):\n self._language = None\n super(SpellingEnchant, self).__init__(language)\n\n def select_language(self, language):\n try:\n self._language = enchant.Dict(language)\n except enchant.DictNotFoundError:\n err = 'Enchant Backend: No language for \"%s\"' % (language, )\n raise NoSuchLangError(err)\n\n def list_languages(self):\n # Note: We do NOT return enchant.list_dicts because that also returns\n # the enchant dict objects and not only the language identifiers.\n return enchant.list_languages()\n\n def check(self, word):\n if not word:\n return None\n return self._language.check(word)\n\n def suggest(self, fragment):\n suggestions = self._language.suggest(fragment)\n # Don't show suggestions that are invalid\n suggestions = [s for s in suggestions if self.check(s)]\n if PY2:\n suggestions = [s.decode('utf-8') for s in suggestions]\n return suggestions\n", "path": "kivy/core/spelling/spelling_enchant.py"}], "after_files": [{"content": "'''\nEnchant Spelling\n================\n\nImplementation spelling backend based on enchant.\n\n.. warning:: pyenchant doesn't have dedicated build anymore for Windows/x64.\n See https://github.com/kivy/kivy/issues/5816 for more informations\n'''\n\n\nimport enchant\n\nfrom kivy.core.spelling import SpellingBase, NoSuchLangError\nfrom kivy.compat import PY2\n\n\nclass SpellingEnchant(SpellingBase):\n '''\n Spelling backend based on the enchant library.\n '''\n\n def __init__(self, language=None):\n self._language = None\n super(SpellingEnchant, self).__init__(language)\n\n def select_language(self, language):\n try:\n self._language = enchant.Dict(language)\n except enchant.DictNotFoundError:\n err = 'Enchant Backend: No language for \"%s\"' % (language, )\n raise NoSuchLangError(err)\n\n def list_languages(self):\n # Note: We do NOT return enchant.list_dicts because that also returns\n # the enchant dict objects and not only the language identifiers.\n return enchant.list_languages()\n\n def check(self, word):\n if not word:\n return None\n return self._language.check(word)\n\n def suggest(self, fragment):\n suggestions = self._language.suggest(fragment)\n # Don't show suggestions that are invalid\n suggestions = [s for s in suggestions if self.check(s)]\n if PY2:\n suggestions = [s.decode('utf-8') for s in suggestions]\n return suggestions\n", "path": "kivy/core/spelling/spelling_enchant.py"}]} |
gh_patches_debug_286 | rasdani/github-patches | git_diff | Cloud-CV__EvalAI-697 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Set default renderer to JSONRenderer in DRF backend
For reference: http://www.django-rest-framework.org/api-guide/renderers/#setting-the-renderers
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `settings/common.py`
Content:
```
1 """
2 Django settings for evalai project.
3
4 Generated by 'django-admin startproject' using Django 1.10.2.
5
6 For more information on this file, see
7 https://docs.djangoproject.com/en/1.10/topics/settings/
8
9 For the full list of settings and their values, see
10 https://docs.djangoproject.com/en/1.10/ref/settings/
11 """
12
13 import datetime
14 import os
15 import sys
16
17 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
18 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
19 APPS_DIR = os.path.join(BASE_DIR, 'apps')
20
21 sys.path.append(APPS_DIR)
22
23 # Quick-start development settings - unsuitable for production
24 # See https://docs.djangoproject.com/en/1.10/howto/deployment/checklist/
25
26 # SECURITY WARNING: keep the secret key used in production secret!
27 SECRET_KEY = os.environ.get('SECRET_KEY', 'random_secret_key')
28
29 # SECURITY WARNING: don't run with debug turned on in production!
30 DEBUG = True
31
32 ALLOWED_HOSTS = []
33
34
35 # Application definition
36
37 DEFAULT_APPS = [
38 'django.contrib.admin',
39 'django.contrib.auth',
40 'django.contrib.contenttypes',
41 'django.contrib.sessions',
42 'django.contrib.messages',
43 'django.contrib.staticfiles',
44 'django.contrib.sites',
45 ]
46
47 OUR_APPS = [
48 'accounts',
49 'analytics',
50 'base',
51 'challenges',
52 'hosts',
53 'jobs',
54 'participants',
55 'submissions',
56 'web',
57 ]
58
59 THIRD_PARTY_APPS = [
60 'allauth',
61 'allauth.account',
62 'corsheaders',
63 'rest_auth',
64 'rest_auth.registration',
65 'rest_framework.authtoken',
66 'rest_framework',
67 'rest_framework_docs',
68 'rest_framework_expiring_authtoken',
69 ]
70
71 INSTALLED_APPS = DEFAULT_APPS + OUR_APPS + THIRD_PARTY_APPS
72
73 MIDDLEWARE = [
74 'corsheaders.middleware.CorsMiddleware',
75 'django.middleware.security.SecurityMiddleware',
76 'django.contrib.sessions.middleware.SessionMiddleware',
77 'django.middleware.common.CommonMiddleware',
78 'django.middleware.csrf.CsrfViewMiddleware',
79 'django.contrib.auth.middleware.AuthenticationMiddleware',
80 'django.contrib.messages.middleware.MessageMiddleware',
81 'django.middleware.clickjacking.XFrameOptionsMiddleware',
82 ]
83
84 ROOT_URLCONF = 'evalai.urls'
85
86
87 TEMPLATES = [
88 {
89 'BACKEND': 'django.template.backends.django.DjangoTemplates',
90 'DIRS': [],
91 'APP_DIRS': True,
92 'OPTIONS': {
93 'context_processors': [
94 'django.template.context_processors.debug',
95 'django.template.context_processors.request',
96 'django.contrib.auth.context_processors.auth',
97 'django.contrib.messages.context_processors.messages',
98 ],
99 },
100 },
101 ]
102
103 WSGI_APPLICATION = 'evalai.wsgi.application'
104
105
106 # Password validation
107 # https://docs.djangoproject.com/en/1.10/ref/settings/#auth-password-validators
108
109 AUTH_PASSWORD_VALIDATORS = [
110 {
111 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', # noqa
112 },
113 {
114 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', # noqa
115 },
116 {
117 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', # noqa
118 },
119 {
120 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', # noqa
121 },
122 ]
123
124
125 # Internationalization
126 # https://docs.djangoproject.com/en/1.10/topics/i18n/
127
128 LANGUAGE_CODE = 'en-us'
129
130 TIME_ZONE = 'UTC'
131
132 USE_I18N = True
133
134 USE_L10N = True
135
136 USE_TZ = True
137
138 # Static files (CSS, JavaScript, Images)
139 # https://docs.djangoproject.com/en/1.10/howto/static-files/
140
141 STATIC_URL = '/static/'
142
143 MEDIA_ROOT = os.path.join(BASE_DIR, 'media')
144 MEDIA_URL = "/media/"
145
146 SITE_ID = 1
147
148 REST_FRAMEWORK = {
149 'DEFAULT_PAGINATION_CLASS': (
150 'rest_framework.pagination.LimitOffsetPagination'),
151 'PAGE_SIZE': 10,
152 'DEFAULT_PERMISSION_CLASSES': [
153 'rest_framework.permissions.IsAuthenticatedOrReadOnly'
154 ],
155 'DEFAULT_AUTHENTICATION_CLASSES': [
156 'rest_framework_expiring_authtoken.authentication.ExpiringTokenAuthentication',
157 ],
158 'TEST_REQUEST_DEFAULT_FORMAT': 'json',
159 'DEFAULT_THROTTLE_CLASSES': (
160 'rest_framework.throttling.AnonRateThrottle',
161 'rest_framework.throttling.UserRateThrottle'
162 ),
163 'DEFAULT_THROTTLE_RATES': {
164 'anon': '100/minute',
165 'user': '100/minute'
166 }
167 }
168
169 # ALLAUTH SETTINGS
170 ACCOUNT_EMAIL_REQUIRED = True
171 OLD_PASSWORD_FIELD_ENABLED = True
172
173 AUTHENTICATION_BACKENDS = (
174 # Needed to login by username in Django admin, regardless of `allauth`
175 'django.contrib.auth.backends.ModelBackend',
176 # `allauth` specific authentication methods, such as login by e-mail
177 'allauth.account.auth_backends.AuthenticationBackend',
178 )
179
180 # CORS Settings
181 CORS_ORIGIN_ALLOW_ALL = True
182
183 # REST Framework Expiring Tokens Configuration
184 EXPIRING_TOKEN_LIFESPAN = datetime.timedelta(days=7)
185
186 # Logging
187 LOGGING = {
188 'version': 1,
189 'disable_existing_loggers': False,
190 'root': {
191 'level': 'INFO',
192 'handlers': ['console'],
193 },
194 'filters': {
195 'require_debug_false': {
196 '()': 'django.utils.log.RequireDebugFalse',
197 },
198 'require_debug_true': {
199 '()': 'django.utils.log.RequireDebugTrue',
200 }
201 },
202 'formatters': {
203 'simple': {
204 'format': '[%(asctime)s] %(levelname)s %(message)s',
205 'datefmt': '%Y-%m-%d %H:%M:%S'
206 },
207 'verbose': {
208 'format': '[%(asctime)s] %(levelname)s %(module)s %(message)s',
209 'datefmt': '%Y-%m-%d %H:%M:%S'
210 }
211 },
212 'handlers': {
213 'console': {
214 'level': 'INFO',
215 'filters': ['require_debug_true'],
216 'class': 'logging.StreamHandler',
217 'formatter': 'simple'
218 },
219 'logfile': {
220 'level': 'DEBUG',
221 'class': 'logging.handlers.RotatingFileHandler',
222 'filename': "/tmp/logfile",
223 'maxBytes': 50000,
224 'backupCount': 10,
225 'formatter': 'verbose'
226 },
227 'mail_admins': {
228 'level': 'ERROR',
229 'class': 'django.utils.log.AdminEmailHandler',
230 'filters': ['require_debug_false'],
231 }
232 },
233 'loggers': {
234 'django': {
235 'handlers': ['console'],
236 'propagate': True,
237 },
238 'django.request': {
239 'handlers': ['mail_admins'],
240 'level': 'ERROR',
241 'propagate': False,
242 },
243 'django.security': {
244 'handlers': ['mail_admins'],
245 'level': 'ERROR',
246 'propagate': False,
247 },
248 'django.db.backends': {
249 'handlers': ['mail_admins'],
250 'level': 'ERROR',
251 'propagate': False,
252 }
253 }
254 }
255
256 CACHES = {
257 'default': {
258 'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
259 }
260 }
261
```
--- 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/settings/common.py b/settings/common.py
--- a/settings/common.py
+++ b/settings/common.py
@@ -163,7 +163,10 @@
'DEFAULT_THROTTLE_RATES': {
'anon': '100/minute',
'user': '100/minute'
- }
+ },
+ 'DEFAULT_RENDERER_CLASSES': (
+ 'rest_framework.renderers.JSONRenderer',
+ )
}
# ALLAUTH SETTINGS
| {"golden_diff": "diff --git a/settings/common.py b/settings/common.py\n--- a/settings/common.py\n+++ b/settings/common.py\n@@ -163,7 +163,10 @@\n 'DEFAULT_THROTTLE_RATES': {\n 'anon': '100/minute',\n 'user': '100/minute'\n- }\n+ },\n+ 'DEFAULT_RENDERER_CLASSES': (\n+ 'rest_framework.renderers.JSONRenderer',\n+ )\n }\n \n # ALLAUTH SETTINGS\n", "issue": "Set default renderer to JSONRenderer in DRF backend\nFor reference: http://www.django-rest-framework.org/api-guide/renderers/#setting-the-renderers\n", "before_files": [{"content": "\"\"\"\nDjango settings for evalai project.\n\nGenerated by 'django-admin startproject' using Django 1.10.2.\n\nFor more information on this file, see\nhttps://docs.djangoproject.com/en/1.10/topics/settings/\n\nFor the full list of settings and their values, see\nhttps://docs.djangoproject.com/en/1.10/ref/settings/\n\"\"\"\n\nimport datetime\nimport os\nimport sys\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__)))\nAPPS_DIR = os.path.join(BASE_DIR, 'apps')\n\nsys.path.append(APPS_DIR)\n\n# Quick-start development settings - unsuitable for production\n# See https://docs.djangoproject.com/en/1.10/howto/deployment/checklist/\n\n# SECURITY WARNING: keep the secret key used in production secret!\nSECRET_KEY = os.environ.get('SECRET_KEY', 'random_secret_key')\n\n# SECURITY WARNING: don't run with debug turned on in production!\nDEBUG = True\n\nALLOWED_HOSTS = []\n\n\n# Application definition\n\nDEFAULT_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.sites',\n]\n\nOUR_APPS = [\n 'accounts',\n 'analytics',\n 'base',\n 'challenges',\n 'hosts',\n 'jobs',\n 'participants',\n 'submissions',\n 'web',\n]\n\nTHIRD_PARTY_APPS = [\n 'allauth',\n 'allauth.account',\n 'corsheaders',\n 'rest_auth',\n 'rest_auth.registration',\n 'rest_framework.authtoken',\n 'rest_framework',\n 'rest_framework_docs',\n 'rest_framework_expiring_authtoken',\n]\n\nINSTALLED_APPS = DEFAULT_APPS + OUR_APPS + THIRD_PARTY_APPS\n\nMIDDLEWARE = [\n 'corsheaders.middleware.CorsMiddleware',\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 = 'evalai.urls'\n\n\nTEMPLATES = [\n {\n 'BACKEND': 'django.template.backends.django.DjangoTemplates',\n 'DIRS': [],\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\nWSGI_APPLICATION = 'evalai.wsgi.application'\n\n\n# Password validation\n# https://docs.djangoproject.com/en/1.10/ref/settings/#auth-password-validators\n\nAUTH_PASSWORD_VALIDATORS = [\n {\n 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', # noqa\n },\n {\n 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', # noqa\n },\n {\n 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', # noqa\n },\n {\n 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', # noqa\n },\n]\n\n\n# Internationalization\n# https://docs.djangoproject.com/en/1.10/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# Static files (CSS, JavaScript, Images)\n# https://docs.djangoproject.com/en/1.10/howto/static-files/\n\nSTATIC_URL = '/static/'\n\nMEDIA_ROOT = os.path.join(BASE_DIR, 'media')\nMEDIA_URL = \"/media/\"\n\nSITE_ID = 1\n\nREST_FRAMEWORK = {\n 'DEFAULT_PAGINATION_CLASS': (\n 'rest_framework.pagination.LimitOffsetPagination'),\n 'PAGE_SIZE': 10,\n 'DEFAULT_PERMISSION_CLASSES': [\n 'rest_framework.permissions.IsAuthenticatedOrReadOnly'\n ],\n 'DEFAULT_AUTHENTICATION_CLASSES': [\n 'rest_framework_expiring_authtoken.authentication.ExpiringTokenAuthentication',\n ],\n 'TEST_REQUEST_DEFAULT_FORMAT': 'json',\n 'DEFAULT_THROTTLE_CLASSES': (\n 'rest_framework.throttling.AnonRateThrottle',\n 'rest_framework.throttling.UserRateThrottle'\n ),\n 'DEFAULT_THROTTLE_RATES': {\n 'anon': '100/minute',\n 'user': '100/minute'\n }\n}\n\n# ALLAUTH SETTINGS\nACCOUNT_EMAIL_REQUIRED = True\nOLD_PASSWORD_FIELD_ENABLED = True\n\nAUTHENTICATION_BACKENDS = (\n # Needed to login by username in Django admin, regardless of `allauth`\n 'django.contrib.auth.backends.ModelBackend',\n # `allauth` specific authentication methods, such as login by e-mail\n 'allauth.account.auth_backends.AuthenticationBackend',\n)\n\n# CORS Settings\nCORS_ORIGIN_ALLOW_ALL = True\n\n# REST Framework Expiring Tokens Configuration\nEXPIRING_TOKEN_LIFESPAN = datetime.timedelta(days=7)\n\n# Logging\nLOGGING = {\n 'version': 1,\n 'disable_existing_loggers': False,\n 'root': {\n 'level': 'INFO',\n 'handlers': ['console'],\n },\n 'filters': {\n 'require_debug_false': {\n '()': 'django.utils.log.RequireDebugFalse',\n },\n 'require_debug_true': {\n '()': 'django.utils.log.RequireDebugTrue',\n }\n },\n 'formatters': {\n 'simple': {\n 'format': '[%(asctime)s] %(levelname)s %(message)s',\n 'datefmt': '%Y-%m-%d %H:%M:%S'\n },\n 'verbose': {\n 'format': '[%(asctime)s] %(levelname)s %(module)s %(message)s',\n 'datefmt': '%Y-%m-%d %H:%M:%S'\n }\n },\n 'handlers': {\n 'console': {\n 'level': 'INFO',\n 'filters': ['require_debug_true'],\n 'class': 'logging.StreamHandler',\n 'formatter': 'simple'\n },\n 'logfile': {\n 'level': 'DEBUG',\n 'class': 'logging.handlers.RotatingFileHandler',\n 'filename': \"/tmp/logfile\",\n 'maxBytes': 50000,\n 'backupCount': 10,\n 'formatter': 'verbose'\n },\n 'mail_admins': {\n 'level': 'ERROR',\n 'class': 'django.utils.log.AdminEmailHandler',\n 'filters': ['require_debug_false'],\n }\n },\n 'loggers': {\n 'django': {\n 'handlers': ['console'],\n 'propagate': True,\n },\n 'django.request': {\n 'handlers': ['mail_admins'],\n 'level': 'ERROR',\n 'propagate': False,\n },\n 'django.security': {\n 'handlers': ['mail_admins'],\n 'level': 'ERROR',\n 'propagate': False,\n },\n 'django.db.backends': {\n 'handlers': ['mail_admins'],\n 'level': 'ERROR',\n 'propagate': False,\n }\n }\n}\n\nCACHES = {\n 'default': {\n 'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',\n }\n}\n", "path": "settings/common.py"}], "after_files": [{"content": "\"\"\"\nDjango settings for evalai project.\n\nGenerated by 'django-admin startproject' using Django 1.10.2.\n\nFor more information on this file, see\nhttps://docs.djangoproject.com/en/1.10/topics/settings/\n\nFor the full list of settings and their values, see\nhttps://docs.djangoproject.com/en/1.10/ref/settings/\n\"\"\"\n\nimport datetime\nimport os\nimport sys\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__)))\nAPPS_DIR = os.path.join(BASE_DIR, 'apps')\n\nsys.path.append(APPS_DIR)\n\n# Quick-start development settings - unsuitable for production\n# See https://docs.djangoproject.com/en/1.10/howto/deployment/checklist/\n\n# SECURITY WARNING: keep the secret key used in production secret!\nSECRET_KEY = os.environ.get('SECRET_KEY', 'random_secret_key')\n\n# SECURITY WARNING: don't run with debug turned on in production!\nDEBUG = True\n\nALLOWED_HOSTS = []\n\n\n# Application definition\n\nDEFAULT_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.sites',\n]\n\nOUR_APPS = [\n 'accounts',\n 'analytics',\n 'base',\n 'challenges',\n 'hosts',\n 'jobs',\n 'participants',\n 'submissions',\n 'web',\n]\n\nTHIRD_PARTY_APPS = [\n 'allauth',\n 'allauth.account',\n 'corsheaders',\n 'rest_auth',\n 'rest_auth.registration',\n 'rest_framework.authtoken',\n 'rest_framework',\n 'rest_framework_docs',\n 'rest_framework_expiring_authtoken',\n]\n\nINSTALLED_APPS = DEFAULT_APPS + OUR_APPS + THIRD_PARTY_APPS\n\nMIDDLEWARE = [\n 'corsheaders.middleware.CorsMiddleware',\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 = 'evalai.urls'\n\n\nTEMPLATES = [\n {\n 'BACKEND': 'django.template.backends.django.DjangoTemplates',\n 'DIRS': [],\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\nWSGI_APPLICATION = 'evalai.wsgi.application'\n\n\n# Password validation\n# https://docs.djangoproject.com/en/1.10/ref/settings/#auth-password-validators\n\nAUTH_PASSWORD_VALIDATORS = [\n {\n 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', # noqa\n },\n {\n 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', # noqa\n },\n {\n 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', # noqa\n },\n {\n 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', # noqa\n },\n]\n\n\n# Internationalization\n# https://docs.djangoproject.com/en/1.10/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# Static files (CSS, JavaScript, Images)\n# https://docs.djangoproject.com/en/1.10/howto/static-files/\n\nSTATIC_URL = '/static/'\n\nMEDIA_ROOT = os.path.join(BASE_DIR, 'media')\nMEDIA_URL = \"/media/\"\n\nSITE_ID = 1\n\nREST_FRAMEWORK = {\n 'DEFAULT_PAGINATION_CLASS': (\n 'rest_framework.pagination.LimitOffsetPagination'),\n 'PAGE_SIZE': 10,\n 'DEFAULT_PERMISSION_CLASSES': [\n 'rest_framework.permissions.IsAuthenticatedOrReadOnly'\n ],\n 'DEFAULT_AUTHENTICATION_CLASSES': [\n 'rest_framework_expiring_authtoken.authentication.ExpiringTokenAuthentication',\n ],\n 'TEST_REQUEST_DEFAULT_FORMAT': 'json',\n 'DEFAULT_THROTTLE_CLASSES': (\n 'rest_framework.throttling.AnonRateThrottle',\n 'rest_framework.throttling.UserRateThrottle'\n ),\n 'DEFAULT_THROTTLE_RATES': {\n 'anon': '100/minute',\n 'user': '100/minute'\n },\n 'DEFAULT_RENDERER_CLASSES': (\n 'rest_framework.renderers.JSONRenderer',\n )\n}\n\n# ALLAUTH SETTINGS\nACCOUNT_EMAIL_REQUIRED = True\nOLD_PASSWORD_FIELD_ENABLED = True\n\nAUTHENTICATION_BACKENDS = (\n # Needed to login by username in Django admin, regardless of `allauth`\n 'django.contrib.auth.backends.ModelBackend',\n # `allauth` specific authentication methods, such as login by e-mail\n 'allauth.account.auth_backends.AuthenticationBackend',\n)\n\n# CORS Settings\nCORS_ORIGIN_ALLOW_ALL = True\n\n# REST Framework Expiring Tokens Configuration\nEXPIRING_TOKEN_LIFESPAN = datetime.timedelta(days=7)\n\n# Logging\nLOGGING = {\n 'version': 1,\n 'disable_existing_loggers': False,\n 'root': {\n 'level': 'INFO',\n 'handlers': ['console'],\n },\n 'filters': {\n 'require_debug_false': {\n '()': 'django.utils.log.RequireDebugFalse',\n },\n 'require_debug_true': {\n '()': 'django.utils.log.RequireDebugTrue',\n }\n },\n 'formatters': {\n 'simple': {\n 'format': '[%(asctime)s] %(levelname)s %(message)s',\n 'datefmt': '%Y-%m-%d %H:%M:%S'\n },\n 'verbose': {\n 'format': '[%(asctime)s] %(levelname)s %(module)s %(message)s',\n 'datefmt': '%Y-%m-%d %H:%M:%S'\n }\n },\n 'handlers': {\n 'console': {\n 'level': 'INFO',\n 'filters': ['require_debug_true'],\n 'class': 'logging.StreamHandler',\n 'formatter': 'simple'\n },\n 'logfile': {\n 'level': 'DEBUG',\n 'class': 'logging.handlers.RotatingFileHandler',\n 'filename': \"/tmp/logfile\",\n 'maxBytes': 50000,\n 'backupCount': 10,\n 'formatter': 'verbose'\n },\n 'mail_admins': {\n 'level': 'ERROR',\n 'class': 'django.utils.log.AdminEmailHandler',\n 'filters': ['require_debug_false'],\n }\n },\n 'loggers': {\n 'django': {\n 'handlers': ['console'],\n 'propagate': True,\n },\n 'django.request': {\n 'handlers': ['mail_admins'],\n 'level': 'ERROR',\n 'propagate': False,\n },\n 'django.security': {\n 'handlers': ['mail_admins'],\n 'level': 'ERROR',\n 'propagate': False,\n },\n 'django.db.backends': {\n 'handlers': ['mail_admins'],\n 'level': 'ERROR',\n 'propagate': False,\n }\n }\n}\n\nCACHES = {\n 'default': {\n 'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',\n }\n}\n", "path": "settings/common.py"}]} |
gh_patches_debug_287 | rasdani/github-patches | git_diff | deis__deis-2001 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
underscores in app names cause logger to fail
I setup a new cluster from master. I tried stop and start but I still see the logger going into the "failed" state.
$ fleetctl journal deis-logger
-- Logs begin at Wed 2014-09-17 15:16:23 UTC, end at Wed 2014-09-17 21:29:41 UTC. --
Sep 17 19:58:35 ip-10-21-1-61.ec2.internal sh[7485]: /usr/local/go/src/pkg/net/udpsock_posix.go:82 +0x142
Sep 17 19:58:35 ip-10-21-1-61.ec2.internal sh[7485]: github.com/deis/deis/logger/syslog.(_Server).receiver(0xc2080182d0, 0x7f5cd6d384f8, 0xc20803a028)
Sep 17 19:58:35 ip-10-21-1-61.ec2.internal sh[7485]: /go/src/github.com/deis/deis/logger/syslog/server.go:106 +0xab
Sep 17 19:58:35 ip-10-21-1-61.ec2.internal sh[7485]: created by github.com/deis/deis/logger/syslog.(_Server).Listen
Sep 17 19:58:35 ip-10-21-1-61.ec2.internal sh[7485]: /go/src/github.com/deis/deis/logger/syslog/server.go:67 +0x286
Sep 17 19:58:40 ip-10-21-1-61.ec2.internal systemd[1]: deis-logger.service: main process exited, code=exited, status=1/FAILURE
Sep 17 19:58:40 ip-10-21-1-61.ec2.internal systemd[1]: deis-logger.service: control process exited, code=exited status=1
Sep 17 19:58:40 ip-10-21-1-61.ec2.internal systemd[1]: Unit deis-logger.service entered failed state.
Sep 17 19:58:40 ip-10-21-1-61.ec2.internal docker[13190]: Error response from daemon: No such container: deis-logger
Sep 17 19:58:40 ip-10-21-1-61.ec2.internal docker[13190]: 2014/09/17 19:58:40 Error: failed to stop one or more containers
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `controller/scheduler/coreos.py`
Content:
```
1 import cStringIO
2 import base64
3 import copy
4 import functools
5 import json
6 import httplib
7 import paramiko
8 import socket
9 import re
10 import time
11
12
13 MATCH = re.compile(
14 '(?P<app>[a-z0-9-]+)_?(?P<version>v[0-9]+)?\.?(?P<c_type>[a-z]+)?.(?P<c_num>[0-9]+)')
15
16
17 class UHTTPConnection(httplib.HTTPConnection):
18 """Subclass of Python library HTTPConnection that uses a Unix domain socket.
19 """
20
21 def __init__(self, path):
22 httplib.HTTPConnection.__init__(self, 'localhost')
23 self.path = path
24
25 def connect(self):
26 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
27 sock.connect(self.path)
28 self.sock = sock
29
30
31 class FleetHTTPClient(object):
32
33 def __init__(self, cluster_name, hosts, auth, domain, options):
34 self.name = cluster_name
35 self.hosts = hosts
36 self.auth = auth
37 self.domain = domain
38 self.options = options
39 # single global connection
40 self.conn = UHTTPConnection('/var/run/fleet.sock')
41
42 # scheduler setup / teardown
43
44 def setUp(self):
45 pass
46
47 def tearDown(self):
48 pass
49
50 # connection helpers
51
52 def _put_unit(self, name, body):
53 headers = {'Content-Type': 'application/json'}
54 self.conn.request('PUT', '/v1-alpha/units/{name}.service'.format(**locals()),
55 headers=headers, body=json.dumps(body))
56 resp = self.conn.getresponse()
57 data = resp.read()
58 if resp.status != 204:
59 errmsg = "Failed to create unit: {} {} - {}".format(
60 resp.status, resp.reason, data)
61 raise RuntimeError(errmsg)
62 return data
63
64 def _delete_unit(self, name):
65 headers = {'Content-Type': 'application/json'}
66 self.conn.request('DELETE', '/v1-alpha/units/{name}.service'.format(**locals()),
67 headers=headers)
68 resp = self.conn.getresponse()
69 data = resp.read()
70 if resp.status not in (404, 204):
71 errmsg = "Failed to delete unit: {} {} - {}".format(
72 resp.status, resp.reason, data)
73 raise RuntimeError(errmsg)
74 return data
75
76 def _get_state(self, name=None):
77 headers = {'Content-Type': 'application/json'}
78 url = '/v1-alpha/state'
79 if name:
80 url += '?unitName={name}.service'.format(**locals())
81 self.conn.request('GET', url, headers=headers)
82 resp = self.conn.getresponse()
83 data = resp.read()
84 if resp.status not in (200,):
85 errmsg = "Failed to retrieve state: {} {} - {}".format(
86 resp.status, resp.reason, data)
87 raise RuntimeError(errmsg)
88 return json.loads(data)
89
90 def _get_machines(self):
91 headers = {'Content-Type': 'application/json'}
92 url = '/v1-alpha/machines'
93 self.conn.request('GET', url, headers=headers)
94 resp = self.conn.getresponse()
95 data = resp.read()
96 if resp.status not in (200,):
97 errmsg = "Failed to retrieve machines: {} {} - {}".format(
98 resp.status, resp.reason, data)
99 raise RuntimeError(errmsg)
100 return json.loads(data)
101
102 # container api
103
104 def create(self, name, image, command='', template=None, **kwargs):
105 """Create a container"""
106 self._create_container(name, image, command,
107 template or copy.deepcopy(CONTAINER_TEMPLATE), **kwargs)
108 self._create_log(name, image, command, copy.deepcopy(LOG_TEMPLATE))
109
110 def _create_container(self, name, image, command, unit, **kwargs):
111 l = locals().copy()
112 l.update(re.match(MATCH, name).groupdict())
113 # prepare memory limit for the container type
114 mem = kwargs.get('memory', {}).get(l['c_type'], None)
115 if mem:
116 l.update({'memory': '-m {}'.format(mem.lower())})
117 else:
118 l.update({'memory': ''})
119 # prepare memory limit for the container type
120 cpu = kwargs.get('cpu', {}).get(l['c_type'], None)
121 if cpu:
122 l.update({'cpu': '-c {}'.format(cpu)})
123 else:
124 l.update({'cpu': ''})
125 # construct unit from template
126 for f in unit:
127 f['value'] = f['value'].format(**l)
128 # prepare tags only if one was provided
129 tags = kwargs.get('tags', {})
130 if tags:
131 tagset = ' '.join(['"{}={}"'.format(k, v) for k, v in tags.items()])
132 unit.append({"section": "X-Fleet", "name": "MachineMetadata",
133 "value": tagset})
134 # post unit to fleet
135 self._put_unit(name, {"desiredState": "launched", "options": unit})
136
137 def _create_log(self, name, image, command, unit):
138 l = locals().copy()
139 l.update(re.match(MATCH, name).groupdict())
140 # construct unit from template
141 for f in unit:
142 f['value'] = f['value'].format(**l)
143 # post unit to fleet
144 self._put_unit(name+'-log', {"desiredState": "launched", "options": unit})
145
146 def start(self, name):
147 """Start a container"""
148 self._wait_for_container(name)
149
150 def _wait_for_container(self, name):
151 # we bump to 20 minutes here to match the timeout on the router and in the app unit files
152 for _ in range(1200):
153 states = self._get_state(name)
154 if states and len(states.get('states', [])) == 1:
155 state = states.get('states')[0]
156 subState = state.get('systemdSubState')
157 if subState == 'running' or subState == 'exited':
158 break
159 elif subState == 'failed':
160 raise RuntimeError('container failed to start')
161 time.sleep(1)
162 else:
163 raise RuntimeError('container failed to start')
164
165 def _wait_for_destroy(self, name):
166 for _ in range(30):
167 states = self._get_state(name)
168 if not states:
169 break
170 time.sleep(1)
171 else:
172 raise RuntimeError('timeout on container destroy')
173
174 def stop(self, name):
175 """Stop a container"""
176 raise NotImplementedError
177
178 def destroy(self, name):
179 """Destroy a container"""
180 funcs = []
181 funcs.append(functools.partial(self._destroy_container, name))
182 funcs.append(functools.partial(self._destroy_log, name))
183 # call all destroy functions, ignoring any errors
184 for f in funcs:
185 try:
186 f()
187 except:
188 pass
189 self._wait_for_destroy(name)
190
191 def _destroy_container(self, name):
192 return self._delete_unit(name)
193
194 def _destroy_log(self, name):
195 return self._delete_unit(name+'-log')
196
197 def run(self, name, image, command): # noqa
198 """Run a one-off command"""
199 self._create_container(name, image, command, copy.deepcopy(RUN_TEMPLATE))
200
201 # wait for the container to get scheduled
202 for _ in range(30):
203 states = self._get_state(name)
204 if states and len(states.get('states', [])) == 1:
205 state = states.get('states')[0]
206 break
207 time.sleep(1)
208 else:
209 raise RuntimeError('container did not report state')
210 machineID = state.get('machineID')
211
212 # find the machine
213 machines = self._get_machines()
214 if not machines:
215 raise RuntimeError('no available hosts to run command')
216
217 # find the machine's primaryIP
218 primaryIP = None
219 for m in machines.get('machines', []):
220 if m['id'] == machineID:
221 primaryIP = m['primaryIP']
222 if not primaryIP:
223 raise RuntimeError('could not find host')
224
225 # prepare ssh key
226 file_obj = cStringIO.StringIO(base64.b64decode(self.auth))
227 pkey = paramiko.RSAKey(file_obj=file_obj)
228
229 # grab output via docker logs over SSH
230 ssh = paramiko.SSHClient()
231 ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
232 ssh.connect(primaryIP, username="core", pkey=pkey)
233 # share a transport
234 tran = ssh.get_transport()
235
236 def _do_ssh(cmd):
237 chan = tran.open_session()
238 # get a pty so stdout/stderr look right
239 chan.get_pty()
240 out = chan.makefile()
241 chan.exec_command(cmd)
242 rc, output = chan.recv_exit_status(), out.read()
243 return rc, output
244
245 # wait for container to start
246 for _ in range(1200):
247 rc, _ = _do_ssh('docker inspect {name}'.format(**locals()))
248 if rc == 0:
249 break
250 time.sleep(1)
251 else:
252 raise RuntimeError('container failed to start on host')
253
254 # wait for container to complete
255 for _ in range(1200):
256 _rc, _output = _do_ssh('docker inspect {name}'.format(**locals()))
257 if _rc != 0:
258 raise RuntimeError('failed to inspect container')
259 _container = json.loads(_output)
260 finished_at = _container[0]["State"]["FinishedAt"]
261 if not finished_at.startswith('0001'):
262 break
263 time.sleep(1)
264 else:
265 raise RuntimeError('container timed out')
266
267 # gather container output
268 _rc, output = _do_ssh('docker logs {name}'.format(**locals()))
269 if _rc != 0:
270 raise RuntimeError('could not attach to container')
271
272 # determine container exit code
273 _rc, _output = _do_ssh('docker inspect {name}'.format(**locals()))
274 if _rc != 0:
275 raise RuntimeError('could not determine exit code')
276 container = json.loads(_output)
277 rc = container[0]["State"]["ExitCode"]
278
279 # cleanup
280 self._destroy_container(name)
281 self._wait_for_destroy(name)
282
283 # return rc and output
284 return rc, output
285
286 def attach(self, name):
287 """
288 Attach to a job's stdin, stdout and stderr
289 """
290 raise NotImplementedError
291
292 SchedulerClient = FleetHTTPClient
293
294
295 CONTAINER_TEMPLATE = [
296 {"section": "Unit", "name": "Description", "value": "{name}"},
297 {"section": "Service", "name": "ExecStartPre", "value": '''/bin/sh -c "IMAGE=$(etcdctl get /deis/registry/host 2>&1):$(etcdctl get /deis/registry/port 2>&1)/{image}; docker pull $IMAGE"'''}, # noqa
298 {"section": "Service", "name": "ExecStartPre", "value": '''/bin/sh -c "docker inspect {name} >/dev/null 2>&1 && docker rm -f {name} || true"'''}, # noqa
299 {"section": "Service", "name": "ExecStart", "value": '''/bin/sh -c "IMAGE=$(etcdctl get /deis/registry/host 2>&1):$(etcdctl get /deis/registry/port 2>&1)/{image}; port=$(docker inspect -f '{{{{range $k, $v := .ContainerConfig.ExposedPorts }}}}{{{{$k}}}}{{{{end}}}}' $IMAGE | cut -d/ -f1) ; docker run --name {name} {memory} {cpu} -P -e PORT=$port $IMAGE {command}"'''}, # noqa
300 {"section": "Service", "name": "ExecStop", "value": '''/usr/bin/docker rm -f {name}'''},
301 {"section": "Service", "name": "TimeoutStartSec", "value": "20m"},
302 ]
303
304
305 LOG_TEMPLATE = [
306 {"section": "Unit", "name": "Description", "value": "{name} log"},
307 {"section": "Unit", "name": "BindsTo", "value": "{name}.service"},
308 {"section": "Service", "name": "ExecStartPre", "value": '''/bin/sh -c "until docker inspect {name} >/dev/null 2>&1; do sleep 1; done"'''}, # noqa
309 {"section": "Service", "name": "ExecStart", "value": '''/bin/sh -c "docker logs -f {name} 2>&1 | logger -p local0.info -t {app}[{c_type}.{c_num}] --udp --server $(etcdctl get /deis/logs/host) --port $(etcdctl get /deis/logs/port)"'''}, # noqa
310 {"section": "Service", "name": "TimeoutStartSec", "value": "20m"},
311 {"section": "X-Fleet", "name": "MachineOf", "value": "{name}.service"},
312 ]
313
314
315 RUN_TEMPLATE = [
316 {"section": "Unit", "name": "Description", "value": "{name} admin command"},
317 {"section": "Service", "name": "ExecStartPre", "value": '''/bin/sh -c "IMAGE=$(etcdctl get /deis/registry/host 2>&1):$(etcdctl get /deis/registry/port 2>&1)/{image}; docker pull $IMAGE"'''}, # noqa
318 {"section": "Service", "name": "ExecStartPre", "value": '''/bin/sh -c "docker inspect {name} >/dev/null 2>&1 && docker rm -f {name} || true"'''}, # noqa
319 {"section": "Service", "name": "ExecStart", "value": '''/bin/sh -c "IMAGE=$(etcdctl get /deis/registry/host 2>&1):$(etcdctl get /deis/registry/port 2>&1)/{image}; docker run --name {name} --entrypoint=/bin/bash -a stdout -a stderr $IMAGE -c '{command}'"'''}, # noqa
320 {"section": "Service", "name": "TimeoutStartSec", "value": "20m"},
321 ]
322
```
--- 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/controller/scheduler/coreos.py b/controller/scheduler/coreos.py
--- a/controller/scheduler/coreos.py
+++ b/controller/scheduler/coreos.py
@@ -11,7 +11,7 @@
MATCH = re.compile(
- '(?P<app>[a-z0-9-]+)_?(?P<version>v[0-9]+)?\.?(?P<c_type>[a-z]+)?.(?P<c_num>[0-9]+)')
+ '(?P<app>[a-z0-9-]+)_?(?P<version>v[0-9]+)?\.?(?P<c_type>[a-z-_]+)?.(?P<c_num>[0-9]+)')
class UHTTPConnection(httplib.HTTPConnection):
| {"golden_diff": "diff --git a/controller/scheduler/coreos.py b/controller/scheduler/coreos.py\n--- a/controller/scheduler/coreos.py\n+++ b/controller/scheduler/coreos.py\n@@ -11,7 +11,7 @@\n \n \n MATCH = re.compile(\n- '(?P<app>[a-z0-9-]+)_?(?P<version>v[0-9]+)?\\.?(?P<c_type>[a-z]+)?.(?P<c_num>[0-9]+)')\n+ '(?P<app>[a-z0-9-]+)_?(?P<version>v[0-9]+)?\\.?(?P<c_type>[a-z-_]+)?.(?P<c_num>[0-9]+)')\n \n \n class UHTTPConnection(httplib.HTTPConnection):\n", "issue": "underscores in app names cause logger to fail\nI setup a new cluster from master. I tried stop and start but I still see the logger going into the \"failed\" state. \n\n$ fleetctl journal deis-logger\n\n-- Logs begin at Wed 2014-09-17 15:16:23 UTC, end at Wed 2014-09-17 21:29:41 UTC. --\nSep 17 19:58:35 ip-10-21-1-61.ec2.internal sh[7485]: /usr/local/go/src/pkg/net/udpsock_posix.go:82 +0x142\nSep 17 19:58:35 ip-10-21-1-61.ec2.internal sh[7485]: github.com/deis/deis/logger/syslog.(_Server).receiver(0xc2080182d0, 0x7f5cd6d384f8, 0xc20803a028)\nSep 17 19:58:35 ip-10-21-1-61.ec2.internal sh[7485]: /go/src/github.com/deis/deis/logger/syslog/server.go:106 +0xab\nSep 17 19:58:35 ip-10-21-1-61.ec2.internal sh[7485]: created by github.com/deis/deis/logger/syslog.(_Server).Listen\nSep 17 19:58:35 ip-10-21-1-61.ec2.internal sh[7485]: /go/src/github.com/deis/deis/logger/syslog/server.go:67 +0x286\nSep 17 19:58:40 ip-10-21-1-61.ec2.internal systemd[1]: deis-logger.service: main process exited, code=exited, status=1/FAILURE\nSep 17 19:58:40 ip-10-21-1-61.ec2.internal systemd[1]: deis-logger.service: control process exited, code=exited status=1\nSep 17 19:58:40 ip-10-21-1-61.ec2.internal systemd[1]: Unit deis-logger.service entered failed state.\nSep 17 19:58:40 ip-10-21-1-61.ec2.internal docker[13190]: Error response from daemon: No such container: deis-logger\nSep 17 19:58:40 ip-10-21-1-61.ec2.internal docker[13190]: 2014/09/17 19:58:40 Error: failed to stop one or more containers\n\n", "before_files": [{"content": "import cStringIO\nimport base64\nimport copy\nimport functools\nimport json\nimport httplib\nimport paramiko\nimport socket\nimport re\nimport time\n\n\nMATCH = re.compile(\n '(?P<app>[a-z0-9-]+)_?(?P<version>v[0-9]+)?\\.?(?P<c_type>[a-z]+)?.(?P<c_num>[0-9]+)')\n\n\nclass UHTTPConnection(httplib.HTTPConnection):\n \"\"\"Subclass of Python library HTTPConnection that uses a Unix domain socket.\n \"\"\"\n\n def __init__(self, path):\n httplib.HTTPConnection.__init__(self, 'localhost')\n self.path = path\n\n def connect(self):\n sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)\n sock.connect(self.path)\n self.sock = sock\n\n\nclass FleetHTTPClient(object):\n\n def __init__(self, cluster_name, hosts, auth, domain, options):\n self.name = cluster_name\n self.hosts = hosts\n self.auth = auth\n self.domain = domain\n self.options = options\n # single global connection\n self.conn = UHTTPConnection('/var/run/fleet.sock')\n\n # scheduler setup / teardown\n\n def setUp(self):\n pass\n\n def tearDown(self):\n pass\n\n # connection helpers\n\n def _put_unit(self, name, body):\n headers = {'Content-Type': 'application/json'}\n self.conn.request('PUT', '/v1-alpha/units/{name}.service'.format(**locals()),\n headers=headers, body=json.dumps(body))\n resp = self.conn.getresponse()\n data = resp.read()\n if resp.status != 204:\n errmsg = \"Failed to create unit: {} {} - {}\".format(\n resp.status, resp.reason, data)\n raise RuntimeError(errmsg)\n return data\n\n def _delete_unit(self, name):\n headers = {'Content-Type': 'application/json'}\n self.conn.request('DELETE', '/v1-alpha/units/{name}.service'.format(**locals()),\n headers=headers)\n resp = self.conn.getresponse()\n data = resp.read()\n if resp.status not in (404, 204):\n errmsg = \"Failed to delete unit: {} {} - {}\".format(\n resp.status, resp.reason, data)\n raise RuntimeError(errmsg)\n return data\n\n def _get_state(self, name=None):\n headers = {'Content-Type': 'application/json'}\n url = '/v1-alpha/state'\n if name:\n url += '?unitName={name}.service'.format(**locals())\n self.conn.request('GET', url, headers=headers)\n resp = self.conn.getresponse()\n data = resp.read()\n if resp.status not in (200,):\n errmsg = \"Failed to retrieve state: {} {} - {}\".format(\n resp.status, resp.reason, data)\n raise RuntimeError(errmsg)\n return json.loads(data)\n\n def _get_machines(self):\n headers = {'Content-Type': 'application/json'}\n url = '/v1-alpha/machines'\n self.conn.request('GET', url, headers=headers)\n resp = self.conn.getresponse()\n data = resp.read()\n if resp.status not in (200,):\n errmsg = \"Failed to retrieve machines: {} {} - {}\".format(\n resp.status, resp.reason, data)\n raise RuntimeError(errmsg)\n return json.loads(data)\n\n # container api\n\n def create(self, name, image, command='', template=None, **kwargs):\n \"\"\"Create a container\"\"\"\n self._create_container(name, image, command,\n template or copy.deepcopy(CONTAINER_TEMPLATE), **kwargs)\n self._create_log(name, image, command, copy.deepcopy(LOG_TEMPLATE))\n\n def _create_container(self, name, image, command, unit, **kwargs):\n l = locals().copy()\n l.update(re.match(MATCH, name).groupdict())\n # prepare memory limit for the container type\n mem = kwargs.get('memory', {}).get(l['c_type'], None)\n if mem:\n l.update({'memory': '-m {}'.format(mem.lower())})\n else:\n l.update({'memory': ''})\n # prepare memory limit for the container type\n cpu = kwargs.get('cpu', {}).get(l['c_type'], None)\n if cpu:\n l.update({'cpu': '-c {}'.format(cpu)})\n else:\n l.update({'cpu': ''})\n # construct unit from template\n for f in unit:\n f['value'] = f['value'].format(**l)\n # prepare tags only if one was provided\n tags = kwargs.get('tags', {})\n if tags:\n tagset = ' '.join(['\"{}={}\"'.format(k, v) for k, v in tags.items()])\n unit.append({\"section\": \"X-Fleet\", \"name\": \"MachineMetadata\",\n \"value\": tagset})\n # post unit to fleet\n self._put_unit(name, {\"desiredState\": \"launched\", \"options\": unit})\n\n def _create_log(self, name, image, command, unit):\n l = locals().copy()\n l.update(re.match(MATCH, name).groupdict())\n # construct unit from template\n for f in unit:\n f['value'] = f['value'].format(**l)\n # post unit to fleet\n self._put_unit(name+'-log', {\"desiredState\": \"launched\", \"options\": unit})\n\n def start(self, name):\n \"\"\"Start a container\"\"\"\n self._wait_for_container(name)\n\n def _wait_for_container(self, name):\n # we bump to 20 minutes here to match the timeout on the router and in the app unit files\n for _ in range(1200):\n states = self._get_state(name)\n if states and len(states.get('states', [])) == 1:\n state = states.get('states')[0]\n subState = state.get('systemdSubState')\n if subState == 'running' or subState == 'exited':\n break\n elif subState == 'failed':\n raise RuntimeError('container failed to start')\n time.sleep(1)\n else:\n raise RuntimeError('container failed to start')\n\n def _wait_for_destroy(self, name):\n for _ in range(30):\n states = self._get_state(name)\n if not states:\n break\n time.sleep(1)\n else:\n raise RuntimeError('timeout on container destroy')\n\n def stop(self, name):\n \"\"\"Stop a container\"\"\"\n raise NotImplementedError\n\n def destroy(self, name):\n \"\"\"Destroy a container\"\"\"\n funcs = []\n funcs.append(functools.partial(self._destroy_container, name))\n funcs.append(functools.partial(self._destroy_log, name))\n # call all destroy functions, ignoring any errors\n for f in funcs:\n try:\n f()\n except:\n pass\n self._wait_for_destroy(name)\n\n def _destroy_container(self, name):\n return self._delete_unit(name)\n\n def _destroy_log(self, name):\n return self._delete_unit(name+'-log')\n\n def run(self, name, image, command): # noqa\n \"\"\"Run a one-off command\"\"\"\n self._create_container(name, image, command, copy.deepcopy(RUN_TEMPLATE))\n\n # wait for the container to get scheduled\n for _ in range(30):\n states = self._get_state(name)\n if states and len(states.get('states', [])) == 1:\n state = states.get('states')[0]\n break\n time.sleep(1)\n else:\n raise RuntimeError('container did not report state')\n machineID = state.get('machineID')\n\n # find the machine\n machines = self._get_machines()\n if not machines:\n raise RuntimeError('no available hosts to run command')\n\n # find the machine's primaryIP\n primaryIP = None\n for m in machines.get('machines', []):\n if m['id'] == machineID:\n primaryIP = m['primaryIP']\n if not primaryIP:\n raise RuntimeError('could not find host')\n\n # prepare ssh key\n file_obj = cStringIO.StringIO(base64.b64decode(self.auth))\n pkey = paramiko.RSAKey(file_obj=file_obj)\n\n # grab output via docker logs over SSH\n ssh = paramiko.SSHClient()\n ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())\n ssh.connect(primaryIP, username=\"core\", pkey=pkey)\n # share a transport\n tran = ssh.get_transport()\n\n def _do_ssh(cmd):\n chan = tran.open_session()\n # get a pty so stdout/stderr look right\n chan.get_pty()\n out = chan.makefile()\n chan.exec_command(cmd)\n rc, output = chan.recv_exit_status(), out.read()\n return rc, output\n\n # wait for container to start\n for _ in range(1200):\n rc, _ = _do_ssh('docker inspect {name}'.format(**locals()))\n if rc == 0:\n break\n time.sleep(1)\n else:\n raise RuntimeError('container failed to start on host')\n\n # wait for container to complete\n for _ in range(1200):\n _rc, _output = _do_ssh('docker inspect {name}'.format(**locals()))\n if _rc != 0:\n raise RuntimeError('failed to inspect container')\n _container = json.loads(_output)\n finished_at = _container[0][\"State\"][\"FinishedAt\"]\n if not finished_at.startswith('0001'):\n break\n time.sleep(1)\n else:\n raise RuntimeError('container timed out')\n\n # gather container output\n _rc, output = _do_ssh('docker logs {name}'.format(**locals()))\n if _rc != 0:\n raise RuntimeError('could not attach to container')\n\n # determine container exit code\n _rc, _output = _do_ssh('docker inspect {name}'.format(**locals()))\n if _rc != 0:\n raise RuntimeError('could not determine exit code')\n container = json.loads(_output)\n rc = container[0][\"State\"][\"ExitCode\"]\n\n # cleanup\n self._destroy_container(name)\n self._wait_for_destroy(name)\n\n # return rc and output\n return rc, output\n\n def attach(self, name):\n \"\"\"\n Attach to a job's stdin, stdout and stderr\n \"\"\"\n raise NotImplementedError\n\nSchedulerClient = FleetHTTPClient\n\n\nCONTAINER_TEMPLATE = [\n {\"section\": \"Unit\", \"name\": \"Description\", \"value\": \"{name}\"},\n {\"section\": \"Service\", \"name\": \"ExecStartPre\", \"value\": '''/bin/sh -c \"IMAGE=$(etcdctl get /deis/registry/host 2>&1):$(etcdctl get /deis/registry/port 2>&1)/{image}; docker pull $IMAGE\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"ExecStartPre\", \"value\": '''/bin/sh -c \"docker inspect {name} >/dev/null 2>&1 && docker rm -f {name} || true\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"ExecStart\", \"value\": '''/bin/sh -c \"IMAGE=$(etcdctl get /deis/registry/host 2>&1):$(etcdctl get /deis/registry/port 2>&1)/{image}; port=$(docker inspect -f '{{{{range $k, $v := .ContainerConfig.ExposedPorts }}}}{{{{$k}}}}{{{{end}}}}' $IMAGE | cut -d/ -f1) ; docker run --name {name} {memory} {cpu} -P -e PORT=$port $IMAGE {command}\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"ExecStop\", \"value\": '''/usr/bin/docker rm -f {name}'''},\n {\"section\": \"Service\", \"name\": \"TimeoutStartSec\", \"value\": \"20m\"},\n]\n\n\nLOG_TEMPLATE = [\n {\"section\": \"Unit\", \"name\": \"Description\", \"value\": \"{name} log\"},\n {\"section\": \"Unit\", \"name\": \"BindsTo\", \"value\": \"{name}.service\"},\n {\"section\": \"Service\", \"name\": \"ExecStartPre\", \"value\": '''/bin/sh -c \"until docker inspect {name} >/dev/null 2>&1; do sleep 1; done\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"ExecStart\", \"value\": '''/bin/sh -c \"docker logs -f {name} 2>&1 | logger -p local0.info -t {app}[{c_type}.{c_num}] --udp --server $(etcdctl get /deis/logs/host) --port $(etcdctl get /deis/logs/port)\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"TimeoutStartSec\", \"value\": \"20m\"},\n {\"section\": \"X-Fleet\", \"name\": \"MachineOf\", \"value\": \"{name}.service\"},\n]\n\n\nRUN_TEMPLATE = [\n {\"section\": \"Unit\", \"name\": \"Description\", \"value\": \"{name} admin command\"},\n {\"section\": \"Service\", \"name\": \"ExecStartPre\", \"value\": '''/bin/sh -c \"IMAGE=$(etcdctl get /deis/registry/host 2>&1):$(etcdctl get /deis/registry/port 2>&1)/{image}; docker pull $IMAGE\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"ExecStartPre\", \"value\": '''/bin/sh -c \"docker inspect {name} >/dev/null 2>&1 && docker rm -f {name} || true\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"ExecStart\", \"value\": '''/bin/sh -c \"IMAGE=$(etcdctl get /deis/registry/host 2>&1):$(etcdctl get /deis/registry/port 2>&1)/{image}; docker run --name {name} --entrypoint=/bin/bash -a stdout -a stderr $IMAGE -c '{command}'\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"TimeoutStartSec\", \"value\": \"20m\"},\n]\n", "path": "controller/scheduler/coreos.py"}], "after_files": [{"content": "import cStringIO\nimport base64\nimport copy\nimport functools\nimport json\nimport httplib\nimport paramiko\nimport socket\nimport re\nimport time\n\n\nMATCH = re.compile(\n '(?P<app>[a-z0-9-]+)_?(?P<version>v[0-9]+)?\\.?(?P<c_type>[a-z-_]+)?.(?P<c_num>[0-9]+)')\n\n\nclass UHTTPConnection(httplib.HTTPConnection):\n \"\"\"Subclass of Python library HTTPConnection that uses a Unix domain socket.\n \"\"\"\n\n def __init__(self, path):\n httplib.HTTPConnection.__init__(self, 'localhost')\n self.path = path\n\n def connect(self):\n sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)\n sock.connect(self.path)\n self.sock = sock\n\n\nclass FleetHTTPClient(object):\n\n def __init__(self, cluster_name, hosts, auth, domain, options):\n self.name = cluster_name\n self.hosts = hosts\n self.auth = auth\n self.domain = domain\n self.options = options\n # single global connection\n self.conn = UHTTPConnection('/var/run/fleet.sock')\n\n # scheduler setup / teardown\n\n def setUp(self):\n pass\n\n def tearDown(self):\n pass\n\n # connection helpers\n\n def _put_unit(self, name, body):\n headers = {'Content-Type': 'application/json'}\n self.conn.request('PUT', '/v1-alpha/units/{name}.service'.format(**locals()),\n headers=headers, body=json.dumps(body))\n resp = self.conn.getresponse()\n data = resp.read()\n if resp.status != 204:\n errmsg = \"Failed to create unit: {} {} - {}\".format(\n resp.status, resp.reason, data)\n raise RuntimeError(errmsg)\n return data\n\n def _delete_unit(self, name):\n headers = {'Content-Type': 'application/json'}\n self.conn.request('DELETE', '/v1-alpha/units/{name}.service'.format(**locals()),\n headers=headers)\n resp = self.conn.getresponse()\n data = resp.read()\n if resp.status not in (404, 204):\n errmsg = \"Failed to delete unit: {} {} - {}\".format(\n resp.status, resp.reason, data)\n raise RuntimeError(errmsg)\n return data\n\n def _get_state(self, name=None):\n headers = {'Content-Type': 'application/json'}\n url = '/v1-alpha/state'\n if name:\n url += '?unitName={name}.service'.format(**locals())\n self.conn.request('GET', url, headers=headers)\n resp = self.conn.getresponse()\n data = resp.read()\n if resp.status not in (200,):\n errmsg = \"Failed to retrieve state: {} {} - {}\".format(\n resp.status, resp.reason, data)\n raise RuntimeError(errmsg)\n return json.loads(data)\n\n def _get_machines(self):\n headers = {'Content-Type': 'application/json'}\n url = '/v1-alpha/machines'\n self.conn.request('GET', url, headers=headers)\n resp = self.conn.getresponse()\n data = resp.read()\n if resp.status not in (200,):\n errmsg = \"Failed to retrieve machines: {} {} - {}\".format(\n resp.status, resp.reason, data)\n raise RuntimeError(errmsg)\n return json.loads(data)\n\n # container api\n\n def create(self, name, image, command='', template=None, **kwargs):\n \"\"\"Create a container\"\"\"\n self._create_container(name, image, command,\n template or copy.deepcopy(CONTAINER_TEMPLATE), **kwargs)\n self._create_log(name, image, command, copy.deepcopy(LOG_TEMPLATE))\n\n def _create_container(self, name, image, command, unit, **kwargs):\n l = locals().copy()\n l.update(re.match(MATCH, name).groupdict())\n # prepare memory limit for the container type\n mem = kwargs.get('memory', {}).get(l['c_type'], None)\n if mem:\n l.update({'memory': '-m {}'.format(mem.lower())})\n else:\n l.update({'memory': ''})\n # prepare memory limit for the container type\n cpu = kwargs.get('cpu', {}).get(l['c_type'], None)\n if cpu:\n l.update({'cpu': '-c {}'.format(cpu)})\n else:\n l.update({'cpu': ''})\n # construct unit from template\n for f in unit:\n f['value'] = f['value'].format(**l)\n # prepare tags only if one was provided\n tags = kwargs.get('tags', {})\n if tags:\n tagset = ' '.join(['\"{}={}\"'.format(k, v) for k, v in tags.items()])\n unit.append({\"section\": \"X-Fleet\", \"name\": \"MachineMetadata\",\n \"value\": tagset})\n # post unit to fleet\n self._put_unit(name, {\"desiredState\": \"launched\", \"options\": unit})\n\n def _create_log(self, name, image, command, unit):\n l = locals().copy()\n l.update(re.match(MATCH, name).groupdict())\n # construct unit from template\n for f in unit:\n f['value'] = f['value'].format(**l)\n # post unit to fleet\n self._put_unit(name+'-log', {\"desiredState\": \"launched\", \"options\": unit})\n\n def start(self, name):\n \"\"\"Start a container\"\"\"\n self._wait_for_container(name)\n\n def _wait_for_container(self, name):\n # we bump to 20 minutes here to match the timeout on the router and in the app unit files\n for _ in range(1200):\n states = self._get_state(name)\n if states and len(states.get('states', [])) == 1:\n state = states.get('states')[0]\n subState = state.get('systemdSubState')\n if subState == 'running' or subState == 'exited':\n break\n elif subState == 'failed':\n raise RuntimeError('container failed to start')\n time.sleep(1)\n else:\n raise RuntimeError('container failed to start')\n\n def _wait_for_destroy(self, name):\n for _ in range(30):\n states = self._get_state(name)\n if not states:\n break\n time.sleep(1)\n else:\n raise RuntimeError('timeout on container destroy')\n\n def stop(self, name):\n \"\"\"Stop a container\"\"\"\n raise NotImplementedError\n\n def destroy(self, name):\n \"\"\"Destroy a container\"\"\"\n funcs = []\n funcs.append(functools.partial(self._destroy_container, name))\n funcs.append(functools.partial(self._destroy_log, name))\n # call all destroy functions, ignoring any errors\n for f in funcs:\n try:\n f()\n except:\n pass\n self._wait_for_destroy(name)\n\n def _destroy_container(self, name):\n return self._delete_unit(name)\n\n def _destroy_log(self, name):\n return self._delete_unit(name+'-log')\n\n def run(self, name, image, command): # noqa\n \"\"\"Run a one-off command\"\"\"\n self._create_container(name, image, command, copy.deepcopy(RUN_TEMPLATE))\n\n # wait for the container to get scheduled\n for _ in range(30):\n states = self._get_state(name)\n if states and len(states.get('states', [])) == 1:\n state = states.get('states')[0]\n break\n time.sleep(1)\n else:\n raise RuntimeError('container did not report state')\n machineID = state.get('machineID')\n\n # find the machine\n machines = self._get_machines()\n if not machines:\n raise RuntimeError('no available hosts to run command')\n\n # find the machine's primaryIP\n primaryIP = None\n for m in machines.get('machines', []):\n if m['id'] == machineID:\n primaryIP = m['primaryIP']\n if not primaryIP:\n raise RuntimeError('could not find host')\n\n # prepare ssh key\n file_obj = cStringIO.StringIO(base64.b64decode(self.auth))\n pkey = paramiko.RSAKey(file_obj=file_obj)\n\n # grab output via docker logs over SSH\n ssh = paramiko.SSHClient()\n ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())\n ssh.connect(primaryIP, username=\"core\", pkey=pkey)\n # share a transport\n tran = ssh.get_transport()\n\n def _do_ssh(cmd):\n chan = tran.open_session()\n # get a pty so stdout/stderr look right\n chan.get_pty()\n out = chan.makefile()\n chan.exec_command(cmd)\n rc, output = chan.recv_exit_status(), out.read()\n return rc, output\n\n # wait for container to start\n for _ in range(1200):\n rc, _ = _do_ssh('docker inspect {name}'.format(**locals()))\n if rc == 0:\n break\n time.sleep(1)\n else:\n raise RuntimeError('container failed to start on host')\n\n # wait for container to complete\n for _ in range(1200):\n _rc, _output = _do_ssh('docker inspect {name}'.format(**locals()))\n if _rc != 0:\n raise RuntimeError('failed to inspect container')\n _container = json.loads(_output)\n finished_at = _container[0][\"State\"][\"FinishedAt\"]\n if not finished_at.startswith('0001'):\n break\n time.sleep(1)\n else:\n raise RuntimeError('container timed out')\n\n # gather container output\n _rc, output = _do_ssh('docker logs {name}'.format(**locals()))\n if _rc != 0:\n raise RuntimeError('could not attach to container')\n\n # determine container exit code\n _rc, _output = _do_ssh('docker inspect {name}'.format(**locals()))\n if _rc != 0:\n raise RuntimeError('could not determine exit code')\n container = json.loads(_output)\n rc = container[0][\"State\"][\"ExitCode\"]\n\n # cleanup\n self._destroy_container(name)\n self._wait_for_destroy(name)\n\n # return rc and output\n return rc, output\n\n def attach(self, name):\n \"\"\"\n Attach to a job's stdin, stdout and stderr\n \"\"\"\n raise NotImplementedError\n\nSchedulerClient = FleetHTTPClient\n\n\nCONTAINER_TEMPLATE = [\n {\"section\": \"Unit\", \"name\": \"Description\", \"value\": \"{name}\"},\n {\"section\": \"Service\", \"name\": \"ExecStartPre\", \"value\": '''/bin/sh -c \"IMAGE=$(etcdctl get /deis/registry/host 2>&1):$(etcdctl get /deis/registry/port 2>&1)/{image}; docker pull $IMAGE\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"ExecStartPre\", \"value\": '''/bin/sh -c \"docker inspect {name} >/dev/null 2>&1 && docker rm -f {name} || true\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"ExecStart\", \"value\": '''/bin/sh -c \"IMAGE=$(etcdctl get /deis/registry/host 2>&1):$(etcdctl get /deis/registry/port 2>&1)/{image}; port=$(docker inspect -f '{{{{range $k, $v := .ContainerConfig.ExposedPorts }}}}{{{{$k}}}}{{{{end}}}}' $IMAGE | cut -d/ -f1) ; docker run --name {name} {memory} {cpu} -P -e PORT=$port $IMAGE {command}\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"ExecStop\", \"value\": '''/usr/bin/docker rm -f {name}'''},\n {\"section\": \"Service\", \"name\": \"TimeoutStartSec\", \"value\": \"20m\"},\n]\n\n\nLOG_TEMPLATE = [\n {\"section\": \"Unit\", \"name\": \"Description\", \"value\": \"{name} log\"},\n {\"section\": \"Unit\", \"name\": \"BindsTo\", \"value\": \"{name}.service\"},\n {\"section\": \"Service\", \"name\": \"ExecStartPre\", \"value\": '''/bin/sh -c \"until docker inspect {name} >/dev/null 2>&1; do sleep 1; done\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"ExecStart\", \"value\": '''/bin/sh -c \"docker logs -f {name} 2>&1 | logger -p local0.info -t {app}[{c_type}.{c_num}] --udp --server $(etcdctl get /deis/logs/host) --port $(etcdctl get /deis/logs/port)\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"TimeoutStartSec\", \"value\": \"20m\"},\n {\"section\": \"X-Fleet\", \"name\": \"MachineOf\", \"value\": \"{name}.service\"},\n]\n\n\nRUN_TEMPLATE = [\n {\"section\": \"Unit\", \"name\": \"Description\", \"value\": \"{name} admin command\"},\n {\"section\": \"Service\", \"name\": \"ExecStartPre\", \"value\": '''/bin/sh -c \"IMAGE=$(etcdctl get /deis/registry/host 2>&1):$(etcdctl get /deis/registry/port 2>&1)/{image}; docker pull $IMAGE\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"ExecStartPre\", \"value\": '''/bin/sh -c \"docker inspect {name} >/dev/null 2>&1 && docker rm -f {name} || true\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"ExecStart\", \"value\": '''/bin/sh -c \"IMAGE=$(etcdctl get /deis/registry/host 2>&1):$(etcdctl get /deis/registry/port 2>&1)/{image}; docker run --name {name} --entrypoint=/bin/bash -a stdout -a stderr $IMAGE -c '{command}'\"'''}, # noqa\n {\"section\": \"Service\", \"name\": \"TimeoutStartSec\", \"value\": \"20m\"},\n]\n", "path": "controller/scheduler/coreos.py"}]} |
gh_patches_debug_288 | rasdani/github-patches | git_diff | getredash__redash-3877 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
API Key authentication should take precedence over cookies
Currently when you're logged in as a user, you can't use embeds or shared dashboards for which you do not have access -- even if you provide the API key. This is because the current user is being defined by the session cookie and the API key is being ignored.
We need to change this behavior so the API key takes precedence. From a quick look at [Flask-Login](https://flask-login.readthedocs.io)'s documentation, it seems that it calls `user_loader` first and only if this fails will try the `requets_loader`.
Unless this is configurable, we might need to change `user_loader` to always return `None` and implement our own logic in `request_loader`.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `redash/authentication/__init__.py`
Content:
```
1 import hashlib
2 import hmac
3 import logging
4 import time
5 from urlparse import urlsplit, urlunsplit
6
7 from flask import jsonify, redirect, request, url_for
8 from flask_login import LoginManager, login_user, logout_user, user_logged_in
9 from redash import models, settings
10 from redash.authentication import jwt_auth
11 from redash.authentication.org_resolving import current_org
12 from redash.settings.organization import settings as org_settings
13 from redash.tasks import record_event
14 from sqlalchemy.orm.exc import NoResultFound
15 from werkzeug.exceptions import Unauthorized
16
17 login_manager = LoginManager()
18 logger = logging.getLogger('authentication')
19
20
21 def get_login_url(external=False, next="/"):
22 if settings.MULTI_ORG and current_org == None:
23 login_url = '/'
24 elif settings.MULTI_ORG:
25 login_url = url_for('redash.login', org_slug=current_org.slug, next=next, _external=external)
26 else:
27 login_url = url_for('redash.login', next=next, _external=external)
28
29 return login_url
30
31
32 def sign(key, path, expires):
33 if not key:
34 return None
35
36 h = hmac.new(str(key), msg=path, digestmod=hashlib.sha1)
37 h.update(str(expires))
38
39 return h.hexdigest()
40
41
42 @login_manager.user_loader
43 def load_user(user_id_with_identity):
44 org = current_org._get_current_object()
45
46 try:
47 user_id, _ = user_id_with_identity.split("-")
48 user = models.User.get_by_id_and_org(user_id, org)
49 if user.is_disabled or user.get_id() != user_id_with_identity:
50 return None
51
52 return user
53 except (models.NoResultFound, ValueError, AttributeError):
54 return None
55
56
57 def request_loader(request):
58 user = None
59 if settings.AUTH_TYPE == 'hmac':
60 user = hmac_load_user_from_request(request)
61 elif settings.AUTH_TYPE == 'api_key':
62 user = api_key_load_user_from_request(request)
63 else:
64 logger.warning("Unknown authentication type ({}). Using default (HMAC).".format(settings.AUTH_TYPE))
65 user = hmac_load_user_from_request(request)
66
67 if org_settings['auth_jwt_login_enabled'] and user is None:
68 user = jwt_token_load_user_from_request(request)
69 return user
70
71
72 def hmac_load_user_from_request(request):
73 signature = request.args.get('signature')
74 expires = float(request.args.get('expires') or 0)
75 query_id = request.view_args.get('query_id', None)
76 user_id = request.args.get('user_id', None)
77
78 # TODO: 3600 should be a setting
79 if signature and time.time() < expires <= time.time() + 3600:
80 if user_id:
81 user = models.User.query.get(user_id)
82 calculated_signature = sign(user.api_key, request.path, expires)
83
84 if user.api_key and signature == calculated_signature:
85 return user
86
87 if query_id:
88 query = models.Query.query.filter(models.Query.id == query_id).one()
89 calculated_signature = sign(query.api_key, request.path, expires)
90
91 if query.api_key and signature == calculated_signature:
92 return models.ApiUser(query.api_key, query.org, query.groups.keys(), name="ApiKey: Query {}".format(query.id))
93
94 return None
95
96
97 def get_user_from_api_key(api_key, query_id):
98 if not api_key:
99 return None
100
101 user = None
102
103 # TODO: once we switch all api key storage into the ApiKey model, this code will be much simplified
104 org = current_org._get_current_object()
105 try:
106 user = models.User.get_by_api_key_and_org(api_key, org)
107 if user.is_disabled:
108 user = None
109 except models.NoResultFound:
110 try:
111 api_key = models.ApiKey.get_by_api_key(api_key)
112 user = models.ApiUser(api_key, api_key.org, [])
113 except models.NoResultFound:
114 if query_id:
115 query = models.Query.get_by_id_and_org(query_id, org)
116 if query and query.api_key == api_key:
117 user = models.ApiUser(api_key, query.org, query.groups.keys(), name="ApiKey: Query {}".format(query.id))
118
119 return user
120
121
122 def get_api_key_from_request(request):
123 api_key = request.args.get('api_key', None)
124
125 if api_key is not None:
126 return api_key
127
128 if request.headers.get('Authorization'):
129 auth_header = request.headers.get('Authorization')
130 api_key = auth_header.replace('Key ', '', 1)
131 elif request.view_args is not None and request.view_args.get('token'):
132 api_key = request.view_args['token']
133
134 return api_key
135
136
137 def api_key_load_user_from_request(request):
138 api_key = get_api_key_from_request(request)
139 if request.view_args is not None:
140 query_id = request.view_args.get('query_id', None)
141 user = get_user_from_api_key(api_key, query_id)
142 else:
143 user = None
144
145 return user
146
147
148 def jwt_token_load_user_from_request(request):
149 org = current_org._get_current_object()
150
151 payload = None
152
153 if org_settings['auth_jwt_auth_cookie_name']:
154 jwt_token = request.cookies.get(org_settings['auth_jwt_auth_cookie_name'], None)
155 elif org_settings['auth_jwt_auth_header_name']:
156 jwt_token = request.headers.get(org_settings['auth_jwt_auth_header_name'], None)
157 else:
158 return None
159
160 if jwt_token:
161 payload, token_is_valid = jwt_auth.verify_jwt_token(
162 jwt_token,
163 expected_issuer=org_settings['auth_jwt_auth_issuer'],
164 expected_audience=org_settings['auth_jwt_auth_audience'],
165 algorithms=org_settings['auth_jwt_auth_algorithms'],
166 public_certs_url=org_settings['auth_jwt_auth_public_certs_url'],
167 )
168 if not token_is_valid:
169 raise Unauthorized('Invalid JWT token')
170
171 if not payload:
172 return
173
174 try:
175 user = models.User.get_by_email_and_org(payload['email'], org)
176 except models.NoResultFound:
177 user = create_and_login_user(current_org, payload['email'], payload['email'])
178
179 return user
180
181
182 def log_user_logged_in(app, user):
183 event = {
184 'org_id': user.org_id,
185 'user_id': user.id,
186 'action': 'login',
187 'object_type': 'redash',
188 'timestamp': int(time.time()),
189 'user_agent': request.user_agent.string,
190 'ip': request.remote_addr
191 }
192
193 record_event.delay(event)
194
195
196 @login_manager.unauthorized_handler
197 def redirect_to_login():
198 if request.is_xhr or '/api/' in request.path:
199 response = jsonify({'message': "Couldn't find resource. Please login and try again."})
200 response.status_code = 404
201 return response
202
203 login_url = get_login_url(next=request.url, external=False)
204
205 return redirect(login_url)
206
207
208 def logout_and_redirect_to_index():
209 logout_user()
210
211 if settings.MULTI_ORG and current_org == None:
212 index_url = '/'
213 elif settings.MULTI_ORG:
214 index_url = url_for('redash.index', org_slug=current_org.slug, _external=False)
215 else:
216 index_url = url_for('redash.index', _external=False)
217
218 return redirect(index_url)
219
220
221 def init_app(app):
222 from redash.authentication import google_oauth, saml_auth, remote_user_auth, ldap_auth
223
224 login_manager.init_app(app)
225 login_manager.anonymous_user = models.AnonymousUser
226
227 app.register_blueprint(google_oauth.blueprint)
228 app.register_blueprint(saml_auth.blueprint)
229 app.register_blueprint(remote_user_auth.blueprint)
230 app.register_blueprint(ldap_auth.blueprint)
231
232 user_logged_in.connect(log_user_logged_in)
233 login_manager.request_loader(request_loader)
234
235
236 def create_and_login_user(org, name, email, picture=None):
237 try:
238 user_object = models.User.get_by_email_and_org(email, org)
239 if user_object.is_disabled:
240 return None
241 if user_object.is_invitation_pending:
242 user_object.is_invitation_pending = False
243 models.db.session.commit()
244 if user_object.name != name:
245 logger.debug("Updating user name (%r -> %r)", user_object.name, name)
246 user_object.name = name
247 models.db.session.commit()
248 except NoResultFound:
249 logger.debug("Creating user object (%r)", name)
250 user_object = models.User(org=org, name=name, email=email, is_invitation_pending=False,
251 _profile_image_url=picture, group_ids=[org.default_group.id])
252 models.db.session.add(user_object)
253 models.db.session.commit()
254
255 login_user(user_object, remember=True)
256
257 return user_object
258
259
260 def get_next_path(unsafe_next_path):
261 if not unsafe_next_path:
262 return ''
263
264 # Preventing open redirection attacks
265 parts = list(urlsplit(unsafe_next_path))
266 parts[0] = '' # clear scheme
267 parts[1] = '' # clear netloc
268 safe_next_path = urlunsplit(parts)
269
270 return safe_next_path
271
```
--- 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/redash/authentication/__init__.py b/redash/authentication/__init__.py
--- a/redash/authentication/__init__.py
+++ b/redash/authentication/__init__.py
@@ -41,6 +41,10 @@
@login_manager.user_loader
def load_user(user_id_with_identity):
+ user = api_key_load_user_from_request(request)
+ if user:
+ return user
+
org = current_org._get_current_object()
try:
| {"golden_diff": "diff --git a/redash/authentication/__init__.py b/redash/authentication/__init__.py\n--- a/redash/authentication/__init__.py\n+++ b/redash/authentication/__init__.py\n@@ -41,6 +41,10 @@\n \n @login_manager.user_loader\n def load_user(user_id_with_identity):\n+ user = api_key_load_user_from_request(request)\n+ if user:\n+ return user\n+\n org = current_org._get_current_object()\n \n try:\n", "issue": "API Key authentication should take precedence over cookies\nCurrently when you're logged in as a user, you can't use embeds or shared dashboards for which you do not have access -- even if you provide the API key. This is because the current user is being defined by the session cookie and the API key is being ignored.\r\n\r\nWe need to change this behavior so the API key takes precedence. From a quick look at [Flask-Login](https://flask-login.readthedocs.io)'s documentation, it seems that it calls `user_loader` first and only if this fails will try the `requets_loader`.\r\n\r\nUnless this is configurable, we might need to change `user_loader` to always return `None` and implement our own logic in `request_loader`.\n", "before_files": [{"content": "import hashlib\nimport hmac\nimport logging\nimport time\nfrom urlparse import urlsplit, urlunsplit\n\nfrom flask import jsonify, redirect, request, url_for\nfrom flask_login import LoginManager, login_user, logout_user, user_logged_in\nfrom redash import models, settings\nfrom redash.authentication import jwt_auth\nfrom redash.authentication.org_resolving import current_org\nfrom redash.settings.organization import settings as org_settings\nfrom redash.tasks import record_event\nfrom sqlalchemy.orm.exc import NoResultFound\nfrom werkzeug.exceptions import Unauthorized\n\nlogin_manager = LoginManager()\nlogger = logging.getLogger('authentication')\n\n\ndef get_login_url(external=False, next=\"/\"):\n if settings.MULTI_ORG and current_org == None:\n login_url = '/'\n elif settings.MULTI_ORG:\n login_url = url_for('redash.login', org_slug=current_org.slug, next=next, _external=external)\n else:\n login_url = url_for('redash.login', next=next, _external=external)\n\n return login_url\n\n\ndef sign(key, path, expires):\n if not key:\n return None\n\n h = hmac.new(str(key), msg=path, digestmod=hashlib.sha1)\n h.update(str(expires))\n\n return h.hexdigest()\n\n\n@login_manager.user_loader\ndef load_user(user_id_with_identity):\n org = current_org._get_current_object()\n\n try:\n user_id, _ = user_id_with_identity.split(\"-\")\n user = models.User.get_by_id_and_org(user_id, org)\n if user.is_disabled or user.get_id() != user_id_with_identity:\n return None\n\n return user\n except (models.NoResultFound, ValueError, AttributeError):\n return None\n\n\ndef request_loader(request):\n user = None\n if settings.AUTH_TYPE == 'hmac':\n user = hmac_load_user_from_request(request)\n elif settings.AUTH_TYPE == 'api_key':\n user = api_key_load_user_from_request(request)\n else:\n logger.warning(\"Unknown authentication type ({}). Using default (HMAC).\".format(settings.AUTH_TYPE))\n user = hmac_load_user_from_request(request)\n\n if org_settings['auth_jwt_login_enabled'] and user is None:\n user = jwt_token_load_user_from_request(request)\n return user\n\n\ndef hmac_load_user_from_request(request):\n signature = request.args.get('signature')\n expires = float(request.args.get('expires') or 0)\n query_id = request.view_args.get('query_id', None)\n user_id = request.args.get('user_id', None)\n\n # TODO: 3600 should be a setting\n if signature and time.time() < expires <= time.time() + 3600:\n if user_id:\n user = models.User.query.get(user_id)\n calculated_signature = sign(user.api_key, request.path, expires)\n\n if user.api_key and signature == calculated_signature:\n return user\n\n if query_id:\n query = models.Query.query.filter(models.Query.id == query_id).one()\n calculated_signature = sign(query.api_key, request.path, expires)\n\n if query.api_key and signature == calculated_signature:\n return models.ApiUser(query.api_key, query.org, query.groups.keys(), name=\"ApiKey: Query {}\".format(query.id))\n\n return None\n\n\ndef get_user_from_api_key(api_key, query_id):\n if not api_key:\n return None\n\n user = None\n\n # TODO: once we switch all api key storage into the ApiKey model, this code will be much simplified\n org = current_org._get_current_object()\n try:\n user = models.User.get_by_api_key_and_org(api_key, org)\n if user.is_disabled:\n user = None\n except models.NoResultFound:\n try:\n api_key = models.ApiKey.get_by_api_key(api_key)\n user = models.ApiUser(api_key, api_key.org, [])\n except models.NoResultFound:\n if query_id:\n query = models.Query.get_by_id_and_org(query_id, org)\n if query and query.api_key == api_key:\n user = models.ApiUser(api_key, query.org, query.groups.keys(), name=\"ApiKey: Query {}\".format(query.id))\n\n return user\n\n\ndef get_api_key_from_request(request):\n api_key = request.args.get('api_key', None)\n\n if api_key is not None:\n return api_key\n\n if request.headers.get('Authorization'):\n auth_header = request.headers.get('Authorization')\n api_key = auth_header.replace('Key ', '', 1)\n elif request.view_args is not None and request.view_args.get('token'):\n api_key = request.view_args['token']\n\n return api_key\n\n\ndef api_key_load_user_from_request(request):\n api_key = get_api_key_from_request(request)\n if request.view_args is not None:\n query_id = request.view_args.get('query_id', None)\n user = get_user_from_api_key(api_key, query_id)\n else:\n user = None\n\n return user\n\n\ndef jwt_token_load_user_from_request(request):\n org = current_org._get_current_object()\n\n payload = None\n\n if org_settings['auth_jwt_auth_cookie_name']:\n jwt_token = request.cookies.get(org_settings['auth_jwt_auth_cookie_name'], None)\n elif org_settings['auth_jwt_auth_header_name']:\n jwt_token = request.headers.get(org_settings['auth_jwt_auth_header_name'], None)\n else:\n return None\n\n if jwt_token:\n payload, token_is_valid = jwt_auth.verify_jwt_token(\n jwt_token,\n expected_issuer=org_settings['auth_jwt_auth_issuer'],\n expected_audience=org_settings['auth_jwt_auth_audience'],\n algorithms=org_settings['auth_jwt_auth_algorithms'],\n public_certs_url=org_settings['auth_jwt_auth_public_certs_url'],\n )\n if not token_is_valid:\n raise Unauthorized('Invalid JWT token')\n\n if not payload:\n return\n\n try:\n user = models.User.get_by_email_and_org(payload['email'], org)\n except models.NoResultFound:\n user = create_and_login_user(current_org, payload['email'], payload['email'])\n\n return user\n\n\ndef log_user_logged_in(app, user):\n event = {\n 'org_id': user.org_id,\n 'user_id': user.id,\n 'action': 'login',\n 'object_type': 'redash',\n 'timestamp': int(time.time()),\n 'user_agent': request.user_agent.string,\n 'ip': request.remote_addr\n }\n\n record_event.delay(event)\n\n\n@login_manager.unauthorized_handler\ndef redirect_to_login():\n if request.is_xhr or '/api/' in request.path:\n response = jsonify({'message': \"Couldn't find resource. Please login and try again.\"})\n response.status_code = 404\n return response\n\n login_url = get_login_url(next=request.url, external=False)\n\n return redirect(login_url)\n\n\ndef logout_and_redirect_to_index():\n logout_user()\n\n if settings.MULTI_ORG and current_org == None:\n index_url = '/'\n elif settings.MULTI_ORG:\n index_url = url_for('redash.index', org_slug=current_org.slug, _external=False)\n else:\n index_url = url_for('redash.index', _external=False)\n\n return redirect(index_url)\n\n\ndef init_app(app):\n from redash.authentication import google_oauth, saml_auth, remote_user_auth, ldap_auth\n\n login_manager.init_app(app)\n login_manager.anonymous_user = models.AnonymousUser\n\n app.register_blueprint(google_oauth.blueprint)\n app.register_blueprint(saml_auth.blueprint)\n app.register_blueprint(remote_user_auth.blueprint)\n app.register_blueprint(ldap_auth.blueprint)\n\n user_logged_in.connect(log_user_logged_in)\n login_manager.request_loader(request_loader)\n\n\ndef create_and_login_user(org, name, email, picture=None):\n try:\n user_object = models.User.get_by_email_and_org(email, org)\n if user_object.is_disabled:\n return None\n if user_object.is_invitation_pending:\n user_object.is_invitation_pending = False\n models.db.session.commit()\n if user_object.name != name:\n logger.debug(\"Updating user name (%r -> %r)\", user_object.name, name)\n user_object.name = name\n models.db.session.commit()\n except NoResultFound:\n logger.debug(\"Creating user object (%r)\", name)\n user_object = models.User(org=org, name=name, email=email, is_invitation_pending=False,\n _profile_image_url=picture, group_ids=[org.default_group.id])\n models.db.session.add(user_object)\n models.db.session.commit()\n\n login_user(user_object, remember=True)\n\n return user_object\n\n\ndef get_next_path(unsafe_next_path):\n if not unsafe_next_path:\n return ''\n\n # Preventing open redirection attacks\n parts = list(urlsplit(unsafe_next_path))\n parts[0] = '' # clear scheme\n parts[1] = '' # clear netloc\n safe_next_path = urlunsplit(parts)\n\n return safe_next_path\n", "path": "redash/authentication/__init__.py"}], "after_files": [{"content": "import hashlib\nimport hmac\nimport logging\nimport time\nfrom urlparse import urlsplit, urlunsplit\n\nfrom flask import jsonify, redirect, request, url_for\nfrom flask_login import LoginManager, login_user, logout_user, user_logged_in\nfrom redash import models, settings\nfrom redash.authentication import jwt_auth\nfrom redash.authentication.org_resolving import current_org\nfrom redash.settings.organization import settings as org_settings\nfrom redash.tasks import record_event\nfrom sqlalchemy.orm.exc import NoResultFound\nfrom werkzeug.exceptions import Unauthorized\n\nlogin_manager = LoginManager()\nlogger = logging.getLogger('authentication')\n\n\ndef get_login_url(external=False, next=\"/\"):\n if settings.MULTI_ORG and current_org == None:\n login_url = '/'\n elif settings.MULTI_ORG:\n login_url = url_for('redash.login', org_slug=current_org.slug, next=next, _external=external)\n else:\n login_url = url_for('redash.login', next=next, _external=external)\n\n return login_url\n\n\ndef sign(key, path, expires):\n if not key:\n return None\n\n h = hmac.new(str(key), msg=path, digestmod=hashlib.sha1)\n h.update(str(expires))\n\n return h.hexdigest()\n\n\n@login_manager.user_loader\ndef load_user(user_id_with_identity):\n user = api_key_load_user_from_request(request)\n if user:\n return user\n\n org = current_org._get_current_object()\n\n try:\n user_id, _ = user_id_with_identity.split(\"-\")\n user = models.User.get_by_id_and_org(user_id, org)\n if user.is_disabled or user.get_id() != user_id_with_identity:\n return None\n\n return user\n except (models.NoResultFound, ValueError, AttributeError):\n return None\n\n\ndef request_loader(request):\n user = None\n if settings.AUTH_TYPE == 'hmac':\n user = hmac_load_user_from_request(request)\n elif settings.AUTH_TYPE == 'api_key':\n user = api_key_load_user_from_request(request)\n else:\n logger.warning(\"Unknown authentication type ({}). Using default (HMAC).\".format(settings.AUTH_TYPE))\n user = hmac_load_user_from_request(request)\n\n if org_settings['auth_jwt_login_enabled'] and user is None:\n user = jwt_token_load_user_from_request(request)\n return user\n\n\ndef hmac_load_user_from_request(request):\n signature = request.args.get('signature')\n expires = float(request.args.get('expires') or 0)\n query_id = request.view_args.get('query_id', None)\n user_id = request.args.get('user_id', None)\n\n # TODO: 3600 should be a setting\n if signature and time.time() < expires <= time.time() + 3600:\n if user_id:\n user = models.User.query.get(user_id)\n calculated_signature = sign(user.api_key, request.path, expires)\n\n if user.api_key and signature == calculated_signature:\n return user\n\n if query_id:\n query = models.Query.query.filter(models.Query.id == query_id).one()\n calculated_signature = sign(query.api_key, request.path, expires)\n\n if query.api_key and signature == calculated_signature:\n return models.ApiUser(query.api_key, query.org, query.groups.keys(), name=\"ApiKey: Query {}\".format(query.id))\n\n return None\n\n\ndef get_user_from_api_key(api_key, query_id):\n if not api_key:\n return None\n\n user = None\n\n # TODO: once we switch all api key storage into the ApiKey model, this code will be much simplified\n org = current_org._get_current_object()\n try:\n user = models.User.get_by_api_key_and_org(api_key, org)\n if user.is_disabled:\n user = None\n except models.NoResultFound:\n try:\n api_key = models.ApiKey.get_by_api_key(api_key)\n user = models.ApiUser(api_key, api_key.org, [])\n except models.NoResultFound:\n if query_id:\n query = models.Query.get_by_id_and_org(query_id, org)\n if query and query.api_key == api_key:\n user = models.ApiUser(api_key, query.org, query.groups.keys(), name=\"ApiKey: Query {}\".format(query.id))\n\n return user\n\n\ndef get_api_key_from_request(request):\n api_key = request.args.get('api_key', None)\n\n if api_key is not None:\n return api_key\n\n if request.headers.get('Authorization'):\n auth_header = request.headers.get('Authorization')\n api_key = auth_header.replace('Key ', '', 1)\n elif request.view_args is not None and request.view_args.get('token'):\n api_key = request.view_args['token']\n\n return api_key\n\n\ndef api_key_load_user_from_request(request):\n api_key = get_api_key_from_request(request)\n if request.view_args is not None:\n query_id = request.view_args.get('query_id', None)\n user = get_user_from_api_key(api_key, query_id)\n else:\n user = None\n\n return user\n\n\ndef jwt_token_load_user_from_request(request):\n org = current_org._get_current_object()\n\n payload = None\n\n if org_settings['auth_jwt_auth_cookie_name']:\n jwt_token = request.cookies.get(org_settings['auth_jwt_auth_cookie_name'], None)\n elif org_settings['auth_jwt_auth_header_name']:\n jwt_token = request.headers.get(org_settings['auth_jwt_auth_header_name'], None)\n else:\n return None\n\n if jwt_token:\n payload, token_is_valid = jwt_auth.verify_jwt_token(\n jwt_token,\n expected_issuer=org_settings['auth_jwt_auth_issuer'],\n expected_audience=org_settings['auth_jwt_auth_audience'],\n algorithms=org_settings['auth_jwt_auth_algorithms'],\n public_certs_url=org_settings['auth_jwt_auth_public_certs_url'],\n )\n if not token_is_valid:\n raise Unauthorized('Invalid JWT token')\n\n if not payload:\n return\n\n try:\n user = models.User.get_by_email_and_org(payload['email'], org)\n except models.NoResultFound:\n user = create_and_login_user(current_org, payload['email'], payload['email'])\n\n return user\n\n\ndef log_user_logged_in(app, user):\n event = {\n 'org_id': user.org_id,\n 'user_id': user.id,\n 'action': 'login',\n 'object_type': 'redash',\n 'timestamp': int(time.time()),\n 'user_agent': request.user_agent.string,\n 'ip': request.remote_addr\n }\n\n record_event.delay(event)\n\n\n@login_manager.unauthorized_handler\ndef redirect_to_login():\n if request.is_xhr or '/api/' in request.path:\n response = jsonify({'message': \"Couldn't find resource. Please login and try again.\"})\n response.status_code = 404\n return response\n\n login_url = get_login_url(next=request.url, external=False)\n\n return redirect(login_url)\n\n\ndef logout_and_redirect_to_index():\n logout_user()\n\n if settings.MULTI_ORG and current_org == None:\n index_url = '/'\n elif settings.MULTI_ORG:\n index_url = url_for('redash.index', org_slug=current_org.slug, _external=False)\n else:\n index_url = url_for('redash.index', _external=False)\n\n return redirect(index_url)\n\n\ndef init_app(app):\n from redash.authentication import google_oauth, saml_auth, remote_user_auth, ldap_auth\n\n login_manager.init_app(app)\n login_manager.anonymous_user = models.AnonymousUser\n\n app.register_blueprint(google_oauth.blueprint)\n app.register_blueprint(saml_auth.blueprint)\n app.register_blueprint(remote_user_auth.blueprint)\n app.register_blueprint(ldap_auth.blueprint)\n\n user_logged_in.connect(log_user_logged_in)\n login_manager.request_loader(request_loader)\n\n\ndef create_and_login_user(org, name, email, picture=None):\n try:\n user_object = models.User.get_by_email_and_org(email, org)\n if user_object.is_disabled:\n return None\n if user_object.is_invitation_pending:\n user_object.is_invitation_pending = False\n models.db.session.commit()\n if user_object.name != name:\n logger.debug(\"Updating user name (%r -> %r)\", user_object.name, name)\n user_object.name = name\n models.db.session.commit()\n except NoResultFound:\n logger.debug(\"Creating user object (%r)\", name)\n user_object = models.User(org=org, name=name, email=email, is_invitation_pending=False,\n _profile_image_url=picture, group_ids=[org.default_group.id])\n models.db.session.add(user_object)\n models.db.session.commit()\n\n login_user(user_object, remember=True)\n\n return user_object\n\n\ndef get_next_path(unsafe_next_path):\n if not unsafe_next_path:\n return ''\n\n # Preventing open redirection attacks\n parts = list(urlsplit(unsafe_next_path))\n parts[0] = '' # clear scheme\n parts[1] = '' # clear netloc\n safe_next_path = urlunsplit(parts)\n\n return safe_next_path\n", "path": "redash/authentication/__init__.py"}]} |
gh_patches_debug_289 | rasdani/github-patches | git_diff | readthedocs__readthedocs.org-5470 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Build List Screen Performance Issue
While working on #5464, I discovered a performance issue on the [build list screen](http://readthedocs.org/projects/requests/builds/).
There appears to be a couple duplicated queries in the build list screen. One is to get the project (probably from `Build.get_absolute_url`) for the build and the other gets the version (probably from `build_list_detailed.html`). This results in O(n) SQL queries where n is the number of builds displayed. It should be possible to get the project and version for each build using `select_related`.
<img width="1155" alt="Screen Shot 2019-03-15 at 11 00 13 AM" src="https://user-images.githubusercontent.com/185043/54452149-a0d76e80-4711-11e9-82f4-763418863f94.png">
--- 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/views.py`
Content:
```
1 # -*- coding: utf-8 -*-
2
3 """Views for builds app."""
4
5 import logging
6 import textwrap
7
8 from django.contrib import messages
9 from django.contrib.auth.decorators import login_required
10 from django.http import (
11 HttpResponseForbidden,
12 HttpResponsePermanentRedirect,
13 HttpResponseRedirect,
14 )
15 from django.shortcuts import get_object_or_404
16 from django.urls import reverse
17 from django.utils.decorators import method_decorator
18 from django.views.generic import DetailView, ListView
19 from requests.utils import quote
20 from urllib.parse import urlparse
21
22 from readthedocs.doc_builder.exceptions import BuildEnvironmentError
23 from readthedocs.builds.models import Build, Version
24 from readthedocs.core.permissions import AdminPermission
25 from readthedocs.core.utils import trigger_build
26 from readthedocs.projects.models import Project
27
28
29 log = logging.getLogger(__name__)
30
31
32 class BuildBase:
33 model = Build
34
35 def get_queryset(self):
36 self.project_slug = self.kwargs.get('project_slug', None)
37 self.project = get_object_or_404(
38 Project.objects.protected(self.request.user),
39 slug=self.project_slug,
40 )
41 queryset = Build.objects.public(
42 user=self.request.user,
43 project=self.project,
44 )
45
46 return queryset
47
48
49 class BuildTriggerMixin:
50
51 @method_decorator(login_required)
52 def post(self, request, project_slug):
53 project = get_object_or_404(Project, slug=project_slug)
54
55 if not AdminPermission.is_admin(request.user, project):
56 return HttpResponseForbidden()
57
58 version_slug = request.POST.get('version_slug')
59 version = get_object_or_404(
60 Version,
61 project=project,
62 slug=version_slug,
63 )
64
65 update_docs_task, build = trigger_build(
66 project=project,
67 version=version,
68 )
69 if (update_docs_task, build) == (None, None):
70 # Build was skipped
71 messages.add_message(
72 request,
73 messages.WARNING,
74 "This project is currently disabled and can't trigger new builds.",
75 )
76 return HttpResponseRedirect(
77 reverse('builds_project_list', args=[project.slug]),
78 )
79
80 return HttpResponseRedirect(
81 reverse('builds_detail', args=[project.slug, build.pk]),
82 )
83
84
85 class BuildList(BuildBase, BuildTriggerMixin, ListView):
86
87 def get_context_data(self, **kwargs):
88 context = super().get_context_data(**kwargs)
89
90 active_builds = self.get_queryset().exclude(
91 state='finished',
92 ).values('id')
93
94 context['project'] = self.project
95 context['active_builds'] = active_builds
96 context['versions'] = Version.objects.public(
97 user=self.request.user,
98 project=self.project,
99 )
100 context['build_qs'] = self.get_queryset()
101
102 return context
103
104
105 class BuildDetail(BuildBase, DetailView):
106 pk_url_kwarg = 'build_pk'
107
108 def get_context_data(self, **kwargs):
109 context = super().get_context_data(**kwargs)
110 context['project'] = self.project
111
112 build = self.get_object()
113 if build.error != BuildEnvironmentError.GENERIC_WITH_BUILD_ID.format(build_id=build.pk):
114 # Do not suggest to open an issue if the error is not generic
115 return context
116
117 scheme = (
118 'https://github.com/rtfd/readthedocs.org/issues/new'
119 '?title={title}{build_id}'
120 '&body={body}'
121 )
122
123 # TODO: we could use ``.github/ISSUE_TEMPLATE.md`` here, but we would
124 # need to add some variables to it which could impact in the UX when
125 # filling an issue from the web
126 body = """
127 ## Details:
128
129 * Project URL: https://readthedocs.org/projects/{project_slug}/
130 * Build URL(if applicable): https://readthedocs.org{build_path}
131 * Read the Docs username(if applicable): {username}
132
133 ## Expected Result
134
135 *A description of what you wanted to happen*
136
137 ## Actual Result
138
139 *A description of what actually happened*""".format(
140 project_slug=self.project,
141 build_path=self.request.path,
142 username=self.request.user,
143 )
144
145 scheme_dict = {
146 'title': quote('Build error with build id #'),
147 'build_id': context['build'].id,
148 'body': quote(textwrap.dedent(body)),
149 }
150
151 issue_url = scheme.format(**scheme_dict)
152 issue_url = urlparse(issue_url).geturl()
153 context['issue_url'] = issue_url
154 return context
155
156
157 # Old build view redirects
158
159
160 def builds_redirect_list(request, project_slug): # pylint: disable=unused-argument
161 return HttpResponsePermanentRedirect(
162 reverse('builds_project_list', args=[project_slug]),
163 )
164
165
166 def builds_redirect_detail(request, project_slug, pk): # pylint: disable=unused-argument
167 return HttpResponsePermanentRedirect(
168 reverse('builds_detail', args=[project_slug, pk]),
169 )
170
```
--- 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/views.py b/readthedocs/builds/views.py
--- a/readthedocs/builds/views.py
+++ b/readthedocs/builds/views.py
@@ -41,7 +41,7 @@
queryset = Build.objects.public(
user=self.request.user,
project=self.project,
- )
+ ).select_related('project', 'version')
return queryset
| {"golden_diff": "diff --git a/readthedocs/builds/views.py b/readthedocs/builds/views.py\n--- a/readthedocs/builds/views.py\n+++ b/readthedocs/builds/views.py\n@@ -41,7 +41,7 @@\n queryset = Build.objects.public(\n user=self.request.user,\n project=self.project,\n- )\n+ ).select_related('project', 'version')\n \n return queryset\n", "issue": "Build List Screen Performance Issue\nWhile working on #5464, I discovered a performance issue on the [build list screen](http://readthedocs.org/projects/requests/builds/).\r\n\r\nThere appears to be a couple duplicated queries in the build list screen. One is to get the project (probably from `Build.get_absolute_url`) for the build and the other gets the version (probably from `build_list_detailed.html`). This results in O(n) SQL queries where n is the number of builds displayed. It should be possible to get the project and version for each build using `select_related`.\r\n\r\n<img width=\"1155\" alt=\"Screen Shot 2019-03-15 at 11 00 13 AM\" src=\"https://user-images.githubusercontent.com/185043/54452149-a0d76e80-4711-11e9-82f4-763418863f94.png\">\r\n\r\n\n", "before_files": [{"content": "# -*- coding: utf-8 -*-\n\n\"\"\"Views for builds app.\"\"\"\n\nimport logging\nimport textwrap\n\nfrom django.contrib import messages\nfrom django.contrib.auth.decorators import login_required\nfrom django.http import (\n HttpResponseForbidden,\n HttpResponsePermanentRedirect,\n HttpResponseRedirect,\n)\nfrom django.shortcuts import get_object_or_404\nfrom django.urls import reverse\nfrom django.utils.decorators import method_decorator\nfrom django.views.generic import DetailView, ListView\nfrom requests.utils import quote\nfrom urllib.parse import urlparse\n\nfrom readthedocs.doc_builder.exceptions import BuildEnvironmentError\nfrom readthedocs.builds.models import Build, Version\nfrom readthedocs.core.permissions import AdminPermission\nfrom readthedocs.core.utils import trigger_build\nfrom readthedocs.projects.models import Project\n\n\nlog = logging.getLogger(__name__)\n\n\nclass BuildBase:\n model = Build\n\n def get_queryset(self):\n self.project_slug = self.kwargs.get('project_slug', None)\n self.project = get_object_or_404(\n Project.objects.protected(self.request.user),\n slug=self.project_slug,\n )\n queryset = Build.objects.public(\n user=self.request.user,\n project=self.project,\n )\n\n return queryset\n\n\nclass BuildTriggerMixin:\n\n @method_decorator(login_required)\n def post(self, request, project_slug):\n project = get_object_or_404(Project, slug=project_slug)\n\n if not AdminPermission.is_admin(request.user, project):\n return HttpResponseForbidden()\n\n version_slug = request.POST.get('version_slug')\n version = get_object_or_404(\n Version,\n project=project,\n slug=version_slug,\n )\n\n update_docs_task, build = trigger_build(\n project=project,\n version=version,\n )\n if (update_docs_task, build) == (None, None):\n # Build was skipped\n messages.add_message(\n request,\n messages.WARNING,\n \"This project is currently disabled and can't trigger new builds.\",\n )\n return HttpResponseRedirect(\n reverse('builds_project_list', args=[project.slug]),\n )\n\n return HttpResponseRedirect(\n reverse('builds_detail', args=[project.slug, build.pk]),\n )\n\n\nclass BuildList(BuildBase, BuildTriggerMixin, ListView):\n\n def get_context_data(self, **kwargs):\n context = super().get_context_data(**kwargs)\n\n active_builds = self.get_queryset().exclude(\n state='finished',\n ).values('id')\n\n context['project'] = self.project\n context['active_builds'] = active_builds\n context['versions'] = Version.objects.public(\n user=self.request.user,\n project=self.project,\n )\n context['build_qs'] = self.get_queryset()\n\n return context\n\n\nclass BuildDetail(BuildBase, DetailView):\n pk_url_kwarg = 'build_pk'\n\n def get_context_data(self, **kwargs):\n context = super().get_context_data(**kwargs)\n context['project'] = self.project\n\n build = self.get_object()\n if build.error != BuildEnvironmentError.GENERIC_WITH_BUILD_ID.format(build_id=build.pk):\n # Do not suggest to open an issue if the error is not generic\n return context\n\n scheme = (\n 'https://github.com/rtfd/readthedocs.org/issues/new'\n '?title={title}{build_id}'\n '&body={body}'\n )\n\n # TODO: we could use ``.github/ISSUE_TEMPLATE.md`` here, but we would\n # need to add some variables to it which could impact in the UX when\n # filling an issue from the web\n body = \"\"\"\n ## Details:\n\n * Project URL: https://readthedocs.org/projects/{project_slug}/\n * Build URL(if applicable): https://readthedocs.org{build_path}\n * Read the Docs username(if applicable): {username}\n\n ## Expected Result\n\n *A description of what you wanted to happen*\n\n ## Actual Result\n\n *A description of what actually happened*\"\"\".format(\n project_slug=self.project,\n build_path=self.request.path,\n username=self.request.user,\n )\n\n scheme_dict = {\n 'title': quote('Build error with build id #'),\n 'build_id': context['build'].id,\n 'body': quote(textwrap.dedent(body)),\n }\n\n issue_url = scheme.format(**scheme_dict)\n issue_url = urlparse(issue_url).geturl()\n context['issue_url'] = issue_url\n return context\n\n\n# Old build view redirects\n\n\ndef builds_redirect_list(request, project_slug): # pylint: disable=unused-argument\n return HttpResponsePermanentRedirect(\n reverse('builds_project_list', args=[project_slug]),\n )\n\n\ndef builds_redirect_detail(request, project_slug, pk): # pylint: disable=unused-argument\n return HttpResponsePermanentRedirect(\n reverse('builds_detail', args=[project_slug, pk]),\n )\n", "path": "readthedocs/builds/views.py"}], "after_files": [{"content": "# -*- coding: utf-8 -*-\n\n\"\"\"Views for builds app.\"\"\"\n\nimport logging\nimport textwrap\n\nfrom django.contrib import messages\nfrom django.contrib.auth.decorators import login_required\nfrom django.http import (\n HttpResponseForbidden,\n HttpResponsePermanentRedirect,\n HttpResponseRedirect,\n)\nfrom django.shortcuts import get_object_or_404\nfrom django.urls import reverse\nfrom django.utils.decorators import method_decorator\nfrom django.views.generic import DetailView, ListView\nfrom requests.utils import quote\nfrom urllib.parse import urlparse\n\nfrom readthedocs.doc_builder.exceptions import BuildEnvironmentError\nfrom readthedocs.builds.models import Build, Version\nfrom readthedocs.core.permissions import AdminPermission\nfrom readthedocs.core.utils import trigger_build\nfrom readthedocs.projects.models import Project\n\n\nlog = logging.getLogger(__name__)\n\n\nclass BuildBase:\n model = Build\n\n def get_queryset(self):\n self.project_slug = self.kwargs.get('project_slug', None)\n self.project = get_object_or_404(\n Project.objects.protected(self.request.user),\n slug=self.project_slug,\n )\n queryset = Build.objects.public(\n user=self.request.user,\n project=self.project,\n ).select_related('project', 'version')\n\n return queryset\n\n\nclass BuildTriggerMixin:\n\n @method_decorator(login_required)\n def post(self, request, project_slug):\n project = get_object_or_404(Project, slug=project_slug)\n\n if not AdminPermission.is_admin(request.user, project):\n return HttpResponseForbidden()\n\n version_slug = request.POST.get('version_slug')\n version = get_object_or_404(\n Version,\n project=project,\n slug=version_slug,\n )\n\n update_docs_task, build = trigger_build(\n project=project,\n version=version,\n )\n if (update_docs_task, build) == (None, None):\n # Build was skipped\n messages.add_message(\n request,\n messages.WARNING,\n \"This project is currently disabled and can't trigger new builds.\",\n )\n return HttpResponseRedirect(\n reverse('builds_project_list', args=[project.slug]),\n )\n\n return HttpResponseRedirect(\n reverse('builds_detail', args=[project.slug, build.pk]),\n )\n\n\nclass BuildList(BuildBase, BuildTriggerMixin, ListView):\n\n def get_context_data(self, **kwargs):\n context = super().get_context_data(**kwargs)\n\n active_builds = self.get_queryset().exclude(\n state='finished',\n ).values('id')\n\n context['project'] = self.project\n context['active_builds'] = active_builds\n context['versions'] = Version.objects.public(\n user=self.request.user,\n project=self.project,\n )\n context['build_qs'] = self.get_queryset()\n\n return context\n\n\nclass BuildDetail(BuildBase, DetailView):\n pk_url_kwarg = 'build_pk'\n\n def get_context_data(self, **kwargs):\n context = super().get_context_data(**kwargs)\n context['project'] = self.project\n\n build = self.get_object()\n if build.error != BuildEnvironmentError.GENERIC_WITH_BUILD_ID.format(build_id=build.pk):\n # Do not suggest to open an issue if the error is not generic\n return context\n\n scheme = (\n 'https://github.com/rtfd/readthedocs.org/issues/new'\n '?title={title}{build_id}'\n '&body={body}'\n )\n\n # TODO: we could use ``.github/ISSUE_TEMPLATE.md`` here, but we would\n # need to add some variables to it which could impact in the UX when\n # filling an issue from the web\n body = \"\"\"\n ## Details:\n\n * Project URL: https://readthedocs.org/projects/{project_slug}/\n * Build URL(if applicable): https://readthedocs.org{build_path}\n * Read the Docs username(if applicable): {username}\n\n ## Expected Result\n\n *A description of what you wanted to happen*\n\n ## Actual Result\n\n *A description of what actually happened*\"\"\".format(\n project_slug=self.project,\n build_path=self.request.path,\n username=self.request.user,\n )\n\n scheme_dict = {\n 'title': quote('Build error with build id #'),\n 'build_id': context['build'].id,\n 'body': quote(textwrap.dedent(body)),\n }\n\n issue_url = scheme.format(**scheme_dict)\n issue_url = urlparse(issue_url).geturl()\n context['issue_url'] = issue_url\n return context\n\n\n# Old build view redirects\n\n\ndef builds_redirect_list(request, project_slug): # pylint: disable=unused-argument\n return HttpResponsePermanentRedirect(\n reverse('builds_project_list', args=[project_slug]),\n )\n\n\ndef builds_redirect_detail(request, project_slug, pk): # pylint: disable=unused-argument\n return HttpResponsePermanentRedirect(\n reverse('builds_detail', args=[project_slug, pk]),\n )\n", "path": "readthedocs/builds/views.py"}]} |
gh_patches_debug_290 | rasdani/github-patches | git_diff | redis__redis-py-2254 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
v4.3.3 continues to contain backwards incompatible change to ``redis.lock.Lock``
Hey this is a continuation of #2209.
The API change made in https://github.com/redis/redis-py/pull/2210/files does not restore backwards compatibility.
We are calling acquire like this:
```py
lock = redis.lock(
"_lock{0}".format(key),
timeout=self.lock_timeout,
sleep=self.lock_sleep,
thread_local=self.thread_local_lock,
)
lock.acquire(False)
```
this is broken by fa0be7671de6be85f859cbb57a31531b2482c9e1 which changes the API of lock.acquire() to use kw-only arguments.
since in #2209 it looks like py-redis has the willingness to revert these changes, hoping you can do that here also. otherwise we have a dogpile.cache patch ready to go out to work around this.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `redis/lock.py`
Content:
```
1 import threading
2 import time as mod_time
3 import uuid
4 from types import SimpleNamespace, TracebackType
5 from typing import Optional, Type
6
7 from redis.exceptions import LockError, LockNotOwnedError
8 from redis.typing import Number
9
10
11 class Lock:
12 """
13 A shared, distributed Lock. Using Redis for locking allows the Lock
14 to be shared across processes and/or machines.
15
16 It's left to the user to resolve deadlock issues and make sure
17 multiple clients play nicely together.
18 """
19
20 lua_release = None
21 lua_extend = None
22 lua_reacquire = None
23
24 # KEYS[1] - lock name
25 # ARGV[1] - token
26 # return 1 if the lock was released, otherwise 0
27 LUA_RELEASE_SCRIPT = """
28 local token = redis.call('get', KEYS[1])
29 if not token or token ~= ARGV[1] then
30 return 0
31 end
32 redis.call('del', KEYS[1])
33 return 1
34 """
35
36 # KEYS[1] - lock name
37 # ARGV[1] - token
38 # ARGV[2] - additional milliseconds
39 # ARGV[3] - "0" if the additional time should be added to the lock's
40 # existing ttl or "1" if the existing ttl should be replaced
41 # return 1 if the locks time was extended, otherwise 0
42 LUA_EXTEND_SCRIPT = """
43 local token = redis.call('get', KEYS[1])
44 if not token or token ~= ARGV[1] then
45 return 0
46 end
47 local expiration = redis.call('pttl', KEYS[1])
48 if not expiration then
49 expiration = 0
50 end
51 if expiration < 0 then
52 return 0
53 end
54
55 local newttl = ARGV[2]
56 if ARGV[3] == "0" then
57 newttl = ARGV[2] + expiration
58 end
59 redis.call('pexpire', KEYS[1], newttl)
60 return 1
61 """
62
63 # KEYS[1] - lock name
64 # ARGV[1] - token
65 # ARGV[2] - milliseconds
66 # return 1 if the locks time was reacquired, otherwise 0
67 LUA_REACQUIRE_SCRIPT = """
68 local token = redis.call('get', KEYS[1])
69 if not token or token ~= ARGV[1] then
70 return 0
71 end
72 redis.call('pexpire', KEYS[1], ARGV[2])
73 return 1
74 """
75
76 def __init__(
77 self,
78 redis,
79 name: str,
80 timeout: Optional[Number] = None,
81 sleep: Number = 0.1,
82 blocking: bool = True,
83 blocking_timeout: Optional[Number] = None,
84 thread_local: bool = True,
85 ):
86 """
87 Create a new Lock instance named ``name`` using the Redis client
88 supplied by ``redis``.
89
90 ``timeout`` indicates a maximum life for the lock in seconds.
91 By default, it will remain locked until release() is called.
92 ``timeout`` can be specified as a float or integer, both representing
93 the number of seconds to wait.
94
95 ``sleep`` indicates the amount of time to sleep in seconds per loop
96 iteration when the lock is in blocking mode and another client is
97 currently holding the lock.
98
99 ``blocking`` indicates whether calling ``acquire`` should block until
100 the lock has been acquired or to fail immediately, causing ``acquire``
101 to return False and the lock not being acquired. Defaults to True.
102 Note this value can be overridden by passing a ``blocking``
103 argument to ``acquire``.
104
105 ``blocking_timeout`` indicates the maximum amount of time in seconds to
106 spend trying to acquire the lock. A value of ``None`` indicates
107 continue trying forever. ``blocking_timeout`` can be specified as a
108 float or integer, both representing the number of seconds to wait.
109
110 ``thread_local`` indicates whether the lock token is placed in
111 thread-local storage. By default, the token is placed in thread local
112 storage so that a thread only sees its token, not a token set by
113 another thread. Consider the following timeline:
114
115 time: 0, thread-1 acquires `my-lock`, with a timeout of 5 seconds.
116 thread-1 sets the token to "abc"
117 time: 1, thread-2 blocks trying to acquire `my-lock` using the
118 Lock instance.
119 time: 5, thread-1 has not yet completed. redis expires the lock
120 key.
121 time: 5, thread-2 acquired `my-lock` now that it's available.
122 thread-2 sets the token to "xyz"
123 time: 6, thread-1 finishes its work and calls release(). if the
124 token is *not* stored in thread local storage, then
125 thread-1 would see the token value as "xyz" and would be
126 able to successfully release the thread-2's lock.
127
128 In some use cases it's necessary to disable thread local storage. For
129 example, if you have code where one thread acquires a lock and passes
130 that lock instance to a worker thread to release later. If thread
131 local storage isn't disabled in this case, the worker thread won't see
132 the token set by the thread that acquired the lock. Our assumption
133 is that these cases aren't common and as such default to using
134 thread local storage.
135 """
136 self.redis = redis
137 self.name = name
138 self.timeout = timeout
139 self.sleep = sleep
140 self.blocking = blocking
141 self.blocking_timeout = blocking_timeout
142 self.thread_local = bool(thread_local)
143 self.local = threading.local() if self.thread_local else SimpleNamespace()
144 self.local.token = None
145 self.register_scripts()
146
147 def register_scripts(self) -> None:
148 cls = self.__class__
149 client = self.redis
150 if cls.lua_release is None:
151 cls.lua_release = client.register_script(cls.LUA_RELEASE_SCRIPT)
152 if cls.lua_extend is None:
153 cls.lua_extend = client.register_script(cls.LUA_EXTEND_SCRIPT)
154 if cls.lua_reacquire is None:
155 cls.lua_reacquire = client.register_script(cls.LUA_REACQUIRE_SCRIPT)
156
157 def __enter__(self) -> "Lock":
158 if self.acquire():
159 return self
160 raise LockError("Unable to acquire lock within the time specified")
161
162 def __exit__(
163 self,
164 exc_type: Optional[Type[BaseException]],
165 exc_value: Optional[BaseException],
166 traceback: Optional[TracebackType],
167 ) -> None:
168 self.release()
169
170 def acquire(
171 self,
172 *,
173 sleep: Optional[Number] = None,
174 blocking: Optional[bool] = None,
175 blocking_timeout: Optional[Number] = None,
176 token: Optional[str] = None,
177 ):
178 """
179 Use Redis to hold a shared, distributed lock named ``name``.
180 Returns True once the lock is acquired.
181
182 If ``blocking`` is False, always return immediately. If the lock
183 was acquired, return True, otherwise return False.
184
185 ``blocking_timeout`` specifies the maximum number of seconds to
186 wait trying to acquire the lock.
187
188 ``token`` specifies the token value to be used. If provided, token
189 must be a bytes object or a string that can be encoded to a bytes
190 object with the default encoding. If a token isn't specified, a UUID
191 will be generated.
192 """
193 if sleep is None:
194 sleep = self.sleep
195 if token is None:
196 token = uuid.uuid1().hex.encode()
197 else:
198 encoder = self.redis.get_encoder()
199 token = encoder.encode(token)
200 if blocking is None:
201 blocking = self.blocking
202 if blocking_timeout is None:
203 blocking_timeout = self.blocking_timeout
204 stop_trying_at = None
205 if blocking_timeout is not None:
206 stop_trying_at = mod_time.monotonic() + blocking_timeout
207 while True:
208 if self.do_acquire(token):
209 self.local.token = token
210 return True
211 if not blocking:
212 return False
213 next_try_at = mod_time.monotonic() + sleep
214 if stop_trying_at is not None and next_try_at > stop_trying_at:
215 return False
216 mod_time.sleep(sleep)
217
218 def do_acquire(self, token: str) -> bool:
219 if self.timeout:
220 # convert to milliseconds
221 timeout = int(self.timeout * 1000)
222 else:
223 timeout = None
224 if self.redis.set(self.name, token, nx=True, px=timeout):
225 return True
226 return False
227
228 def locked(self) -> bool:
229 """
230 Returns True if this key is locked by any process, otherwise False.
231 """
232 return self.redis.get(self.name) is not None
233
234 def owned(self) -> bool:
235 """
236 Returns True if this key is locked by this lock, otherwise False.
237 """
238 stored_token = self.redis.get(self.name)
239 # need to always compare bytes to bytes
240 # TODO: this can be simplified when the context manager is finished
241 if stored_token and not isinstance(stored_token, bytes):
242 encoder = self.redis.get_encoder()
243 stored_token = encoder.encode(stored_token)
244 return self.local.token is not None and stored_token == self.local.token
245
246 def release(self) -> None:
247 """
248 Releases the already acquired lock
249 """
250 expected_token = self.local.token
251 if expected_token is None:
252 raise LockError("Cannot release an unlocked lock")
253 self.local.token = None
254 self.do_release(expected_token)
255
256 def do_release(self, expected_token: str) -> None:
257 if not bool(
258 self.lua_release(keys=[self.name], args=[expected_token], client=self.redis)
259 ):
260 raise LockNotOwnedError("Cannot release a lock" " that's no longer owned")
261
262 def extend(self, additional_time: int, replace_ttl: bool = False) -> bool:
263 """
264 Adds more time to an already acquired lock.
265
266 ``additional_time`` can be specified as an integer or a float, both
267 representing the number of seconds to add.
268
269 ``replace_ttl`` if False (the default), add `additional_time` to
270 the lock's existing ttl. If True, replace the lock's ttl with
271 `additional_time`.
272 """
273 if self.local.token is None:
274 raise LockError("Cannot extend an unlocked lock")
275 if self.timeout is None:
276 raise LockError("Cannot extend a lock with no timeout")
277 return self.do_extend(additional_time, replace_ttl)
278
279 def do_extend(self, additional_time: int, replace_ttl: bool) -> bool:
280 additional_time = int(additional_time * 1000)
281 if not bool(
282 self.lua_extend(
283 keys=[self.name],
284 args=[self.local.token, additional_time, "1" if replace_ttl else "0"],
285 client=self.redis,
286 )
287 ):
288 raise LockNotOwnedError("Cannot extend a lock that's no longer owned")
289 return True
290
291 def reacquire(self) -> bool:
292 """
293 Resets a TTL of an already acquired lock back to a timeout value.
294 """
295 if self.local.token is None:
296 raise LockError("Cannot reacquire an unlocked lock")
297 if self.timeout is None:
298 raise LockError("Cannot reacquire a lock with no timeout")
299 return self.do_reacquire()
300
301 def do_reacquire(self) -> bool:
302 timeout = int(self.timeout * 1000)
303 if not bool(
304 self.lua_reacquire(
305 keys=[self.name], args=[self.local.token, timeout], client=self.redis
306 )
307 ):
308 raise LockNotOwnedError("Cannot reacquire a lock that's no longer owned")
309 return True
310
```
--- 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/redis/lock.py b/redis/lock.py
--- a/redis/lock.py
+++ b/redis/lock.py
@@ -169,7 +169,6 @@
def acquire(
self,
- *,
sleep: Optional[Number] = None,
blocking: Optional[bool] = None,
blocking_timeout: Optional[Number] = None,
| {"golden_diff": "diff --git a/redis/lock.py b/redis/lock.py\n--- a/redis/lock.py\n+++ b/redis/lock.py\n@@ -169,7 +169,6 @@\n \n def acquire(\n self,\n- *,\n sleep: Optional[Number] = None,\n blocking: Optional[bool] = None,\n blocking_timeout: Optional[Number] = None,\n", "issue": "v4.3.3 continues to contain backwards incompatible change to ``redis.lock.Lock``\nHey this is a continuation of #2209.\r\n\r\nThe API change made in https://github.com/redis/redis-py/pull/2210/files does not restore backwards compatibility.\r\n\r\nWe are calling acquire like this:\r\n\r\n```py\r\nlock = redis.lock(\r\n \"_lock{0}\".format(key),\r\n timeout=self.lock_timeout,\r\n sleep=self.lock_sleep,\r\n thread_local=self.thread_local_lock,\r\n)\r\n\r\nlock.acquire(False)\r\n\r\n```\r\n\r\nthis is broken by fa0be7671de6be85f859cbb57a31531b2482c9e1 which changes the API of lock.acquire() to use kw-only arguments.\r\n\r\nsince in #2209 it looks like py-redis has the willingness to revert these changes, hoping you can do that here also. otherwise we have a dogpile.cache patch ready to go out to work around this.\n", "before_files": [{"content": "import threading\nimport time as mod_time\nimport uuid\nfrom types import SimpleNamespace, TracebackType\nfrom typing import Optional, Type\n\nfrom redis.exceptions import LockError, LockNotOwnedError\nfrom redis.typing import Number\n\n\nclass Lock:\n \"\"\"\n A shared, distributed Lock. Using Redis for locking allows the Lock\n to be shared across processes and/or machines.\n\n It's left to the user to resolve deadlock issues and make sure\n multiple clients play nicely together.\n \"\"\"\n\n lua_release = None\n lua_extend = None\n lua_reacquire = None\n\n # KEYS[1] - lock name\n # ARGV[1] - token\n # return 1 if the lock was released, otherwise 0\n LUA_RELEASE_SCRIPT = \"\"\"\n local token = redis.call('get', KEYS[1])\n if not token or token ~= ARGV[1] then\n return 0\n end\n redis.call('del', KEYS[1])\n return 1\n \"\"\"\n\n # KEYS[1] - lock name\n # ARGV[1] - token\n # ARGV[2] - additional milliseconds\n # ARGV[3] - \"0\" if the additional time should be added to the lock's\n # existing ttl or \"1\" if the existing ttl should be replaced\n # return 1 if the locks time was extended, otherwise 0\n LUA_EXTEND_SCRIPT = \"\"\"\n local token = redis.call('get', KEYS[1])\n if not token or token ~= ARGV[1] then\n return 0\n end\n local expiration = redis.call('pttl', KEYS[1])\n if not expiration then\n expiration = 0\n end\n if expiration < 0 then\n return 0\n end\n\n local newttl = ARGV[2]\n if ARGV[3] == \"0\" then\n newttl = ARGV[2] + expiration\n end\n redis.call('pexpire', KEYS[1], newttl)\n return 1\n \"\"\"\n\n # KEYS[1] - lock name\n # ARGV[1] - token\n # ARGV[2] - milliseconds\n # return 1 if the locks time was reacquired, otherwise 0\n LUA_REACQUIRE_SCRIPT = \"\"\"\n local token = redis.call('get', KEYS[1])\n if not token or token ~= ARGV[1] then\n return 0\n end\n redis.call('pexpire', KEYS[1], ARGV[2])\n return 1\n \"\"\"\n\n def __init__(\n self,\n redis,\n name: str,\n timeout: Optional[Number] = None,\n sleep: Number = 0.1,\n blocking: bool = True,\n blocking_timeout: Optional[Number] = None,\n thread_local: bool = True,\n ):\n \"\"\"\n Create a new Lock instance named ``name`` using the Redis client\n supplied by ``redis``.\n\n ``timeout`` indicates a maximum life for the lock in seconds.\n By default, it will remain locked until release() is called.\n ``timeout`` can be specified as a float or integer, both representing\n the number of seconds to wait.\n\n ``sleep`` indicates the amount of time to sleep in seconds per loop\n iteration when the lock is in blocking mode and another client is\n currently holding the lock.\n\n ``blocking`` indicates whether calling ``acquire`` should block until\n the lock has been acquired or to fail immediately, causing ``acquire``\n to return False and the lock not being acquired. Defaults to True.\n Note this value can be overridden by passing a ``blocking``\n argument to ``acquire``.\n\n ``blocking_timeout`` indicates the maximum amount of time in seconds to\n spend trying to acquire the lock. A value of ``None`` indicates\n continue trying forever. ``blocking_timeout`` can be specified as a\n float or integer, both representing the number of seconds to wait.\n\n ``thread_local`` indicates whether the lock token is placed in\n thread-local storage. By default, the token is placed in thread local\n storage so that a thread only sees its token, not a token set by\n another thread. Consider the following timeline:\n\n time: 0, thread-1 acquires `my-lock`, with a timeout of 5 seconds.\n thread-1 sets the token to \"abc\"\n time: 1, thread-2 blocks trying to acquire `my-lock` using the\n Lock instance.\n time: 5, thread-1 has not yet completed. redis expires the lock\n key.\n time: 5, thread-2 acquired `my-lock` now that it's available.\n thread-2 sets the token to \"xyz\"\n time: 6, thread-1 finishes its work and calls release(). if the\n token is *not* stored in thread local storage, then\n thread-1 would see the token value as \"xyz\" and would be\n able to successfully release the thread-2's lock.\n\n In some use cases it's necessary to disable thread local storage. For\n example, if you have code where one thread acquires a lock and passes\n that lock instance to a worker thread to release later. If thread\n local storage isn't disabled in this case, the worker thread won't see\n the token set by the thread that acquired the lock. Our assumption\n is that these cases aren't common and as such default to using\n thread local storage.\n \"\"\"\n self.redis = redis\n self.name = name\n self.timeout = timeout\n self.sleep = sleep\n self.blocking = blocking\n self.blocking_timeout = blocking_timeout\n self.thread_local = bool(thread_local)\n self.local = threading.local() if self.thread_local else SimpleNamespace()\n self.local.token = None\n self.register_scripts()\n\n def register_scripts(self) -> None:\n cls = self.__class__\n client = self.redis\n if cls.lua_release is None:\n cls.lua_release = client.register_script(cls.LUA_RELEASE_SCRIPT)\n if cls.lua_extend is None:\n cls.lua_extend = client.register_script(cls.LUA_EXTEND_SCRIPT)\n if cls.lua_reacquire is None:\n cls.lua_reacquire = client.register_script(cls.LUA_REACQUIRE_SCRIPT)\n\n def __enter__(self) -> \"Lock\":\n if self.acquire():\n return self\n raise LockError(\"Unable to acquire lock within the time specified\")\n\n def __exit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc_value: Optional[BaseException],\n traceback: Optional[TracebackType],\n ) -> None:\n self.release()\n\n def acquire(\n self,\n *,\n sleep: Optional[Number] = None,\n blocking: Optional[bool] = None,\n blocking_timeout: Optional[Number] = None,\n token: Optional[str] = None,\n ):\n \"\"\"\n Use Redis to hold a shared, distributed lock named ``name``.\n Returns True once the lock is acquired.\n\n If ``blocking`` is False, always return immediately. If the lock\n was acquired, return True, otherwise return False.\n\n ``blocking_timeout`` specifies the maximum number of seconds to\n wait trying to acquire the lock.\n\n ``token`` specifies the token value to be used. If provided, token\n must be a bytes object or a string that can be encoded to a bytes\n object with the default encoding. If a token isn't specified, a UUID\n will be generated.\n \"\"\"\n if sleep is None:\n sleep = self.sleep\n if token is None:\n token = uuid.uuid1().hex.encode()\n else:\n encoder = self.redis.get_encoder()\n token = encoder.encode(token)\n if blocking is None:\n blocking = self.blocking\n if blocking_timeout is None:\n blocking_timeout = self.blocking_timeout\n stop_trying_at = None\n if blocking_timeout is not None:\n stop_trying_at = mod_time.monotonic() + blocking_timeout\n while True:\n if self.do_acquire(token):\n self.local.token = token\n return True\n if not blocking:\n return False\n next_try_at = mod_time.monotonic() + sleep\n if stop_trying_at is not None and next_try_at > stop_trying_at:\n return False\n mod_time.sleep(sleep)\n\n def do_acquire(self, token: str) -> bool:\n if self.timeout:\n # convert to milliseconds\n timeout = int(self.timeout * 1000)\n else:\n timeout = None\n if self.redis.set(self.name, token, nx=True, px=timeout):\n return True\n return False\n\n def locked(self) -> bool:\n \"\"\"\n Returns True if this key is locked by any process, otherwise False.\n \"\"\"\n return self.redis.get(self.name) is not None\n\n def owned(self) -> bool:\n \"\"\"\n Returns True if this key is locked by this lock, otherwise False.\n \"\"\"\n stored_token = self.redis.get(self.name)\n # need to always compare bytes to bytes\n # TODO: this can be simplified when the context manager is finished\n if stored_token and not isinstance(stored_token, bytes):\n encoder = self.redis.get_encoder()\n stored_token = encoder.encode(stored_token)\n return self.local.token is not None and stored_token == self.local.token\n\n def release(self) -> None:\n \"\"\"\n Releases the already acquired lock\n \"\"\"\n expected_token = self.local.token\n if expected_token is None:\n raise LockError(\"Cannot release an unlocked lock\")\n self.local.token = None\n self.do_release(expected_token)\n\n def do_release(self, expected_token: str) -> None:\n if not bool(\n self.lua_release(keys=[self.name], args=[expected_token], client=self.redis)\n ):\n raise LockNotOwnedError(\"Cannot release a lock\" \" that's no longer owned\")\n\n def extend(self, additional_time: int, replace_ttl: bool = False) -> bool:\n \"\"\"\n Adds more time to an already acquired lock.\n\n ``additional_time`` can be specified as an integer or a float, both\n representing the number of seconds to add.\n\n ``replace_ttl`` if False (the default), add `additional_time` to\n the lock's existing ttl. If True, replace the lock's ttl with\n `additional_time`.\n \"\"\"\n if self.local.token is None:\n raise LockError(\"Cannot extend an unlocked lock\")\n if self.timeout is None:\n raise LockError(\"Cannot extend a lock with no timeout\")\n return self.do_extend(additional_time, replace_ttl)\n\n def do_extend(self, additional_time: int, replace_ttl: bool) -> bool:\n additional_time = int(additional_time * 1000)\n if not bool(\n self.lua_extend(\n keys=[self.name],\n args=[self.local.token, additional_time, \"1\" if replace_ttl else \"0\"],\n client=self.redis,\n )\n ):\n raise LockNotOwnedError(\"Cannot extend a lock that's no longer owned\")\n return True\n\n def reacquire(self) -> bool:\n \"\"\"\n Resets a TTL of an already acquired lock back to a timeout value.\n \"\"\"\n if self.local.token is None:\n raise LockError(\"Cannot reacquire an unlocked lock\")\n if self.timeout is None:\n raise LockError(\"Cannot reacquire a lock with no timeout\")\n return self.do_reacquire()\n\n def do_reacquire(self) -> bool:\n timeout = int(self.timeout * 1000)\n if not bool(\n self.lua_reacquire(\n keys=[self.name], args=[self.local.token, timeout], client=self.redis\n )\n ):\n raise LockNotOwnedError(\"Cannot reacquire a lock that's no longer owned\")\n return True\n", "path": "redis/lock.py"}], "after_files": [{"content": "import threading\nimport time as mod_time\nimport uuid\nfrom types import SimpleNamespace, TracebackType\nfrom typing import Optional, Type\n\nfrom redis.exceptions import LockError, LockNotOwnedError\nfrom redis.typing import Number\n\n\nclass Lock:\n \"\"\"\n A shared, distributed Lock. Using Redis for locking allows the Lock\n to be shared across processes and/or machines.\n\n It's left to the user to resolve deadlock issues and make sure\n multiple clients play nicely together.\n \"\"\"\n\n lua_release = None\n lua_extend = None\n lua_reacquire = None\n\n # KEYS[1] - lock name\n # ARGV[1] - token\n # return 1 if the lock was released, otherwise 0\n LUA_RELEASE_SCRIPT = \"\"\"\n local token = redis.call('get', KEYS[1])\n if not token or token ~= ARGV[1] then\n return 0\n end\n redis.call('del', KEYS[1])\n return 1\n \"\"\"\n\n # KEYS[1] - lock name\n # ARGV[1] - token\n # ARGV[2] - additional milliseconds\n # ARGV[3] - \"0\" if the additional time should be added to the lock's\n # existing ttl or \"1\" if the existing ttl should be replaced\n # return 1 if the locks time was extended, otherwise 0\n LUA_EXTEND_SCRIPT = \"\"\"\n local token = redis.call('get', KEYS[1])\n if not token or token ~= ARGV[1] then\n return 0\n end\n local expiration = redis.call('pttl', KEYS[1])\n if not expiration then\n expiration = 0\n end\n if expiration < 0 then\n return 0\n end\n\n local newttl = ARGV[2]\n if ARGV[3] == \"0\" then\n newttl = ARGV[2] + expiration\n end\n redis.call('pexpire', KEYS[1], newttl)\n return 1\n \"\"\"\n\n # KEYS[1] - lock name\n # ARGV[1] - token\n # ARGV[2] - milliseconds\n # return 1 if the locks time was reacquired, otherwise 0\n LUA_REACQUIRE_SCRIPT = \"\"\"\n local token = redis.call('get', KEYS[1])\n if not token or token ~= ARGV[1] then\n return 0\n end\n redis.call('pexpire', KEYS[1], ARGV[2])\n return 1\n \"\"\"\n\n def __init__(\n self,\n redis,\n name: str,\n timeout: Optional[Number] = None,\n sleep: Number = 0.1,\n blocking: bool = True,\n blocking_timeout: Optional[Number] = None,\n thread_local: bool = True,\n ):\n \"\"\"\n Create a new Lock instance named ``name`` using the Redis client\n supplied by ``redis``.\n\n ``timeout`` indicates a maximum life for the lock in seconds.\n By default, it will remain locked until release() is called.\n ``timeout`` can be specified as a float or integer, both representing\n the number of seconds to wait.\n\n ``sleep`` indicates the amount of time to sleep in seconds per loop\n iteration when the lock is in blocking mode and another client is\n currently holding the lock.\n\n ``blocking`` indicates whether calling ``acquire`` should block until\n the lock has been acquired or to fail immediately, causing ``acquire``\n to return False and the lock not being acquired. Defaults to True.\n Note this value can be overridden by passing a ``blocking``\n argument to ``acquire``.\n\n ``blocking_timeout`` indicates the maximum amount of time in seconds to\n spend trying to acquire the lock. A value of ``None`` indicates\n continue trying forever. ``blocking_timeout`` can be specified as a\n float or integer, both representing the number of seconds to wait.\n\n ``thread_local`` indicates whether the lock token is placed in\n thread-local storage. By default, the token is placed in thread local\n storage so that a thread only sees its token, not a token set by\n another thread. Consider the following timeline:\n\n time: 0, thread-1 acquires `my-lock`, with a timeout of 5 seconds.\n thread-1 sets the token to \"abc\"\n time: 1, thread-2 blocks trying to acquire `my-lock` using the\n Lock instance.\n time: 5, thread-1 has not yet completed. redis expires the lock\n key.\n time: 5, thread-2 acquired `my-lock` now that it's available.\n thread-2 sets the token to \"xyz\"\n time: 6, thread-1 finishes its work and calls release(). if the\n token is *not* stored in thread local storage, then\n thread-1 would see the token value as \"xyz\" and would be\n able to successfully release the thread-2's lock.\n\n In some use cases it's necessary to disable thread local storage. For\n example, if you have code where one thread acquires a lock and passes\n that lock instance to a worker thread to release later. If thread\n local storage isn't disabled in this case, the worker thread won't see\n the token set by the thread that acquired the lock. Our assumption\n is that these cases aren't common and as such default to using\n thread local storage.\n \"\"\"\n self.redis = redis\n self.name = name\n self.timeout = timeout\n self.sleep = sleep\n self.blocking = blocking\n self.blocking_timeout = blocking_timeout\n self.thread_local = bool(thread_local)\n self.local = threading.local() if self.thread_local else SimpleNamespace()\n self.local.token = None\n self.register_scripts()\n\n def register_scripts(self) -> None:\n cls = self.__class__\n client = self.redis\n if cls.lua_release is None:\n cls.lua_release = client.register_script(cls.LUA_RELEASE_SCRIPT)\n if cls.lua_extend is None:\n cls.lua_extend = client.register_script(cls.LUA_EXTEND_SCRIPT)\n if cls.lua_reacquire is None:\n cls.lua_reacquire = client.register_script(cls.LUA_REACQUIRE_SCRIPT)\n\n def __enter__(self) -> \"Lock\":\n if self.acquire():\n return self\n raise LockError(\"Unable to acquire lock within the time specified\")\n\n def __exit__(\n self,\n exc_type: Optional[Type[BaseException]],\n exc_value: Optional[BaseException],\n traceback: Optional[TracebackType],\n ) -> None:\n self.release()\n\n def acquire(\n self,\n sleep: Optional[Number] = None,\n blocking: Optional[bool] = None,\n blocking_timeout: Optional[Number] = None,\n token: Optional[str] = None,\n ):\n \"\"\"\n Use Redis to hold a shared, distributed lock named ``name``.\n Returns True once the lock is acquired.\n\n If ``blocking`` is False, always return immediately. If the lock\n was acquired, return True, otherwise return False.\n\n ``blocking_timeout`` specifies the maximum number of seconds to\n wait trying to acquire the lock.\n\n ``token`` specifies the token value to be used. If provided, token\n must be a bytes object or a string that can be encoded to a bytes\n object with the default encoding. If a token isn't specified, a UUID\n will be generated.\n \"\"\"\n if sleep is None:\n sleep = self.sleep\n if token is None:\n token = uuid.uuid1().hex.encode()\n else:\n encoder = self.redis.get_encoder()\n token = encoder.encode(token)\n if blocking is None:\n blocking = self.blocking\n if blocking_timeout is None:\n blocking_timeout = self.blocking_timeout\n stop_trying_at = None\n if blocking_timeout is not None:\n stop_trying_at = mod_time.monotonic() + blocking_timeout\n while True:\n if self.do_acquire(token):\n self.local.token = token\n return True\n if not blocking:\n return False\n next_try_at = mod_time.monotonic() + sleep\n if stop_trying_at is not None and next_try_at > stop_trying_at:\n return False\n mod_time.sleep(sleep)\n\n def do_acquire(self, token: str) -> bool:\n if self.timeout:\n # convert to milliseconds\n timeout = int(self.timeout * 1000)\n else:\n timeout = None\n if self.redis.set(self.name, token, nx=True, px=timeout):\n return True\n return False\n\n def locked(self) -> bool:\n \"\"\"\n Returns True if this key is locked by any process, otherwise False.\n \"\"\"\n return self.redis.get(self.name) is not None\n\n def owned(self) -> bool:\n \"\"\"\n Returns True if this key is locked by this lock, otherwise False.\n \"\"\"\n stored_token = self.redis.get(self.name)\n # need to always compare bytes to bytes\n # TODO: this can be simplified when the context manager is finished\n if stored_token and not isinstance(stored_token, bytes):\n encoder = self.redis.get_encoder()\n stored_token = encoder.encode(stored_token)\n return self.local.token is not None and stored_token == self.local.token\n\n def release(self) -> None:\n \"\"\"\n Releases the already acquired lock\n \"\"\"\n expected_token = self.local.token\n if expected_token is None:\n raise LockError(\"Cannot release an unlocked lock\")\n self.local.token = None\n self.do_release(expected_token)\n\n def do_release(self, expected_token: str) -> None:\n if not bool(\n self.lua_release(keys=[self.name], args=[expected_token], client=self.redis)\n ):\n raise LockNotOwnedError(\"Cannot release a lock\" \" that's no longer owned\")\n\n def extend(self, additional_time: int, replace_ttl: bool = False) -> bool:\n \"\"\"\n Adds more time to an already acquired lock.\n\n ``additional_time`` can be specified as an integer or a float, both\n representing the number of seconds to add.\n\n ``replace_ttl`` if False (the default), add `additional_time` to\n the lock's existing ttl. If True, replace the lock's ttl with\n `additional_time`.\n \"\"\"\n if self.local.token is None:\n raise LockError(\"Cannot extend an unlocked lock\")\n if self.timeout is None:\n raise LockError(\"Cannot extend a lock with no timeout\")\n return self.do_extend(additional_time, replace_ttl)\n\n def do_extend(self, additional_time: int, replace_ttl: bool) -> bool:\n additional_time = int(additional_time * 1000)\n if not bool(\n self.lua_extend(\n keys=[self.name],\n args=[self.local.token, additional_time, \"1\" if replace_ttl else \"0\"],\n client=self.redis,\n )\n ):\n raise LockNotOwnedError(\"Cannot extend a lock that's no longer owned\")\n return True\n\n def reacquire(self) -> bool:\n \"\"\"\n Resets a TTL of an already acquired lock back to a timeout value.\n \"\"\"\n if self.local.token is None:\n raise LockError(\"Cannot reacquire an unlocked lock\")\n if self.timeout is None:\n raise LockError(\"Cannot reacquire a lock with no timeout\")\n return self.do_reacquire()\n\n def do_reacquire(self) -> bool:\n timeout = int(self.timeout * 1000)\n if not bool(\n self.lua_reacquire(\n keys=[self.name], args=[self.local.token, timeout], client=self.redis\n )\n ):\n raise LockNotOwnedError(\"Cannot reacquire a lock that's no longer owned\")\n return True\n", "path": "redis/lock.py"}]} |
gh_patches_debug_291 | rasdani/github-patches | git_diff | buildbot__buildbot-1214 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
New web plugin idea: a health indicator
This ticket is a migrated Trac ticket [2966](http://trac.buildbot.net/ticket/2966)
People contributed to the original ticket: `benoit.allard@...`, @tardyp, @rutsky, @unknown_contributor, @sa2ajj, @rutsky
Ticket created on: `Oct 24 2014`
Ticket last modified on: `Mar 19 2016`
---
I like to extract as much useful indicator from my builds as possible (time, but also amount of warnings, and such ...)
It would be cool to have a web plugin that could print the evolution of my indicators over time ! (Of course, I would have to configure which indicator I want to see plotted, maybe the kind of plot, and so on ...)
---
_Comment from_: @sa2ajj
_Date_: `Oct 24 2014`
Could you please elaborate or provide a more specific example?
I think it's related to the [[metrics support|http://docs.buildbot.net/latest/developer/metrics.html]], but without an example I can easily be wrong :)
---
_Comment from_: @Ben
_Date_: `Oct 24 2014`
I was more aiming at [[Statistics|http://docs.buildbot.net/latest/developer/cls-buildsteps.html?highlight=statistics#buildbot.process.buildstep.[[BuildStep]].hasStatistic]], but I just realized that
Note that statistics are not preserved after a build is complete.
So metrics is probably where we want to interface with the master.
I used to abuse Properties for that purpose ...
---
_Comment from_: @tardyp
_Date_: `Oct 24 2014`
Buildbot plugin system is really made for enabling such dashboards.
A web ui plugin is not technically restricted to creating a bunch of js file, it could also create a twisted service.
For me having the JS only use existing data api to query the data will be very inefficient. I think we could easily create a service, like a status service that registers to a bunch of mq events, and create statistics based on that.
I also had in mind that plugins could have some table in the DB they could use to store the data, or maybe use another db configuration with all schema + migration stuff separated.
---
_Comment from_: @tardyp
_Date_: `Oct 26 2014`
on IRC, sa2ajj talked about http://graphite.readthedocs.org/
He told us, he actually uses it at work, and has integration working with eigth.
Looking at the documentation, the first reaction is how to integrate this with multimaster, as graphite has its own db called whisper.
I haven't look too much deeply, but I think this is still feasible as a external tool. Probably this would be much cheaper than making our own metrics system inside buildbot.
An external graphite server could be setup, and watch for the (TBD) mq server. As there are messages for nearly every kind of activity that happens in buildbot, this is a good mean of making solid analysis of what is going on. Of course, this solution would not be fully integrated, as probably the UI would be external, but anyway, I think this is a possible cheap path.
@sa2ajj do you think it is possible? How would you estimate the cost of integration?
---
_Comment from_: @Ben
_Date_: `Oct 26 2014`
There are a lot of [[interfaces|http://graphite.readthedocs.org/en/latest/tools.html#visualization]], as well as data collectors / forwarders (same page, a bit higher) available for graphite. It looks like some of them are js-only ! Still way to go for a www-plugin !
---
_Comment from_: @sa2ajj
_Date_: `Oct 27 2014`
What I said was that we indeed use graphite, but I did not say we use it with Buildbot.
I have an oldish branch where I tried to publish metrics to graphite. However I stopped working on that when I realised that it's not very straightforward to implement it to support multi-master case.
If there's an interest, I can revive the branch or, at least, publish what I have (after rebasing the latest master) so other could comment in what direction my thinking worked.
---
_Comment from_: @unknown_contributor
_Date_: `Mar 19 2016`
+1 for this feature. I suggest to merge the statistic API with the [[stats module|https://github.com/buildbot/buildbot/tree/master/master/buildbot/statistics]] developed last year by my GSOC student. And add a default backend that store a subset of these stat in the main database that would enable the development of heath/stats visualization modules directly installed by default (using Highchart js lib for example)
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `pkg/setup.py`
Content:
```
1 #!/usr/bin/env python
2 #
3 # This file is part of Buildbot. Buildbot is free software: you can
4 # redistribute it and/or modify it under the terms of the GNU General Public
5 # License as published by the Free Software Foundation, version 2.
6 #
7 # This program is distributed in the hope that it will be useful, but WITHOUT
8 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
9 # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
10 # details.
11 #
12 # You should have received a copy of the GNU General Public License along with
13 # this program; if not, write to the Free Software Foundation, Inc., 51
14 # Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
15 #
16 # Copyright Buildbot Team Members
17
18 from setuptools import setup
19 import buildbot_pkg
20
21 setup(
22 name='buildbot_pkg',
23 version=buildbot_pkg.getVersion("."),
24 description='Buildbot packaging tools',
25 author=u'Pierre Tardy',
26 author_email=u'[email protected]',
27 url='http://buildbot.net/',
28 license='GNU GPL',
29 py_modules=['buildbot_pkg'],
30 )
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/pkg/setup.py b/pkg/setup.py
--- a/pkg/setup.py
+++ b/pkg/setup.py
@@ -19,7 +19,7 @@
import buildbot_pkg
setup(
- name='buildbot_pkg',
+ name='buildbot-pkg',
version=buildbot_pkg.getVersion("."),
description='Buildbot packaging tools',
author=u'Pierre Tardy',
| {"golden_diff": "diff --git a/pkg/setup.py b/pkg/setup.py\n--- a/pkg/setup.py\n+++ b/pkg/setup.py\n@@ -19,7 +19,7 @@\n import buildbot_pkg\n \n setup(\n- name='buildbot_pkg',\n+ name='buildbot-pkg',\n version=buildbot_pkg.getVersion(\".\"),\n description='Buildbot packaging tools',\n author=u'Pierre Tardy',\n", "issue": "New web plugin idea: a health indicator\nThis ticket is a migrated Trac ticket [2966](http://trac.buildbot.net/ticket/2966)\n\nPeople contributed to the original ticket: `benoit.allard@...`, @tardyp, @rutsky, @unknown_contributor, @sa2ajj, @rutsky\nTicket created on: `Oct 24 2014`\nTicket last modified on: `Mar 19 2016`\n\n---\n\nI like to extract as much useful indicator from my builds as possible (time, but also amount of warnings, and such ...)\n\nIt would be cool to have a web plugin that could print the evolution of my indicators over time ! (Of course, I would have to configure which indicator I want to see plotted, maybe the kind of plot, and so on ...)\n\n\n---\n\n_Comment from_: @sa2ajj\n_Date_: `Oct 24 2014`\n\nCould you please elaborate or provide a more specific example?\n\nI think it's related to the [[metrics support|http://docs.buildbot.net/latest/developer/metrics.html]], but without an example I can easily be wrong :)\n\n---\n_Comment from_: @Ben\n_Date_: `Oct 24 2014`\n\nI was more aiming at [[Statistics|http://docs.buildbot.net/latest/developer/cls-buildsteps.html?highlight=statistics#buildbot.process.buildstep.[[BuildStep]].hasStatistic]], but I just realized that\n\n Note that statistics are not preserved after a build is complete.\n\nSo metrics is probably where we want to interface with the master.\n\nI used to abuse Properties for that purpose ...\n\n---\n_Comment from_: @tardyp\n_Date_: `Oct 24 2014`\n\nBuildbot plugin system is really made for enabling such dashboards.\n\nA web ui plugin is not technically restricted to creating a bunch of js file, it could also create a twisted service.\n\nFor me having the JS only use existing data api to query the data will be very inefficient. I think we could easily create a service, like a status service that registers to a bunch of mq events, and create statistics based on that.\n\nI also had in mind that plugins could have some table in the DB they could use to store the data, or maybe use another db configuration with all schema + migration stuff separated.\n\n\n---\n_Comment from_: @tardyp\n_Date_: `Oct 26 2014`\n\non IRC, sa2ajj talked about http://graphite.readthedocs.org/\n\nHe told us, he actually uses it at work, and has integration working with eigth.\n\nLooking at the documentation, the first reaction is how to integrate this with multimaster, as graphite has its own db called whisper.\nI haven't look too much deeply, but I think this is still feasible as a external tool. Probably this would be much cheaper than making our own metrics system inside buildbot.\n\nAn external graphite server could be setup, and watch for the (TBD) mq server. As there are messages for nearly every kind of activity that happens in buildbot, this is a good mean of making solid analysis of what is going on. Of course, this solution would not be fully integrated, as probably the UI would be external, but anyway, I think this is a possible cheap path.\n\n@sa2ajj do you think it is possible? How would you estimate the cost of integration?\n\n\n\n\n---\n_Comment from_: @Ben\n_Date_: `Oct 26 2014`\n\nThere are a lot of [[interfaces|http://graphite.readthedocs.org/en/latest/tools.html#visualization]], as well as data collectors / forwarders (same page, a bit higher) available for graphite. It looks like some of them are js-only ! Still way to go for a www-plugin !\n\n---\n_Comment from_: @sa2ajj\n_Date_: `Oct 27 2014`\n\nWhat I said was that we indeed use graphite, but I did not say we use it with Buildbot.\n\nI have an oldish branch where I tried to publish metrics to graphite. However I stopped working on that when I realised that it's not very straightforward to implement it to support multi-master case.\n\nIf there's an interest, I can revive the branch or, at least, publish what I have (after rebasing the latest master) so other could comment in what direction my thinking worked.\n\n---\n_Comment from_: @unknown_contributor\n_Date_: `Mar 19 2016`\n\n+1 for this feature. I suggest to merge the statistic API with the [[stats module|https://github.com/buildbot/buildbot/tree/master/master/buildbot/statistics]] developed last year by my GSOC student. And add a default backend that store a subset of these stat in the main database that would enable the development of heath/stats visualization modules directly installed by default (using Highchart js lib for example) \n\n\n", "before_files": [{"content": "#!/usr/bin/env python\n#\n# This file is part of Buildbot. Buildbot is free software: you can\n# redistribute it and/or modify it under the terms of the GNU General Public\n# License as published by the Free Software Foundation, version 2.\n#\n# This program is distributed in the hope that it will be useful, but WITHOUT\n# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\n# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more\n# details.\n#\n# You should have received a copy of the GNU General Public License along with\n# this program; if not, write to the Free Software Foundation, Inc., 51\n# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n#\n# Copyright Buildbot Team Members\n\nfrom setuptools import setup\nimport buildbot_pkg\n\nsetup(\n name='buildbot_pkg',\n version=buildbot_pkg.getVersion(\".\"),\n description='Buildbot packaging tools',\n author=u'Pierre Tardy',\n author_email=u'[email protected]',\n url='http://buildbot.net/',\n license='GNU GPL',\n py_modules=['buildbot_pkg'],\n)\n", "path": "pkg/setup.py"}], "after_files": [{"content": "#!/usr/bin/env python\n#\n# This file is part of Buildbot. Buildbot is free software: you can\n# redistribute it and/or modify it under the terms of the GNU General Public\n# License as published by the Free Software Foundation, version 2.\n#\n# This program is distributed in the hope that it will be useful, but WITHOUT\n# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\n# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more\n# details.\n#\n# You should have received a copy of the GNU General Public License along with\n# this program; if not, write to the Free Software Foundation, Inc., 51\n# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n#\n# Copyright Buildbot Team Members\n\nfrom setuptools import setup\nimport buildbot_pkg\n\nsetup(\n name='buildbot-pkg',\n version=buildbot_pkg.getVersion(\".\"),\n description='Buildbot packaging tools',\n author=u'Pierre Tardy',\n author_email=u'[email protected]',\n url='http://buildbot.net/',\n license='GNU GPL',\n py_modules=['buildbot_pkg'],\n)\n", "path": "pkg/setup.py"}]} |
gh_patches_debug_292 | rasdani/github-patches | git_diff | DistrictDataLabs__yellowbrick-904 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Overhaul unittest and fixtures
Remove dependency on `unittest.TestCase` by replacing assertions with `assert` statements. This also involves using `pytest.raises` and `pytest.skip` decorators.
Use PyTest fixtures for datasets and other fixtures.
~Add PEP checking to pytest (alongside pyflakes)~
- [x] rename `ThingTests` to `TestThing`
- [x] assertions
- [x] pytest.skip
- [x] dataset fixtures
- [ ] ~PEP8~
Alongside this we should also do a PY2 removal check, namely anywhere:
```python
try:
from unittest import mock
except ImportError:
import mock
```
should be replaced with just `from unittest import mock`
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `yellowbrick/features/rfecv.py`
Content:
```
1 # yellowbrick.features.rfecv
2 # Visualize the number of features selected with recursive feature elimination
3 #
4 # Author: Benjamin Bengfort <[email protected]>
5 # Created: Tue Apr 03 17:31:37 2018 -0400
6 #
7 # ID: rfecv.py [] [email protected] $
8
9 """
10 Visualize the number of features selected using recursive feature elimination
11 """
12
13 ##########################################################################
14 ## Imports
15 ##########################################################################
16
17 import numpy as np
18
19 from yellowbrick.base import ModelVisualizer
20 from yellowbrick.exceptions import YellowbrickValueError
21
22 from sklearn.utils import check_X_y
23 from sklearn.feature_selection import RFE
24 from sklearn.model_selection import cross_val_score
25
26
27 ##########################################################################
28 ## Recursive Feature Elimination
29 ##########################################################################
30
31 class RFECV(ModelVisualizer):
32 """
33 Recursive Feature Elimination, Cross-Validated (RFECV) feature selection.
34
35 Selects the best subset of features for the supplied estimator by removing
36 0 to N features (where N is the number of features) using recursive
37 feature elimination, then selecting the best subset based on the
38 cross-validation score of the model. Recursive feature elimination
39 eliminates n features from a model by fitting the model multiple times and
40 at each step, removing the weakest features, determined by either the
41 ``coef_`` or ``feature_importances_`` attribute of the fitted model.
42
43 The visualization plots the score relative to each subset and shows trends
44 in feature elimination. If the feature elimination CV score is flat, then
45 potentially there are not enough features in the model. An ideal curve is
46 when the score jumps from low to high as the number of features removed
47 increases, then slowly decreases again from the optimal number of
48 features.
49
50 Parameters
51 ----------
52 model : a scikit-learn estimator
53 An object that implements ``fit`` and provides information about the
54 relative importance of features with either a ``coef_`` or
55 ``feature_importances_`` attribute.
56
57 Note that the object is cloned for each validation.
58
59 ax : matplotlib.Axes object, optional
60 The axes object to plot the figure on.
61
62 step : int or float, optional (default=1)
63 If greater than or equal to 1, then step corresponds to the (integer)
64 number of features to remove at each iteration. If within (0.0, 1.0),
65 then step corresponds to the percentage (rounded down) of features to
66 remove at each iteration.
67
68 groups : array-like, with shape (n_samples,), optional
69 Group labels for the samples used while splitting the dataset into
70 train/test set.
71
72 cv : int, cross-validation generator or an iterable, optional
73 Determines the cross-validation splitting strategy.
74 Possible inputs for cv are:
75
76 - None, to use the default 3-fold cross-validation,
77 - integer, to specify the number of folds.
78 - An object to be used as a cross-validation generator.
79 - An iterable yielding train/test splits.
80
81 see the scikit-learn
82 `cross-validation guide <http://scikit-learn.org/stable/modules/cross_validation.html>`_
83 for more information on the possible strategies that can be used here.
84
85 scoring : string, callable or None, optional, default: None
86 A string or scorer callable object / function with signature
87 ``scorer(estimator, X, y)``. See scikit-learn model evaluation
88 documentation for names of possible metrics.
89
90 kwargs : dict
91 Keyword arguments that are passed to the base class and may influence
92 the visualization as defined in other Visualizers.
93
94 Attributes
95 ----------
96 n_features_ : int
97 The number of features in the selected subset
98
99 support_ : array of shape [n_features]
100 A mask of the selected features
101
102 ranking_ : array of shape [n_features]
103 The feature ranking, such that ``ranking_[i]`` corresponds to the
104 ranked position of feature i. Selected features are assigned rank 1.
105
106 cv_scores_ : array of shape [n_subsets_of_features, n_splits]
107 The cross-validation scores for each subset of features and splits in
108 the cross-validation strategy.
109
110 rfe_estimator_ : sklearn.feature_selection.RFE
111 A fitted RFE estimator wrapping the original estimator. All estimator
112 functions such as ``predict()`` and ``score()`` are passed through to
113 this estimator (it rewraps the original model).
114
115 n_feature_subsets_ : array of shape [n_subsets_of_features]
116 The number of features removed on each iteration of RFE, computed by the
117 number of features in the dataset and the step parameter.
118
119 Notes
120 -----
121 This model wraps ``sklearn.feature_selection.RFE`` and not
122 ``sklearn.feature_selection.RFECV`` because access to the internals of the
123 CV and RFE estimators is required for the visualization. The visualizer
124 does take similar arguments, however it does not expose the same internal
125 attributes.
126
127 Additionally, the RFE model can be accessed via the ``rfe_estimator_``
128 attribute. Once fitted, the visualizer acts as a wrapper for this
129 estimator and not for the original model passed to the model. This way the
130 visualizer model can be used to make predictions.
131
132 .. caution:: This visualizer requires a model that has either a ``coef_``
133 or ``feature_importances_`` attribute when fitted.
134 """
135
136 def __init__(self, model, ax=None, step=1, groups=None, cv=None,
137 scoring=None, **kwargs):
138
139 # Initialize the model visualizer
140 super(RFECV, self).__init__(model, ax=ax, **kwargs)
141
142 # Set parameters
143 self.set_params(step=step, groups=groups, cv=cv, scoring=scoring)
144
145 def fit(self, X, y=None):
146 """
147 Fits the RFECV with the wrapped model to the specified data and draws
148 the rfecv curve with the optimal number of features found.
149
150 Parameters
151 ----------
152 X : array-like, shape (n_samples, n_features)
153 Training vector, where n_samples is the number of samples and
154 n_features is the number of features.
155
156 y : array-like, shape (n_samples) or (n_samples, n_features), optional
157 Target relative to X for classification or regression.
158
159 Returns
160 -------
161 self : instance
162 Returns the instance of the RFECV visualizer.
163 """
164 X, y = check_X_y(X, y, "csr")
165 n_features = X.shape[1]
166
167 # This check is kind of unnecessary since RFE will do it, but it's
168 # nice to get it out of the way ASAP and raise a meaningful error.
169 if 0.0 < self.step < 1.0:
170 step = int(max(1, self.step * n_features))
171 else:
172 step = int(self.step)
173
174 if step < 0:
175 raise YellowbrickValueError("step must be >0")
176
177 # Create the RFE model
178 rfe = RFE(self.estimator, step=step)
179 self.n_feature_subsets_ = np.arange(1, n_features+step, step)
180
181 # Create the cross validation params
182 # TODO: handle random state
183 cv_params = {
184 key: self.get_params()[key]
185 for key in ('groups', 'cv', 'scoring')
186 }
187
188 # Perform cross-validation for each feature subset
189 scores = []
190 for n_features_to_select in self.n_feature_subsets_:
191 rfe.set_params(n_features_to_select=n_features_to_select)
192 scores.append(cross_val_score(rfe, X, y, **cv_params))
193
194 # Convert scores to array
195 self.cv_scores_ = np.array(scores)
196
197 # Find the best RFE model
198 bestidx = self.cv_scores_.mean(axis=1).argmax()
199 self.n_features_ = self.n_feature_subsets_[bestidx]
200
201 # Fit the final RFE model for the number of features
202 self.rfe_estimator_ = rfe
203 self.rfe_estimator_.set_params(n_features_to_select=self.n_features_)
204 self.rfe_estimator_.fit(X, y)
205
206 # Rewrap the visualizer to use the rfe estimator
207 self._wrapped = self.rfe_estimator_
208
209 # Hoist the RFE params to the visualizer
210 self.support_ = self.rfe_estimator_.support_
211 self.ranking_ = self.rfe_estimator_.ranking_
212
213 self.draw()
214 return self
215
216 def draw(self, **kwargs):
217 """
218 Renders the rfecv curve.
219 """
220 # Compute the curves
221 x = self.n_feature_subsets_
222 means = self.cv_scores_.mean(axis=1)
223 sigmas = self.cv_scores_.std(axis=1)
224
225
226 # Plot one standard deviation above and below the mean
227 self.ax.fill_between(x, means - sigmas, means+sigmas, alpha=0.25)
228
229 # Plot the curve
230 self.ax.plot(x, means, 'o-')
231
232 # Plot the maximum number of features
233 self.ax.axvline(
234 self.n_features_, c='k', ls='--',
235 label="n_features = {}\nscore = {:0.3f}".format(
236 self.n_features_, self.cv_scores_.mean(axis=1).max()
237 )
238 )
239
240 return self.ax
241
242 def finalize(self, **kwargs):
243 """
244 Add the title, legend, and other visual final touches to the plot.
245 """
246 # Set the title of the figure
247 self.set_title('RFECV for {}'.format(self.name))
248
249 # Add the legend
250 self.ax.legend(frameon=True, loc='best')
251
252 # Set the axis labels
253 self.ax.set_xlabel('Number of Features Selected')
254 self.ax.set_ylabel('Score')
255
256
257 ##########################################################################
258 ## Quick Methods
259 ##########################################################################
260
261 def rfecv(model, X, y, ax=None, step=1, groups=None, cv=None,
262 scoring=None, **kwargs):
263 """
264 Performs recursive feature elimination with cross-validation to determine
265 an optimal number of features for a model. Visualizes the feature subsets
266 with respect to the cross-validation score.
267
268 This helper function is a quick wrapper to utilize the RFECV visualizer
269 for one-off analysis.
270
271 Parameters
272 ----------
273 model : a scikit-learn estimator
274 An object that implements ``fit`` and provides information about the
275 relative importance of features with either a ``coef_`` or
276 ``feature_importances_`` attribute.
277
278 Note that the object is cloned for each validation.
279
280 X : array-like, shape (n_samples, n_features)
281 Training vector, where n_samples is the number of samples and
282 n_features is the number of features.
283
284 y : array-like, shape (n_samples) or (n_samples, n_features), optional
285 Target relative to X for classification or regression.
286
287 ax : matplotlib.Axes object, optional
288 The axes object to plot the figure on.
289
290 step : int or float, optional (default=1)
291 If greater than or equal to 1, then step corresponds to the (integer)
292 number of features to remove at each iteration. If within (0.0, 1.0),
293 then step corresponds to the percentage (rounded down) of features to
294 remove at each iteration.
295
296 groups : array-like, with shape (n_samples,), optional
297 Group labels for the samples used while splitting the dataset into
298 train/test set.
299
300 cv : int, cross-validation generator or an iterable, optional
301 Determines the cross-validation splitting strategy.
302 Possible inputs for cv are:
303
304 - None, to use the default 3-fold cross-validation,
305 - integer, to specify the number of folds.
306 - An object to be used as a cross-validation generator.
307 - An iterable yielding train/test splits.
308
309 see the scikit-learn
310 `cross-validation guide <http://scikit-learn.org/stable/modules/cross_validation.html>`_
311 for more information on the possible strategies that can be used here.
312
313 scoring : string, callable or None, optional, default: None
314 A string or scorer callable object / function with signature
315 ``scorer(estimator, X, y)``. See scikit-learn model evaluation
316 documentation for names of possible metrics.
317
318 kwargs : dict
319 Keyword arguments that are passed to the base class and may influence
320 the visualization as defined in other Visualizers. These arguments are
321 also passed to the `poof()` method, e.g. can pass a path to save the
322 figure to.
323
324 Returns
325 -------
326 ax : matplotlib axes
327 Returns the axes that the rfecv were drawn on.
328 """
329 # Initialize the visualizer
330 oz = RFECV(model, ax=ax, step=step, groups=groups, cv=cv, scoring=scoring)
331
332 # Fit and poof the visualizer
333 oz.fit(X, y)
334 oz.poof(**kwargs)
335 return oz.ax
336
```
--- 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/yellowbrick/features/rfecv.py b/yellowbrick/features/rfecv.py
--- a/yellowbrick/features/rfecv.py
+++ b/yellowbrick/features/rfecv.py
@@ -171,7 +171,7 @@
else:
step = int(self.step)
- if step < 0:
+ if step <= 0:
raise YellowbrickValueError("step must be >0")
# Create the RFE model
| {"golden_diff": "diff --git a/yellowbrick/features/rfecv.py b/yellowbrick/features/rfecv.py\n--- a/yellowbrick/features/rfecv.py\n+++ b/yellowbrick/features/rfecv.py\n@@ -171,7 +171,7 @@\n else:\n step = int(self.step)\n \n- if step < 0:\n+ if step <= 0:\n raise YellowbrickValueError(\"step must be >0\")\n \n # Create the RFE model\n", "issue": "Overhaul unittest and fixtures\nRemove dependency on `unittest.TestCase` by replacing assertions with `assert` statements. This also involves using `pytest.raises` and `pytest.skip` decorators. \r\n\r\nUse PyTest fixtures for datasets and other fixtures. \r\n\r\n~Add PEP checking to pytest (alongside pyflakes)~\r\n\r\n- [x] rename `ThingTests` to `TestThing` \r\n- [x] assertions \r\n- [x] pytest.skip \r\n- [x] dataset fixtures \r\n- [ ] ~PEP8~\r\n\r\nAlongside this we should also do a PY2 removal check, namely anywhere:\r\n\r\n```python\r\ntry:\r\n from unittest import mock\r\nexcept ImportError:\r\n import mock\r\n```\r\n\r\nshould be replaced with just `from unittest import mock` \n", "before_files": [{"content": "# yellowbrick.features.rfecv\n# Visualize the number of features selected with recursive feature elimination\n#\n# Author: Benjamin Bengfort <[email protected]>\n# Created: Tue Apr 03 17:31:37 2018 -0400\n#\n# ID: rfecv.py [] [email protected] $\n\n\"\"\"\nVisualize the number of features selected using recursive feature elimination\n\"\"\"\n\n##########################################################################\n## Imports\n##########################################################################\n\nimport numpy as np\n\nfrom yellowbrick.base import ModelVisualizer\nfrom yellowbrick.exceptions import YellowbrickValueError\n\nfrom sklearn.utils import check_X_y\nfrom sklearn.feature_selection import RFE\nfrom sklearn.model_selection import cross_val_score\n\n\n##########################################################################\n## Recursive Feature Elimination\n##########################################################################\n\nclass RFECV(ModelVisualizer):\n \"\"\"\n Recursive Feature Elimination, Cross-Validated (RFECV) feature selection.\n\n Selects the best subset of features for the supplied estimator by removing\n 0 to N features (where N is the number of features) using recursive\n feature elimination, then selecting the best subset based on the\n cross-validation score of the model. Recursive feature elimination\n eliminates n features from a model by fitting the model multiple times and\n at each step, removing the weakest features, determined by either the\n ``coef_`` or ``feature_importances_`` attribute of the fitted model.\n\n The visualization plots the score relative to each subset and shows trends\n in feature elimination. If the feature elimination CV score is flat, then\n potentially there are not enough features in the model. An ideal curve is\n when the score jumps from low to high as the number of features removed\n increases, then slowly decreases again from the optimal number of\n features.\n\n Parameters\n ----------\n model : a scikit-learn estimator\n An object that implements ``fit`` and provides information about the\n relative importance of features with either a ``coef_`` or\n ``feature_importances_`` attribute.\n\n Note that the object is cloned for each validation.\n\n ax : matplotlib.Axes object, optional\n The axes object to plot the figure on.\n\n step : int or float, optional (default=1)\n If greater than or equal to 1, then step corresponds to the (integer)\n number of features to remove at each iteration. If within (0.0, 1.0),\n then step corresponds to the percentage (rounded down) of features to\n remove at each iteration.\n\n groups : array-like, with shape (n_samples,), optional\n Group labels for the samples used while splitting the dataset into\n train/test set.\n\n cv : int, cross-validation generator or an iterable, optional\n Determines the cross-validation splitting strategy.\n Possible inputs for cv are:\n\n - None, to use the default 3-fold cross-validation,\n - integer, to specify the number of folds.\n - An object to be used as a cross-validation generator.\n - An iterable yielding train/test splits.\n\n see the scikit-learn\n `cross-validation guide <http://scikit-learn.org/stable/modules/cross_validation.html>`_\n for more information on the possible strategies that can be used here.\n\n scoring : string, callable or None, optional, default: None\n A string or scorer callable object / function with signature\n ``scorer(estimator, X, y)``. See scikit-learn model evaluation\n documentation for names of possible metrics.\n\n kwargs : dict\n Keyword arguments that are passed to the base class and may influence\n the visualization as defined in other Visualizers.\n\n Attributes\n ----------\n n_features_ : int\n The number of features in the selected subset\n\n support_ : array of shape [n_features]\n A mask of the selected features\n\n ranking_ : array of shape [n_features]\n The feature ranking, such that ``ranking_[i]`` corresponds to the\n ranked position of feature i. Selected features are assigned rank 1.\n\n cv_scores_ : array of shape [n_subsets_of_features, n_splits]\n The cross-validation scores for each subset of features and splits in\n the cross-validation strategy.\n\n rfe_estimator_ : sklearn.feature_selection.RFE\n A fitted RFE estimator wrapping the original estimator. All estimator\n functions such as ``predict()`` and ``score()`` are passed through to\n this estimator (it rewraps the original model).\n\n n_feature_subsets_ : array of shape [n_subsets_of_features]\n The number of features removed on each iteration of RFE, computed by the\n number of features in the dataset and the step parameter.\n\n Notes\n -----\n This model wraps ``sklearn.feature_selection.RFE`` and not\n ``sklearn.feature_selection.RFECV`` because access to the internals of the\n CV and RFE estimators is required for the visualization. The visualizer\n does take similar arguments, however it does not expose the same internal\n attributes.\n\n Additionally, the RFE model can be accessed via the ``rfe_estimator_``\n attribute. Once fitted, the visualizer acts as a wrapper for this\n estimator and not for the original model passed to the model. This way the\n visualizer model can be used to make predictions.\n\n .. caution:: This visualizer requires a model that has either a ``coef_``\n or ``feature_importances_`` attribute when fitted.\n \"\"\"\n\n def __init__(self, model, ax=None, step=1, groups=None, cv=None,\n scoring=None, **kwargs):\n\n # Initialize the model visualizer\n super(RFECV, self).__init__(model, ax=ax, **kwargs)\n\n # Set parameters\n self.set_params(step=step, groups=groups, cv=cv, scoring=scoring)\n\n def fit(self, X, y=None):\n \"\"\"\n Fits the RFECV with the wrapped model to the specified data and draws\n the rfecv curve with the optimal number of features found.\n\n Parameters\n ----------\n X : array-like, shape (n_samples, n_features)\n Training vector, where n_samples is the number of samples and\n n_features is the number of features.\n\n y : array-like, shape (n_samples) or (n_samples, n_features), optional\n Target relative to X for classification or regression.\n\n Returns\n -------\n self : instance\n Returns the instance of the RFECV visualizer.\n \"\"\"\n X, y = check_X_y(X, y, \"csr\")\n n_features = X.shape[1]\n\n # This check is kind of unnecessary since RFE will do it, but it's\n # nice to get it out of the way ASAP and raise a meaningful error.\n if 0.0 < self.step < 1.0:\n step = int(max(1, self.step * n_features))\n else:\n step = int(self.step)\n\n if step < 0:\n raise YellowbrickValueError(\"step must be >0\")\n\n # Create the RFE model\n rfe = RFE(self.estimator, step=step)\n self.n_feature_subsets_ = np.arange(1, n_features+step, step)\n\n # Create the cross validation params\n # TODO: handle random state\n cv_params = {\n key: self.get_params()[key]\n for key in ('groups', 'cv', 'scoring')\n }\n\n # Perform cross-validation for each feature subset\n scores = []\n for n_features_to_select in self.n_feature_subsets_:\n rfe.set_params(n_features_to_select=n_features_to_select)\n scores.append(cross_val_score(rfe, X, y, **cv_params))\n\n # Convert scores to array\n self.cv_scores_ = np.array(scores)\n\n # Find the best RFE model\n bestidx = self.cv_scores_.mean(axis=1).argmax()\n self.n_features_ = self.n_feature_subsets_[bestidx]\n\n # Fit the final RFE model for the number of features\n self.rfe_estimator_ = rfe\n self.rfe_estimator_.set_params(n_features_to_select=self.n_features_)\n self.rfe_estimator_.fit(X, y)\n\n # Rewrap the visualizer to use the rfe estimator\n self._wrapped = self.rfe_estimator_\n\n # Hoist the RFE params to the visualizer\n self.support_ = self.rfe_estimator_.support_\n self.ranking_ = self.rfe_estimator_.ranking_\n\n self.draw()\n return self\n\n def draw(self, **kwargs):\n \"\"\"\n Renders the rfecv curve.\n \"\"\"\n # Compute the curves\n x = self.n_feature_subsets_\n means = self.cv_scores_.mean(axis=1)\n sigmas = self.cv_scores_.std(axis=1)\n\n\n # Plot one standard deviation above and below the mean\n self.ax.fill_between(x, means - sigmas, means+sigmas, alpha=0.25)\n\n # Plot the curve\n self.ax.plot(x, means, 'o-')\n\n # Plot the maximum number of features\n self.ax.axvline(\n self.n_features_, c='k', ls='--',\n label=\"n_features = {}\\nscore = {:0.3f}\".format(\n self.n_features_, self.cv_scores_.mean(axis=1).max()\n )\n )\n\n return self.ax\n\n def finalize(self, **kwargs):\n \"\"\"\n Add the title, legend, and other visual final touches to the plot.\n \"\"\"\n # Set the title of the figure\n self.set_title('RFECV for {}'.format(self.name))\n\n # Add the legend\n self.ax.legend(frameon=True, loc='best')\n\n # Set the axis labels\n self.ax.set_xlabel('Number of Features Selected')\n self.ax.set_ylabel('Score')\n\n\n##########################################################################\n## Quick Methods\n##########################################################################\n\ndef rfecv(model, X, y, ax=None, step=1, groups=None, cv=None,\n scoring=None, **kwargs):\n \"\"\"\n Performs recursive feature elimination with cross-validation to determine\n an optimal number of features for a model. Visualizes the feature subsets\n with respect to the cross-validation score.\n\n This helper function is a quick wrapper to utilize the RFECV visualizer\n for one-off analysis.\n\n Parameters\n ----------\n model : a scikit-learn estimator\n An object that implements ``fit`` and provides information about the\n relative importance of features with either a ``coef_`` or\n ``feature_importances_`` attribute.\n\n Note that the object is cloned for each validation.\n\n X : array-like, shape (n_samples, n_features)\n Training vector, where n_samples is the number of samples and\n n_features is the number of features.\n\n y : array-like, shape (n_samples) or (n_samples, n_features), optional\n Target relative to X for classification or regression.\n\n ax : matplotlib.Axes object, optional\n The axes object to plot the figure on.\n\n step : int or float, optional (default=1)\n If greater than or equal to 1, then step corresponds to the (integer)\n number of features to remove at each iteration. If within (0.0, 1.0),\n then step corresponds to the percentage (rounded down) of features to\n remove at each iteration.\n\n groups : array-like, with shape (n_samples,), optional\n Group labels for the samples used while splitting the dataset into\n train/test set.\n\n cv : int, cross-validation generator or an iterable, optional\n Determines the cross-validation splitting strategy.\n Possible inputs for cv are:\n\n - None, to use the default 3-fold cross-validation,\n - integer, to specify the number of folds.\n - An object to be used as a cross-validation generator.\n - An iterable yielding train/test splits.\n\n see the scikit-learn\n `cross-validation guide <http://scikit-learn.org/stable/modules/cross_validation.html>`_\n for more information on the possible strategies that can be used here.\n\n scoring : string, callable or None, optional, default: None\n A string or scorer callable object / function with signature\n ``scorer(estimator, X, y)``. See scikit-learn model evaluation\n documentation for names of possible metrics.\n\n kwargs : dict\n Keyword arguments that are passed to the base class and may influence\n the visualization as defined in other Visualizers. These arguments are\n also passed to the `poof()` method, e.g. can pass a path to save the\n figure to.\n\n Returns\n -------\n ax : matplotlib axes\n Returns the axes that the rfecv were drawn on.\n \"\"\"\n # Initialize the visualizer\n oz = RFECV(model, ax=ax, step=step, groups=groups, cv=cv, scoring=scoring)\n\n # Fit and poof the visualizer\n oz.fit(X, y)\n oz.poof(**kwargs)\n return oz.ax\n", "path": "yellowbrick/features/rfecv.py"}], "after_files": [{"content": "# yellowbrick.features.rfecv\n# Visualize the number of features selected with recursive feature elimination\n#\n# Author: Benjamin Bengfort <[email protected]>\n# Created: Tue Apr 03 17:31:37 2018 -0400\n#\n# ID: rfecv.py [] [email protected] $\n\n\"\"\"\nVisualize the number of features selected using recursive feature elimination\n\"\"\"\n\n##########################################################################\n## Imports\n##########################################################################\n\nimport numpy as np\n\nfrom yellowbrick.base import ModelVisualizer\nfrom yellowbrick.exceptions import YellowbrickValueError\n\nfrom sklearn.utils import check_X_y\nfrom sklearn.feature_selection import RFE\nfrom sklearn.model_selection import cross_val_score\n\n\n##########################################################################\n## Recursive Feature Elimination\n##########################################################################\n\nclass RFECV(ModelVisualizer):\n \"\"\"\n Recursive Feature Elimination, Cross-Validated (RFECV) feature selection.\n\n Selects the best subset of features for the supplied estimator by removing\n 0 to N features (where N is the number of features) using recursive\n feature elimination, then selecting the best subset based on the\n cross-validation score of the model. Recursive feature elimination\n eliminates n features from a model by fitting the model multiple times and\n at each step, removing the weakest features, determined by either the\n ``coef_`` or ``feature_importances_`` attribute of the fitted model.\n\n The visualization plots the score relative to each subset and shows trends\n in feature elimination. If the feature elimination CV score is flat, then\n potentially there are not enough features in the model. An ideal curve is\n when the score jumps from low to high as the number of features removed\n increases, then slowly decreases again from the optimal number of\n features.\n\n Parameters\n ----------\n model : a scikit-learn estimator\n An object that implements ``fit`` and provides information about the\n relative importance of features with either a ``coef_`` or\n ``feature_importances_`` attribute.\n\n Note that the object is cloned for each validation.\n\n ax : matplotlib.Axes object, optional\n The axes object to plot the figure on.\n\n step : int or float, optional (default=1)\n If greater than or equal to 1, then step corresponds to the (integer)\n number of features to remove at each iteration. If within (0.0, 1.0),\n then step corresponds to the percentage (rounded down) of features to\n remove at each iteration.\n\n groups : array-like, with shape (n_samples,), optional\n Group labels for the samples used while splitting the dataset into\n train/test set.\n\n cv : int, cross-validation generator or an iterable, optional\n Determines the cross-validation splitting strategy.\n Possible inputs for cv are:\n\n - None, to use the default 3-fold cross-validation,\n - integer, to specify the number of folds.\n - An object to be used as a cross-validation generator.\n - An iterable yielding train/test splits.\n\n see the scikit-learn\n `cross-validation guide <http://scikit-learn.org/stable/modules/cross_validation.html>`_\n for more information on the possible strategies that can be used here.\n\n scoring : string, callable or None, optional, default: None\n A string or scorer callable object / function with signature\n ``scorer(estimator, X, y)``. See scikit-learn model evaluation\n documentation for names of possible metrics.\n\n kwargs : dict\n Keyword arguments that are passed to the base class and may influence\n the visualization as defined in other Visualizers.\n\n Attributes\n ----------\n n_features_ : int\n The number of features in the selected subset\n\n support_ : array of shape [n_features]\n A mask of the selected features\n\n ranking_ : array of shape [n_features]\n The feature ranking, such that ``ranking_[i]`` corresponds to the\n ranked position of feature i. Selected features are assigned rank 1.\n\n cv_scores_ : array of shape [n_subsets_of_features, n_splits]\n The cross-validation scores for each subset of features and splits in\n the cross-validation strategy.\n\n rfe_estimator_ : sklearn.feature_selection.RFE\n A fitted RFE estimator wrapping the original estimator. All estimator\n functions such as ``predict()`` and ``score()`` are passed through to\n this estimator (it rewraps the original model).\n\n n_feature_subsets_ : array of shape [n_subsets_of_features]\n The number of features removed on each iteration of RFE, computed by the\n number of features in the dataset and the step parameter.\n\n Notes\n -----\n This model wraps ``sklearn.feature_selection.RFE`` and not\n ``sklearn.feature_selection.RFECV`` because access to the internals of the\n CV and RFE estimators is required for the visualization. The visualizer\n does take similar arguments, however it does not expose the same internal\n attributes.\n\n Additionally, the RFE model can be accessed via the ``rfe_estimator_``\n attribute. Once fitted, the visualizer acts as a wrapper for this\n estimator and not for the original model passed to the model. This way the\n visualizer model can be used to make predictions.\n\n .. caution:: This visualizer requires a model that has either a ``coef_``\n or ``feature_importances_`` attribute when fitted.\n \"\"\"\n\n def __init__(self, model, ax=None, step=1, groups=None, cv=None,\n scoring=None, **kwargs):\n\n # Initialize the model visualizer\n super(RFECV, self).__init__(model, ax=ax, **kwargs)\n\n # Set parameters\n self.set_params(step=step, groups=groups, cv=cv, scoring=scoring)\n\n def fit(self, X, y=None):\n \"\"\"\n Fits the RFECV with the wrapped model to the specified data and draws\n the rfecv curve with the optimal number of features found.\n\n Parameters\n ----------\n X : array-like, shape (n_samples, n_features)\n Training vector, where n_samples is the number of samples and\n n_features is the number of features.\n\n y : array-like, shape (n_samples) or (n_samples, n_features), optional\n Target relative to X for classification or regression.\n\n Returns\n -------\n self : instance\n Returns the instance of the RFECV visualizer.\n \"\"\"\n X, y = check_X_y(X, y, \"csr\")\n n_features = X.shape[1]\n\n # This check is kind of unnecessary since RFE will do it, but it's\n # nice to get it out of the way ASAP and raise a meaningful error.\n if 0.0 < self.step < 1.0:\n step = int(max(1, self.step * n_features))\n else:\n step = int(self.step)\n\n if step <= 0:\n raise YellowbrickValueError(\"step must be >0\")\n\n # Create the RFE model\n rfe = RFE(self.estimator, step=step)\n self.n_feature_subsets_ = np.arange(1, n_features+step, step)\n\n # Create the cross validation params\n # TODO: handle random state\n cv_params = {\n key: self.get_params()[key]\n for key in ('groups', 'cv', 'scoring')\n }\n\n # Perform cross-validation for each feature subset\n scores = []\n for n_features_to_select in self.n_feature_subsets_:\n rfe.set_params(n_features_to_select=n_features_to_select)\n scores.append(cross_val_score(rfe, X, y, **cv_params))\n\n # Convert scores to array\n self.cv_scores_ = np.array(scores)\n\n # Find the best RFE model\n bestidx = self.cv_scores_.mean(axis=1).argmax()\n self.n_features_ = self.n_feature_subsets_[bestidx]\n\n # Fit the final RFE model for the number of features\n self.rfe_estimator_ = rfe\n self.rfe_estimator_.set_params(n_features_to_select=self.n_features_)\n self.rfe_estimator_.fit(X, y)\n\n # Rewrap the visualizer to use the rfe estimator\n self._wrapped = self.rfe_estimator_\n\n # Hoist the RFE params to the visualizer\n self.support_ = self.rfe_estimator_.support_\n self.ranking_ = self.rfe_estimator_.ranking_\n\n self.draw()\n return self\n\n def draw(self, **kwargs):\n \"\"\"\n Renders the rfecv curve.\n \"\"\"\n # Compute the curves\n x = self.n_feature_subsets_\n means = self.cv_scores_.mean(axis=1)\n sigmas = self.cv_scores_.std(axis=1)\n\n\n # Plot one standard deviation above and below the mean\n self.ax.fill_between(x, means - sigmas, means+sigmas, alpha=0.25)\n\n # Plot the curve\n self.ax.plot(x, means, 'o-')\n\n # Plot the maximum number of features\n self.ax.axvline(\n self.n_features_, c='k', ls='--',\n label=\"n_features = {}\\nscore = {:0.3f}\".format(\n self.n_features_, self.cv_scores_.mean(axis=1).max()\n )\n )\n\n return self.ax\n\n def finalize(self, **kwargs):\n \"\"\"\n Add the title, legend, and other visual final touches to the plot.\n \"\"\"\n # Set the title of the figure\n self.set_title('RFECV for {}'.format(self.name))\n\n # Add the legend\n self.ax.legend(frameon=True, loc='best')\n\n # Set the axis labels\n self.ax.set_xlabel('Number of Features Selected')\n self.ax.set_ylabel('Score')\n\n\n##########################################################################\n## Quick Methods\n##########################################################################\n\ndef rfecv(model, X, y, ax=None, step=1, groups=None, cv=None,\n scoring=None, **kwargs):\n \"\"\"\n Performs recursive feature elimination with cross-validation to determine\n an optimal number of features for a model. Visualizes the feature subsets\n with respect to the cross-validation score.\n\n This helper function is a quick wrapper to utilize the RFECV visualizer\n for one-off analysis.\n\n Parameters\n ----------\n model : a scikit-learn estimator\n An object that implements ``fit`` and provides information about the\n relative importance of features with either a ``coef_`` or\n ``feature_importances_`` attribute.\n\n Note that the object is cloned for each validation.\n\n X : array-like, shape (n_samples, n_features)\n Training vector, where n_samples is the number of samples and\n n_features is the number of features.\n\n y : array-like, shape (n_samples) or (n_samples, n_features), optional\n Target relative to X for classification or regression.\n\n ax : matplotlib.Axes object, optional\n The axes object to plot the figure on.\n\n step : int or float, optional (default=1)\n If greater than or equal to 1, then step corresponds to the (integer)\n number of features to remove at each iteration. If within (0.0, 1.0),\n then step corresponds to the percentage (rounded down) of features to\n remove at each iteration.\n\n groups : array-like, with shape (n_samples,), optional\n Group labels for the samples used while splitting the dataset into\n train/test set.\n\n cv : int, cross-validation generator or an iterable, optional\n Determines the cross-validation splitting strategy.\n Possible inputs for cv are:\n\n - None, to use the default 3-fold cross-validation,\n - integer, to specify the number of folds.\n - An object to be used as a cross-validation generator.\n - An iterable yielding train/test splits.\n\n see the scikit-learn\n `cross-validation guide <http://scikit-learn.org/stable/modules/cross_validation.html>`_\n for more information on the possible strategies that can be used here.\n\n scoring : string, callable or None, optional, default: None\n A string or scorer callable object / function with signature\n ``scorer(estimator, X, y)``. See scikit-learn model evaluation\n documentation for names of possible metrics.\n\n kwargs : dict\n Keyword arguments that are passed to the base class and may influence\n the visualization as defined in other Visualizers. These arguments are\n also passed to the `poof()` method, e.g. can pass a path to save the\n figure to.\n\n Returns\n -------\n ax : matplotlib axes\n Returns the axes that the rfecv were drawn on.\n \"\"\"\n # Initialize the visualizer\n oz = RFECV(model, ax=ax, step=step, groups=groups, cv=cv, scoring=scoring)\n\n # Fit and poof the visualizer\n oz.fit(X, y)\n oz.poof(**kwargs)\n return oz.ax\n", "path": "yellowbrick/features/rfecv.py"}]} |
gh_patches_debug_293 | rasdani/github-patches | git_diff | OpenNMT__OpenNMT-tf-577 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Bug in "onmt-ark-to-records" code
I have found a small bug in the code line referenced below. It causes the script to terminate with a `TypeError: data type not understood`. Just for the sake of completeness, this is caused by the fact that numpy doesn't understand the object `tf.float32`. I changed that to `float` and it worked as it was supposed to. I can create a PR for this, but I suppose it is too trivial to do so and claim a contribution, unless you want me to.
https://github.com/OpenNMT/OpenNMT-tf/blob/5809c293d7bc65d923274cfd56b3339fc4107af6/opennmt/bin/ark_to_records.py#L46
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `opennmt/bin/ark_to_records.py`
Content:
```
1 """ARK data file to TFRecords converter.
2
3 The scripts takes the ARK data file and optionally the indexed target text
4 to write aligned source and target data.
5 """
6
7 import argparse
8 import numpy as np
9 import tensorflow as tf
10
11 from opennmt.inputters.record_inputter import write_sequence_record
12
13
14 def consume_next_vector(ark_file):
15 """Consumes the next vector.
16
17 Args:
18 ark_file: The ARK data file.
19
20 Returns:
21 The next vector as a 2D Numpy array.
22 """
23 idx = None
24 vector = []
25
26 for line in ark_file:
27 line = line.strip()
28 fields = line.split()
29
30 if not idx:
31 idx = fields[0]
32 fields.pop(0)
33 fields.pop(0)
34
35 end = fields and fields[-1] == "]"
36
37 if end:
38 fields.pop()
39
40 if fields:
41 vector.append(fields)
42
43 if end:
44 break
45
46 return idx, np.asarray(vector, dtype=tf.float32)
47
48 def consume_next_text(text_file):
49 """Consumes the next text line from `text_file`."""
50 idx = None
51 text = text_file.readline()
52
53 if text:
54 tokens = text.strip().split()
55 idx = tokens[0]
56 tokens.pop(0)
57 text = " ".join(tokens)
58
59 return idx, text
60
61 def write_text(text, writer):
62 """Serializes a line of text."""
63 writer.write(text)
64 writer.write("\n")
65
66 def ark_to_records_aligned(ark_filename, text_filename, out_prefix, compression_type=None):
67 """Converts ARK and text datasets to aligned TFRecords and text datasets."""
68 record_filename = "%s.records" % out_prefix
69 if compression_type == "GZIP":
70 record_filename = "%s.gz" % record_filename
71 record_writer = tf.io.TFRecordWriter(record_filename, options=compression_type)
72 text_writer = open(out_prefix + ".txt", encoding="utf-8", mode="w")
73
74 ark_buffer = {}
75 text_buffer = {}
76 count = 0
77
78 def _write_example(vector, text):
79 write_sequence_record(vector, record_writer)
80 write_text(text, text_writer)
81
82 def _search_aligned():
83 for idx in ark_buffer:
84 if idx in text_buffer:
85 vector = ark_buffer[idx]
86 text = text_buffer[idx]
87
88 del ark_buffer[idx]
89 del text_buffer[idx]
90
91 return vector, text
92
93 return None, None
94
95 with open(ark_filename, encoding="utf-8") as ark_file, open(text_filename, encoding="utf-8") as text_file: #pylint: disable=line-too-long
96 while True:
97 ark_idx, vector = consume_next_vector(ark_file)
98 text_idx, text = consume_next_text(text_file)
99
100 if not ark_idx and not text_idx:
101 # Both files are empty.
102 break
103
104 if ark_idx == text_idx:
105 # If the indices match, write the example.
106 _write_example(vector, text)
107 count += 1
108 else:
109 # Otherwise store the entries.
110 if ark_idx:
111 ark_buffer[ark_idx] = vector
112 if text_idx:
113 text_buffer[text_idx] = text
114
115 # Look if we can now find aligned entries.
116 vector, text = _search_aligned()
117
118 if vector is not None:
119 _write_example(vector, text)
120 count += 1
121
122 # Search alignments in stored entries.
123 while True:
124 vector, text = _search_aligned()
125 if vector is None:
126 break
127 _write_example(vector, text)
128 count += 1
129
130 record_writer.close()
131 text_writer.close()
132
133 print("Saved {} aligned records.".format(count))
134
135 def ark_to_records(ark_filename, out_prefix, compression_type=None):
136 """Converts ARK dataset to TFRecords."""
137 record_writer = tf.io.TFRecordWriter(out_prefix + ".records", options=compression_type)
138 count = 0
139
140 with open(ark_filename, encoding="utf-8") as ark_file:
141 while True:
142 ark_idx, vector = consume_next_vector(ark_file)
143 if not ark_idx:
144 break
145 write_sequence_record(vector, record_writer)
146 count += 1
147
148 record_writer.close()
149 print("Saved {} records.".format(count))
150
151
152 def main():
153 parser = argparse.ArgumentParser()
154 parser.add_argument("--ark", required=True,
155 help="Indexed ARK data file.")
156 parser.add_argument("--txt",
157 help=("Indexed target text data file "
158 "(must set it to align source and target files)."))
159 parser.add_argument("--out", required=True,
160 help="Output files prefix (will be suffixed by .records and .txt).")
161 parser.add_argument("--compression_type", default=None, choices=["GZIP"],
162 help="Optional compression type.")
163 args = parser.parse_args()
164
165 if args.txt:
166 ark_to_records_aligned(args.ark, args.txt, args.out, compression_type=args.compression_type)
167 else:
168 ark_to_records(args.ark, args.out, compression_type=args.compression_type)
169
170 if __name__ == "__main__":
171 main()
172
```
--- 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/opennmt/bin/ark_to_records.py b/opennmt/bin/ark_to_records.py
--- a/opennmt/bin/ark_to_records.py
+++ b/opennmt/bin/ark_to_records.py
@@ -43,7 +43,7 @@
if end:
break
- return idx, np.asarray(vector, dtype=tf.float32)
+ return idx, np.asarray(vector, dtype=np.float32)
def consume_next_text(text_file):
"""Consumes the next text line from `text_file`."""
| {"golden_diff": "diff --git a/opennmt/bin/ark_to_records.py b/opennmt/bin/ark_to_records.py\n--- a/opennmt/bin/ark_to_records.py\n+++ b/opennmt/bin/ark_to_records.py\n@@ -43,7 +43,7 @@\n if end:\n break\n \n- return idx, np.asarray(vector, dtype=tf.float32)\n+ return idx, np.asarray(vector, dtype=np.float32)\n \n def consume_next_text(text_file):\n \"\"\"Consumes the next text line from `text_file`.\"\"\"\n", "issue": "Bug in \"onmt-ark-to-records\" code\nI have found a small bug in the code line referenced below. It causes the script to terminate with a `TypeError: data type not understood`. Just for the sake of completeness, this is caused by the fact that numpy doesn't understand the object `tf.float32`. I changed that to `float` and it worked as it was supposed to. I can create a PR for this, but I suppose it is too trivial to do so and claim a contribution, unless you want me to.\r\n\r\nhttps://github.com/OpenNMT/OpenNMT-tf/blob/5809c293d7bc65d923274cfd56b3339fc4107af6/opennmt/bin/ark_to_records.py#L46\n", "before_files": [{"content": "\"\"\"ARK data file to TFRecords converter.\n\nThe scripts takes the ARK data file and optionally the indexed target text\nto write aligned source and target data.\n\"\"\"\n\nimport argparse\nimport numpy as np\nimport tensorflow as tf\n\nfrom opennmt.inputters.record_inputter import write_sequence_record\n\n\ndef consume_next_vector(ark_file):\n \"\"\"Consumes the next vector.\n\n Args:\n ark_file: The ARK data file.\n\n Returns:\n The next vector as a 2D Numpy array.\n \"\"\"\n idx = None\n vector = []\n\n for line in ark_file:\n line = line.strip()\n fields = line.split()\n\n if not idx:\n idx = fields[0]\n fields.pop(0)\n fields.pop(0)\n\n end = fields and fields[-1] == \"]\"\n\n if end:\n fields.pop()\n\n if fields:\n vector.append(fields)\n\n if end:\n break\n\n return idx, np.asarray(vector, dtype=tf.float32)\n\ndef consume_next_text(text_file):\n \"\"\"Consumes the next text line from `text_file`.\"\"\"\n idx = None\n text = text_file.readline()\n\n if text:\n tokens = text.strip().split()\n idx = tokens[0]\n tokens.pop(0)\n text = \" \".join(tokens)\n\n return idx, text\n\ndef write_text(text, writer):\n \"\"\"Serializes a line of text.\"\"\"\n writer.write(text)\n writer.write(\"\\n\")\n\ndef ark_to_records_aligned(ark_filename, text_filename, out_prefix, compression_type=None):\n \"\"\"Converts ARK and text datasets to aligned TFRecords and text datasets.\"\"\"\n record_filename = \"%s.records\" % out_prefix\n if compression_type == \"GZIP\":\n record_filename = \"%s.gz\" % record_filename\n record_writer = tf.io.TFRecordWriter(record_filename, options=compression_type)\n text_writer = open(out_prefix + \".txt\", encoding=\"utf-8\", mode=\"w\")\n\n ark_buffer = {}\n text_buffer = {}\n count = 0\n\n def _write_example(vector, text):\n write_sequence_record(vector, record_writer)\n write_text(text, text_writer)\n\n def _search_aligned():\n for idx in ark_buffer:\n if idx in text_buffer:\n vector = ark_buffer[idx]\n text = text_buffer[idx]\n\n del ark_buffer[idx]\n del text_buffer[idx]\n\n return vector, text\n\n return None, None\n\n with open(ark_filename, encoding=\"utf-8\") as ark_file, open(text_filename, encoding=\"utf-8\") as text_file: #pylint: disable=line-too-long\n while True:\n ark_idx, vector = consume_next_vector(ark_file)\n text_idx, text = consume_next_text(text_file)\n\n if not ark_idx and not text_idx:\n # Both files are empty.\n break\n\n if ark_idx == text_idx:\n # If the indices match, write the example.\n _write_example(vector, text)\n count += 1\n else:\n # Otherwise store the entries.\n if ark_idx:\n ark_buffer[ark_idx] = vector\n if text_idx:\n text_buffer[text_idx] = text\n\n # Look if we can now find aligned entries.\n vector, text = _search_aligned()\n\n if vector is not None:\n _write_example(vector, text)\n count += 1\n\n # Search alignments in stored entries.\n while True:\n vector, text = _search_aligned()\n if vector is None:\n break\n _write_example(vector, text)\n count += 1\n\n record_writer.close()\n text_writer.close()\n\n print(\"Saved {} aligned records.\".format(count))\n\ndef ark_to_records(ark_filename, out_prefix, compression_type=None):\n \"\"\"Converts ARK dataset to TFRecords.\"\"\"\n record_writer = tf.io.TFRecordWriter(out_prefix + \".records\", options=compression_type)\n count = 0\n\n with open(ark_filename, encoding=\"utf-8\") as ark_file:\n while True:\n ark_idx, vector = consume_next_vector(ark_file)\n if not ark_idx:\n break\n write_sequence_record(vector, record_writer)\n count += 1\n\n record_writer.close()\n print(\"Saved {} records.\".format(count))\n\n\ndef main():\n parser = argparse.ArgumentParser()\n parser.add_argument(\"--ark\", required=True,\n help=\"Indexed ARK data file.\")\n parser.add_argument(\"--txt\",\n help=(\"Indexed target text data file \"\n \"(must set it to align source and target files).\"))\n parser.add_argument(\"--out\", required=True,\n help=\"Output files prefix (will be suffixed by .records and .txt).\")\n parser.add_argument(\"--compression_type\", default=None, choices=[\"GZIP\"],\n help=\"Optional compression type.\")\n args = parser.parse_args()\n\n if args.txt:\n ark_to_records_aligned(args.ark, args.txt, args.out, compression_type=args.compression_type)\n else:\n ark_to_records(args.ark, args.out, compression_type=args.compression_type)\n\nif __name__ == \"__main__\":\n main()\n", "path": "opennmt/bin/ark_to_records.py"}], "after_files": [{"content": "\"\"\"ARK data file to TFRecords converter.\n\nThe scripts takes the ARK data file and optionally the indexed target text\nto write aligned source and target data.\n\"\"\"\n\nimport argparse\nimport numpy as np\nimport tensorflow as tf\n\nfrom opennmt.inputters.record_inputter import write_sequence_record\n\n\ndef consume_next_vector(ark_file):\n \"\"\"Consumes the next vector.\n\n Args:\n ark_file: The ARK data file.\n\n Returns:\n The next vector as a 2D Numpy array.\n \"\"\"\n idx = None\n vector = []\n\n for line in ark_file:\n line = line.strip()\n fields = line.split()\n\n if not idx:\n idx = fields[0]\n fields.pop(0)\n fields.pop(0)\n\n end = fields and fields[-1] == \"]\"\n\n if end:\n fields.pop()\n\n if fields:\n vector.append(fields)\n\n if end:\n break\n\n return idx, np.asarray(vector, dtype=np.float32)\n\ndef consume_next_text(text_file):\n \"\"\"Consumes the next text line from `text_file`.\"\"\"\n idx = None\n text = text_file.readline()\n\n if text:\n tokens = text.strip().split()\n idx = tokens[0]\n tokens.pop(0)\n text = \" \".join(tokens)\n\n return idx, text\n\ndef write_text(text, writer):\n \"\"\"Serializes a line of text.\"\"\"\n writer.write(text)\n writer.write(\"\\n\")\n\ndef ark_to_records_aligned(ark_filename, text_filename, out_prefix, compression_type=None):\n \"\"\"Converts ARK and text datasets to aligned TFRecords and text datasets.\"\"\"\n record_filename = \"%s.records\" % out_prefix\n if compression_type == \"GZIP\":\n record_filename = \"%s.gz\" % record_filename\n record_writer = tf.io.TFRecordWriter(record_filename, options=compression_type)\n text_writer = open(out_prefix + \".txt\", encoding=\"utf-8\", mode=\"w\")\n\n ark_buffer = {}\n text_buffer = {}\n count = 0\n\n def _write_example(vector, text):\n write_sequence_record(vector, record_writer)\n write_text(text, text_writer)\n\n def _search_aligned():\n for idx in ark_buffer:\n if idx in text_buffer:\n vector = ark_buffer[idx]\n text = text_buffer[idx]\n\n del ark_buffer[idx]\n del text_buffer[idx]\n\n return vector, text\n\n return None, None\n\n with open(ark_filename, encoding=\"utf-8\") as ark_file, open(text_filename, encoding=\"utf-8\") as text_file: #pylint: disable=line-too-long\n while True:\n ark_idx, vector = consume_next_vector(ark_file)\n text_idx, text = consume_next_text(text_file)\n\n if not ark_idx and not text_idx:\n # Both files are empty.\n break\n\n if ark_idx == text_idx:\n # If the indices match, write the example.\n _write_example(vector, text)\n count += 1\n else:\n # Otherwise store the entries.\n if ark_idx:\n ark_buffer[ark_idx] = vector\n if text_idx:\n text_buffer[text_idx] = text\n\n # Look if we can now find aligned entries.\n vector, text = _search_aligned()\n\n if vector is not None:\n _write_example(vector, text)\n count += 1\n\n # Search alignments in stored entries.\n while True:\n vector, text = _search_aligned()\n if vector is None:\n break\n _write_example(vector, text)\n count += 1\n\n record_writer.close()\n text_writer.close()\n\n print(\"Saved {} aligned records.\".format(count))\n\ndef ark_to_records(ark_filename, out_prefix, compression_type=None):\n \"\"\"Converts ARK dataset to TFRecords.\"\"\"\n record_writer = tf.io.TFRecordWriter(out_prefix + \".records\", options=compression_type)\n count = 0\n\n with open(ark_filename, encoding=\"utf-8\") as ark_file:\n while True:\n ark_idx, vector = consume_next_vector(ark_file)\n if not ark_idx:\n break\n write_sequence_record(vector, record_writer)\n count += 1\n\n record_writer.close()\n print(\"Saved {} records.\".format(count))\n\n\ndef main():\n parser = argparse.ArgumentParser()\n parser.add_argument(\"--ark\", required=True,\n help=\"Indexed ARK data file.\")\n parser.add_argument(\"--txt\",\n help=(\"Indexed target text data file \"\n \"(must set it to align source and target files).\"))\n parser.add_argument(\"--out\", required=True,\n help=\"Output files prefix (will be suffixed by .records and .txt).\")\n parser.add_argument(\"--compression_type\", default=None, choices=[\"GZIP\"],\n help=\"Optional compression type.\")\n args = parser.parse_args()\n\n if args.txt:\n ark_to_records_aligned(args.ark, args.txt, args.out, compression_type=args.compression_type)\n else:\n ark_to_records(args.ark, args.out, compression_type=args.compression_type)\n\nif __name__ == \"__main__\":\n main()\n", "path": "opennmt/bin/ark_to_records.py"}]} |
gh_patches_debug_294 | rasdani/github-patches | git_diff | getredash__redash-3421 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
When creating a visualisation after running a query the query results are deleted
We are testing the latest stable version of redash (6.0.0+b10818 (7fa66654)
Found a regression when creating a new visualization, to reproduce:
0. Open a new browser tab and log into redash
1. Run a query
2. Create a new visualization
3. The X & Y drop downs are empty
4. When you cancel the visualization creation you see that the query results disappeared
Note - the issue occurs only when you run redash for the first time on a new session
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `redash/handlers/queries.py`
Content:
```
1 import sqlparse
2 from flask import jsonify, request, url_for
3 from flask_login import login_required
4 from flask_restful import abort
5 from sqlalchemy.orm.exc import StaleDataError
6 from funcy import partial
7
8 from redash import models, settings
9 from redash.authentication.org_resolving import current_org
10 from redash.handlers.base import (BaseResource, filter_by_tags, get_object_or_404,
11 org_scoped_rule, paginate, routes, order_results as _order_results)
12 from redash.handlers.query_results import run_query
13 from redash.permissions import (can_modify, not_view_only, require_access,
14 require_admin_or_owner,
15 require_object_modify_permission,
16 require_permission, view_only)
17 from redash.utils import collect_parameters_from_request
18 from redash.serializers import QuerySerializer
19
20
21 # Ordering map for relationships
22 order_map = {
23 'name': 'lowercase_name',
24 '-name': '-lowercase_name',
25 'created_at': 'created_at',
26 '-created_at': '-created_at',
27 'schedule': 'schedule',
28 '-schedule': '-schedule',
29 'runtime': 'query_results-runtime',
30 '-runtime': '-query_results-runtime',
31 'executed_at': 'query_results-retrieved_at',
32 '-executed_at': '-query_results-retrieved_at',
33 'created_by': 'users-name',
34 '-created_by': '-users-name',
35 }
36
37 order_results = partial(
38 _order_results,
39 default_order='-created_at',
40 allowed_orders=order_map,
41 )
42
43
44 @routes.route(org_scoped_rule('/api/queries/format'), methods=['POST'])
45 @login_required
46 def format_sql_query(org_slug=None):
47 """
48 Formats an SQL query using the Python ``sqlparse`` formatter.
49
50 :<json string query: The SQL text to format
51 :>json string query: Formatted SQL text
52 """
53 arguments = request.get_json(force=True)
54 query = arguments.get("query", "")
55
56 return jsonify({'query': sqlparse.format(query, **settings.SQLPARSE_FORMAT_OPTIONS)})
57
58
59 class QuerySearchResource(BaseResource):
60 @require_permission('view_query')
61 def get(self):
62 """
63 Search query text, names, and descriptions.
64
65 :qparam string q: Search term
66 :qparam number include_drafts: Whether to include draft in results
67
68 Responds with a list of :ref:`query <query-response-label>` objects.
69 """
70 term = request.args.get('q', '')
71 if not term:
72 return []
73
74 include_drafts = request.args.get('include_drafts') is not None
75
76 self.record_event({
77 'action': 'search',
78 'object_type': 'query',
79 'term': term,
80 })
81
82 # this redirects to the new query list API that is aware of search
83 new_location = url_for(
84 'queries',
85 q=term,
86 org_slug=current_org.slug,
87 drafts='true' if include_drafts else 'false',
88 )
89 return {}, 301, {'Location': new_location}
90
91
92 class QueryRecentResource(BaseResource):
93 @require_permission('view_query')
94 def get(self):
95 """
96 Retrieve up to 10 queries recently modified by the user.
97
98 Responds with a list of :ref:`query <query-response-label>` objects.
99 """
100
101 results = models.Query.by_user(self.current_user).order_by(models.Query.updated_at.desc()).limit(10)
102 return QuerySerializer(results, with_last_modified_by=False, with_user=False).serialize()
103
104
105 class BaseQueryListResource(BaseResource):
106
107 def get_queries(self, search_term):
108 if search_term:
109 results = models.Query.search(
110 search_term,
111 self.current_user.group_ids,
112 self.current_user.id,
113 include_drafts=True,
114 )
115 else:
116 results = models.Query.all_queries(
117 self.current_user.group_ids,
118 self.current_user.id,
119 include_drafts=True,
120 )
121 return filter_by_tags(results, models.Query.tags)
122
123 @require_permission('view_query')
124 def get(self):
125 """
126 Retrieve a list of queries.
127
128 :qparam number page_size: Number of queries to return per page
129 :qparam number page: Page number to retrieve
130 :qparam number order: Name of column to order by
131 :qparam number q: Full text search term
132
133 Responds with an array of :ref:`query <query-response-label>` objects.
134 """
135 # See if we want to do full-text search or just regular queries
136 search_term = request.args.get('q', '')
137
138 queries = self.get_queries(search_term)
139
140 results = filter_by_tags(queries, models.Query.tags)
141
142 # order results according to passed order parameter,
143 # special-casing search queries where the database
144 # provides an order by search rank
145 ordered_results = order_results(results, fallback=bool(search_term))
146
147 page = request.args.get('page', 1, type=int)
148 page_size = request.args.get('page_size', 25, type=int)
149
150 response = paginate(
151 ordered_results,
152 page=page,
153 page_size=page_size,
154 serializer=QuerySerializer,
155 with_stats=True,
156 with_last_modified_by=False
157 )
158
159 if search_term:
160 self.record_event({
161 'action': 'search',
162 'object_type': 'query',
163 'term': search_term,
164 })
165 else:
166 self.record_event({
167 'action': 'list',
168 'object_type': 'query',
169 })
170
171 return response
172
173
174 class QueryListResource(BaseQueryListResource):
175 @require_permission('create_query')
176 def post(self):
177 """
178 Create a new query.
179
180 :<json number data_source_id: The ID of the data source this query will run on
181 :<json string query: Query text
182 :<json string name:
183 :<json string description:
184 :<json string schedule: Schedule interval, in seconds, for repeated execution of this query
185 :<json object options: Query options
186
187 .. _query-response-label:
188
189 :>json number id: Query ID
190 :>json number latest_query_data_id: ID for latest output data from this query
191 :>json string name:
192 :>json string description:
193 :>json string query: Query text
194 :>json string query_hash: Hash of query text
195 :>json string schedule: Schedule interval, in seconds, for repeated execution of this query
196 :>json string api_key: Key for public access to this query's results.
197 :>json boolean is_archived: Whether this query is displayed in indexes and search results or not.
198 :>json boolean is_draft: Whether this query is a draft or not
199 :>json string updated_at: Time of last modification, in ISO format
200 :>json string created_at: Time of creation, in ISO format
201 :>json number data_source_id: ID of the data source this query will run on
202 :>json object options: Query options
203 :>json number version: Revision version (for update conflict avoidance)
204 :>json number user_id: ID of query creator
205 :>json number last_modified_by_id: ID of user who last modified this query
206 :>json string retrieved_at: Time when query results were last retrieved, in ISO format (may be null)
207 :>json number runtime: Runtime of last query execution, in seconds (may be null)
208 """
209 query_def = request.get_json(force=True)
210 data_source = models.DataSource.get_by_id_and_org(query_def.pop('data_source_id'), self.current_org)
211 require_access(data_source.groups, self.current_user, not_view_only)
212
213 for field in ['id', 'created_at', 'api_key', 'visualizations', 'latest_query_data', 'last_modified_by']:
214 query_def.pop(field, None)
215
216 query_def['query_text'] = query_def.pop('query')
217 query_def['user'] = self.current_user
218 query_def['data_source'] = data_source
219 query_def['org'] = self.current_org
220 query_def['is_draft'] = True
221 query = models.Query.create(**query_def)
222 models.db.session.add(query)
223 models.db.session.commit()
224
225 self.record_event({
226 'action': 'create',
227 'object_id': query.id,
228 'object_type': 'query'
229 })
230
231 return QuerySerializer(query).serialize()
232
233
234 class QueryArchiveResource(BaseQueryListResource):
235
236 def get_queries(self, search_term):
237 if search_term:
238 return models.Query.search(
239 search_term,
240 self.current_user.group_ids,
241 self.current_user.id,
242 include_drafts=False,
243 include_archived=True,
244 )
245 else:
246 return models.Query.all_queries(
247 self.current_user.group_ids,
248 self.current_user.id,
249 include_drafts=False,
250 include_archived=True,
251 )
252
253
254 class MyQueriesResource(BaseResource):
255 @require_permission('view_query')
256 def get(self):
257 """
258 Retrieve a list of queries created by the current user.
259
260 :qparam number page_size: Number of queries to return per page
261 :qparam number page: Page number to retrieve
262 :qparam number order: Name of column to order by
263 :qparam number search: Full text search term
264
265 Responds with an array of :ref:`query <query-response-label>` objects.
266 """
267 search_term = request.args.get('q', '')
268 if search_term:
269 results = models.Query.search_by_user(search_term, self.current_user)
270 else:
271 results = models.Query.by_user(self.current_user)
272
273 results = filter_by_tags(results, models.Query.tags)
274
275 # order results according to passed order parameter,
276 # special-casing search queries where the database
277 # provides an order by search rank
278 ordered_results = order_results(results, fallback=bool(search_term))
279
280 page = request.args.get('page', 1, type=int)
281 page_size = request.args.get('page_size', 25, type=int)
282 return paginate(
283 ordered_results,
284 page,
285 page_size,
286 QuerySerializer,
287 with_stats=True,
288 with_last_modified_by=False,
289 )
290
291
292 class QueryResource(BaseResource):
293 @require_permission('edit_query')
294 def post(self, query_id):
295 """
296 Modify a query.
297
298 :param query_id: ID of query to update
299 :<json number data_source_id: The ID of the data source this query will run on
300 :<json string query: Query text
301 :<json string name:
302 :<json string description:
303 :<json string schedule: Schedule interval, in seconds, for repeated execution of this query
304 :<json object options: Query options
305
306 Responds with the updated :ref:`query <query-response-label>` object.
307 """
308 query = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)
309 query_def = request.get_json(force=True)
310
311 require_object_modify_permission(query, self.current_user)
312
313 for field in ['id', 'created_at', 'api_key', 'visualizations', 'latest_query_data', 'user', 'last_modified_by', 'org']:
314 query_def.pop(field, None)
315
316 if 'query' in query_def:
317 query_def['query_text'] = query_def.pop('query')
318
319 query_def['last_modified_by'] = self.current_user
320 query_def['changed_by'] = self.current_user
321 # SQLAlchemy handles the case where a concurrent transaction beats us
322 # to the update. But we still have to make sure that we're not starting
323 # out behind.
324 if 'version' in query_def and query_def['version'] != query.version:
325 abort(409)
326
327 try:
328 self.update_model(query, query_def)
329 models.db.session.commit()
330 except StaleDataError:
331 abort(409)
332
333 return QuerySerializer(query, with_visualizations=True).serialize()
334
335 @require_permission('view_query')
336 def get(self, query_id):
337 """
338 Retrieve a query.
339
340 :param query_id: ID of query to fetch
341
342 Responds with the :ref:`query <query-response-label>` contents.
343 """
344 q = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)
345 require_access(q.groups, self.current_user, view_only)
346
347 result = QuerySerializer(q, with_visualizations=True).serialize()
348 result['can_edit'] = can_modify(q, self.current_user)
349
350 self.record_event({
351 'action': 'view',
352 'object_id': query_id,
353 'object_type': 'query',
354 })
355
356 return result
357
358 # TODO: move to resource of its own? (POST /queries/{id}/archive)
359 def delete(self, query_id):
360 """
361 Archives a query.
362
363 :param query_id: ID of query to archive
364 """
365 query = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)
366 require_admin_or_owner(query.user_id)
367 query.archive(self.current_user)
368 models.db.session.commit()
369
370
371 class QueryForkResource(BaseResource):
372 @require_permission('edit_query')
373 def post(self, query_id):
374 """
375 Creates a new query, copying the query text from an existing one.
376
377 :param query_id: ID of query to fork
378
379 Responds with created :ref:`query <query-response-label>` object.
380 """
381 query = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)
382 require_access(query.data_source.groups, self.current_user, not_view_only)
383 forked_query = query.fork(self.current_user)
384 models.db.session.commit()
385
386 self.record_event({
387 'action': 'fork',
388 'object_id': query_id,
389 'object_type': 'query',
390 })
391
392 return QuerySerializer(forked_query, with_visualizations=True).serialize()
393
394
395 class QueryRefreshResource(BaseResource):
396 def post(self, query_id):
397 """
398 Execute a query, updating the query object with the results.
399
400 :param query_id: ID of query to execute
401
402 Responds with query task details.
403 """
404 # TODO: this should actually check for permissions, but because currently you can only
405 # get here either with a user API key or a query one, we can just check whether it's
406 # an api key (meaning this is a query API key, which only grants read access).
407 if self.current_user.is_api_user():
408 abort(403, message="Please use a user API key.")
409
410 query = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)
411 require_access(query.groups, self.current_user, not_view_only)
412
413 parameter_values = collect_parameters_from_request(request.args)
414
415 return run_query(query.data_source, parameter_values, query.query_text, query.id)
416
417
418 class QueryTagsResource(BaseResource):
419 def get(self):
420 """
421 Returns all query tags including those for drafts.
422 """
423 tags = models.Query.all_tags(self.current_user, include_drafts=True)
424 return {
425 'tags': [
426 {
427 'name': name,
428 'count': count,
429 }
430 for name, count in tags
431 ]
432 }
433
```
--- 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/redash/handlers/queries.py b/redash/handlers/queries.py
--- a/redash/handlers/queries.py
+++ b/redash/handlers/queries.py
@@ -228,7 +228,7 @@
'object_type': 'query'
})
- return QuerySerializer(query).serialize()
+ return QuerySerializer(query, with_visualizations=True).serialize()
class QueryArchiveResource(BaseQueryListResource):
| {"golden_diff": "diff --git a/redash/handlers/queries.py b/redash/handlers/queries.py\n--- a/redash/handlers/queries.py\n+++ b/redash/handlers/queries.py\n@@ -228,7 +228,7 @@\n 'object_type': 'query'\n })\n \n- return QuerySerializer(query).serialize()\n+ return QuerySerializer(query, with_visualizations=True).serialize()\n \n \n class QueryArchiveResource(BaseQueryListResource):\n", "issue": "When creating a visualisation after running a query the query results are deleted\nWe are testing the latest stable version of redash (6.0.0+b10818 (7fa66654)\r\nFound a regression when creating a new visualization, to reproduce:\r\n0. Open a new browser tab and log into redash\r\n1. Run a query\r\n2. Create a new visualization\r\n3. The X & Y drop downs are empty\r\n4. When you cancel the visualization creation you see that the query results disappeared\r\n\r\nNote - the issue occurs only when you run redash for the first time on a new session\n", "before_files": [{"content": "import sqlparse\nfrom flask import jsonify, request, url_for\nfrom flask_login import login_required\nfrom flask_restful import abort\nfrom sqlalchemy.orm.exc import StaleDataError\nfrom funcy import partial\n\nfrom redash import models, settings\nfrom redash.authentication.org_resolving import current_org\nfrom redash.handlers.base import (BaseResource, filter_by_tags, get_object_or_404,\n org_scoped_rule, paginate, routes, order_results as _order_results)\nfrom redash.handlers.query_results import run_query\nfrom redash.permissions import (can_modify, not_view_only, require_access,\n require_admin_or_owner,\n require_object_modify_permission,\n require_permission, view_only)\nfrom redash.utils import collect_parameters_from_request\nfrom redash.serializers import QuerySerializer\n\n\n# Ordering map for relationships\norder_map = {\n 'name': 'lowercase_name',\n '-name': '-lowercase_name',\n 'created_at': 'created_at',\n '-created_at': '-created_at',\n 'schedule': 'schedule',\n '-schedule': '-schedule',\n 'runtime': 'query_results-runtime',\n '-runtime': '-query_results-runtime',\n 'executed_at': 'query_results-retrieved_at',\n '-executed_at': '-query_results-retrieved_at',\n 'created_by': 'users-name',\n '-created_by': '-users-name',\n}\n\norder_results = partial(\n _order_results,\n default_order='-created_at',\n allowed_orders=order_map,\n)\n\n\[email protected](org_scoped_rule('/api/queries/format'), methods=['POST'])\n@login_required\ndef format_sql_query(org_slug=None):\n \"\"\"\n Formats an SQL query using the Python ``sqlparse`` formatter.\n\n :<json string query: The SQL text to format\n :>json string query: Formatted SQL text\n \"\"\"\n arguments = request.get_json(force=True)\n query = arguments.get(\"query\", \"\")\n\n return jsonify({'query': sqlparse.format(query, **settings.SQLPARSE_FORMAT_OPTIONS)})\n\n\nclass QuerySearchResource(BaseResource):\n @require_permission('view_query')\n def get(self):\n \"\"\"\n Search query text, names, and descriptions.\n\n :qparam string q: Search term\n :qparam number include_drafts: Whether to include draft in results\n\n Responds with a list of :ref:`query <query-response-label>` objects.\n \"\"\"\n term = request.args.get('q', '')\n if not term:\n return []\n\n include_drafts = request.args.get('include_drafts') is not None\n\n self.record_event({\n 'action': 'search',\n 'object_type': 'query',\n 'term': term,\n })\n\n # this redirects to the new query list API that is aware of search\n new_location = url_for(\n 'queries',\n q=term,\n org_slug=current_org.slug,\n drafts='true' if include_drafts else 'false',\n )\n return {}, 301, {'Location': new_location}\n\n\nclass QueryRecentResource(BaseResource):\n @require_permission('view_query')\n def get(self):\n \"\"\"\n Retrieve up to 10 queries recently modified by the user.\n\n Responds with a list of :ref:`query <query-response-label>` objects.\n \"\"\"\n\n results = models.Query.by_user(self.current_user).order_by(models.Query.updated_at.desc()).limit(10)\n return QuerySerializer(results, with_last_modified_by=False, with_user=False).serialize()\n\n\nclass BaseQueryListResource(BaseResource):\n\n def get_queries(self, search_term):\n if search_term:\n results = models.Query.search(\n search_term,\n self.current_user.group_ids,\n self.current_user.id,\n include_drafts=True,\n )\n else:\n results = models.Query.all_queries(\n self.current_user.group_ids,\n self.current_user.id,\n include_drafts=True,\n )\n return filter_by_tags(results, models.Query.tags)\n\n @require_permission('view_query')\n def get(self):\n \"\"\"\n Retrieve a list of queries.\n\n :qparam number page_size: Number of queries to return per page\n :qparam number page: Page number to retrieve\n :qparam number order: Name of column to order by\n :qparam number q: Full text search term\n\n Responds with an array of :ref:`query <query-response-label>` objects.\n \"\"\"\n # See if we want to do full-text search or just regular queries\n search_term = request.args.get('q', '')\n\n queries = self.get_queries(search_term)\n\n results = filter_by_tags(queries, models.Query.tags)\n\n # order results according to passed order parameter,\n # special-casing search queries where the database\n # provides an order by search rank\n ordered_results = order_results(results, fallback=bool(search_term))\n\n page = request.args.get('page', 1, type=int)\n page_size = request.args.get('page_size', 25, type=int)\n\n response = paginate(\n ordered_results,\n page=page,\n page_size=page_size,\n serializer=QuerySerializer,\n with_stats=True,\n with_last_modified_by=False\n )\n\n if search_term:\n self.record_event({\n 'action': 'search',\n 'object_type': 'query',\n 'term': search_term,\n })\n else:\n self.record_event({\n 'action': 'list',\n 'object_type': 'query',\n })\n\n return response\n\n\nclass QueryListResource(BaseQueryListResource):\n @require_permission('create_query')\n def post(self):\n \"\"\"\n Create a new query.\n\n :<json number data_source_id: The ID of the data source this query will run on\n :<json string query: Query text\n :<json string name:\n :<json string description:\n :<json string schedule: Schedule interval, in seconds, for repeated execution of this query\n :<json object options: Query options\n\n .. _query-response-label:\n\n :>json number id: Query ID\n :>json number latest_query_data_id: ID for latest output data from this query\n :>json string name:\n :>json string description:\n :>json string query: Query text\n :>json string query_hash: Hash of query text\n :>json string schedule: Schedule interval, in seconds, for repeated execution of this query\n :>json string api_key: Key for public access to this query's results.\n :>json boolean is_archived: Whether this query is displayed in indexes and search results or not.\n :>json boolean is_draft: Whether this query is a draft or not\n :>json string updated_at: Time of last modification, in ISO format\n :>json string created_at: Time of creation, in ISO format\n :>json number data_source_id: ID of the data source this query will run on\n :>json object options: Query options\n :>json number version: Revision version (for update conflict avoidance)\n :>json number user_id: ID of query creator\n :>json number last_modified_by_id: ID of user who last modified this query\n :>json string retrieved_at: Time when query results were last retrieved, in ISO format (may be null)\n :>json number runtime: Runtime of last query execution, in seconds (may be null)\n \"\"\"\n query_def = request.get_json(force=True)\n data_source = models.DataSource.get_by_id_and_org(query_def.pop('data_source_id'), self.current_org)\n require_access(data_source.groups, self.current_user, not_view_only)\n\n for field in ['id', 'created_at', 'api_key', 'visualizations', 'latest_query_data', 'last_modified_by']:\n query_def.pop(field, None)\n\n query_def['query_text'] = query_def.pop('query')\n query_def['user'] = self.current_user\n query_def['data_source'] = data_source\n query_def['org'] = self.current_org\n query_def['is_draft'] = True\n query = models.Query.create(**query_def)\n models.db.session.add(query)\n models.db.session.commit()\n\n self.record_event({\n 'action': 'create',\n 'object_id': query.id,\n 'object_type': 'query'\n })\n\n return QuerySerializer(query).serialize()\n\n\nclass QueryArchiveResource(BaseQueryListResource):\n\n def get_queries(self, search_term):\n if search_term:\n return models.Query.search(\n search_term,\n self.current_user.group_ids,\n self.current_user.id,\n include_drafts=False,\n include_archived=True,\n )\n else:\n return models.Query.all_queries(\n self.current_user.group_ids,\n self.current_user.id,\n include_drafts=False,\n include_archived=True,\n )\n\n\nclass MyQueriesResource(BaseResource):\n @require_permission('view_query')\n def get(self):\n \"\"\"\n Retrieve a list of queries created by the current user.\n\n :qparam number page_size: Number of queries to return per page\n :qparam number page: Page number to retrieve\n :qparam number order: Name of column to order by\n :qparam number search: Full text search term\n\n Responds with an array of :ref:`query <query-response-label>` objects.\n \"\"\"\n search_term = request.args.get('q', '')\n if search_term:\n results = models.Query.search_by_user(search_term, self.current_user)\n else:\n results = models.Query.by_user(self.current_user)\n\n results = filter_by_tags(results, models.Query.tags)\n\n # order results according to passed order parameter,\n # special-casing search queries where the database\n # provides an order by search rank\n ordered_results = order_results(results, fallback=bool(search_term))\n\n page = request.args.get('page', 1, type=int)\n page_size = request.args.get('page_size', 25, type=int)\n return paginate(\n ordered_results,\n page,\n page_size,\n QuerySerializer,\n with_stats=True,\n with_last_modified_by=False,\n )\n\n\nclass QueryResource(BaseResource):\n @require_permission('edit_query')\n def post(self, query_id):\n \"\"\"\n Modify a query.\n\n :param query_id: ID of query to update\n :<json number data_source_id: The ID of the data source this query will run on\n :<json string query: Query text\n :<json string name:\n :<json string description:\n :<json string schedule: Schedule interval, in seconds, for repeated execution of this query\n :<json object options: Query options\n\n Responds with the updated :ref:`query <query-response-label>` object.\n \"\"\"\n query = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)\n query_def = request.get_json(force=True)\n\n require_object_modify_permission(query, self.current_user)\n\n for field in ['id', 'created_at', 'api_key', 'visualizations', 'latest_query_data', 'user', 'last_modified_by', 'org']:\n query_def.pop(field, None)\n\n if 'query' in query_def:\n query_def['query_text'] = query_def.pop('query')\n\n query_def['last_modified_by'] = self.current_user\n query_def['changed_by'] = self.current_user\n # SQLAlchemy handles the case where a concurrent transaction beats us\n # to the update. But we still have to make sure that we're not starting\n # out behind.\n if 'version' in query_def and query_def['version'] != query.version:\n abort(409)\n\n try:\n self.update_model(query, query_def)\n models.db.session.commit()\n except StaleDataError:\n abort(409)\n\n return QuerySerializer(query, with_visualizations=True).serialize()\n\n @require_permission('view_query')\n def get(self, query_id):\n \"\"\"\n Retrieve a query.\n\n :param query_id: ID of query to fetch\n\n Responds with the :ref:`query <query-response-label>` contents.\n \"\"\"\n q = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)\n require_access(q.groups, self.current_user, view_only)\n\n result = QuerySerializer(q, with_visualizations=True).serialize()\n result['can_edit'] = can_modify(q, self.current_user)\n\n self.record_event({\n 'action': 'view',\n 'object_id': query_id,\n 'object_type': 'query',\n })\n\n return result\n\n # TODO: move to resource of its own? (POST /queries/{id}/archive)\n def delete(self, query_id):\n \"\"\"\n Archives a query.\n\n :param query_id: ID of query to archive\n \"\"\"\n query = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)\n require_admin_or_owner(query.user_id)\n query.archive(self.current_user)\n models.db.session.commit()\n\n\nclass QueryForkResource(BaseResource):\n @require_permission('edit_query')\n def post(self, query_id):\n \"\"\"\n Creates a new query, copying the query text from an existing one.\n\n :param query_id: ID of query to fork\n\n Responds with created :ref:`query <query-response-label>` object.\n \"\"\"\n query = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)\n require_access(query.data_source.groups, self.current_user, not_view_only)\n forked_query = query.fork(self.current_user)\n models.db.session.commit()\n\n self.record_event({\n 'action': 'fork',\n 'object_id': query_id,\n 'object_type': 'query',\n })\n\n return QuerySerializer(forked_query, with_visualizations=True).serialize()\n\n\nclass QueryRefreshResource(BaseResource):\n def post(self, query_id):\n \"\"\"\n Execute a query, updating the query object with the results.\n\n :param query_id: ID of query to execute\n\n Responds with query task details.\n \"\"\"\n # TODO: this should actually check for permissions, but because currently you can only\n # get here either with a user API key or a query one, we can just check whether it's\n # an api key (meaning this is a query API key, which only grants read access).\n if self.current_user.is_api_user():\n abort(403, message=\"Please use a user API key.\")\n\n query = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)\n require_access(query.groups, self.current_user, not_view_only)\n\n parameter_values = collect_parameters_from_request(request.args)\n\n return run_query(query.data_source, parameter_values, query.query_text, query.id)\n\n\nclass QueryTagsResource(BaseResource):\n def get(self):\n \"\"\"\n Returns all query tags including those for drafts.\n \"\"\"\n tags = models.Query.all_tags(self.current_user, include_drafts=True)\n return {\n 'tags': [\n {\n 'name': name,\n 'count': count,\n }\n for name, count in tags\n ]\n }\n", "path": "redash/handlers/queries.py"}], "after_files": [{"content": "import sqlparse\nfrom flask import jsonify, request, url_for\nfrom flask_login import login_required\nfrom flask_restful import abort\nfrom sqlalchemy.orm.exc import StaleDataError\nfrom funcy import partial\n\nfrom redash import models, settings\nfrom redash.authentication.org_resolving import current_org\nfrom redash.handlers.base import (BaseResource, filter_by_tags, get_object_or_404,\n org_scoped_rule, paginate, routes, order_results as _order_results)\nfrom redash.handlers.query_results import run_query\nfrom redash.permissions import (can_modify, not_view_only, require_access,\n require_admin_or_owner,\n require_object_modify_permission,\n require_permission, view_only)\nfrom redash.utils import collect_parameters_from_request\nfrom redash.serializers import QuerySerializer\n\n\n# Ordering map for relationships\norder_map = {\n 'name': 'lowercase_name',\n '-name': '-lowercase_name',\n 'created_at': 'created_at',\n '-created_at': '-created_at',\n 'schedule': 'schedule',\n '-schedule': '-schedule',\n 'runtime': 'query_results-runtime',\n '-runtime': '-query_results-runtime',\n 'executed_at': 'query_results-retrieved_at',\n '-executed_at': '-query_results-retrieved_at',\n 'created_by': 'users-name',\n '-created_by': '-users-name',\n}\n\norder_results = partial(\n _order_results,\n default_order='-created_at',\n allowed_orders=order_map,\n)\n\n\[email protected](org_scoped_rule('/api/queries/format'), methods=['POST'])\n@login_required\ndef format_sql_query(org_slug=None):\n \"\"\"\n Formats an SQL query using the Python ``sqlparse`` formatter.\n\n :<json string query: The SQL text to format\n :>json string query: Formatted SQL text\n \"\"\"\n arguments = request.get_json(force=True)\n query = arguments.get(\"query\", \"\")\n\n return jsonify({'query': sqlparse.format(query, **settings.SQLPARSE_FORMAT_OPTIONS)})\n\n\nclass QuerySearchResource(BaseResource):\n @require_permission('view_query')\n def get(self):\n \"\"\"\n Search query text, names, and descriptions.\n\n :qparam string q: Search term\n :qparam number include_drafts: Whether to include draft in results\n\n Responds with a list of :ref:`query <query-response-label>` objects.\n \"\"\"\n term = request.args.get('q', '')\n if not term:\n return []\n\n include_drafts = request.args.get('include_drafts') is not None\n\n self.record_event({\n 'action': 'search',\n 'object_type': 'query',\n 'term': term,\n })\n\n # this redirects to the new query list API that is aware of search\n new_location = url_for(\n 'queries',\n q=term,\n org_slug=current_org.slug,\n drafts='true' if include_drafts else 'false',\n )\n return {}, 301, {'Location': new_location}\n\n\nclass QueryRecentResource(BaseResource):\n @require_permission('view_query')\n def get(self):\n \"\"\"\n Retrieve up to 10 queries recently modified by the user.\n\n Responds with a list of :ref:`query <query-response-label>` objects.\n \"\"\"\n\n results = models.Query.by_user(self.current_user).order_by(models.Query.updated_at.desc()).limit(10)\n return QuerySerializer(results, with_last_modified_by=False, with_user=False).serialize()\n\n\nclass BaseQueryListResource(BaseResource):\n\n def get_queries(self, search_term):\n if search_term:\n results = models.Query.search(\n search_term,\n self.current_user.group_ids,\n self.current_user.id,\n include_drafts=True,\n )\n else:\n results = models.Query.all_queries(\n self.current_user.group_ids,\n self.current_user.id,\n include_drafts=True,\n )\n return filter_by_tags(results, models.Query.tags)\n\n @require_permission('view_query')\n def get(self):\n \"\"\"\n Retrieve a list of queries.\n\n :qparam number page_size: Number of queries to return per page\n :qparam number page: Page number to retrieve\n :qparam number order: Name of column to order by\n :qparam number q: Full text search term\n\n Responds with an array of :ref:`query <query-response-label>` objects.\n \"\"\"\n # See if we want to do full-text search or just regular queries\n search_term = request.args.get('q', '')\n\n queries = self.get_queries(search_term)\n\n results = filter_by_tags(queries, models.Query.tags)\n\n # order results according to passed order parameter,\n # special-casing search queries where the database\n # provides an order by search rank\n ordered_results = order_results(results, fallback=bool(search_term))\n\n page = request.args.get('page', 1, type=int)\n page_size = request.args.get('page_size', 25, type=int)\n\n response = paginate(\n ordered_results,\n page=page,\n page_size=page_size,\n serializer=QuerySerializer,\n with_stats=True,\n with_last_modified_by=False\n )\n\n if search_term:\n self.record_event({\n 'action': 'search',\n 'object_type': 'query',\n 'term': search_term,\n })\n else:\n self.record_event({\n 'action': 'list',\n 'object_type': 'query',\n })\n\n return response\n\n\nclass QueryListResource(BaseQueryListResource):\n @require_permission('create_query')\n def post(self):\n \"\"\"\n Create a new query.\n\n :<json number data_source_id: The ID of the data source this query will run on\n :<json string query: Query text\n :<json string name:\n :<json string description:\n :<json string schedule: Schedule interval, in seconds, for repeated execution of this query\n :<json object options: Query options\n\n .. _query-response-label:\n\n :>json number id: Query ID\n :>json number latest_query_data_id: ID for latest output data from this query\n :>json string name:\n :>json string description:\n :>json string query: Query text\n :>json string query_hash: Hash of query text\n :>json string schedule: Schedule interval, in seconds, for repeated execution of this query\n :>json string api_key: Key for public access to this query's results.\n :>json boolean is_archived: Whether this query is displayed in indexes and search results or not.\n :>json boolean is_draft: Whether this query is a draft or not\n :>json string updated_at: Time of last modification, in ISO format\n :>json string created_at: Time of creation, in ISO format\n :>json number data_source_id: ID of the data source this query will run on\n :>json object options: Query options\n :>json number version: Revision version (for update conflict avoidance)\n :>json number user_id: ID of query creator\n :>json number last_modified_by_id: ID of user who last modified this query\n :>json string retrieved_at: Time when query results were last retrieved, in ISO format (may be null)\n :>json number runtime: Runtime of last query execution, in seconds (may be null)\n \"\"\"\n query_def = request.get_json(force=True)\n data_source = models.DataSource.get_by_id_and_org(query_def.pop('data_source_id'), self.current_org)\n require_access(data_source.groups, self.current_user, not_view_only)\n\n for field in ['id', 'created_at', 'api_key', 'visualizations', 'latest_query_data', 'last_modified_by']:\n query_def.pop(field, None)\n\n query_def['query_text'] = query_def.pop('query')\n query_def['user'] = self.current_user\n query_def['data_source'] = data_source\n query_def['org'] = self.current_org\n query_def['is_draft'] = True\n query = models.Query.create(**query_def)\n models.db.session.add(query)\n models.db.session.commit()\n\n self.record_event({\n 'action': 'create',\n 'object_id': query.id,\n 'object_type': 'query'\n })\n\n return QuerySerializer(query, with_visualizations=True).serialize()\n\n\nclass QueryArchiveResource(BaseQueryListResource):\n\n def get_queries(self, search_term):\n if search_term:\n return models.Query.search(\n search_term,\n self.current_user.group_ids,\n self.current_user.id,\n include_drafts=False,\n include_archived=True,\n )\n else:\n return models.Query.all_queries(\n self.current_user.group_ids,\n self.current_user.id,\n include_drafts=False,\n include_archived=True,\n )\n\n\nclass MyQueriesResource(BaseResource):\n @require_permission('view_query')\n def get(self):\n \"\"\"\n Retrieve a list of queries created by the current user.\n\n :qparam number page_size: Number of queries to return per page\n :qparam number page: Page number to retrieve\n :qparam number order: Name of column to order by\n :qparam number search: Full text search term\n\n Responds with an array of :ref:`query <query-response-label>` objects.\n \"\"\"\n search_term = request.args.get('q', '')\n if search_term:\n results = models.Query.search_by_user(search_term, self.current_user)\n else:\n results = models.Query.by_user(self.current_user)\n\n results = filter_by_tags(results, models.Query.tags)\n\n # order results according to passed order parameter,\n # special-casing search queries where the database\n # provides an order by search rank\n ordered_results = order_results(results, fallback=bool(search_term))\n\n page = request.args.get('page', 1, type=int)\n page_size = request.args.get('page_size', 25, type=int)\n return paginate(\n ordered_results,\n page,\n page_size,\n QuerySerializer,\n with_stats=True,\n with_last_modified_by=False,\n )\n\n\nclass QueryResource(BaseResource):\n @require_permission('edit_query')\n def post(self, query_id):\n \"\"\"\n Modify a query.\n\n :param query_id: ID of query to update\n :<json number data_source_id: The ID of the data source this query will run on\n :<json string query: Query text\n :<json string name:\n :<json string description:\n :<json string schedule: Schedule interval, in seconds, for repeated execution of this query\n :<json object options: Query options\n\n Responds with the updated :ref:`query <query-response-label>` object.\n \"\"\"\n query = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)\n query_def = request.get_json(force=True)\n\n require_object_modify_permission(query, self.current_user)\n\n for field in ['id', 'created_at', 'api_key', 'visualizations', 'latest_query_data', 'user', 'last_modified_by', 'org']:\n query_def.pop(field, None)\n\n if 'query' in query_def:\n query_def['query_text'] = query_def.pop('query')\n\n query_def['last_modified_by'] = self.current_user\n query_def['changed_by'] = self.current_user\n # SQLAlchemy handles the case where a concurrent transaction beats us\n # to the update. But we still have to make sure that we're not starting\n # out behind.\n if 'version' in query_def and query_def['version'] != query.version:\n abort(409)\n\n try:\n self.update_model(query, query_def)\n models.db.session.commit()\n except StaleDataError:\n abort(409)\n\n return QuerySerializer(query, with_visualizations=True).serialize()\n\n @require_permission('view_query')\n def get(self, query_id):\n \"\"\"\n Retrieve a query.\n\n :param query_id: ID of query to fetch\n\n Responds with the :ref:`query <query-response-label>` contents.\n \"\"\"\n q = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)\n require_access(q.groups, self.current_user, view_only)\n\n result = QuerySerializer(q, with_visualizations=True).serialize()\n result['can_edit'] = can_modify(q, self.current_user)\n\n self.record_event({\n 'action': 'view',\n 'object_id': query_id,\n 'object_type': 'query',\n })\n\n return result\n\n # TODO: move to resource of its own? (POST /queries/{id}/archive)\n def delete(self, query_id):\n \"\"\"\n Archives a query.\n\n :param query_id: ID of query to archive\n \"\"\"\n query = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)\n require_admin_or_owner(query.user_id)\n query.archive(self.current_user)\n models.db.session.commit()\n\n\nclass QueryForkResource(BaseResource):\n @require_permission('edit_query')\n def post(self, query_id):\n \"\"\"\n Creates a new query, copying the query text from an existing one.\n\n :param query_id: ID of query to fork\n\n Responds with created :ref:`query <query-response-label>` object.\n \"\"\"\n query = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)\n require_access(query.data_source.groups, self.current_user, not_view_only)\n forked_query = query.fork(self.current_user)\n models.db.session.commit()\n\n self.record_event({\n 'action': 'fork',\n 'object_id': query_id,\n 'object_type': 'query',\n })\n\n return QuerySerializer(forked_query, with_visualizations=True).serialize()\n\n\nclass QueryRefreshResource(BaseResource):\n def post(self, query_id):\n \"\"\"\n Execute a query, updating the query object with the results.\n\n :param query_id: ID of query to execute\n\n Responds with query task details.\n \"\"\"\n # TODO: this should actually check for permissions, but because currently you can only\n # get here either with a user API key or a query one, we can just check whether it's\n # an api key (meaning this is a query API key, which only grants read access).\n if self.current_user.is_api_user():\n abort(403, message=\"Please use a user API key.\")\n\n query = get_object_or_404(models.Query.get_by_id_and_org, query_id, self.current_org)\n require_access(query.groups, self.current_user, not_view_only)\n\n parameter_values = collect_parameters_from_request(request.args)\n\n return run_query(query.data_source, parameter_values, query.query_text, query.id)\n\n\nclass QueryTagsResource(BaseResource):\n def get(self):\n \"\"\"\n Returns all query tags including those for drafts.\n \"\"\"\n tags = models.Query.all_tags(self.current_user, include_drafts=True)\n return {\n 'tags': [\n {\n 'name': name,\n 'count': count,\n }\n for name, count in tags\n ]\n }\n", "path": "redash/handlers/queries.py"}]} |
gh_patches_debug_295 | rasdani/github-patches | git_diff | arviz-devs__arviz-1962 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
from_pystan puts log likelihood and posterior predictions in posterior data
## Short Description
I would like to convert a posterior sample from a PyStan `stan.fit.Fit` object to an `az.InferenceData` object, but the log likelihood and posterior prediction variables end up in the `posterior` section. (They also appear in their respective sections of the `InferenceData` object). I was wondering if there is a way to have them not be in the `posterior` section. This would make using them with other ArviZ functions much easier because then they will *not* be included in tables or plots of the *posterior distributions* such as `az.plot_trace(data)`.
## Code Example or link
The example is from the PyStan section of the *Creating InferenceData* guide: https://arviz-devs.github.io/arviz/getting_started/CreatingInferenceData.html#from-pystan
> Note that there are some changes to reflect changes in the PyStan API (such as importing `stan` instead of `pystan`.
```python
import arviz as az
import numpy as np
import stan
schools_code = """
data {
int<lower=0> J;
real y[J];
real<lower=0> sigma[J];
}
parameters {
real mu;
real<lower=0> tau;
real theta_tilde[J];
}
transformed parameters {
real theta[J];
for (j in 1:J)
theta[j] = mu + tau * theta_tilde[j];
}
model {
mu ~ normal(0, 5);
tau ~ cauchy(0, 5);
theta_tilde ~ normal(0, 1);
y ~ normal(theta, sigma);
}
generated quantities {
vector[J] log_lik;
vector[J] y_hat;
for (j in 1:J) {
log_lik[j] = normal_lpdf(y[j] | theta[j], sigma[j]);
y_hat[j] = normal_rng(theta[j], sigma[j]);
}
}
"""
eight_school_data = {
"J": 8,
"y": np.array([28.0, 8.0, -3.0, 7.0, -1.0, 1.0, 18.0, 12.0]),
"sigma": np.array([15.0, 10.0, 16.0, 11.0, 9.0, 11.0, 10.0, 18.0]),
}
stan_model = stan.build(schools_code, data=eight_school_data)
fit = stan_model.sample()
stan_data = az.from_pystan(
posterior=fit,
posterior_predictive="y_hat",
posterior_model= stan_model,
observed_data=["y"],
log_likelihood={"y": "log_lik"},
coords={"school": np.arange(eight_school_data["J"])},
dims={
"theta": ["school"],
"y": ["school"],
"log_lik": ["school"],
"y_hat": ["school"],
"theta_tilde": ["school"],
},
)
stan_data
#> Inference data with groups:
#> > posterior
#> > posterior_predictive
#> > log_likelihood
#> > sample_stats
stan_data.posterior
#> <xarray.Dataset>
#> Dimensions: (chain: 4, draw: 1000, school: 8)
#> Coordinates:
#> * chain (chain) int64 0 1 2 3
#> * draw (draw) int64 0 1 2 3 4 5 6 7 ... 993 994 995 996 997 998 999
#> * school (school) int64 0 1 2 3 4 5 6 7
#> Data variables:
#> mu (chain, draw) float64 5.583 13.74 -1.643 ... 7.135 1.818 2.276
#> tau (chain, draw) float64 3.375 2.563 2.734 ... 1.585 0.2655 8.359
#> theta_tilde (chain, draw, school) float64 0.9058 0.2812 ... 1.286 -0.5058
#> theta (chain, draw, school) float64 8.64 6.531 6.381 ... 13.03 -1.952
#> log_lik (chain, draw, school) float64 -4.46 -3.232 ... -3.345 -4.11
#> y_hat (chain, draw, school) float64 -15.09 7.846 ... 19.34 8.089
#> Attributes:
#> created_at: 2022-01-13T22:30:54.799215
#> arviz_version: 0.11.4
#> inference_library: stan
#> inference_library_version: 3.3.0
#> num_chains: 4
#> num_samples: 1000
#> num_thin: 1
#> num_warmup: 1000
#> save_warmup: 0
#> model_name: models/6kxc6kz6
#> program_code: \ndata {\n int<lower=0> J;\n real y[J];...
#> random_seed: None
```
PyStan version: 3.3.0
ArviZ version: 0.11.4
## Relevant documentation or public examples
- Guide on creating InferenceData objects from PyStan: https://arviz-devs.github.io/arviz/getting_started/CreatingInferenceData.html#from-pystan
- documentation for `from_pystan()`: https://arviz-devs.github.io/arviz/api/generated/arviz.from_pystan.html#arviz-from-pystan
--- 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/data/io_pystan.py`
Content:
```
1 # pylint: disable=too-many-instance-attributes,too-many-lines
2 """PyStan-specific conversion code."""
3 import re
4 import warnings
5 from collections import OrderedDict
6 from copy import deepcopy
7
8 import numpy as np
9 import xarray as xr
10
11 from .. import _log
12 from ..rcparams import rcParams
13 from .base import dict_to_dataset, generate_dims_coords, infer_stan_dtypes, make_attrs, requires
14 from .inference_data import InferenceData
15
16 try:
17 import ujson as json
18 except ImportError:
19 # Can't find ujson using json
20 # mypy struggles with conditional imports expressed as catching ImportError:
21 # https://github.com/python/mypy/issues/1153
22 import json # type: ignore
23
24
25 class PyStanConverter:
26 """Encapsulate PyStan specific logic."""
27
28 def __init__(
29 self,
30 *,
31 posterior=None,
32 posterior_predictive=None,
33 predictions=None,
34 prior=None,
35 prior_predictive=None,
36 observed_data=None,
37 constant_data=None,
38 predictions_constant_data=None,
39 log_likelihood=None,
40 coords=None,
41 dims=None,
42 save_warmup=None,
43 dtypes=None,
44 ):
45 self.posterior = posterior
46 self.posterior_predictive = posterior_predictive
47 self.predictions = predictions
48 self.prior = prior
49 self.prior_predictive = prior_predictive
50 self.observed_data = observed_data
51 self.constant_data = constant_data
52 self.predictions_constant_data = predictions_constant_data
53 self.log_likelihood = (
54 rcParams["data.log_likelihood"] if log_likelihood is None else log_likelihood
55 )
56 self.coords = coords
57 self.dims = dims
58 self.save_warmup = rcParams["data.save_warmup"] if save_warmup is None else save_warmup
59 self.dtypes = dtypes
60
61 if (
62 self.log_likelihood is True
63 and self.posterior is not None
64 and "log_lik" in self.posterior.sim["pars_oi"]
65 ):
66 self.log_likelihood = ["log_lik"]
67 elif isinstance(self.log_likelihood, bool):
68 self.log_likelihood = None
69
70 import pystan # pylint: disable=import-error
71
72 self.pystan = pystan
73
74 @requires("posterior")
75 def posterior_to_xarray(self):
76 """Extract posterior samples from fit."""
77 posterior = self.posterior
78 # filter posterior_predictive and log_likelihood
79 posterior_predictive = self.posterior_predictive
80 if posterior_predictive is None:
81 posterior_predictive = []
82 elif isinstance(posterior_predictive, str):
83 posterior_predictive = [posterior_predictive]
84 predictions = self.predictions
85 if predictions is None:
86 predictions = []
87 elif isinstance(predictions, str):
88 predictions = [predictions]
89 log_likelihood = self.log_likelihood
90 if log_likelihood is None:
91 log_likelihood = []
92 elif isinstance(log_likelihood, str):
93 log_likelihood = [log_likelihood]
94 elif isinstance(log_likelihood, dict):
95 log_likelihood = list(log_likelihood.values())
96
97 ignore = posterior_predictive + predictions + log_likelihood + ["lp__"]
98
99 data, data_warmup = get_draws(
100 posterior, ignore=ignore, warmup=self.save_warmup, dtypes=self.dtypes
101 )
102 attrs = get_attrs(posterior)
103 return (
104 dict_to_dataset(
105 data, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims
106 ),
107 dict_to_dataset(
108 data_warmup, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims
109 ),
110 )
111
112 @requires("posterior")
113 def sample_stats_to_xarray(self):
114 """Extract sample_stats from posterior."""
115 posterior = self.posterior
116
117 data, data_warmup = get_sample_stats(posterior, warmup=self.save_warmup)
118
119 # lp__
120 stat_lp, stat_lp_warmup = get_draws(
121 posterior, variables="lp__", warmup=self.save_warmup, dtypes=self.dtypes
122 )
123 data["lp"] = stat_lp["lp__"]
124 if stat_lp_warmup:
125 data_warmup["lp"] = stat_lp_warmup["lp__"]
126
127 attrs = get_attrs(posterior)
128 return (
129 dict_to_dataset(
130 data, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims
131 ),
132 dict_to_dataset(
133 data_warmup, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims
134 ),
135 )
136
137 @requires("posterior")
138 @requires("log_likelihood")
139 def log_likelihood_to_xarray(self):
140 """Store log_likelihood data in log_likelihood group."""
141 fit = self.posterior
142
143 # log_likelihood values
144 log_likelihood = self.log_likelihood
145 if isinstance(log_likelihood, str):
146 log_likelihood = [log_likelihood]
147 if isinstance(log_likelihood, (list, tuple)):
148 log_likelihood = {name: name for name in log_likelihood}
149 log_likelihood_draws, log_likelihood_draws_warmup = get_draws(
150 fit,
151 variables=list(log_likelihood.values()),
152 warmup=self.save_warmup,
153 dtypes=self.dtypes,
154 )
155 data = {
156 obs_var_name: log_likelihood_draws[log_like_name]
157 for obs_var_name, log_like_name in log_likelihood.items()
158 if log_like_name in log_likelihood_draws
159 }
160
161 data_warmup = {
162 obs_var_name: log_likelihood_draws_warmup[log_like_name]
163 for obs_var_name, log_like_name in log_likelihood.items()
164 if log_like_name in log_likelihood_draws_warmup
165 }
166
167 return (
168 dict_to_dataset(
169 data, library=self.pystan, coords=self.coords, dims=self.dims, skip_event_dims=True
170 ),
171 dict_to_dataset(
172 data_warmup,
173 library=self.pystan,
174 coords=self.coords,
175 dims=self.dims,
176 skip_event_dims=True,
177 ),
178 )
179
180 @requires("posterior")
181 @requires("posterior_predictive")
182 def posterior_predictive_to_xarray(self):
183 """Convert posterior_predictive samples to xarray."""
184 posterior = self.posterior
185 posterior_predictive = self.posterior_predictive
186 data, data_warmup = get_draws(
187 posterior, variables=posterior_predictive, warmup=self.save_warmup, dtypes=self.dtypes
188 )
189 return (
190 dict_to_dataset(data, library=self.pystan, coords=self.coords, dims=self.dims),
191 dict_to_dataset(data_warmup, library=self.pystan, coords=self.coords, dims=self.dims),
192 )
193
194 @requires("posterior")
195 @requires("predictions")
196 def predictions_to_xarray(self):
197 """Convert predictions samples to xarray."""
198 posterior = self.posterior
199 predictions = self.predictions
200 data, data_warmup = get_draws(
201 posterior, variables=predictions, warmup=self.save_warmup, dtypes=self.dtypes
202 )
203 return (
204 dict_to_dataset(data, library=self.pystan, coords=self.coords, dims=self.dims),
205 dict_to_dataset(data_warmup, library=self.pystan, coords=self.coords, dims=self.dims),
206 )
207
208 @requires("prior")
209 def prior_to_xarray(self):
210 """Convert prior samples to xarray."""
211 prior = self.prior
212 # filter posterior_predictive and log_likelihood
213 prior_predictive = self.prior_predictive
214 if prior_predictive is None:
215 prior_predictive = []
216 elif isinstance(prior_predictive, str):
217 prior_predictive = [prior_predictive]
218
219 ignore = prior_predictive + ["lp__"]
220
221 data, _ = get_draws(prior, ignore=ignore, warmup=False, dtypes=self.dtypes)
222 attrs = get_attrs(prior)
223 return dict_to_dataset(
224 data, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims
225 )
226
227 @requires("prior")
228 def sample_stats_prior_to_xarray(self):
229 """Extract sample_stats_prior from prior."""
230 prior = self.prior
231 data, _ = get_sample_stats(prior, warmup=False)
232
233 # lp__
234 stat_lp, _ = get_draws(prior, variables="lp__", warmup=False, dtypes=self.dtypes)
235 data["lp"] = stat_lp["lp__"]
236
237 attrs = get_attrs(prior)
238 return dict_to_dataset(
239 data, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims
240 )
241
242 @requires("prior")
243 @requires("prior_predictive")
244 def prior_predictive_to_xarray(self):
245 """Convert prior_predictive samples to xarray."""
246 prior = self.prior
247 prior_predictive = self.prior_predictive
248 data, _ = get_draws(prior, variables=prior_predictive, warmup=False, dtypes=self.dtypes)
249 return dict_to_dataset(data, library=self.pystan, coords=self.coords, dims=self.dims)
250
251 @requires("posterior")
252 @requires(["observed_data", "constant_data", "predictions_constant_data"])
253 def data_to_xarray(self):
254 """Convert observed, constant data and predictions constant data to xarray."""
255 posterior = self.posterior
256 if self.dims is None:
257 dims = {}
258 else:
259 dims = self.dims
260 obs_const_dict = {}
261 for group_name in ("observed_data", "constant_data", "predictions_constant_data"):
262 names = getattr(self, group_name)
263 if names is None:
264 continue
265 names = [names] if isinstance(names, str) else names
266 data = OrderedDict()
267 for key in names:
268 vals = np.atleast_1d(posterior.data[key])
269 val_dims = dims.get(key)
270 val_dims, coords = generate_dims_coords(
271 vals.shape, key, dims=val_dims, coords=self.coords
272 )
273 data[key] = xr.DataArray(vals, dims=val_dims, coords=coords)
274 obs_const_dict[group_name] = xr.Dataset(
275 data_vars=data, attrs=make_attrs(library=self.pystan)
276 )
277 return obs_const_dict
278
279 def to_inference_data(self):
280 """Convert all available data to an InferenceData object.
281
282 Note that if groups can not be created (i.e., there is no `fit`, so
283 the `posterior` and `sample_stats` can not be extracted), then the InferenceData
284 will not have those groups.
285 """
286 data_dict = self.data_to_xarray()
287 return InferenceData(
288 save_warmup=self.save_warmup,
289 **{
290 "posterior": self.posterior_to_xarray(),
291 "sample_stats": self.sample_stats_to_xarray(),
292 "log_likelihood": self.log_likelihood_to_xarray(),
293 "posterior_predictive": self.posterior_predictive_to_xarray(),
294 "predictions": self.predictions_to_xarray(),
295 "prior": self.prior_to_xarray(),
296 "sample_stats_prior": self.sample_stats_prior_to_xarray(),
297 "prior_predictive": self.prior_predictive_to_xarray(),
298 **({} if data_dict is None else data_dict),
299 },
300 )
301
302
303 class PyStan3Converter:
304 """Encapsulate PyStan3 specific logic."""
305
306 # pylint: disable=too-many-instance-attributes
307 def __init__(
308 self,
309 *,
310 posterior=None,
311 posterior_model=None,
312 posterior_predictive=None,
313 predictions=None,
314 prior=None,
315 prior_model=None,
316 prior_predictive=None,
317 observed_data=None,
318 constant_data=None,
319 predictions_constant_data=None,
320 log_likelihood=None,
321 coords=None,
322 dims=None,
323 dtypes=None,
324 ):
325 self.posterior = posterior
326 self.posterior_model = posterior_model
327 self.posterior_predictive = posterior_predictive
328 self.predictions = predictions
329 self.prior = prior
330 self.prior_model = prior_model
331 self.prior_predictive = prior_predictive
332 self.observed_data = observed_data
333 self.constant_data = constant_data
334 self.predictions_constant_data = predictions_constant_data
335 self.log_likelihood = (
336 rcParams["data.log_likelihood"] if log_likelihood is None else log_likelihood
337 )
338 self.coords = coords
339 self.dims = dims
340 self.dtypes = dtypes
341
342 if (
343 self.log_likelihood is True
344 and self.posterior is not None
345 and "log_lik" in self.posterior.param_names
346 ):
347 self.log_likelihood = ["log_lik"]
348 elif isinstance(self.log_likelihood, bool):
349 self.log_likelihood = None
350
351 import stan # pylint: disable=import-error
352
353 self.stan = stan
354
355 @requires("posterior")
356 def posterior_to_xarray(self):
357 """Extract posterior samples from fit."""
358 posterior = self.posterior
359 posterior_model = self.posterior_model
360 # filter posterior_predictive and log_likelihood
361 posterior_predictive = self.posterior_predictive
362 if posterior_predictive is None:
363 posterior_predictive = []
364 elif isinstance(posterior_predictive, str):
365 posterior_predictive = [posterior_predictive]
366 predictions = self.predictions
367 if predictions is None:
368 predictions = []
369 elif isinstance(predictions, str):
370 predictions = [predictions]
371 log_likelihood = self.log_likelihood
372 if log_likelihood is None:
373 log_likelihood = []
374 elif isinstance(log_likelihood, str):
375 log_likelihood = [log_likelihood]
376 elif isinstance(log_likelihood, dict):
377 log_likelihood = list(log_likelihood.values())
378
379 ignore = posterior_predictive + predictions + log_likelihood
380
381 data = get_draws_stan3(posterior, model=posterior_model, ignore=ignore, dtypes=self.dtypes)
382 attrs = get_attrs_stan3(posterior, model=posterior_model)
383 return dict_to_dataset(
384 data, library=self.stan, attrs=attrs, coords=self.coords, dims=self.dims
385 )
386
387 @requires("posterior")
388 def sample_stats_to_xarray(self):
389 """Extract sample_stats from posterior."""
390 posterior = self.posterior
391 posterior_model = self.posterior_model
392 data = get_sample_stats_stan3(posterior, ignore="lp__", dtypes=self.dtypes)
393 data["lp"] = get_sample_stats_stan3(posterior, variables="lp__")["lp"]
394
395 attrs = get_attrs_stan3(posterior, model=posterior_model)
396 return dict_to_dataset(
397 data, library=self.stan, attrs=attrs, coords=self.coords, dims=self.dims
398 )
399
400 @requires("posterior")
401 @requires("log_likelihood")
402 def log_likelihood_to_xarray(self):
403 """Store log_likelihood data in log_likelihood group."""
404 fit = self.posterior
405
406 log_likelihood = self.log_likelihood
407 model = self.posterior_model
408 if isinstance(log_likelihood, str):
409 log_likelihood = [log_likelihood]
410 if isinstance(log_likelihood, (list, tuple)):
411 log_likelihood = {name: name for name in log_likelihood}
412 log_likelihood_draws = get_draws_stan3(
413 fit, model=model, variables=list(log_likelihood.values()), dtypes=self.dtypes
414 )
415 data = {
416 obs_var_name: log_likelihood_draws[log_like_name]
417 for obs_var_name, log_like_name in log_likelihood.items()
418 if log_like_name in log_likelihood_draws
419 }
420
421 return dict_to_dataset(data, library=self.stan, coords=self.coords, dims=self.dims)
422
423 @requires("posterior")
424 @requires("posterior_predictive")
425 def posterior_predictive_to_xarray(self):
426 """Convert posterior_predictive samples to xarray."""
427 posterior = self.posterior
428 posterior_model = self.posterior_model
429 posterior_predictive = self.posterior_predictive
430 data = get_draws_stan3(
431 posterior, model=posterior_model, variables=posterior_predictive, dtypes=self.dtypes
432 )
433 return dict_to_dataset(data, library=self.stan, coords=self.coords, dims=self.dims)
434
435 @requires("posterior")
436 @requires("predictions")
437 def predictions_to_xarray(self):
438 """Convert predictions samples to xarray."""
439 posterior = self.posterior
440 posterior_model = self.posterior_model
441 predictions = self.predictions
442 data = get_draws_stan3(
443 posterior, model=posterior_model, variables=predictions, dtypes=self.dtypes
444 )
445 return dict_to_dataset(data, library=self.stan, coords=self.coords, dims=self.dims)
446
447 @requires("prior")
448 def prior_to_xarray(self):
449 """Convert prior samples to xarray."""
450 prior = self.prior
451 prior_model = self.prior_model
452 # filter posterior_predictive and log_likelihood
453 prior_predictive = self.prior_predictive
454 if prior_predictive is None:
455 prior_predictive = []
456 elif isinstance(prior_predictive, str):
457 prior_predictive = [prior_predictive]
458
459 ignore = prior_predictive
460
461 data = get_draws_stan3(prior, model=prior_model, ignore=ignore, dtypes=self.dtypes)
462 attrs = get_attrs_stan3(prior, model=prior_model)
463 return dict_to_dataset(
464 data, library=self.stan, attrs=attrs, coords=self.coords, dims=self.dims
465 )
466
467 @requires("prior")
468 def sample_stats_prior_to_xarray(self):
469 """Extract sample_stats_prior from prior."""
470 prior = self.prior
471 prior_model = self.prior_model
472 data = get_sample_stats_stan3(prior, dtypes=self.dtypes)
473 attrs = get_attrs_stan3(prior, model=prior_model)
474 return dict_to_dataset(
475 data, library=self.stan, attrs=attrs, coords=self.coords, dims=self.dims
476 )
477
478 @requires("prior")
479 @requires("prior_predictive")
480 def prior_predictive_to_xarray(self):
481 """Convert prior_predictive samples to xarray."""
482 prior = self.prior
483 prior_model = self.prior_model
484 prior_predictive = self.prior_predictive
485 data = get_draws_stan3(
486 prior, model=prior_model, variables=prior_predictive, dtypes=self.dtypes
487 )
488 return dict_to_dataset(data, library=self.stan, coords=self.coords, dims=self.dims)
489
490 @requires("posterior_model")
491 @requires(["observed_data", "constant_data"])
492 def observed_and_constant_data_to_xarray(self):
493 """Convert observed data to xarray."""
494 posterior_model = self.posterior_model
495 if self.dims is None:
496 dims = {}
497 else:
498 dims = self.dims
499 obs_const_dict = {}
500 for group_name in ("observed_data", "constant_data"):
501 names = getattr(self, group_name)
502 if names is None:
503 continue
504 names = [names] if isinstance(names, str) else names
505 data = OrderedDict()
506 for key in names:
507 vals = np.atleast_1d(posterior_model.data[key])
508 val_dims = dims.get(key)
509 val_dims, coords = generate_dims_coords(
510 vals.shape, key, dims=val_dims, coords=self.coords
511 )
512 data[key] = xr.DataArray(vals, dims=val_dims, coords=coords)
513 obs_const_dict[group_name] = xr.Dataset(
514 data_vars=data, attrs=make_attrs(library=self.stan)
515 )
516 return obs_const_dict
517
518 @requires("posterior_model")
519 @requires("predictions_constant_data")
520 def predictions_constant_data_to_xarray(self):
521 """Convert observed data to xarray."""
522 posterior_model = self.posterior_model
523 if self.dims is None:
524 dims = {}
525 else:
526 dims = self.dims
527 names = self.predictions_constant_data
528 names = [names] if isinstance(names, str) else names
529 data = OrderedDict()
530 for key in names:
531 vals = np.atleast_1d(posterior_model.data[key])
532 val_dims = dims.get(key)
533 val_dims, coords = generate_dims_coords(
534 vals.shape, key, dims=val_dims, coords=self.coords
535 )
536 data[key] = xr.DataArray(vals, dims=val_dims, coords=coords)
537 return xr.Dataset(data_vars=data, attrs=make_attrs(library=self.stan))
538
539 def to_inference_data(self):
540 """Convert all available data to an InferenceData object.
541
542 Note that if groups can not be created (i.e., there is no `fit`, so
543 the `posterior` and `sample_stats` can not be extracted), then the InferenceData
544 will not have those groups.
545 """
546 obs_const_dict = self.observed_and_constant_data_to_xarray()
547 predictions_const_data = self.predictions_constant_data_to_xarray()
548 return InferenceData(
549 **{
550 "posterior": self.posterior_to_xarray(),
551 "sample_stats": self.sample_stats_to_xarray(),
552 "log_likelihood": self.log_likelihood_to_xarray(),
553 "posterior_predictive": self.posterior_predictive_to_xarray(),
554 "predictions": self.predictions_to_xarray(),
555 "prior": self.prior_to_xarray(),
556 "sample_stats_prior": self.sample_stats_prior_to_xarray(),
557 "prior_predictive": self.prior_predictive_to_xarray(),
558 **({} if obs_const_dict is None else obs_const_dict),
559 **(
560 {}
561 if predictions_const_data is None
562 else {"predictions_constant_data": predictions_const_data}
563 ),
564 }
565 )
566
567
568 def get_draws(fit, variables=None, ignore=None, warmup=False, dtypes=None):
569 """Extract draws from PyStan fit."""
570 if ignore is None:
571 ignore = []
572 if fit.mode == 1:
573 msg = "Model in mode 'test_grad'. Sampling is not conducted."
574 raise AttributeError(msg)
575
576 if fit.mode == 2 or fit.sim.get("samples") is None:
577 msg = "Fit doesn't contain samples."
578 raise AttributeError(msg)
579
580 if dtypes is None:
581 dtypes = {}
582
583 dtypes = {**infer_dtypes(fit), **dtypes}
584
585 if variables is None:
586 variables = fit.sim["pars_oi"]
587 elif isinstance(variables, str):
588 variables = [variables]
589 variables = list(variables)
590
591 for var, dim in zip(fit.sim["pars_oi"], fit.sim["dims_oi"]):
592 if var in variables and np.prod(dim) == 0:
593 del variables[variables.index(var)]
594
595 ndraws_warmup = fit.sim["warmup2"]
596 if max(ndraws_warmup) == 0:
597 warmup = False
598 ndraws = [s - w for s, w in zip(fit.sim["n_save"], ndraws_warmup)]
599 nchain = len(fit.sim["samples"])
600
601 # check if the values are in 0-based (<=2.17) or 1-based indexing (>=2.18)
602 shift = 1
603 if any(dim and np.prod(dim) != 0 for dim in fit.sim["dims_oi"]):
604 # choose variable with lowest number of dims > 1
605 par_idx = min(
606 (dim, i) for i, dim in enumerate(fit.sim["dims_oi"]) if (dim and np.prod(dim) != 0)
607 )[1]
608 offset = int(sum(map(np.product, fit.sim["dims_oi"][:par_idx])))
609 par_offset = int(np.product(fit.sim["dims_oi"][par_idx]))
610 par_keys = fit.sim["fnames_oi"][offset : offset + par_offset]
611 shift = len(par_keys)
612 for item in par_keys:
613 _, shape = item.replace("]", "").split("[")
614 shape_idx_min = min(int(shape_value) for shape_value in shape.split(","))
615 if shape_idx_min < shift:
616 shift = shape_idx_min
617 # If shift is higher than 1, this will probably mean that Stan
618 # has implemented sparse structure (saves only non-zero parts),
619 # but let's hope that dims are still corresponding to the full shape
620 shift = int(min(shift, 1))
621
622 var_keys = OrderedDict((var, []) for var in fit.sim["pars_oi"])
623 for key in fit.sim["fnames_oi"]:
624 var, *tails = key.split("[")
625 loc = [Ellipsis]
626 for tail in tails:
627 loc = []
628 for i in tail[:-1].split(","):
629 loc.append(int(i) - shift)
630 var_keys[var].append((key, loc))
631
632 shapes = dict(zip(fit.sim["pars_oi"], fit.sim["dims_oi"]))
633
634 variables = [var for var in variables if var not in ignore]
635
636 data = OrderedDict()
637 data_warmup = OrderedDict()
638
639 for var in variables:
640 if var in data:
641 continue
642 keys_locs = var_keys.get(var, [(var, [Ellipsis])])
643 shape = shapes.get(var, [])
644 dtype = dtypes.get(var)
645
646 ndraw = max(ndraws)
647 ary_shape = [nchain, ndraw] + shape
648 ary = np.empty(ary_shape, dtype=dtype, order="F")
649
650 if warmup:
651 nwarmup = max(ndraws_warmup)
652 ary_warmup_shape = [nchain, nwarmup] + shape
653 ary_warmup = np.empty(ary_warmup_shape, dtype=dtype, order="F")
654
655 for chain, (pyholder, ndraw, ndraw_warmup) in enumerate(
656 zip(fit.sim["samples"], ndraws, ndraws_warmup)
657 ):
658 axes = [chain, slice(None)]
659 for key, loc in keys_locs:
660 ary_slice = tuple(axes + loc)
661 ary[ary_slice] = pyholder.chains[key][-ndraw:]
662 if warmup:
663 ary_warmup[ary_slice] = pyholder.chains[key][:ndraw_warmup]
664 data[var] = ary
665 if warmup:
666 data_warmup[var] = ary_warmup
667 return data, data_warmup
668
669
670 def get_sample_stats(fit, warmup=False, dtypes=None):
671 """Extract sample stats from PyStan fit."""
672 if dtypes is None:
673 dtypes = {}
674 dtypes = {"divergent__": bool, "n_leapfrog__": np.int64, "treedepth__": np.int64, **dtypes}
675
676 rename_dict = {
677 "divergent": "diverging",
678 "n_leapfrog": "n_steps",
679 "treedepth": "tree_depth",
680 "stepsize": "step_size",
681 "accept_stat": "acceptance_rate",
682 }
683
684 ndraws_warmup = fit.sim["warmup2"]
685 if max(ndraws_warmup) == 0:
686 warmup = False
687 ndraws = [s - w for s, w in zip(fit.sim["n_save"], ndraws_warmup)]
688
689 extraction = OrderedDict()
690 extraction_warmup = OrderedDict()
691 for chain, (pyholder, ndraw, ndraw_warmup) in enumerate(
692 zip(fit.sim["samples"], ndraws, ndraws_warmup)
693 ):
694 if chain == 0:
695 for key in pyholder["sampler_param_names"]:
696 extraction[key] = []
697 if warmup:
698 extraction_warmup[key] = []
699 for key, values in zip(pyholder["sampler_param_names"], pyholder["sampler_params"]):
700 extraction[key].append(values[-ndraw:])
701 if warmup:
702 extraction_warmup[key].append(values[:ndraw_warmup])
703
704 data = OrderedDict()
705 for key, values in extraction.items():
706 values = np.stack(values, axis=0)
707 dtype = dtypes.get(key)
708 values = values.astype(dtype)
709 name = re.sub("__$", "", key)
710 name = rename_dict.get(name, name)
711 data[name] = values
712
713 data_warmup = OrderedDict()
714 if warmup:
715 for key, values in extraction_warmup.items():
716 values = np.stack(values, axis=0)
717 values = values.astype(dtypes.get(key))
718 name = re.sub("__$", "", key)
719 name = rename_dict.get(name, name)
720 data_warmup[name] = values
721
722 return data, data_warmup
723
724
725 def get_attrs(fit):
726 """Get attributes from PyStan fit object."""
727 attrs = {}
728
729 try:
730 attrs["args"] = [deepcopy(holder.args) for holder in fit.sim["samples"]]
731 except Exception as exp: # pylint: disable=broad-except
732 _log.warning("Failed to fetch args from fit: %s", exp)
733 if "args" in attrs:
734 for arg in attrs["args"]:
735 if isinstance(arg["init"], bytes):
736 arg["init"] = arg["init"].decode("utf-8")
737 attrs["args"] = json.dumps(attrs["args"])
738 try:
739 attrs["inits"] = [holder.inits for holder in fit.sim["samples"]]
740 except Exception as exp: # pylint: disable=broad-except
741 _log.warning("Failed to fetch `args` from fit: %s", exp)
742 else:
743 attrs["inits"] = json.dumps(attrs["inits"])
744
745 attrs["step_size"] = []
746 attrs["metric"] = []
747 attrs["inv_metric"] = []
748 for holder in fit.sim["samples"]:
749 try:
750 step_size = float(
751 re.search(
752 r"step\s*size\s*=\s*([0-9]+.?[0-9]+)\s*",
753 holder.adaptation_info,
754 flags=re.IGNORECASE,
755 ).group(1)
756 )
757 except AttributeError:
758 step_size = np.nan
759 attrs["step_size"].append(step_size)
760
761 inv_metric_match = re.search(
762 r"mass matrix:\s*(.*)\s*$", holder.adaptation_info, flags=re.DOTALL
763 )
764 if inv_metric_match:
765 inv_metric_str = inv_metric_match.group(1)
766 if "Diagonal elements of inverse mass matrix" in holder.adaptation_info:
767 metric = "diag_e"
768 inv_metric = [float(item) for item in inv_metric_str.strip(" #\n").split(",")]
769 else:
770 metric = "dense_e"
771 inv_metric = [
772 list(map(float, item.split(",")))
773 for item in re.sub(r"#\s", "", inv_metric_str).splitlines()
774 ]
775 else:
776 metric = "unit_e"
777 inv_metric = None
778
779 attrs["metric"].append(metric)
780 attrs["inv_metric"].append(inv_metric)
781 attrs["inv_metric"] = json.dumps(attrs["inv_metric"])
782
783 if not attrs["step_size"]:
784 del attrs["step_size"]
785
786 attrs["adaptation_info"] = fit.get_adaptation_info()
787 attrs["stan_code"] = fit.get_stancode()
788
789 return attrs
790
791
792 def get_draws_stan3(fit, model=None, variables=None, ignore=None, dtypes=None):
793 """Extract draws from PyStan3 fit."""
794 if ignore is None:
795 ignore = []
796
797 if dtypes is None:
798 dtypes = {}
799
800 if model is not None:
801 dtypes = {**infer_dtypes(fit, model), **dtypes}
802
803 if variables is None:
804 variables = fit.param_names
805 elif isinstance(variables, str):
806 variables = [variables]
807 variables = list(variables)
808
809 data = OrderedDict()
810
811 for var in variables:
812 if var in data:
813 continue
814 dtype = dtypes.get(var)
815
816 # in future fix the correct number of draws if fit.save_warmup is True
817 new_shape = (*fit.dims[fit.param_names.index(var)], -1, fit.num_chains)
818 if 0 in new_shape:
819 continue
820 values = fit._draws[fit._parameter_indexes(var), :] # pylint: disable=protected-access
821 values = values.reshape(new_shape, order="F")
822 values = np.moveaxis(values, [-2, -1], [1, 0])
823 values = values.astype(dtype)
824 data[var] = values
825
826 return data
827
828
829 def get_sample_stats_stan3(fit, variables=None, ignore=None, dtypes=None):
830 """Extract sample stats from PyStan3 fit."""
831 if dtypes is None:
832 dtypes = {}
833 dtypes = {"divergent__": bool, "n_leapfrog__": np.int64, "treedepth__": np.int64, **dtypes}
834
835 rename_dict = {
836 "divergent": "diverging",
837 "n_leapfrog": "n_steps",
838 "treedepth": "tree_depth",
839 "stepsize": "step_size",
840 "accept_stat": "acceptance_rate",
841 }
842
843 if isinstance(variables, str):
844 variables = [variables]
845 if isinstance(ignore, str):
846 ignore = [ignore]
847
848 data = OrderedDict()
849 for key in fit.sample_and_sampler_param_names:
850 if (variables and key not in variables) or (ignore and key in ignore):
851 continue
852 new_shape = -1, fit.num_chains
853 values = fit._draws[fit._parameter_indexes(key)] # pylint: disable=protected-access
854 values = values.reshape(new_shape, order="F")
855 values = np.moveaxis(values, [-2, -1], [1, 0])
856 dtype = dtypes.get(key)
857 values = values.astype(dtype)
858 name = re.sub("__$", "", key)
859 name = rename_dict.get(name, name)
860 data[name] = values
861
862 return data
863
864
865 def get_attrs_stan3(fit, model=None):
866 """Get attributes from PyStan3 fit and model object."""
867 attrs = {}
868 for key in ["num_chains", "num_samples", "num_thin", "num_warmup", "save_warmup"]:
869 try:
870 attrs[key] = getattr(fit, key)
871 except AttributeError as exp:
872 _log.warning("Failed to access attribute %s in fit object %s", key, exp)
873
874 if model is not None:
875 for key in ["model_name", "program_code", "random_seed"]:
876 try:
877 attrs[key] = getattr(model, key)
878 except AttributeError as exp:
879 _log.warning("Failed to access attribute %s in model object %s", key, exp)
880
881 return attrs
882
883
884 def infer_dtypes(fit, model=None):
885 """Infer dtypes from Stan model code.
886
887 Function strips out generated quantities block and searches for `int`
888 dtypes after stripping out comments inside the block.
889 """
890 if model is None:
891 stan_code = fit.get_stancode()
892 model_pars = fit.model_pars
893 else:
894 stan_code = model.program_code
895 model_pars = fit.param_names
896
897 dtypes = {key: item for key, item in infer_stan_dtypes(stan_code).items() if key in model_pars}
898 return dtypes
899
900
901 # pylint disable=too-many-instance-attributes
902 def from_pystan(
903 posterior=None,
904 *,
905 posterior_predictive=None,
906 predictions=None,
907 prior=None,
908 prior_predictive=None,
909 observed_data=None,
910 constant_data=None,
911 predictions_constant_data=None,
912 log_likelihood=None,
913 coords=None,
914 dims=None,
915 posterior_model=None,
916 prior_model=None,
917 save_warmup=None,
918 dtypes=None,
919 ):
920 """Convert PyStan data into an InferenceData object.
921
922 For a usage example read the
923 :ref:`Creating InferenceData section on from_pystan <creating_InferenceData>`
924
925 Parameters
926 ----------
927 posterior : StanFit4Model or stan.fit.Fit
928 PyStan fit object for posterior.
929 posterior_predictive : str, a list of str
930 Posterior predictive samples for the posterior.
931 predictions : str, a list of str
932 Out-of-sample predictions for the posterior.
933 prior : StanFit4Model or stan.fit.Fit
934 PyStan fit object for prior.
935 prior_predictive : str, a list of str
936 Posterior predictive samples for the prior.
937 observed_data : str or a list of str
938 observed data used in the sampling.
939 Observed data is extracted from the `posterior.data`.
940 PyStan3 needs model object for the extraction.
941 See `posterior_model`.
942 constant_data : str or list of str
943 Constants relevant to the model (i.e. x values in a linear
944 regression).
945 predictions_constant_data : str or list of str
946 Constants relevant to the model predictions (i.e. new x values in a linear
947 regression).
948 log_likelihood : dict of {str: str}, list of str or str, optional
949 Pointwise log_likelihood for the data. log_likelihood is extracted from the
950 posterior. It is recommended to use this argument as a dictionary whose keys
951 are observed variable names and its values are the variables storing log
952 likelihood arrays in the Stan code. In other cases, a dictionary with keys
953 equal to its values is used. By default, if a variable ``log_lik`` is
954 present in the Stan model, it will be retrieved as pointwise log
955 likelihood values. Use ``False`` or set ``data.log_likelihood`` to
956 false to avoid this behaviour.
957 coords : dict[str, iterable]
958 A dictionary containing the values that are used as index. The key
959 is the name of the dimension, the values are the index values.
960 dims : dict[str, List(str)]
961 A mapping from variables to a list of coordinate names for the variable.
962 posterior_model : stan.model.Model
963 PyStan3 specific model object. Needed for automatic dtype parsing
964 and for the extraction of observed data.
965 prior_model : stan.model.Model
966 PyStan3 specific model object. Needed for automatic dtype parsing.
967 save_warmup : bool
968 Save warmup iterations into InferenceData object. If not defined, use default
969 defined by the rcParams. Not supported in PyStan3.
970 dtypes: dict
971 A dictionary containing dtype information (int, float) for parameters.
972 By default dtype information is extracted from the model code.
973 Model code is extracted from fit object in PyStan 2 and from model object
974 in PyStan 3.
975
976 Returns
977 -------
978 InferenceData object
979 """
980 check_posterior = (posterior is not None) and (type(posterior).__module__ == "stan.fit")
981 check_prior = (prior is not None) and (type(prior).__module__ == "stan.fit")
982 if check_posterior or check_prior:
983 if save_warmup:
984 warnings.warn(
985 "save_warmup is not currently supported for PyStan3",
986 UserWarning,
987 )
988 return PyStan3Converter(
989 posterior=posterior,
990 posterior_model=posterior_model,
991 posterior_predictive=posterior_predictive,
992 predictions=predictions,
993 prior=prior,
994 prior_model=prior_model,
995 prior_predictive=prior_predictive,
996 observed_data=observed_data,
997 constant_data=constant_data,
998 predictions_constant_data=predictions_constant_data,
999 log_likelihood=log_likelihood,
1000 coords=coords,
1001 dims=dims,
1002 dtypes=dtypes,
1003 ).to_inference_data()
1004 else:
1005 return PyStanConverter(
1006 posterior=posterior,
1007 posterior_predictive=posterior_predictive,
1008 predictions=predictions,
1009 prior=prior,
1010 prior_predictive=prior_predictive,
1011 observed_data=observed_data,
1012 constant_data=constant_data,
1013 predictions_constant_data=predictions_constant_data,
1014 log_likelihood=log_likelihood,
1015 coords=coords,
1016 dims=dims,
1017 save_warmup=save_warmup,
1018 dtypes=dtypes,
1019 ).to_inference_data()
1020
```
--- 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/data/io_pystan.py b/arviz/data/io_pystan.py
--- a/arviz/data/io_pystan.py
+++ b/arviz/data/io_pystan.py
@@ -809,6 +809,8 @@
data = OrderedDict()
for var in variables:
+ if var in ignore:
+ continue
if var in data:
continue
dtype = dtypes.get(var)
| {"golden_diff": "diff --git a/arviz/data/io_pystan.py b/arviz/data/io_pystan.py\n--- a/arviz/data/io_pystan.py\n+++ b/arviz/data/io_pystan.py\n@@ -809,6 +809,8 @@\n data = OrderedDict()\r\n \r\n for var in variables:\r\n+ if var in ignore:\r\n+ continue\r\n if var in data:\r\n continue\r\n dtype = dtypes.get(var)\n", "issue": "from_pystan puts log likelihood and posterior predictions in posterior data\n## Short Description\r\n\r\nI would like to convert a posterior sample from a PyStan `stan.fit.Fit` object to an `az.InferenceData` object, but the log likelihood and posterior prediction variables end up in the `posterior` section. (They also appear in their respective sections of the `InferenceData` object). I was wondering if there is a way to have them not be in the `posterior` section. This would make using them with other ArviZ functions much easier because then they will *not* be included in tables or plots of the *posterior distributions* such as `az.plot_trace(data)`.\r\n\r\n## Code Example or link\r\n\r\nThe example is from the PyStan section of the *Creating InferenceData* guide: https://arviz-devs.github.io/arviz/getting_started/CreatingInferenceData.html#from-pystan\r\n\r\n> Note that there are some changes to reflect changes in the PyStan API (such as importing `stan` instead of `pystan`.\r\n\r\n```python\r\nimport arviz as az\r\nimport numpy as np\r\nimport stan\r\n\r\nschools_code = \"\"\"\r\ndata {\r\n int<lower=0> J;\r\n real y[J];\r\n real<lower=0> sigma[J];\r\n}\r\n\r\nparameters {\r\n real mu;\r\n real<lower=0> tau;\r\n real theta_tilde[J];\r\n}\r\n\r\ntransformed parameters {\r\n real theta[J];\r\n for (j in 1:J)\r\n theta[j] = mu + tau * theta_tilde[j];\r\n}\r\n\r\nmodel {\r\n mu ~ normal(0, 5);\r\n tau ~ cauchy(0, 5);\r\n theta_tilde ~ normal(0, 1);\r\n y ~ normal(theta, sigma);\r\n}\r\n\r\ngenerated quantities {\r\n vector[J] log_lik;\r\n vector[J] y_hat;\r\n for (j in 1:J) {\r\n log_lik[j] = normal_lpdf(y[j] | theta[j], sigma[j]);\r\n y_hat[j] = normal_rng(theta[j], sigma[j]);\r\n }\r\n}\r\n\"\"\"\r\n\r\neight_school_data = {\r\n \"J\": 8,\r\n \"y\": np.array([28.0, 8.0, -3.0, 7.0, -1.0, 1.0, 18.0, 12.0]),\r\n \"sigma\": np.array([15.0, 10.0, 16.0, 11.0, 9.0, 11.0, 10.0, 18.0]),\r\n}\r\n\r\nstan_model = stan.build(schools_code, data=eight_school_data)\r\nfit = stan_model.sample()\r\n\r\nstan_data = az.from_pystan(\r\n posterior=fit,\r\n posterior_predictive=\"y_hat\",\r\n posterior_model= stan_model,\r\n observed_data=[\"y\"],\r\n log_likelihood={\"y\": \"log_lik\"},\r\n coords={\"school\": np.arange(eight_school_data[\"J\"])},\r\n dims={\r\n \"theta\": [\"school\"],\r\n \"y\": [\"school\"],\r\n \"log_lik\": [\"school\"],\r\n \"y_hat\": [\"school\"],\r\n \"theta_tilde\": [\"school\"],\r\n },\r\n)\r\n\r\nstan_data\r\n#> Inference data with groups:\r\n#> > posterior\r\n#> > posterior_predictive\r\n#> > log_likelihood\r\n#> > sample_stats\r\n\r\nstan_data.posterior\r\n#> <xarray.Dataset>\r\n#> Dimensions: (chain: 4, draw: 1000, school: 8)\r\n#> Coordinates:\r\n#> * chain (chain) int64 0 1 2 3\r\n#> * draw (draw) int64 0 1 2 3 4 5 6 7 ... 993 994 995 996 997 998 999\r\n#> * school (school) int64 0 1 2 3 4 5 6 7\r\n#> Data variables:\r\n#> mu (chain, draw) float64 5.583 13.74 -1.643 ... 7.135 1.818 2.276\r\n#> tau (chain, draw) float64 3.375 2.563 2.734 ... 1.585 0.2655 8.359\r\n#> theta_tilde (chain, draw, school) float64 0.9058 0.2812 ... 1.286 -0.5058\r\n#> theta (chain, draw, school) float64 8.64 6.531 6.381 ... 13.03 -1.952\r\n#> log_lik (chain, draw, school) float64 -4.46 -3.232 ... -3.345 -4.11\r\n#> y_hat (chain, draw, school) float64 -15.09 7.846 ... 19.34 8.089\r\n#> Attributes:\r\n#> created_at: 2022-01-13T22:30:54.799215\r\n#> arviz_version: 0.11.4\r\n#> inference_library: stan\r\n#> inference_library_version: 3.3.0\r\n#> num_chains: 4\r\n#> num_samples: 1000\r\n#> num_thin: 1\r\n#> num_warmup: 1000\r\n#> save_warmup: 0\r\n#> model_name: models/6kxc6kz6\r\n#> program_code: \\ndata {\\n int<lower=0> J;\\n real y[J];...\r\n#> random_seed: None\r\n```\r\n\r\nPyStan version: 3.3.0\r\nArviZ version: 0.11.4\r\n\r\n## Relevant documentation or public examples\r\n\r\n- Guide on creating InferenceData objects from PyStan: https://arviz-devs.github.io/arviz/getting_started/CreatingInferenceData.html#from-pystan\r\n- documentation for `from_pystan()`: https://arviz-devs.github.io/arviz/api/generated/arviz.from_pystan.html#arviz-from-pystan\n", "before_files": [{"content": "# pylint: disable=too-many-instance-attributes,too-many-lines\r\n\"\"\"PyStan-specific conversion code.\"\"\"\r\nimport re\r\nimport warnings\r\nfrom collections import OrderedDict\r\nfrom copy import deepcopy\r\n\r\nimport numpy as np\r\nimport xarray as xr\r\n\r\nfrom .. import _log\r\nfrom ..rcparams import rcParams\r\nfrom .base import dict_to_dataset, generate_dims_coords, infer_stan_dtypes, make_attrs, requires\r\nfrom .inference_data import InferenceData\r\n\r\ntry:\r\n import ujson as json\r\nexcept ImportError:\r\n # Can't find ujson using json\r\n # mypy struggles with conditional imports expressed as catching ImportError:\r\n # https://github.com/python/mypy/issues/1153\r\n import json # type: ignore\r\n\r\n\r\nclass PyStanConverter:\r\n \"\"\"Encapsulate PyStan specific logic.\"\"\"\r\n\r\n def __init__(\r\n self,\r\n *,\r\n posterior=None,\r\n posterior_predictive=None,\r\n predictions=None,\r\n prior=None,\r\n prior_predictive=None,\r\n observed_data=None,\r\n constant_data=None,\r\n predictions_constant_data=None,\r\n log_likelihood=None,\r\n coords=None,\r\n dims=None,\r\n save_warmup=None,\r\n dtypes=None,\r\n ):\r\n self.posterior = posterior\r\n self.posterior_predictive = posterior_predictive\r\n self.predictions = predictions\r\n self.prior = prior\r\n self.prior_predictive = prior_predictive\r\n self.observed_data = observed_data\r\n self.constant_data = constant_data\r\n self.predictions_constant_data = predictions_constant_data\r\n self.log_likelihood = (\r\n rcParams[\"data.log_likelihood\"] if log_likelihood is None else log_likelihood\r\n )\r\n self.coords = coords\r\n self.dims = dims\r\n self.save_warmup = rcParams[\"data.save_warmup\"] if save_warmup is None else save_warmup\r\n self.dtypes = dtypes\r\n\r\n if (\r\n self.log_likelihood is True\r\n and self.posterior is not None\r\n and \"log_lik\" in self.posterior.sim[\"pars_oi\"]\r\n ):\r\n self.log_likelihood = [\"log_lik\"]\r\n elif isinstance(self.log_likelihood, bool):\r\n self.log_likelihood = None\r\n\r\n import pystan # pylint: disable=import-error\r\n\r\n self.pystan = pystan\r\n\r\n @requires(\"posterior\")\r\n def posterior_to_xarray(self):\r\n \"\"\"Extract posterior samples from fit.\"\"\"\r\n posterior = self.posterior\r\n # filter posterior_predictive and log_likelihood\r\n posterior_predictive = self.posterior_predictive\r\n if posterior_predictive is None:\r\n posterior_predictive = []\r\n elif isinstance(posterior_predictive, str):\r\n posterior_predictive = [posterior_predictive]\r\n predictions = self.predictions\r\n if predictions is None:\r\n predictions = []\r\n elif isinstance(predictions, str):\r\n predictions = [predictions]\r\n log_likelihood = self.log_likelihood\r\n if log_likelihood is None:\r\n log_likelihood = []\r\n elif isinstance(log_likelihood, str):\r\n log_likelihood = [log_likelihood]\r\n elif isinstance(log_likelihood, dict):\r\n log_likelihood = list(log_likelihood.values())\r\n\r\n ignore = posterior_predictive + predictions + log_likelihood + [\"lp__\"]\r\n\r\n data, data_warmup = get_draws(\r\n posterior, ignore=ignore, warmup=self.save_warmup, dtypes=self.dtypes\r\n )\r\n attrs = get_attrs(posterior)\r\n return (\r\n dict_to_dataset(\r\n data, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims\r\n ),\r\n dict_to_dataset(\r\n data_warmup, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims\r\n ),\r\n )\r\n\r\n @requires(\"posterior\")\r\n def sample_stats_to_xarray(self):\r\n \"\"\"Extract sample_stats from posterior.\"\"\"\r\n posterior = self.posterior\r\n\r\n data, data_warmup = get_sample_stats(posterior, warmup=self.save_warmup)\r\n\r\n # lp__\r\n stat_lp, stat_lp_warmup = get_draws(\r\n posterior, variables=\"lp__\", warmup=self.save_warmup, dtypes=self.dtypes\r\n )\r\n data[\"lp\"] = stat_lp[\"lp__\"]\r\n if stat_lp_warmup:\r\n data_warmup[\"lp\"] = stat_lp_warmup[\"lp__\"]\r\n\r\n attrs = get_attrs(posterior)\r\n return (\r\n dict_to_dataset(\r\n data, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims\r\n ),\r\n dict_to_dataset(\r\n data_warmup, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims\r\n ),\r\n )\r\n\r\n @requires(\"posterior\")\r\n @requires(\"log_likelihood\")\r\n def log_likelihood_to_xarray(self):\r\n \"\"\"Store log_likelihood data in log_likelihood group.\"\"\"\r\n fit = self.posterior\r\n\r\n # log_likelihood values\r\n log_likelihood = self.log_likelihood\r\n if isinstance(log_likelihood, str):\r\n log_likelihood = [log_likelihood]\r\n if isinstance(log_likelihood, (list, tuple)):\r\n log_likelihood = {name: name for name in log_likelihood}\r\n log_likelihood_draws, log_likelihood_draws_warmup = get_draws(\r\n fit,\r\n variables=list(log_likelihood.values()),\r\n warmup=self.save_warmup,\r\n dtypes=self.dtypes,\r\n )\r\n data = {\r\n obs_var_name: log_likelihood_draws[log_like_name]\r\n for obs_var_name, log_like_name in log_likelihood.items()\r\n if log_like_name in log_likelihood_draws\r\n }\r\n\r\n data_warmup = {\r\n obs_var_name: log_likelihood_draws_warmup[log_like_name]\r\n for obs_var_name, log_like_name in log_likelihood.items()\r\n if log_like_name in log_likelihood_draws_warmup\r\n }\r\n\r\n return (\r\n dict_to_dataset(\r\n data, library=self.pystan, coords=self.coords, dims=self.dims, skip_event_dims=True\r\n ),\r\n dict_to_dataset(\r\n data_warmup,\r\n library=self.pystan,\r\n coords=self.coords,\r\n dims=self.dims,\r\n skip_event_dims=True,\r\n ),\r\n )\r\n\r\n @requires(\"posterior\")\r\n @requires(\"posterior_predictive\")\r\n def posterior_predictive_to_xarray(self):\r\n \"\"\"Convert posterior_predictive samples to xarray.\"\"\"\r\n posterior = self.posterior\r\n posterior_predictive = self.posterior_predictive\r\n data, data_warmup = get_draws(\r\n posterior, variables=posterior_predictive, warmup=self.save_warmup, dtypes=self.dtypes\r\n )\r\n return (\r\n dict_to_dataset(data, library=self.pystan, coords=self.coords, dims=self.dims),\r\n dict_to_dataset(data_warmup, library=self.pystan, coords=self.coords, dims=self.dims),\r\n )\r\n\r\n @requires(\"posterior\")\r\n @requires(\"predictions\")\r\n def predictions_to_xarray(self):\r\n \"\"\"Convert predictions samples to xarray.\"\"\"\r\n posterior = self.posterior\r\n predictions = self.predictions\r\n data, data_warmup = get_draws(\r\n posterior, variables=predictions, warmup=self.save_warmup, dtypes=self.dtypes\r\n )\r\n return (\r\n dict_to_dataset(data, library=self.pystan, coords=self.coords, dims=self.dims),\r\n dict_to_dataset(data_warmup, library=self.pystan, coords=self.coords, dims=self.dims),\r\n )\r\n\r\n @requires(\"prior\")\r\n def prior_to_xarray(self):\r\n \"\"\"Convert prior samples to xarray.\"\"\"\r\n prior = self.prior\r\n # filter posterior_predictive and log_likelihood\r\n prior_predictive = self.prior_predictive\r\n if prior_predictive is None:\r\n prior_predictive = []\r\n elif isinstance(prior_predictive, str):\r\n prior_predictive = [prior_predictive]\r\n\r\n ignore = prior_predictive + [\"lp__\"]\r\n\r\n data, _ = get_draws(prior, ignore=ignore, warmup=False, dtypes=self.dtypes)\r\n attrs = get_attrs(prior)\r\n return dict_to_dataset(\r\n data, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims\r\n )\r\n\r\n @requires(\"prior\")\r\n def sample_stats_prior_to_xarray(self):\r\n \"\"\"Extract sample_stats_prior from prior.\"\"\"\r\n prior = self.prior\r\n data, _ = get_sample_stats(prior, warmup=False)\r\n\r\n # lp__\r\n stat_lp, _ = get_draws(prior, variables=\"lp__\", warmup=False, dtypes=self.dtypes)\r\n data[\"lp\"] = stat_lp[\"lp__\"]\r\n\r\n attrs = get_attrs(prior)\r\n return dict_to_dataset(\r\n data, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims\r\n )\r\n\r\n @requires(\"prior\")\r\n @requires(\"prior_predictive\")\r\n def prior_predictive_to_xarray(self):\r\n \"\"\"Convert prior_predictive samples to xarray.\"\"\"\r\n prior = self.prior\r\n prior_predictive = self.prior_predictive\r\n data, _ = get_draws(prior, variables=prior_predictive, warmup=False, dtypes=self.dtypes)\r\n return dict_to_dataset(data, library=self.pystan, coords=self.coords, dims=self.dims)\r\n\r\n @requires(\"posterior\")\r\n @requires([\"observed_data\", \"constant_data\", \"predictions_constant_data\"])\r\n def data_to_xarray(self):\r\n \"\"\"Convert observed, constant data and predictions constant data to xarray.\"\"\"\r\n posterior = self.posterior\r\n if self.dims is None:\r\n dims = {}\r\n else:\r\n dims = self.dims\r\n obs_const_dict = {}\r\n for group_name in (\"observed_data\", \"constant_data\", \"predictions_constant_data\"):\r\n names = getattr(self, group_name)\r\n if names is None:\r\n continue\r\n names = [names] if isinstance(names, str) else names\r\n data = OrderedDict()\r\n for key in names:\r\n vals = np.atleast_1d(posterior.data[key])\r\n val_dims = dims.get(key)\r\n val_dims, coords = generate_dims_coords(\r\n vals.shape, key, dims=val_dims, coords=self.coords\r\n )\r\n data[key] = xr.DataArray(vals, dims=val_dims, coords=coords)\r\n obs_const_dict[group_name] = xr.Dataset(\r\n data_vars=data, attrs=make_attrs(library=self.pystan)\r\n )\r\n return obs_const_dict\r\n\r\n def to_inference_data(self):\r\n \"\"\"Convert all available data to an InferenceData object.\r\n\r\n Note that if groups can not be created (i.e., there is no `fit`, so\r\n the `posterior` and `sample_stats` can not be extracted), then the InferenceData\r\n will not have those groups.\r\n \"\"\"\r\n data_dict = self.data_to_xarray()\r\n return InferenceData(\r\n save_warmup=self.save_warmup,\r\n **{\r\n \"posterior\": self.posterior_to_xarray(),\r\n \"sample_stats\": self.sample_stats_to_xarray(),\r\n \"log_likelihood\": self.log_likelihood_to_xarray(),\r\n \"posterior_predictive\": self.posterior_predictive_to_xarray(),\r\n \"predictions\": self.predictions_to_xarray(),\r\n \"prior\": self.prior_to_xarray(),\r\n \"sample_stats_prior\": self.sample_stats_prior_to_xarray(),\r\n \"prior_predictive\": self.prior_predictive_to_xarray(),\r\n **({} if data_dict is None else data_dict),\r\n },\r\n )\r\n\r\n\r\nclass PyStan3Converter:\r\n \"\"\"Encapsulate PyStan3 specific logic.\"\"\"\r\n\r\n # pylint: disable=too-many-instance-attributes\r\n def __init__(\r\n self,\r\n *,\r\n posterior=None,\r\n posterior_model=None,\r\n posterior_predictive=None,\r\n predictions=None,\r\n prior=None,\r\n prior_model=None,\r\n prior_predictive=None,\r\n observed_data=None,\r\n constant_data=None,\r\n predictions_constant_data=None,\r\n log_likelihood=None,\r\n coords=None,\r\n dims=None,\r\n dtypes=None,\r\n ):\r\n self.posterior = posterior\r\n self.posterior_model = posterior_model\r\n self.posterior_predictive = posterior_predictive\r\n self.predictions = predictions\r\n self.prior = prior\r\n self.prior_model = prior_model\r\n self.prior_predictive = prior_predictive\r\n self.observed_data = observed_data\r\n self.constant_data = constant_data\r\n self.predictions_constant_data = predictions_constant_data\r\n self.log_likelihood = (\r\n rcParams[\"data.log_likelihood\"] if log_likelihood is None else log_likelihood\r\n )\r\n self.coords = coords\r\n self.dims = dims\r\n self.dtypes = dtypes\r\n\r\n if (\r\n self.log_likelihood is True\r\n and self.posterior is not None\r\n and \"log_lik\" in self.posterior.param_names\r\n ):\r\n self.log_likelihood = [\"log_lik\"]\r\n elif isinstance(self.log_likelihood, bool):\r\n self.log_likelihood = None\r\n\r\n import stan # pylint: disable=import-error\r\n\r\n self.stan = stan\r\n\r\n @requires(\"posterior\")\r\n def posterior_to_xarray(self):\r\n \"\"\"Extract posterior samples from fit.\"\"\"\r\n posterior = self.posterior\r\n posterior_model = self.posterior_model\r\n # filter posterior_predictive and log_likelihood\r\n posterior_predictive = self.posterior_predictive\r\n if posterior_predictive is None:\r\n posterior_predictive = []\r\n elif isinstance(posterior_predictive, str):\r\n posterior_predictive = [posterior_predictive]\r\n predictions = self.predictions\r\n if predictions is None:\r\n predictions = []\r\n elif isinstance(predictions, str):\r\n predictions = [predictions]\r\n log_likelihood = self.log_likelihood\r\n if log_likelihood is None:\r\n log_likelihood = []\r\n elif isinstance(log_likelihood, str):\r\n log_likelihood = [log_likelihood]\r\n elif isinstance(log_likelihood, dict):\r\n log_likelihood = list(log_likelihood.values())\r\n\r\n ignore = posterior_predictive + predictions + log_likelihood\r\n\r\n data = get_draws_stan3(posterior, model=posterior_model, ignore=ignore, dtypes=self.dtypes)\r\n attrs = get_attrs_stan3(posterior, model=posterior_model)\r\n return dict_to_dataset(\r\n data, library=self.stan, attrs=attrs, coords=self.coords, dims=self.dims\r\n )\r\n\r\n @requires(\"posterior\")\r\n def sample_stats_to_xarray(self):\r\n \"\"\"Extract sample_stats from posterior.\"\"\"\r\n posterior = self.posterior\r\n posterior_model = self.posterior_model\r\n data = get_sample_stats_stan3(posterior, ignore=\"lp__\", dtypes=self.dtypes)\r\n data[\"lp\"] = get_sample_stats_stan3(posterior, variables=\"lp__\")[\"lp\"]\r\n\r\n attrs = get_attrs_stan3(posterior, model=posterior_model)\r\n return dict_to_dataset(\r\n data, library=self.stan, attrs=attrs, coords=self.coords, dims=self.dims\r\n )\r\n\r\n @requires(\"posterior\")\r\n @requires(\"log_likelihood\")\r\n def log_likelihood_to_xarray(self):\r\n \"\"\"Store log_likelihood data in log_likelihood group.\"\"\"\r\n fit = self.posterior\r\n\r\n log_likelihood = self.log_likelihood\r\n model = self.posterior_model\r\n if isinstance(log_likelihood, str):\r\n log_likelihood = [log_likelihood]\r\n if isinstance(log_likelihood, (list, tuple)):\r\n log_likelihood = {name: name for name in log_likelihood}\r\n log_likelihood_draws = get_draws_stan3(\r\n fit, model=model, variables=list(log_likelihood.values()), dtypes=self.dtypes\r\n )\r\n data = {\r\n obs_var_name: log_likelihood_draws[log_like_name]\r\n for obs_var_name, log_like_name in log_likelihood.items()\r\n if log_like_name in log_likelihood_draws\r\n }\r\n\r\n return dict_to_dataset(data, library=self.stan, coords=self.coords, dims=self.dims)\r\n\r\n @requires(\"posterior\")\r\n @requires(\"posterior_predictive\")\r\n def posterior_predictive_to_xarray(self):\r\n \"\"\"Convert posterior_predictive samples to xarray.\"\"\"\r\n posterior = self.posterior\r\n posterior_model = self.posterior_model\r\n posterior_predictive = self.posterior_predictive\r\n data = get_draws_stan3(\r\n posterior, model=posterior_model, variables=posterior_predictive, dtypes=self.dtypes\r\n )\r\n return dict_to_dataset(data, library=self.stan, coords=self.coords, dims=self.dims)\r\n\r\n @requires(\"posterior\")\r\n @requires(\"predictions\")\r\n def predictions_to_xarray(self):\r\n \"\"\"Convert predictions samples to xarray.\"\"\"\r\n posterior = self.posterior\r\n posterior_model = self.posterior_model\r\n predictions = self.predictions\r\n data = get_draws_stan3(\r\n posterior, model=posterior_model, variables=predictions, dtypes=self.dtypes\r\n )\r\n return dict_to_dataset(data, library=self.stan, coords=self.coords, dims=self.dims)\r\n\r\n @requires(\"prior\")\r\n def prior_to_xarray(self):\r\n \"\"\"Convert prior samples to xarray.\"\"\"\r\n prior = self.prior\r\n prior_model = self.prior_model\r\n # filter posterior_predictive and log_likelihood\r\n prior_predictive = self.prior_predictive\r\n if prior_predictive is None:\r\n prior_predictive = []\r\n elif isinstance(prior_predictive, str):\r\n prior_predictive = [prior_predictive]\r\n\r\n ignore = prior_predictive\r\n\r\n data = get_draws_stan3(prior, model=prior_model, ignore=ignore, dtypes=self.dtypes)\r\n attrs = get_attrs_stan3(prior, model=prior_model)\r\n return dict_to_dataset(\r\n data, library=self.stan, attrs=attrs, coords=self.coords, dims=self.dims\r\n )\r\n\r\n @requires(\"prior\")\r\n def sample_stats_prior_to_xarray(self):\r\n \"\"\"Extract sample_stats_prior from prior.\"\"\"\r\n prior = self.prior\r\n prior_model = self.prior_model\r\n data = get_sample_stats_stan3(prior, dtypes=self.dtypes)\r\n attrs = get_attrs_stan3(prior, model=prior_model)\r\n return dict_to_dataset(\r\n data, library=self.stan, attrs=attrs, coords=self.coords, dims=self.dims\r\n )\r\n\r\n @requires(\"prior\")\r\n @requires(\"prior_predictive\")\r\n def prior_predictive_to_xarray(self):\r\n \"\"\"Convert prior_predictive samples to xarray.\"\"\"\r\n prior = self.prior\r\n prior_model = self.prior_model\r\n prior_predictive = self.prior_predictive\r\n data = get_draws_stan3(\r\n prior, model=prior_model, variables=prior_predictive, dtypes=self.dtypes\r\n )\r\n return dict_to_dataset(data, library=self.stan, coords=self.coords, dims=self.dims)\r\n\r\n @requires(\"posterior_model\")\r\n @requires([\"observed_data\", \"constant_data\"])\r\n def observed_and_constant_data_to_xarray(self):\r\n \"\"\"Convert observed data to xarray.\"\"\"\r\n posterior_model = self.posterior_model\r\n if self.dims is None:\r\n dims = {}\r\n else:\r\n dims = self.dims\r\n obs_const_dict = {}\r\n for group_name in (\"observed_data\", \"constant_data\"):\r\n names = getattr(self, group_name)\r\n if names is None:\r\n continue\r\n names = [names] if isinstance(names, str) else names\r\n data = OrderedDict()\r\n for key in names:\r\n vals = np.atleast_1d(posterior_model.data[key])\r\n val_dims = dims.get(key)\r\n val_dims, coords = generate_dims_coords(\r\n vals.shape, key, dims=val_dims, coords=self.coords\r\n )\r\n data[key] = xr.DataArray(vals, dims=val_dims, coords=coords)\r\n obs_const_dict[group_name] = xr.Dataset(\r\n data_vars=data, attrs=make_attrs(library=self.stan)\r\n )\r\n return obs_const_dict\r\n\r\n @requires(\"posterior_model\")\r\n @requires(\"predictions_constant_data\")\r\n def predictions_constant_data_to_xarray(self):\r\n \"\"\"Convert observed data to xarray.\"\"\"\r\n posterior_model = self.posterior_model\r\n if self.dims is None:\r\n dims = {}\r\n else:\r\n dims = self.dims\r\n names = self.predictions_constant_data\r\n names = [names] if isinstance(names, str) else names\r\n data = OrderedDict()\r\n for key in names:\r\n vals = np.atleast_1d(posterior_model.data[key])\r\n val_dims = dims.get(key)\r\n val_dims, coords = generate_dims_coords(\r\n vals.shape, key, dims=val_dims, coords=self.coords\r\n )\r\n data[key] = xr.DataArray(vals, dims=val_dims, coords=coords)\r\n return xr.Dataset(data_vars=data, attrs=make_attrs(library=self.stan))\r\n\r\n def to_inference_data(self):\r\n \"\"\"Convert all available data to an InferenceData object.\r\n\r\n Note that if groups can not be created (i.e., there is no `fit`, so\r\n the `posterior` and `sample_stats` can not be extracted), then the InferenceData\r\n will not have those groups.\r\n \"\"\"\r\n obs_const_dict = self.observed_and_constant_data_to_xarray()\r\n predictions_const_data = self.predictions_constant_data_to_xarray()\r\n return InferenceData(\r\n **{\r\n \"posterior\": self.posterior_to_xarray(),\r\n \"sample_stats\": self.sample_stats_to_xarray(),\r\n \"log_likelihood\": self.log_likelihood_to_xarray(),\r\n \"posterior_predictive\": self.posterior_predictive_to_xarray(),\r\n \"predictions\": self.predictions_to_xarray(),\r\n \"prior\": self.prior_to_xarray(),\r\n \"sample_stats_prior\": self.sample_stats_prior_to_xarray(),\r\n \"prior_predictive\": self.prior_predictive_to_xarray(),\r\n **({} if obs_const_dict is None else obs_const_dict),\r\n **(\r\n {}\r\n if predictions_const_data is None\r\n else {\"predictions_constant_data\": predictions_const_data}\r\n ),\r\n }\r\n )\r\n\r\n\r\ndef get_draws(fit, variables=None, ignore=None, warmup=False, dtypes=None):\r\n \"\"\"Extract draws from PyStan fit.\"\"\"\r\n if ignore is None:\r\n ignore = []\r\n if fit.mode == 1:\r\n msg = \"Model in mode 'test_grad'. Sampling is not conducted.\"\r\n raise AttributeError(msg)\r\n\r\n if fit.mode == 2 or fit.sim.get(\"samples\") is None:\r\n msg = \"Fit doesn't contain samples.\"\r\n raise AttributeError(msg)\r\n\r\n if dtypes is None:\r\n dtypes = {}\r\n\r\n dtypes = {**infer_dtypes(fit), **dtypes}\r\n\r\n if variables is None:\r\n variables = fit.sim[\"pars_oi\"]\r\n elif isinstance(variables, str):\r\n variables = [variables]\r\n variables = list(variables)\r\n\r\n for var, dim in zip(fit.sim[\"pars_oi\"], fit.sim[\"dims_oi\"]):\r\n if var in variables and np.prod(dim) == 0:\r\n del variables[variables.index(var)]\r\n\r\n ndraws_warmup = fit.sim[\"warmup2\"]\r\n if max(ndraws_warmup) == 0:\r\n warmup = False\r\n ndraws = [s - w for s, w in zip(fit.sim[\"n_save\"], ndraws_warmup)]\r\n nchain = len(fit.sim[\"samples\"])\r\n\r\n # check if the values are in 0-based (<=2.17) or 1-based indexing (>=2.18)\r\n shift = 1\r\n if any(dim and np.prod(dim) != 0 for dim in fit.sim[\"dims_oi\"]):\r\n # choose variable with lowest number of dims > 1\r\n par_idx = min(\r\n (dim, i) for i, dim in enumerate(fit.sim[\"dims_oi\"]) if (dim and np.prod(dim) != 0)\r\n )[1]\r\n offset = int(sum(map(np.product, fit.sim[\"dims_oi\"][:par_idx])))\r\n par_offset = int(np.product(fit.sim[\"dims_oi\"][par_idx]))\r\n par_keys = fit.sim[\"fnames_oi\"][offset : offset + par_offset]\r\n shift = len(par_keys)\r\n for item in par_keys:\r\n _, shape = item.replace(\"]\", \"\").split(\"[\")\r\n shape_idx_min = min(int(shape_value) for shape_value in shape.split(\",\"))\r\n if shape_idx_min < shift:\r\n shift = shape_idx_min\r\n # If shift is higher than 1, this will probably mean that Stan\r\n # has implemented sparse structure (saves only non-zero parts),\r\n # but let's hope that dims are still corresponding to the full shape\r\n shift = int(min(shift, 1))\r\n\r\n var_keys = OrderedDict((var, []) for var in fit.sim[\"pars_oi\"])\r\n for key in fit.sim[\"fnames_oi\"]:\r\n var, *tails = key.split(\"[\")\r\n loc = [Ellipsis]\r\n for tail in tails:\r\n loc = []\r\n for i in tail[:-1].split(\",\"):\r\n loc.append(int(i) - shift)\r\n var_keys[var].append((key, loc))\r\n\r\n shapes = dict(zip(fit.sim[\"pars_oi\"], fit.sim[\"dims_oi\"]))\r\n\r\n variables = [var for var in variables if var not in ignore]\r\n\r\n data = OrderedDict()\r\n data_warmup = OrderedDict()\r\n\r\n for var in variables:\r\n if var in data:\r\n continue\r\n keys_locs = var_keys.get(var, [(var, [Ellipsis])])\r\n shape = shapes.get(var, [])\r\n dtype = dtypes.get(var)\r\n\r\n ndraw = max(ndraws)\r\n ary_shape = [nchain, ndraw] + shape\r\n ary = np.empty(ary_shape, dtype=dtype, order=\"F\")\r\n\r\n if warmup:\r\n nwarmup = max(ndraws_warmup)\r\n ary_warmup_shape = [nchain, nwarmup] + shape\r\n ary_warmup = np.empty(ary_warmup_shape, dtype=dtype, order=\"F\")\r\n\r\n for chain, (pyholder, ndraw, ndraw_warmup) in enumerate(\r\n zip(fit.sim[\"samples\"], ndraws, ndraws_warmup)\r\n ):\r\n axes = [chain, slice(None)]\r\n for key, loc in keys_locs:\r\n ary_slice = tuple(axes + loc)\r\n ary[ary_slice] = pyholder.chains[key][-ndraw:]\r\n if warmup:\r\n ary_warmup[ary_slice] = pyholder.chains[key][:ndraw_warmup]\r\n data[var] = ary\r\n if warmup:\r\n data_warmup[var] = ary_warmup\r\n return data, data_warmup\r\n\r\n\r\ndef get_sample_stats(fit, warmup=False, dtypes=None):\r\n \"\"\"Extract sample stats from PyStan fit.\"\"\"\r\n if dtypes is None:\r\n dtypes = {}\r\n dtypes = {\"divergent__\": bool, \"n_leapfrog__\": np.int64, \"treedepth__\": np.int64, **dtypes}\r\n\r\n rename_dict = {\r\n \"divergent\": \"diverging\",\r\n \"n_leapfrog\": \"n_steps\",\r\n \"treedepth\": \"tree_depth\",\r\n \"stepsize\": \"step_size\",\r\n \"accept_stat\": \"acceptance_rate\",\r\n }\r\n\r\n ndraws_warmup = fit.sim[\"warmup2\"]\r\n if max(ndraws_warmup) == 0:\r\n warmup = False\r\n ndraws = [s - w for s, w in zip(fit.sim[\"n_save\"], ndraws_warmup)]\r\n\r\n extraction = OrderedDict()\r\n extraction_warmup = OrderedDict()\r\n for chain, (pyholder, ndraw, ndraw_warmup) in enumerate(\r\n zip(fit.sim[\"samples\"], ndraws, ndraws_warmup)\r\n ):\r\n if chain == 0:\r\n for key in pyholder[\"sampler_param_names\"]:\r\n extraction[key] = []\r\n if warmup:\r\n extraction_warmup[key] = []\r\n for key, values in zip(pyholder[\"sampler_param_names\"], pyholder[\"sampler_params\"]):\r\n extraction[key].append(values[-ndraw:])\r\n if warmup:\r\n extraction_warmup[key].append(values[:ndraw_warmup])\r\n\r\n data = OrderedDict()\r\n for key, values in extraction.items():\r\n values = np.stack(values, axis=0)\r\n dtype = dtypes.get(key)\r\n values = values.astype(dtype)\r\n name = re.sub(\"__$\", \"\", key)\r\n name = rename_dict.get(name, name)\r\n data[name] = values\r\n\r\n data_warmup = OrderedDict()\r\n if warmup:\r\n for key, values in extraction_warmup.items():\r\n values = np.stack(values, axis=0)\r\n values = values.astype(dtypes.get(key))\r\n name = re.sub(\"__$\", \"\", key)\r\n name = rename_dict.get(name, name)\r\n data_warmup[name] = values\r\n\r\n return data, data_warmup\r\n\r\n\r\ndef get_attrs(fit):\r\n \"\"\"Get attributes from PyStan fit object.\"\"\"\r\n attrs = {}\r\n\r\n try:\r\n attrs[\"args\"] = [deepcopy(holder.args) for holder in fit.sim[\"samples\"]]\r\n except Exception as exp: # pylint: disable=broad-except\r\n _log.warning(\"Failed to fetch args from fit: %s\", exp)\r\n if \"args\" in attrs:\r\n for arg in attrs[\"args\"]:\r\n if isinstance(arg[\"init\"], bytes):\r\n arg[\"init\"] = arg[\"init\"].decode(\"utf-8\")\r\n attrs[\"args\"] = json.dumps(attrs[\"args\"])\r\n try:\r\n attrs[\"inits\"] = [holder.inits for holder in fit.sim[\"samples\"]]\r\n except Exception as exp: # pylint: disable=broad-except\r\n _log.warning(\"Failed to fetch `args` from fit: %s\", exp)\r\n else:\r\n attrs[\"inits\"] = json.dumps(attrs[\"inits\"])\r\n\r\n attrs[\"step_size\"] = []\r\n attrs[\"metric\"] = []\r\n attrs[\"inv_metric\"] = []\r\n for holder in fit.sim[\"samples\"]:\r\n try:\r\n step_size = float(\r\n re.search(\r\n r\"step\\s*size\\s*=\\s*([0-9]+.?[0-9]+)\\s*\",\r\n holder.adaptation_info,\r\n flags=re.IGNORECASE,\r\n ).group(1)\r\n )\r\n except AttributeError:\r\n step_size = np.nan\r\n attrs[\"step_size\"].append(step_size)\r\n\r\n inv_metric_match = re.search(\r\n r\"mass matrix:\\s*(.*)\\s*$\", holder.adaptation_info, flags=re.DOTALL\r\n )\r\n if inv_metric_match:\r\n inv_metric_str = inv_metric_match.group(1)\r\n if \"Diagonal elements of inverse mass matrix\" in holder.adaptation_info:\r\n metric = \"diag_e\"\r\n inv_metric = [float(item) for item in inv_metric_str.strip(\" #\\n\").split(\",\")]\r\n else:\r\n metric = \"dense_e\"\r\n inv_metric = [\r\n list(map(float, item.split(\",\")))\r\n for item in re.sub(r\"#\\s\", \"\", inv_metric_str).splitlines()\r\n ]\r\n else:\r\n metric = \"unit_e\"\r\n inv_metric = None\r\n\r\n attrs[\"metric\"].append(metric)\r\n attrs[\"inv_metric\"].append(inv_metric)\r\n attrs[\"inv_metric\"] = json.dumps(attrs[\"inv_metric\"])\r\n\r\n if not attrs[\"step_size\"]:\r\n del attrs[\"step_size\"]\r\n\r\n attrs[\"adaptation_info\"] = fit.get_adaptation_info()\r\n attrs[\"stan_code\"] = fit.get_stancode()\r\n\r\n return attrs\r\n\r\n\r\ndef get_draws_stan3(fit, model=None, variables=None, ignore=None, dtypes=None):\r\n \"\"\"Extract draws from PyStan3 fit.\"\"\"\r\n if ignore is None:\r\n ignore = []\r\n\r\n if dtypes is None:\r\n dtypes = {}\r\n\r\n if model is not None:\r\n dtypes = {**infer_dtypes(fit, model), **dtypes}\r\n\r\n if variables is None:\r\n variables = fit.param_names\r\n elif isinstance(variables, str):\r\n variables = [variables]\r\n variables = list(variables)\r\n\r\n data = OrderedDict()\r\n\r\n for var in variables:\r\n if var in data:\r\n continue\r\n dtype = dtypes.get(var)\r\n\r\n # in future fix the correct number of draws if fit.save_warmup is True\r\n new_shape = (*fit.dims[fit.param_names.index(var)], -1, fit.num_chains)\r\n if 0 in new_shape:\r\n continue\r\n values = fit._draws[fit._parameter_indexes(var), :] # pylint: disable=protected-access\r\n values = values.reshape(new_shape, order=\"F\")\r\n values = np.moveaxis(values, [-2, -1], [1, 0])\r\n values = values.astype(dtype)\r\n data[var] = values\r\n\r\n return data\r\n\r\n\r\ndef get_sample_stats_stan3(fit, variables=None, ignore=None, dtypes=None):\r\n \"\"\"Extract sample stats from PyStan3 fit.\"\"\"\r\n if dtypes is None:\r\n dtypes = {}\r\n dtypes = {\"divergent__\": bool, \"n_leapfrog__\": np.int64, \"treedepth__\": np.int64, **dtypes}\r\n\r\n rename_dict = {\r\n \"divergent\": \"diverging\",\r\n \"n_leapfrog\": \"n_steps\",\r\n \"treedepth\": \"tree_depth\",\r\n \"stepsize\": \"step_size\",\r\n \"accept_stat\": \"acceptance_rate\",\r\n }\r\n\r\n if isinstance(variables, str):\r\n variables = [variables]\r\n if isinstance(ignore, str):\r\n ignore = [ignore]\r\n\r\n data = OrderedDict()\r\n for key in fit.sample_and_sampler_param_names:\r\n if (variables and key not in variables) or (ignore and key in ignore):\r\n continue\r\n new_shape = -1, fit.num_chains\r\n values = fit._draws[fit._parameter_indexes(key)] # pylint: disable=protected-access\r\n values = values.reshape(new_shape, order=\"F\")\r\n values = np.moveaxis(values, [-2, -1], [1, 0])\r\n dtype = dtypes.get(key)\r\n values = values.astype(dtype)\r\n name = re.sub(\"__$\", \"\", key)\r\n name = rename_dict.get(name, name)\r\n data[name] = values\r\n\r\n return data\r\n\r\n\r\ndef get_attrs_stan3(fit, model=None):\r\n \"\"\"Get attributes from PyStan3 fit and model object.\"\"\"\r\n attrs = {}\r\n for key in [\"num_chains\", \"num_samples\", \"num_thin\", \"num_warmup\", \"save_warmup\"]:\r\n try:\r\n attrs[key] = getattr(fit, key)\r\n except AttributeError as exp:\r\n _log.warning(\"Failed to access attribute %s in fit object %s\", key, exp)\r\n\r\n if model is not None:\r\n for key in [\"model_name\", \"program_code\", \"random_seed\"]:\r\n try:\r\n attrs[key] = getattr(model, key)\r\n except AttributeError as exp:\r\n _log.warning(\"Failed to access attribute %s in model object %s\", key, exp)\r\n\r\n return attrs\r\n\r\n\r\ndef infer_dtypes(fit, model=None):\r\n \"\"\"Infer dtypes from Stan model code.\r\n\r\n Function strips out generated quantities block and searches for `int`\r\n dtypes after stripping out comments inside the block.\r\n \"\"\"\r\n if model is None:\r\n stan_code = fit.get_stancode()\r\n model_pars = fit.model_pars\r\n else:\r\n stan_code = model.program_code\r\n model_pars = fit.param_names\r\n\r\n dtypes = {key: item for key, item in infer_stan_dtypes(stan_code).items() if key in model_pars}\r\n return dtypes\r\n\r\n\r\n# pylint disable=too-many-instance-attributes\r\ndef from_pystan(\r\n posterior=None,\r\n *,\r\n posterior_predictive=None,\r\n predictions=None,\r\n prior=None,\r\n prior_predictive=None,\r\n observed_data=None,\r\n constant_data=None,\r\n predictions_constant_data=None,\r\n log_likelihood=None,\r\n coords=None,\r\n dims=None,\r\n posterior_model=None,\r\n prior_model=None,\r\n save_warmup=None,\r\n dtypes=None,\r\n):\r\n \"\"\"Convert PyStan data into an InferenceData object.\r\n\r\n For a usage example read the\r\n :ref:`Creating InferenceData section on from_pystan <creating_InferenceData>`\r\n\r\n Parameters\r\n ----------\r\n posterior : StanFit4Model or stan.fit.Fit\r\n PyStan fit object for posterior.\r\n posterior_predictive : str, a list of str\r\n Posterior predictive samples for the posterior.\r\n predictions : str, a list of str\r\n Out-of-sample predictions for the posterior.\r\n prior : StanFit4Model or stan.fit.Fit\r\n PyStan fit object for prior.\r\n prior_predictive : str, a list of str\r\n Posterior predictive samples for the prior.\r\n observed_data : str or a list of str\r\n observed data used in the sampling.\r\n Observed data is extracted from the `posterior.data`.\r\n PyStan3 needs model object for the extraction.\r\n See `posterior_model`.\r\n constant_data : str or list of str\r\n Constants relevant to the model (i.e. x values in a linear\r\n regression).\r\n predictions_constant_data : str or list of str\r\n Constants relevant to the model predictions (i.e. new x values in a linear\r\n regression).\r\n log_likelihood : dict of {str: str}, list of str or str, optional\r\n Pointwise log_likelihood for the data. log_likelihood is extracted from the\r\n posterior. It is recommended to use this argument as a dictionary whose keys\r\n are observed variable names and its values are the variables storing log\r\n likelihood arrays in the Stan code. In other cases, a dictionary with keys\r\n equal to its values is used. By default, if a variable ``log_lik`` is\r\n present in the Stan model, it will be retrieved as pointwise log\r\n likelihood values. Use ``False`` or set ``data.log_likelihood`` to\r\n false to avoid this behaviour.\r\n coords : dict[str, iterable]\r\n A dictionary containing the values that are used as index. The key\r\n is the name of the dimension, the values are the index values.\r\n dims : dict[str, List(str)]\r\n A mapping from variables to a list of coordinate names for the variable.\r\n posterior_model : stan.model.Model\r\n PyStan3 specific model object. Needed for automatic dtype parsing\r\n and for the extraction of observed data.\r\n prior_model : stan.model.Model\r\n PyStan3 specific model object. Needed for automatic dtype parsing.\r\n save_warmup : bool\r\n Save warmup iterations into InferenceData object. If not defined, use default\r\n defined by the rcParams. Not supported in PyStan3.\r\n dtypes: dict\r\n A dictionary containing dtype information (int, float) for parameters.\r\n By default dtype information is extracted from the model code.\r\n Model code is extracted from fit object in PyStan 2 and from model object\r\n in PyStan 3.\r\n\r\n Returns\r\n -------\r\n InferenceData object\r\n \"\"\"\r\n check_posterior = (posterior is not None) and (type(posterior).__module__ == \"stan.fit\")\r\n check_prior = (prior is not None) and (type(prior).__module__ == \"stan.fit\")\r\n if check_posterior or check_prior:\r\n if save_warmup:\r\n warnings.warn(\r\n \"save_warmup is not currently supported for PyStan3\",\r\n UserWarning,\r\n )\r\n return PyStan3Converter(\r\n posterior=posterior,\r\n posterior_model=posterior_model,\r\n posterior_predictive=posterior_predictive,\r\n predictions=predictions,\r\n prior=prior,\r\n prior_model=prior_model,\r\n prior_predictive=prior_predictive,\r\n observed_data=observed_data,\r\n constant_data=constant_data,\r\n predictions_constant_data=predictions_constant_data,\r\n log_likelihood=log_likelihood,\r\n coords=coords,\r\n dims=dims,\r\n dtypes=dtypes,\r\n ).to_inference_data()\r\n else:\r\n return PyStanConverter(\r\n posterior=posterior,\r\n posterior_predictive=posterior_predictive,\r\n predictions=predictions,\r\n prior=prior,\r\n prior_predictive=prior_predictive,\r\n observed_data=observed_data,\r\n constant_data=constant_data,\r\n predictions_constant_data=predictions_constant_data,\r\n log_likelihood=log_likelihood,\r\n coords=coords,\r\n dims=dims,\r\n save_warmup=save_warmup,\r\n dtypes=dtypes,\r\n ).to_inference_data()\r\n", "path": "arviz/data/io_pystan.py"}], "after_files": [{"content": "# pylint: disable=too-many-instance-attributes,too-many-lines\r\n\"\"\"PyStan-specific conversion code.\"\"\"\r\nimport re\r\nimport warnings\r\nfrom collections import OrderedDict\r\nfrom copy import deepcopy\r\n\r\nimport numpy as np\r\nimport xarray as xr\r\n\r\nfrom .. import _log\r\nfrom ..rcparams import rcParams\r\nfrom .base import dict_to_dataset, generate_dims_coords, infer_stan_dtypes, make_attrs, requires\r\nfrom .inference_data import InferenceData\r\n\r\ntry:\r\n import ujson as json\r\nexcept ImportError:\r\n # Can't find ujson using json\r\n # mypy struggles with conditional imports expressed as catching ImportError:\r\n # https://github.com/python/mypy/issues/1153\r\n import json # type: ignore\r\n\r\n\r\nclass PyStanConverter:\r\n \"\"\"Encapsulate PyStan specific logic.\"\"\"\r\n\r\n def __init__(\r\n self,\r\n *,\r\n posterior=None,\r\n posterior_predictive=None,\r\n predictions=None,\r\n prior=None,\r\n prior_predictive=None,\r\n observed_data=None,\r\n constant_data=None,\r\n predictions_constant_data=None,\r\n log_likelihood=None,\r\n coords=None,\r\n dims=None,\r\n save_warmup=None,\r\n dtypes=None,\r\n ):\r\n self.posterior = posterior\r\n self.posterior_predictive = posterior_predictive\r\n self.predictions = predictions\r\n self.prior = prior\r\n self.prior_predictive = prior_predictive\r\n self.observed_data = observed_data\r\n self.constant_data = constant_data\r\n self.predictions_constant_data = predictions_constant_data\r\n self.log_likelihood = (\r\n rcParams[\"data.log_likelihood\"] if log_likelihood is None else log_likelihood\r\n )\r\n self.coords = coords\r\n self.dims = dims\r\n self.save_warmup = rcParams[\"data.save_warmup\"] if save_warmup is None else save_warmup\r\n self.dtypes = dtypes\r\n\r\n if (\r\n self.log_likelihood is True\r\n and self.posterior is not None\r\n and \"log_lik\" in self.posterior.sim[\"pars_oi\"]\r\n ):\r\n self.log_likelihood = [\"log_lik\"]\r\n elif isinstance(self.log_likelihood, bool):\r\n self.log_likelihood = None\r\n\r\n import pystan # pylint: disable=import-error\r\n\r\n self.pystan = pystan\r\n\r\n @requires(\"posterior\")\r\n def posterior_to_xarray(self):\r\n \"\"\"Extract posterior samples from fit.\"\"\"\r\n posterior = self.posterior\r\n # filter posterior_predictive and log_likelihood\r\n posterior_predictive = self.posterior_predictive\r\n if posterior_predictive is None:\r\n posterior_predictive = []\r\n elif isinstance(posterior_predictive, str):\r\n posterior_predictive = [posterior_predictive]\r\n predictions = self.predictions\r\n if predictions is None:\r\n predictions = []\r\n elif isinstance(predictions, str):\r\n predictions = [predictions]\r\n log_likelihood = self.log_likelihood\r\n if log_likelihood is None:\r\n log_likelihood = []\r\n elif isinstance(log_likelihood, str):\r\n log_likelihood = [log_likelihood]\r\n elif isinstance(log_likelihood, dict):\r\n log_likelihood = list(log_likelihood.values())\r\n\r\n ignore = posterior_predictive + predictions + log_likelihood + [\"lp__\"]\r\n\r\n data, data_warmup = get_draws(\r\n posterior, ignore=ignore, warmup=self.save_warmup, dtypes=self.dtypes\r\n )\r\n attrs = get_attrs(posterior)\r\n return (\r\n dict_to_dataset(\r\n data, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims\r\n ),\r\n dict_to_dataset(\r\n data_warmup, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims\r\n ),\r\n )\r\n\r\n @requires(\"posterior\")\r\n def sample_stats_to_xarray(self):\r\n \"\"\"Extract sample_stats from posterior.\"\"\"\r\n posterior = self.posterior\r\n\r\n data, data_warmup = get_sample_stats(posterior, warmup=self.save_warmup)\r\n\r\n # lp__\r\n stat_lp, stat_lp_warmup = get_draws(\r\n posterior, variables=\"lp__\", warmup=self.save_warmup, dtypes=self.dtypes\r\n )\r\n data[\"lp\"] = stat_lp[\"lp__\"]\r\n if stat_lp_warmup:\r\n data_warmup[\"lp\"] = stat_lp_warmup[\"lp__\"]\r\n\r\n attrs = get_attrs(posterior)\r\n return (\r\n dict_to_dataset(\r\n data, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims\r\n ),\r\n dict_to_dataset(\r\n data_warmup, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims\r\n ),\r\n )\r\n\r\n @requires(\"posterior\")\r\n @requires(\"log_likelihood\")\r\n def log_likelihood_to_xarray(self):\r\n \"\"\"Store log_likelihood data in log_likelihood group.\"\"\"\r\n fit = self.posterior\r\n\r\n # log_likelihood values\r\n log_likelihood = self.log_likelihood\r\n if isinstance(log_likelihood, str):\r\n log_likelihood = [log_likelihood]\r\n if isinstance(log_likelihood, (list, tuple)):\r\n log_likelihood = {name: name for name in log_likelihood}\r\n log_likelihood_draws, log_likelihood_draws_warmup = get_draws(\r\n fit,\r\n variables=list(log_likelihood.values()),\r\n warmup=self.save_warmup,\r\n dtypes=self.dtypes,\r\n )\r\n data = {\r\n obs_var_name: log_likelihood_draws[log_like_name]\r\n for obs_var_name, log_like_name in log_likelihood.items()\r\n if log_like_name in log_likelihood_draws\r\n }\r\n\r\n data_warmup = {\r\n obs_var_name: log_likelihood_draws_warmup[log_like_name]\r\n for obs_var_name, log_like_name in log_likelihood.items()\r\n if log_like_name in log_likelihood_draws_warmup\r\n }\r\n\r\n return (\r\n dict_to_dataset(\r\n data, library=self.pystan, coords=self.coords, dims=self.dims, skip_event_dims=True\r\n ),\r\n dict_to_dataset(\r\n data_warmup,\r\n library=self.pystan,\r\n coords=self.coords,\r\n dims=self.dims,\r\n skip_event_dims=True,\r\n ),\r\n )\r\n\r\n @requires(\"posterior\")\r\n @requires(\"posterior_predictive\")\r\n def posterior_predictive_to_xarray(self):\r\n \"\"\"Convert posterior_predictive samples to xarray.\"\"\"\r\n posterior = self.posterior\r\n posterior_predictive = self.posterior_predictive\r\n data, data_warmup = get_draws(\r\n posterior, variables=posterior_predictive, warmup=self.save_warmup, dtypes=self.dtypes\r\n )\r\n return (\r\n dict_to_dataset(data, library=self.pystan, coords=self.coords, dims=self.dims),\r\n dict_to_dataset(data_warmup, library=self.pystan, coords=self.coords, dims=self.dims),\r\n )\r\n\r\n @requires(\"posterior\")\r\n @requires(\"predictions\")\r\n def predictions_to_xarray(self):\r\n \"\"\"Convert predictions samples to xarray.\"\"\"\r\n posterior = self.posterior\r\n predictions = self.predictions\r\n data, data_warmup = get_draws(\r\n posterior, variables=predictions, warmup=self.save_warmup, dtypes=self.dtypes\r\n )\r\n return (\r\n dict_to_dataset(data, library=self.pystan, coords=self.coords, dims=self.dims),\r\n dict_to_dataset(data_warmup, library=self.pystan, coords=self.coords, dims=self.dims),\r\n )\r\n\r\n @requires(\"prior\")\r\n def prior_to_xarray(self):\r\n \"\"\"Convert prior samples to xarray.\"\"\"\r\n prior = self.prior\r\n # filter posterior_predictive and log_likelihood\r\n prior_predictive = self.prior_predictive\r\n if prior_predictive is None:\r\n prior_predictive = []\r\n elif isinstance(prior_predictive, str):\r\n prior_predictive = [prior_predictive]\r\n\r\n ignore = prior_predictive + [\"lp__\"]\r\n\r\n data, _ = get_draws(prior, ignore=ignore, warmup=False, dtypes=self.dtypes)\r\n attrs = get_attrs(prior)\r\n return dict_to_dataset(\r\n data, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims\r\n )\r\n\r\n @requires(\"prior\")\r\n def sample_stats_prior_to_xarray(self):\r\n \"\"\"Extract sample_stats_prior from prior.\"\"\"\r\n prior = self.prior\r\n data, _ = get_sample_stats(prior, warmup=False)\r\n\r\n # lp__\r\n stat_lp, _ = get_draws(prior, variables=\"lp__\", warmup=False, dtypes=self.dtypes)\r\n data[\"lp\"] = stat_lp[\"lp__\"]\r\n\r\n attrs = get_attrs(prior)\r\n return dict_to_dataset(\r\n data, library=self.pystan, attrs=attrs, coords=self.coords, dims=self.dims\r\n )\r\n\r\n @requires(\"prior\")\r\n @requires(\"prior_predictive\")\r\n def prior_predictive_to_xarray(self):\r\n \"\"\"Convert prior_predictive samples to xarray.\"\"\"\r\n prior = self.prior\r\n prior_predictive = self.prior_predictive\r\n data, _ = get_draws(prior, variables=prior_predictive, warmup=False, dtypes=self.dtypes)\r\n return dict_to_dataset(data, library=self.pystan, coords=self.coords, dims=self.dims)\r\n\r\n @requires(\"posterior\")\r\n @requires([\"observed_data\", \"constant_data\", \"predictions_constant_data\"])\r\n def data_to_xarray(self):\r\n \"\"\"Convert observed, constant data and predictions constant data to xarray.\"\"\"\r\n posterior = self.posterior\r\n if self.dims is None:\r\n dims = {}\r\n else:\r\n dims = self.dims\r\n obs_const_dict = {}\r\n for group_name in (\"observed_data\", \"constant_data\", \"predictions_constant_data\"):\r\n names = getattr(self, group_name)\r\n if names is None:\r\n continue\r\n names = [names] if isinstance(names, str) else names\r\n data = OrderedDict()\r\n for key in names:\r\n vals = np.atleast_1d(posterior.data[key])\r\n val_dims = dims.get(key)\r\n val_dims, coords = generate_dims_coords(\r\n vals.shape, key, dims=val_dims, coords=self.coords\r\n )\r\n data[key] = xr.DataArray(vals, dims=val_dims, coords=coords)\r\n obs_const_dict[group_name] = xr.Dataset(\r\n data_vars=data, attrs=make_attrs(library=self.pystan)\r\n )\r\n return obs_const_dict\r\n\r\n def to_inference_data(self):\r\n \"\"\"Convert all available data to an InferenceData object.\r\n\r\n Note that if groups can not be created (i.e., there is no `fit`, so\r\n the `posterior` and `sample_stats` can not be extracted), then the InferenceData\r\n will not have those groups.\r\n \"\"\"\r\n data_dict = self.data_to_xarray()\r\n return InferenceData(\r\n save_warmup=self.save_warmup,\r\n **{\r\n \"posterior\": self.posterior_to_xarray(),\r\n \"sample_stats\": self.sample_stats_to_xarray(),\r\n \"log_likelihood\": self.log_likelihood_to_xarray(),\r\n \"posterior_predictive\": self.posterior_predictive_to_xarray(),\r\n \"predictions\": self.predictions_to_xarray(),\r\n \"prior\": self.prior_to_xarray(),\r\n \"sample_stats_prior\": self.sample_stats_prior_to_xarray(),\r\n \"prior_predictive\": self.prior_predictive_to_xarray(),\r\n **({} if data_dict is None else data_dict),\r\n },\r\n )\r\n\r\n\r\nclass PyStan3Converter:\r\n \"\"\"Encapsulate PyStan3 specific logic.\"\"\"\r\n\r\n # pylint: disable=too-many-instance-attributes\r\n def __init__(\r\n self,\r\n *,\r\n posterior=None,\r\n posterior_model=None,\r\n posterior_predictive=None,\r\n predictions=None,\r\n prior=None,\r\n prior_model=None,\r\n prior_predictive=None,\r\n observed_data=None,\r\n constant_data=None,\r\n predictions_constant_data=None,\r\n log_likelihood=None,\r\n coords=None,\r\n dims=None,\r\n dtypes=None,\r\n ):\r\n self.posterior = posterior\r\n self.posterior_model = posterior_model\r\n self.posterior_predictive = posterior_predictive\r\n self.predictions = predictions\r\n self.prior = prior\r\n self.prior_model = prior_model\r\n self.prior_predictive = prior_predictive\r\n self.observed_data = observed_data\r\n self.constant_data = constant_data\r\n self.predictions_constant_data = predictions_constant_data\r\n self.log_likelihood = (\r\n rcParams[\"data.log_likelihood\"] if log_likelihood is None else log_likelihood\r\n )\r\n self.coords = coords\r\n self.dims = dims\r\n self.dtypes = dtypes\r\n\r\n if (\r\n self.log_likelihood is True\r\n and self.posterior is not None\r\n and \"log_lik\" in self.posterior.param_names\r\n ):\r\n self.log_likelihood = [\"log_lik\"]\r\n elif isinstance(self.log_likelihood, bool):\r\n self.log_likelihood = None\r\n\r\n import stan # pylint: disable=import-error\r\n\r\n self.stan = stan\r\n\r\n @requires(\"posterior\")\r\n def posterior_to_xarray(self):\r\n \"\"\"Extract posterior samples from fit.\"\"\"\r\n posterior = self.posterior\r\n posterior_model = self.posterior_model\r\n # filter posterior_predictive and log_likelihood\r\n posterior_predictive = self.posterior_predictive\r\n if posterior_predictive is None:\r\n posterior_predictive = []\r\n elif isinstance(posterior_predictive, str):\r\n posterior_predictive = [posterior_predictive]\r\n predictions = self.predictions\r\n if predictions is None:\r\n predictions = []\r\n elif isinstance(predictions, str):\r\n predictions = [predictions]\r\n log_likelihood = self.log_likelihood\r\n if log_likelihood is None:\r\n log_likelihood = []\r\n elif isinstance(log_likelihood, str):\r\n log_likelihood = [log_likelihood]\r\n elif isinstance(log_likelihood, dict):\r\n log_likelihood = list(log_likelihood.values())\r\n\r\n ignore = posterior_predictive + predictions + log_likelihood\r\n\r\n data = get_draws_stan3(posterior, model=posterior_model, ignore=ignore, dtypes=self.dtypes)\r\n attrs = get_attrs_stan3(posterior, model=posterior_model)\r\n return dict_to_dataset(\r\n data, library=self.stan, attrs=attrs, coords=self.coords, dims=self.dims\r\n )\r\n\r\n @requires(\"posterior\")\r\n def sample_stats_to_xarray(self):\r\n \"\"\"Extract sample_stats from posterior.\"\"\"\r\n posterior = self.posterior\r\n posterior_model = self.posterior_model\r\n data = get_sample_stats_stan3(posterior, ignore=\"lp__\", dtypes=self.dtypes)\r\n data[\"lp\"] = get_sample_stats_stan3(posterior, variables=\"lp__\")[\"lp\"]\r\n\r\n attrs = get_attrs_stan3(posterior, model=posterior_model)\r\n return dict_to_dataset(\r\n data, library=self.stan, attrs=attrs, coords=self.coords, dims=self.dims\r\n )\r\n\r\n @requires(\"posterior\")\r\n @requires(\"log_likelihood\")\r\n def log_likelihood_to_xarray(self):\r\n \"\"\"Store log_likelihood data in log_likelihood group.\"\"\"\r\n fit = self.posterior\r\n\r\n log_likelihood = self.log_likelihood\r\n model = self.posterior_model\r\n if isinstance(log_likelihood, str):\r\n log_likelihood = [log_likelihood]\r\n if isinstance(log_likelihood, (list, tuple)):\r\n log_likelihood = {name: name for name in log_likelihood}\r\n log_likelihood_draws = get_draws_stan3(\r\n fit, model=model, variables=list(log_likelihood.values()), dtypes=self.dtypes\r\n )\r\n data = {\r\n obs_var_name: log_likelihood_draws[log_like_name]\r\n for obs_var_name, log_like_name in log_likelihood.items()\r\n if log_like_name in log_likelihood_draws\r\n }\r\n\r\n return dict_to_dataset(data, library=self.stan, coords=self.coords, dims=self.dims)\r\n\r\n @requires(\"posterior\")\r\n @requires(\"posterior_predictive\")\r\n def posterior_predictive_to_xarray(self):\r\n \"\"\"Convert posterior_predictive samples to xarray.\"\"\"\r\n posterior = self.posterior\r\n posterior_model = self.posterior_model\r\n posterior_predictive = self.posterior_predictive\r\n data = get_draws_stan3(\r\n posterior, model=posterior_model, variables=posterior_predictive, dtypes=self.dtypes\r\n )\r\n return dict_to_dataset(data, library=self.stan, coords=self.coords, dims=self.dims)\r\n\r\n @requires(\"posterior\")\r\n @requires(\"predictions\")\r\n def predictions_to_xarray(self):\r\n \"\"\"Convert predictions samples to xarray.\"\"\"\r\n posterior = self.posterior\r\n posterior_model = self.posterior_model\r\n predictions = self.predictions\r\n data = get_draws_stan3(\r\n posterior, model=posterior_model, variables=predictions, dtypes=self.dtypes\r\n )\r\n return dict_to_dataset(data, library=self.stan, coords=self.coords, dims=self.dims)\r\n\r\n @requires(\"prior\")\r\n def prior_to_xarray(self):\r\n \"\"\"Convert prior samples to xarray.\"\"\"\r\n prior = self.prior\r\n prior_model = self.prior_model\r\n # filter posterior_predictive and log_likelihood\r\n prior_predictive = self.prior_predictive\r\n if prior_predictive is None:\r\n prior_predictive = []\r\n elif isinstance(prior_predictive, str):\r\n prior_predictive = [prior_predictive]\r\n\r\n ignore = prior_predictive\r\n\r\n data = get_draws_stan3(prior, model=prior_model, ignore=ignore, dtypes=self.dtypes)\r\n attrs = get_attrs_stan3(prior, model=prior_model)\r\n return dict_to_dataset(\r\n data, library=self.stan, attrs=attrs, coords=self.coords, dims=self.dims\r\n )\r\n\r\n @requires(\"prior\")\r\n def sample_stats_prior_to_xarray(self):\r\n \"\"\"Extract sample_stats_prior from prior.\"\"\"\r\n prior = self.prior\r\n prior_model = self.prior_model\r\n data = get_sample_stats_stan3(prior, dtypes=self.dtypes)\r\n attrs = get_attrs_stan3(prior, model=prior_model)\r\n return dict_to_dataset(\r\n data, library=self.stan, attrs=attrs, coords=self.coords, dims=self.dims\r\n )\r\n\r\n @requires(\"prior\")\r\n @requires(\"prior_predictive\")\r\n def prior_predictive_to_xarray(self):\r\n \"\"\"Convert prior_predictive samples to xarray.\"\"\"\r\n prior = self.prior\r\n prior_model = self.prior_model\r\n prior_predictive = self.prior_predictive\r\n data = get_draws_stan3(\r\n prior, model=prior_model, variables=prior_predictive, dtypes=self.dtypes\r\n )\r\n return dict_to_dataset(data, library=self.stan, coords=self.coords, dims=self.dims)\r\n\r\n @requires(\"posterior_model\")\r\n @requires([\"observed_data\", \"constant_data\"])\r\n def observed_and_constant_data_to_xarray(self):\r\n \"\"\"Convert observed data to xarray.\"\"\"\r\n posterior_model = self.posterior_model\r\n if self.dims is None:\r\n dims = {}\r\n else:\r\n dims = self.dims\r\n obs_const_dict = {}\r\n for group_name in (\"observed_data\", \"constant_data\"):\r\n names = getattr(self, group_name)\r\n if names is None:\r\n continue\r\n names = [names] if isinstance(names, str) else names\r\n data = OrderedDict()\r\n for key in names:\r\n vals = np.atleast_1d(posterior_model.data[key])\r\n val_dims = dims.get(key)\r\n val_dims, coords = generate_dims_coords(\r\n vals.shape, key, dims=val_dims, coords=self.coords\r\n )\r\n data[key] = xr.DataArray(vals, dims=val_dims, coords=coords)\r\n obs_const_dict[group_name] = xr.Dataset(\r\n data_vars=data, attrs=make_attrs(library=self.stan)\r\n )\r\n return obs_const_dict\r\n\r\n @requires(\"posterior_model\")\r\n @requires(\"predictions_constant_data\")\r\n def predictions_constant_data_to_xarray(self):\r\n \"\"\"Convert observed data to xarray.\"\"\"\r\n posterior_model = self.posterior_model\r\n if self.dims is None:\r\n dims = {}\r\n else:\r\n dims = self.dims\r\n names = self.predictions_constant_data\r\n names = [names] if isinstance(names, str) else names\r\n data = OrderedDict()\r\n for key in names:\r\n vals = np.atleast_1d(posterior_model.data[key])\r\n val_dims = dims.get(key)\r\n val_dims, coords = generate_dims_coords(\r\n vals.shape, key, dims=val_dims, coords=self.coords\r\n )\r\n data[key] = xr.DataArray(vals, dims=val_dims, coords=coords)\r\n return xr.Dataset(data_vars=data, attrs=make_attrs(library=self.stan))\r\n\r\n def to_inference_data(self):\r\n \"\"\"Convert all available data to an InferenceData object.\r\n\r\n Note that if groups can not be created (i.e., there is no `fit`, so\r\n the `posterior` and `sample_stats` can not be extracted), then the InferenceData\r\n will not have those groups.\r\n \"\"\"\r\n obs_const_dict = self.observed_and_constant_data_to_xarray()\r\n predictions_const_data = self.predictions_constant_data_to_xarray()\r\n return InferenceData(\r\n **{\r\n \"posterior\": self.posterior_to_xarray(),\r\n \"sample_stats\": self.sample_stats_to_xarray(),\r\n \"log_likelihood\": self.log_likelihood_to_xarray(),\r\n \"posterior_predictive\": self.posterior_predictive_to_xarray(),\r\n \"predictions\": self.predictions_to_xarray(),\r\n \"prior\": self.prior_to_xarray(),\r\n \"sample_stats_prior\": self.sample_stats_prior_to_xarray(),\r\n \"prior_predictive\": self.prior_predictive_to_xarray(),\r\n **({} if obs_const_dict is None else obs_const_dict),\r\n **(\r\n {}\r\n if predictions_const_data is None\r\n else {\"predictions_constant_data\": predictions_const_data}\r\n ),\r\n }\r\n )\r\n\r\n\r\ndef get_draws(fit, variables=None, ignore=None, warmup=False, dtypes=None):\r\n \"\"\"Extract draws from PyStan fit.\"\"\"\r\n if ignore is None:\r\n ignore = []\r\n if fit.mode == 1:\r\n msg = \"Model in mode 'test_grad'. Sampling is not conducted.\"\r\n raise AttributeError(msg)\r\n\r\n if fit.mode == 2 or fit.sim.get(\"samples\") is None:\r\n msg = \"Fit doesn't contain samples.\"\r\n raise AttributeError(msg)\r\n\r\n if dtypes is None:\r\n dtypes = {}\r\n\r\n dtypes = {**infer_dtypes(fit), **dtypes}\r\n\r\n if variables is None:\r\n variables = fit.sim[\"pars_oi\"]\r\n elif isinstance(variables, str):\r\n variables = [variables]\r\n variables = list(variables)\r\n\r\n for var, dim in zip(fit.sim[\"pars_oi\"], fit.sim[\"dims_oi\"]):\r\n if var in variables and np.prod(dim) == 0:\r\n del variables[variables.index(var)]\r\n\r\n ndraws_warmup = fit.sim[\"warmup2\"]\r\n if max(ndraws_warmup) == 0:\r\n warmup = False\r\n ndraws = [s - w for s, w in zip(fit.sim[\"n_save\"], ndraws_warmup)]\r\n nchain = len(fit.sim[\"samples\"])\r\n\r\n # check if the values are in 0-based (<=2.17) or 1-based indexing (>=2.18)\r\n shift = 1\r\n if any(dim and np.prod(dim) != 0 for dim in fit.sim[\"dims_oi\"]):\r\n # choose variable with lowest number of dims > 1\r\n par_idx = min(\r\n (dim, i) for i, dim in enumerate(fit.sim[\"dims_oi\"]) if (dim and np.prod(dim) != 0)\r\n )[1]\r\n offset = int(sum(map(np.product, fit.sim[\"dims_oi\"][:par_idx])))\r\n par_offset = int(np.product(fit.sim[\"dims_oi\"][par_idx]))\r\n par_keys = fit.sim[\"fnames_oi\"][offset : offset + par_offset]\r\n shift = len(par_keys)\r\n for item in par_keys:\r\n _, shape = item.replace(\"]\", \"\").split(\"[\")\r\n shape_idx_min = min(int(shape_value) for shape_value in shape.split(\",\"))\r\n if shape_idx_min < shift:\r\n shift = shape_idx_min\r\n # If shift is higher than 1, this will probably mean that Stan\r\n # has implemented sparse structure (saves only non-zero parts),\r\n # but let's hope that dims are still corresponding to the full shape\r\n shift = int(min(shift, 1))\r\n\r\n var_keys = OrderedDict((var, []) for var in fit.sim[\"pars_oi\"])\r\n for key in fit.sim[\"fnames_oi\"]:\r\n var, *tails = key.split(\"[\")\r\n loc = [Ellipsis]\r\n for tail in tails:\r\n loc = []\r\n for i in tail[:-1].split(\",\"):\r\n loc.append(int(i) - shift)\r\n var_keys[var].append((key, loc))\r\n\r\n shapes = dict(zip(fit.sim[\"pars_oi\"], fit.sim[\"dims_oi\"]))\r\n\r\n variables = [var for var in variables if var not in ignore]\r\n\r\n data = OrderedDict()\r\n data_warmup = OrderedDict()\r\n\r\n for var in variables:\r\n if var in data:\r\n continue\r\n keys_locs = var_keys.get(var, [(var, [Ellipsis])])\r\n shape = shapes.get(var, [])\r\n dtype = dtypes.get(var)\r\n\r\n ndraw = max(ndraws)\r\n ary_shape = [nchain, ndraw] + shape\r\n ary = np.empty(ary_shape, dtype=dtype, order=\"F\")\r\n\r\n if warmup:\r\n nwarmup = max(ndraws_warmup)\r\n ary_warmup_shape = [nchain, nwarmup] + shape\r\n ary_warmup = np.empty(ary_warmup_shape, dtype=dtype, order=\"F\")\r\n\r\n for chain, (pyholder, ndraw, ndraw_warmup) in enumerate(\r\n zip(fit.sim[\"samples\"], ndraws, ndraws_warmup)\r\n ):\r\n axes = [chain, slice(None)]\r\n for key, loc in keys_locs:\r\n ary_slice = tuple(axes + loc)\r\n ary[ary_slice] = pyholder.chains[key][-ndraw:]\r\n if warmup:\r\n ary_warmup[ary_slice] = pyholder.chains[key][:ndraw_warmup]\r\n data[var] = ary\r\n if warmup:\r\n data_warmup[var] = ary_warmup\r\n return data, data_warmup\r\n\r\n\r\ndef get_sample_stats(fit, warmup=False, dtypes=None):\r\n \"\"\"Extract sample stats from PyStan fit.\"\"\"\r\n if dtypes is None:\r\n dtypes = {}\r\n dtypes = {\"divergent__\": bool, \"n_leapfrog__\": np.int64, \"treedepth__\": np.int64, **dtypes}\r\n\r\n rename_dict = {\r\n \"divergent\": \"diverging\",\r\n \"n_leapfrog\": \"n_steps\",\r\n \"treedepth\": \"tree_depth\",\r\n \"stepsize\": \"step_size\",\r\n \"accept_stat\": \"acceptance_rate\",\r\n }\r\n\r\n ndraws_warmup = fit.sim[\"warmup2\"]\r\n if max(ndraws_warmup) == 0:\r\n warmup = False\r\n ndraws = [s - w for s, w in zip(fit.sim[\"n_save\"], ndraws_warmup)]\r\n\r\n extraction = OrderedDict()\r\n extraction_warmup = OrderedDict()\r\n for chain, (pyholder, ndraw, ndraw_warmup) in enumerate(\r\n zip(fit.sim[\"samples\"], ndraws, ndraws_warmup)\r\n ):\r\n if chain == 0:\r\n for key in pyholder[\"sampler_param_names\"]:\r\n extraction[key] = []\r\n if warmup:\r\n extraction_warmup[key] = []\r\n for key, values in zip(pyholder[\"sampler_param_names\"], pyholder[\"sampler_params\"]):\r\n extraction[key].append(values[-ndraw:])\r\n if warmup:\r\n extraction_warmup[key].append(values[:ndraw_warmup])\r\n\r\n data = OrderedDict()\r\n for key, values in extraction.items():\r\n values = np.stack(values, axis=0)\r\n dtype = dtypes.get(key)\r\n values = values.astype(dtype)\r\n name = re.sub(\"__$\", \"\", key)\r\n name = rename_dict.get(name, name)\r\n data[name] = values\r\n\r\n data_warmup = OrderedDict()\r\n if warmup:\r\n for key, values in extraction_warmup.items():\r\n values = np.stack(values, axis=0)\r\n values = values.astype(dtypes.get(key))\r\n name = re.sub(\"__$\", \"\", key)\r\n name = rename_dict.get(name, name)\r\n data_warmup[name] = values\r\n\r\n return data, data_warmup\r\n\r\n\r\ndef get_attrs(fit):\r\n \"\"\"Get attributes from PyStan fit object.\"\"\"\r\n attrs = {}\r\n\r\n try:\r\n attrs[\"args\"] = [deepcopy(holder.args) for holder in fit.sim[\"samples\"]]\r\n except Exception as exp: # pylint: disable=broad-except\r\n _log.warning(\"Failed to fetch args from fit: %s\", exp)\r\n if \"args\" in attrs:\r\n for arg in attrs[\"args\"]:\r\n if isinstance(arg[\"init\"], bytes):\r\n arg[\"init\"] = arg[\"init\"].decode(\"utf-8\")\r\n attrs[\"args\"] = json.dumps(attrs[\"args\"])\r\n try:\r\n attrs[\"inits\"] = [holder.inits for holder in fit.sim[\"samples\"]]\r\n except Exception as exp: # pylint: disable=broad-except\r\n _log.warning(\"Failed to fetch `args` from fit: %s\", exp)\r\n else:\r\n attrs[\"inits\"] = json.dumps(attrs[\"inits\"])\r\n\r\n attrs[\"step_size\"] = []\r\n attrs[\"metric\"] = []\r\n attrs[\"inv_metric\"] = []\r\n for holder in fit.sim[\"samples\"]:\r\n try:\r\n step_size = float(\r\n re.search(\r\n r\"step\\s*size\\s*=\\s*([0-9]+.?[0-9]+)\\s*\",\r\n holder.adaptation_info,\r\n flags=re.IGNORECASE,\r\n ).group(1)\r\n )\r\n except AttributeError:\r\n step_size = np.nan\r\n attrs[\"step_size\"].append(step_size)\r\n\r\n inv_metric_match = re.search(\r\n r\"mass matrix:\\s*(.*)\\s*$\", holder.adaptation_info, flags=re.DOTALL\r\n )\r\n if inv_metric_match:\r\n inv_metric_str = inv_metric_match.group(1)\r\n if \"Diagonal elements of inverse mass matrix\" in holder.adaptation_info:\r\n metric = \"diag_e\"\r\n inv_metric = [float(item) for item in inv_metric_str.strip(\" #\\n\").split(\",\")]\r\n else:\r\n metric = \"dense_e\"\r\n inv_metric = [\r\n list(map(float, item.split(\",\")))\r\n for item in re.sub(r\"#\\s\", \"\", inv_metric_str).splitlines()\r\n ]\r\n else:\r\n metric = \"unit_e\"\r\n inv_metric = None\r\n\r\n attrs[\"metric\"].append(metric)\r\n attrs[\"inv_metric\"].append(inv_metric)\r\n attrs[\"inv_metric\"] = json.dumps(attrs[\"inv_metric\"])\r\n\r\n if not attrs[\"step_size\"]:\r\n del attrs[\"step_size\"]\r\n\r\n attrs[\"adaptation_info\"] = fit.get_adaptation_info()\r\n attrs[\"stan_code\"] = fit.get_stancode()\r\n\r\n return attrs\r\n\r\n\r\ndef get_draws_stan3(fit, model=None, variables=None, ignore=None, dtypes=None):\r\n \"\"\"Extract draws from PyStan3 fit.\"\"\"\r\n if ignore is None:\r\n ignore = []\r\n\r\n if dtypes is None:\r\n dtypes = {}\r\n\r\n if model is not None:\r\n dtypes = {**infer_dtypes(fit, model), **dtypes}\r\n\r\n if variables is None:\r\n variables = fit.param_names\r\n elif isinstance(variables, str):\r\n variables = [variables]\r\n variables = list(variables)\r\n\r\n data = OrderedDict()\r\n\r\n for var in variables:\r\n if var in ignore:\r\n continue\r\n if var in data:\r\n continue\r\n dtype = dtypes.get(var)\r\n\r\n # in future fix the correct number of draws if fit.save_warmup is True\r\n new_shape = (*fit.dims[fit.param_names.index(var)], -1, fit.num_chains)\r\n if 0 in new_shape:\r\n continue\r\n values = fit._draws[fit._parameter_indexes(var), :] # pylint: disable=protected-access\r\n values = values.reshape(new_shape, order=\"F\")\r\n values = np.moveaxis(values, [-2, -1], [1, 0])\r\n values = values.astype(dtype)\r\n data[var] = values\r\n\r\n return data\r\n\r\n\r\ndef get_sample_stats_stan3(fit, variables=None, ignore=None, dtypes=None):\r\n \"\"\"Extract sample stats from PyStan3 fit.\"\"\"\r\n if dtypes is None:\r\n dtypes = {}\r\n dtypes = {\"divergent__\": bool, \"n_leapfrog__\": np.int64, \"treedepth__\": np.int64, **dtypes}\r\n\r\n rename_dict = {\r\n \"divergent\": \"diverging\",\r\n \"n_leapfrog\": \"n_steps\",\r\n \"treedepth\": \"tree_depth\",\r\n \"stepsize\": \"step_size\",\r\n \"accept_stat\": \"acceptance_rate\",\r\n }\r\n\r\n if isinstance(variables, str):\r\n variables = [variables]\r\n if isinstance(ignore, str):\r\n ignore = [ignore]\r\n\r\n data = OrderedDict()\r\n for key in fit.sample_and_sampler_param_names:\r\n if (variables and key not in variables) or (ignore and key in ignore):\r\n continue\r\n new_shape = -1, fit.num_chains\r\n values = fit._draws[fit._parameter_indexes(key)] # pylint: disable=protected-access\r\n values = values.reshape(new_shape, order=\"F\")\r\n values = np.moveaxis(values, [-2, -1], [1, 0])\r\n dtype = dtypes.get(key)\r\n values = values.astype(dtype)\r\n name = re.sub(\"__$\", \"\", key)\r\n name = rename_dict.get(name, name)\r\n data[name] = values\r\n\r\n return data\r\n\r\n\r\ndef get_attrs_stan3(fit, model=None):\r\n \"\"\"Get attributes from PyStan3 fit and model object.\"\"\"\r\n attrs = {}\r\n for key in [\"num_chains\", \"num_samples\", \"num_thin\", \"num_warmup\", \"save_warmup\"]:\r\n try:\r\n attrs[key] = getattr(fit, key)\r\n except AttributeError as exp:\r\n _log.warning(\"Failed to access attribute %s in fit object %s\", key, exp)\r\n\r\n if model is not None:\r\n for key in [\"model_name\", \"program_code\", \"random_seed\"]:\r\n try:\r\n attrs[key] = getattr(model, key)\r\n except AttributeError as exp:\r\n _log.warning(\"Failed to access attribute %s in model object %s\", key, exp)\r\n\r\n return attrs\r\n\r\n\r\ndef infer_dtypes(fit, model=None):\r\n \"\"\"Infer dtypes from Stan model code.\r\n\r\n Function strips out generated quantities block and searches for `int`\r\n dtypes after stripping out comments inside the block.\r\n \"\"\"\r\n if model is None:\r\n stan_code = fit.get_stancode()\r\n model_pars = fit.model_pars\r\n else:\r\n stan_code = model.program_code\r\n model_pars = fit.param_names\r\n\r\n dtypes = {key: item for key, item in infer_stan_dtypes(stan_code).items() if key in model_pars}\r\n return dtypes\r\n\r\n\r\n# pylint disable=too-many-instance-attributes\r\ndef from_pystan(\r\n posterior=None,\r\n *,\r\n posterior_predictive=None,\r\n predictions=None,\r\n prior=None,\r\n prior_predictive=None,\r\n observed_data=None,\r\n constant_data=None,\r\n predictions_constant_data=None,\r\n log_likelihood=None,\r\n coords=None,\r\n dims=None,\r\n posterior_model=None,\r\n prior_model=None,\r\n save_warmup=None,\r\n dtypes=None,\r\n):\r\n \"\"\"Convert PyStan data into an InferenceData object.\r\n\r\n For a usage example read the\r\n :ref:`Creating InferenceData section on from_pystan <creating_InferenceData>`\r\n\r\n Parameters\r\n ----------\r\n posterior : StanFit4Model or stan.fit.Fit\r\n PyStan fit object for posterior.\r\n posterior_predictive : str, a list of str\r\n Posterior predictive samples for the posterior.\r\n predictions : str, a list of str\r\n Out-of-sample predictions for the posterior.\r\n prior : StanFit4Model or stan.fit.Fit\r\n PyStan fit object for prior.\r\n prior_predictive : str, a list of str\r\n Posterior predictive samples for the prior.\r\n observed_data : str or a list of str\r\n observed data used in the sampling.\r\n Observed data is extracted from the `posterior.data`.\r\n PyStan3 needs model object for the extraction.\r\n See `posterior_model`.\r\n constant_data : str or list of str\r\n Constants relevant to the model (i.e. x values in a linear\r\n regression).\r\n predictions_constant_data : str or list of str\r\n Constants relevant to the model predictions (i.e. new x values in a linear\r\n regression).\r\n log_likelihood : dict of {str: str}, list of str or str, optional\r\n Pointwise log_likelihood for the data. log_likelihood is extracted from the\r\n posterior. It is recommended to use this argument as a dictionary whose keys\r\n are observed variable names and its values are the variables storing log\r\n likelihood arrays in the Stan code. In other cases, a dictionary with keys\r\n equal to its values is used. By default, if a variable ``log_lik`` is\r\n present in the Stan model, it will be retrieved as pointwise log\r\n likelihood values. Use ``False`` or set ``data.log_likelihood`` to\r\n false to avoid this behaviour.\r\n coords : dict[str, iterable]\r\n A dictionary containing the values that are used as index. The key\r\n is the name of the dimension, the values are the index values.\r\n dims : dict[str, List(str)]\r\n A mapping from variables to a list of coordinate names for the variable.\r\n posterior_model : stan.model.Model\r\n PyStan3 specific model object. Needed for automatic dtype parsing\r\n and for the extraction of observed data.\r\n prior_model : stan.model.Model\r\n PyStan3 specific model object. Needed for automatic dtype parsing.\r\n save_warmup : bool\r\n Save warmup iterations into InferenceData object. If not defined, use default\r\n defined by the rcParams. Not supported in PyStan3.\r\n dtypes: dict\r\n A dictionary containing dtype information (int, float) for parameters.\r\n By default dtype information is extracted from the model code.\r\n Model code is extracted from fit object in PyStan 2 and from model object\r\n in PyStan 3.\r\n\r\n Returns\r\n -------\r\n InferenceData object\r\n \"\"\"\r\n check_posterior = (posterior is not None) and (type(posterior).__module__ == \"stan.fit\")\r\n check_prior = (prior is not None) and (type(prior).__module__ == \"stan.fit\")\r\n if check_posterior or check_prior:\r\n if save_warmup:\r\n warnings.warn(\r\n \"save_warmup is not currently supported for PyStan3\",\r\n UserWarning,\r\n )\r\n return PyStan3Converter(\r\n posterior=posterior,\r\n posterior_model=posterior_model,\r\n posterior_predictive=posterior_predictive,\r\n predictions=predictions,\r\n prior=prior,\r\n prior_model=prior_model,\r\n prior_predictive=prior_predictive,\r\n observed_data=observed_data,\r\n constant_data=constant_data,\r\n predictions_constant_data=predictions_constant_data,\r\n log_likelihood=log_likelihood,\r\n coords=coords,\r\n dims=dims,\r\n dtypes=dtypes,\r\n ).to_inference_data()\r\n else:\r\n return PyStanConverter(\r\n posterior=posterior,\r\n posterior_predictive=posterior_predictive,\r\n predictions=predictions,\r\n prior=prior,\r\n prior_predictive=prior_predictive,\r\n observed_data=observed_data,\r\n constant_data=constant_data,\r\n predictions_constant_data=predictions_constant_data,\r\n log_likelihood=log_likelihood,\r\n coords=coords,\r\n dims=dims,\r\n save_warmup=save_warmup,\r\n dtypes=dtypes,\r\n ).to_inference_data()\r\n", "path": "arviz/data/io_pystan.py"}]} |
gh_patches_debug_296 | rasdani/github-patches | git_diff | TheAlgorithms__Python-11276 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Global variable should not using in class method
### Repository commit
9caf4784aada17dc75348f77cc8c356df503c0f3
### Python version (python --version)
python3.11
### Dependencies version (pip freeze)
#nop
### Expected behavior
Hi, guys. I come across one global variable that used in class method. I think using instance attribute would be better !
```python
def show_data(self):
show_list = []
for i in range(1, N + 1): ==> should using self.N instead of N !
show_list += [self.query(i, i)]
print(show_list)
```
[source](https://github.com/TheAlgorithms/Python/blob/master/data_structures/binary_tree/segment_tree.py#L101)
### Actual behavior
```python
def show_data(self):
show_list = []
for i in range(1, self.N + 1):
show_list += [self.query(i, i)]
print(show_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: `data_structures/binary_tree/segment_tree.py`
Content:
```
1 import math
2
3
4 class SegmentTree:
5 def __init__(self, a):
6 self.A = a
7 self.N = len(self.A)
8 self.st = [0] * (
9 4 * self.N
10 ) # approximate the overall size of segment tree with array N
11 if self.N:
12 self.build(1, 0, self.N - 1)
13
14 def left(self, idx):
15 """
16 Returns the left child index for a given index in a binary tree.
17
18 >>> s = SegmentTree([1, 2, 3])
19 >>> s.left(1)
20 2
21 >>> s.left(2)
22 4
23 """
24 return idx * 2
25
26 def right(self, idx):
27 """
28 Returns the right child index for a given index in a binary tree.
29
30 >>> s = SegmentTree([1, 2, 3])
31 >>> s.right(1)
32 3
33 >>> s.right(2)
34 5
35 """
36 return idx * 2 + 1
37
38 def build(self, idx, l, r): # noqa: E741
39 if l == r:
40 self.st[idx] = self.A[l]
41 else:
42 mid = (l + r) // 2
43 self.build(self.left(idx), l, mid)
44 self.build(self.right(idx), mid + 1, r)
45 self.st[idx] = max(self.st[self.left(idx)], self.st[self.right(idx)])
46
47 def update(self, a, b, val):
48 """
49 Update the values in the segment tree in the range [a,b] with the given value.
50
51 >>> s = SegmentTree([1, 2, 3, 4, 5])
52 >>> s.update(2, 4, 10)
53 True
54 >>> s.query(1, 5)
55 10
56 """
57 return self.update_recursive(1, 0, self.N - 1, a - 1, b - 1, val)
58
59 def update_recursive(self, idx, l, r, a, b, val): # noqa: E741
60 """
61 update(1, 1, N, a, b, v) for update val v to [a,b]
62 """
63 if r < a or l > b:
64 return True
65 if l == r:
66 self.st[idx] = val
67 return True
68 mid = (l + r) // 2
69 self.update_recursive(self.left(idx), l, mid, a, b, val)
70 self.update_recursive(self.right(idx), mid + 1, r, a, b, val)
71 self.st[idx] = max(self.st[self.left(idx)], self.st[self.right(idx)])
72 return True
73
74 def query(self, a, b):
75 """
76 Query the maximum value in the range [a,b].
77
78 >>> s = SegmentTree([1, 2, 3, 4, 5])
79 >>> s.query(1, 3)
80 3
81 >>> s.query(1, 5)
82 5
83 """
84 return self.query_recursive(1, 0, self.N - 1, a - 1, b - 1)
85
86 def query_recursive(self, idx, l, r, a, b): # noqa: E741
87 """
88 query(1, 1, N, a, b) for query max of [a,b]
89 """
90 if r < a or l > b:
91 return -math.inf
92 if l >= a and r <= b:
93 return self.st[idx]
94 mid = (l + r) // 2
95 q1 = self.query_recursive(self.left(idx), l, mid, a, b)
96 q2 = self.query_recursive(self.right(idx), mid + 1, r, a, b)
97 return max(q1, q2)
98
99 def show_data(self):
100 show_list = []
101 for i in range(1, N + 1):
102 show_list += [self.query(i, i)]
103 print(show_list)
104
105
106 if __name__ == "__main__":
107 A = [1, 2, -4, 7, 3, -5, 6, 11, -20, 9, 14, 15, 5, 2, -8]
108 N = 15
109 segt = SegmentTree(A)
110 print(segt.query(4, 6))
111 print(segt.query(7, 11))
112 print(segt.query(7, 12))
113 segt.update(1, 3, 111)
114 print(segt.query(1, 15))
115 segt.update(7, 8, 235)
116 segt.show_data()
117
```
--- 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/data_structures/binary_tree/segment_tree.py b/data_structures/binary_tree/segment_tree.py
--- a/data_structures/binary_tree/segment_tree.py
+++ b/data_structures/binary_tree/segment_tree.py
@@ -98,7 +98,7 @@
def show_data(self):
show_list = []
- for i in range(1, N + 1):
+ for i in range(1, self.N + 1):
show_list += [self.query(i, i)]
print(show_list)
| {"golden_diff": "diff --git a/data_structures/binary_tree/segment_tree.py b/data_structures/binary_tree/segment_tree.py\n--- a/data_structures/binary_tree/segment_tree.py\n+++ b/data_structures/binary_tree/segment_tree.py\n@@ -98,7 +98,7 @@\n \n def show_data(self):\n show_list = []\n- for i in range(1, N + 1):\n+ for i in range(1, self.N + 1):\n show_list += [self.query(i, i)]\n print(show_list)\n", "issue": "Global variable should not using in class method\n### Repository commit\n\n9caf4784aada17dc75348f77cc8c356df503c0f3\n\n### Python version (python --version)\n\npython3.11\n\n### Dependencies version (pip freeze)\n\n#nop \n\n### Expected behavior\n\nHi, guys. I come across one global variable that used in class method. I think using instance attribute would be better !\r\n```python\r\n def show_data(self):\r\n show_list = []\r\n for i in range(1, N + 1): ==> should using self.N instead of N !\r\n show_list += [self.query(i, i)]\r\n print(show_list)\r\n```\r\n[source](https://github.com/TheAlgorithms/Python/blob/master/data_structures/binary_tree/segment_tree.py#L101)\r\n\r\n\n\n### Actual behavior\n\n```python\r\n def show_data(self):\r\n show_list = []\r\n for i in range(1, self.N + 1): \r\n show_list += [self.query(i, i)]\r\n print(show_list)\r\n```\n", "before_files": [{"content": "import math\n\n\nclass SegmentTree:\n def __init__(self, a):\n self.A = a\n self.N = len(self.A)\n self.st = [0] * (\n 4 * self.N\n ) # approximate the overall size of segment tree with array N\n if self.N:\n self.build(1, 0, self.N - 1)\n\n def left(self, idx):\n \"\"\"\n Returns the left child index for a given index in a binary tree.\n\n >>> s = SegmentTree([1, 2, 3])\n >>> s.left(1)\n 2\n >>> s.left(2)\n 4\n \"\"\"\n return idx * 2\n\n def right(self, idx):\n \"\"\"\n Returns the right child index for a given index in a binary tree.\n\n >>> s = SegmentTree([1, 2, 3])\n >>> s.right(1)\n 3\n >>> s.right(2)\n 5\n \"\"\"\n return idx * 2 + 1\n\n def build(self, idx, l, r): # noqa: E741\n if l == r:\n self.st[idx] = self.A[l]\n else:\n mid = (l + r) // 2\n self.build(self.left(idx), l, mid)\n self.build(self.right(idx), mid + 1, r)\n self.st[idx] = max(self.st[self.left(idx)], self.st[self.right(idx)])\n\n def update(self, a, b, val):\n \"\"\"\n Update the values in the segment tree in the range [a,b] with the given value.\n\n >>> s = SegmentTree([1, 2, 3, 4, 5])\n >>> s.update(2, 4, 10)\n True\n >>> s.query(1, 5)\n 10\n \"\"\"\n return self.update_recursive(1, 0, self.N - 1, a - 1, b - 1, val)\n\n def update_recursive(self, idx, l, r, a, b, val): # noqa: E741\n \"\"\"\n update(1, 1, N, a, b, v) for update val v to [a,b]\n \"\"\"\n if r < a or l > b:\n return True\n if l == r:\n self.st[idx] = val\n return True\n mid = (l + r) // 2\n self.update_recursive(self.left(idx), l, mid, a, b, val)\n self.update_recursive(self.right(idx), mid + 1, r, a, b, val)\n self.st[idx] = max(self.st[self.left(idx)], self.st[self.right(idx)])\n return True\n\n def query(self, a, b):\n \"\"\"\n Query the maximum value in the range [a,b].\n\n >>> s = SegmentTree([1, 2, 3, 4, 5])\n >>> s.query(1, 3)\n 3\n >>> s.query(1, 5)\n 5\n \"\"\"\n return self.query_recursive(1, 0, self.N - 1, a - 1, b - 1)\n\n def query_recursive(self, idx, l, r, a, b): # noqa: E741\n \"\"\"\n query(1, 1, N, a, b) for query max of [a,b]\n \"\"\"\n if r < a or l > b:\n return -math.inf\n if l >= a and r <= b:\n return self.st[idx]\n mid = (l + r) // 2\n q1 = self.query_recursive(self.left(idx), l, mid, a, b)\n q2 = self.query_recursive(self.right(idx), mid + 1, r, a, b)\n return max(q1, q2)\n\n def show_data(self):\n show_list = []\n for i in range(1, N + 1):\n show_list += [self.query(i, i)]\n print(show_list)\n\n\nif __name__ == \"__main__\":\n A = [1, 2, -4, 7, 3, -5, 6, 11, -20, 9, 14, 15, 5, 2, -8]\n N = 15\n segt = SegmentTree(A)\n print(segt.query(4, 6))\n print(segt.query(7, 11))\n print(segt.query(7, 12))\n segt.update(1, 3, 111)\n print(segt.query(1, 15))\n segt.update(7, 8, 235)\n segt.show_data()\n", "path": "data_structures/binary_tree/segment_tree.py"}], "after_files": [{"content": "import math\n\n\nclass SegmentTree:\n def __init__(self, a):\n self.A = a\n self.N = len(self.A)\n self.st = [0] * (\n 4 * self.N\n ) # approximate the overall size of segment tree with array N\n if self.N:\n self.build(1, 0, self.N - 1)\n\n def left(self, idx):\n \"\"\"\n Returns the left child index for a given index in a binary tree.\n\n >>> s = SegmentTree([1, 2, 3])\n >>> s.left(1)\n 2\n >>> s.left(2)\n 4\n \"\"\"\n return idx * 2\n\n def right(self, idx):\n \"\"\"\n Returns the right child index for a given index in a binary tree.\n\n >>> s = SegmentTree([1, 2, 3])\n >>> s.right(1)\n 3\n >>> s.right(2)\n 5\n \"\"\"\n return idx * 2 + 1\n\n def build(self, idx, l, r): # noqa: E741\n if l == r:\n self.st[idx] = self.A[l]\n else:\n mid = (l + r) // 2\n self.build(self.left(idx), l, mid)\n self.build(self.right(idx), mid + 1, r)\n self.st[idx] = max(self.st[self.left(idx)], self.st[self.right(idx)])\n\n def update(self, a, b, val):\n \"\"\"\n Update the values in the segment tree in the range [a,b] with the given value.\n\n >>> s = SegmentTree([1, 2, 3, 4, 5])\n >>> s.update(2, 4, 10)\n True\n >>> s.query(1, 5)\n 10\n \"\"\"\n return self.update_recursive(1, 0, self.N - 1, a - 1, b - 1, val)\n\n def update_recursive(self, idx, l, r, a, b, val): # noqa: E741\n \"\"\"\n update(1, 1, N, a, b, v) for update val v to [a,b]\n \"\"\"\n if r < a or l > b:\n return True\n if l == r:\n self.st[idx] = val\n return True\n mid = (l + r) // 2\n self.update_recursive(self.left(idx), l, mid, a, b, val)\n self.update_recursive(self.right(idx), mid + 1, r, a, b, val)\n self.st[idx] = max(self.st[self.left(idx)], self.st[self.right(idx)])\n return True\n\n def query(self, a, b):\n \"\"\"\n Query the maximum value in the range [a,b].\n\n >>> s = SegmentTree([1, 2, 3, 4, 5])\n >>> s.query(1, 3)\n 3\n >>> s.query(1, 5)\n 5\n \"\"\"\n return self.query_recursive(1, 0, self.N - 1, a - 1, b - 1)\n\n def query_recursive(self, idx, l, r, a, b): # noqa: E741\n \"\"\"\n query(1, 1, N, a, b) for query max of [a,b]\n \"\"\"\n if r < a or l > b:\n return -math.inf\n if l >= a and r <= b:\n return self.st[idx]\n mid = (l + r) // 2\n q1 = self.query_recursive(self.left(idx), l, mid, a, b)\n q2 = self.query_recursive(self.right(idx), mid + 1, r, a, b)\n return max(q1, q2)\n\n def show_data(self):\n show_list = []\n for i in range(1, self.N + 1):\n show_list += [self.query(i, i)]\n print(show_list)\n\n\nif __name__ == \"__main__\":\n A = [1, 2, -4, 7, 3, -5, 6, 11, -20, 9, 14, 15, 5, 2, -8]\n N = 15\n segt = SegmentTree(A)\n print(segt.query(4, 6))\n print(segt.query(7, 11))\n print(segt.query(7, 12))\n segt.update(1, 3, 111)\n print(segt.query(1, 15))\n segt.update(7, 8, 235)\n segt.show_data()\n", "path": "data_structures/binary_tree/segment_tree.py"}]} |
gh_patches_debug_297 | rasdani/github-patches | git_diff | typeddjango__django-stubs-1326 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Next release planning (1.13.2)
I'd like to make a new django-stubs release soonish.
I think this is a blocker:
* #1311
~~I don't know how to unlock mypy 0.991 support other than to disable testing with Django 3.2 and 2.2 (due to #1261). That's not ideal, but it is a step towards the new versioning policy we discussed in https://github.com/typeddjango/django-stubs/issues/1095#issuecomment-1307066177 to only support the latest Django version.~~
* #1260
Nice to have PRs:
* #1309
* #1308
* #1315
Would this be version 1.13.2, 1.14.0 or go with https://github.com/typeddjango/django-stubs/issues/1095#issuecomment-1307066177 and call it 4.1.0?
@sobolevn @adamchainz feedback welcome (and anyone else)
--- 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 typing import List
3
4 from setuptools import find_packages, setup
5
6
7 def find_stub_files(name: str) -> List[str]:
8 result = []
9 for root, _dirs, files in os.walk(name):
10 for file in files:
11 if file.endswith(".pyi"):
12 if os.path.sep in root:
13 sub_root = root.split(os.path.sep, 1)[-1]
14 file = os.path.join(sub_root, file)
15 result.append(file)
16 return result
17
18
19 with open("README.md") as f:
20 readme = f.read()
21
22 dependencies = [
23 "mypy>=0.980",
24 "django",
25 "django-stubs-ext>=0.7.0",
26 "tomli",
27 # Types:
28 "typing-extensions",
29 "types-pytz",
30 "types-PyYAML",
31 ]
32
33 extras_require = {
34 "compatible-mypy": ["mypy>=0.980,<0.990"],
35 }
36
37 setup(
38 name="django-stubs",
39 version="1.13.1",
40 description="Mypy stubs for Django",
41 long_description=readme,
42 long_description_content_type="text/markdown",
43 license="MIT",
44 url="https://github.com/typeddjango/django-stubs",
45 author="Maksim Kurnikov",
46 author_email="[email protected]",
47 maintainer="Nikita Sobolev",
48 maintainer_email="[email protected]",
49 py_modules=[],
50 python_requires=">=3.7",
51 install_requires=dependencies,
52 extras_require=extras_require,
53 packages=["django-stubs", *find_packages(exclude=["scripts"])],
54 package_data={
55 "django-stubs": find_stub_files("django-stubs"),
56 "mypy_django_plugin": ["py.typed"],
57 },
58 classifiers=[
59 "License :: OSI Approved :: MIT License",
60 "Operating System :: OS Independent",
61 "Programming Language :: Python :: 3.7",
62 "Programming Language :: Python :: 3.8",
63 "Programming Language :: Python :: 3.9",
64 "Programming Language :: Python :: 3.10",
65 "Programming Language :: Python :: 3.11",
66 "Typing :: Typed",
67 "Framework :: Django",
68 "Framework :: Django :: 2.2",
69 "Framework :: Django :: 3.0",
70 "Framework :: Django :: 3.1",
71 "Framework :: Django :: 3.2",
72 "Framework :: Django :: 4.0",
73 "Framework :: Django :: 4.1",
74 ],
75 project_urls={
76 "Release notes": "https://github.com/typeddjango/django-stubs/releases",
77 },
78 )
79
```
--- 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
@@ -36,7 +36,7 @@
setup(
name="django-stubs",
- version="1.13.1",
+ version="1.13.2",
description="Mypy stubs for Django",
long_description=readme,
long_description_content_type="text/markdown",
| {"golden_diff": "diff --git a/setup.py b/setup.py\n--- a/setup.py\n+++ b/setup.py\n@@ -36,7 +36,7 @@\n \n setup(\n name=\"django-stubs\",\n- version=\"1.13.1\",\n+ version=\"1.13.2\",\n description=\"Mypy stubs for Django\",\n long_description=readme,\n long_description_content_type=\"text/markdown\",\n", "issue": "Next release planning (1.13.2)\nI'd like to make a new django-stubs release soonish.\r\n\r\nI think this is a blocker: \r\n* #1311 \r\n\r\n~~I don't know how to unlock mypy 0.991 support other than to disable testing with Django 3.2 and 2.2 (due to #1261). That's not ideal, but it is a step towards the new versioning policy we discussed in https://github.com/typeddjango/django-stubs/issues/1095#issuecomment-1307066177 to only support the latest Django version.~~\r\n* #1260\r\n\r\nNice to have PRs:\r\n* #1309\r\n* #1308\r\n* #1315\r\n\r\nWould this be version 1.13.2, 1.14.0 or go with https://github.com/typeddjango/django-stubs/issues/1095#issuecomment-1307066177 and call it 4.1.0?\r\n\r\n@sobolevn @adamchainz feedback welcome (and anyone else)\r\n\n", "before_files": [{"content": "import os\nfrom typing import List\n\nfrom setuptools import find_packages, setup\n\n\ndef find_stub_files(name: str) -> List[str]:\n result = []\n for root, _dirs, files in os.walk(name):\n for file in files:\n if file.endswith(\".pyi\"):\n if os.path.sep in root:\n sub_root = root.split(os.path.sep, 1)[-1]\n file = os.path.join(sub_root, file)\n result.append(file)\n return result\n\n\nwith open(\"README.md\") as f:\n readme = f.read()\n\ndependencies = [\n \"mypy>=0.980\",\n \"django\",\n \"django-stubs-ext>=0.7.0\",\n \"tomli\",\n # Types:\n \"typing-extensions\",\n \"types-pytz\",\n \"types-PyYAML\",\n]\n\nextras_require = {\n \"compatible-mypy\": [\"mypy>=0.980,<0.990\"],\n}\n\nsetup(\n name=\"django-stubs\",\n version=\"1.13.1\",\n description=\"Mypy stubs for Django\",\n long_description=readme,\n long_description_content_type=\"text/markdown\",\n license=\"MIT\",\n url=\"https://github.com/typeddjango/django-stubs\",\n author=\"Maksim Kurnikov\",\n author_email=\"[email protected]\",\n maintainer=\"Nikita Sobolev\",\n maintainer_email=\"[email protected]\",\n py_modules=[],\n python_requires=\">=3.7\",\n install_requires=dependencies,\n extras_require=extras_require,\n packages=[\"django-stubs\", *find_packages(exclude=[\"scripts\"])],\n package_data={\n \"django-stubs\": find_stub_files(\"django-stubs\"),\n \"mypy_django_plugin\": [\"py.typed\"],\n },\n classifiers=[\n \"License :: OSI Approved :: MIT License\",\n \"Operating System :: OS Independent\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\",\n \"Programming Language :: Python :: 3.10\",\n \"Programming Language :: Python :: 3.11\",\n \"Typing :: Typed\",\n \"Framework :: Django\",\n \"Framework :: Django :: 2.2\",\n \"Framework :: Django :: 3.0\",\n \"Framework :: Django :: 3.1\",\n \"Framework :: Django :: 3.2\",\n \"Framework :: Django :: 4.0\",\n \"Framework :: Django :: 4.1\",\n ],\n project_urls={\n \"Release notes\": \"https://github.com/typeddjango/django-stubs/releases\",\n },\n)\n", "path": "setup.py"}], "after_files": [{"content": "import os\nfrom typing import List\n\nfrom setuptools import find_packages, setup\n\n\ndef find_stub_files(name: str) -> List[str]:\n result = []\n for root, _dirs, files in os.walk(name):\n for file in files:\n if file.endswith(\".pyi\"):\n if os.path.sep in root:\n sub_root = root.split(os.path.sep, 1)[-1]\n file = os.path.join(sub_root, file)\n result.append(file)\n return result\n\n\nwith open(\"README.md\") as f:\n readme = f.read()\n\ndependencies = [\n \"mypy>=0.980\",\n \"django\",\n \"django-stubs-ext>=0.7.0\",\n \"tomli\",\n # Types:\n \"typing-extensions\",\n \"types-pytz\",\n \"types-PyYAML\",\n]\n\nextras_require = {\n \"compatible-mypy\": [\"mypy>=0.980,<0.990\"],\n}\n\nsetup(\n name=\"django-stubs\",\n version=\"1.13.2\",\n description=\"Mypy stubs for Django\",\n long_description=readme,\n long_description_content_type=\"text/markdown\",\n license=\"MIT\",\n url=\"https://github.com/typeddjango/django-stubs\",\n author=\"Maksim Kurnikov\",\n author_email=\"[email protected]\",\n maintainer=\"Nikita Sobolev\",\n maintainer_email=\"[email protected]\",\n py_modules=[],\n python_requires=\">=3.7\",\n install_requires=dependencies,\n extras_require=extras_require,\n packages=[\"django-stubs\", *find_packages(exclude=[\"scripts\"])],\n package_data={\n \"django-stubs\": find_stub_files(\"django-stubs\"),\n \"mypy_django_plugin\": [\"py.typed\"],\n },\n classifiers=[\n \"License :: OSI Approved :: MIT License\",\n \"Operating System :: OS Independent\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\",\n \"Programming Language :: Python :: 3.10\",\n \"Programming Language :: Python :: 3.11\",\n \"Typing :: Typed\",\n \"Framework :: Django\",\n \"Framework :: Django :: 2.2\",\n \"Framework :: Django :: 3.0\",\n \"Framework :: Django :: 3.1\",\n \"Framework :: Django :: 3.2\",\n \"Framework :: Django :: 4.0\",\n \"Framework :: Django :: 4.1\",\n ],\n project_urls={\n \"Release notes\": \"https://github.com/typeddjango/django-stubs/releases\",\n },\n)\n", "path": "setup.py"}]} |
gh_patches_debug_298 | rasdani/github-patches | git_diff | pytorch__vision-8164 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Bug in `datasets.kitti.Kitti`: `expanduser` operation not performed for `root` parameter
### **🐛 Describe the bug**
When initializing the `torchvision.datasets.kitti.Kitti` class from the torchvision project, the `root` parameter is directly assigned to `self.root` without performing the `expanduser` operation. This behavior leads to an unexpected result in Linux, where using a relative path starting with `~` to specify the dataset location creates a directory named '~' in the program running directory, instead of expanding to the user directory.
### **To Reproduce**
You can use the following code to reproduce this problem.
```python
from torchvision.datasets import Kitti
if __name__ == "__main__":
dataset_train = Kitti("~/data", train=True, download=True)
```
After running this program, you can see the `'~'` folder in current folder.
<img width="189" src="https://github.com/pytorch/vision/assets/39642933/afd31dc1-b711-4f5f-8cc7-e5c0bafb42ce">
### **Expected behavior**
The `root` parameter should be expanded to use the user directory when a relative path starting with `~` is provided. This operation should be handled by the parent class `VisionDataset`.
### **Additional context**
Here is the relevant code snippet from the `Kitti` class:
```python
class Kitti(VisionDataset):
...
def __init__(
self,
root: str,
train: bool = True,
transform: Optional[Callable] = None,
target_transform: Optional[Callable] = None,
transforms: Optional[Callable] = None,
download: bool = False,
):
super().__init__(
root,
transform=transform,
target_transform=target_transform,
transforms=transforms,
)
self.images = []
self.targets = []
self.root = root # This line should be removed
self.train = train
self._location = "training" if self.train else "testing"
...
```
According to my preliminary inspection, I did not find similar problems on other datasets. But I'm not that confident in this conclusion.
### **Suggested Solution**
The line `self.root = root` ([line 69](https://github.com/pytorch/vision/blob/44a9beaf0c8b26bb31892c0f1714c84742663ad7/torchvision/datasets/kitti.py#L69C25-L69C25)) in the `Kitti` class should be removed. The `root` parameter should be handled by the parent class `VisionDataset`, which already performs the `expanduser` operation.
### **Versions**
```
Collecting environment information...
Collecting environment information...
PyTorch version: 2.1.1
Is debug build: False
CUDA used to build PyTorch: 12.1
ROCM used to build PyTorch: N/A
OS: Ubuntu 20.04.6 LTS (x86_64)
GCC version: (Ubuntu 9.4.0-1ubuntu1~20.04.2) 9.4.0
Clang version: Could not collect
CMake version: Could not collect
Libc version: glibc-2.31
Python version: 3.11.6 | packaged by conda-forge | (main, Oct 3 2023, 10:40:35) [GCC 12.3.0] (64-bit runtime)
Python platform: Linux-5.4.0-162-generic-x86_64-with-glibc2.31
Is CUDA available: True
CUDA runtime version: 10.1.243
CUDA_MODULE_LOADING set to: LAZY
GPU models and configuration:
GPU 0: NVIDIA GeForce RTX 3090
GPU 1: NVIDIA GeForce RTX 3090
GPU 2: NVIDIA GeForce RTX 3090
GPU 3: NVIDIA GeForce RTX 3090
Nvidia driver version: 525.89.02
cuDNN version: Probably one of the following:
/usr/local/cuda-11.8/targets/x86_64-linux/lib/libcudnn.so.8
/usr/local/cuda-11.8/targets/x86_64-linux/lib/libcudnn_adv_infer.so.8
/usr/local/cuda-11.8/targets/x86_64-linux/lib/libcudnn_adv_train.so.8
/usr/local/cuda-11.8/targets/x86_64-linux/lib/libcudnn_cnn_infer.so.8
/usr/local/cuda-11.8/targets/x86_64-linux/lib/libcudnn_cnn_train.so.8
/usr/local/cuda-11.8/targets/x86_64-linux/lib/libcudnn_ops_infer.so.8
/usr/local/cuda-11.8/targets/x86_64-linux/lib/libcudnn_ops_train.so.8
HIP runtime version: N/A
MIOpen runtime version: N/A
Is XNNPACK available: True
CPU:
Architecture: x86_64
CPU op-mode(s): 32-bit, 64-bit
Byte Order: Little Endian
Address sizes: 46 bits physical, 48 bits virtual
CPU(s): 48
On-line CPU(s) list: 0-47
Thread(s) per core: 2
Core(s) per socket: 12
Socket(s): 2
NUMA node(s): 2
Vendor ID: GenuineIntel
CPU family: 6
Model: 85
Model name: Intel(R) Xeon(R) Silver 4214R CPU @ 2.40GHz
Stepping: 7
CPU MHz: 1000.055
CPU max MHz: 3500.0000
CPU min MHz: 1000.0000
BogoMIPS: 4800.00
Virtualization: VT-x
L1d cache: 768 KiB
L1i cache: 768 KiB
L2 cache: 24 MiB
L3 cache: 33 MiB
NUMA node0 CPU(s): 0-11,24-35
NUMA node1 CPU(s): 12-23,36-47
Vulnerability Gather data sampling: Mitigation; Microcode
Vulnerability Itlb multihit: KVM: Mitigation: Split huge pages
Vulnerability L1tf: Not affected
Vulnerability Mds: Not affected
Vulnerability Meltdown: Not affected
Vulnerability Mmio stale data: Mitigation; Clear CPU buffers; SMT vulnerable
Vulnerability Retbleed: Mitigation; Enhanced IBRS
Vulnerability Spec store bypass: Mitigation; Speculative Store Bypass disabled via prctl and seccomp
Vulnerability Spectre v1: Mitigation; usercopy/swapgs barriers and __user pointer sanitization
Vulnerability Spectre v2: Mitigation; Enhanced IBRS, IBPB conditional, RSB filling, PBRSB-eIBRS SW sequence
Vulnerability Srbds: Not affected
Vulnerability Tsx async abort: Mitigation; TSX disabled
Flags: fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts acpi mmx fxsr sse sse2 ss ht tm pbe syscall nx pdpe1gb rdtscp lm constant_tsc art arch_perfmon pebs bts rep_good nopl xtopology nonstop_tsc cpuid aperfmperf pni pclmulqdq dtes64 monitor ds_cpl vmx smx est tm2 ssse3 sdbg fma cx16 xtpr pdcm pcid dca sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand lahf_lm abm 3dnowprefetch cpuid_fault epb cat_l3 cdp_l3 invpcid_single intel_ppin ssbd mba ibrs ibpb stibp ibrs_enhanced tpr_shadow vnmi flexpriority ept vpid ept_ad fsgsbase tsc_adjust bmi1 avx2 smep bmi2 erms invpcid cqm mpx rdt_a avx512f avx512dq rdseed adx smap clflushopt clwb intel_pt avx512cd avx512bw avx512vl xsaveopt xsavec xgetbv1 xsaves cqm_llc cqm_occup_llc cqm_mbm_total cqm_mbm_local dtherm ida arat pln pts pku ospke avx512_vnni md_clear flush_l1d arch_capabilities
Versions of relevant libraries:
[pip3] mypy==1.7.1
[pip3] mypy-extensions==1.0.0
[pip3] numpy==1.26.2
[pip3] torch==2.1.1
[pip3] torchvision==0.16.1
[pip3] triton==2.1.0
[conda] blas 2.116 mkl conda-forge
[conda] blas-devel 3.9.0 16_linux64_mkl conda-forge
[conda] libblas 3.9.0 16_linux64_mkl conda-forge
[conda] libcblas 3.9.0 16_linux64_mkl conda-forge
[conda] liblapack 3.9.0 16_linux64_mkl conda-forge
[conda] liblapacke 3.9.0 16_linux64_mkl conda-forge
[conda] mkl 2022.1.0 hc2b9512_224 defaults
[conda] mkl-devel 2022.1.0 h66538d2_224 defaults
[conda] mkl-include 2022.1.0 h06a4308_224 defaults
[conda] numpy 1.26.2 py311h64a7726_0 conda-forge
[conda] pytorch 2.1.1 py3.11_cuda12.1_cudnn8.9.2_0 pytorch
[conda] pytorch-cuda 12.1 ha16c6d3_5 pytorch
[conda] pytorch-mutex 1.0 cuda pytorch
[conda] torchtriton 2.1.0 py311 pytorch
[conda] torchvision 0.16.1 py311_cu121 pytorch
```
--- 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/datasets/kitti.py`
Content:
```
1 import csv
2 import os
3 from typing import Any, Callable, List, Optional, Tuple
4
5 from PIL import Image
6
7 from .utils import download_and_extract_archive
8 from .vision import VisionDataset
9
10
11 class Kitti(VisionDataset):
12 """`KITTI <http://www.cvlibs.net/datasets/kitti/eval_object.php?obj_benchmark>`_ Dataset.
13
14 It corresponds to the "left color images of object" dataset, for object detection.
15
16 Args:
17 root (string): Root directory where images are downloaded to.
18 Expects the following folder structure if download=False:
19
20 .. code::
21
22 <root>
23 └── Kitti
24 └─ raw
25 ├── training
26 | ├── image_2
27 | └── label_2
28 └── testing
29 └── image_2
30 train (bool, optional): Use ``train`` split if true, else ``test`` split.
31 Defaults to ``train``.
32 transform (callable, optional): A function/transform that takes in a PIL image
33 and returns a transformed version. E.g, ``transforms.PILToTensor``
34 target_transform (callable, optional): A function/transform that takes in the
35 target and transforms it.
36 transforms (callable, optional): A function/transform that takes input sample
37 and its target as entry and returns a transformed version.
38 download (bool, optional): If true, downloads the dataset from the internet and
39 puts it in root directory. If dataset is already downloaded, it is not
40 downloaded again.
41
42 """
43
44 data_url = "https://s3.eu-central-1.amazonaws.com/avg-kitti/"
45 resources = [
46 "data_object_image_2.zip",
47 "data_object_label_2.zip",
48 ]
49 image_dir_name = "image_2"
50 labels_dir_name = "label_2"
51
52 def __init__(
53 self,
54 root: str,
55 train: bool = True,
56 transform: Optional[Callable] = None,
57 target_transform: Optional[Callable] = None,
58 transforms: Optional[Callable] = None,
59 download: bool = False,
60 ):
61 super().__init__(
62 root,
63 transform=transform,
64 target_transform=target_transform,
65 transforms=transforms,
66 )
67 self.images = []
68 self.targets = []
69 self.root = root
70 self.train = train
71 self._location = "training" if self.train else "testing"
72
73 if download:
74 self.download()
75 if not self._check_exists():
76 raise RuntimeError("Dataset not found. You may use download=True to download it.")
77
78 image_dir = os.path.join(self._raw_folder, self._location, self.image_dir_name)
79 if self.train:
80 labels_dir = os.path.join(self._raw_folder, self._location, self.labels_dir_name)
81 for img_file in os.listdir(image_dir):
82 self.images.append(os.path.join(image_dir, img_file))
83 if self.train:
84 self.targets.append(os.path.join(labels_dir, f"{img_file.split('.')[0]}.txt"))
85
86 def __getitem__(self, index: int) -> Tuple[Any, Any]:
87 """Get item at a given index.
88
89 Args:
90 index (int): Index
91 Returns:
92 tuple: (image, target), where
93 target is a list of dictionaries with the following keys:
94
95 - type: str
96 - truncated: float
97 - occluded: int
98 - alpha: float
99 - bbox: float[4]
100 - dimensions: float[3]
101 - locations: float[3]
102 - rotation_y: float
103
104 """
105 image = Image.open(self.images[index])
106 target = self._parse_target(index) if self.train else None
107 if self.transforms:
108 image, target = self.transforms(image, target)
109 return image, target
110
111 def _parse_target(self, index: int) -> List:
112 target = []
113 with open(self.targets[index]) as inp:
114 content = csv.reader(inp, delimiter=" ")
115 for line in content:
116 target.append(
117 {
118 "type": line[0],
119 "truncated": float(line[1]),
120 "occluded": int(line[2]),
121 "alpha": float(line[3]),
122 "bbox": [float(x) for x in line[4:8]],
123 "dimensions": [float(x) for x in line[8:11]],
124 "location": [float(x) for x in line[11:14]],
125 "rotation_y": float(line[14]),
126 }
127 )
128 return target
129
130 def __len__(self) -> int:
131 return len(self.images)
132
133 @property
134 def _raw_folder(self) -> str:
135 return os.path.join(self.root, self.__class__.__name__, "raw")
136
137 def _check_exists(self) -> bool:
138 """Check if the data directory exists."""
139 folders = [self.image_dir_name]
140 if self.train:
141 folders.append(self.labels_dir_name)
142 return all(os.path.isdir(os.path.join(self._raw_folder, self._location, fname)) for fname in folders)
143
144 def download(self) -> None:
145 """Download the KITTI data if it doesn't exist already."""
146
147 if self._check_exists():
148 return
149
150 os.makedirs(self._raw_folder, exist_ok=True)
151
152 # download files
153 for fname in self.resources:
154 download_and_extract_archive(
155 url=f"{self.data_url}{fname}",
156 download_root=self._raw_folder,
157 filename=fname,
158 )
159
```
--- 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/datasets/kitti.py b/torchvision/datasets/kitti.py
--- a/torchvision/datasets/kitti.py
+++ b/torchvision/datasets/kitti.py
@@ -66,7 +66,6 @@
)
self.images = []
self.targets = []
- self.root = root
self.train = train
self._location = "training" if self.train else "testing"
| {"golden_diff": "diff --git a/torchvision/datasets/kitti.py b/torchvision/datasets/kitti.py\n--- a/torchvision/datasets/kitti.py\n+++ b/torchvision/datasets/kitti.py\n@@ -66,7 +66,6 @@\n )\n self.images = []\n self.targets = []\n- self.root = root\n self.train = train\n self._location = \"training\" if self.train else \"testing\"\n", "issue": "Bug in `datasets.kitti.Kitti`: `expanduser` operation not performed for `root` parameter\n### **\ud83d\udc1b Describe the bug**\r\nWhen initializing the `torchvision.datasets.kitti.Kitti` class from the torchvision project, the `root` parameter is directly assigned to `self.root` without performing the `expanduser` operation. This behavior leads to an unexpected result in Linux, where using a relative path starting with `~` to specify the dataset location creates a directory named '~' in the program running directory, instead of expanding to the user directory.\r\n\r\n\r\n### **To Reproduce**\r\nYou can use the following code to reproduce this problem.\r\n```python\r\nfrom torchvision.datasets import Kitti\r\n\r\nif __name__ == \"__main__\":\r\n dataset_train = Kitti(\"~/data\", train=True, download=True)\r\n```\r\nAfter running this program, you can see the `'~'` folder in current folder.\r\n<img width=\"189\" src=\"https://github.com/pytorch/vision/assets/39642933/afd31dc1-b711-4f5f-8cc7-e5c0bafb42ce\">\r\n\r\n### **Expected behavior**\r\nThe `root` parameter should be expanded to use the user directory when a relative path starting with `~` is provided. This operation should be handled by the parent class `VisionDataset`.\r\n\r\n\r\n### **Additional context**\r\n\r\nHere is the relevant code snippet from the `Kitti` class:\r\n\r\n```python\r\nclass Kitti(VisionDataset):\r\n ...\r\n def __init__(\r\n self,\r\n root: str,\r\n train: bool = True,\r\n transform: Optional[Callable] = None,\r\n target_transform: Optional[Callable] = None,\r\n transforms: Optional[Callable] = None,\r\n download: bool = False,\r\n ):\r\n super().__init__(\r\n root,\r\n transform=transform,\r\n target_transform=target_transform,\r\n transforms=transforms,\r\n )\r\n self.images = []\r\n self.targets = []\r\n self.root = root # This line should be removed\r\n self.train = train\r\n self._location = \"training\" if self.train else \"testing\"\r\n ...\r\n```\r\nAccording to my preliminary inspection, I did not find similar problems on other datasets. But I'm not that confident in this conclusion.\r\n\r\n### **Suggested Solution**\r\n\r\nThe line `self.root = root` ([line 69](https://github.com/pytorch/vision/blob/44a9beaf0c8b26bb31892c0f1714c84742663ad7/torchvision/datasets/kitti.py#L69C25-L69C25)) in the `Kitti` class should be removed. The `root` parameter should be handled by the parent class `VisionDataset`, which already performs the `expanduser` operation.\r\n\r\n### **Versions**\r\n```\r\nCollecting environment information...\r\nCollecting environment information...\r\nPyTorch version: 2.1.1\r\nIs debug build: False\r\nCUDA used to build PyTorch: 12.1\r\nROCM used to build PyTorch: N/A\r\n\r\nOS: Ubuntu 20.04.6 LTS (x86_64)\r\nGCC version: (Ubuntu 9.4.0-1ubuntu1~20.04.2) 9.4.0\r\nClang version: Could not collect\r\nCMake version: Could not collect\r\nLibc version: glibc-2.31\r\n\r\nPython version: 3.11.6 | packaged by conda-forge | (main, Oct 3 2023, 10:40:35) [GCC 12.3.0] (64-bit runtime)\r\nPython platform: Linux-5.4.0-162-generic-x86_64-with-glibc2.31\r\nIs CUDA available: True\r\nCUDA runtime version: 10.1.243\r\nCUDA_MODULE_LOADING set to: LAZY\r\nGPU models and configuration: \r\nGPU 0: NVIDIA GeForce RTX 3090\r\nGPU 1: NVIDIA GeForce RTX 3090\r\nGPU 2: NVIDIA GeForce RTX 3090\r\nGPU 3: NVIDIA GeForce RTX 3090\r\n\r\nNvidia driver version: 525.89.02\r\ncuDNN version: Probably one of the following:\r\n/usr/local/cuda-11.8/targets/x86_64-linux/lib/libcudnn.so.8\r\n/usr/local/cuda-11.8/targets/x86_64-linux/lib/libcudnn_adv_infer.so.8\r\n/usr/local/cuda-11.8/targets/x86_64-linux/lib/libcudnn_adv_train.so.8\r\n/usr/local/cuda-11.8/targets/x86_64-linux/lib/libcudnn_cnn_infer.so.8\r\n/usr/local/cuda-11.8/targets/x86_64-linux/lib/libcudnn_cnn_train.so.8\r\n/usr/local/cuda-11.8/targets/x86_64-linux/lib/libcudnn_ops_infer.so.8\r\n/usr/local/cuda-11.8/targets/x86_64-linux/lib/libcudnn_ops_train.so.8\r\nHIP runtime version: N/A\r\nMIOpen runtime version: N/A\r\nIs XNNPACK available: True\r\n\r\nCPU:\r\nArchitecture: x86_64\r\nCPU op-mode(s): 32-bit, 64-bit\r\nByte Order: Little Endian\r\nAddress sizes: 46 bits physical, 48 bits virtual\r\nCPU(s): 48\r\nOn-line CPU(s) list: 0-47\r\nThread(s) per core: 2\r\nCore(s) per socket: 12\r\nSocket(s): 2\r\nNUMA node(s): 2\r\nVendor ID: GenuineIntel\r\nCPU family: 6\r\nModel: 85\r\nModel name: Intel(R) Xeon(R) Silver 4214R CPU @ 2.40GHz\r\nStepping: 7\r\nCPU MHz: 1000.055\r\nCPU max MHz: 3500.0000\r\nCPU min MHz: 1000.0000\r\nBogoMIPS: 4800.00\r\nVirtualization: VT-x\r\nL1d cache: 768 KiB\r\nL1i cache: 768 KiB\r\nL2 cache: 24 MiB\r\nL3 cache: 33 MiB\r\nNUMA node0 CPU(s): 0-11,24-35\r\nNUMA node1 CPU(s): 12-23,36-47\r\nVulnerability Gather data sampling: Mitigation; Microcode\r\nVulnerability Itlb multihit: KVM: Mitigation: Split huge pages\r\nVulnerability L1tf: Not affected\r\nVulnerability Mds: Not affected\r\nVulnerability Meltdown: Not affected\r\nVulnerability Mmio stale data: Mitigation; Clear CPU buffers; SMT vulnerable\r\nVulnerability Retbleed: Mitigation; Enhanced IBRS\r\nVulnerability Spec store bypass: Mitigation; Speculative Store Bypass disabled via prctl and seccomp\r\nVulnerability Spectre v1: Mitigation; usercopy/swapgs barriers and __user pointer sanitization\r\nVulnerability Spectre v2: Mitigation; Enhanced IBRS, IBPB conditional, RSB filling, PBRSB-eIBRS SW sequence\r\nVulnerability Srbds: Not affected\r\nVulnerability Tsx async abort: Mitigation; TSX disabled\r\nFlags: fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts acpi mmx fxsr sse sse2 ss ht tm pbe syscall nx pdpe1gb rdtscp lm constant_tsc art arch_perfmon pebs bts rep_good nopl xtopology nonstop_tsc cpuid aperfmperf pni pclmulqdq dtes64 monitor ds_cpl vmx smx est tm2 ssse3 sdbg fma cx16 xtpr pdcm pcid dca sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand lahf_lm abm 3dnowprefetch cpuid_fault epb cat_l3 cdp_l3 invpcid_single intel_ppin ssbd mba ibrs ibpb stibp ibrs_enhanced tpr_shadow vnmi flexpriority ept vpid ept_ad fsgsbase tsc_adjust bmi1 avx2 smep bmi2 erms invpcid cqm mpx rdt_a avx512f avx512dq rdseed adx smap clflushopt clwb intel_pt avx512cd avx512bw avx512vl xsaveopt xsavec xgetbv1 xsaves cqm_llc cqm_occup_llc cqm_mbm_total cqm_mbm_local dtherm ida arat pln pts pku ospke avx512_vnni md_clear flush_l1d arch_capabilities\r\n\r\nVersions of relevant libraries:\r\n[pip3] mypy==1.7.1\r\n[pip3] mypy-extensions==1.0.0\r\n[pip3] numpy==1.26.2\r\n[pip3] torch==2.1.1\r\n[pip3] torchvision==0.16.1\r\n[pip3] triton==2.1.0\r\n[conda] blas 2.116 mkl conda-forge\r\n[conda] blas-devel 3.9.0 16_linux64_mkl conda-forge\r\n[conda] libblas 3.9.0 16_linux64_mkl conda-forge\r\n[conda] libcblas 3.9.0 16_linux64_mkl conda-forge\r\n[conda] liblapack 3.9.0 16_linux64_mkl conda-forge\r\n[conda] liblapacke 3.9.0 16_linux64_mkl conda-forge\r\n[conda] mkl 2022.1.0 hc2b9512_224 defaults\r\n[conda] mkl-devel 2022.1.0 h66538d2_224 defaults\r\n[conda] mkl-include 2022.1.0 h06a4308_224 defaults\r\n[conda] numpy 1.26.2 py311h64a7726_0 conda-forge\r\n[conda] pytorch 2.1.1 py3.11_cuda12.1_cudnn8.9.2_0 pytorch\r\n[conda] pytorch-cuda 12.1 ha16c6d3_5 pytorch\r\n[conda] pytorch-mutex 1.0 cuda pytorch\r\n[conda] torchtriton 2.1.0 py311 pytorch\r\n[conda] torchvision 0.16.1 py311_cu121 pytorch\r\n```\n", "before_files": [{"content": "import csv\nimport os\nfrom typing import Any, Callable, List, Optional, Tuple\n\nfrom PIL import Image\n\nfrom .utils import download_and_extract_archive\nfrom .vision import VisionDataset\n\n\nclass Kitti(VisionDataset):\n \"\"\"`KITTI <http://www.cvlibs.net/datasets/kitti/eval_object.php?obj_benchmark>`_ Dataset.\n\n It corresponds to the \"left color images of object\" dataset, for object detection.\n\n Args:\n root (string): Root directory where images are downloaded to.\n Expects the following folder structure if download=False:\n\n .. code::\n\n <root>\n \u2514\u2500\u2500 Kitti\n \u2514\u2500 raw\n \u251c\u2500\u2500 training\n | \u251c\u2500\u2500 image_2\n | \u2514\u2500\u2500 label_2\n \u2514\u2500\u2500 testing\n \u2514\u2500\u2500 image_2\n train (bool, optional): Use ``train`` split if true, else ``test`` split.\n Defaults to ``train``.\n transform (callable, optional): A function/transform that takes in a PIL image\n and returns a transformed version. E.g, ``transforms.PILToTensor``\n target_transform (callable, optional): A function/transform that takes in the\n target and transforms it.\n transforms (callable, optional): A function/transform that takes input sample\n and its target as entry and returns a transformed version.\n download (bool, optional): If true, downloads the dataset from the internet and\n puts it in root directory. If dataset is already downloaded, it is not\n downloaded again.\n\n \"\"\"\n\n data_url = \"https://s3.eu-central-1.amazonaws.com/avg-kitti/\"\n resources = [\n \"data_object_image_2.zip\",\n \"data_object_label_2.zip\",\n ]\n image_dir_name = \"image_2\"\n labels_dir_name = \"label_2\"\n\n def __init__(\n self,\n root: str,\n train: bool = True,\n transform: Optional[Callable] = None,\n target_transform: Optional[Callable] = None,\n transforms: Optional[Callable] = None,\n download: bool = False,\n ):\n super().__init__(\n root,\n transform=transform,\n target_transform=target_transform,\n transforms=transforms,\n )\n self.images = []\n self.targets = []\n self.root = root\n self.train = train\n self._location = \"training\" if self.train else \"testing\"\n\n if download:\n self.download()\n if not self._check_exists():\n raise RuntimeError(\"Dataset not found. You may use download=True to download it.\")\n\n image_dir = os.path.join(self._raw_folder, self._location, self.image_dir_name)\n if self.train:\n labels_dir = os.path.join(self._raw_folder, self._location, self.labels_dir_name)\n for img_file in os.listdir(image_dir):\n self.images.append(os.path.join(image_dir, img_file))\n if self.train:\n self.targets.append(os.path.join(labels_dir, f\"{img_file.split('.')[0]}.txt\"))\n\n def __getitem__(self, index: int) -> Tuple[Any, Any]:\n \"\"\"Get item at a given index.\n\n Args:\n index (int): Index\n Returns:\n tuple: (image, target), where\n target is a list of dictionaries with the following keys:\n\n - type: str\n - truncated: float\n - occluded: int\n - alpha: float\n - bbox: float[4]\n - dimensions: float[3]\n - locations: float[3]\n - rotation_y: float\n\n \"\"\"\n image = Image.open(self.images[index])\n target = self._parse_target(index) if self.train else None\n if self.transforms:\n image, target = self.transforms(image, target)\n return image, target\n\n def _parse_target(self, index: int) -> List:\n target = []\n with open(self.targets[index]) as inp:\n content = csv.reader(inp, delimiter=\" \")\n for line in content:\n target.append(\n {\n \"type\": line[0],\n \"truncated\": float(line[1]),\n \"occluded\": int(line[2]),\n \"alpha\": float(line[3]),\n \"bbox\": [float(x) for x in line[4:8]],\n \"dimensions\": [float(x) for x in line[8:11]],\n \"location\": [float(x) for x in line[11:14]],\n \"rotation_y\": float(line[14]),\n }\n )\n return target\n\n def __len__(self) -> int:\n return len(self.images)\n\n @property\n def _raw_folder(self) -> str:\n return os.path.join(self.root, self.__class__.__name__, \"raw\")\n\n def _check_exists(self) -> bool:\n \"\"\"Check if the data directory exists.\"\"\"\n folders = [self.image_dir_name]\n if self.train:\n folders.append(self.labels_dir_name)\n return all(os.path.isdir(os.path.join(self._raw_folder, self._location, fname)) for fname in folders)\n\n def download(self) -> None:\n \"\"\"Download the KITTI data if it doesn't exist already.\"\"\"\n\n if self._check_exists():\n return\n\n os.makedirs(self._raw_folder, exist_ok=True)\n\n # download files\n for fname in self.resources:\n download_and_extract_archive(\n url=f\"{self.data_url}{fname}\",\n download_root=self._raw_folder,\n filename=fname,\n )\n", "path": "torchvision/datasets/kitti.py"}], "after_files": [{"content": "import csv\nimport os\nfrom typing import Any, Callable, List, Optional, Tuple\n\nfrom PIL import Image\n\nfrom .utils import download_and_extract_archive\nfrom .vision import VisionDataset\n\n\nclass Kitti(VisionDataset):\n \"\"\"`KITTI <http://www.cvlibs.net/datasets/kitti/eval_object.php?obj_benchmark>`_ Dataset.\n\n It corresponds to the \"left color images of object\" dataset, for object detection.\n\n Args:\n root (string): Root directory where images are downloaded to.\n Expects the following folder structure if download=False:\n\n .. code::\n\n <root>\n \u2514\u2500\u2500 Kitti\n \u2514\u2500 raw\n \u251c\u2500\u2500 training\n | \u251c\u2500\u2500 image_2\n | \u2514\u2500\u2500 label_2\n \u2514\u2500\u2500 testing\n \u2514\u2500\u2500 image_2\n train (bool, optional): Use ``train`` split if true, else ``test`` split.\n Defaults to ``train``.\n transform (callable, optional): A function/transform that takes in a PIL image\n and returns a transformed version. E.g, ``transforms.PILToTensor``\n target_transform (callable, optional): A function/transform that takes in the\n target and transforms it.\n transforms (callable, optional): A function/transform that takes input sample\n and its target as entry and returns a transformed version.\n download (bool, optional): If true, downloads the dataset from the internet and\n puts it in root directory. If dataset is already downloaded, it is not\n downloaded again.\n\n \"\"\"\n\n data_url = \"https://s3.eu-central-1.amazonaws.com/avg-kitti/\"\n resources = [\n \"data_object_image_2.zip\",\n \"data_object_label_2.zip\",\n ]\n image_dir_name = \"image_2\"\n labels_dir_name = \"label_2\"\n\n def __init__(\n self,\n root: str,\n train: bool = True,\n transform: Optional[Callable] = None,\n target_transform: Optional[Callable] = None,\n transforms: Optional[Callable] = None,\n download: bool = False,\n ):\n super().__init__(\n root,\n transform=transform,\n target_transform=target_transform,\n transforms=transforms,\n )\n self.images = []\n self.targets = []\n self.train = train\n self._location = \"training\" if self.train else \"testing\"\n\n if download:\n self.download()\n if not self._check_exists():\n raise RuntimeError(\"Dataset not found. You may use download=True to download it.\")\n\n image_dir = os.path.join(self._raw_folder, self._location, self.image_dir_name)\n if self.train:\n labels_dir = os.path.join(self._raw_folder, self._location, self.labels_dir_name)\n for img_file in os.listdir(image_dir):\n self.images.append(os.path.join(image_dir, img_file))\n if self.train:\n self.targets.append(os.path.join(labels_dir, f\"{img_file.split('.')[0]}.txt\"))\n\n def __getitem__(self, index: int) -> Tuple[Any, Any]:\n \"\"\"Get item at a given index.\n\n Args:\n index (int): Index\n Returns:\n tuple: (image, target), where\n target is a list of dictionaries with the following keys:\n\n - type: str\n - truncated: float\n - occluded: int\n - alpha: float\n - bbox: float[4]\n - dimensions: float[3]\n - locations: float[3]\n - rotation_y: float\n\n \"\"\"\n image = Image.open(self.images[index])\n target = self._parse_target(index) if self.train else None\n if self.transforms:\n image, target = self.transforms(image, target)\n return image, target\n\n def _parse_target(self, index: int) -> List:\n target = []\n with open(self.targets[index]) as inp:\n content = csv.reader(inp, delimiter=\" \")\n for line in content:\n target.append(\n {\n \"type\": line[0],\n \"truncated\": float(line[1]),\n \"occluded\": int(line[2]),\n \"alpha\": float(line[3]),\n \"bbox\": [float(x) for x in line[4:8]],\n \"dimensions\": [float(x) for x in line[8:11]],\n \"location\": [float(x) for x in line[11:14]],\n \"rotation_y\": float(line[14]),\n }\n )\n return target\n\n def __len__(self) -> int:\n return len(self.images)\n\n @property\n def _raw_folder(self) -> str:\n return os.path.join(self.root, self.__class__.__name__, \"raw\")\n\n def _check_exists(self) -> bool:\n \"\"\"Check if the data directory exists.\"\"\"\n folders = [self.image_dir_name]\n if self.train:\n folders.append(self.labels_dir_name)\n return all(os.path.isdir(os.path.join(self._raw_folder, self._location, fname)) for fname in folders)\n\n def download(self) -> None:\n \"\"\"Download the KITTI data if it doesn't exist already.\"\"\"\n\n if self._check_exists():\n return\n\n os.makedirs(self._raw_folder, exist_ok=True)\n\n # download files\n for fname in self.resources:\n download_and_extract_archive(\n url=f\"{self.data_url}{fname}\",\n download_root=self._raw_folder,\n filename=fname,\n )\n", "path": "torchvision/datasets/kitti.py"}]} |
gh_patches_debug_299 | rasdani/github-patches | git_diff | pypi__warehouse-3130 | We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Change "Edit" to "Manage" in "Your Projects"
Change the button/link text "Edit" to "Manage" in "Your Projects".
From IRC conversation with @alanbato, @ewdurbin and @nlhkabu .
~~~
<EWDurbin> I think perhaps “Manage” might be a better name for the button that currently says “Edit"
<EWDurbin> Just right off the bat. Since well you can’t really Edit anything, just delete files/releases/projects
<di_codes> ^ agreed
<alanbato> Makes sense to me, Edit misguides people into thinking they can change project attributes imho
<nlh> yep 100% agree
<sumanah> nlh: and I agree with them but I want to hear your thoughts -- you're the one who's done user testing, so do you think people would understand "manage"?
<nlh> i'll open a PR :)
<nlh> yes
<sumanah> thanks nlh!
<nlh> it's also more consistent with the URL structure
~~~
But I do not see a pull request from Nicole yet, so I declare this a:
**Good First Issue**: This issue is good for first time contributors. If there is not a corresponding pull request for this issue, it is up for grabs. For directions for getting set up, see our [Getting Started Guide](https://warehouse.pypa.io/development/getting-started/). If you are working on this issue and have questions, please feel free to ask them here, in [`#pypa-dev` on Freenode](https://webchat.freenode.net/?channels=%23pypa-dev), or on the [pypa-dev mailing list](https://groups.google.com/forum/#!forum/pypa-dev).
Fix for #3118
Fixes #3118.
Updated the projects.html and the relating sass snippet to show **manage** in stead of **edit** when in **Your projects**.
--- END ISSUE ---
Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `warehouse/packaging/views.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 from first import first
14 from pyramid.httpexceptions import HTTPMovedPermanently, HTTPNotFound
15 from pyramid.view import view_config
16 from sqlalchemy.orm.exc import NoResultFound
17
18 from warehouse.accounts.models import User
19 from warehouse.cache.origin import origin_cache
20 from warehouse.packaging.models import Release, Role
21
22
23 @view_config(
24 route_name="packaging.project",
25 renderer="packaging/detail.html",
26 decorator=[
27 origin_cache(
28 1 * 24 * 60 * 60, # 1 day
29 stale_while_revalidate=1 * 24 * 60 * 60, # 1 day
30 stale_if_error=5 * 24 * 60 * 60, # 5 days
31 ),
32 ],
33 )
34 def project_detail(project, request):
35 if project.name != request.matchdict.get("name", project.name):
36 return HTTPMovedPermanently(
37 request.current_route_path(name=project.name),
38 )
39
40 try:
41 release = (
42 request.db.query(Release)
43 .filter(Release.project == project)
44 .order_by(
45 Release.is_prerelease.nullslast(),
46 Release._pypi_ordering.desc())
47 .limit(1)
48 .one()
49 )
50 except NoResultFound:
51 return HTTPNotFound()
52
53 return release_detail(release, request)
54
55
56 @view_config(
57 route_name="packaging.release",
58 renderer="packaging/detail.html",
59 decorator=[
60 origin_cache(
61 1 * 24 * 60 * 60, # 1 day
62 stale_while_revalidate=1 * 24 * 60 * 60, # 1 day
63 stale_if_error=5 * 24 * 60 * 60, # 5 days
64 ),
65 ],
66 )
67 def release_detail(release, request):
68 project = release.project
69
70 if not {project.name, release.version} <= set(request.matchdict.values()):
71 return HTTPMovedPermanently(
72 request.current_route_path(
73 name=project.name, version=release.version,
74 ),
75 )
76
77 # Get all of the registered versions for this Project, in order of newest
78 # to oldest.
79 all_releases = (
80 request.db.query(Release)
81 .filter(Release.project == project)
82 .with_entities(
83 Release.version,
84 Release.is_prerelease,
85 Release.created)
86 .order_by(Release._pypi_ordering.desc())
87 .all()
88 )
89
90 # Get the latest non-prerelease of this Project, or the latest release if
91 # all releases are prereleases.
92 latest_release = first(
93 all_releases,
94 key=lambda r: not r.is_prerelease,
95 default=all_releases[0],
96 )
97
98 # Get all of the maintainers for this project.
99 maintainers = [
100 r.user
101 for r in (
102 request.db.query(Role)
103 .join(User)
104 .filter(Role.project == project)
105 .distinct(User.username)
106 .order_by(User.username)
107 .all()
108 )
109 ]
110
111 # Get the license from the classifiers or metadata, preferring classifiers.
112 license = None
113 if release.license:
114 # Make a best effort when the entire license text is given
115 # by using the first line only.
116 license = release.license.split('\n')[0]
117 license_classifiers = [c.split(" :: ")[-1] for c in release.classifiers
118 if c.startswith("License")]
119 if license_classifiers:
120 license = ', '.join(license_classifiers)
121
122 return {
123 "project": project,
124 "release": release,
125 "files": release.files.all(),
126 "latest_release": latest_release,
127 "all_releases": all_releases,
128 "maintainers": maintainers,
129 "license": license,
130 }
131
132
133 @view_config(
134 route_name="includes.edit-project-button",
135 renderer="includes/edit-project-button.html",
136 uses_session=True,
137 permission="manage",
138 )
139 def edit_project_button(project, request):
140 return {'project': project}
141
```
--- 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/warehouse/packaging/views.py b/warehouse/packaging/views.py
--- a/warehouse/packaging/views.py
+++ b/warehouse/packaging/views.py
@@ -132,7 +132,7 @@
@view_config(
route_name="includes.edit-project-button",
- renderer="includes/edit-project-button.html",
+ renderer="includes/manage-project-button.html",
uses_session=True,
permission="manage",
)
| {"golden_diff": "diff --git a/warehouse/packaging/views.py b/warehouse/packaging/views.py\n--- a/warehouse/packaging/views.py\n+++ b/warehouse/packaging/views.py\n@@ -132,7 +132,7 @@\n \n @view_config(\n route_name=\"includes.edit-project-button\",\n- renderer=\"includes/edit-project-button.html\",\n+ renderer=\"includes/manage-project-button.html\",\n uses_session=True,\n permission=\"manage\",\n )\n", "issue": "Change \"Edit\" to \"Manage\" in \"Your Projects\"\nChange the button/link text \"Edit\" to \"Manage\" in \"Your Projects\".\r\n\r\nFrom IRC conversation with @alanbato, @ewdurbin and @nlhkabu .\r\n\r\n~~~\r\n<EWDurbin> I think perhaps \u201cManage\u201d might be a better name for the button that currently says \u201cEdit\"\r\n<EWDurbin> Just right off the bat. Since well you can\u2019t really Edit anything, just delete files/releases/projects\r\n<di_codes> ^ agreed\r\n<alanbato> Makes sense to me, Edit misguides people into thinking they can change project attributes imho\r\n<nlh> yep 100% agree\r\n<sumanah> nlh: and I agree with them but I want to hear your thoughts -- you're the one who's done user testing, so do you think people would understand \"manage\"?\r\n<nlh> i'll open a PR :)\r\n<nlh> yes\r\n<sumanah> thanks nlh!\r\n<nlh> it's also more consistent with the URL structure\r\n~~~\r\n\r\nBut I do not see a pull request from Nicole yet, so I declare this a:\r\n\r\n**Good First Issue**: This issue is good for first time contributors. If there is not a corresponding pull request for this issue, it is up for grabs. For directions for getting set up, see our [Getting Started Guide](https://warehouse.pypa.io/development/getting-started/). If you are working on this issue and have questions, please feel free to ask them here, in [`#pypa-dev` on Freenode](https://webchat.freenode.net/?channels=%23pypa-dev), or on the [pypa-dev mailing list](https://groups.google.com/forum/#!forum/pypa-dev).\nFix for #3118\nFixes #3118.\r\n\r\nUpdated the projects.html and the relating sass snippet to show **manage** in stead of **edit** when in **Your projects**.\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\nfrom first import first\nfrom pyramid.httpexceptions import HTTPMovedPermanently, HTTPNotFound\nfrom pyramid.view import view_config\nfrom sqlalchemy.orm.exc import NoResultFound\n\nfrom warehouse.accounts.models import User\nfrom warehouse.cache.origin import origin_cache\nfrom warehouse.packaging.models import Release, Role\n\n\n@view_config(\n route_name=\"packaging.project\",\n renderer=\"packaging/detail.html\",\n decorator=[\n origin_cache(\n 1 * 24 * 60 * 60, # 1 day\n stale_while_revalidate=1 * 24 * 60 * 60, # 1 day\n stale_if_error=5 * 24 * 60 * 60, # 5 days\n ),\n ],\n)\ndef project_detail(project, request):\n if project.name != request.matchdict.get(\"name\", project.name):\n return HTTPMovedPermanently(\n request.current_route_path(name=project.name),\n )\n\n try:\n release = (\n request.db.query(Release)\n .filter(Release.project == project)\n .order_by(\n Release.is_prerelease.nullslast(),\n Release._pypi_ordering.desc())\n .limit(1)\n .one()\n )\n except NoResultFound:\n return HTTPNotFound()\n\n return release_detail(release, request)\n\n\n@view_config(\n route_name=\"packaging.release\",\n renderer=\"packaging/detail.html\",\n decorator=[\n origin_cache(\n 1 * 24 * 60 * 60, # 1 day\n stale_while_revalidate=1 * 24 * 60 * 60, # 1 day\n stale_if_error=5 * 24 * 60 * 60, # 5 days\n ),\n ],\n)\ndef release_detail(release, request):\n project = release.project\n\n if not {project.name, release.version} <= set(request.matchdict.values()):\n return HTTPMovedPermanently(\n request.current_route_path(\n name=project.name, version=release.version,\n ),\n )\n\n # Get all of the registered versions for this Project, in order of newest\n # to oldest.\n all_releases = (\n request.db.query(Release)\n .filter(Release.project == project)\n .with_entities(\n Release.version,\n Release.is_prerelease,\n Release.created)\n .order_by(Release._pypi_ordering.desc())\n .all()\n )\n\n # Get the latest non-prerelease of this Project, or the latest release if\n # all releases are prereleases.\n latest_release = first(\n all_releases,\n key=lambda r: not r.is_prerelease,\n default=all_releases[0],\n )\n\n # Get all of the maintainers for this project.\n maintainers = [\n r.user\n for r in (\n request.db.query(Role)\n .join(User)\n .filter(Role.project == project)\n .distinct(User.username)\n .order_by(User.username)\n .all()\n )\n ]\n\n # Get the license from the classifiers or metadata, preferring classifiers.\n license = None\n if release.license:\n # Make a best effort when the entire license text is given\n # by using the first line only.\n license = release.license.split('\\n')[0]\n license_classifiers = [c.split(\" :: \")[-1] for c in release.classifiers\n if c.startswith(\"License\")]\n if license_classifiers:\n license = ', '.join(license_classifiers)\n\n return {\n \"project\": project,\n \"release\": release,\n \"files\": release.files.all(),\n \"latest_release\": latest_release,\n \"all_releases\": all_releases,\n \"maintainers\": maintainers,\n \"license\": license,\n }\n\n\n@view_config(\n route_name=\"includes.edit-project-button\",\n renderer=\"includes/edit-project-button.html\",\n uses_session=True,\n permission=\"manage\",\n)\ndef edit_project_button(project, request):\n return {'project': project}\n", "path": "warehouse/packaging/views.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\nfrom first import first\nfrom pyramid.httpexceptions import HTTPMovedPermanently, HTTPNotFound\nfrom pyramid.view import view_config\nfrom sqlalchemy.orm.exc import NoResultFound\n\nfrom warehouse.accounts.models import User\nfrom warehouse.cache.origin import origin_cache\nfrom warehouse.packaging.models import Release, Role\n\n\n@view_config(\n route_name=\"packaging.project\",\n renderer=\"packaging/detail.html\",\n decorator=[\n origin_cache(\n 1 * 24 * 60 * 60, # 1 day\n stale_while_revalidate=1 * 24 * 60 * 60, # 1 day\n stale_if_error=5 * 24 * 60 * 60, # 5 days\n ),\n ],\n)\ndef project_detail(project, request):\n if project.name != request.matchdict.get(\"name\", project.name):\n return HTTPMovedPermanently(\n request.current_route_path(name=project.name),\n )\n\n try:\n release = (\n request.db.query(Release)\n .filter(Release.project == project)\n .order_by(\n Release.is_prerelease.nullslast(),\n Release._pypi_ordering.desc())\n .limit(1)\n .one()\n )\n except NoResultFound:\n return HTTPNotFound()\n\n return release_detail(release, request)\n\n\n@view_config(\n route_name=\"packaging.release\",\n renderer=\"packaging/detail.html\",\n decorator=[\n origin_cache(\n 1 * 24 * 60 * 60, # 1 day\n stale_while_revalidate=1 * 24 * 60 * 60, # 1 day\n stale_if_error=5 * 24 * 60 * 60, # 5 days\n ),\n ],\n)\ndef release_detail(release, request):\n project = release.project\n\n if not {project.name, release.version} <= set(request.matchdict.values()):\n return HTTPMovedPermanently(\n request.current_route_path(\n name=project.name, version=release.version,\n ),\n )\n\n # Get all of the registered versions for this Project, in order of newest\n # to oldest.\n all_releases = (\n request.db.query(Release)\n .filter(Release.project == project)\n .with_entities(\n Release.version,\n Release.is_prerelease,\n Release.created)\n .order_by(Release._pypi_ordering.desc())\n .all()\n )\n\n # Get the latest non-prerelease of this Project, or the latest release if\n # all releases are prereleases.\n latest_release = first(\n all_releases,\n key=lambda r: not r.is_prerelease,\n default=all_releases[0],\n )\n\n # Get all of the maintainers for this project.\n maintainers = [\n r.user\n for r in (\n request.db.query(Role)\n .join(User)\n .filter(Role.project == project)\n .distinct(User.username)\n .order_by(User.username)\n .all()\n )\n ]\n\n # Get the license from the classifiers or metadata, preferring classifiers.\n license = None\n if release.license:\n # Make a best effort when the entire license text is given\n # by using the first line only.\n license = release.license.split('\\n')[0]\n license_classifiers = [c.split(\" :: \")[-1] for c in release.classifiers\n if c.startswith(\"License\")]\n if license_classifiers:\n license = ', '.join(license_classifiers)\n\n return {\n \"project\": project,\n \"release\": release,\n \"files\": release.files.all(),\n \"latest_release\": latest_release,\n \"all_releases\": all_releases,\n \"maintainers\": maintainers,\n \"license\": license,\n }\n\n\n@view_config(\n route_name=\"includes.edit-project-button\",\n renderer=\"includes/manage-project-button.html\",\n uses_session=True,\n permission=\"manage\",\n)\ndef edit_project_button(project, request):\n return {'project': project}\n", "path": "warehouse/packaging/views.py"}]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.