repository_name
stringlengths 7
55
| func_path_in_repository
stringlengths 4
223
| func_name
stringlengths 1
134
| whole_func_string
stringlengths 75
104k
| language
stringclasses 1
value | func_code_string
stringlengths 75
104k
| func_code_tokens
listlengths 19
28.4k
| func_documentation_string
stringlengths 1
46.9k
| func_documentation_tokens
listlengths 1
1.97k
| split_name
stringclasses 1
value | func_code_url
stringlengths 87
315
|
|---|---|---|---|---|---|---|---|---|---|---|
rfosterslo/wagtailplus
|
wagtailplus/wagtailrelations/models.py
|
EntryManager.get_for_tag
|
def get_for_tag(self, tag):
"""
Returns queryset of Entry instances assigned to specified
tag, which can be a PK value, a slug value, or a Tag instance.
:param tag: tag PK, slug, or instance.
:rtype: django.db.models.query.QuerySet.
"""
tag_filter = {'tag': tag}
if isinstance(tag, six.integer_types):
tag_filter = {'tag_id': tag}
elif isinstance(tag, str):
tag_filter = {'tag__slug': tag}
return self.filter(id__in=[
entry_tag.entry_id
for entry_tag
in EntryTag.objects.filter(**tag_filter)
])
|
python
|
def get_for_tag(self, tag):
"""
Returns queryset of Entry instances assigned to specified
tag, which can be a PK value, a slug value, or a Tag instance.
:param tag: tag PK, slug, or instance.
:rtype: django.db.models.query.QuerySet.
"""
tag_filter = {'tag': tag}
if isinstance(tag, six.integer_types):
tag_filter = {'tag_id': tag}
elif isinstance(tag, str):
tag_filter = {'tag__slug': tag}
return self.filter(id__in=[
entry_tag.entry_id
for entry_tag
in EntryTag.objects.filter(**tag_filter)
])
|
[
"def",
"get_for_tag",
"(",
"self",
",",
"tag",
")",
":",
"tag_filter",
"=",
"{",
"'tag'",
":",
"tag",
"}",
"if",
"isinstance",
"(",
"tag",
",",
"six",
".",
"integer_types",
")",
":",
"tag_filter",
"=",
"{",
"'tag_id'",
":",
"tag",
"}",
"elif",
"isinstance",
"(",
"tag",
",",
"str",
")",
":",
"tag_filter",
"=",
"{",
"'tag__slug'",
":",
"tag",
"}",
"return",
"self",
".",
"filter",
"(",
"id__in",
"=",
"[",
"entry_tag",
".",
"entry_id",
"for",
"entry_tag",
"in",
"EntryTag",
".",
"objects",
".",
"filter",
"(",
"*",
"*",
"tag_filter",
")",
"]",
")"
] |
Returns queryset of Entry instances assigned to specified
tag, which can be a PK value, a slug value, or a Tag instance.
:param tag: tag PK, slug, or instance.
:rtype: django.db.models.query.QuerySet.
|
[
"Returns",
"queryset",
"of",
"Entry",
"instances",
"assigned",
"to",
"specified",
"tag",
"which",
"can",
"be",
"a",
"PK",
"value",
"a",
"slug",
"value",
"or",
"a",
"Tag",
"instance",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/wagtailrelations/models.py#L132-L151
|
rfosterslo/wagtailplus
|
wagtailplus/wagtailrelations/models.py
|
EntryTagManager.for_category
|
def for_category(self, category, live_only=False):
"""
Returns queryset of EntryTag instances for specified category.
:param category: the Category instance.
:param live_only: flag to include only "live" entries.
:rtype: django.db.models.query.QuerySet.
"""
filters = {'tag': category.tag}
if live_only:
filters.update({'entry__live': True})
return self.filter(**filters)
|
python
|
def for_category(self, category, live_only=False):
"""
Returns queryset of EntryTag instances for specified category.
:param category: the Category instance.
:param live_only: flag to include only "live" entries.
:rtype: django.db.models.query.QuerySet.
"""
filters = {'tag': category.tag}
if live_only:
filters.update({'entry__live': True})
return self.filter(**filters)
|
[
"def",
"for_category",
"(",
"self",
",",
"category",
",",
"live_only",
"=",
"False",
")",
":",
"filters",
"=",
"{",
"'tag'",
":",
"category",
".",
"tag",
"}",
"if",
"live_only",
":",
"filters",
".",
"update",
"(",
"{",
"'entry__live'",
":",
"True",
"}",
")",
"return",
"self",
".",
"filter",
"(",
"*",
"*",
"filters",
")"
] |
Returns queryset of EntryTag instances for specified category.
:param category: the Category instance.
:param live_only: flag to include only "live" entries.
:rtype: django.db.models.query.QuerySet.
|
[
"Returns",
"queryset",
"of",
"EntryTag",
"instances",
"for",
"specified",
"category",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/wagtailrelations/models.py#L343-L356
|
rfosterslo/wagtailplus
|
wagtailplus/wagtailrelations/models.py
|
EntryTagManager.related_to
|
def related_to(self, entry, live_only=False):
"""
Returns queryset of Entry instances related to specified
Entry instance.
:param entry: the Entry instance.
:param live_only: flag to include only "live" entries.
:rtype: django.db.models.query.QuerySet.
"""
filters = {'tag__in': entry.tags}
if live_only:
filters.update({'entry__live': True})
return self.filter(**filters).exclude(entry=entry)
|
python
|
def related_to(self, entry, live_only=False):
"""
Returns queryset of Entry instances related to specified
Entry instance.
:param entry: the Entry instance.
:param live_only: flag to include only "live" entries.
:rtype: django.db.models.query.QuerySet.
"""
filters = {'tag__in': entry.tags}
if live_only:
filters.update({'entry__live': True})
return self.filter(**filters).exclude(entry=entry)
|
[
"def",
"related_to",
"(",
"self",
",",
"entry",
",",
"live_only",
"=",
"False",
")",
":",
"filters",
"=",
"{",
"'tag__in'",
":",
"entry",
".",
"tags",
"}",
"if",
"live_only",
":",
"filters",
".",
"update",
"(",
"{",
"'entry__live'",
":",
"True",
"}",
")",
"return",
"self",
".",
"filter",
"(",
"*",
"*",
"filters",
")",
".",
"exclude",
"(",
"entry",
"=",
"entry",
")"
] |
Returns queryset of Entry instances related to specified
Entry instance.
:param entry: the Entry instance.
:param live_only: flag to include only "live" entries.
:rtype: django.db.models.query.QuerySet.
|
[
"Returns",
"queryset",
"of",
"Entry",
"instances",
"related",
"to",
"specified",
"Entry",
"instance",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/wagtailrelations/models.py#L365-L379
|
rfosterslo/wagtailplus
|
wagtailplus/utils/views/chooser.py
|
chosen_view_factory
|
def chosen_view_factory(chooser_cls):
"""
Returns a ChosenView class that extends specified chooser class.
:param chooser_cls: the class to extend.
:rtype: class.
"""
class ChosenView(chooser_cls):
#noinspection PyUnusedLocal
def get(self, request, *args, **kwargs):
"""
Returns GET response.
:param request: the request instance.
:rtype: django.http.HttpResponse.
"""
#noinspection PyAttributeOutsideInit
self.object = self.get_object()
return render_modal_workflow(
self.request,
None,
'{0}/chosen.js'.format(self.template_dir),
{'obj': self.get_json(self.object)}
)
def get_object(self, queryset=None):
"""
Returns chosen object instance.
:param queryset: the queryset instance.
:rtype: django.db.models.Model.
"""
if queryset is None:
queryset = self.get_queryset()
pk = self.kwargs.get('pk', None)
try:
return queryset.get(pk=pk)
except self.models.DoesNotExist:
raise Http404()
def post(self, request, *args, **kwargs):
"""
Returns POST response.
:param request: the request instance.
:rtype: django.http.HttpResponse.
"""
return self.get(request, *args, **kwargs)
return ChosenView
|
python
|
def chosen_view_factory(chooser_cls):
"""
Returns a ChosenView class that extends specified chooser class.
:param chooser_cls: the class to extend.
:rtype: class.
"""
class ChosenView(chooser_cls):
#noinspection PyUnusedLocal
def get(self, request, *args, **kwargs):
"""
Returns GET response.
:param request: the request instance.
:rtype: django.http.HttpResponse.
"""
#noinspection PyAttributeOutsideInit
self.object = self.get_object()
return render_modal_workflow(
self.request,
None,
'{0}/chosen.js'.format(self.template_dir),
{'obj': self.get_json(self.object)}
)
def get_object(self, queryset=None):
"""
Returns chosen object instance.
:param queryset: the queryset instance.
:rtype: django.db.models.Model.
"""
if queryset is None:
queryset = self.get_queryset()
pk = self.kwargs.get('pk', None)
try:
return queryset.get(pk=pk)
except self.models.DoesNotExist:
raise Http404()
def post(self, request, *args, **kwargs):
"""
Returns POST response.
:param request: the request instance.
:rtype: django.http.HttpResponse.
"""
return self.get(request, *args, **kwargs)
return ChosenView
|
[
"def",
"chosen_view_factory",
"(",
"chooser_cls",
")",
":",
"class",
"ChosenView",
"(",
"chooser_cls",
")",
":",
"#noinspection PyUnusedLocal",
"def",
"get",
"(",
"self",
",",
"request",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"\"\"\"\n Returns GET response.\n\n :param request: the request instance.\n :rtype: django.http.HttpResponse.\n \"\"\"",
"#noinspection PyAttributeOutsideInit",
"self",
".",
"object",
"=",
"self",
".",
"get_object",
"(",
")",
"return",
"render_modal_workflow",
"(",
"self",
".",
"request",
",",
"None",
",",
"'{0}/chosen.js'",
".",
"format",
"(",
"self",
".",
"template_dir",
")",
",",
"{",
"'obj'",
":",
"self",
".",
"get_json",
"(",
"self",
".",
"object",
")",
"}",
")",
"def",
"get_object",
"(",
"self",
",",
"queryset",
"=",
"None",
")",
":",
"\"\"\"\n Returns chosen object instance.\n\n :param queryset: the queryset instance.\n :rtype: django.db.models.Model.\n \"\"\"",
"if",
"queryset",
"is",
"None",
":",
"queryset",
"=",
"self",
".",
"get_queryset",
"(",
")",
"pk",
"=",
"self",
".",
"kwargs",
".",
"get",
"(",
"'pk'",
",",
"None",
")",
"try",
":",
"return",
"queryset",
".",
"get",
"(",
"pk",
"=",
"pk",
")",
"except",
"self",
".",
"models",
".",
"DoesNotExist",
":",
"raise",
"Http404",
"(",
")",
"def",
"post",
"(",
"self",
",",
"request",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"\"\"\"\n Returns POST response.\n\n :param request: the request instance.\n :rtype: django.http.HttpResponse.\n \"\"\"",
"return",
"self",
".",
"get",
"(",
"request",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
"return",
"ChosenView"
] |
Returns a ChosenView class that extends specified chooser class.
:param chooser_cls: the class to extend.
:rtype: class.
|
[
"Returns",
"a",
"ChosenView",
"class",
"that",
"extends",
"specified",
"chooser",
"class",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/utils/views/chooser.py#L163-L215
|
rfosterslo/wagtailplus
|
wagtailplus/utils/views/chooser.py
|
ChooserView.form_invalid
|
def form_invalid(self, form):
"""
Processes an invalid form submittal.
:param form: the form instance.
:rtype: django.http.HttpResponse.
"""
context = self.get_context_data(form=form)
#noinspection PyUnresolvedReferences
return render_modal_workflow(
self.request,
'{0}/chooser.html'.format(self.template_dir),
'{0}/chooser.js'.format(self.template_dir),
context
)
|
python
|
def form_invalid(self, form):
"""
Processes an invalid form submittal.
:param form: the form instance.
:rtype: django.http.HttpResponse.
"""
context = self.get_context_data(form=form)
#noinspection PyUnresolvedReferences
return render_modal_workflow(
self.request,
'{0}/chooser.html'.format(self.template_dir),
'{0}/chooser.js'.format(self.template_dir),
context
)
|
[
"def",
"form_invalid",
"(",
"self",
",",
"form",
")",
":",
"context",
"=",
"self",
".",
"get_context_data",
"(",
"form",
"=",
"form",
")",
"#noinspection PyUnresolvedReferences",
"return",
"render_modal_workflow",
"(",
"self",
".",
"request",
",",
"'{0}/chooser.html'",
".",
"format",
"(",
"self",
".",
"template_dir",
")",
",",
"'{0}/chooser.js'",
".",
"format",
"(",
"self",
".",
"template_dir",
")",
",",
"context",
")"
] |
Processes an invalid form submittal.
:param form: the form instance.
:rtype: django.http.HttpResponse.
|
[
"Processes",
"an",
"invalid",
"form",
"submittal",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/utils/views/chooser.py#L20-L35
|
rfosterslo/wagtailplus
|
wagtailplus/utils/views/chooser.py
|
ChooserView.form_valid
|
def form_valid(self, form):
"""
Processes a valid form submittal.
:param form: the form instance.
:rtype: django.http.HttpResponse.
"""
#noinspection PyAttributeOutsideInit
self.object = form.save()
# Index the link.
for backend in get_search_backends():
backend.add(self.object)
#noinspection PyUnresolvedReferences
return render_modal_workflow(
self.request,
None,
'{0}/chosen.js'.format(self.template_dir),
{'obj': self.get_json(self.object)}
)
|
python
|
def form_valid(self, form):
"""
Processes a valid form submittal.
:param form: the form instance.
:rtype: django.http.HttpResponse.
"""
#noinspection PyAttributeOutsideInit
self.object = form.save()
# Index the link.
for backend in get_search_backends():
backend.add(self.object)
#noinspection PyUnresolvedReferences
return render_modal_workflow(
self.request,
None,
'{0}/chosen.js'.format(self.template_dir),
{'obj': self.get_json(self.object)}
)
|
[
"def",
"form_valid",
"(",
"self",
",",
"form",
")",
":",
"#noinspection PyAttributeOutsideInit",
"self",
".",
"object",
"=",
"form",
".",
"save",
"(",
")",
"# Index the link.",
"for",
"backend",
"in",
"get_search_backends",
"(",
")",
":",
"backend",
".",
"add",
"(",
"self",
".",
"object",
")",
"#noinspection PyUnresolvedReferences",
"return",
"render_modal_workflow",
"(",
"self",
".",
"request",
",",
"None",
",",
"'{0}/chosen.js'",
".",
"format",
"(",
"self",
".",
"template_dir",
")",
",",
"{",
"'obj'",
":",
"self",
".",
"get_json",
"(",
"self",
".",
"object",
")",
"}",
")"
] |
Processes a valid form submittal.
:param form: the form instance.
:rtype: django.http.HttpResponse.
|
[
"Processes",
"a",
"valid",
"form",
"submittal",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/utils/views/chooser.py#L37-L57
|
rfosterslo/wagtailplus
|
wagtailplus/utils/views/chooser.py
|
ChooserView.get
|
def get(self, request, *args, **kwargs):
"""
Returns GET response.
:param request: the request instance.
:rtype: django.http.HttpResponse.
"""
#noinspection PyAttributeOutsideInit
self.object_list = self.get_queryset()
context = self.get_context_data(force_search=True)
if self.form_class:
context.update({'form': self.get_form()})
if 'q' in request.GET or 'p' in request.GET:
return render(
request,
'{0}/results.html'.format(self.template_dir),
context
)
else:
return render_modal_workflow(
request,
'{0}/chooser.html'.format(self.template_dir),
'{0}/chooser.js'.format(self.template_dir),
context
)
|
python
|
def get(self, request, *args, **kwargs):
"""
Returns GET response.
:param request: the request instance.
:rtype: django.http.HttpResponse.
"""
#noinspection PyAttributeOutsideInit
self.object_list = self.get_queryset()
context = self.get_context_data(force_search=True)
if self.form_class:
context.update({'form': self.get_form()})
if 'q' in request.GET or 'p' in request.GET:
return render(
request,
'{0}/results.html'.format(self.template_dir),
context
)
else:
return render_modal_workflow(
request,
'{0}/chooser.html'.format(self.template_dir),
'{0}/chooser.js'.format(self.template_dir),
context
)
|
[
"def",
"get",
"(",
"self",
",",
"request",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"#noinspection PyAttributeOutsideInit",
"self",
".",
"object_list",
"=",
"self",
".",
"get_queryset",
"(",
")",
"context",
"=",
"self",
".",
"get_context_data",
"(",
"force_search",
"=",
"True",
")",
"if",
"self",
".",
"form_class",
":",
"context",
".",
"update",
"(",
"{",
"'form'",
":",
"self",
".",
"get_form",
"(",
")",
"}",
")",
"if",
"'q'",
"in",
"request",
".",
"GET",
"or",
"'p'",
"in",
"request",
".",
"GET",
":",
"return",
"render",
"(",
"request",
",",
"'{0}/results.html'",
".",
"format",
"(",
"self",
".",
"template_dir",
")",
",",
"context",
")",
"else",
":",
"return",
"render_modal_workflow",
"(",
"request",
",",
"'{0}/chooser.html'",
".",
"format",
"(",
"self",
".",
"template_dir",
")",
",",
"'{0}/chooser.js'",
".",
"format",
"(",
"self",
".",
"template_dir",
")",
",",
"context",
")"
] |
Returns GET response.
:param request: the request instance.
:rtype: django.http.HttpResponse.
|
[
"Returns",
"GET",
"response",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/utils/views/chooser.py#L59-L85
|
rfosterslo/wagtailplus
|
wagtailplus/utils/views/chooser.py
|
ChooserView.get_form_kwargs
|
def get_form_kwargs(self):
"""
Returns the keyword arguments for instantiating the form.
:rtype: dict.
"""
kwargs = {
'initial': self.get_initial(),
'prefix': self.get_prefix(),
}
#noinspection PyUnresolvedReferences
if self.request.method in ('POST', 'PUT'):
#noinspection PyUnresolvedReferences
kwargs.update({
'data': self.request.POST,
'files': self.request.FILES,
})
if hasattr(self, 'object'):
kwargs.update({'instance': self.object})
return kwargs
|
python
|
def get_form_kwargs(self):
"""
Returns the keyword arguments for instantiating the form.
:rtype: dict.
"""
kwargs = {
'initial': self.get_initial(),
'prefix': self.get_prefix(),
}
#noinspection PyUnresolvedReferences
if self.request.method in ('POST', 'PUT'):
#noinspection PyUnresolvedReferences
kwargs.update({
'data': self.request.POST,
'files': self.request.FILES,
})
if hasattr(self, 'object'):
kwargs.update({'instance': self.object})
return kwargs
|
[
"def",
"get_form_kwargs",
"(",
"self",
")",
":",
"kwargs",
"=",
"{",
"'initial'",
":",
"self",
".",
"get_initial",
"(",
")",
",",
"'prefix'",
":",
"self",
".",
"get_prefix",
"(",
")",
",",
"}",
"#noinspection PyUnresolvedReferences",
"if",
"self",
".",
"request",
".",
"method",
"in",
"(",
"'POST'",
",",
"'PUT'",
")",
":",
"#noinspection PyUnresolvedReferences",
"kwargs",
".",
"update",
"(",
"{",
"'data'",
":",
"self",
".",
"request",
".",
"POST",
",",
"'files'",
":",
"self",
".",
"request",
".",
"FILES",
",",
"}",
")",
"if",
"hasattr",
"(",
"self",
",",
"'object'",
")",
":",
"kwargs",
".",
"update",
"(",
"{",
"'instance'",
":",
"self",
".",
"object",
"}",
")",
"return",
"kwargs"
] |
Returns the keyword arguments for instantiating the form.
:rtype: dict.
|
[
"Returns",
"the",
"keyword",
"arguments",
"for",
"instantiating",
"the",
"form",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/utils/views/chooser.py#L106-L128
|
rfosterslo/wagtailplus
|
wagtailplus/wagtailrelations/signals/handlers.py
|
create_entry_tag
|
def create_entry_tag(sender, instance, created, **kwargs):
"""
Creates EntryTag for Entry corresponding to specified
ItemBase instance.
:param sender: the sending ItemBase class.
:param instance: the ItemBase instance.
"""
from ..models import (
Entry,
EntryTag
)
entry = Entry.objects.get_for_model(instance.content_object)[0]
tag = instance.tag
if not EntryTag.objects.filter(tag=tag, entry=entry).exists():
EntryTag.objects.create(tag=tag, entry=entry)
|
python
|
def create_entry_tag(sender, instance, created, **kwargs):
"""
Creates EntryTag for Entry corresponding to specified
ItemBase instance.
:param sender: the sending ItemBase class.
:param instance: the ItemBase instance.
"""
from ..models import (
Entry,
EntryTag
)
entry = Entry.objects.get_for_model(instance.content_object)[0]
tag = instance.tag
if not EntryTag.objects.filter(tag=tag, entry=entry).exists():
EntryTag.objects.create(tag=tag, entry=entry)
|
[
"def",
"create_entry_tag",
"(",
"sender",
",",
"instance",
",",
"created",
",",
"*",
"*",
"kwargs",
")",
":",
"from",
".",
".",
"models",
"import",
"(",
"Entry",
",",
"EntryTag",
")",
"entry",
"=",
"Entry",
".",
"objects",
".",
"get_for_model",
"(",
"instance",
".",
"content_object",
")",
"[",
"0",
"]",
"tag",
"=",
"instance",
".",
"tag",
"if",
"not",
"EntryTag",
".",
"objects",
".",
"filter",
"(",
"tag",
"=",
"tag",
",",
"entry",
"=",
"entry",
")",
".",
"exists",
"(",
")",
":",
"EntryTag",
".",
"objects",
".",
"create",
"(",
"tag",
"=",
"tag",
",",
"entry",
"=",
"entry",
")"
] |
Creates EntryTag for Entry corresponding to specified
ItemBase instance.
:param sender: the sending ItemBase class.
:param instance: the ItemBase instance.
|
[
"Creates",
"EntryTag",
"for",
"Entry",
"corresponding",
"to",
"specified",
"ItemBase",
"instance",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/wagtailrelations/signals/handlers.py#L11-L28
|
rfosterslo/wagtailplus
|
wagtailplus/wagtailrelations/signals/handlers.py
|
delete_entry_tag
|
def delete_entry_tag(sender, instance, **kwargs):
"""
Deletes EntryTag for Entry corresponding to specified
TaggedItemBase instance.
:param sender: the sending TaggedItemBase class.
:param instance: the TaggedItemBase instance.
"""
from ..models import (
Entry,
EntryTag
)
entry = Entry.objects.get_for_model(instance.content_object)[0]
tag = instance.tag
EntryTag.objects.filter(tag=tag, entry=entry).delete()
|
python
|
def delete_entry_tag(sender, instance, **kwargs):
"""
Deletes EntryTag for Entry corresponding to specified
TaggedItemBase instance.
:param sender: the sending TaggedItemBase class.
:param instance: the TaggedItemBase instance.
"""
from ..models import (
Entry,
EntryTag
)
entry = Entry.objects.get_for_model(instance.content_object)[0]
tag = instance.tag
EntryTag.objects.filter(tag=tag, entry=entry).delete()
|
[
"def",
"delete_entry_tag",
"(",
"sender",
",",
"instance",
",",
"*",
"*",
"kwargs",
")",
":",
"from",
".",
".",
"models",
"import",
"(",
"Entry",
",",
"EntryTag",
")",
"entry",
"=",
"Entry",
".",
"objects",
".",
"get_for_model",
"(",
"instance",
".",
"content_object",
")",
"[",
"0",
"]",
"tag",
"=",
"instance",
".",
"tag",
"EntryTag",
".",
"objects",
".",
"filter",
"(",
"tag",
"=",
"tag",
",",
"entry",
"=",
"entry",
")",
".",
"delete",
"(",
")"
] |
Deletes EntryTag for Entry corresponding to specified
TaggedItemBase instance.
:param sender: the sending TaggedItemBase class.
:param instance: the TaggedItemBase instance.
|
[
"Deletes",
"EntryTag",
"for",
"Entry",
"corresponding",
"to",
"specified",
"TaggedItemBase",
"instance",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/wagtailrelations/signals/handlers.py#L31-L47
|
rfosterslo/wagtailplus
|
wagtailplus/wagtailrelations/signals/handlers.py
|
delete_entry
|
def delete_entry(sender, instance, **kwargs):
"""
Deletes Entry instance corresponding to specified instance.
:param sender: the sending class.
:param instance: the instance being deleted.
"""
from ..models import Entry
Entry.objects.get_for_model(instance)[0].delete()
|
python
|
def delete_entry(sender, instance, **kwargs):
"""
Deletes Entry instance corresponding to specified instance.
:param sender: the sending class.
:param instance: the instance being deleted.
"""
from ..models import Entry
Entry.objects.get_for_model(instance)[0].delete()
|
[
"def",
"delete_entry",
"(",
"sender",
",",
"instance",
",",
"*",
"*",
"kwargs",
")",
":",
"from",
".",
".",
"models",
"import",
"Entry",
"Entry",
".",
"objects",
".",
"get_for_model",
"(",
"instance",
")",
"[",
"0",
"]",
".",
"delete",
"(",
")"
] |
Deletes Entry instance corresponding to specified instance.
:param sender: the sending class.
:param instance: the instance being deleted.
|
[
"Deletes",
"Entry",
"instance",
"corresponding",
"to",
"specified",
"instance",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/wagtailrelations/signals/handlers.py#L50-L59
|
rfosterslo/wagtailplus
|
wagtailplus/wagtailrelations/signals/handlers.py
|
update_entry_attributes
|
def update_entry_attributes(sender, instance, **kwargs):
"""
Updates attributes for Entry instance corresponding to
specified instance.
:param sender: the sending class.
:param instance: the instance being saved.
"""
from ..models import Entry
entry = Entry.objects.get_for_model(instance)[0]
default_url = getattr(instance, 'get_absolute_url', '')
entry.title = getattr(instance, 'title', str(instance))
entry.url = getattr(instance, 'url', default_url)
entry.live = bool(getattr(instance, 'live', True))
entry.save()
|
python
|
def update_entry_attributes(sender, instance, **kwargs):
"""
Updates attributes for Entry instance corresponding to
specified instance.
:param sender: the sending class.
:param instance: the instance being saved.
"""
from ..models import Entry
entry = Entry.objects.get_for_model(instance)[0]
default_url = getattr(instance, 'get_absolute_url', '')
entry.title = getattr(instance, 'title', str(instance))
entry.url = getattr(instance, 'url', default_url)
entry.live = bool(getattr(instance, 'live', True))
entry.save()
|
[
"def",
"update_entry_attributes",
"(",
"sender",
",",
"instance",
",",
"*",
"*",
"kwargs",
")",
":",
"from",
".",
".",
"models",
"import",
"Entry",
"entry",
"=",
"Entry",
".",
"objects",
".",
"get_for_model",
"(",
"instance",
")",
"[",
"0",
"]",
"default_url",
"=",
"getattr",
"(",
"instance",
",",
"'get_absolute_url'",
",",
"''",
")",
"entry",
".",
"title",
"=",
"getattr",
"(",
"instance",
",",
"'title'",
",",
"str",
"(",
"instance",
")",
")",
"entry",
".",
"url",
"=",
"getattr",
"(",
"instance",
",",
"'url'",
",",
"default_url",
")",
"entry",
".",
"live",
"=",
"bool",
"(",
"getattr",
"(",
"instance",
",",
"'live'",
",",
"True",
")",
")",
"entry",
".",
"save",
"(",
")"
] |
Updates attributes for Entry instance corresponding to
specified instance.
:param sender: the sending class.
:param instance: the instance being saved.
|
[
"Updates",
"attributes",
"for",
"Entry",
"instance",
"corresponding",
"to",
"specified",
"instance",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/wagtailrelations/signals/handlers.py#L62-L79
|
rfosterslo/wagtailplus
|
wagtailplus/wagtailrollbacks/views.py
|
get_revisions
|
def get_revisions(page, page_num=1):
"""
Returns paginated queryset of PageRevision instances for
specified Page instance.
:param page: the page instance.
:param page_num: the pagination page number.
:rtype: django.db.models.query.QuerySet.
"""
revisions = page.revisions.order_by('-created_at')
current = page.get_latest_revision()
if current:
revisions.exclude(id=current.id)
paginator = Paginator(revisions, 5)
try:
revisions = paginator.page(page_num)
except PageNotAnInteger:
revisions = paginator.page(1)
except EmptyPage:
revisions = paginator.page(paginator.num_pages)
return revisions
|
python
|
def get_revisions(page, page_num=1):
"""
Returns paginated queryset of PageRevision instances for
specified Page instance.
:param page: the page instance.
:param page_num: the pagination page number.
:rtype: django.db.models.query.QuerySet.
"""
revisions = page.revisions.order_by('-created_at')
current = page.get_latest_revision()
if current:
revisions.exclude(id=current.id)
paginator = Paginator(revisions, 5)
try:
revisions = paginator.page(page_num)
except PageNotAnInteger:
revisions = paginator.page(1)
except EmptyPage:
revisions = paginator.page(paginator.num_pages)
return revisions
|
[
"def",
"get_revisions",
"(",
"page",
",",
"page_num",
"=",
"1",
")",
":",
"revisions",
"=",
"page",
".",
"revisions",
".",
"order_by",
"(",
"'-created_at'",
")",
"current",
"=",
"page",
".",
"get_latest_revision",
"(",
")",
"if",
"current",
":",
"revisions",
".",
"exclude",
"(",
"id",
"=",
"current",
".",
"id",
")",
"paginator",
"=",
"Paginator",
"(",
"revisions",
",",
"5",
")",
"try",
":",
"revisions",
"=",
"paginator",
".",
"page",
"(",
"page_num",
")",
"except",
"PageNotAnInteger",
":",
"revisions",
"=",
"paginator",
".",
"page",
"(",
"1",
")",
"except",
"EmptyPage",
":",
"revisions",
"=",
"paginator",
".",
"page",
"(",
"paginator",
".",
"num_pages",
")",
"return",
"revisions"
] |
Returns paginated queryset of PageRevision instances for
specified Page instance.
:param page: the page instance.
:param page_num: the pagination page number.
:rtype: django.db.models.query.QuerySet.
|
[
"Returns",
"paginated",
"queryset",
"of",
"PageRevision",
"instances",
"for",
"specified",
"Page",
"instance",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/wagtailrollbacks/views.py#L27-L51
|
rfosterslo/wagtailplus
|
wagtailplus/wagtailrollbacks/views.py
|
page_revisions
|
def page_revisions(request, page_id, template_name='wagtailrollbacks/edit_handlers/revisions.html'):
"""
Returns GET response for specified page revisions.
:param request: the request instance.
:param page_id: the page ID.
:param template_name: the template name.
:rtype: django.http.HttpResponse.
"""
page = get_object_or_404(Page, pk=page_id)
page_perms = page.permissions_for_user(request.user)
if not page_perms.can_edit():
raise PermissionDenied
page_num = request.GET.get('p', 1)
revisions = get_revisions(page, page_num)
return render(
request,
template_name,
{
'page': page,
'revisions': revisions,
'p': page_num,
}
)
|
python
|
def page_revisions(request, page_id, template_name='wagtailrollbacks/edit_handlers/revisions.html'):
"""
Returns GET response for specified page revisions.
:param request: the request instance.
:param page_id: the page ID.
:param template_name: the template name.
:rtype: django.http.HttpResponse.
"""
page = get_object_or_404(Page, pk=page_id)
page_perms = page.permissions_for_user(request.user)
if not page_perms.can_edit():
raise PermissionDenied
page_num = request.GET.get('p', 1)
revisions = get_revisions(page, page_num)
return render(
request,
template_name,
{
'page': page,
'revisions': revisions,
'p': page_num,
}
)
|
[
"def",
"page_revisions",
"(",
"request",
",",
"page_id",
",",
"template_name",
"=",
"'wagtailrollbacks/edit_handlers/revisions.html'",
")",
":",
"page",
"=",
"get_object_or_404",
"(",
"Page",
",",
"pk",
"=",
"page_id",
")",
"page_perms",
"=",
"page",
".",
"permissions_for_user",
"(",
"request",
".",
"user",
")",
"if",
"not",
"page_perms",
".",
"can_edit",
"(",
")",
":",
"raise",
"PermissionDenied",
"page_num",
"=",
"request",
".",
"GET",
".",
"get",
"(",
"'p'",
",",
"1",
")",
"revisions",
"=",
"get_revisions",
"(",
"page",
",",
"page_num",
")",
"return",
"render",
"(",
"request",
",",
"template_name",
",",
"{",
"'page'",
":",
"page",
",",
"'revisions'",
":",
"revisions",
",",
"'p'",
":",
"page_num",
",",
"}",
")"
] |
Returns GET response for specified page revisions.
:param request: the request instance.
:param page_id: the page ID.
:param template_name: the template name.
:rtype: django.http.HttpResponse.
|
[
"Returns",
"GET",
"response",
"for",
"specified",
"page",
"revisions",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/wagtailrollbacks/views.py#L53-L79
|
rfosterslo/wagtailplus
|
wagtailplus/wagtailrollbacks/views.py
|
preview_page_version
|
def preview_page_version(request, revision_id):
"""
Returns GET response for specified page preview.
:param request: the request instance.
:param reversion_pk: the page revision ID.
:rtype: django.http.HttpResponse.
"""
revision = get_object_or_404(PageRevision, pk=revision_id)
if not revision.page.permissions_for_user(request.user).can_publish():
raise PermissionDenied
page = revision.as_page_object()
request.revision_id = revision_id
return page.serve_preview(request, page.default_preview_mode)
|
python
|
def preview_page_version(request, revision_id):
"""
Returns GET response for specified page preview.
:param request: the request instance.
:param reversion_pk: the page revision ID.
:rtype: django.http.HttpResponse.
"""
revision = get_object_or_404(PageRevision, pk=revision_id)
if not revision.page.permissions_for_user(request.user).can_publish():
raise PermissionDenied
page = revision.as_page_object()
request.revision_id = revision_id
return page.serve_preview(request, page.default_preview_mode)
|
[
"def",
"preview_page_version",
"(",
"request",
",",
"revision_id",
")",
":",
"revision",
"=",
"get_object_or_404",
"(",
"PageRevision",
",",
"pk",
"=",
"revision_id",
")",
"if",
"not",
"revision",
".",
"page",
".",
"permissions_for_user",
"(",
"request",
".",
"user",
")",
".",
"can_publish",
"(",
")",
":",
"raise",
"PermissionDenied",
"page",
"=",
"revision",
".",
"as_page_object",
"(",
")",
"request",
".",
"revision_id",
"=",
"revision_id",
"return",
"page",
".",
"serve_preview",
"(",
"request",
",",
"page",
".",
"default_preview_mode",
")"
] |
Returns GET response for specified page preview.
:param request: the request instance.
:param reversion_pk: the page revision ID.
:rtype: django.http.HttpResponse.
|
[
"Returns",
"GET",
"response",
"for",
"specified",
"page",
"preview",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/wagtailrollbacks/views.py#L81-L97
|
rfosterslo/wagtailplus
|
wagtailplus/wagtailrollbacks/views.py
|
confirm_page_reversion
|
def confirm_page_reversion(request, revision_id, template_name='wagtailrollbacks/pages/confirm_reversion.html'):
"""
Handles page reversion process (GET and POST).
:param request: the request instance.
:param revision_id: the page revision ID.
:param template_name: the template name.
:rtype: django.http.HttpResponse.
"""
revision = get_object_or_404(PageRevision, pk=revision_id)
page = revision.page
if page.locked:
messages.error(
request,
_("Page '{0}' is locked.").format(page.title),
buttons = []
)
return redirect(reverse('wagtailadmin_pages:edit', args=(page.id,)))
page_perms = page.permissions_for_user(request.user)
if not page_perms.can_edit():
raise PermissionDenied
if request.POST:
is_publishing = bool(request.POST.get('action-publish')) and page_perms.can_publish()
is_submitting = bool(request.POST.get('action-submit'))
new_revision = page.rollback(
revision_id = revision_id,
user = request.user,
submitted_for_moderation = is_submitting
)
if is_publishing:
new_revision.publish()
messages.success(
request,
_("Page '{0}' published.").format(page.title),
buttons=[
messages.button(page.url, _('View live')),
messages.button(reverse('wagtailadmin_pages:edit', args=(page.id,)), _('Edit'))
]
)
elif is_submitting:
messages.success(
request,
_("Page '{0}' submitted for moderation.").format(page.title),
buttons=[
messages.button(reverse('wagtailadmin_pages:view_draft', args=(page.id,)), _('View draft')),
messages.button(reverse('wagtailadmin_pages:edit', args=(page.id,)), _('Edit'))
]
)
send_notification(new_revision.id, 'submitted', request.user.id)
else:
messages.success(
request,
_("Page '{0}' updated.").format(page.title),
buttons=[]
)
for fn in hooks.get_hooks('after_edit_page'):
result = fn(request, page)
if hasattr(result, 'status_code'):
return result
return redirect('wagtailadmin_explore', page.get_parent().id)
return render(
request,
template_name,
{
'page': page,
'revision': revision,
'page_perms': page_perms
}
)
|
python
|
def confirm_page_reversion(request, revision_id, template_name='wagtailrollbacks/pages/confirm_reversion.html'):
"""
Handles page reversion process (GET and POST).
:param request: the request instance.
:param revision_id: the page revision ID.
:param template_name: the template name.
:rtype: django.http.HttpResponse.
"""
revision = get_object_or_404(PageRevision, pk=revision_id)
page = revision.page
if page.locked:
messages.error(
request,
_("Page '{0}' is locked.").format(page.title),
buttons = []
)
return redirect(reverse('wagtailadmin_pages:edit', args=(page.id,)))
page_perms = page.permissions_for_user(request.user)
if not page_perms.can_edit():
raise PermissionDenied
if request.POST:
is_publishing = bool(request.POST.get('action-publish')) and page_perms.can_publish()
is_submitting = bool(request.POST.get('action-submit'))
new_revision = page.rollback(
revision_id = revision_id,
user = request.user,
submitted_for_moderation = is_submitting
)
if is_publishing:
new_revision.publish()
messages.success(
request,
_("Page '{0}' published.").format(page.title),
buttons=[
messages.button(page.url, _('View live')),
messages.button(reverse('wagtailadmin_pages:edit', args=(page.id,)), _('Edit'))
]
)
elif is_submitting:
messages.success(
request,
_("Page '{0}' submitted for moderation.").format(page.title),
buttons=[
messages.button(reverse('wagtailadmin_pages:view_draft', args=(page.id,)), _('View draft')),
messages.button(reverse('wagtailadmin_pages:edit', args=(page.id,)), _('Edit'))
]
)
send_notification(new_revision.id, 'submitted', request.user.id)
else:
messages.success(
request,
_("Page '{0}' updated.").format(page.title),
buttons=[]
)
for fn in hooks.get_hooks('after_edit_page'):
result = fn(request, page)
if hasattr(result, 'status_code'):
return result
return redirect('wagtailadmin_explore', page.get_parent().id)
return render(
request,
template_name,
{
'page': page,
'revision': revision,
'page_perms': page_perms
}
)
|
[
"def",
"confirm_page_reversion",
"(",
"request",
",",
"revision_id",
",",
"template_name",
"=",
"'wagtailrollbacks/pages/confirm_reversion.html'",
")",
":",
"revision",
"=",
"get_object_or_404",
"(",
"PageRevision",
",",
"pk",
"=",
"revision_id",
")",
"page",
"=",
"revision",
".",
"page",
"if",
"page",
".",
"locked",
":",
"messages",
".",
"error",
"(",
"request",
",",
"_",
"(",
"\"Page '{0}' is locked.\"",
")",
".",
"format",
"(",
"page",
".",
"title",
")",
",",
"buttons",
"=",
"[",
"]",
")",
"return",
"redirect",
"(",
"reverse",
"(",
"'wagtailadmin_pages:edit'",
",",
"args",
"=",
"(",
"page",
".",
"id",
",",
")",
")",
")",
"page_perms",
"=",
"page",
".",
"permissions_for_user",
"(",
"request",
".",
"user",
")",
"if",
"not",
"page_perms",
".",
"can_edit",
"(",
")",
":",
"raise",
"PermissionDenied",
"if",
"request",
".",
"POST",
":",
"is_publishing",
"=",
"bool",
"(",
"request",
".",
"POST",
".",
"get",
"(",
"'action-publish'",
")",
")",
"and",
"page_perms",
".",
"can_publish",
"(",
")",
"is_submitting",
"=",
"bool",
"(",
"request",
".",
"POST",
".",
"get",
"(",
"'action-submit'",
")",
")",
"new_revision",
"=",
"page",
".",
"rollback",
"(",
"revision_id",
"=",
"revision_id",
",",
"user",
"=",
"request",
".",
"user",
",",
"submitted_for_moderation",
"=",
"is_submitting",
")",
"if",
"is_publishing",
":",
"new_revision",
".",
"publish",
"(",
")",
"messages",
".",
"success",
"(",
"request",
",",
"_",
"(",
"\"Page '{0}' published.\"",
")",
".",
"format",
"(",
"page",
".",
"title",
")",
",",
"buttons",
"=",
"[",
"messages",
".",
"button",
"(",
"page",
".",
"url",
",",
"_",
"(",
"'View live'",
")",
")",
",",
"messages",
".",
"button",
"(",
"reverse",
"(",
"'wagtailadmin_pages:edit'",
",",
"args",
"=",
"(",
"page",
".",
"id",
",",
")",
")",
",",
"_",
"(",
"'Edit'",
")",
")",
"]",
")",
"elif",
"is_submitting",
":",
"messages",
".",
"success",
"(",
"request",
",",
"_",
"(",
"\"Page '{0}' submitted for moderation.\"",
")",
".",
"format",
"(",
"page",
".",
"title",
")",
",",
"buttons",
"=",
"[",
"messages",
".",
"button",
"(",
"reverse",
"(",
"'wagtailadmin_pages:view_draft'",
",",
"args",
"=",
"(",
"page",
".",
"id",
",",
")",
")",
",",
"_",
"(",
"'View draft'",
")",
")",
",",
"messages",
".",
"button",
"(",
"reverse",
"(",
"'wagtailadmin_pages:edit'",
",",
"args",
"=",
"(",
"page",
".",
"id",
",",
")",
")",
",",
"_",
"(",
"'Edit'",
")",
")",
"]",
")",
"send_notification",
"(",
"new_revision",
".",
"id",
",",
"'submitted'",
",",
"request",
".",
"user",
".",
"id",
")",
"else",
":",
"messages",
".",
"success",
"(",
"request",
",",
"_",
"(",
"\"Page '{0}' updated.\"",
")",
".",
"format",
"(",
"page",
".",
"title",
")",
",",
"buttons",
"=",
"[",
"]",
")",
"for",
"fn",
"in",
"hooks",
".",
"get_hooks",
"(",
"'after_edit_page'",
")",
":",
"result",
"=",
"fn",
"(",
"request",
",",
"page",
")",
"if",
"hasattr",
"(",
"result",
",",
"'status_code'",
")",
":",
"return",
"result",
"return",
"redirect",
"(",
"'wagtailadmin_explore'",
",",
"page",
".",
"get_parent",
"(",
")",
".",
"id",
")",
"return",
"render",
"(",
"request",
",",
"template_name",
",",
"{",
"'page'",
":",
"page",
",",
"'revision'",
":",
"revision",
",",
"'page_perms'",
":",
"page_perms",
"}",
")"
] |
Handles page reversion process (GET and POST).
:param request: the request instance.
:param revision_id: the page revision ID.
:param template_name: the template name.
:rtype: django.http.HttpResponse.
|
[
"Handles",
"page",
"reversion",
"process",
"(",
"GET",
"and",
"POST",
")",
"."
] |
train
|
https://github.com/rfosterslo/wagtailplus/blob/22cac857175d8a6f77e470751831c14a92ccd768/wagtailplus/wagtailrollbacks/views.py#L99-L176
|
jaraco/keyrings.alt
|
keyrings/alt/Google.py
|
DocsKeyring.get_password
|
def get_password(self, service, username):
"""Get password of the username for the service
"""
result = self._get_entry(self._keyring, service, username)
if result:
result = self._decrypt(result)
return result
|
python
|
def get_password(self, service, username):
"""Get password of the username for the service
"""
result = self._get_entry(self._keyring, service, username)
if result:
result = self._decrypt(result)
return result
|
[
"def",
"get_password",
"(",
"self",
",",
"service",
",",
"username",
")",
":",
"result",
"=",
"self",
".",
"_get_entry",
"(",
"self",
".",
"_keyring",
",",
"service",
",",
"username",
")",
"if",
"result",
":",
"result",
"=",
"self",
".",
"_decrypt",
"(",
"result",
")",
"return",
"result"
] |
Get password of the username for the service
|
[
"Get",
"password",
"of",
"the",
"username",
"for",
"the",
"service"
] |
train
|
https://github.com/jaraco/keyrings.alt/blob/5b71223d12bf9ac6abd05b1b395f1efccb5ea660/keyrings/alt/Google.py#L85-L91
|
jaraco/keyrings.alt
|
keyrings/alt/Google.py
|
DocsKeyring.set_password
|
def set_password(self, service, username, password):
"""Set password for the username of the service
"""
password = self._encrypt(password or '')
keyring_working_copy = copy.deepcopy(self._keyring)
service_entries = keyring_working_copy.get(service)
if not service_entries:
service_entries = {}
keyring_working_copy[service] = service_entries
service_entries[username] = password
save_result = self._save_keyring(keyring_working_copy)
if save_result == self.OK:
self._keyring_dict = keyring_working_copy
return
elif save_result == self.CONFLICT:
# check if we can avoid updating
self.docs_entry, keyring_dict = self._read()
existing_pwd = self._get_entry(self._keyring, service, username)
conflicting_pwd = self._get_entry(keyring_dict, service, username)
if conflicting_pwd == password:
# if someone else updated it to the same value then we are done
self._keyring_dict = keyring_working_copy
return
elif conflicting_pwd is None or conflicting_pwd == existing_pwd:
# if doesn't already exist or is unchanged then update it
new_service_entries = keyring_dict.get(service, {})
new_service_entries[username] = password
keyring_dict[service] = new_service_entries
save_result = self._save_keyring(keyring_dict)
if save_result == self.OK:
self._keyring_dict = keyring_dict
return
else:
raise errors.PasswordSetError(
'Failed write after conflict detected')
else:
raise errors.PasswordSetError(
'Conflict detected, service:%s and username:%s was '
'set to a different value by someone else' % (
service,
username,
),
)
raise errors.PasswordSetError('Could not save keyring')
|
python
|
def set_password(self, service, username, password):
"""Set password for the username of the service
"""
password = self._encrypt(password or '')
keyring_working_copy = copy.deepcopy(self._keyring)
service_entries = keyring_working_copy.get(service)
if not service_entries:
service_entries = {}
keyring_working_copy[service] = service_entries
service_entries[username] = password
save_result = self._save_keyring(keyring_working_copy)
if save_result == self.OK:
self._keyring_dict = keyring_working_copy
return
elif save_result == self.CONFLICT:
# check if we can avoid updating
self.docs_entry, keyring_dict = self._read()
existing_pwd = self._get_entry(self._keyring, service, username)
conflicting_pwd = self._get_entry(keyring_dict, service, username)
if conflicting_pwd == password:
# if someone else updated it to the same value then we are done
self._keyring_dict = keyring_working_copy
return
elif conflicting_pwd is None or conflicting_pwd == existing_pwd:
# if doesn't already exist or is unchanged then update it
new_service_entries = keyring_dict.get(service, {})
new_service_entries[username] = password
keyring_dict[service] = new_service_entries
save_result = self._save_keyring(keyring_dict)
if save_result == self.OK:
self._keyring_dict = keyring_dict
return
else:
raise errors.PasswordSetError(
'Failed write after conflict detected')
else:
raise errors.PasswordSetError(
'Conflict detected, service:%s and username:%s was '
'set to a different value by someone else' % (
service,
username,
),
)
raise errors.PasswordSetError('Could not save keyring')
|
[
"def",
"set_password",
"(",
"self",
",",
"service",
",",
"username",
",",
"password",
")",
":",
"password",
"=",
"self",
".",
"_encrypt",
"(",
"password",
"or",
"''",
")",
"keyring_working_copy",
"=",
"copy",
".",
"deepcopy",
"(",
"self",
".",
"_keyring",
")",
"service_entries",
"=",
"keyring_working_copy",
".",
"get",
"(",
"service",
")",
"if",
"not",
"service_entries",
":",
"service_entries",
"=",
"{",
"}",
"keyring_working_copy",
"[",
"service",
"]",
"=",
"service_entries",
"service_entries",
"[",
"username",
"]",
"=",
"password",
"save_result",
"=",
"self",
".",
"_save_keyring",
"(",
"keyring_working_copy",
")",
"if",
"save_result",
"==",
"self",
".",
"OK",
":",
"self",
".",
"_keyring_dict",
"=",
"keyring_working_copy",
"return",
"elif",
"save_result",
"==",
"self",
".",
"CONFLICT",
":",
"# check if we can avoid updating",
"self",
".",
"docs_entry",
",",
"keyring_dict",
"=",
"self",
".",
"_read",
"(",
")",
"existing_pwd",
"=",
"self",
".",
"_get_entry",
"(",
"self",
".",
"_keyring",
",",
"service",
",",
"username",
")",
"conflicting_pwd",
"=",
"self",
".",
"_get_entry",
"(",
"keyring_dict",
",",
"service",
",",
"username",
")",
"if",
"conflicting_pwd",
"==",
"password",
":",
"# if someone else updated it to the same value then we are done",
"self",
".",
"_keyring_dict",
"=",
"keyring_working_copy",
"return",
"elif",
"conflicting_pwd",
"is",
"None",
"or",
"conflicting_pwd",
"==",
"existing_pwd",
":",
"# if doesn't already exist or is unchanged then update it",
"new_service_entries",
"=",
"keyring_dict",
".",
"get",
"(",
"service",
",",
"{",
"}",
")",
"new_service_entries",
"[",
"username",
"]",
"=",
"password",
"keyring_dict",
"[",
"service",
"]",
"=",
"new_service_entries",
"save_result",
"=",
"self",
".",
"_save_keyring",
"(",
"keyring_dict",
")",
"if",
"save_result",
"==",
"self",
".",
"OK",
":",
"self",
".",
"_keyring_dict",
"=",
"keyring_dict",
"return",
"else",
":",
"raise",
"errors",
".",
"PasswordSetError",
"(",
"'Failed write after conflict detected'",
")",
"else",
":",
"raise",
"errors",
".",
"PasswordSetError",
"(",
"'Conflict detected, service:%s and username:%s was '",
"'set to a different value by someone else'",
"%",
"(",
"service",
",",
"username",
",",
")",
",",
")",
"raise",
"errors",
".",
"PasswordSetError",
"(",
"'Could not save keyring'",
")"
] |
Set password for the username of the service
|
[
"Set",
"password",
"for",
"the",
"username",
"of",
"the",
"service"
] |
train
|
https://github.com/jaraco/keyrings.alt/blob/5b71223d12bf9ac6abd05b1b395f1efccb5ea660/keyrings/alt/Google.py#L93-L137
|
jaraco/keyrings.alt
|
keyrings/alt/Google.py
|
DocsKeyring._save_keyring
|
def _save_keyring(self, keyring_dict):
"""Helper to actually write the keyring to Google"""
import gdata
result = self.OK
file_contents = base64.urlsafe_b64encode(pickle.dumps(keyring_dict))
try:
if self.docs_entry:
extra_headers = {'Content-Type': 'text/plain',
'Content-Length': len(file_contents)}
self.docs_entry = self.client.Put(
file_contents,
self.docs_entry.GetEditMediaLink().href,
extra_headers=extra_headers
)
else:
from gdata.docs.service import DocumentQuery
# check for existence of folder, create if required
folder_query = DocumentQuery(categories=['folder'])
folder_query['title'] = self.collection
folder_query['title-exact'] = 'true'
docs = self.client.QueryDocumentListFeed(folder_query.ToUri())
if docs.entry:
folder_entry = docs.entry[0]
else:
folder_entry = self.client.CreateFolder(self.collection)
file_handle = io.BytesIO(file_contents)
media_source = gdata.MediaSource(
file_handle=file_handle,
content_type='text/plain',
content_length=len(file_contents),
file_name='temp')
self.docs_entry = self.client.Upload(
media_source,
self._get_doc_title(),
folder_or_uri=folder_entry
)
except gdata.service.RequestError as ex:
try:
if ex.message['reason'].lower().find('conflict') != -1:
result = self.CONFLICT
else:
# Google docs has a bug when updating a shared document
# using PUT from any account other that the owner.
# It returns an error 400 "Sorry, there was an error saving
# the file. Please try again"
# *despite* actually updating the document!
# Workaround by re-reading to see if it actually updated
msg = 'Sorry, there was an error saving the file'
if ex.message['body'].find(msg) != -1:
new_docs_entry, new_keyring_dict = self._read()
if new_keyring_dict == keyring_dict:
result = self.OK
else:
result = self.FAIL
else:
result = self.FAIL
except Exception:
result = self.FAIL
return result
|
python
|
def _save_keyring(self, keyring_dict):
"""Helper to actually write the keyring to Google"""
import gdata
result = self.OK
file_contents = base64.urlsafe_b64encode(pickle.dumps(keyring_dict))
try:
if self.docs_entry:
extra_headers = {'Content-Type': 'text/plain',
'Content-Length': len(file_contents)}
self.docs_entry = self.client.Put(
file_contents,
self.docs_entry.GetEditMediaLink().href,
extra_headers=extra_headers
)
else:
from gdata.docs.service import DocumentQuery
# check for existence of folder, create if required
folder_query = DocumentQuery(categories=['folder'])
folder_query['title'] = self.collection
folder_query['title-exact'] = 'true'
docs = self.client.QueryDocumentListFeed(folder_query.ToUri())
if docs.entry:
folder_entry = docs.entry[0]
else:
folder_entry = self.client.CreateFolder(self.collection)
file_handle = io.BytesIO(file_contents)
media_source = gdata.MediaSource(
file_handle=file_handle,
content_type='text/plain',
content_length=len(file_contents),
file_name='temp')
self.docs_entry = self.client.Upload(
media_source,
self._get_doc_title(),
folder_or_uri=folder_entry
)
except gdata.service.RequestError as ex:
try:
if ex.message['reason'].lower().find('conflict') != -1:
result = self.CONFLICT
else:
# Google docs has a bug when updating a shared document
# using PUT from any account other that the owner.
# It returns an error 400 "Sorry, there was an error saving
# the file. Please try again"
# *despite* actually updating the document!
# Workaround by re-reading to see if it actually updated
msg = 'Sorry, there was an error saving the file'
if ex.message['body'].find(msg) != -1:
new_docs_entry, new_keyring_dict = self._read()
if new_keyring_dict == keyring_dict:
result = self.OK
else:
result = self.FAIL
else:
result = self.FAIL
except Exception:
result = self.FAIL
return result
|
[
"def",
"_save_keyring",
"(",
"self",
",",
"keyring_dict",
")",
":",
"import",
"gdata",
"result",
"=",
"self",
".",
"OK",
"file_contents",
"=",
"base64",
".",
"urlsafe_b64encode",
"(",
"pickle",
".",
"dumps",
"(",
"keyring_dict",
")",
")",
"try",
":",
"if",
"self",
".",
"docs_entry",
":",
"extra_headers",
"=",
"{",
"'Content-Type'",
":",
"'text/plain'",
",",
"'Content-Length'",
":",
"len",
"(",
"file_contents",
")",
"}",
"self",
".",
"docs_entry",
"=",
"self",
".",
"client",
".",
"Put",
"(",
"file_contents",
",",
"self",
".",
"docs_entry",
".",
"GetEditMediaLink",
"(",
")",
".",
"href",
",",
"extra_headers",
"=",
"extra_headers",
")",
"else",
":",
"from",
"gdata",
".",
"docs",
".",
"service",
"import",
"DocumentQuery",
"# check for existence of folder, create if required",
"folder_query",
"=",
"DocumentQuery",
"(",
"categories",
"=",
"[",
"'folder'",
"]",
")",
"folder_query",
"[",
"'title'",
"]",
"=",
"self",
".",
"collection",
"folder_query",
"[",
"'title-exact'",
"]",
"=",
"'true'",
"docs",
"=",
"self",
".",
"client",
".",
"QueryDocumentListFeed",
"(",
"folder_query",
".",
"ToUri",
"(",
")",
")",
"if",
"docs",
".",
"entry",
":",
"folder_entry",
"=",
"docs",
".",
"entry",
"[",
"0",
"]",
"else",
":",
"folder_entry",
"=",
"self",
".",
"client",
".",
"CreateFolder",
"(",
"self",
".",
"collection",
")",
"file_handle",
"=",
"io",
".",
"BytesIO",
"(",
"file_contents",
")",
"media_source",
"=",
"gdata",
".",
"MediaSource",
"(",
"file_handle",
"=",
"file_handle",
",",
"content_type",
"=",
"'text/plain'",
",",
"content_length",
"=",
"len",
"(",
"file_contents",
")",
",",
"file_name",
"=",
"'temp'",
")",
"self",
".",
"docs_entry",
"=",
"self",
".",
"client",
".",
"Upload",
"(",
"media_source",
",",
"self",
".",
"_get_doc_title",
"(",
")",
",",
"folder_or_uri",
"=",
"folder_entry",
")",
"except",
"gdata",
".",
"service",
".",
"RequestError",
"as",
"ex",
":",
"try",
":",
"if",
"ex",
".",
"message",
"[",
"'reason'",
"]",
".",
"lower",
"(",
")",
".",
"find",
"(",
"'conflict'",
")",
"!=",
"-",
"1",
":",
"result",
"=",
"self",
".",
"CONFLICT",
"else",
":",
"# Google docs has a bug when updating a shared document",
"# using PUT from any account other that the owner.",
"# It returns an error 400 \"Sorry, there was an error saving",
"# the file. Please try again\"",
"# *despite* actually updating the document!",
"# Workaround by re-reading to see if it actually updated",
"msg",
"=",
"'Sorry, there was an error saving the file'",
"if",
"ex",
".",
"message",
"[",
"'body'",
"]",
".",
"find",
"(",
"msg",
")",
"!=",
"-",
"1",
":",
"new_docs_entry",
",",
"new_keyring_dict",
"=",
"self",
".",
"_read",
"(",
")",
"if",
"new_keyring_dict",
"==",
"keyring_dict",
":",
"result",
"=",
"self",
".",
"OK",
"else",
":",
"result",
"=",
"self",
".",
"FAIL",
"else",
":",
"result",
"=",
"self",
".",
"FAIL",
"except",
"Exception",
":",
"result",
"=",
"self",
".",
"FAIL",
"return",
"result"
] |
Helper to actually write the keyring to Google
|
[
"Helper",
"to",
"actually",
"write",
"the",
"keyring",
"to",
"Google"
] |
train
|
https://github.com/jaraco/keyrings.alt/blob/5b71223d12bf9ac6abd05b1b395f1efccb5ea660/keyrings/alt/Google.py#L247-L306
|
Boudewijn26/gTTS-token
|
gtts_token/gtts_token.py
|
Token.calculate_token
|
def calculate_token(self, text, seed=None):
""" Calculate the request token (`tk`) of a string
:param text: str The text to calculate a token for
:param seed: str The seed to use. By default this is the number of hours since epoch
"""
if seed is None:
seed = self._get_token_key()
[first_seed, second_seed] = seed.split(".")
try:
d = bytearray(text.encode('UTF-8'))
except UnicodeDecodeError:
# This will probably only occur when d is actually a str containing UTF-8 chars, which means we don't need
# to encode.
d = bytearray(text)
a = int(first_seed)
for value in d:
a += value
a = self._work_token(a, self.SALT_1)
a = self._work_token(a, self.SALT_2)
a ^= int(second_seed)
if 0 > a:
a = (a & 2147483647) + 2147483648
a %= 1E6
a = int(a)
return str(a) + "." + str(a ^ int(first_seed))
|
python
|
def calculate_token(self, text, seed=None):
""" Calculate the request token (`tk`) of a string
:param text: str The text to calculate a token for
:param seed: str The seed to use. By default this is the number of hours since epoch
"""
if seed is None:
seed = self._get_token_key()
[first_seed, second_seed] = seed.split(".")
try:
d = bytearray(text.encode('UTF-8'))
except UnicodeDecodeError:
# This will probably only occur when d is actually a str containing UTF-8 chars, which means we don't need
# to encode.
d = bytearray(text)
a = int(first_seed)
for value in d:
a += value
a = self._work_token(a, self.SALT_1)
a = self._work_token(a, self.SALT_2)
a ^= int(second_seed)
if 0 > a:
a = (a & 2147483647) + 2147483648
a %= 1E6
a = int(a)
return str(a) + "." + str(a ^ int(first_seed))
|
[
"def",
"calculate_token",
"(",
"self",
",",
"text",
",",
"seed",
"=",
"None",
")",
":",
"if",
"seed",
"is",
"None",
":",
"seed",
"=",
"self",
".",
"_get_token_key",
"(",
")",
"[",
"first_seed",
",",
"second_seed",
"]",
"=",
"seed",
".",
"split",
"(",
"\".\"",
")",
"try",
":",
"d",
"=",
"bytearray",
"(",
"text",
".",
"encode",
"(",
"'UTF-8'",
")",
")",
"except",
"UnicodeDecodeError",
":",
"# This will probably only occur when d is actually a str containing UTF-8 chars, which means we don't need",
"# to encode.",
"d",
"=",
"bytearray",
"(",
"text",
")",
"a",
"=",
"int",
"(",
"first_seed",
")",
"for",
"value",
"in",
"d",
":",
"a",
"+=",
"value",
"a",
"=",
"self",
".",
"_work_token",
"(",
"a",
",",
"self",
".",
"SALT_1",
")",
"a",
"=",
"self",
".",
"_work_token",
"(",
"a",
",",
"self",
".",
"SALT_2",
")",
"a",
"^=",
"int",
"(",
"second_seed",
")",
"if",
"0",
">",
"a",
":",
"a",
"=",
"(",
"a",
"&",
"2147483647",
")",
"+",
"2147483648",
"a",
"%=",
"1E6",
"a",
"=",
"int",
"(",
"a",
")",
"return",
"str",
"(",
"a",
")",
"+",
"\".\"",
"+",
"str",
"(",
"a",
"^",
"int",
"(",
"first_seed",
")",
")"
] |
Calculate the request token (`tk`) of a string
:param text: str The text to calculate a token for
:param seed: str The seed to use. By default this is the number of hours since epoch
|
[
"Calculate",
"the",
"request",
"token",
"(",
"tk",
")",
"of",
"a",
"string",
":",
"param",
"text",
":",
"str",
"The",
"text",
"to",
"calculate",
"a",
"token",
"for",
":",
"param",
"seed",
":",
"str",
"The",
"seed",
"to",
"use",
".",
"By",
"default",
"this",
"is",
"the",
"number",
"of",
"hours",
"since",
"epoch"
] |
train
|
https://github.com/Boudewijn26/gTTS-token/blob/9a1bb569bcce1ec091bfd9586dd54f9c879e7d3c/gtts_token/gtts_token.py#L21-L49
|
paddycarey/dweepy
|
dweepy/api.py
|
_request
|
def _request(method, url, session=None, **kwargs):
"""Make HTTP request, raising an exception if it fails.
"""
url = BASE_URL + url
if session:
request_func = getattr(session, method)
else:
request_func = getattr(requests, method)
response = request_func(url, **kwargs)
# raise an exception if request is not successful
if not response.status_code == requests.codes.ok:
raise DweepyError('HTTP {0} response'.format(response.status_code))
response_json = response.json()
if response_json['this'] == 'failed':
raise DweepyError(response_json['because'])
return response_json['with']
|
python
|
def _request(method, url, session=None, **kwargs):
"""Make HTTP request, raising an exception if it fails.
"""
url = BASE_URL + url
if session:
request_func = getattr(session, method)
else:
request_func = getattr(requests, method)
response = request_func(url, **kwargs)
# raise an exception if request is not successful
if not response.status_code == requests.codes.ok:
raise DweepyError('HTTP {0} response'.format(response.status_code))
response_json = response.json()
if response_json['this'] == 'failed':
raise DweepyError(response_json['because'])
return response_json['with']
|
[
"def",
"_request",
"(",
"method",
",",
"url",
",",
"session",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"url",
"=",
"BASE_URL",
"+",
"url",
"if",
"session",
":",
"request_func",
"=",
"getattr",
"(",
"session",
",",
"method",
")",
"else",
":",
"request_func",
"=",
"getattr",
"(",
"requests",
",",
"method",
")",
"response",
"=",
"request_func",
"(",
"url",
",",
"*",
"*",
"kwargs",
")",
"# raise an exception if request is not successful",
"if",
"not",
"response",
".",
"status_code",
"==",
"requests",
".",
"codes",
".",
"ok",
":",
"raise",
"DweepyError",
"(",
"'HTTP {0} response'",
".",
"format",
"(",
"response",
".",
"status_code",
")",
")",
"response_json",
"=",
"response",
".",
"json",
"(",
")",
"if",
"response_json",
"[",
"'this'",
"]",
"==",
"'failed'",
":",
"raise",
"DweepyError",
"(",
"response_json",
"[",
"'because'",
"]",
")",
"return",
"response_json",
"[",
"'with'",
"]"
] |
Make HTTP request, raising an exception if it fails.
|
[
"Make",
"HTTP",
"request",
"raising",
"an",
"exception",
"if",
"it",
"fails",
"."
] |
train
|
https://github.com/paddycarey/dweepy/blob/1eb69de4a20c929c57be2a21e2aa39ae9a0ae298/dweepy/api.py#L29-L45
|
paddycarey/dweepy
|
dweepy/api.py
|
_send_dweet
|
def _send_dweet(payload, url, params=None, session=None):
"""Send a dweet to dweet.io
"""
data = json.dumps(payload)
headers = {'Content-type': 'application/json'}
return _request('post', url, data=data, headers=headers, params=params, session=session)
|
python
|
def _send_dweet(payload, url, params=None, session=None):
"""Send a dweet to dweet.io
"""
data = json.dumps(payload)
headers = {'Content-type': 'application/json'}
return _request('post', url, data=data, headers=headers, params=params, session=session)
|
[
"def",
"_send_dweet",
"(",
"payload",
",",
"url",
",",
"params",
"=",
"None",
",",
"session",
"=",
"None",
")",
":",
"data",
"=",
"json",
".",
"dumps",
"(",
"payload",
")",
"headers",
"=",
"{",
"'Content-type'",
":",
"'application/json'",
"}",
"return",
"_request",
"(",
"'post'",
",",
"url",
",",
"data",
"=",
"data",
",",
"headers",
"=",
"headers",
",",
"params",
"=",
"params",
",",
"session",
"=",
"session",
")"
] |
Send a dweet to dweet.io
|
[
"Send",
"a",
"dweet",
"to",
"dweet",
".",
"io"
] |
train
|
https://github.com/paddycarey/dweepy/blob/1eb69de4a20c929c57be2a21e2aa39ae9a0ae298/dweepy/api.py#L48-L53
|
paddycarey/dweepy
|
dweepy/api.py
|
dweet_for
|
def dweet_for(thing_name, payload, key=None, session=None):
"""Send a dweet to dweet.io for a thing with a known name
"""
if key is not None:
params = {'key': key}
else:
params = None
return _send_dweet(payload, '/dweet/for/{0}'.format(thing_name), params=params, session=session)
|
python
|
def dweet_for(thing_name, payload, key=None, session=None):
"""Send a dweet to dweet.io for a thing with a known name
"""
if key is not None:
params = {'key': key}
else:
params = None
return _send_dweet(payload, '/dweet/for/{0}'.format(thing_name), params=params, session=session)
|
[
"def",
"dweet_for",
"(",
"thing_name",
",",
"payload",
",",
"key",
"=",
"None",
",",
"session",
"=",
"None",
")",
":",
"if",
"key",
"is",
"not",
"None",
":",
"params",
"=",
"{",
"'key'",
":",
"key",
"}",
"else",
":",
"params",
"=",
"None",
"return",
"_send_dweet",
"(",
"payload",
",",
"'/dweet/for/{0}'",
".",
"format",
"(",
"thing_name",
")",
",",
"params",
"=",
"params",
",",
"session",
"=",
"session",
")"
] |
Send a dweet to dweet.io for a thing with a known name
|
[
"Send",
"a",
"dweet",
"to",
"dweet",
".",
"io",
"for",
"a",
"thing",
"with",
"a",
"known",
"name"
] |
train
|
https://github.com/paddycarey/dweepy/blob/1eb69de4a20c929c57be2a21e2aa39ae9a0ae298/dweepy/api.py#L62-L69
|
paddycarey/dweepy
|
dweepy/api.py
|
get_dweets_for
|
def get_dweets_for(thing_name, key=None, session=None):
"""Read all the dweets for a dweeter
"""
if key is not None:
params = {'key': key}
else:
params = None
return _request('get', '/get/dweets/for/{0}'.format(thing_name), params=params, session=None)
|
python
|
def get_dweets_for(thing_name, key=None, session=None):
"""Read all the dweets for a dweeter
"""
if key is not None:
params = {'key': key}
else:
params = None
return _request('get', '/get/dweets/for/{0}'.format(thing_name), params=params, session=None)
|
[
"def",
"get_dweets_for",
"(",
"thing_name",
",",
"key",
"=",
"None",
",",
"session",
"=",
"None",
")",
":",
"if",
"key",
"is",
"not",
"None",
":",
"params",
"=",
"{",
"'key'",
":",
"key",
"}",
"else",
":",
"params",
"=",
"None",
"return",
"_request",
"(",
"'get'",
",",
"'/get/dweets/for/{0}'",
".",
"format",
"(",
"thing_name",
")",
",",
"params",
"=",
"params",
",",
"session",
"=",
"None",
")"
] |
Read all the dweets for a dweeter
|
[
"Read",
"all",
"the",
"dweets",
"for",
"a",
"dweeter"
] |
train
|
https://github.com/paddycarey/dweepy/blob/1eb69de4a20c929c57be2a21e2aa39ae9a0ae298/dweepy/api.py#L82-L89
|
paddycarey/dweepy
|
dweepy/api.py
|
remove_lock
|
def remove_lock(lock, key, session=None):
"""Remove a lock (no matter what it's connected to).
"""
return _request('get', '/remove/lock/{0}'.format(lock), params={'key': key}, session=session)
|
python
|
def remove_lock(lock, key, session=None):
"""Remove a lock (no matter what it's connected to).
"""
return _request('get', '/remove/lock/{0}'.format(lock), params={'key': key}, session=session)
|
[
"def",
"remove_lock",
"(",
"lock",
",",
"key",
",",
"session",
"=",
"None",
")",
":",
"return",
"_request",
"(",
"'get'",
",",
"'/remove/lock/{0}'",
".",
"format",
"(",
"lock",
")",
",",
"params",
"=",
"{",
"'key'",
":",
"key",
"}",
",",
"session",
"=",
"session",
")"
] |
Remove a lock (no matter what it's connected to).
|
[
"Remove",
"a",
"lock",
"(",
"no",
"matter",
"what",
"it",
"s",
"connected",
"to",
")",
"."
] |
train
|
https://github.com/paddycarey/dweepy/blob/1eb69de4a20c929c57be2a21e2aa39ae9a0ae298/dweepy/api.py#L92-L95
|
paddycarey/dweepy
|
dweepy/api.py
|
lock
|
def lock(thing_name, lock, key, session=None):
"""Lock a thing (prevents unauthed dweets for the locked thing)
"""
return _request('get', '/lock/{0}'.format(thing_name), params={'key': key, 'lock': lock}, session=session)
|
python
|
def lock(thing_name, lock, key, session=None):
"""Lock a thing (prevents unauthed dweets for the locked thing)
"""
return _request('get', '/lock/{0}'.format(thing_name), params={'key': key, 'lock': lock}, session=session)
|
[
"def",
"lock",
"(",
"thing_name",
",",
"lock",
",",
"key",
",",
"session",
"=",
"None",
")",
":",
"return",
"_request",
"(",
"'get'",
",",
"'/lock/{0}'",
".",
"format",
"(",
"thing_name",
")",
",",
"params",
"=",
"{",
"'key'",
":",
"key",
",",
"'lock'",
":",
"lock",
"}",
",",
"session",
"=",
"session",
")"
] |
Lock a thing (prevents unauthed dweets for the locked thing)
|
[
"Lock",
"a",
"thing",
"(",
"prevents",
"unauthed",
"dweets",
"for",
"the",
"locked",
"thing",
")"
] |
train
|
https://github.com/paddycarey/dweepy/blob/1eb69de4a20c929c57be2a21e2aa39ae9a0ae298/dweepy/api.py#L98-L101
|
paddycarey/dweepy
|
dweepy/api.py
|
unlock
|
def unlock(thing_name, key, session=None):
"""Unlock a thing
"""
return _request('get', '/unlock/{0}'.format(thing_name), params={'key': key}, session=session)
|
python
|
def unlock(thing_name, key, session=None):
"""Unlock a thing
"""
return _request('get', '/unlock/{0}'.format(thing_name), params={'key': key}, session=session)
|
[
"def",
"unlock",
"(",
"thing_name",
",",
"key",
",",
"session",
"=",
"None",
")",
":",
"return",
"_request",
"(",
"'get'",
",",
"'/unlock/{0}'",
".",
"format",
"(",
"thing_name",
")",
",",
"params",
"=",
"{",
"'key'",
":",
"key",
"}",
",",
"session",
"=",
"session",
")"
] |
Unlock a thing
|
[
"Unlock",
"a",
"thing"
] |
train
|
https://github.com/paddycarey/dweepy/blob/1eb69de4a20c929c57be2a21e2aa39ae9a0ae298/dweepy/api.py#L104-L107
|
paddycarey/dweepy
|
dweepy/api.py
|
set_alert
|
def set_alert(thing_name, who, condition, key, session=None):
"""Set an alert on a thing with the given condition
"""
return _request('get', '/alert/{0}/when/{1}/{2}'.format(
','.join(who),
thing_name,
quote(condition),
), params={'key': key}, session=session)
|
python
|
def set_alert(thing_name, who, condition, key, session=None):
"""Set an alert on a thing with the given condition
"""
return _request('get', '/alert/{0}/when/{1}/{2}'.format(
','.join(who),
thing_name,
quote(condition),
), params={'key': key}, session=session)
|
[
"def",
"set_alert",
"(",
"thing_name",
",",
"who",
",",
"condition",
",",
"key",
",",
"session",
"=",
"None",
")",
":",
"return",
"_request",
"(",
"'get'",
",",
"'/alert/{0}/when/{1}/{2}'",
".",
"format",
"(",
"','",
".",
"join",
"(",
"who",
")",
",",
"thing_name",
",",
"quote",
"(",
"condition",
")",
",",
")",
",",
"params",
"=",
"{",
"'key'",
":",
"key",
"}",
",",
"session",
"=",
"session",
")"
] |
Set an alert on a thing with the given condition
|
[
"Set",
"an",
"alert",
"on",
"a",
"thing",
"with",
"the",
"given",
"condition"
] |
train
|
https://github.com/paddycarey/dweepy/blob/1eb69de4a20c929c57be2a21e2aa39ae9a0ae298/dweepy/api.py#L110-L117
|
paddycarey/dweepy
|
dweepy/api.py
|
get_alert
|
def get_alert(thing_name, key, session=None):
"""Set an alert on a thing with the given condition
"""
return _request('get', '/get/alert/for/{0}'.format(thing_name), params={'key': key}, session=session)
|
python
|
def get_alert(thing_name, key, session=None):
"""Set an alert on a thing with the given condition
"""
return _request('get', '/get/alert/for/{0}'.format(thing_name), params={'key': key}, session=session)
|
[
"def",
"get_alert",
"(",
"thing_name",
",",
"key",
",",
"session",
"=",
"None",
")",
":",
"return",
"_request",
"(",
"'get'",
",",
"'/get/alert/for/{0}'",
".",
"format",
"(",
"thing_name",
")",
",",
"params",
"=",
"{",
"'key'",
":",
"key",
"}",
",",
"session",
"=",
"session",
")"
] |
Set an alert on a thing with the given condition
|
[
"Set",
"an",
"alert",
"on",
"a",
"thing",
"with",
"the",
"given",
"condition"
] |
train
|
https://github.com/paddycarey/dweepy/blob/1eb69de4a20c929c57be2a21e2aa39ae9a0ae298/dweepy/api.py#L120-L123
|
paddycarey/dweepy
|
dweepy/api.py
|
remove_alert
|
def remove_alert(thing_name, key, session=None):
"""Remove an alert for the given thing
"""
return _request('get', '/remove/alert/for/{0}'.format(thing_name), params={'key': key}, session=session)
|
python
|
def remove_alert(thing_name, key, session=None):
"""Remove an alert for the given thing
"""
return _request('get', '/remove/alert/for/{0}'.format(thing_name), params={'key': key}, session=session)
|
[
"def",
"remove_alert",
"(",
"thing_name",
",",
"key",
",",
"session",
"=",
"None",
")",
":",
"return",
"_request",
"(",
"'get'",
",",
"'/remove/alert/for/{0}'",
".",
"format",
"(",
"thing_name",
")",
",",
"params",
"=",
"{",
"'key'",
":",
"key",
"}",
",",
"session",
"=",
"session",
")"
] |
Remove an alert for the given thing
|
[
"Remove",
"an",
"alert",
"for",
"the",
"given",
"thing"
] |
train
|
https://github.com/paddycarey/dweepy/blob/1eb69de4a20c929c57be2a21e2aa39ae9a0ae298/dweepy/api.py#L126-L129
|
MalongTech/productai-python-sdk
|
productai/__init__.py
|
ProductSetAPI.get_product_sets
|
def get_product_sets(self):
"""
list all product sets for current user
"""
# ensure we are using api url without a specific product set id
api_url = super(ProductSetAPI, self).base_url
return self.client.get(api_url)
|
python
|
def get_product_sets(self):
"""
list all product sets for current user
"""
# ensure we are using api url without a specific product set id
api_url = super(ProductSetAPI, self).base_url
return self.client.get(api_url)
|
[
"def",
"get_product_sets",
"(",
"self",
")",
":",
"# ensure we are using api url without a specific product set id",
"api_url",
"=",
"super",
"(",
"ProductSetAPI",
",",
"self",
")",
".",
"base_url",
"return",
"self",
".",
"client",
".",
"get",
"(",
"api_url",
")"
] |
list all product sets for current user
|
[
"list",
"all",
"product",
"sets",
"for",
"current",
"user"
] |
train
|
https://github.com/MalongTech/productai-python-sdk/blob/2227783dbef4ce8e94613c08e67d65d6eecee21c/productai/__init__.py#L488-L494
|
MalongTech/productai-python-sdk
|
productai/__init__.py
|
ProductSetAPI.delete_all_product_sets
|
def delete_all_product_sets(self):
"""
BE NOTICED: this will delete all product sets for current user
"""
# ensure we are using api url without a specific product set id
api_url = super(ProductSetAPI, self).base_url
return self.client.delete(api_url)
|
python
|
def delete_all_product_sets(self):
"""
BE NOTICED: this will delete all product sets for current user
"""
# ensure we are using api url without a specific product set id
api_url = super(ProductSetAPI, self).base_url
return self.client.delete(api_url)
|
[
"def",
"delete_all_product_sets",
"(",
"self",
")",
":",
"# ensure we are using api url without a specific product set id",
"api_url",
"=",
"super",
"(",
"ProductSetAPI",
",",
"self",
")",
".",
"base_url",
"return",
"self",
".",
"client",
".",
"delete",
"(",
"api_url",
")"
] |
BE NOTICED: this will delete all product sets for current user
|
[
"BE",
"NOTICED",
":",
"this",
"will",
"delete",
"all",
"product",
"sets",
"for",
"current",
"user"
] |
train
|
https://github.com/MalongTech/productai-python-sdk/blob/2227783dbef4ce8e94613c08e67d65d6eecee21c/productai/__init__.py#L496-L502
|
MalongTech/productai-python-sdk
|
productai/__init__.py
|
ProductSetAPI.get_products
|
def get_products(self, product_ids):
"""
This function (and backend API) is being obsoleted. Don't use it anymore.
"""
if self.product_set_id is None:
raise ValueError('product_set_id must be specified')
data = {'ids': product_ids}
return self.client.get(self.base_url + '/products', json=data)
|
python
|
def get_products(self, product_ids):
"""
This function (and backend API) is being obsoleted. Don't use it anymore.
"""
if self.product_set_id is None:
raise ValueError('product_set_id must be specified')
data = {'ids': product_ids}
return self.client.get(self.base_url + '/products', json=data)
|
[
"def",
"get_products",
"(",
"self",
",",
"product_ids",
")",
":",
"if",
"self",
".",
"product_set_id",
"is",
"None",
":",
"raise",
"ValueError",
"(",
"'product_set_id must be specified'",
")",
"data",
"=",
"{",
"'ids'",
":",
"product_ids",
"}",
"return",
"self",
".",
"client",
".",
"get",
"(",
"self",
".",
"base_url",
"+",
"'/products'",
",",
"json",
"=",
"data",
")"
] |
This function (and backend API) is being obsoleted. Don't use it anymore.
|
[
"This",
"function",
"(",
"and",
"backend",
"API",
")",
"is",
"being",
"obsoleted",
".",
"Don",
"t",
"use",
"it",
"anymore",
"."
] |
train
|
https://github.com/MalongTech/productai-python-sdk/blob/2227783dbef4ce8e94613c08e67d65d6eecee21c/productai/__init__.py#L544-L551
|
paddycarey/dweepy
|
dweepy/streaming.py
|
_check_stream_timeout
|
def _check_stream_timeout(started, timeout):
"""Check if the timeout has been reached and raise a `StopIteration` if so.
"""
if timeout:
elapsed = datetime.datetime.utcnow() - started
if elapsed.seconds > timeout:
raise StopIteration
|
python
|
def _check_stream_timeout(started, timeout):
"""Check if the timeout has been reached and raise a `StopIteration` if so.
"""
if timeout:
elapsed = datetime.datetime.utcnow() - started
if elapsed.seconds > timeout:
raise StopIteration
|
[
"def",
"_check_stream_timeout",
"(",
"started",
",",
"timeout",
")",
":",
"if",
"timeout",
":",
"elapsed",
"=",
"datetime",
".",
"datetime",
".",
"utcnow",
"(",
")",
"-",
"started",
"if",
"elapsed",
".",
"seconds",
">",
"timeout",
":",
"raise",
"StopIteration"
] |
Check if the timeout has been reached and raise a `StopIteration` if so.
|
[
"Check",
"if",
"the",
"timeout",
"has",
"been",
"reached",
"and",
"raise",
"a",
"StopIteration",
"if",
"so",
"."
] |
train
|
https://github.com/paddycarey/dweepy/blob/1eb69de4a20c929c57be2a21e2aa39ae9a0ae298/dweepy/streaming.py#L32-L38
|
paddycarey/dweepy
|
dweepy/streaming.py
|
_listen_for_dweets_from_response
|
def _listen_for_dweets_from_response(response):
"""Yields dweets as received from dweet.io's streaming API
"""
streambuffer = ''
for byte in response.iter_content():
if byte:
streambuffer += byte.decode('ascii')
try:
dweet = json.loads(streambuffer.splitlines()[1])
except (IndexError, ValueError):
continue
if isstr(dweet):
yield json.loads(dweet)
streambuffer = ''
|
python
|
def _listen_for_dweets_from_response(response):
"""Yields dweets as received from dweet.io's streaming API
"""
streambuffer = ''
for byte in response.iter_content():
if byte:
streambuffer += byte.decode('ascii')
try:
dweet = json.loads(streambuffer.splitlines()[1])
except (IndexError, ValueError):
continue
if isstr(dweet):
yield json.loads(dweet)
streambuffer = ''
|
[
"def",
"_listen_for_dweets_from_response",
"(",
"response",
")",
":",
"streambuffer",
"=",
"''",
"for",
"byte",
"in",
"response",
".",
"iter_content",
"(",
")",
":",
"if",
"byte",
":",
"streambuffer",
"+=",
"byte",
".",
"decode",
"(",
"'ascii'",
")",
"try",
":",
"dweet",
"=",
"json",
".",
"loads",
"(",
"streambuffer",
".",
"splitlines",
"(",
")",
"[",
"1",
"]",
")",
"except",
"(",
"IndexError",
",",
"ValueError",
")",
":",
"continue",
"if",
"isstr",
"(",
"dweet",
")",
":",
"yield",
"json",
".",
"loads",
"(",
"dweet",
")",
"streambuffer",
"=",
"''"
] |
Yields dweets as received from dweet.io's streaming API
|
[
"Yields",
"dweets",
"as",
"received",
"from",
"dweet",
".",
"io",
"s",
"streaming",
"API"
] |
train
|
https://github.com/paddycarey/dweepy/blob/1eb69de4a20c929c57be2a21e2aa39ae9a0ae298/dweepy/streaming.py#L41-L54
|
paddycarey/dweepy
|
dweepy/streaming.py
|
listen_for_dweets_from
|
def listen_for_dweets_from(thing_name, timeout=900, key=None, session=None):
"""Create a real-time subscription to dweets
"""
url = BASE_URL + '/listen/for/dweets/from/{0}'.format(thing_name)
session = session or requests.Session()
if key is not None:
params = {'key': key}
else:
params = None
start = datetime.datetime.utcnow()
while True:
request = requests.Request("GET", url, params=params).prepare()
resp = session.send(request, stream=True, timeout=timeout)
try:
for x in _listen_for_dweets_from_response(resp):
yield x
_check_stream_timeout(start, timeout)
except (ChunkedEncodingError, requests.exceptions.ConnectionError, requests.exceptions.ReadTimeout):
pass
_check_stream_timeout(start, timeout)
|
python
|
def listen_for_dweets_from(thing_name, timeout=900, key=None, session=None):
"""Create a real-time subscription to dweets
"""
url = BASE_URL + '/listen/for/dweets/from/{0}'.format(thing_name)
session = session or requests.Session()
if key is not None:
params = {'key': key}
else:
params = None
start = datetime.datetime.utcnow()
while True:
request = requests.Request("GET", url, params=params).prepare()
resp = session.send(request, stream=True, timeout=timeout)
try:
for x in _listen_for_dweets_from_response(resp):
yield x
_check_stream_timeout(start, timeout)
except (ChunkedEncodingError, requests.exceptions.ConnectionError, requests.exceptions.ReadTimeout):
pass
_check_stream_timeout(start, timeout)
|
[
"def",
"listen_for_dweets_from",
"(",
"thing_name",
",",
"timeout",
"=",
"900",
",",
"key",
"=",
"None",
",",
"session",
"=",
"None",
")",
":",
"url",
"=",
"BASE_URL",
"+",
"'/listen/for/dweets/from/{0}'",
".",
"format",
"(",
"thing_name",
")",
"session",
"=",
"session",
"or",
"requests",
".",
"Session",
"(",
")",
"if",
"key",
"is",
"not",
"None",
":",
"params",
"=",
"{",
"'key'",
":",
"key",
"}",
"else",
":",
"params",
"=",
"None",
"start",
"=",
"datetime",
".",
"datetime",
".",
"utcnow",
"(",
")",
"while",
"True",
":",
"request",
"=",
"requests",
".",
"Request",
"(",
"\"GET\"",
",",
"url",
",",
"params",
"=",
"params",
")",
".",
"prepare",
"(",
")",
"resp",
"=",
"session",
".",
"send",
"(",
"request",
",",
"stream",
"=",
"True",
",",
"timeout",
"=",
"timeout",
")",
"try",
":",
"for",
"x",
"in",
"_listen_for_dweets_from_response",
"(",
"resp",
")",
":",
"yield",
"x",
"_check_stream_timeout",
"(",
"start",
",",
"timeout",
")",
"except",
"(",
"ChunkedEncodingError",
",",
"requests",
".",
"exceptions",
".",
"ConnectionError",
",",
"requests",
".",
"exceptions",
".",
"ReadTimeout",
")",
":",
"pass",
"_check_stream_timeout",
"(",
"start",
",",
"timeout",
")"
] |
Create a real-time subscription to dweets
|
[
"Create",
"a",
"real",
"-",
"time",
"subscription",
"to",
"dweets"
] |
train
|
https://github.com/paddycarey/dweepy/blob/1eb69de4a20c929c57be2a21e2aa39ae9a0ae298/dweepy/streaming.py#L57-L77
|
MalongTech/productai-python-sdk
|
productai/bad_case.py
|
BadCaseApi.add
|
def add(self, service_id, request_id, description=None, details=None):
if not service_id:
raise ValueError('service_id is required')
if not request_id:
raise ValueError('request_id is required')
"""
curl -X POST \
-H 'x-ca-version: 1.0' \
-H 'x-ca-accesskeyid: YourAccessId' \
-d "service_id=p4dkh2sg&request_id=c13ed5aa-d6d2-11e8-ba11-02420a582a05&description=blahlblah" \
https://api.productai.cn/bad_cases/_0000204
"""
data = dict()
data['service_id'] = service_id
data['request_id'] = request_id
if description:
data['description'] = description
if details:
data['details'] = details
"""
{
"created_at": "2018-10-24T03:30:51Z",
"description": "\u8fd9\u662f\u4e00\u4e2a\u6d4b\u8bd5",
"details": "",
"id": 34,
"image_path": null,
"modified_at": "2018-10-24T03:30:51Z",
"reporter_id": 1632,
"request_id": "34954696-d73d-11e8-9419-0242ac1c2b04",
"service_id": "p4dkh2sg",
"status": "open"
}
"""
return self.client.post(self.base_url, data=data)
|
python
|
def add(self, service_id, request_id, description=None, details=None):
if not service_id:
raise ValueError('service_id is required')
if not request_id:
raise ValueError('request_id is required')
"""
curl -X POST \
-H 'x-ca-version: 1.0' \
-H 'x-ca-accesskeyid: YourAccessId' \
-d "service_id=p4dkh2sg&request_id=c13ed5aa-d6d2-11e8-ba11-02420a582a05&description=blahlblah" \
https://api.productai.cn/bad_cases/_0000204
"""
data = dict()
data['service_id'] = service_id
data['request_id'] = request_id
if description:
data['description'] = description
if details:
data['details'] = details
"""
{
"created_at": "2018-10-24T03:30:51Z",
"description": "\u8fd9\u662f\u4e00\u4e2a\u6d4b\u8bd5",
"details": "",
"id": 34,
"image_path": null,
"modified_at": "2018-10-24T03:30:51Z",
"reporter_id": 1632,
"request_id": "34954696-d73d-11e8-9419-0242ac1c2b04",
"service_id": "p4dkh2sg",
"status": "open"
}
"""
return self.client.post(self.base_url, data=data)
|
[
"def",
"add",
"(",
"self",
",",
"service_id",
",",
"request_id",
",",
"description",
"=",
"None",
",",
"details",
"=",
"None",
")",
":",
"if",
"not",
"service_id",
":",
"raise",
"ValueError",
"(",
"'service_id is required'",
")",
"if",
"not",
"request_id",
":",
"raise",
"ValueError",
"(",
"'request_id is required'",
")",
"data",
"=",
"dict",
"(",
")",
"data",
"[",
"'service_id'",
"]",
"=",
"service_id",
"data",
"[",
"'request_id'",
"]",
"=",
"request_id",
"if",
"description",
":",
"data",
"[",
"'description'",
"]",
"=",
"description",
"if",
"details",
":",
"data",
"[",
"'details'",
"]",
"=",
"details",
"\"\"\"\n{\n\"created_at\": \"2018-10-24T03:30:51Z\",\n\"description\": \"\\u8fd9\\u662f\\u4e00\\u4e2a\\u6d4b\\u8bd5\",\n\"details\": \"\",\n\"id\": 34,\n\"image_path\": null,\n\"modified_at\": \"2018-10-24T03:30:51Z\",\n\"reporter_id\": 1632,\n\"request_id\": \"34954696-d73d-11e8-9419-0242ac1c2b04\",\n\"service_id\": \"p4dkh2sg\",\n\"status\": \"open\"\n} \n \"\"\"",
"return",
"self",
".",
"client",
".",
"post",
"(",
"self",
".",
"base_url",
",",
"data",
"=",
"data",
")"
] |
curl -X POST \
-H 'x-ca-version: 1.0' \
-H 'x-ca-accesskeyid: YourAccessId' \
-d "service_id=p4dkh2sg&request_id=c13ed5aa-d6d2-11e8-ba11-02420a582a05&description=blahlblah" \
https://api.productai.cn/bad_cases/_0000204
|
[
"curl",
"-",
"X",
"POST",
"\\",
"-",
"H",
"x",
"-",
"ca",
"-",
"version",
":",
"1",
".",
"0",
"\\",
"-",
"H",
"x",
"-",
"ca",
"-",
"accesskeyid",
":",
"YourAccessId",
"\\",
"-",
"d",
"service_id",
"=",
"p4dkh2sg&request_id",
"=",
"c13ed5aa",
"-",
"d6d2",
"-",
"11e8",
"-",
"ba11",
"-",
"02420a582a05&description",
"=",
"blahlblah",
"\\",
"https",
":",
"//",
"api",
".",
"productai",
".",
"cn",
"/",
"bad_cases",
"/",
"_0000204"
] |
train
|
https://github.com/MalongTech/productai-python-sdk/blob/2227783dbef4ce8e94613c08e67d65d6eecee21c/productai/bad_case.py#L9-L47
|
nir0s/python-packer
|
packer.py
|
Packer.build
|
def build(self, parallel=True, debug=False, force=False,
machine_readable=False):
"""Executes a `packer build`
:param bool parallel: Run builders in parallel
:param bool debug: Run in debug mode
:param bool force: Force artifact output even if exists
:param bool machine_readable: Make output machine-readable
"""
self.packer_cmd = self.packer.build
self._add_opt('-parallel=true' if parallel else None)
self._add_opt('-debug' if debug else None)
self._add_opt('-force' if force else None)
self._add_opt('-machine-readable' if machine_readable else None)
self._append_base_arguments()
self._add_opt(self.packerfile)
return self.packer_cmd()
|
python
|
def build(self, parallel=True, debug=False, force=False,
machine_readable=False):
"""Executes a `packer build`
:param bool parallel: Run builders in parallel
:param bool debug: Run in debug mode
:param bool force: Force artifact output even if exists
:param bool machine_readable: Make output machine-readable
"""
self.packer_cmd = self.packer.build
self._add_opt('-parallel=true' if parallel else None)
self._add_opt('-debug' if debug else None)
self._add_opt('-force' if force else None)
self._add_opt('-machine-readable' if machine_readable else None)
self._append_base_arguments()
self._add_opt(self.packerfile)
return self.packer_cmd()
|
[
"def",
"build",
"(",
"self",
",",
"parallel",
"=",
"True",
",",
"debug",
"=",
"False",
",",
"force",
"=",
"False",
",",
"machine_readable",
"=",
"False",
")",
":",
"self",
".",
"packer_cmd",
"=",
"self",
".",
"packer",
".",
"build",
"self",
".",
"_add_opt",
"(",
"'-parallel=true'",
"if",
"parallel",
"else",
"None",
")",
"self",
".",
"_add_opt",
"(",
"'-debug'",
"if",
"debug",
"else",
"None",
")",
"self",
".",
"_add_opt",
"(",
"'-force'",
"if",
"force",
"else",
"None",
")",
"self",
".",
"_add_opt",
"(",
"'-machine-readable'",
"if",
"machine_readable",
"else",
"None",
")",
"self",
".",
"_append_base_arguments",
"(",
")",
"self",
".",
"_add_opt",
"(",
"self",
".",
"packerfile",
")",
"return",
"self",
".",
"packer_cmd",
"(",
")"
] |
Executes a `packer build`
:param bool parallel: Run builders in parallel
:param bool debug: Run in debug mode
:param bool force: Force artifact output even if exists
:param bool machine_readable: Make output machine-readable
|
[
"Executes",
"a",
"packer",
"build"
] |
train
|
https://github.com/nir0s/python-packer/blob/aebb9936e1f7fbfc75131cf2b0284239298faced/packer.py#L44-L62
|
nir0s/python-packer
|
packer.py
|
Packer.fix
|
def fix(self, to_file=None):
"""Implements the `packer fix` function
:param string to_file: File to output fixed template to
"""
self.packer_cmd = self.packer.fix
self._add_opt(self.packerfile)
result = self.packer_cmd()
if to_file:
with open(to_file, 'w') as f:
f.write(result.stdout.decode())
result.fixed = json.loads(result.stdout.decode())
return result
|
python
|
def fix(self, to_file=None):
"""Implements the `packer fix` function
:param string to_file: File to output fixed template to
"""
self.packer_cmd = self.packer.fix
self._add_opt(self.packerfile)
result = self.packer_cmd()
if to_file:
with open(to_file, 'w') as f:
f.write(result.stdout.decode())
result.fixed = json.loads(result.stdout.decode())
return result
|
[
"def",
"fix",
"(",
"self",
",",
"to_file",
"=",
"None",
")",
":",
"self",
".",
"packer_cmd",
"=",
"self",
".",
"packer",
".",
"fix",
"self",
".",
"_add_opt",
"(",
"self",
".",
"packerfile",
")",
"result",
"=",
"self",
".",
"packer_cmd",
"(",
")",
"if",
"to_file",
":",
"with",
"open",
"(",
"to_file",
",",
"'w'",
")",
"as",
"f",
":",
"f",
".",
"write",
"(",
"result",
".",
"stdout",
".",
"decode",
"(",
")",
")",
"result",
".",
"fixed",
"=",
"json",
".",
"loads",
"(",
"result",
".",
"stdout",
".",
"decode",
"(",
")",
")",
"return",
"result"
] |
Implements the `packer fix` function
:param string to_file: File to output fixed template to
|
[
"Implements",
"the",
"packer",
"fix",
"function"
] |
train
|
https://github.com/nir0s/python-packer/blob/aebb9936e1f7fbfc75131cf2b0284239298faced/packer.py#L64-L78
|
nir0s/python-packer
|
packer.py
|
Packer.inspect
|
def inspect(self, mrf=True):
"""Inspects a Packer Templates file (`packer inspect -machine-readable`)
To return the output in a readable form, the `-machine-readable` flag
is appended automatically, afterwhich the output is parsed and returned
as a dict of the following format:
"variables": [
{
"name": "aws_access_key",
"value": "{{env `AWS_ACCESS_KEY_ID`}}"
},
{
"name": "aws_secret_key",
"value": "{{env `AWS_ACCESS_KEY`}}"
}
],
"provisioners": [
{
"type": "shell"
}
],
"builders": [
{
"type": "amazon-ebs",
"name": "amazon"
}
]
:param bool mrf: output in machine-readable form.
"""
self.packer_cmd = self.packer.inspect
self._add_opt('-machine-readable' if mrf else None)
self._add_opt(self.packerfile)
result = self.packer_cmd()
if mrf:
result.parsed_output = self._parse_inspection_output(
result.stdout.decode())
else:
result.parsed_output = None
return result
|
python
|
def inspect(self, mrf=True):
"""Inspects a Packer Templates file (`packer inspect -machine-readable`)
To return the output in a readable form, the `-machine-readable` flag
is appended automatically, afterwhich the output is parsed and returned
as a dict of the following format:
"variables": [
{
"name": "aws_access_key",
"value": "{{env `AWS_ACCESS_KEY_ID`}}"
},
{
"name": "aws_secret_key",
"value": "{{env `AWS_ACCESS_KEY`}}"
}
],
"provisioners": [
{
"type": "shell"
}
],
"builders": [
{
"type": "amazon-ebs",
"name": "amazon"
}
]
:param bool mrf: output in machine-readable form.
"""
self.packer_cmd = self.packer.inspect
self._add_opt('-machine-readable' if mrf else None)
self._add_opt(self.packerfile)
result = self.packer_cmd()
if mrf:
result.parsed_output = self._parse_inspection_output(
result.stdout.decode())
else:
result.parsed_output = None
return result
|
[
"def",
"inspect",
"(",
"self",
",",
"mrf",
"=",
"True",
")",
":",
"self",
".",
"packer_cmd",
"=",
"self",
".",
"packer",
".",
"inspect",
"self",
".",
"_add_opt",
"(",
"'-machine-readable'",
"if",
"mrf",
"else",
"None",
")",
"self",
".",
"_add_opt",
"(",
"self",
".",
"packerfile",
")",
"result",
"=",
"self",
".",
"packer_cmd",
"(",
")",
"if",
"mrf",
":",
"result",
".",
"parsed_output",
"=",
"self",
".",
"_parse_inspection_output",
"(",
"result",
".",
"stdout",
".",
"decode",
"(",
")",
")",
"else",
":",
"result",
".",
"parsed_output",
"=",
"None",
"return",
"result"
] |
Inspects a Packer Templates file (`packer inspect -machine-readable`)
To return the output in a readable form, the `-machine-readable` flag
is appended automatically, afterwhich the output is parsed and returned
as a dict of the following format:
"variables": [
{
"name": "aws_access_key",
"value": "{{env `AWS_ACCESS_KEY_ID`}}"
},
{
"name": "aws_secret_key",
"value": "{{env `AWS_ACCESS_KEY`}}"
}
],
"provisioners": [
{
"type": "shell"
}
],
"builders": [
{
"type": "amazon-ebs",
"name": "amazon"
}
]
:param bool mrf: output in machine-readable form.
|
[
"Inspects",
"a",
"Packer",
"Templates",
"file",
"(",
"packer",
"inspect",
"-",
"machine",
"-",
"readable",
")"
] |
train
|
https://github.com/nir0s/python-packer/blob/aebb9936e1f7fbfc75131cf2b0284239298faced/packer.py#L80-L121
|
nir0s/python-packer
|
packer.py
|
Packer.push
|
def push(self, create=True, token=False):
"""Implmenets the `packer push` function
UNTESTED! Must be used alongside an Atlas account
"""
self.packer_cmd = self.packer.push
self._add_opt('-create=true' if create else None)
self._add_opt('-tokn={0}'.format(token) if token else None)
self._add_opt(self.packerfile)
return self.packer_cmd()
|
python
|
def push(self, create=True, token=False):
"""Implmenets the `packer push` function
UNTESTED! Must be used alongside an Atlas account
"""
self.packer_cmd = self.packer.push
self._add_opt('-create=true' if create else None)
self._add_opt('-tokn={0}'.format(token) if token else None)
self._add_opt(self.packerfile)
return self.packer_cmd()
|
[
"def",
"push",
"(",
"self",
",",
"create",
"=",
"True",
",",
"token",
"=",
"False",
")",
":",
"self",
".",
"packer_cmd",
"=",
"self",
".",
"packer",
".",
"push",
"self",
".",
"_add_opt",
"(",
"'-create=true'",
"if",
"create",
"else",
"None",
")",
"self",
".",
"_add_opt",
"(",
"'-tokn={0}'",
".",
"format",
"(",
"token",
")",
"if",
"token",
"else",
"None",
")",
"self",
".",
"_add_opt",
"(",
"self",
".",
"packerfile",
")",
"return",
"self",
".",
"packer_cmd",
"(",
")"
] |
Implmenets the `packer push` function
UNTESTED! Must be used alongside an Atlas account
|
[
"Implmenets",
"the",
"packer",
"push",
"function"
] |
train
|
https://github.com/nir0s/python-packer/blob/aebb9936e1f7fbfc75131cf2b0284239298faced/packer.py#L123-L134
|
nir0s/python-packer
|
packer.py
|
Packer.validate
|
def validate(self, syntax_only=False):
"""Validates a Packer Template file (`packer validate`)
If the validation failed, an `sh` exception will be raised.
:param bool syntax_only: Whether to validate the syntax only
without validating the configuration itself.
"""
self.packer_cmd = self.packer.validate
self._add_opt('-syntax-only' if syntax_only else None)
self._append_base_arguments()
self._add_opt(self.packerfile)
# as sh raises an exception rather than return a value when execution
# fails we create an object to return the exception and the validation
# state
try:
validation = self.packer_cmd()
validation.succeeded = validation.exit_code == 0
validation.error = None
except Exception as ex:
validation = ValidationObject()
validation.succeeded = False
validation.failed = True
validation.error = ex.message
return validation
|
python
|
def validate(self, syntax_only=False):
"""Validates a Packer Template file (`packer validate`)
If the validation failed, an `sh` exception will be raised.
:param bool syntax_only: Whether to validate the syntax only
without validating the configuration itself.
"""
self.packer_cmd = self.packer.validate
self._add_opt('-syntax-only' if syntax_only else None)
self._append_base_arguments()
self._add_opt(self.packerfile)
# as sh raises an exception rather than return a value when execution
# fails we create an object to return the exception and the validation
# state
try:
validation = self.packer_cmd()
validation.succeeded = validation.exit_code == 0
validation.error = None
except Exception as ex:
validation = ValidationObject()
validation.succeeded = False
validation.failed = True
validation.error = ex.message
return validation
|
[
"def",
"validate",
"(",
"self",
",",
"syntax_only",
"=",
"False",
")",
":",
"self",
".",
"packer_cmd",
"=",
"self",
".",
"packer",
".",
"validate",
"self",
".",
"_add_opt",
"(",
"'-syntax-only'",
"if",
"syntax_only",
"else",
"None",
")",
"self",
".",
"_append_base_arguments",
"(",
")",
"self",
".",
"_add_opt",
"(",
"self",
".",
"packerfile",
")",
"# as sh raises an exception rather than return a value when execution",
"# fails we create an object to return the exception and the validation",
"# state",
"try",
":",
"validation",
"=",
"self",
".",
"packer_cmd",
"(",
")",
"validation",
".",
"succeeded",
"=",
"validation",
".",
"exit_code",
"==",
"0",
"validation",
".",
"error",
"=",
"None",
"except",
"Exception",
"as",
"ex",
":",
"validation",
"=",
"ValidationObject",
"(",
")",
"validation",
".",
"succeeded",
"=",
"False",
"validation",
".",
"failed",
"=",
"True",
"validation",
".",
"error",
"=",
"ex",
".",
"message",
"return",
"validation"
] |
Validates a Packer Template file (`packer validate`)
If the validation failed, an `sh` exception will be raised.
:param bool syntax_only: Whether to validate the syntax only
without validating the configuration itself.
|
[
"Validates",
"a",
"Packer",
"Template",
"file",
"(",
"packer",
"validate",
")"
] |
train
|
https://github.com/nir0s/python-packer/blob/aebb9936e1f7fbfc75131cf2b0284239298faced/packer.py#L136-L161
|
nir0s/python-packer
|
packer.py
|
Packer._append_base_arguments
|
def _append_base_arguments(self):
"""Appends base arguments to packer commands.
-except, -only, -var and -var-file are appeneded to almost
all subcommands in packer. As such this can be called to add
these flags to the subcommand.
"""
if self.exc and self.only:
raise PackerException('Cannot provide both "except" and "only"')
elif self.exc:
self._add_opt('-except={0}'.format(self._join_comma(self.exc)))
elif self.only:
self._add_opt('-only={0}'.format(self._join_comma(self.only)))
for var, value in self.vars.items():
self._add_opt("-var")
self._add_opt("{0}={1}".format(var, value))
if self.var_file:
self._add_opt('-var-file={0}'.format(self.var_file))
|
python
|
def _append_base_arguments(self):
"""Appends base arguments to packer commands.
-except, -only, -var and -var-file are appeneded to almost
all subcommands in packer. As such this can be called to add
these flags to the subcommand.
"""
if self.exc and self.only:
raise PackerException('Cannot provide both "except" and "only"')
elif self.exc:
self._add_opt('-except={0}'.format(self._join_comma(self.exc)))
elif self.only:
self._add_opt('-only={0}'.format(self._join_comma(self.only)))
for var, value in self.vars.items():
self._add_opt("-var")
self._add_opt("{0}={1}".format(var, value))
if self.var_file:
self._add_opt('-var-file={0}'.format(self.var_file))
|
[
"def",
"_append_base_arguments",
"(",
"self",
")",
":",
"if",
"self",
".",
"exc",
"and",
"self",
".",
"only",
":",
"raise",
"PackerException",
"(",
"'Cannot provide both \"except\" and \"only\"'",
")",
"elif",
"self",
".",
"exc",
":",
"self",
".",
"_add_opt",
"(",
"'-except={0}'",
".",
"format",
"(",
"self",
".",
"_join_comma",
"(",
"self",
".",
"exc",
")",
")",
")",
"elif",
"self",
".",
"only",
":",
"self",
".",
"_add_opt",
"(",
"'-only={0}'",
".",
"format",
"(",
"self",
".",
"_join_comma",
"(",
"self",
".",
"only",
")",
")",
")",
"for",
"var",
",",
"value",
"in",
"self",
".",
"vars",
".",
"items",
"(",
")",
":",
"self",
".",
"_add_opt",
"(",
"\"-var\"",
")",
"self",
".",
"_add_opt",
"(",
"\"{0}={1}\"",
".",
"format",
"(",
"var",
",",
"value",
")",
")",
"if",
"self",
".",
"var_file",
":",
"self",
".",
"_add_opt",
"(",
"'-var-file={0}'",
".",
"format",
"(",
"self",
".",
"var_file",
")",
")"
] |
Appends base arguments to packer commands.
-except, -only, -var and -var-file are appeneded to almost
all subcommands in packer. As such this can be called to add
these flags to the subcommand.
|
[
"Appends",
"base",
"arguments",
"to",
"packer",
"commands",
"."
] |
train
|
https://github.com/nir0s/python-packer/blob/aebb9936e1f7fbfc75131cf2b0284239298faced/packer.py#L183-L200
|
nir0s/python-packer
|
packer.py
|
Packer._parse_inspection_output
|
def _parse_inspection_output(self, output):
"""Parses the machine-readable output `packer inspect` provides.
See the inspect method for more info.
This has been tested vs. Packer v0.7.5
"""
parts = {'variables': [], 'builders': [], 'provisioners': []}
for line in output.splitlines():
line = line.split(',')
if line[2].startswith('template'):
del line[0:2]
component = line[0]
if component == 'template-variable':
variable = {"name": line[1], "value": line[2]}
parts['variables'].append(variable)
elif component == 'template-builder':
builder = {"name": line[1], "type": line[2]}
parts['builders'].append(builder)
elif component == 'template-provisioner':
provisioner = {"type": line[1]}
parts['provisioners'].append(provisioner)
return parts
|
python
|
def _parse_inspection_output(self, output):
"""Parses the machine-readable output `packer inspect` provides.
See the inspect method for more info.
This has been tested vs. Packer v0.7.5
"""
parts = {'variables': [], 'builders': [], 'provisioners': []}
for line in output.splitlines():
line = line.split(',')
if line[2].startswith('template'):
del line[0:2]
component = line[0]
if component == 'template-variable':
variable = {"name": line[1], "value": line[2]}
parts['variables'].append(variable)
elif component == 'template-builder':
builder = {"name": line[1], "type": line[2]}
parts['builders'].append(builder)
elif component == 'template-provisioner':
provisioner = {"type": line[1]}
parts['provisioners'].append(provisioner)
return parts
|
[
"def",
"_parse_inspection_output",
"(",
"self",
",",
"output",
")",
":",
"parts",
"=",
"{",
"'variables'",
":",
"[",
"]",
",",
"'builders'",
":",
"[",
"]",
",",
"'provisioners'",
":",
"[",
"]",
"}",
"for",
"line",
"in",
"output",
".",
"splitlines",
"(",
")",
":",
"line",
"=",
"line",
".",
"split",
"(",
"','",
")",
"if",
"line",
"[",
"2",
"]",
".",
"startswith",
"(",
"'template'",
")",
":",
"del",
"line",
"[",
"0",
":",
"2",
"]",
"component",
"=",
"line",
"[",
"0",
"]",
"if",
"component",
"==",
"'template-variable'",
":",
"variable",
"=",
"{",
"\"name\"",
":",
"line",
"[",
"1",
"]",
",",
"\"value\"",
":",
"line",
"[",
"2",
"]",
"}",
"parts",
"[",
"'variables'",
"]",
".",
"append",
"(",
"variable",
")",
"elif",
"component",
"==",
"'template-builder'",
":",
"builder",
"=",
"{",
"\"name\"",
":",
"line",
"[",
"1",
"]",
",",
"\"type\"",
":",
"line",
"[",
"2",
"]",
"}",
"parts",
"[",
"'builders'",
"]",
".",
"append",
"(",
"builder",
")",
"elif",
"component",
"==",
"'template-provisioner'",
":",
"provisioner",
"=",
"{",
"\"type\"",
":",
"line",
"[",
"1",
"]",
"}",
"parts",
"[",
"'provisioners'",
"]",
".",
"append",
"(",
"provisioner",
")",
"return",
"parts"
] |
Parses the machine-readable output `packer inspect` provides.
See the inspect method for more info.
This has been tested vs. Packer v0.7.5
|
[
"Parses",
"the",
"machine",
"-",
"readable",
"output",
"packer",
"inspect",
"provides",
"."
] |
train
|
https://github.com/nir0s/python-packer/blob/aebb9936e1f7fbfc75131cf2b0284239298faced/packer.py#L206-L227
|
versae/neo4j-rest-client
|
neo4jrestclient/request.py
|
Request.post
|
def post(self, url, data, headers=None):
"""
Perform an HTTP POST request for a given url.
Returns the response object.
"""
return self._request('POST', url, data, headers=headers)
|
python
|
def post(self, url, data, headers=None):
"""
Perform an HTTP POST request for a given url.
Returns the response object.
"""
return self._request('POST', url, data, headers=headers)
|
[
"def",
"post",
"(",
"self",
",",
"url",
",",
"data",
",",
"headers",
"=",
"None",
")",
":",
"return",
"self",
".",
"_request",
"(",
"'POST'",
",",
"url",
",",
"data",
",",
"headers",
"=",
"headers",
")"
] |
Perform an HTTP POST request for a given url.
Returns the response object.
|
[
"Perform",
"an",
"HTTP",
"POST",
"request",
"for",
"a",
"given",
"url",
".",
"Returns",
"the",
"response",
"object",
"."
] |
train
|
https://github.com/versae/neo4j-rest-client/blob/b03c09c8f598fa4dbad8ea8998ffb1c885805074/neo4jrestclient/request.py#L65-L70
|
versae/neo4j-rest-client
|
neo4jrestclient/request.py
|
Request.put
|
def put(self, url, data, headers=None):
"""
Perform an HTTP PUT request for a given url.
Returns the response object.
"""
return self._request('PUT', url, data, headers=headers)
|
python
|
def put(self, url, data, headers=None):
"""
Perform an HTTP PUT request for a given url.
Returns the response object.
"""
return self._request('PUT', url, data, headers=headers)
|
[
"def",
"put",
"(",
"self",
",",
"url",
",",
"data",
",",
"headers",
"=",
"None",
")",
":",
"return",
"self",
".",
"_request",
"(",
"'PUT'",
",",
"url",
",",
"data",
",",
"headers",
"=",
"headers",
")"
] |
Perform an HTTP PUT request for a given url.
Returns the response object.
|
[
"Perform",
"an",
"HTTP",
"PUT",
"request",
"for",
"a",
"given",
"url",
".",
"Returns",
"the",
"response",
"object",
"."
] |
train
|
https://github.com/versae/neo4j-rest-client/blob/b03c09c8f598fa4dbad8ea8998ffb1c885805074/neo4jrestclient/request.py#L72-L77
|
versae/neo4j-rest-client
|
neo4jrestclient/client.py
|
Index.query
|
def query(self, *args):
"""
Query a fulltext index by key and query or just a plain Lucene query,
i1 = gdb.nodes.indexes.get('people',type='fulltext', provider='lucene')
i1.query('name','do*')
i1.query('name:do*')
In this example, the last two line are equivalent.
"""
if not args or len(args) > 2:
raise TypeError('query() takes 2 or 3 arguments (a query or a key '
'and a query) (%d given)' % (len(args) + 1))
elif len(args) == 1:
query, = args
return self.get('text').query(text_type(query))
else:
key, query = args
index_key = self.get(key)
if isinstance(query, string_types):
return index_key.query(query)
else:
if query.fielded:
raise ValueError('Queries with an included key should '
'not include a field.')
return index_key.query(text_type(query))
|
python
|
def query(self, *args):
"""
Query a fulltext index by key and query or just a plain Lucene query,
i1 = gdb.nodes.indexes.get('people',type='fulltext', provider='lucene')
i1.query('name','do*')
i1.query('name:do*')
In this example, the last two line are equivalent.
"""
if not args or len(args) > 2:
raise TypeError('query() takes 2 or 3 arguments (a query or a key '
'and a query) (%d given)' % (len(args) + 1))
elif len(args) == 1:
query, = args
return self.get('text').query(text_type(query))
else:
key, query = args
index_key = self.get(key)
if isinstance(query, string_types):
return index_key.query(query)
else:
if query.fielded:
raise ValueError('Queries with an included key should '
'not include a field.')
return index_key.query(text_type(query))
|
[
"def",
"query",
"(",
"self",
",",
"*",
"args",
")",
":",
"if",
"not",
"args",
"or",
"len",
"(",
"args",
")",
">",
"2",
":",
"raise",
"TypeError",
"(",
"'query() takes 2 or 3 arguments (a query or a key '",
"'and a query) (%d given)'",
"%",
"(",
"len",
"(",
"args",
")",
"+",
"1",
")",
")",
"elif",
"len",
"(",
"args",
")",
"==",
"1",
":",
"query",
",",
"=",
"args",
"return",
"self",
".",
"get",
"(",
"'text'",
")",
".",
"query",
"(",
"text_type",
"(",
"query",
")",
")",
"else",
":",
"key",
",",
"query",
"=",
"args",
"index_key",
"=",
"self",
".",
"get",
"(",
"key",
")",
"if",
"isinstance",
"(",
"query",
",",
"string_types",
")",
":",
"return",
"index_key",
".",
"query",
"(",
"query",
")",
"else",
":",
"if",
"query",
".",
"fielded",
":",
"raise",
"ValueError",
"(",
"'Queries with an included key should '",
"'not include a field.'",
")",
"return",
"index_key",
".",
"query",
"(",
"text_type",
"(",
"query",
")",
")"
] |
Query a fulltext index by key and query or just a plain Lucene query,
i1 = gdb.nodes.indexes.get('people',type='fulltext', provider='lucene')
i1.query('name','do*')
i1.query('name:do*')
In this example, the last two line are equivalent.
|
[
"Query",
"a",
"fulltext",
"index",
"by",
"key",
"and",
"query",
"or",
"just",
"a",
"plain",
"Lucene",
"query"
] |
train
|
https://github.com/versae/neo4j-rest-client/blob/b03c09c8f598fa4dbad8ea8998ffb1c885805074/neo4jrestclient/client.py#L1788-L1813
|
versae/neo4j-rest-client
|
neo4jrestclient/query.py
|
QuerySequence._plot_graph
|
def _plot_graph(self, graph, title=None, width=None, height=None):
"""
Return a HTML representation for a particular QuerySequence.
Mainly for IPython Notebook.
"""
if not self._elements_row and not self._elements_graph:
raise ValueError('Unable to display the graph or the table')
title = title or self.q
width = width or json.dumps(None)
height = height or 300
d3_uuid = text_type(uuid.uuid1())
d3_graph = self._transform_graph_to_d3(graph)
d3_id = "d3_id_" + d3_uuid
d3_title = title
d3_container_id = d3_id + "_d3c"
style = """
#{d3_id} path.link {{
fill: none;
stroke-width: 1.5px;
}}
#{d3_id} .node {{
/*fill: #ccc;*/
stroke: #333;
stroke-width: 1.5px;
}}
#{d3_id} text {{
font: 10px sans-serif;
pointer-events: none;
}}
#{d3_id} text.shadow {{
stroke: #fff;
stroke-width: 3px;
stroke-opacity: .8;
}}
#{d3_id} .node.sticky {{
/* stroke-width: 2px; */
}}
""".format(d3_id=d3_id)
js = """
var links = graph.links;
var nodes = graph.nodes;
// Compute the distinct nodes from the links.
links.forEach(function(link) {
link.source = (nodes[link.source] ||
(nodes[link.source] = {name: link.source}));
link.target = (nodes[link.target] ||
(nodes[link.target] = {name: link.target}));
});
var w = width || $(container).width(), h = height;
var force = d3.layout.force()
.nodes(d3.values(nodes))
.links(links)
.size([w, h])
.linkDistance(60)
.charge(-300)
.on("tick", tick)
.start();
var svg = d3.select(container).append("svg:svg")
.attr("width", w)
.attr("height", h);
// Per-type markers, as they don't inherit styles.
svg.append("svg:defs").selectAll("marker")
.data(["arrow"])
.enter().append("svg:marker")
.attr("id", String)
.attr("viewBox", "0 -5 10 10")
.attr("refX", 15)
.attr("refY", -1.5)
.attr("markerWidth", 6)
.attr("markerHeight", 6)
.attr("orient", "auto")
.append("svg:path")
.attr("d", "M0,-5L10,0L0,5");
var path = svg.append("svg:g").selectAll("path")
.data(force.links())
.enter().append("svg:path")
.attr("class", function(d) { return "link " + d.stroke; })
.attr("stroke", function(d) { return d.stroke; })
.attr("marker-end", function(d) { return "url(#arrow)"; });
var circle = svg.append("svg:g").selectAll("circle")
.data(force.nodes())
.enter().append("svg:circle")
.attr("fill", function(d) { return d.fill; })
.attr("r", 6)
.attr("class", "node")
.call(force.drag)
.on("mousedown", function(d) {
d.fixed = true;
d3.select(this).classed("sticky", true);
});
var text = svg.append("svg:g").selectAll("g")
.data(force.nodes())
.enter().append("svg:g");
// A copy of the text with a thick white stroke for legibility.
text.append("svg:text")
.attr("x", 8)
.attr("y", ".31em")
.attr("class", "shadow")
.text(function(d) { return d.label; });
text.append("svg:text")
.attr("x", 8)
.attr("y", ".31em")
.attr("class", "front")
.text(function(d) { return d.label; });
// Use elliptical arc path segments to doubly-encode directionality.
function tick() {
path.attr("d", function(d) {
var dx = d.target.x - d.source.x,
dy = d.target.y - d.source.y,
dr = Math.sqrt(dx * dx + dy * dy);
return ("M" + d.source.x + "," + d.source.y + "A"
+ dr + "," + dr + " 0 0,1 " + d.target.x + ","
+ d.target.y);
});
circle.attr("transform", function(d) {
return "translate(" + d.x + "," + d.y + ")";
});
text.attr("transform", function(d) {
return "translate(" + d.x + "," + d.y + ")";
});
}
// Display options
var display = $(container + "_display");
graph.properties.forEach(function (property) {
var option = $("<OPTION/>");
option.text(property);
option.attr("value", property);
display.append(option);
});
display.on("change", function () {
var selected = $(this).find(":selected").val(),
displayFunc;
if (selected.length !== 0) {
displayFunc = function(d) {
return d.properties[selected];
}
} else {
displayFunc = function(d) {
return d.label;
}
}
text.select("text.front").text(displayFunc);
text.select("text.shadow").text(displayFunc);
});
"""
return ("""
<style type="text/css">
{style}
</style>
<div class="accordion">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed"
data-toggle="collapse" data-parent=""
href="#{d3_id}">
{d3_title}
</a>
</div>
<div id="{d3_id}" class="accordion-body in collapse">
<div class="accordion-inner">
<div id="{d3_container_id}">
<select id="{d3_container_id}_display">
<option value="">ID</option>
</select>
</div>
</div>
</div>
</div>
</div>
<script>
var neo4jrestclient = window.neo4jrestclient || {{}};
neo4jrestclient['{d3_uuid}'] = {{}};
neo4jrestclient['{d3_uuid}'].graph = {d3_graph};
neo4jrestclient['{d3_uuid}'].container_id = "{d3_container_id}";
neo4jrestclient['{d3_uuid}'].container = "#{d3_container_id}";
neo4jrestclient['{d3_uuid}'].render = function () {{
(function (graph, container, width, height) {{
{js}
}})(
neo4jrestclient['{d3_uuid}'].graph,
neo4jrestclient['{d3_uuid}'].container,
{width},
{height}
);
}}
if (!window.d3) {{
$.getScript(
"//d3js.org/d3.v2.js?2.9.1",
neo4jrestclient['{d3_uuid}'].render
);
}} else {{
neo4jrestclient['{d3_uuid}'].render();
}}
</script>
""".format(
style=style,
js=js,
d3_graph=json.dumps(d3_graph),
d3_id=d3_id,
d3_uuid=d3_uuid,
d3_title=d3_title,
d3_container_id=d3_container_id,
width=width,
height=height,
))
|
python
|
def _plot_graph(self, graph, title=None, width=None, height=None):
"""
Return a HTML representation for a particular QuerySequence.
Mainly for IPython Notebook.
"""
if not self._elements_row and not self._elements_graph:
raise ValueError('Unable to display the graph or the table')
title = title or self.q
width = width or json.dumps(None)
height = height or 300
d3_uuid = text_type(uuid.uuid1())
d3_graph = self._transform_graph_to_d3(graph)
d3_id = "d3_id_" + d3_uuid
d3_title = title
d3_container_id = d3_id + "_d3c"
style = """
#{d3_id} path.link {{
fill: none;
stroke-width: 1.5px;
}}
#{d3_id} .node {{
/*fill: #ccc;*/
stroke: #333;
stroke-width: 1.5px;
}}
#{d3_id} text {{
font: 10px sans-serif;
pointer-events: none;
}}
#{d3_id} text.shadow {{
stroke: #fff;
stroke-width: 3px;
stroke-opacity: .8;
}}
#{d3_id} .node.sticky {{
/* stroke-width: 2px; */
}}
""".format(d3_id=d3_id)
js = """
var links = graph.links;
var nodes = graph.nodes;
// Compute the distinct nodes from the links.
links.forEach(function(link) {
link.source = (nodes[link.source] ||
(nodes[link.source] = {name: link.source}));
link.target = (nodes[link.target] ||
(nodes[link.target] = {name: link.target}));
});
var w = width || $(container).width(), h = height;
var force = d3.layout.force()
.nodes(d3.values(nodes))
.links(links)
.size([w, h])
.linkDistance(60)
.charge(-300)
.on("tick", tick)
.start();
var svg = d3.select(container).append("svg:svg")
.attr("width", w)
.attr("height", h);
// Per-type markers, as they don't inherit styles.
svg.append("svg:defs").selectAll("marker")
.data(["arrow"])
.enter().append("svg:marker")
.attr("id", String)
.attr("viewBox", "0 -5 10 10")
.attr("refX", 15)
.attr("refY", -1.5)
.attr("markerWidth", 6)
.attr("markerHeight", 6)
.attr("orient", "auto")
.append("svg:path")
.attr("d", "M0,-5L10,0L0,5");
var path = svg.append("svg:g").selectAll("path")
.data(force.links())
.enter().append("svg:path")
.attr("class", function(d) { return "link " + d.stroke; })
.attr("stroke", function(d) { return d.stroke; })
.attr("marker-end", function(d) { return "url(#arrow)"; });
var circle = svg.append("svg:g").selectAll("circle")
.data(force.nodes())
.enter().append("svg:circle")
.attr("fill", function(d) { return d.fill; })
.attr("r", 6)
.attr("class", "node")
.call(force.drag)
.on("mousedown", function(d) {
d.fixed = true;
d3.select(this).classed("sticky", true);
});
var text = svg.append("svg:g").selectAll("g")
.data(force.nodes())
.enter().append("svg:g");
// A copy of the text with a thick white stroke for legibility.
text.append("svg:text")
.attr("x", 8)
.attr("y", ".31em")
.attr("class", "shadow")
.text(function(d) { return d.label; });
text.append("svg:text")
.attr("x", 8)
.attr("y", ".31em")
.attr("class", "front")
.text(function(d) { return d.label; });
// Use elliptical arc path segments to doubly-encode directionality.
function tick() {
path.attr("d", function(d) {
var dx = d.target.x - d.source.x,
dy = d.target.y - d.source.y,
dr = Math.sqrt(dx * dx + dy * dy);
return ("M" + d.source.x + "," + d.source.y + "A"
+ dr + "," + dr + " 0 0,1 " + d.target.x + ","
+ d.target.y);
});
circle.attr("transform", function(d) {
return "translate(" + d.x + "," + d.y + ")";
});
text.attr("transform", function(d) {
return "translate(" + d.x + "," + d.y + ")";
});
}
// Display options
var display = $(container + "_display");
graph.properties.forEach(function (property) {
var option = $("<OPTION/>");
option.text(property);
option.attr("value", property);
display.append(option);
});
display.on("change", function () {
var selected = $(this).find(":selected").val(),
displayFunc;
if (selected.length !== 0) {
displayFunc = function(d) {
return d.properties[selected];
}
} else {
displayFunc = function(d) {
return d.label;
}
}
text.select("text.front").text(displayFunc);
text.select("text.shadow").text(displayFunc);
});
"""
return ("""
<style type="text/css">
{style}
</style>
<div class="accordion">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed"
data-toggle="collapse" data-parent=""
href="#{d3_id}">
{d3_title}
</a>
</div>
<div id="{d3_id}" class="accordion-body in collapse">
<div class="accordion-inner">
<div id="{d3_container_id}">
<select id="{d3_container_id}_display">
<option value="">ID</option>
</select>
</div>
</div>
</div>
</div>
</div>
<script>
var neo4jrestclient = window.neo4jrestclient || {{}};
neo4jrestclient['{d3_uuid}'] = {{}};
neo4jrestclient['{d3_uuid}'].graph = {d3_graph};
neo4jrestclient['{d3_uuid}'].container_id = "{d3_container_id}";
neo4jrestclient['{d3_uuid}'].container = "#{d3_container_id}";
neo4jrestclient['{d3_uuid}'].render = function () {{
(function (graph, container, width, height) {{
{js}
}})(
neo4jrestclient['{d3_uuid}'].graph,
neo4jrestclient['{d3_uuid}'].container,
{width},
{height}
);
}}
if (!window.d3) {{
$.getScript(
"//d3js.org/d3.v2.js?2.9.1",
neo4jrestclient['{d3_uuid}'].render
);
}} else {{
neo4jrestclient['{d3_uuid}'].render();
}}
</script>
""".format(
style=style,
js=js,
d3_graph=json.dumps(d3_graph),
d3_id=d3_id,
d3_uuid=d3_uuid,
d3_title=d3_title,
d3_container_id=d3_container_id,
width=width,
height=height,
))
|
[
"def",
"_plot_graph",
"(",
"self",
",",
"graph",
",",
"title",
"=",
"None",
",",
"width",
"=",
"None",
",",
"height",
"=",
"None",
")",
":",
"if",
"not",
"self",
".",
"_elements_row",
"and",
"not",
"self",
".",
"_elements_graph",
":",
"raise",
"ValueError",
"(",
"'Unable to display the graph or the table'",
")",
"title",
"=",
"title",
"or",
"self",
".",
"q",
"width",
"=",
"width",
"or",
"json",
".",
"dumps",
"(",
"None",
")",
"height",
"=",
"height",
"or",
"300",
"d3_uuid",
"=",
"text_type",
"(",
"uuid",
".",
"uuid1",
"(",
")",
")",
"d3_graph",
"=",
"self",
".",
"_transform_graph_to_d3",
"(",
"graph",
")",
"d3_id",
"=",
"\"d3_id_\"",
"+",
"d3_uuid",
"d3_title",
"=",
"title",
"d3_container_id",
"=",
"d3_id",
"+",
"\"_d3c\"",
"style",
"=",
"\"\"\"\n #{d3_id} path.link {{\n fill: none;\n stroke-width: 1.5px;\n }}\n #{d3_id} .node {{\n /*fill: #ccc;*/\n stroke: #333;\n stroke-width: 1.5px;\n }}\n #{d3_id} text {{\n font: 10px sans-serif;\n pointer-events: none;\n }}\n #{d3_id} text.shadow {{\n stroke: #fff;\n stroke-width: 3px;\n stroke-opacity: .8;\n }}\n #{d3_id} .node.sticky {{\n /* stroke-width: 2px; */\n }}\n \"\"\"",
".",
"format",
"(",
"d3_id",
"=",
"d3_id",
")",
"js",
"=",
"\"\"\"\n var links = graph.links;\n var nodes = graph.nodes;\n\n // Compute the distinct nodes from the links.\n links.forEach(function(link) {\n link.source = (nodes[link.source] ||\n (nodes[link.source] = {name: link.source}));\n link.target = (nodes[link.target] ||\n (nodes[link.target] = {name: link.target}));\n });\n\n var w = width || $(container).width(), h = height;\n\n var force = d3.layout.force()\n .nodes(d3.values(nodes))\n .links(links)\n .size([w, h])\n .linkDistance(60)\n .charge(-300)\n .on(\"tick\", tick)\n .start();\n\n var svg = d3.select(container).append(\"svg:svg\")\n .attr(\"width\", w)\n .attr(\"height\", h);\n\n // Per-type markers, as they don't inherit styles.\n svg.append(\"svg:defs\").selectAll(\"marker\")\n .data([\"arrow\"])\n .enter().append(\"svg:marker\")\n .attr(\"id\", String)\n .attr(\"viewBox\", \"0 -5 10 10\")\n .attr(\"refX\", 15)\n .attr(\"refY\", -1.5)\n .attr(\"markerWidth\", 6)\n .attr(\"markerHeight\", 6)\n .attr(\"orient\", \"auto\")\n .append(\"svg:path\")\n .attr(\"d\", \"M0,-5L10,0L0,5\");\n\n var path = svg.append(\"svg:g\").selectAll(\"path\")\n .data(force.links())\n .enter().append(\"svg:path\")\n .attr(\"class\", function(d) { return \"link \" + d.stroke; })\n .attr(\"stroke\", function(d) { return d.stroke; })\n .attr(\"marker-end\", function(d) { return \"url(#arrow)\"; });\n\n var circle = svg.append(\"svg:g\").selectAll(\"circle\")\n .data(force.nodes())\n .enter().append(\"svg:circle\")\n .attr(\"fill\", function(d) { return d.fill; })\n .attr(\"r\", 6)\n .attr(\"class\", \"node\")\n .call(force.drag)\n .on(\"mousedown\", function(d) {\n d.fixed = true;\n d3.select(this).classed(\"sticky\", true);\n });\n\n var text = svg.append(\"svg:g\").selectAll(\"g\")\n .data(force.nodes())\n .enter().append(\"svg:g\");\n\n // A copy of the text with a thick white stroke for legibility.\n text.append(\"svg:text\")\n .attr(\"x\", 8)\n .attr(\"y\", \".31em\")\n .attr(\"class\", \"shadow\")\n .text(function(d) { return d.label; });\n\n text.append(\"svg:text\")\n .attr(\"x\", 8)\n .attr(\"y\", \".31em\")\n .attr(\"class\", \"front\")\n .text(function(d) { return d.label; });\n\n // Use elliptical arc path segments to doubly-encode directionality.\n function tick() {\n path.attr(\"d\", function(d) {\n var dx = d.target.x - d.source.x,\n dy = d.target.y - d.source.y,\n dr = Math.sqrt(dx * dx + dy * dy);\n return (\"M\" + d.source.x + \",\" + d.source.y + \"A\"\n + dr + \",\" + dr + \" 0 0,1 \" + d.target.x + \",\"\n + d.target.y);\n });\n\n circle.attr(\"transform\", function(d) {\n return \"translate(\" + d.x + \",\" + d.y + \")\";\n });\n\n text.attr(\"transform\", function(d) {\n return \"translate(\" + d.x + \",\" + d.y + \")\";\n });\n }\n\n // Display options\n var display = $(container + \"_display\");\n graph.properties.forEach(function (property) {\n var option = $(\"<OPTION/>\");\n option.text(property);\n option.attr(\"value\", property);\n display.append(option);\n });\n display.on(\"change\", function () {\n var selected = $(this).find(\":selected\").val(),\n displayFunc;\n if (selected.length !== 0) {\n displayFunc = function(d) {\n return d.properties[selected];\n }\n } else {\n displayFunc = function(d) {\n return d.label;\n }\n }\n text.select(\"text.front\").text(displayFunc);\n text.select(\"text.shadow\").text(displayFunc);\n });\n \"\"\"",
"return",
"(",
"\"\"\"\n <style type=\"text/css\">\n {style}\n </style>\n\n <div class=\"accordion\">\n <div class=\"accordion-group\">\n <div class=\"accordion-heading\">\n <a class=\"accordion-toggle collapsed\"\n data-toggle=\"collapse\" data-parent=\"\"\n href=\"#{d3_id}\">\n {d3_title}\n </a>\n </div>\n <div id=\"{d3_id}\" class=\"accordion-body in collapse\">\n <div class=\"accordion-inner\">\n <div id=\"{d3_container_id}\">\n <select id=\"{d3_container_id}_display\">\n <option value=\"\">ID</option>\n </select>\n </div>\n </div>\n </div>\n </div>\n </div>\n\n <script>\n var neo4jrestclient = window.neo4jrestclient || {{}};\n neo4jrestclient['{d3_uuid}'] = {{}};\n neo4jrestclient['{d3_uuid}'].graph = {d3_graph};\n neo4jrestclient['{d3_uuid}'].container_id = \"{d3_container_id}\";\n neo4jrestclient['{d3_uuid}'].container = \"#{d3_container_id}\";\n neo4jrestclient['{d3_uuid}'].render = function () {{\n (function (graph, container, width, height) {{\n {js}\n }})(\n neo4jrestclient['{d3_uuid}'].graph,\n neo4jrestclient['{d3_uuid}'].container,\n {width},\n {height}\n );\n }}\n if (!window.d3) {{\n $.getScript(\n \"//d3js.org/d3.v2.js?2.9.1\",\n neo4jrestclient['{d3_uuid}'].render\n );\n }} else {{\n neo4jrestclient['{d3_uuid}'].render();\n }}\n </script>\n \"\"\"",
".",
"format",
"(",
"style",
"=",
"style",
",",
"js",
"=",
"js",
",",
"d3_graph",
"=",
"json",
".",
"dumps",
"(",
"d3_graph",
")",
",",
"d3_id",
"=",
"d3_id",
",",
"d3_uuid",
"=",
"d3_uuid",
",",
"d3_title",
"=",
"d3_title",
",",
"d3_container_id",
"=",
"d3_container_id",
",",
"width",
"=",
"width",
",",
"height",
"=",
"height",
",",
")",
")"
] |
Return a HTML representation for a particular QuerySequence.
Mainly for IPython Notebook.
|
[
"Return",
"a",
"HTML",
"representation",
"for",
"a",
"particular",
"QuerySequence",
".",
"Mainly",
"for",
"IPython",
"Notebook",
"."
] |
train
|
https://github.com/versae/neo4j-rest-client/blob/b03c09c8f598fa4dbad8ea8998ffb1c885805074/neo4jrestclient/query.py#L422-L642
|
bkjones/pyrabbit
|
pyrabbit/http.py
|
HTTPClient.do_call
|
def do_call(self, path, method, body=None, headers=None):
"""
Send an HTTP request to the REST API.
:param string path: A URL
:param string method: The HTTP method (GET, POST, etc.) to use
in the request.
:param string body: A string representing any data to be sent in the
body of the HTTP request.
:param dictionary headers:
"{header-name: header-value}" dictionary.
"""
url = urljoin(self.base_url, path)
try:
resp = requests.request(method, url, data=body, headers=headers,
auth=self.auth, timeout=self.timeout)
except requests.exceptions.Timeout as out:
raise NetworkError("Timeout while trying to connect to RabbitMQ")
except requests.exceptions.RequestException as err:
# All other requests exceptions inherit from RequestException
raise NetworkError("Error during request %s %s" % (type(err), err))
try:
content = resp.json()
except ValueError as out:
content = None
# 'success' HTTP status codes are 200-206
if resp.status_code < 200 or resp.status_code > 206:
raise HTTPError(content, resp.status_code, resp.text, path, body)
else:
if content:
return content
else:
return None
|
python
|
def do_call(self, path, method, body=None, headers=None):
"""
Send an HTTP request to the REST API.
:param string path: A URL
:param string method: The HTTP method (GET, POST, etc.) to use
in the request.
:param string body: A string representing any data to be sent in the
body of the HTTP request.
:param dictionary headers:
"{header-name: header-value}" dictionary.
"""
url = urljoin(self.base_url, path)
try:
resp = requests.request(method, url, data=body, headers=headers,
auth=self.auth, timeout=self.timeout)
except requests.exceptions.Timeout as out:
raise NetworkError("Timeout while trying to connect to RabbitMQ")
except requests.exceptions.RequestException as err:
# All other requests exceptions inherit from RequestException
raise NetworkError("Error during request %s %s" % (type(err), err))
try:
content = resp.json()
except ValueError as out:
content = None
# 'success' HTTP status codes are 200-206
if resp.status_code < 200 or resp.status_code > 206:
raise HTTPError(content, resp.status_code, resp.text, path, body)
else:
if content:
return content
else:
return None
|
[
"def",
"do_call",
"(",
"self",
",",
"path",
",",
"method",
",",
"body",
"=",
"None",
",",
"headers",
"=",
"None",
")",
":",
"url",
"=",
"urljoin",
"(",
"self",
".",
"base_url",
",",
"path",
")",
"try",
":",
"resp",
"=",
"requests",
".",
"request",
"(",
"method",
",",
"url",
",",
"data",
"=",
"body",
",",
"headers",
"=",
"headers",
",",
"auth",
"=",
"self",
".",
"auth",
",",
"timeout",
"=",
"self",
".",
"timeout",
")",
"except",
"requests",
".",
"exceptions",
".",
"Timeout",
"as",
"out",
":",
"raise",
"NetworkError",
"(",
"\"Timeout while trying to connect to RabbitMQ\"",
")",
"except",
"requests",
".",
"exceptions",
".",
"RequestException",
"as",
"err",
":",
"# All other requests exceptions inherit from RequestException",
"raise",
"NetworkError",
"(",
"\"Error during request %s %s\"",
"%",
"(",
"type",
"(",
"err",
")",
",",
"err",
")",
")",
"try",
":",
"content",
"=",
"resp",
".",
"json",
"(",
")",
"except",
"ValueError",
"as",
"out",
":",
"content",
"=",
"None",
"# 'success' HTTP status codes are 200-206",
"if",
"resp",
".",
"status_code",
"<",
"200",
"or",
"resp",
".",
"status_code",
">",
"206",
":",
"raise",
"HTTPError",
"(",
"content",
",",
"resp",
".",
"status_code",
",",
"resp",
".",
"text",
",",
"path",
",",
"body",
")",
"else",
":",
"if",
"content",
":",
"return",
"content",
"else",
":",
"return",
"None"
] |
Send an HTTP request to the REST API.
:param string path: A URL
:param string method: The HTTP method (GET, POST, etc.) to use
in the request.
:param string body: A string representing any data to be sent in the
body of the HTTP request.
:param dictionary headers:
"{header-name: header-value}" dictionary.
|
[
"Send",
"an",
"HTTP",
"request",
"to",
"the",
"REST",
"API",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/http.py#L72-L107
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client._call
|
def _call(self, path, method, body=None, headers=None):
"""
Wrapper around http.do_call that transforms some HTTPError into
our own exceptions
"""
try:
resp = self.http.do_call(path, method, body, headers)
except http.HTTPError as err:
if err.status == 401:
raise PermissionError('Insufficient permissions to query ' +
'%s with user %s :%s' % (path, self.user, err))
raise
return resp
|
python
|
def _call(self, path, method, body=None, headers=None):
"""
Wrapper around http.do_call that transforms some HTTPError into
our own exceptions
"""
try:
resp = self.http.do_call(path, method, body, headers)
except http.HTTPError as err:
if err.status == 401:
raise PermissionError('Insufficient permissions to query ' +
'%s with user %s :%s' % (path, self.user, err))
raise
return resp
|
[
"def",
"_call",
"(",
"self",
",",
"path",
",",
"method",
",",
"body",
"=",
"None",
",",
"headers",
"=",
"None",
")",
":",
"try",
":",
"resp",
"=",
"self",
".",
"http",
".",
"do_call",
"(",
"path",
",",
"method",
",",
"body",
",",
"headers",
")",
"except",
"http",
".",
"HTTPError",
"as",
"err",
":",
"if",
"err",
".",
"status",
"==",
"401",
":",
"raise",
"PermissionError",
"(",
"'Insufficient permissions to query '",
"+",
"'%s with user %s :%s'",
"%",
"(",
"path",
",",
"self",
".",
"user",
",",
"err",
")",
")",
"raise",
"return",
"resp"
] |
Wrapper around http.do_call that transforms some HTTPError into
our own exceptions
|
[
"Wrapper",
"around",
"http",
".",
"do_call",
"that",
"transforms",
"some",
"HTTPError",
"into",
"our",
"own",
"exceptions"
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L102-L114
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.is_alive
|
def is_alive(self, vhost='%2F'):
"""
Uses the aliveness-test API call to determine if the
server is alive and the vhost is active. The broker (not this code)
creates a queue and then sends/consumes a message from it.
:param string vhost: There should be no real reason to ever change
this from the default value, but it's there if you need to.
:returns bool: True if alive, False otherwise
:raises: HTTPError if *vhost* doesn't exist on the broker.
"""
uri = Client.urls['live_test'] % vhost
try:
resp = self._call(uri, 'GET')
except http.HTTPError as err:
if err.status == 404:
raise APIError("No vhost named '%s'" % vhost)
raise
if resp['status'] == 'ok':
return True
else:
return False
|
python
|
def is_alive(self, vhost='%2F'):
"""
Uses the aliveness-test API call to determine if the
server is alive and the vhost is active. The broker (not this code)
creates a queue and then sends/consumes a message from it.
:param string vhost: There should be no real reason to ever change
this from the default value, but it's there if you need to.
:returns bool: True if alive, False otherwise
:raises: HTTPError if *vhost* doesn't exist on the broker.
"""
uri = Client.urls['live_test'] % vhost
try:
resp = self._call(uri, 'GET')
except http.HTTPError as err:
if err.status == 404:
raise APIError("No vhost named '%s'" % vhost)
raise
if resp['status'] == 'ok':
return True
else:
return False
|
[
"def",
"is_alive",
"(",
"self",
",",
"vhost",
"=",
"'%2F'",
")",
":",
"uri",
"=",
"Client",
".",
"urls",
"[",
"'live_test'",
"]",
"%",
"vhost",
"try",
":",
"resp",
"=",
"self",
".",
"_call",
"(",
"uri",
",",
"'GET'",
")",
"except",
"http",
".",
"HTTPError",
"as",
"err",
":",
"if",
"err",
".",
"status",
"==",
"404",
":",
"raise",
"APIError",
"(",
"\"No vhost named '%s'\"",
"%",
"vhost",
")",
"raise",
"if",
"resp",
"[",
"'status'",
"]",
"==",
"'ok'",
":",
"return",
"True",
"else",
":",
"return",
"False"
] |
Uses the aliveness-test API call to determine if the
server is alive and the vhost is active. The broker (not this code)
creates a queue and then sends/consumes a message from it.
:param string vhost: There should be no real reason to ever change
this from the default value, but it's there if you need to.
:returns bool: True if alive, False otherwise
:raises: HTTPError if *vhost* doesn't exist on the broker.
|
[
"Uses",
"the",
"aliveness",
"-",
"test",
"API",
"call",
"to",
"determine",
"if",
"the",
"server",
"is",
"alive",
"and",
"the",
"vhost",
"is",
"active",
".",
"The",
"broker",
"(",
"not",
"this",
"code",
")",
"creates",
"a",
"queue",
"and",
"then",
"sends",
"/",
"consumes",
"a",
"message",
"from",
"it",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L117-L141
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_whoami
|
def get_whoami(self):
"""
A convenience function used in the event that you need to confirm that
the broker thinks you are who you think you are.
:returns dict whoami: Dict structure contains:
* administrator: whether the user is has admin privileges
* name: user name
* auth_backend: backend used to determine admin rights
"""
path = Client.urls['whoami']
whoami = self._call(path, 'GET')
return whoami
|
python
|
def get_whoami(self):
"""
A convenience function used in the event that you need to confirm that
the broker thinks you are who you think you are.
:returns dict whoami: Dict structure contains:
* administrator: whether the user is has admin privileges
* name: user name
* auth_backend: backend used to determine admin rights
"""
path = Client.urls['whoami']
whoami = self._call(path, 'GET')
return whoami
|
[
"def",
"get_whoami",
"(",
"self",
")",
":",
"path",
"=",
"Client",
".",
"urls",
"[",
"'whoami'",
"]",
"whoami",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"return",
"whoami"
] |
A convenience function used in the event that you need to confirm that
the broker thinks you are who you think you are.
:returns dict whoami: Dict structure contains:
* administrator: whether the user is has admin privileges
* name: user name
* auth_backend: backend used to determine admin rights
|
[
"A",
"convenience",
"function",
"used",
"in",
"the",
"event",
"that",
"you",
"need",
"to",
"confirm",
"that",
"the",
"broker",
"thinks",
"you",
"are",
"who",
"you",
"think",
"you",
"are",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L143-L155
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_vhost_names
|
def get_vhost_names(self):
"""
A convenience function for getting back only the vhost names instead of
the larger vhost dicts.
:returns list vhost_names: A list of just the vhost names.
"""
vhosts = self.get_all_vhosts()
vhost_names = [i['name'] for i in vhosts]
return vhost_names
|
python
|
def get_vhost_names(self):
"""
A convenience function for getting back only the vhost names instead of
the larger vhost dicts.
:returns list vhost_names: A list of just the vhost names.
"""
vhosts = self.get_all_vhosts()
vhost_names = [i['name'] for i in vhosts]
return vhost_names
|
[
"def",
"get_vhost_names",
"(",
"self",
")",
":",
"vhosts",
"=",
"self",
".",
"get_all_vhosts",
"(",
")",
"vhost_names",
"=",
"[",
"i",
"[",
"'name'",
"]",
"for",
"i",
"in",
"vhosts",
"]",
"return",
"vhost_names"
] |
A convenience function for getting back only the vhost names instead of
the larger vhost dicts.
:returns list vhost_names: A list of just the vhost names.
|
[
"A",
"convenience",
"function",
"for",
"getting",
"back",
"only",
"the",
"vhost",
"names",
"instead",
"of",
"the",
"larger",
"vhost",
"dicts",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L207-L216
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_vhost
|
def get_vhost(self, vname):
"""
Returns the attributes of a single named vhost in a dict.
:param string vname: Name of the vhost to get.
:returns dict vhost: Attribute dict for the named vhost
"""
vname = quote(vname, '')
path = Client.urls['vhosts_by_name'] % vname
vhost = self._call(path, 'GET', headers=Client.json_headers)
return vhost
|
python
|
def get_vhost(self, vname):
"""
Returns the attributes of a single named vhost in a dict.
:param string vname: Name of the vhost to get.
:returns dict vhost: Attribute dict for the named vhost
"""
vname = quote(vname, '')
path = Client.urls['vhosts_by_name'] % vname
vhost = self._call(path, 'GET', headers=Client.json_headers)
return vhost
|
[
"def",
"get_vhost",
"(",
"self",
",",
"vname",
")",
":",
"vname",
"=",
"quote",
"(",
"vname",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'vhosts_by_name'",
"]",
"%",
"vname",
"vhost",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
",",
"headers",
"=",
"Client",
".",
"json_headers",
")",
"return",
"vhost"
] |
Returns the attributes of a single named vhost in a dict.
:param string vname: Name of the vhost to get.
:returns dict vhost: Attribute dict for the named vhost
|
[
"Returns",
"the",
"attributes",
"of",
"a",
"single",
"named",
"vhost",
"in",
"a",
"dict",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L218-L230
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.create_vhost
|
def create_vhost(self, vname):
"""
Creates a vhost on the server to house exchanges.
:param string vname: The name to give to the vhost on the server
:returns: boolean
"""
vname = quote(vname, '')
path = Client.urls['vhosts_by_name'] % vname
return self._call(path, 'PUT',
headers=Client.json_headers)
|
python
|
def create_vhost(self, vname):
"""
Creates a vhost on the server to house exchanges.
:param string vname: The name to give to the vhost on the server
:returns: boolean
"""
vname = quote(vname, '')
path = Client.urls['vhosts_by_name'] % vname
return self._call(path, 'PUT',
headers=Client.json_headers)
|
[
"def",
"create_vhost",
"(",
"self",
",",
"vname",
")",
":",
"vname",
"=",
"quote",
"(",
"vname",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'vhosts_by_name'",
"]",
"%",
"vname",
"return",
"self",
".",
"_call",
"(",
"path",
",",
"'PUT'",
",",
"headers",
"=",
"Client",
".",
"json_headers",
")"
] |
Creates a vhost on the server to house exchanges.
:param string vname: The name to give to the vhost on the server
:returns: boolean
|
[
"Creates",
"a",
"vhost",
"on",
"the",
"server",
"to",
"house",
"exchanges",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L232-L242
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.delete_vhost
|
def delete_vhost(self, vname):
"""
Deletes a vhost from the server. Note that this also deletes any
exchanges or queues that belong to this vhost.
:param string vname: Name of the vhost to delete from the server.
"""
vname = quote(vname, '')
path = Client.urls['vhosts_by_name'] % vname
return self._call(path, 'DELETE')
|
python
|
def delete_vhost(self, vname):
"""
Deletes a vhost from the server. Note that this also deletes any
exchanges or queues that belong to this vhost.
:param string vname: Name of the vhost to delete from the server.
"""
vname = quote(vname, '')
path = Client.urls['vhosts_by_name'] % vname
return self._call(path, 'DELETE')
|
[
"def",
"delete_vhost",
"(",
"self",
",",
"vname",
")",
":",
"vname",
"=",
"quote",
"(",
"vname",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'vhosts_by_name'",
"]",
"%",
"vname",
"return",
"self",
".",
"_call",
"(",
"path",
",",
"'DELETE'",
")"
] |
Deletes a vhost from the server. Note that this also deletes any
exchanges or queues that belong to this vhost.
:param string vname: Name of the vhost to delete from the server.
|
[
"Deletes",
"a",
"vhost",
"from",
"the",
"server",
".",
"Note",
"that",
"this",
"also",
"deletes",
"any",
"exchanges",
"or",
"queues",
"that",
"belong",
"to",
"this",
"vhost",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L244-L253
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_permissions
|
def get_permissions(self):
"""
:returns: list of dicts, or an empty list if there are no permissions.
"""
path = Client.urls['all_permissions']
conns = self._call(path, 'GET')
return conns
|
python
|
def get_permissions(self):
"""
:returns: list of dicts, or an empty list if there are no permissions.
"""
path = Client.urls['all_permissions']
conns = self._call(path, 'GET')
return conns
|
[
"def",
"get_permissions",
"(",
"self",
")",
":",
"path",
"=",
"Client",
".",
"urls",
"[",
"'all_permissions'",
"]",
"conns",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"return",
"conns"
] |
:returns: list of dicts, or an empty list if there are no permissions.
|
[
":",
"returns",
":",
"list",
"of",
"dicts",
"or",
"an",
"empty",
"list",
"if",
"there",
"are",
"no",
"permissions",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L258-L264
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_vhost_permissions
|
def get_vhost_permissions(self, vname):
"""
:returns: list of dicts, or an empty list if there are no permissions.
:param string vname: Name of the vhost to set perms on.
"""
vname = quote(vname, '')
path = Client.urls['vhost_permissions_get'] % (vname,)
conns = self._call(path, 'GET')
return conns
|
python
|
def get_vhost_permissions(self, vname):
"""
:returns: list of dicts, or an empty list if there are no permissions.
:param string vname: Name of the vhost to set perms on.
"""
vname = quote(vname, '')
path = Client.urls['vhost_permissions_get'] % (vname,)
conns = self._call(path, 'GET')
return conns
|
[
"def",
"get_vhost_permissions",
"(",
"self",
",",
"vname",
")",
":",
"vname",
"=",
"quote",
"(",
"vname",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'vhost_permissions_get'",
"]",
"%",
"(",
"vname",
",",
")",
"conns",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"return",
"conns"
] |
:returns: list of dicts, or an empty list if there are no permissions.
:param string vname: Name of the vhost to set perms on.
|
[
":",
"returns",
":",
"list",
"of",
"dicts",
"or",
"an",
"empty",
"list",
"if",
"there",
"are",
"no",
"permissions",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L266-L275
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_user_permissions
|
def get_user_permissions(self, username):
"""
:returns: list of dicts, or an empty list if there are no permissions.
:param string username: User to set permissions for.
"""
path = Client.urls['user_permissions'] % (username,)
conns = self._call(path, 'GET')
return conns
|
python
|
def get_user_permissions(self, username):
"""
:returns: list of dicts, or an empty list if there are no permissions.
:param string username: User to set permissions for.
"""
path = Client.urls['user_permissions'] % (username,)
conns = self._call(path, 'GET')
return conns
|
[
"def",
"get_user_permissions",
"(",
"self",
",",
"username",
")",
":",
"path",
"=",
"Client",
".",
"urls",
"[",
"'user_permissions'",
"]",
"%",
"(",
"username",
",",
")",
"conns",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"return",
"conns"
] |
:returns: list of dicts, or an empty list if there are no permissions.
:param string username: User to set permissions for.
|
[
":",
"returns",
":",
"list",
"of",
"dicts",
"or",
"an",
"empty",
"list",
"if",
"there",
"are",
"no",
"permissions",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L277-L286
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.set_vhost_permissions
|
def set_vhost_permissions(self, vname, username, config, rd, wr):
"""
Set permissions for a given username on a given vhost. Both
must already exist.
:param string vname: Name of the vhost to set perms on.
:param string username: User to set permissions for.
:param string config: Permission pattern for configuration operations
for this user in this vhost.
:param string rd: Permission pattern for read operations for this user
in this vhost
:param string wr: Permission pattern for write operations for this user
in this vhost.
Permission patterns are regex strings. If you're unfamiliar with this,
you should definitely check out this section of the RabbitMQ docs:
http://www.rabbitmq.com/admin-guide.html#access-control
"""
vname = quote(vname, '')
body = json.dumps({"configure": config, "read": rd, "write": wr})
path = Client.urls['vhost_permissions'] % (vname, username)
return self._call(path, 'PUT', body,
headers=Client.json_headers)
|
python
|
def set_vhost_permissions(self, vname, username, config, rd, wr):
"""
Set permissions for a given username on a given vhost. Both
must already exist.
:param string vname: Name of the vhost to set perms on.
:param string username: User to set permissions for.
:param string config: Permission pattern for configuration operations
for this user in this vhost.
:param string rd: Permission pattern for read operations for this user
in this vhost
:param string wr: Permission pattern for write operations for this user
in this vhost.
Permission patterns are regex strings. If you're unfamiliar with this,
you should definitely check out this section of the RabbitMQ docs:
http://www.rabbitmq.com/admin-guide.html#access-control
"""
vname = quote(vname, '')
body = json.dumps({"configure": config, "read": rd, "write": wr})
path = Client.urls['vhost_permissions'] % (vname, username)
return self._call(path, 'PUT', body,
headers=Client.json_headers)
|
[
"def",
"set_vhost_permissions",
"(",
"self",
",",
"vname",
",",
"username",
",",
"config",
",",
"rd",
",",
"wr",
")",
":",
"vname",
"=",
"quote",
"(",
"vname",
",",
"''",
")",
"body",
"=",
"json",
".",
"dumps",
"(",
"{",
"\"configure\"",
":",
"config",
",",
"\"read\"",
":",
"rd",
",",
"\"write\"",
":",
"wr",
"}",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'vhost_permissions'",
"]",
"%",
"(",
"vname",
",",
"username",
")",
"return",
"self",
".",
"_call",
"(",
"path",
",",
"'PUT'",
",",
"body",
",",
"headers",
"=",
"Client",
".",
"json_headers",
")"
] |
Set permissions for a given username on a given vhost. Both
must already exist.
:param string vname: Name of the vhost to set perms on.
:param string username: User to set permissions for.
:param string config: Permission pattern for configuration operations
for this user in this vhost.
:param string rd: Permission pattern for read operations for this user
in this vhost
:param string wr: Permission pattern for write operations for this user
in this vhost.
Permission patterns are regex strings. If you're unfamiliar with this,
you should definitely check out this section of the RabbitMQ docs:
http://www.rabbitmq.com/admin-guide.html#access-control
|
[
"Set",
"permissions",
"for",
"a",
"given",
"username",
"on",
"a",
"given",
"vhost",
".",
"Both",
"must",
"already",
"exist",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L288-L311
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.delete_permission
|
def delete_permission(self, vname, username):
"""
Delete permission for a given username on a given vhost. Both
must already exist.
:param string vname: Name of the vhost to set perms on.
:param string username: User to set permissions for.
"""
vname = quote(vname, '')
path = Client.urls['vhost_permissions'] % (vname, username)
return self._call(path, 'DELETE')
|
python
|
def delete_permission(self, vname, username):
"""
Delete permission for a given username on a given vhost. Both
must already exist.
:param string vname: Name of the vhost to set perms on.
:param string username: User to set permissions for.
"""
vname = quote(vname, '')
path = Client.urls['vhost_permissions'] % (vname, username)
return self._call(path, 'DELETE')
|
[
"def",
"delete_permission",
"(",
"self",
",",
"vname",
",",
"username",
")",
":",
"vname",
"=",
"quote",
"(",
"vname",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'vhost_permissions'",
"]",
"%",
"(",
"vname",
",",
"username",
")",
"return",
"self",
".",
"_call",
"(",
"path",
",",
"'DELETE'",
")"
] |
Delete permission for a given username on a given vhost. Both
must already exist.
:param string vname: Name of the vhost to set perms on.
:param string username: User to set permissions for.
|
[
"Delete",
"permission",
"for",
"a",
"given",
"username",
"on",
"a",
"given",
"vhost",
".",
"Both",
"must",
"already",
"exist",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L313-L323
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_exchanges
|
def get_exchanges(self, vhost=None):
"""
:returns: A list of dicts
:param string vhost: A vhost to query for exchanges, or None (default),
which triggers a query for all exchanges in all vhosts.
"""
if vhost:
vhost = quote(vhost, '')
path = Client.urls['exchanges_by_vhost'] % vhost
else:
path = Client.urls['all_exchanges']
exchanges = self._call(path, 'GET')
return exchanges
|
python
|
def get_exchanges(self, vhost=None):
"""
:returns: A list of dicts
:param string vhost: A vhost to query for exchanges, or None (default),
which triggers a query for all exchanges in all vhosts.
"""
if vhost:
vhost = quote(vhost, '')
path = Client.urls['exchanges_by_vhost'] % vhost
else:
path = Client.urls['all_exchanges']
exchanges = self._call(path, 'GET')
return exchanges
|
[
"def",
"get_exchanges",
"(",
"self",
",",
"vhost",
"=",
"None",
")",
":",
"if",
"vhost",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'exchanges_by_vhost'",
"]",
"%",
"vhost",
"else",
":",
"path",
"=",
"Client",
".",
"urls",
"[",
"'all_exchanges'",
"]",
"exchanges",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"return",
"exchanges"
] |
:returns: A list of dicts
:param string vhost: A vhost to query for exchanges, or None (default),
which triggers a query for all exchanges in all vhosts.
|
[
":",
"returns",
":",
"A",
"list",
"of",
"dicts",
":",
"param",
"string",
"vhost",
":",
"A",
"vhost",
"to",
"query",
"for",
"exchanges",
"or",
"None",
"(",
"default",
")",
"which",
"triggers",
"a",
"query",
"for",
"all",
"exchanges",
"in",
"all",
"vhosts",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L339-L353
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_exchange
|
def get_exchange(self, vhost, name):
"""
Gets a single exchange which requires a vhost and name.
:param string vhost: The vhost containing the target exchange
:param string name: The name of the exchange
:returns: dict
"""
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['exchange_by_name'] % (vhost, name)
exch = self._call(path, 'GET')
return exch
|
python
|
def get_exchange(self, vhost, name):
"""
Gets a single exchange which requires a vhost and name.
:param string vhost: The vhost containing the target exchange
:param string name: The name of the exchange
:returns: dict
"""
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['exchange_by_name'] % (vhost, name)
exch = self._call(path, 'GET')
return exch
|
[
"def",
"get_exchange",
"(",
"self",
",",
"vhost",
",",
"name",
")",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"name",
"=",
"quote",
"(",
"name",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'exchange_by_name'",
"]",
"%",
"(",
"vhost",
",",
"name",
")",
"exch",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"return",
"exch"
] |
Gets a single exchange which requires a vhost and name.
:param string vhost: The vhost containing the target exchange
:param string name: The name of the exchange
:returns: dict
|
[
"Gets",
"a",
"single",
"exchange",
"which",
"requires",
"a",
"vhost",
"and",
"name",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L355-L368
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.create_exchange
|
def create_exchange(self,
vhost,
name,
xtype,
auto_delete=False,
durable=True,
internal=False,
arguments=None):
"""
Creates an exchange in the given vhost with the given name. As per the
RabbitMQ API documentation, a JSON body also needs to be included that
"looks something like this":
{"type":"direct",
"auto_delete":false,
"durable":true,
"internal":false,
"arguments":[]}
On success, the API returns a 204 with no content, in which case this
function returns True. If any other response is received, it's raised.
:param string vhost: Vhost to create the exchange in.
:param string name: Name of the proposed exchange.
:param string type: The AMQP exchange type.
:param bool auto_delete: Whether or not the exchange should be
dropped when the no. of consumers drops to zero.
:param bool durable: Whether you want this exchange to persist a
broker restart.
:param bool internal: Whether or not this is a queue for use by the
broker only.
:param list arguments: If given, should be a list. If not given, an
empty list is sent.
"""
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['exchange_by_name'] % (vhost, name)
base_body = {"type": xtype, "auto_delete": auto_delete,
"durable": durable, "internal": internal,
"arguments": arguments or list()}
body = json.dumps(base_body)
self._call(path, 'PUT', body,
headers=Client.json_headers)
return True
|
python
|
def create_exchange(self,
vhost,
name,
xtype,
auto_delete=False,
durable=True,
internal=False,
arguments=None):
"""
Creates an exchange in the given vhost with the given name. As per the
RabbitMQ API documentation, a JSON body also needs to be included that
"looks something like this":
{"type":"direct",
"auto_delete":false,
"durable":true,
"internal":false,
"arguments":[]}
On success, the API returns a 204 with no content, in which case this
function returns True. If any other response is received, it's raised.
:param string vhost: Vhost to create the exchange in.
:param string name: Name of the proposed exchange.
:param string type: The AMQP exchange type.
:param bool auto_delete: Whether or not the exchange should be
dropped when the no. of consumers drops to zero.
:param bool durable: Whether you want this exchange to persist a
broker restart.
:param bool internal: Whether or not this is a queue for use by the
broker only.
:param list arguments: If given, should be a list. If not given, an
empty list is sent.
"""
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['exchange_by_name'] % (vhost, name)
base_body = {"type": xtype, "auto_delete": auto_delete,
"durable": durable, "internal": internal,
"arguments": arguments or list()}
body = json.dumps(base_body)
self._call(path, 'PUT', body,
headers=Client.json_headers)
return True
|
[
"def",
"create_exchange",
"(",
"self",
",",
"vhost",
",",
"name",
",",
"xtype",
",",
"auto_delete",
"=",
"False",
",",
"durable",
"=",
"True",
",",
"internal",
"=",
"False",
",",
"arguments",
"=",
"None",
")",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"name",
"=",
"quote",
"(",
"name",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'exchange_by_name'",
"]",
"%",
"(",
"vhost",
",",
"name",
")",
"base_body",
"=",
"{",
"\"type\"",
":",
"xtype",
",",
"\"auto_delete\"",
":",
"auto_delete",
",",
"\"durable\"",
":",
"durable",
",",
"\"internal\"",
":",
"internal",
",",
"\"arguments\"",
":",
"arguments",
"or",
"list",
"(",
")",
"}",
"body",
"=",
"json",
".",
"dumps",
"(",
"base_body",
")",
"self",
".",
"_call",
"(",
"path",
",",
"'PUT'",
",",
"body",
",",
"headers",
"=",
"Client",
".",
"json_headers",
")",
"return",
"True"
] |
Creates an exchange in the given vhost with the given name. As per the
RabbitMQ API documentation, a JSON body also needs to be included that
"looks something like this":
{"type":"direct",
"auto_delete":false,
"durable":true,
"internal":false,
"arguments":[]}
On success, the API returns a 204 with no content, in which case this
function returns True. If any other response is received, it's raised.
:param string vhost: Vhost to create the exchange in.
:param string name: Name of the proposed exchange.
:param string type: The AMQP exchange type.
:param bool auto_delete: Whether or not the exchange should be
dropped when the no. of consumers drops to zero.
:param bool durable: Whether you want this exchange to persist a
broker restart.
:param bool internal: Whether or not this is a queue for use by the
broker only.
:param list arguments: If given, should be a list. If not given, an
empty list is sent.
|
[
"Creates",
"an",
"exchange",
"in",
"the",
"given",
"vhost",
"with",
"the",
"given",
"name",
".",
"As",
"per",
"the",
"RabbitMQ",
"API",
"documentation",
"a",
"JSON",
"body",
"also",
"needs",
"to",
"be",
"included",
"that",
"looks",
"something",
"like",
"this",
":"
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L370-L416
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.publish
|
def publish(self, vhost, xname, rt_key, payload, payload_enc='string',
properties=None):
"""
Publish a message to an exchange.
:param string vhost: vhost housing the target exchange
:param string xname: name of the target exchange
:param string rt_key: routing key for message
:param string payload: the message body for publishing
:param string payload_enc: encoding of the payload. The only choices
here are 'string' and 'base64'.
:param dict properties: a dict of message properties
:returns: boolean indicating success or failure.
"""
vhost = quote(vhost, '')
xname = quote(xname, '')
path = Client.urls['publish_to_exchange'] % (vhost, xname)
body = json.dumps({'routing_key': rt_key, 'payload': payload,
'payload_encoding': payload_enc,
'properties': properties or {}})
result = self._call(path, 'POST', body)
return result['routed']
|
python
|
def publish(self, vhost, xname, rt_key, payload, payload_enc='string',
properties=None):
"""
Publish a message to an exchange.
:param string vhost: vhost housing the target exchange
:param string xname: name of the target exchange
:param string rt_key: routing key for message
:param string payload: the message body for publishing
:param string payload_enc: encoding of the payload. The only choices
here are 'string' and 'base64'.
:param dict properties: a dict of message properties
:returns: boolean indicating success or failure.
"""
vhost = quote(vhost, '')
xname = quote(xname, '')
path = Client.urls['publish_to_exchange'] % (vhost, xname)
body = json.dumps({'routing_key': rt_key, 'payload': payload,
'payload_encoding': payload_enc,
'properties': properties or {}})
result = self._call(path, 'POST', body)
return result['routed']
|
[
"def",
"publish",
"(",
"self",
",",
"vhost",
",",
"xname",
",",
"rt_key",
",",
"payload",
",",
"payload_enc",
"=",
"'string'",
",",
"properties",
"=",
"None",
")",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"xname",
"=",
"quote",
"(",
"xname",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'publish_to_exchange'",
"]",
"%",
"(",
"vhost",
",",
"xname",
")",
"body",
"=",
"json",
".",
"dumps",
"(",
"{",
"'routing_key'",
":",
"rt_key",
",",
"'payload'",
":",
"payload",
",",
"'payload_encoding'",
":",
"payload_enc",
",",
"'properties'",
":",
"properties",
"or",
"{",
"}",
"}",
")",
"result",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'POST'",
",",
"body",
")",
"return",
"result",
"[",
"'routed'",
"]"
] |
Publish a message to an exchange.
:param string vhost: vhost housing the target exchange
:param string xname: name of the target exchange
:param string rt_key: routing key for message
:param string payload: the message body for publishing
:param string payload_enc: encoding of the payload. The only choices
here are 'string' and 'base64'.
:param dict properties: a dict of message properties
:returns: boolean indicating success or failure.
|
[
"Publish",
"a",
"message",
"to",
"an",
"exchange",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L418-L439
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.delete_exchange
|
def delete_exchange(self, vhost, name):
"""
Delete the named exchange from the named vhost. The API returns a 204
on success, in which case this method returns True, otherwise the
error is raised.
:param string vhost: Vhost where target exchange was created
:param string name: The name of the exchange to delete.
:returns bool: True on success.
"""
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['exchange_by_name'] % (vhost, name)
self._call(path, 'DELETE')
return True
|
python
|
def delete_exchange(self, vhost, name):
"""
Delete the named exchange from the named vhost. The API returns a 204
on success, in which case this method returns True, otherwise the
error is raised.
:param string vhost: Vhost where target exchange was created
:param string name: The name of the exchange to delete.
:returns bool: True on success.
"""
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['exchange_by_name'] % (vhost, name)
self._call(path, 'DELETE')
return True
|
[
"def",
"delete_exchange",
"(",
"self",
",",
"vhost",
",",
"name",
")",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"name",
"=",
"quote",
"(",
"name",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'exchange_by_name'",
"]",
"%",
"(",
"vhost",
",",
"name",
")",
"self",
".",
"_call",
"(",
"path",
",",
"'DELETE'",
")",
"return",
"True"
] |
Delete the named exchange from the named vhost. The API returns a 204
on success, in which case this method returns True, otherwise the
error is raised.
:param string vhost: Vhost where target exchange was created
:param string name: The name of the exchange to delete.
:returns bool: True on success.
|
[
"Delete",
"the",
"named",
"exchange",
"from",
"the",
"named",
"vhost",
".",
"The",
"API",
"returns",
"a",
"204",
"on",
"success",
"in",
"which",
"case",
"this",
"method",
"returns",
"True",
"otherwise",
"the",
"error",
"is",
"raised",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L441-L455
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_queues
|
def get_queues(self, vhost=None):
"""
Get all queues, or all queues in a vhost if vhost is not None.
Returns a list.
:param string vhost: The virtual host to list queues for. If This is
None (the default), all queues for the broker instance
are returned.
:returns: A list of dicts, each representing a queue.
:rtype: list of dicts
"""
if vhost:
vhost = quote(vhost, '')
path = Client.urls['queues_by_vhost'] % vhost
else:
path = Client.urls['all_queues']
queues = self._call(path, 'GET')
return queues or list()
|
python
|
def get_queues(self, vhost=None):
"""
Get all queues, or all queues in a vhost if vhost is not None.
Returns a list.
:param string vhost: The virtual host to list queues for. If This is
None (the default), all queues for the broker instance
are returned.
:returns: A list of dicts, each representing a queue.
:rtype: list of dicts
"""
if vhost:
vhost = quote(vhost, '')
path = Client.urls['queues_by_vhost'] % vhost
else:
path = Client.urls['all_queues']
queues = self._call(path, 'GET')
return queues or list()
|
[
"def",
"get_queues",
"(",
"self",
",",
"vhost",
"=",
"None",
")",
":",
"if",
"vhost",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'queues_by_vhost'",
"]",
"%",
"vhost",
"else",
":",
"path",
"=",
"Client",
".",
"urls",
"[",
"'all_queues'",
"]",
"queues",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"return",
"queues",
"or",
"list",
"(",
")"
] |
Get all queues, or all queues in a vhost if vhost is not None.
Returns a list.
:param string vhost: The virtual host to list queues for. If This is
None (the default), all queues for the broker instance
are returned.
:returns: A list of dicts, each representing a queue.
:rtype: list of dicts
|
[
"Get",
"all",
"queues",
"or",
"all",
"queues",
"in",
"a",
"vhost",
"if",
"vhost",
"is",
"not",
"None",
".",
"Returns",
"a",
"list",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L460-L479
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_queue
|
def get_queue(self, vhost, name):
"""
Get a single queue, which requires both vhost and name.
:param string vhost: The virtual host for the queue being requested.
If the vhost is '/', note that it will be translated to '%2F' to
conform to URL encoding requirements.
:param string name: The name of the queue being requested.
:returns: A dictionary of queue properties.
:rtype: dict
"""
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['queues_by_name'] % (vhost, name)
queue = self._call(path, 'GET')
return queue
|
python
|
def get_queue(self, vhost, name):
"""
Get a single queue, which requires both vhost and name.
:param string vhost: The virtual host for the queue being requested.
If the vhost is '/', note that it will be translated to '%2F' to
conform to URL encoding requirements.
:param string name: The name of the queue being requested.
:returns: A dictionary of queue properties.
:rtype: dict
"""
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['queues_by_name'] % (vhost, name)
queue = self._call(path, 'GET')
return queue
|
[
"def",
"get_queue",
"(",
"self",
",",
"vhost",
",",
"name",
")",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"name",
"=",
"quote",
"(",
"name",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'queues_by_name'",
"]",
"%",
"(",
"vhost",
",",
"name",
")",
"queue",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"return",
"queue"
] |
Get a single queue, which requires both vhost and name.
:param string vhost: The virtual host for the queue being requested.
If the vhost is '/', note that it will be translated to '%2F' to
conform to URL encoding requirements.
:param string name: The name of the queue being requested.
:returns: A dictionary of queue properties.
:rtype: dict
|
[
"Get",
"a",
"single",
"queue",
"which",
"requires",
"both",
"vhost",
"and",
"name",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L481-L497
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_queue_depth
|
def get_queue_depth(self, vhost, name):
"""
Get the number of messages currently in a queue. This is a convenience
function that just calls :meth:`Client.get_queue` and pulls
out/returns the 'messages' field from the dictionary it returns.
:param string vhost: The vhost of the queue being queried.
:param string name: The name of the queue to query.
:returns: Number of messages in the queue
:rtype: integer
"""
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['queues_by_name'] % (vhost, name)
queue = self._call(path, 'GET')
depth = queue['messages']
return depth
|
python
|
def get_queue_depth(self, vhost, name):
"""
Get the number of messages currently in a queue. This is a convenience
function that just calls :meth:`Client.get_queue` and pulls
out/returns the 'messages' field from the dictionary it returns.
:param string vhost: The vhost of the queue being queried.
:param string name: The name of the queue to query.
:returns: Number of messages in the queue
:rtype: integer
"""
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['queues_by_name'] % (vhost, name)
queue = self._call(path, 'GET')
depth = queue['messages']
return depth
|
[
"def",
"get_queue_depth",
"(",
"self",
",",
"vhost",
",",
"name",
")",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"name",
"=",
"quote",
"(",
"name",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'queues_by_name'",
"]",
"%",
"(",
"vhost",
",",
"name",
")",
"queue",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"depth",
"=",
"queue",
"[",
"'messages'",
"]",
"return",
"depth"
] |
Get the number of messages currently in a queue. This is a convenience
function that just calls :meth:`Client.get_queue` and pulls
out/returns the 'messages' field from the dictionary it returns.
:param string vhost: The vhost of the queue being queried.
:param string name: The name of the queue to query.
:returns: Number of messages in the queue
:rtype: integer
|
[
"Get",
"the",
"number",
"of",
"messages",
"currently",
"in",
"a",
"queue",
".",
"This",
"is",
"a",
"convenience",
"function",
"that",
"just",
"calls",
":",
"meth",
":",
"Client",
".",
"get_queue",
"and",
"pulls",
"out",
"/",
"returns",
"the",
"messages",
"field",
"from",
"the",
"dictionary",
"it",
"returns",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L499-L517
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_queue_depths
|
def get_queue_depths(self, vhost, names=None):
"""
Get the number of messages currently sitting in either the queue
names listed in 'names', or all queues in 'vhost' if no 'names' are
given.
:param str vhost: Vhost where queues in 'names' live.
:param list names: OPTIONAL - Specific queues to show depths for. If
None, show depths for all queues in 'vhost'.
"""
vhost = quote(vhost, '')
if not names:
# get all queues in vhost
path = Client.urls['queues_by_vhost'] % vhost
queues = self._call(path, 'GET')
for queue in queues:
depth = queue['messages']
print("\t%s: %s" % (queue, depth))
else:
# get the named queues only.
for name in names:
depth = self.get_queue_depth(vhost, name)
print("\t%s: %s" % (name, depth))
|
python
|
def get_queue_depths(self, vhost, names=None):
"""
Get the number of messages currently sitting in either the queue
names listed in 'names', or all queues in 'vhost' if no 'names' are
given.
:param str vhost: Vhost where queues in 'names' live.
:param list names: OPTIONAL - Specific queues to show depths for. If
None, show depths for all queues in 'vhost'.
"""
vhost = quote(vhost, '')
if not names:
# get all queues in vhost
path = Client.urls['queues_by_vhost'] % vhost
queues = self._call(path, 'GET')
for queue in queues:
depth = queue['messages']
print("\t%s: %s" % (queue, depth))
else:
# get the named queues only.
for name in names:
depth = self.get_queue_depth(vhost, name)
print("\t%s: %s" % (name, depth))
|
[
"def",
"get_queue_depths",
"(",
"self",
",",
"vhost",
",",
"names",
"=",
"None",
")",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"if",
"not",
"names",
":",
"# get all queues in vhost",
"path",
"=",
"Client",
".",
"urls",
"[",
"'queues_by_vhost'",
"]",
"%",
"vhost",
"queues",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"for",
"queue",
"in",
"queues",
":",
"depth",
"=",
"queue",
"[",
"'messages'",
"]",
"print",
"(",
"\"\\t%s: %s\"",
"%",
"(",
"queue",
",",
"depth",
")",
")",
"else",
":",
"# get the named queues only.",
"for",
"name",
"in",
"names",
":",
"depth",
"=",
"self",
".",
"get_queue_depth",
"(",
"vhost",
",",
"name",
")",
"print",
"(",
"\"\\t%s: %s\"",
"%",
"(",
"name",
",",
"depth",
")",
")"
] |
Get the number of messages currently sitting in either the queue
names listed in 'names', or all queues in 'vhost' if no 'names' are
given.
:param str vhost: Vhost where queues in 'names' live.
:param list names: OPTIONAL - Specific queues to show depths for. If
None, show depths for all queues in 'vhost'.
|
[
"Get",
"the",
"number",
"of",
"messages",
"currently",
"sitting",
"in",
"either",
"the",
"queue",
"names",
"listed",
"in",
"names",
"or",
"all",
"queues",
"in",
"vhost",
"if",
"no",
"names",
"are",
"given",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L519-L542
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.purge_queues
|
def purge_queues(self, queues):
"""
Purge all messages from one or more queues.
:param list queues: A list of ('qname', 'vhost') tuples.
:returns: True on success
"""
for name, vhost in queues:
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['purge_queue'] % (vhost, name)
self._call(path, 'DELETE')
return True
|
python
|
def purge_queues(self, queues):
"""
Purge all messages from one or more queues.
:param list queues: A list of ('qname', 'vhost') tuples.
:returns: True on success
"""
for name, vhost in queues:
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['purge_queue'] % (vhost, name)
self._call(path, 'DELETE')
return True
|
[
"def",
"purge_queues",
"(",
"self",
",",
"queues",
")",
":",
"for",
"name",
",",
"vhost",
"in",
"queues",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"name",
"=",
"quote",
"(",
"name",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'purge_queue'",
"]",
"%",
"(",
"vhost",
",",
"name",
")",
"self",
".",
"_call",
"(",
"path",
",",
"'DELETE'",
")",
"return",
"True"
] |
Purge all messages from one or more queues.
:param list queues: A list of ('qname', 'vhost') tuples.
:returns: True on success
|
[
"Purge",
"all",
"messages",
"from",
"one",
"or",
"more",
"queues",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L544-L557
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.purge_queue
|
def purge_queue(self, vhost, name):
"""
Purge all messages from a single queue. This is a convenience method
so you aren't forced to supply a list containing a single tuple to
the purge_queues method.
:param string vhost: The vhost of the queue being purged.
:param string name: The name of the queue being purged.
:rtype: None
"""
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['purge_queue'] % (vhost, name)
return self._call(path, 'DELETE')
|
python
|
def purge_queue(self, vhost, name):
"""
Purge all messages from a single queue. This is a convenience method
so you aren't forced to supply a list containing a single tuple to
the purge_queues method.
:param string vhost: The vhost of the queue being purged.
:param string name: The name of the queue being purged.
:rtype: None
"""
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['purge_queue'] % (vhost, name)
return self._call(path, 'DELETE')
|
[
"def",
"purge_queue",
"(",
"self",
",",
"vhost",
",",
"name",
")",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"name",
"=",
"quote",
"(",
"name",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'purge_queue'",
"]",
"%",
"(",
"vhost",
",",
"name",
")",
"return",
"self",
".",
"_call",
"(",
"path",
",",
"'DELETE'",
")"
] |
Purge all messages from a single queue. This is a convenience method
so you aren't forced to supply a list containing a single tuple to
the purge_queues method.
:param string vhost: The vhost of the queue being purged.
:param string name: The name of the queue being purged.
:rtype: None
|
[
"Purge",
"all",
"messages",
"from",
"a",
"single",
"queue",
".",
"This",
"is",
"a",
"convenience",
"method",
"so",
"you",
"aren",
"t",
"forced",
"to",
"supply",
"a",
"list",
"containing",
"a",
"single",
"tuple",
"to",
"the",
"purge_queues",
"method",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L559-L573
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.create_queue
|
def create_queue(self, vhost, name, **kwargs):
"""
Create a queue. The API documentation specifies that all of the body
elements are optional, so this method only requires arguments needed
to form the URI
:param string vhost: The vhost to create the queue in.
:param string name: The name of the queue
More on these operations can be found at:
http://www.rabbitmq.com/amqp-0-9-1-reference.html
"""
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['queues_by_name'] % (vhost, name)
body = json.dumps(kwargs)
return self._call(path,
'PUT',
body,
headers=Client.json_headers)
|
python
|
def create_queue(self, vhost, name, **kwargs):
"""
Create a queue. The API documentation specifies that all of the body
elements are optional, so this method only requires arguments needed
to form the URI
:param string vhost: The vhost to create the queue in.
:param string name: The name of the queue
More on these operations can be found at:
http://www.rabbitmq.com/amqp-0-9-1-reference.html
"""
vhost = quote(vhost, '')
name = quote(name, '')
path = Client.urls['queues_by_name'] % (vhost, name)
body = json.dumps(kwargs)
return self._call(path,
'PUT',
body,
headers=Client.json_headers)
|
[
"def",
"create_queue",
"(",
"self",
",",
"vhost",
",",
"name",
",",
"*",
"*",
"kwargs",
")",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"name",
"=",
"quote",
"(",
"name",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'queues_by_name'",
"]",
"%",
"(",
"vhost",
",",
"name",
")",
"body",
"=",
"json",
".",
"dumps",
"(",
"kwargs",
")",
"return",
"self",
".",
"_call",
"(",
"path",
",",
"'PUT'",
",",
"body",
",",
"headers",
"=",
"Client",
".",
"json_headers",
")"
] |
Create a queue. The API documentation specifies that all of the body
elements are optional, so this method only requires arguments needed
to form the URI
:param string vhost: The vhost to create the queue in.
:param string name: The name of the queue
More on these operations can be found at:
http://www.rabbitmq.com/amqp-0-9-1-reference.html
|
[
"Create",
"a",
"queue",
".",
"The",
"API",
"documentation",
"specifies",
"that",
"all",
"of",
"the",
"body",
"elements",
"are",
"optional",
"so",
"this",
"method",
"only",
"requires",
"arguments",
"needed",
"to",
"form",
"the",
"URI"
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L575-L598
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.delete_queue
|
def delete_queue(self, vhost, qname):
"""
Deletes the named queue from the named vhost.
:param string vhost: Vhost housing the queue to be deleted.
:param string qname: Name of the queue to delete.
Note that if you just want to delete the messages from a queue, you
should use purge_queue instead of deleting/recreating a queue.
"""
vhost = quote(vhost, '')
qname = quote(qname, '')
path = Client.urls['queues_by_name'] % (vhost, qname)
return self._call(path, 'DELETE', headers=Client.json_headers)
|
python
|
def delete_queue(self, vhost, qname):
"""
Deletes the named queue from the named vhost.
:param string vhost: Vhost housing the queue to be deleted.
:param string qname: Name of the queue to delete.
Note that if you just want to delete the messages from a queue, you
should use purge_queue instead of deleting/recreating a queue.
"""
vhost = quote(vhost, '')
qname = quote(qname, '')
path = Client.urls['queues_by_name'] % (vhost, qname)
return self._call(path, 'DELETE', headers=Client.json_headers)
|
[
"def",
"delete_queue",
"(",
"self",
",",
"vhost",
",",
"qname",
")",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"qname",
"=",
"quote",
"(",
"qname",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'queues_by_name'",
"]",
"%",
"(",
"vhost",
",",
"qname",
")",
"return",
"self",
".",
"_call",
"(",
"path",
",",
"'DELETE'",
",",
"headers",
"=",
"Client",
".",
"json_headers",
")"
] |
Deletes the named queue from the named vhost.
:param string vhost: Vhost housing the queue to be deleted.
:param string qname: Name of the queue to delete.
Note that if you just want to delete the messages from a queue, you
should use purge_queue instead of deleting/recreating a queue.
|
[
"Deletes",
"the",
"named",
"queue",
"from",
"the",
"named",
"vhost",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L600-L613
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_messages
|
def get_messages(self, vhost, qname, count=1,
requeue=False, truncate=None, encoding='auto'):
"""
Gets <count> messages from the queue.
:param string vhost: Name of vhost containing the queue
:param string qname: Name of the queue to consume from
:param int count: Number of messages to get.
:param bool requeue: Whether to requeue the message after getting it.
This will cause the 'redelivered' flag to be set in the message on
the queue.
:param int truncate: The length, in bytes, beyond which the server will
truncate the message before returning it.
:returns: list of dicts. messages[msg-index]['payload'] will contain
the message body.
"""
vhost = quote(vhost, '')
base_body = {'count': count, 'requeue': requeue, 'encoding': encoding}
if truncate:
base_body['truncate'] = truncate
body = json.dumps(base_body)
qname = quote(qname, '')
path = Client.urls['get_from_queue'] % (vhost, qname)
messages = self._call(path, 'POST', body,
headers=Client.json_headers)
return messages
|
python
|
def get_messages(self, vhost, qname, count=1,
requeue=False, truncate=None, encoding='auto'):
"""
Gets <count> messages from the queue.
:param string vhost: Name of vhost containing the queue
:param string qname: Name of the queue to consume from
:param int count: Number of messages to get.
:param bool requeue: Whether to requeue the message after getting it.
This will cause the 'redelivered' flag to be set in the message on
the queue.
:param int truncate: The length, in bytes, beyond which the server will
truncate the message before returning it.
:returns: list of dicts. messages[msg-index]['payload'] will contain
the message body.
"""
vhost = quote(vhost, '')
base_body = {'count': count, 'requeue': requeue, 'encoding': encoding}
if truncate:
base_body['truncate'] = truncate
body = json.dumps(base_body)
qname = quote(qname, '')
path = Client.urls['get_from_queue'] % (vhost, qname)
messages = self._call(path, 'POST', body,
headers=Client.json_headers)
return messages
|
[
"def",
"get_messages",
"(",
"self",
",",
"vhost",
",",
"qname",
",",
"count",
"=",
"1",
",",
"requeue",
"=",
"False",
",",
"truncate",
"=",
"None",
",",
"encoding",
"=",
"'auto'",
")",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"base_body",
"=",
"{",
"'count'",
":",
"count",
",",
"'requeue'",
":",
"requeue",
",",
"'encoding'",
":",
"encoding",
"}",
"if",
"truncate",
":",
"base_body",
"[",
"'truncate'",
"]",
"=",
"truncate",
"body",
"=",
"json",
".",
"dumps",
"(",
"base_body",
")",
"qname",
"=",
"quote",
"(",
"qname",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'get_from_queue'",
"]",
"%",
"(",
"vhost",
",",
"qname",
")",
"messages",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'POST'",
",",
"body",
",",
"headers",
"=",
"Client",
".",
"json_headers",
")",
"return",
"messages"
] |
Gets <count> messages from the queue.
:param string vhost: Name of vhost containing the queue
:param string qname: Name of the queue to consume from
:param int count: Number of messages to get.
:param bool requeue: Whether to requeue the message after getting it.
This will cause the 'redelivered' flag to be set in the message on
the queue.
:param int truncate: The length, in bytes, beyond which the server will
truncate the message before returning it.
:returns: list of dicts. messages[msg-index]['payload'] will contain
the message body.
|
[
"Gets",
"<count",
">",
"messages",
"from",
"the",
"queue",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L615-L642
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_connections
|
def get_connections(self):
"""
:returns: list of dicts, or an empty list if there are no connections.
"""
path = Client.urls['all_connections']
conns = self._call(path, 'GET')
return conns
|
python
|
def get_connections(self):
"""
:returns: list of dicts, or an empty list if there are no connections.
"""
path = Client.urls['all_connections']
conns = self._call(path, 'GET')
return conns
|
[
"def",
"get_connections",
"(",
"self",
")",
":",
"path",
"=",
"Client",
".",
"urls",
"[",
"'all_connections'",
"]",
"conns",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"return",
"conns"
] |
:returns: list of dicts, or an empty list if there are no connections.
|
[
":",
"returns",
":",
"list",
"of",
"dicts",
"or",
"an",
"empty",
"list",
"if",
"there",
"are",
"no",
"connections",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L647-L653
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_connection
|
def get_connection(self, name):
"""
Get a connection by name. To get the names, use get_connections.
:param string name: Name of connection to get
:returns dict conn: A connection attribute dictionary.
"""
name = quote(name, '')
path = Client.urls['connections_by_name'] % name
conn = self._call(path, 'GET')
return conn
|
python
|
def get_connection(self, name):
"""
Get a connection by name. To get the names, use get_connections.
:param string name: Name of connection to get
:returns dict conn: A connection attribute dictionary.
"""
name = quote(name, '')
path = Client.urls['connections_by_name'] % name
conn = self._call(path, 'GET')
return conn
|
[
"def",
"get_connection",
"(",
"self",
",",
"name",
")",
":",
"name",
"=",
"quote",
"(",
"name",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'connections_by_name'",
"]",
"%",
"name",
"conn",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"return",
"conn"
] |
Get a connection by name. To get the names, use get_connections.
:param string name: Name of connection to get
:returns dict conn: A connection attribute dictionary.
|
[
"Get",
"a",
"connection",
"by",
"name",
".",
"To",
"get",
"the",
"names",
"use",
"get_connections",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L655-L666
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.delete_connection
|
def delete_connection(self, name):
"""
Close the named connection. The API returns a 204 on success,
in which case this method returns True, otherwise the
error is raised.
:param string name: The name of the connection to delete.
:returns bool: True on success.
"""
name = quote(name, '')
path = Client.urls['connections_by_name'] % name
self._call(path, 'DELETE')
return True
|
python
|
def delete_connection(self, name):
"""
Close the named connection. The API returns a 204 on success,
in which case this method returns True, otherwise the
error is raised.
:param string name: The name of the connection to delete.
:returns bool: True on success.
"""
name = quote(name, '')
path = Client.urls['connections_by_name'] % name
self._call(path, 'DELETE')
return True
|
[
"def",
"delete_connection",
"(",
"self",
",",
"name",
")",
":",
"name",
"=",
"quote",
"(",
"name",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'connections_by_name'",
"]",
"%",
"name",
"self",
".",
"_call",
"(",
"path",
",",
"'DELETE'",
")",
"return",
"True"
] |
Close the named connection. The API returns a 204 on success,
in which case this method returns True, otherwise the
error is raised.
:param string name: The name of the connection to delete.
:returns bool: True on success.
|
[
"Close",
"the",
"named",
"connection",
".",
"The",
"API",
"returns",
"a",
"204",
"on",
"success",
"in",
"which",
"case",
"this",
"method",
"returns",
"True",
"otherwise",
"the",
"error",
"is",
"raised",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L668-L680
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_channels
|
def get_channels(self):
"""
Return a list of dicts containing details about broker connections.
:returns: list of dicts
"""
path = Client.urls['all_channels']
chans = self._call(path, 'GET')
return chans
|
python
|
def get_channels(self):
"""
Return a list of dicts containing details about broker connections.
:returns: list of dicts
"""
path = Client.urls['all_channels']
chans = self._call(path, 'GET')
return chans
|
[
"def",
"get_channels",
"(",
"self",
")",
":",
"path",
"=",
"Client",
".",
"urls",
"[",
"'all_channels'",
"]",
"chans",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"return",
"chans"
] |
Return a list of dicts containing details about broker connections.
:returns: list of dicts
|
[
"Return",
"a",
"list",
"of",
"dicts",
"containing",
"details",
"about",
"broker",
"connections",
".",
":",
"returns",
":",
"list",
"of",
"dicts"
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L682-L689
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_channel
|
def get_channel(self, name):
"""
Get a channel by name. To get the names, use get_channels.
:param string name: Name of channel to get
:returns dict conn: A channel attribute dictionary.
"""
name = quote(name, '')
path = Client.urls['channels_by_name'] % name
chan = self._call(path, 'GET')
return chan
|
python
|
def get_channel(self, name):
"""
Get a channel by name. To get the names, use get_channels.
:param string name: Name of channel to get
:returns dict conn: A channel attribute dictionary.
"""
name = quote(name, '')
path = Client.urls['channels_by_name'] % name
chan = self._call(path, 'GET')
return chan
|
[
"def",
"get_channel",
"(",
"self",
",",
"name",
")",
":",
"name",
"=",
"quote",
"(",
"name",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'channels_by_name'",
"]",
"%",
"name",
"chan",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"return",
"chan"
] |
Get a channel by name. To get the names, use get_channels.
:param string name: Name of channel to get
:returns dict conn: A channel attribute dictionary.
|
[
"Get",
"a",
"channel",
"by",
"name",
".",
"To",
"get",
"the",
"names",
"use",
"get_channels",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L691-L702
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_bindings
|
def get_bindings(self):
"""
:returns: list of dicts
"""
path = Client.urls['all_bindings']
bindings = self._call(path, 'GET')
return bindings
|
python
|
def get_bindings(self):
"""
:returns: list of dicts
"""
path = Client.urls['all_bindings']
bindings = self._call(path, 'GET')
return bindings
|
[
"def",
"get_bindings",
"(",
"self",
")",
":",
"path",
"=",
"Client",
".",
"urls",
"[",
"'all_bindings'",
"]",
"bindings",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"return",
"bindings"
] |
:returns: list of dicts
|
[
":",
"returns",
":",
"list",
"of",
"dicts"
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L704-L711
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.get_queue_bindings
|
def get_queue_bindings(self, vhost, qname):
"""
Return a list of dicts, one dict per binding. The dict format coming
from RabbitMQ for queue named 'testq' is:
{"source":"sourceExch","vhost":"/","destination":"testq",
"destination_type":"queue","routing_key":"*.*","arguments":{},
"properties_key":"%2A.%2A"}
"""
vhost = quote(vhost, '')
qname = quote(qname, '')
path = Client.urls['bindings_on_queue'] % (vhost, qname)
bindings = self._call(path, 'GET')
return bindings
|
python
|
def get_queue_bindings(self, vhost, qname):
"""
Return a list of dicts, one dict per binding. The dict format coming
from RabbitMQ for queue named 'testq' is:
{"source":"sourceExch","vhost":"/","destination":"testq",
"destination_type":"queue","routing_key":"*.*","arguments":{},
"properties_key":"%2A.%2A"}
"""
vhost = quote(vhost, '')
qname = quote(qname, '')
path = Client.urls['bindings_on_queue'] % (vhost, qname)
bindings = self._call(path, 'GET')
return bindings
|
[
"def",
"get_queue_bindings",
"(",
"self",
",",
"vhost",
",",
"qname",
")",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"qname",
"=",
"quote",
"(",
"qname",
",",
"''",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'bindings_on_queue'",
"]",
"%",
"(",
"vhost",
",",
"qname",
")",
"bindings",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'GET'",
")",
"return",
"bindings"
] |
Return a list of dicts, one dict per binding. The dict format coming
from RabbitMQ for queue named 'testq' is:
{"source":"sourceExch","vhost":"/","destination":"testq",
"destination_type":"queue","routing_key":"*.*","arguments":{},
"properties_key":"%2A.%2A"}
|
[
"Return",
"a",
"list",
"of",
"dicts",
"one",
"dict",
"per",
"binding",
".",
"The",
"dict",
"format",
"coming",
"from",
"RabbitMQ",
"for",
"queue",
"named",
"testq",
"is",
":"
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L713-L726
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.create_binding
|
def create_binding(self, vhost, exchange, queue, rt_key=None, args=None):
"""
Creates a binding between an exchange and a queue on a given vhost.
:param string vhost: vhost housing the exchange/queue to bind
:param string exchange: the target exchange of the binding
:param string queue: the queue to bind to the exchange
:param string rt_key: the routing key to use for the binding
:param list args: extra arguments to associate w/ the binding.
:returns: boolean
"""
vhost = quote(vhost, '')
exchange = quote(exchange, '')
queue = quote(queue, '')
body = json.dumps({'routing_key': rt_key, 'arguments': args or []})
path = Client.urls['bindings_between_exch_queue'] % (vhost,
exchange,
queue)
binding = self._call(path, 'POST', body=body,
headers=Client.json_headers)
return binding
|
python
|
def create_binding(self, vhost, exchange, queue, rt_key=None, args=None):
"""
Creates a binding between an exchange and a queue on a given vhost.
:param string vhost: vhost housing the exchange/queue to bind
:param string exchange: the target exchange of the binding
:param string queue: the queue to bind to the exchange
:param string rt_key: the routing key to use for the binding
:param list args: extra arguments to associate w/ the binding.
:returns: boolean
"""
vhost = quote(vhost, '')
exchange = quote(exchange, '')
queue = quote(queue, '')
body = json.dumps({'routing_key': rt_key, 'arguments': args or []})
path = Client.urls['bindings_between_exch_queue'] % (vhost,
exchange,
queue)
binding = self._call(path, 'POST', body=body,
headers=Client.json_headers)
return binding
|
[
"def",
"create_binding",
"(",
"self",
",",
"vhost",
",",
"exchange",
",",
"queue",
",",
"rt_key",
"=",
"None",
",",
"args",
"=",
"None",
")",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"exchange",
"=",
"quote",
"(",
"exchange",
",",
"''",
")",
"queue",
"=",
"quote",
"(",
"queue",
",",
"''",
")",
"body",
"=",
"json",
".",
"dumps",
"(",
"{",
"'routing_key'",
":",
"rt_key",
",",
"'arguments'",
":",
"args",
"or",
"[",
"]",
"}",
")",
"path",
"=",
"Client",
".",
"urls",
"[",
"'bindings_between_exch_queue'",
"]",
"%",
"(",
"vhost",
",",
"exchange",
",",
"queue",
")",
"binding",
"=",
"self",
".",
"_call",
"(",
"path",
",",
"'POST'",
",",
"body",
"=",
"body",
",",
"headers",
"=",
"Client",
".",
"json_headers",
")",
"return",
"binding"
] |
Creates a binding between an exchange and a queue on a given vhost.
:param string vhost: vhost housing the exchange/queue to bind
:param string exchange: the target exchange of the binding
:param string queue: the queue to bind to the exchange
:param string rt_key: the routing key to use for the binding
:param list args: extra arguments to associate w/ the binding.
:returns: boolean
|
[
"Creates",
"a",
"binding",
"between",
"an",
"exchange",
"and",
"a",
"queue",
"on",
"a",
"given",
"vhost",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L737-L758
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.delete_binding
|
def delete_binding(self, vhost, exchange, queue, rt_key):
"""
Deletes a binding between an exchange and a queue on a given vhost.
:param string vhost: vhost housing the exchange/queue to bind
:param string exchange: the target exchange of the binding
:param string queue: the queue to bind to the exchange
:param string rt_key: the routing key to use for the binding
"""
vhost = quote(vhost, '')
exchange = quote(exchange, '')
queue = quote(queue, '')
body = ''
path = Client.urls['rt_bindings_between_exch_queue'] % (vhost,
exchange,
queue,
rt_key)
return self._call(path, 'DELETE', headers=Client.json_headers)
|
python
|
def delete_binding(self, vhost, exchange, queue, rt_key):
"""
Deletes a binding between an exchange and a queue on a given vhost.
:param string vhost: vhost housing the exchange/queue to bind
:param string exchange: the target exchange of the binding
:param string queue: the queue to bind to the exchange
:param string rt_key: the routing key to use for the binding
"""
vhost = quote(vhost, '')
exchange = quote(exchange, '')
queue = quote(queue, '')
body = ''
path = Client.urls['rt_bindings_between_exch_queue'] % (vhost,
exchange,
queue,
rt_key)
return self._call(path, 'DELETE', headers=Client.json_headers)
|
[
"def",
"delete_binding",
"(",
"self",
",",
"vhost",
",",
"exchange",
",",
"queue",
",",
"rt_key",
")",
":",
"vhost",
"=",
"quote",
"(",
"vhost",
",",
"''",
")",
"exchange",
"=",
"quote",
"(",
"exchange",
",",
"''",
")",
"queue",
"=",
"quote",
"(",
"queue",
",",
"''",
")",
"body",
"=",
"''",
"path",
"=",
"Client",
".",
"urls",
"[",
"'rt_bindings_between_exch_queue'",
"]",
"%",
"(",
"vhost",
",",
"exchange",
",",
"queue",
",",
"rt_key",
")",
"return",
"self",
".",
"_call",
"(",
"path",
",",
"'DELETE'",
",",
"headers",
"=",
"Client",
".",
"json_headers",
")"
] |
Deletes a binding between an exchange and a queue on a given vhost.
:param string vhost: vhost housing the exchange/queue to bind
:param string exchange: the target exchange of the binding
:param string queue: the queue to bind to the exchange
:param string rt_key: the routing key to use for the binding
|
[
"Deletes",
"a",
"binding",
"between",
"an",
"exchange",
"and",
"a",
"queue",
"on",
"a",
"given",
"vhost",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L760-L778
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.create_user
|
def create_user(self, username, password, tags=""):
"""
Creates a user.
:param string username: The name to give to the new user
:param string password: Password for the new user
:param string tags: Comma-separated list of tags for the user
:returns: boolean
"""
path = Client.urls['users_by_name'] % username
body = json.dumps({'password': password, 'tags': tags})
return self._call(path, 'PUT', body=body,
headers=Client.json_headers)
|
python
|
def create_user(self, username, password, tags=""):
"""
Creates a user.
:param string username: The name to give to the new user
:param string password: Password for the new user
:param string tags: Comma-separated list of tags for the user
:returns: boolean
"""
path = Client.urls['users_by_name'] % username
body = json.dumps({'password': password, 'tags': tags})
return self._call(path, 'PUT', body=body,
headers=Client.json_headers)
|
[
"def",
"create_user",
"(",
"self",
",",
"username",
",",
"password",
",",
"tags",
"=",
"\"\"",
")",
":",
"path",
"=",
"Client",
".",
"urls",
"[",
"'users_by_name'",
"]",
"%",
"username",
"body",
"=",
"json",
".",
"dumps",
"(",
"{",
"'password'",
":",
"password",
",",
"'tags'",
":",
"tags",
"}",
")",
"return",
"self",
".",
"_call",
"(",
"path",
",",
"'PUT'",
",",
"body",
"=",
"body",
",",
"headers",
"=",
"Client",
".",
"json_headers",
")"
] |
Creates a user.
:param string username: The name to give to the new user
:param string password: Password for the new user
:param string tags: Comma-separated list of tags for the user
:returns: boolean
|
[
"Creates",
"a",
"user",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L780-L792
|
bkjones/pyrabbit
|
pyrabbit/api.py
|
Client.delete_user
|
def delete_user(self, username):
"""
Deletes a user from the server.
:param string username: Name of the user to delete from the server.
"""
path = Client.urls['users_by_name'] % username
return self._call(path, 'DELETE')
|
python
|
def delete_user(self, username):
"""
Deletes a user from the server.
:param string username: Name of the user to delete from the server.
"""
path = Client.urls['users_by_name'] % username
return self._call(path, 'DELETE')
|
[
"def",
"delete_user",
"(",
"self",
",",
"username",
")",
":",
"path",
"=",
"Client",
".",
"urls",
"[",
"'users_by_name'",
"]",
"%",
"username",
"return",
"self",
".",
"_call",
"(",
"path",
",",
"'DELETE'",
")"
] |
Deletes a user from the server.
:param string username: Name of the user to delete from the server.
|
[
"Deletes",
"a",
"user",
"from",
"the",
"server",
"."
] |
train
|
https://github.com/bkjones/pyrabbit/blob/e8a9f74ed5c6bba958994fb9a72c396e6a99ea0f/pyrabbit/api.py#L794-L801
|
bartTC/django-wakawaka
|
wakawaka/views.py
|
index
|
def index(request):
"""
Redirects to the default wiki index name.
"""
kwargs = {'slug': getattr(settings, 'WAKAWAKA_DEFAULT_INDEX', 'WikiIndex')}
redirect_to = reverse('wakawaka_page', kwargs=kwargs)
return HttpResponseRedirect(redirect_to)
|
python
|
def index(request):
"""
Redirects to the default wiki index name.
"""
kwargs = {'slug': getattr(settings, 'WAKAWAKA_DEFAULT_INDEX', 'WikiIndex')}
redirect_to = reverse('wakawaka_page', kwargs=kwargs)
return HttpResponseRedirect(redirect_to)
|
[
"def",
"index",
"(",
"request",
")",
":",
"kwargs",
"=",
"{",
"'slug'",
":",
"getattr",
"(",
"settings",
",",
"'WAKAWAKA_DEFAULT_INDEX'",
",",
"'WikiIndex'",
")",
"}",
"redirect_to",
"=",
"reverse",
"(",
"'wakawaka_page'",
",",
"kwargs",
"=",
"kwargs",
")",
"return",
"HttpResponseRedirect",
"(",
"redirect_to",
")"
] |
Redirects to the default wiki index name.
|
[
"Redirects",
"to",
"the",
"default",
"wiki",
"index",
"name",
"."
] |
train
|
https://github.com/bartTC/django-wakawaka/blob/95daff9703a1de07d3393e4b2145bcb903f80e72/wakawaka/views.py#L21-L27
|
bartTC/django-wakawaka
|
wakawaka/views.py
|
page
|
def page(
request,
slug,
rev_id=None,
template_name='wakawaka/page.html',
extra_context=None,
):
"""
Displays a wiki page. Redirects to the edit view if the page doesn't exist.
"""
try:
queryset = WikiPage.objects.all()
page = queryset.get(slug=slug)
rev = page.current
# Display an older revision if rev_id is given
if rev_id:
revision_queryset = Revision.objects.all()
rev_specific = revision_queryset.get(pk=rev_id)
if rev.pk != rev_specific.pk:
rev_specific.is_not_current = True
rev = rev_specific
# The Page does not exist, redirect to the edit form or
# deny, if the user has no permission to add pages
except WikiPage.DoesNotExist:
if request.user.is_authenticated:
kwargs = {'slug': slug}
redirect_to = reverse('wakawaka_edit', kwargs=kwargs)
return HttpResponseRedirect(redirect_to)
raise Http404
template_context = {'page': page, 'rev': rev}
template_context.update(extra_context or {})
return render(request, template_name, template_context)
|
python
|
def page(
request,
slug,
rev_id=None,
template_name='wakawaka/page.html',
extra_context=None,
):
"""
Displays a wiki page. Redirects to the edit view if the page doesn't exist.
"""
try:
queryset = WikiPage.objects.all()
page = queryset.get(slug=slug)
rev = page.current
# Display an older revision if rev_id is given
if rev_id:
revision_queryset = Revision.objects.all()
rev_specific = revision_queryset.get(pk=rev_id)
if rev.pk != rev_specific.pk:
rev_specific.is_not_current = True
rev = rev_specific
# The Page does not exist, redirect to the edit form or
# deny, if the user has no permission to add pages
except WikiPage.DoesNotExist:
if request.user.is_authenticated:
kwargs = {'slug': slug}
redirect_to = reverse('wakawaka_edit', kwargs=kwargs)
return HttpResponseRedirect(redirect_to)
raise Http404
template_context = {'page': page, 'rev': rev}
template_context.update(extra_context or {})
return render(request, template_name, template_context)
|
[
"def",
"page",
"(",
"request",
",",
"slug",
",",
"rev_id",
"=",
"None",
",",
"template_name",
"=",
"'wakawaka/page.html'",
",",
"extra_context",
"=",
"None",
",",
")",
":",
"try",
":",
"queryset",
"=",
"WikiPage",
".",
"objects",
".",
"all",
"(",
")",
"page",
"=",
"queryset",
".",
"get",
"(",
"slug",
"=",
"slug",
")",
"rev",
"=",
"page",
".",
"current",
"# Display an older revision if rev_id is given",
"if",
"rev_id",
":",
"revision_queryset",
"=",
"Revision",
".",
"objects",
".",
"all",
"(",
")",
"rev_specific",
"=",
"revision_queryset",
".",
"get",
"(",
"pk",
"=",
"rev_id",
")",
"if",
"rev",
".",
"pk",
"!=",
"rev_specific",
".",
"pk",
":",
"rev_specific",
".",
"is_not_current",
"=",
"True",
"rev",
"=",
"rev_specific",
"# The Page does not exist, redirect to the edit form or",
"# deny, if the user has no permission to add pages",
"except",
"WikiPage",
".",
"DoesNotExist",
":",
"if",
"request",
".",
"user",
".",
"is_authenticated",
":",
"kwargs",
"=",
"{",
"'slug'",
":",
"slug",
"}",
"redirect_to",
"=",
"reverse",
"(",
"'wakawaka_edit'",
",",
"kwargs",
"=",
"kwargs",
")",
"return",
"HttpResponseRedirect",
"(",
"redirect_to",
")",
"raise",
"Http404",
"template_context",
"=",
"{",
"'page'",
":",
"page",
",",
"'rev'",
":",
"rev",
"}",
"template_context",
".",
"update",
"(",
"extra_context",
"or",
"{",
"}",
")",
"return",
"render",
"(",
"request",
",",
"template_name",
",",
"template_context",
")"
] |
Displays a wiki page. Redirects to the edit view if the page doesn't exist.
|
[
"Displays",
"a",
"wiki",
"page",
".",
"Redirects",
"to",
"the",
"edit",
"view",
"if",
"the",
"page",
"doesn",
"t",
"exist",
"."
] |
train
|
https://github.com/bartTC/django-wakawaka/blob/95daff9703a1de07d3393e4b2145bcb903f80e72/wakawaka/views.py#L30-L63
|
bartTC/django-wakawaka
|
wakawaka/views.py
|
edit
|
def edit(
request,
slug,
rev_id=None,
template_name='wakawaka/edit.html',
extra_context=None,
wiki_page_form=WikiPageForm,
wiki_delete_form=DeleteWikiPageForm,
):
"""
Displays the form for editing and deleting a page.
"""
# Get the page for slug and get a specific revision, if given
try:
queryset = WikiPage.objects.all()
page = queryset.get(slug=slug)
rev = page.current
initial = {'content': page.current.content}
# Do not allow editing wiki pages if the user has no permission
if not request.user.has_perms(
('wakawaka.change_wikipage', 'wakawaka.change_revision')
):
return HttpResponseForbidden(
ugettext('You don\'t have permission to edit pages.')
)
if rev_id:
# There is a specific revision, fetch this
rev_specific = Revision.objects.get(pk=rev_id)
if rev.pk != rev_specific.pk:
rev = rev_specific
rev.is_not_current = True
initial = {
'content': rev.content,
'message': _('Reverted to "%s"' % rev.message),
}
# This page does not exist, create a dummy page
# Note that it's not saved here
except WikiPage.DoesNotExist:
# Do not allow adding wiki pages if the user has no permission
if not request.user.has_perms(
('wakawaka.add_wikipage', 'wakawaka.add_revision')
):
return HttpResponseForbidden(
ugettext('You don\'t have permission to add wiki pages.')
)
page = WikiPage(slug=slug)
page.is_initial = True
rev = None
initial = {
'content': _('Describe your new page %s here...' % slug),
'message': _('Initial revision'),
}
# Don't display the delete form if the user has nor permission
delete_form = None
# The user has permission, then do
if request.user.has_perm(
'wakawaka.delete_wikipage'
) or request.user.has_perm('wakawaka.delete_revision'):
delete_form = wiki_delete_form(request)
if request.method == 'POST' and request.POST.get('delete'):
delete_form = wiki_delete_form(request, request.POST)
if delete_form.is_valid():
return delete_form.delete_wiki(request, page, rev)
# Page add/edit form
form = wiki_page_form(initial=initial)
if request.method == 'POST':
form = wiki_page_form(data=request.POST)
if form.is_valid():
# Check if the content is changed, except there is a rev_id and the
# user possibly only reverted the HEAD to it
if (
not rev_id
and initial['content'] == form.cleaned_data['content']
):
form.errors['content'] = (_('You have made no changes!'),)
# Save the form and redirect to the page view
else:
try:
# Check that the page already exist
queryset = WikiPage.objects.all()
page = queryset.get(slug=slug)
except WikiPage.DoesNotExist:
# Must be a new one, create that page
page = WikiPage(slug=slug)
page.save()
form.save(request, page)
kwargs = {'slug': page.slug}
redirect_to = reverse('wakawaka_page', kwargs=kwargs)
messages.success(
request,
ugettext('Your changes to %s were saved' % page.slug),
)
return HttpResponseRedirect(redirect_to)
template_context = {
'form': form,
'delete_form': delete_form,
'page': page,
'rev': rev,
}
template_context.update(extra_context or {})
return render(request, template_name, template_context)
|
python
|
def edit(
request,
slug,
rev_id=None,
template_name='wakawaka/edit.html',
extra_context=None,
wiki_page_form=WikiPageForm,
wiki_delete_form=DeleteWikiPageForm,
):
"""
Displays the form for editing and deleting a page.
"""
# Get the page for slug and get a specific revision, if given
try:
queryset = WikiPage.objects.all()
page = queryset.get(slug=slug)
rev = page.current
initial = {'content': page.current.content}
# Do not allow editing wiki pages if the user has no permission
if not request.user.has_perms(
('wakawaka.change_wikipage', 'wakawaka.change_revision')
):
return HttpResponseForbidden(
ugettext('You don\'t have permission to edit pages.')
)
if rev_id:
# There is a specific revision, fetch this
rev_specific = Revision.objects.get(pk=rev_id)
if rev.pk != rev_specific.pk:
rev = rev_specific
rev.is_not_current = True
initial = {
'content': rev.content,
'message': _('Reverted to "%s"' % rev.message),
}
# This page does not exist, create a dummy page
# Note that it's not saved here
except WikiPage.DoesNotExist:
# Do not allow adding wiki pages if the user has no permission
if not request.user.has_perms(
('wakawaka.add_wikipage', 'wakawaka.add_revision')
):
return HttpResponseForbidden(
ugettext('You don\'t have permission to add wiki pages.')
)
page = WikiPage(slug=slug)
page.is_initial = True
rev = None
initial = {
'content': _('Describe your new page %s here...' % slug),
'message': _('Initial revision'),
}
# Don't display the delete form if the user has nor permission
delete_form = None
# The user has permission, then do
if request.user.has_perm(
'wakawaka.delete_wikipage'
) or request.user.has_perm('wakawaka.delete_revision'):
delete_form = wiki_delete_form(request)
if request.method == 'POST' and request.POST.get('delete'):
delete_form = wiki_delete_form(request, request.POST)
if delete_form.is_valid():
return delete_form.delete_wiki(request, page, rev)
# Page add/edit form
form = wiki_page_form(initial=initial)
if request.method == 'POST':
form = wiki_page_form(data=request.POST)
if form.is_valid():
# Check if the content is changed, except there is a rev_id and the
# user possibly only reverted the HEAD to it
if (
not rev_id
and initial['content'] == form.cleaned_data['content']
):
form.errors['content'] = (_('You have made no changes!'),)
# Save the form and redirect to the page view
else:
try:
# Check that the page already exist
queryset = WikiPage.objects.all()
page = queryset.get(slug=slug)
except WikiPage.DoesNotExist:
# Must be a new one, create that page
page = WikiPage(slug=slug)
page.save()
form.save(request, page)
kwargs = {'slug': page.slug}
redirect_to = reverse('wakawaka_page', kwargs=kwargs)
messages.success(
request,
ugettext('Your changes to %s were saved' % page.slug),
)
return HttpResponseRedirect(redirect_to)
template_context = {
'form': form,
'delete_form': delete_form,
'page': page,
'rev': rev,
}
template_context.update(extra_context or {})
return render(request, template_name, template_context)
|
[
"def",
"edit",
"(",
"request",
",",
"slug",
",",
"rev_id",
"=",
"None",
",",
"template_name",
"=",
"'wakawaka/edit.html'",
",",
"extra_context",
"=",
"None",
",",
"wiki_page_form",
"=",
"WikiPageForm",
",",
"wiki_delete_form",
"=",
"DeleteWikiPageForm",
",",
")",
":",
"# Get the page for slug and get a specific revision, if given",
"try",
":",
"queryset",
"=",
"WikiPage",
".",
"objects",
".",
"all",
"(",
")",
"page",
"=",
"queryset",
".",
"get",
"(",
"slug",
"=",
"slug",
")",
"rev",
"=",
"page",
".",
"current",
"initial",
"=",
"{",
"'content'",
":",
"page",
".",
"current",
".",
"content",
"}",
"# Do not allow editing wiki pages if the user has no permission",
"if",
"not",
"request",
".",
"user",
".",
"has_perms",
"(",
"(",
"'wakawaka.change_wikipage'",
",",
"'wakawaka.change_revision'",
")",
")",
":",
"return",
"HttpResponseForbidden",
"(",
"ugettext",
"(",
"'You don\\'t have permission to edit pages.'",
")",
")",
"if",
"rev_id",
":",
"# There is a specific revision, fetch this",
"rev_specific",
"=",
"Revision",
".",
"objects",
".",
"get",
"(",
"pk",
"=",
"rev_id",
")",
"if",
"rev",
".",
"pk",
"!=",
"rev_specific",
".",
"pk",
":",
"rev",
"=",
"rev_specific",
"rev",
".",
"is_not_current",
"=",
"True",
"initial",
"=",
"{",
"'content'",
":",
"rev",
".",
"content",
",",
"'message'",
":",
"_",
"(",
"'Reverted to \"%s\"'",
"%",
"rev",
".",
"message",
")",
",",
"}",
"# This page does not exist, create a dummy page",
"# Note that it's not saved here",
"except",
"WikiPage",
".",
"DoesNotExist",
":",
"# Do not allow adding wiki pages if the user has no permission",
"if",
"not",
"request",
".",
"user",
".",
"has_perms",
"(",
"(",
"'wakawaka.add_wikipage'",
",",
"'wakawaka.add_revision'",
")",
")",
":",
"return",
"HttpResponseForbidden",
"(",
"ugettext",
"(",
"'You don\\'t have permission to add wiki pages.'",
")",
")",
"page",
"=",
"WikiPage",
"(",
"slug",
"=",
"slug",
")",
"page",
".",
"is_initial",
"=",
"True",
"rev",
"=",
"None",
"initial",
"=",
"{",
"'content'",
":",
"_",
"(",
"'Describe your new page %s here...'",
"%",
"slug",
")",
",",
"'message'",
":",
"_",
"(",
"'Initial revision'",
")",
",",
"}",
"# Don't display the delete form if the user has nor permission",
"delete_form",
"=",
"None",
"# The user has permission, then do",
"if",
"request",
".",
"user",
".",
"has_perm",
"(",
"'wakawaka.delete_wikipage'",
")",
"or",
"request",
".",
"user",
".",
"has_perm",
"(",
"'wakawaka.delete_revision'",
")",
":",
"delete_form",
"=",
"wiki_delete_form",
"(",
"request",
")",
"if",
"request",
".",
"method",
"==",
"'POST'",
"and",
"request",
".",
"POST",
".",
"get",
"(",
"'delete'",
")",
":",
"delete_form",
"=",
"wiki_delete_form",
"(",
"request",
",",
"request",
".",
"POST",
")",
"if",
"delete_form",
".",
"is_valid",
"(",
")",
":",
"return",
"delete_form",
".",
"delete_wiki",
"(",
"request",
",",
"page",
",",
"rev",
")",
"# Page add/edit form",
"form",
"=",
"wiki_page_form",
"(",
"initial",
"=",
"initial",
")",
"if",
"request",
".",
"method",
"==",
"'POST'",
":",
"form",
"=",
"wiki_page_form",
"(",
"data",
"=",
"request",
".",
"POST",
")",
"if",
"form",
".",
"is_valid",
"(",
")",
":",
"# Check if the content is changed, except there is a rev_id and the",
"# user possibly only reverted the HEAD to it",
"if",
"(",
"not",
"rev_id",
"and",
"initial",
"[",
"'content'",
"]",
"==",
"form",
".",
"cleaned_data",
"[",
"'content'",
"]",
")",
":",
"form",
".",
"errors",
"[",
"'content'",
"]",
"=",
"(",
"_",
"(",
"'You have made no changes!'",
")",
",",
")",
"# Save the form and redirect to the page view",
"else",
":",
"try",
":",
"# Check that the page already exist",
"queryset",
"=",
"WikiPage",
".",
"objects",
".",
"all",
"(",
")",
"page",
"=",
"queryset",
".",
"get",
"(",
"slug",
"=",
"slug",
")",
"except",
"WikiPage",
".",
"DoesNotExist",
":",
"# Must be a new one, create that page",
"page",
"=",
"WikiPage",
"(",
"slug",
"=",
"slug",
")",
"page",
".",
"save",
"(",
")",
"form",
".",
"save",
"(",
"request",
",",
"page",
")",
"kwargs",
"=",
"{",
"'slug'",
":",
"page",
".",
"slug",
"}",
"redirect_to",
"=",
"reverse",
"(",
"'wakawaka_page'",
",",
"kwargs",
"=",
"kwargs",
")",
"messages",
".",
"success",
"(",
"request",
",",
"ugettext",
"(",
"'Your changes to %s were saved'",
"%",
"page",
".",
"slug",
")",
",",
")",
"return",
"HttpResponseRedirect",
"(",
"redirect_to",
")",
"template_context",
"=",
"{",
"'form'",
":",
"form",
",",
"'delete_form'",
":",
"delete_form",
",",
"'page'",
":",
"page",
",",
"'rev'",
":",
"rev",
",",
"}",
"template_context",
".",
"update",
"(",
"extra_context",
"or",
"{",
"}",
")",
"return",
"render",
"(",
"request",
",",
"template_name",
",",
"template_context",
")"
] |
Displays the form for editing and deleting a page.
|
[
"Displays",
"the",
"form",
"for",
"editing",
"and",
"deleting",
"a",
"page",
"."
] |
train
|
https://github.com/bartTC/django-wakawaka/blob/95daff9703a1de07d3393e4b2145bcb903f80e72/wakawaka/views.py#L66-L178
|
bartTC/django-wakawaka
|
wakawaka/views.py
|
revisions
|
def revisions(
request, slug, template_name='wakawaka/revisions.html', extra_context=None
):
"""
Displays the list of all revisions for a specific WikiPage
"""
queryset = WikiPage.objects.all()
page = get_object_or_404(queryset, slug=slug)
template_context = {'page': page}
template_context.update(extra_context or {})
return render(request, template_name, template_context)
|
python
|
def revisions(
request, slug, template_name='wakawaka/revisions.html', extra_context=None
):
"""
Displays the list of all revisions for a specific WikiPage
"""
queryset = WikiPage.objects.all()
page = get_object_or_404(queryset, slug=slug)
template_context = {'page': page}
template_context.update(extra_context or {})
return render(request, template_name, template_context)
|
[
"def",
"revisions",
"(",
"request",
",",
"slug",
",",
"template_name",
"=",
"'wakawaka/revisions.html'",
",",
"extra_context",
"=",
"None",
")",
":",
"queryset",
"=",
"WikiPage",
".",
"objects",
".",
"all",
"(",
")",
"page",
"=",
"get_object_or_404",
"(",
"queryset",
",",
"slug",
"=",
"slug",
")",
"template_context",
"=",
"{",
"'page'",
":",
"page",
"}",
"template_context",
".",
"update",
"(",
"extra_context",
"or",
"{",
"}",
")",
"return",
"render",
"(",
"request",
",",
"template_name",
",",
"template_context",
")"
] |
Displays the list of all revisions for a specific WikiPage
|
[
"Displays",
"the",
"list",
"of",
"all",
"revisions",
"for",
"a",
"specific",
"WikiPage"
] |
train
|
https://github.com/bartTC/django-wakawaka/blob/95daff9703a1de07d3393e4b2145bcb903f80e72/wakawaka/views.py#L181-L192
|
bartTC/django-wakawaka
|
wakawaka/views.py
|
changes
|
def changes(
request, slug, template_name='wakawaka/changes.html', extra_context=None
):
"""
Displays the changes between two revisions.
"""
rev_a_id = request.GET.get('a', None)
rev_b_id = request.GET.get('b', None)
# Some stinky fingers manipulated the url
if not rev_a_id or not rev_b_id:
return HttpResponseBadRequest('Bad Request')
try:
revision_queryset = Revision.objects.all()
wikipage_queryset = WikiPage.objects.all()
rev_a = revision_queryset.get(pk=rev_a_id)
rev_b = revision_queryset.get(pk=rev_b_id)
page = wikipage_queryset.get(slug=slug)
except ObjectDoesNotExist:
raise Http404
if rev_a.content != rev_b.content:
d = difflib.unified_diff(
rev_b.content.splitlines(),
rev_a.content.splitlines(),
'Original',
'Current',
lineterm='',
)
difftext = '\n'.join(d)
else:
difftext = _(u'No changes were made between this two files.')
template_context = {
'page': page,
'diff': difftext,
'rev_a': rev_a,
'rev_b': rev_b,
}
template_context.update(extra_context or {})
return render(request, template_name, template_context)
|
python
|
def changes(
request, slug, template_name='wakawaka/changes.html', extra_context=None
):
"""
Displays the changes between two revisions.
"""
rev_a_id = request.GET.get('a', None)
rev_b_id = request.GET.get('b', None)
# Some stinky fingers manipulated the url
if not rev_a_id or not rev_b_id:
return HttpResponseBadRequest('Bad Request')
try:
revision_queryset = Revision.objects.all()
wikipage_queryset = WikiPage.objects.all()
rev_a = revision_queryset.get(pk=rev_a_id)
rev_b = revision_queryset.get(pk=rev_b_id)
page = wikipage_queryset.get(slug=slug)
except ObjectDoesNotExist:
raise Http404
if rev_a.content != rev_b.content:
d = difflib.unified_diff(
rev_b.content.splitlines(),
rev_a.content.splitlines(),
'Original',
'Current',
lineterm='',
)
difftext = '\n'.join(d)
else:
difftext = _(u'No changes were made between this two files.')
template_context = {
'page': page,
'diff': difftext,
'rev_a': rev_a,
'rev_b': rev_b,
}
template_context.update(extra_context or {})
return render(request, template_name, template_context)
|
[
"def",
"changes",
"(",
"request",
",",
"slug",
",",
"template_name",
"=",
"'wakawaka/changes.html'",
",",
"extra_context",
"=",
"None",
")",
":",
"rev_a_id",
"=",
"request",
".",
"GET",
".",
"get",
"(",
"'a'",
",",
"None",
")",
"rev_b_id",
"=",
"request",
".",
"GET",
".",
"get",
"(",
"'b'",
",",
"None",
")",
"# Some stinky fingers manipulated the url",
"if",
"not",
"rev_a_id",
"or",
"not",
"rev_b_id",
":",
"return",
"HttpResponseBadRequest",
"(",
"'Bad Request'",
")",
"try",
":",
"revision_queryset",
"=",
"Revision",
".",
"objects",
".",
"all",
"(",
")",
"wikipage_queryset",
"=",
"WikiPage",
".",
"objects",
".",
"all",
"(",
")",
"rev_a",
"=",
"revision_queryset",
".",
"get",
"(",
"pk",
"=",
"rev_a_id",
")",
"rev_b",
"=",
"revision_queryset",
".",
"get",
"(",
"pk",
"=",
"rev_b_id",
")",
"page",
"=",
"wikipage_queryset",
".",
"get",
"(",
"slug",
"=",
"slug",
")",
"except",
"ObjectDoesNotExist",
":",
"raise",
"Http404",
"if",
"rev_a",
".",
"content",
"!=",
"rev_b",
".",
"content",
":",
"d",
"=",
"difflib",
".",
"unified_diff",
"(",
"rev_b",
".",
"content",
".",
"splitlines",
"(",
")",
",",
"rev_a",
".",
"content",
".",
"splitlines",
"(",
")",
",",
"'Original'",
",",
"'Current'",
",",
"lineterm",
"=",
"''",
",",
")",
"difftext",
"=",
"'\\n'",
".",
"join",
"(",
"d",
")",
"else",
":",
"difftext",
"=",
"_",
"(",
"u'No changes were made between this two files.'",
")",
"template_context",
"=",
"{",
"'page'",
":",
"page",
",",
"'diff'",
":",
"difftext",
",",
"'rev_a'",
":",
"rev_a",
",",
"'rev_b'",
":",
"rev_b",
",",
"}",
"template_context",
".",
"update",
"(",
"extra_context",
"or",
"{",
"}",
")",
"return",
"render",
"(",
"request",
",",
"template_name",
",",
"template_context",
")"
] |
Displays the changes between two revisions.
|
[
"Displays",
"the",
"changes",
"between",
"two",
"revisions",
"."
] |
train
|
https://github.com/bartTC/django-wakawaka/blob/95daff9703a1de07d3393e4b2145bcb903f80e72/wakawaka/views.py#L195-L236
|
bartTC/django-wakawaka
|
wakawaka/views.py
|
revision_list
|
def revision_list(
request, template_name='wakawaka/revision_list.html', extra_context=None
):
"""
Displays a list of all recent revisions.
"""
revision_list = Revision.objects.all()
template_context = {'revision_list': revision_list}
template_context.update(extra_context or {})
return render(request, template_name, template_context)
|
python
|
def revision_list(
request, template_name='wakawaka/revision_list.html', extra_context=None
):
"""
Displays a list of all recent revisions.
"""
revision_list = Revision.objects.all()
template_context = {'revision_list': revision_list}
template_context.update(extra_context or {})
return render(request, template_name, template_context)
|
[
"def",
"revision_list",
"(",
"request",
",",
"template_name",
"=",
"'wakawaka/revision_list.html'",
",",
"extra_context",
"=",
"None",
")",
":",
"revision_list",
"=",
"Revision",
".",
"objects",
".",
"all",
"(",
")",
"template_context",
"=",
"{",
"'revision_list'",
":",
"revision_list",
"}",
"template_context",
".",
"update",
"(",
"extra_context",
"or",
"{",
"}",
")",
"return",
"render",
"(",
"request",
",",
"template_name",
",",
"template_context",
")"
] |
Displays a list of all recent revisions.
|
[
"Displays",
"a",
"list",
"of",
"all",
"recent",
"revisions",
"."
] |
train
|
https://github.com/bartTC/django-wakawaka/blob/95daff9703a1de07d3393e4b2145bcb903f80e72/wakawaka/views.py#L240-L249
|
bartTC/django-wakawaka
|
wakawaka/views.py
|
page_list
|
def page_list(
request, template_name='wakawaka/page_list.html', extra_context=None
):
"""
Displays all Pages
"""
page_list = WikiPage.objects.all()
page_list = page_list.order_by('slug')
template_context = {
'page_list': page_list,
'index_slug': getattr(settings, 'WAKAWAKA_DEFAULT_INDEX', 'WikiIndex'),
}
template_context.update(extra_context or {})
return render(request, template_name, template_context)
|
python
|
def page_list(
request, template_name='wakawaka/page_list.html', extra_context=None
):
"""
Displays all Pages
"""
page_list = WikiPage.objects.all()
page_list = page_list.order_by('slug')
template_context = {
'page_list': page_list,
'index_slug': getattr(settings, 'WAKAWAKA_DEFAULT_INDEX', 'WikiIndex'),
}
template_context.update(extra_context or {})
return render(request, template_name, template_context)
|
[
"def",
"page_list",
"(",
"request",
",",
"template_name",
"=",
"'wakawaka/page_list.html'",
",",
"extra_context",
"=",
"None",
")",
":",
"page_list",
"=",
"WikiPage",
".",
"objects",
".",
"all",
"(",
")",
"page_list",
"=",
"page_list",
".",
"order_by",
"(",
"'slug'",
")",
"template_context",
"=",
"{",
"'page_list'",
":",
"page_list",
",",
"'index_slug'",
":",
"getattr",
"(",
"settings",
",",
"'WAKAWAKA_DEFAULT_INDEX'",
",",
"'WikiIndex'",
")",
",",
"}",
"template_context",
".",
"update",
"(",
"extra_context",
"or",
"{",
"}",
")",
"return",
"render",
"(",
"request",
",",
"template_name",
",",
"template_context",
")"
] |
Displays all Pages
|
[
"Displays",
"all",
"Pages"
] |
train
|
https://github.com/bartTC/django-wakawaka/blob/95daff9703a1de07d3393e4b2145bcb903f80e72/wakawaka/views.py#L252-L266
|
bartTC/django-wakawaka
|
wakawaka/forms.py
|
DeleteWikiPageForm.delete_wiki
|
def delete_wiki(self, request, page, rev):
"""
Deletes the page with all revisions or the revision, based on the
users choice.
Returns a HttpResponseRedirect.
"""
# Delete the page
if (
self.cleaned_data.get('delete') == 'page'
and request.user.has_perm('wakawaka.delete_revision')
and request.user.has_perm('wakawaka.delete_wikipage')
):
self._delete_page(page)
messages.success(
request, ugettext('The page %s was deleted' % page.slug)
)
return HttpResponseRedirect(reverse('wakawaka_index'))
# Revision handling
if self.cleaned_data.get('delete') == 'rev':
revision_length = len(page.revisions.all())
# Delete the revision if there are more than 1 and the user has permission
if revision_length > 1 and request.user.has_perm(
'wakawaka.delete_revision'
):
self._delete_revision(rev)
messages.success(
request,
ugettext('The revision for %s was deleted' % page.slug),
)
return HttpResponseRedirect(
reverse('wakawaka_page', kwargs={'slug': page.slug})
)
# Do not allow deleting the revision, if it's the only one and the user
# has no permisson to delete the page.
if revision_length <= 1 and not request.user.has_perm(
'wakawaka.delete_wikipage'
):
messages.error(
request,
ugettext(
'You can not delete this revison for %s because it\'s the '
'only one and you have no permission to delete the whole page.'
% page.slug
),
)
return HttpResponseRedirect(
reverse('wakawaka_page', kwargs={'slug': page.slug})
)
# Delete the page and the revision if the user has both permissions
if (
revision_length <= 1
and request.user.has_perm('wakawaka.delete_revision')
and request.user.has_perm('wakawaka.delete_wikipage')
):
self._delete_page(page)
messages.success(
request,
ugettext(
'The page for %s was deleted because you deleted the only revision'
% page.slug
),
)
return HttpResponseRedirect(reverse('wakawaka_index'))
|
python
|
def delete_wiki(self, request, page, rev):
"""
Deletes the page with all revisions or the revision, based on the
users choice.
Returns a HttpResponseRedirect.
"""
# Delete the page
if (
self.cleaned_data.get('delete') == 'page'
and request.user.has_perm('wakawaka.delete_revision')
and request.user.has_perm('wakawaka.delete_wikipage')
):
self._delete_page(page)
messages.success(
request, ugettext('The page %s was deleted' % page.slug)
)
return HttpResponseRedirect(reverse('wakawaka_index'))
# Revision handling
if self.cleaned_data.get('delete') == 'rev':
revision_length = len(page.revisions.all())
# Delete the revision if there are more than 1 and the user has permission
if revision_length > 1 and request.user.has_perm(
'wakawaka.delete_revision'
):
self._delete_revision(rev)
messages.success(
request,
ugettext('The revision for %s was deleted' % page.slug),
)
return HttpResponseRedirect(
reverse('wakawaka_page', kwargs={'slug': page.slug})
)
# Do not allow deleting the revision, if it's the only one and the user
# has no permisson to delete the page.
if revision_length <= 1 and not request.user.has_perm(
'wakawaka.delete_wikipage'
):
messages.error(
request,
ugettext(
'You can not delete this revison for %s because it\'s the '
'only one and you have no permission to delete the whole page.'
% page.slug
),
)
return HttpResponseRedirect(
reverse('wakawaka_page', kwargs={'slug': page.slug})
)
# Delete the page and the revision if the user has both permissions
if (
revision_length <= 1
and request.user.has_perm('wakawaka.delete_revision')
and request.user.has_perm('wakawaka.delete_wikipage')
):
self._delete_page(page)
messages.success(
request,
ugettext(
'The page for %s was deleted because you deleted the only revision'
% page.slug
),
)
return HttpResponseRedirect(reverse('wakawaka_index'))
|
[
"def",
"delete_wiki",
"(",
"self",
",",
"request",
",",
"page",
",",
"rev",
")",
":",
"# Delete the page",
"if",
"(",
"self",
".",
"cleaned_data",
".",
"get",
"(",
"'delete'",
")",
"==",
"'page'",
"and",
"request",
".",
"user",
".",
"has_perm",
"(",
"'wakawaka.delete_revision'",
")",
"and",
"request",
".",
"user",
".",
"has_perm",
"(",
"'wakawaka.delete_wikipage'",
")",
")",
":",
"self",
".",
"_delete_page",
"(",
"page",
")",
"messages",
".",
"success",
"(",
"request",
",",
"ugettext",
"(",
"'The page %s was deleted'",
"%",
"page",
".",
"slug",
")",
")",
"return",
"HttpResponseRedirect",
"(",
"reverse",
"(",
"'wakawaka_index'",
")",
")",
"# Revision handling",
"if",
"self",
".",
"cleaned_data",
".",
"get",
"(",
"'delete'",
")",
"==",
"'rev'",
":",
"revision_length",
"=",
"len",
"(",
"page",
".",
"revisions",
".",
"all",
"(",
")",
")",
"# Delete the revision if there are more than 1 and the user has permission",
"if",
"revision_length",
">",
"1",
"and",
"request",
".",
"user",
".",
"has_perm",
"(",
"'wakawaka.delete_revision'",
")",
":",
"self",
".",
"_delete_revision",
"(",
"rev",
")",
"messages",
".",
"success",
"(",
"request",
",",
"ugettext",
"(",
"'The revision for %s was deleted'",
"%",
"page",
".",
"slug",
")",
",",
")",
"return",
"HttpResponseRedirect",
"(",
"reverse",
"(",
"'wakawaka_page'",
",",
"kwargs",
"=",
"{",
"'slug'",
":",
"page",
".",
"slug",
"}",
")",
")",
"# Do not allow deleting the revision, if it's the only one and the user",
"# has no permisson to delete the page.",
"if",
"revision_length",
"<=",
"1",
"and",
"not",
"request",
".",
"user",
".",
"has_perm",
"(",
"'wakawaka.delete_wikipage'",
")",
":",
"messages",
".",
"error",
"(",
"request",
",",
"ugettext",
"(",
"'You can not delete this revison for %s because it\\'s the '",
"'only one and you have no permission to delete the whole page.'",
"%",
"page",
".",
"slug",
")",
",",
")",
"return",
"HttpResponseRedirect",
"(",
"reverse",
"(",
"'wakawaka_page'",
",",
"kwargs",
"=",
"{",
"'slug'",
":",
"page",
".",
"slug",
"}",
")",
")",
"# Delete the page and the revision if the user has both permissions",
"if",
"(",
"revision_length",
"<=",
"1",
"and",
"request",
".",
"user",
".",
"has_perm",
"(",
"'wakawaka.delete_revision'",
")",
"and",
"request",
".",
"user",
".",
"has_perm",
"(",
"'wakawaka.delete_wikipage'",
")",
")",
":",
"self",
".",
"_delete_page",
"(",
"page",
")",
"messages",
".",
"success",
"(",
"request",
",",
"ugettext",
"(",
"'The page for %s was deleted because you deleted the only revision'",
"%",
"page",
".",
"slug",
")",
",",
")",
"return",
"HttpResponseRedirect",
"(",
"reverse",
"(",
"'wakawaka_index'",
")",
")"
] |
Deletes the page with all revisions or the revision, based on the
users choice.
Returns a HttpResponseRedirect.
|
[
"Deletes",
"the",
"page",
"with",
"all",
"revisions",
"or",
"the",
"revision",
"based",
"on",
"the",
"users",
"choice",
"."
] |
train
|
https://github.com/bartTC/django-wakawaka/blob/95daff9703a1de07d3393e4b2145bcb903f80e72/wakawaka/forms.py#L62-L131
|
noirbizarre/django-eztables
|
eztables/views.py
|
get_real_field
|
def get_real_field(model, field_name):
'''
Get the real field from a model given its name.
Handle nested models recursively (aka. ``__`` lookups)
'''
parts = field_name.split('__')
field = model._meta.get_field(parts[0])
if len(parts) == 1:
return model._meta.get_field(field_name)
elif isinstance(field, models.ForeignKey):
return get_real_field(field.rel.to, '__'.join(parts[1:]))
else:
raise Exception('Unhandled field: %s' % field_name)
|
python
|
def get_real_field(model, field_name):
'''
Get the real field from a model given its name.
Handle nested models recursively (aka. ``__`` lookups)
'''
parts = field_name.split('__')
field = model._meta.get_field(parts[0])
if len(parts) == 1:
return model._meta.get_field(field_name)
elif isinstance(field, models.ForeignKey):
return get_real_field(field.rel.to, '__'.join(parts[1:]))
else:
raise Exception('Unhandled field: %s' % field_name)
|
[
"def",
"get_real_field",
"(",
"model",
",",
"field_name",
")",
":",
"parts",
"=",
"field_name",
".",
"split",
"(",
"'__'",
")",
"field",
"=",
"model",
".",
"_meta",
".",
"get_field",
"(",
"parts",
"[",
"0",
"]",
")",
"if",
"len",
"(",
"parts",
")",
"==",
"1",
":",
"return",
"model",
".",
"_meta",
".",
"get_field",
"(",
"field_name",
")",
"elif",
"isinstance",
"(",
"field",
",",
"models",
".",
"ForeignKey",
")",
":",
"return",
"get_real_field",
"(",
"field",
".",
"rel",
".",
"to",
",",
"'__'",
".",
"join",
"(",
"parts",
"[",
"1",
":",
"]",
")",
")",
"else",
":",
"raise",
"Exception",
"(",
"'Unhandled field: %s'",
"%",
"field_name",
")"
] |
Get the real field from a model given its name.
Handle nested models recursively (aka. ``__`` lookups)
|
[
"Get",
"the",
"real",
"field",
"from",
"a",
"model",
"given",
"its",
"name",
"."
] |
train
|
https://github.com/noirbizarre/django-eztables/blob/347e74dcc08121d20f4cf942181d873dbe33b995/eztables/views.py#L35-L48
|
noirbizarre/django-eztables
|
eztables/views.py
|
DatatablesView.can_regex
|
def can_regex(self, field):
'''Test if a given field supports regex lookups'''
from django.conf import settings
if settings.DATABASES['default']['ENGINE'].endswith('sqlite3'):
return not isinstance(get_real_field(self.model, field), UNSUPPORTED_REGEX_FIELDS)
else:
return True
|
python
|
def can_regex(self, field):
'''Test if a given field supports regex lookups'''
from django.conf import settings
if settings.DATABASES['default']['ENGINE'].endswith('sqlite3'):
return not isinstance(get_real_field(self.model, field), UNSUPPORTED_REGEX_FIELDS)
else:
return True
|
[
"def",
"can_regex",
"(",
"self",
",",
"field",
")",
":",
"from",
"django",
".",
"conf",
"import",
"settings",
"if",
"settings",
".",
"DATABASES",
"[",
"'default'",
"]",
"[",
"'ENGINE'",
"]",
".",
"endswith",
"(",
"'sqlite3'",
")",
":",
"return",
"not",
"isinstance",
"(",
"get_real_field",
"(",
"self",
".",
"model",
",",
"field",
")",
",",
"UNSUPPORTED_REGEX_FIELDS",
")",
"else",
":",
"return",
"True"
] |
Test if a given field supports regex lookups
|
[
"Test",
"if",
"a",
"given",
"field",
"supports",
"regex",
"lookups"
] |
train
|
https://github.com/noirbizarre/django-eztables/blob/347e74dcc08121d20f4cf942181d873dbe33b995/eztables/views.py#L95-L101
|
noirbizarre/django-eztables
|
eztables/views.py
|
DatatablesView.get_orders
|
def get_orders(self):
'''Get ordering fields for ``QuerySet.order_by``'''
orders = []
iSortingCols = self.dt_data['iSortingCols']
dt_orders = [(self.dt_data['iSortCol_%s' % i], self.dt_data['sSortDir_%s' % i]) for i in xrange(iSortingCols)]
for field_idx, field_dir in dt_orders:
direction = '-' if field_dir == DESC else ''
if hasattr(self, 'sort_col_%s' % field_idx):
method = getattr(self, 'sort_col_%s' % field_idx)
result = method(direction)
if isinstance(result, (bytes, text_type)):
orders.append(result)
else:
orders.extend(result)
else:
field = self.get_field(field_idx)
if RE_FORMATTED.match(field):
tokens = RE_FORMATTED.findall(field)
orders.extend(['%s%s' % (direction, token) for token in tokens])
else:
orders.append('%s%s' % (direction, field))
return orders
|
python
|
def get_orders(self):
'''Get ordering fields for ``QuerySet.order_by``'''
orders = []
iSortingCols = self.dt_data['iSortingCols']
dt_orders = [(self.dt_data['iSortCol_%s' % i], self.dt_data['sSortDir_%s' % i]) for i in xrange(iSortingCols)]
for field_idx, field_dir in dt_orders:
direction = '-' if field_dir == DESC else ''
if hasattr(self, 'sort_col_%s' % field_idx):
method = getattr(self, 'sort_col_%s' % field_idx)
result = method(direction)
if isinstance(result, (bytes, text_type)):
orders.append(result)
else:
orders.extend(result)
else:
field = self.get_field(field_idx)
if RE_FORMATTED.match(field):
tokens = RE_FORMATTED.findall(field)
orders.extend(['%s%s' % (direction, token) for token in tokens])
else:
orders.append('%s%s' % (direction, field))
return orders
|
[
"def",
"get_orders",
"(",
"self",
")",
":",
"orders",
"=",
"[",
"]",
"iSortingCols",
"=",
"self",
".",
"dt_data",
"[",
"'iSortingCols'",
"]",
"dt_orders",
"=",
"[",
"(",
"self",
".",
"dt_data",
"[",
"'iSortCol_%s'",
"%",
"i",
"]",
",",
"self",
".",
"dt_data",
"[",
"'sSortDir_%s'",
"%",
"i",
"]",
")",
"for",
"i",
"in",
"xrange",
"(",
"iSortingCols",
")",
"]",
"for",
"field_idx",
",",
"field_dir",
"in",
"dt_orders",
":",
"direction",
"=",
"'-'",
"if",
"field_dir",
"==",
"DESC",
"else",
"''",
"if",
"hasattr",
"(",
"self",
",",
"'sort_col_%s'",
"%",
"field_idx",
")",
":",
"method",
"=",
"getattr",
"(",
"self",
",",
"'sort_col_%s'",
"%",
"field_idx",
")",
"result",
"=",
"method",
"(",
"direction",
")",
"if",
"isinstance",
"(",
"result",
",",
"(",
"bytes",
",",
"text_type",
")",
")",
":",
"orders",
".",
"append",
"(",
"result",
")",
"else",
":",
"orders",
".",
"extend",
"(",
"result",
")",
"else",
":",
"field",
"=",
"self",
".",
"get_field",
"(",
"field_idx",
")",
"if",
"RE_FORMATTED",
".",
"match",
"(",
"field",
")",
":",
"tokens",
"=",
"RE_FORMATTED",
".",
"findall",
"(",
"field",
")",
"orders",
".",
"extend",
"(",
"[",
"'%s%s'",
"%",
"(",
"direction",
",",
"token",
")",
"for",
"token",
"in",
"tokens",
"]",
")",
"else",
":",
"orders",
".",
"append",
"(",
"'%s%s'",
"%",
"(",
"direction",
",",
"field",
")",
")",
"return",
"orders"
] |
Get ordering fields for ``QuerySet.order_by``
|
[
"Get",
"ordering",
"fields",
"for",
"QuerySet",
".",
"order_by"
] |
train
|
https://github.com/noirbizarre/django-eztables/blob/347e74dcc08121d20f4cf942181d873dbe33b995/eztables/views.py#L103-L124
|
noirbizarre/django-eztables
|
eztables/views.py
|
DatatablesView.global_search
|
def global_search(self, queryset):
'''Filter a queryset with global search'''
search = self.dt_data['sSearch']
if search:
if self.dt_data['bRegex']:
criterions = [
Q(**{'%s__iregex' % field: search})
for field in self.get_db_fields()
if self.can_regex(field)
]
if len(criterions) > 0:
search = reduce(or_, criterions)
queryset = queryset.filter(search)
else:
for term in search.split():
criterions = (Q(**{'%s__icontains' % field: term}) for field in self.get_db_fields())
search = reduce(or_, criterions)
queryset = queryset.filter(search)
return queryset
|
python
|
def global_search(self, queryset):
'''Filter a queryset with global search'''
search = self.dt_data['sSearch']
if search:
if self.dt_data['bRegex']:
criterions = [
Q(**{'%s__iregex' % field: search})
for field in self.get_db_fields()
if self.can_regex(field)
]
if len(criterions) > 0:
search = reduce(or_, criterions)
queryset = queryset.filter(search)
else:
for term in search.split():
criterions = (Q(**{'%s__icontains' % field: term}) for field in self.get_db_fields())
search = reduce(or_, criterions)
queryset = queryset.filter(search)
return queryset
|
[
"def",
"global_search",
"(",
"self",
",",
"queryset",
")",
":",
"search",
"=",
"self",
".",
"dt_data",
"[",
"'sSearch'",
"]",
"if",
"search",
":",
"if",
"self",
".",
"dt_data",
"[",
"'bRegex'",
"]",
":",
"criterions",
"=",
"[",
"Q",
"(",
"*",
"*",
"{",
"'%s__iregex'",
"%",
"field",
":",
"search",
"}",
")",
"for",
"field",
"in",
"self",
".",
"get_db_fields",
"(",
")",
"if",
"self",
".",
"can_regex",
"(",
"field",
")",
"]",
"if",
"len",
"(",
"criterions",
")",
">",
"0",
":",
"search",
"=",
"reduce",
"(",
"or_",
",",
"criterions",
")",
"queryset",
"=",
"queryset",
".",
"filter",
"(",
"search",
")",
"else",
":",
"for",
"term",
"in",
"search",
".",
"split",
"(",
")",
":",
"criterions",
"=",
"(",
"Q",
"(",
"*",
"*",
"{",
"'%s__icontains'",
"%",
"field",
":",
"term",
"}",
")",
"for",
"field",
"in",
"self",
".",
"get_db_fields",
"(",
")",
")",
"search",
"=",
"reduce",
"(",
"or_",
",",
"criterions",
")",
"queryset",
"=",
"queryset",
".",
"filter",
"(",
"search",
")",
"return",
"queryset"
] |
Filter a queryset with global search
|
[
"Filter",
"a",
"queryset",
"with",
"global",
"search"
] |
train
|
https://github.com/noirbizarre/django-eztables/blob/347e74dcc08121d20f4cf942181d873dbe33b995/eztables/views.py#L126-L144
|
noirbizarre/django-eztables
|
eztables/views.py
|
DatatablesView.column_search
|
def column_search(self, queryset):
'''Filter a queryset with column search'''
for idx in xrange(self.dt_data['iColumns']):
search = self.dt_data['sSearch_%s' % idx]
if search:
if hasattr(self, 'search_col_%s' % idx):
custom_search = getattr(self, 'search_col_%s' % idx)
queryset = custom_search(search, queryset)
else:
field = self.get_field(idx)
fields = RE_FORMATTED.findall(field) if RE_FORMATTED.match(field) else [field]
if self.dt_data['bRegex_%s' % idx]:
criterions = [Q(**{'%s__iregex' % field: search}) for field in fields if self.can_regex(field)]
if len(criterions) > 0:
search = reduce(or_, criterions)
queryset = queryset.filter(search)
else:
for term in search.split():
criterions = (Q(**{'%s__icontains' % field: term}) for field in fields)
search = reduce(or_, criterions)
queryset = queryset.filter(search)
return queryset
|
python
|
def column_search(self, queryset):
'''Filter a queryset with column search'''
for idx in xrange(self.dt_data['iColumns']):
search = self.dt_data['sSearch_%s' % idx]
if search:
if hasattr(self, 'search_col_%s' % idx):
custom_search = getattr(self, 'search_col_%s' % idx)
queryset = custom_search(search, queryset)
else:
field = self.get_field(idx)
fields = RE_FORMATTED.findall(field) if RE_FORMATTED.match(field) else [field]
if self.dt_data['bRegex_%s' % idx]:
criterions = [Q(**{'%s__iregex' % field: search}) for field in fields if self.can_regex(field)]
if len(criterions) > 0:
search = reduce(or_, criterions)
queryset = queryset.filter(search)
else:
for term in search.split():
criterions = (Q(**{'%s__icontains' % field: term}) for field in fields)
search = reduce(or_, criterions)
queryset = queryset.filter(search)
return queryset
|
[
"def",
"column_search",
"(",
"self",
",",
"queryset",
")",
":",
"for",
"idx",
"in",
"xrange",
"(",
"self",
".",
"dt_data",
"[",
"'iColumns'",
"]",
")",
":",
"search",
"=",
"self",
".",
"dt_data",
"[",
"'sSearch_%s'",
"%",
"idx",
"]",
"if",
"search",
":",
"if",
"hasattr",
"(",
"self",
",",
"'search_col_%s'",
"%",
"idx",
")",
":",
"custom_search",
"=",
"getattr",
"(",
"self",
",",
"'search_col_%s'",
"%",
"idx",
")",
"queryset",
"=",
"custom_search",
"(",
"search",
",",
"queryset",
")",
"else",
":",
"field",
"=",
"self",
".",
"get_field",
"(",
"idx",
")",
"fields",
"=",
"RE_FORMATTED",
".",
"findall",
"(",
"field",
")",
"if",
"RE_FORMATTED",
".",
"match",
"(",
"field",
")",
"else",
"[",
"field",
"]",
"if",
"self",
".",
"dt_data",
"[",
"'bRegex_%s'",
"%",
"idx",
"]",
":",
"criterions",
"=",
"[",
"Q",
"(",
"*",
"*",
"{",
"'%s__iregex'",
"%",
"field",
":",
"search",
"}",
")",
"for",
"field",
"in",
"fields",
"if",
"self",
".",
"can_regex",
"(",
"field",
")",
"]",
"if",
"len",
"(",
"criterions",
")",
">",
"0",
":",
"search",
"=",
"reduce",
"(",
"or_",
",",
"criterions",
")",
"queryset",
"=",
"queryset",
".",
"filter",
"(",
"search",
")",
"else",
":",
"for",
"term",
"in",
"search",
".",
"split",
"(",
")",
":",
"criterions",
"=",
"(",
"Q",
"(",
"*",
"*",
"{",
"'%s__icontains'",
"%",
"field",
":",
"term",
"}",
")",
"for",
"field",
"in",
"fields",
")",
"search",
"=",
"reduce",
"(",
"or_",
",",
"criterions",
")",
"queryset",
"=",
"queryset",
".",
"filter",
"(",
"search",
")",
"return",
"queryset"
] |
Filter a queryset with column search
|
[
"Filter",
"a",
"queryset",
"with",
"column",
"search"
] |
train
|
https://github.com/noirbizarre/django-eztables/blob/347e74dcc08121d20f4cf942181d873dbe33b995/eztables/views.py#L146-L167
|
noirbizarre/django-eztables
|
eztables/views.py
|
DatatablesView.get_queryset
|
def get_queryset(self):
'''Apply Datatables sort and search criterion to QuerySet'''
qs = super(DatatablesView, self).get_queryset()
# Perform global search
qs = self.global_search(qs)
# Perform column search
qs = self.column_search(qs)
# Return the ordered queryset
return qs.order_by(*self.get_orders())
|
python
|
def get_queryset(self):
'''Apply Datatables sort and search criterion to QuerySet'''
qs = super(DatatablesView, self).get_queryset()
# Perform global search
qs = self.global_search(qs)
# Perform column search
qs = self.column_search(qs)
# Return the ordered queryset
return qs.order_by(*self.get_orders())
|
[
"def",
"get_queryset",
"(",
"self",
")",
":",
"qs",
"=",
"super",
"(",
"DatatablesView",
",",
"self",
")",
".",
"get_queryset",
"(",
")",
"# Perform global search",
"qs",
"=",
"self",
".",
"global_search",
"(",
"qs",
")",
"# Perform column search",
"qs",
"=",
"self",
".",
"column_search",
"(",
"qs",
")",
"# Return the ordered queryset",
"return",
"qs",
".",
"order_by",
"(",
"*",
"self",
".",
"get_orders",
"(",
")",
")"
] |
Apply Datatables sort and search criterion to QuerySet
|
[
"Apply",
"Datatables",
"sort",
"and",
"search",
"criterion",
"to",
"QuerySet"
] |
train
|
https://github.com/noirbizarre/django-eztables/blob/347e74dcc08121d20f4cf942181d873dbe33b995/eztables/views.py#L169-L177
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.