text_prompt
stringlengths 100
17.7k
⌀ | code_prompt
stringlengths 7
9.86k
⌀ |
|---|---|
<SYSTEM_TASK:>
Validate and return the Placeholder object that the template variable points to.
<END_TASK>
<USER_TASK:>
Description:
def _get_placeholder_arg(arg_name, placeholder):
"""
Validate and return the Placeholder object that the template variable points to.
""" |
if placeholder is None:
raise RuntimeWarning(u"placeholder object is None")
elif isinstance(placeholder, Placeholder):
return placeholder
elif isinstance(placeholder, Manager):
manager = placeholder
try:
parent_object = manager.instance # read RelatedManager code
except AttributeError:
parent_object = None
try:
placeholder = manager.all()[0]
if parent_object is not None:
placeholder.parent = parent_object # Fill GFK cache
return placeholder
except IndexError:
raise RuntimeWarning(u"No placeholders found for query '{0}.all.0'".format(arg_name))
else:
raise ValueError(u"The field '{0}' does not refer to a placeholder object!".format(arg_name)) |
<SYSTEM_TASK:>
Return the string literal that is used in the template.
<END_TASK>
<USER_TASK:>
Description:
def get_title(self):
"""
Return the string literal that is used in the template.
The title is used in the admin screens.
""" |
try:
return extract_literal(self.meta_kwargs['title'])
except KeyError:
slot = self.get_slot()
if slot is not None:
return slot.replace('_', ' ').title()
return None |
<SYSTEM_TASK:>
See if a template FilterExpression holds a literal value.
<END_TASK>
<USER_TASK:>
Description:
def extract_literal(templatevar):
"""
See if a template FilterExpression holds a literal value.
:type templatevar: django.template.FilterExpression
:rtype: bool|None
""" |
# FilterExpression contains another 'var' that either contains a Variable or SafeData object.
if hasattr(templatevar, 'var'):
templatevar = templatevar.var
if isinstance(templatevar, SafeData):
# Literal in FilterExpression, can return.
return templatevar
else:
# Variable in FilterExpression, not going to work here.
return None
if templatevar[0] in ('"', "'") and templatevar[-1] in ('"', "'"):
return templatevar[1:-1]
else:
return None |
<SYSTEM_TASK:>
See if a template FilterExpression holds a literal boolean value.
<END_TASK>
<USER_TASK:>
Description:
def extract_literal_bool(templatevar):
"""
See if a template FilterExpression holds a literal boolean value.
:type templatevar: django.template.FilterExpression
:rtype: bool|None
""" |
# FilterExpression contains another 'var' that either contains a Variable or SafeData object.
if hasattr(templatevar, 'var'):
templatevar = templatevar.var
if isinstance(templatevar, SafeData):
# Literal in FilterExpression, can return.
return is_true(templatevar)
else:
# Variable in FilterExpression, not going to work here.
return None
return is_true(templatevar) |
<SYSTEM_TASK:>
Create a new MarkupPlugin class that represents the plugin type.
<END_TASK>
<USER_TASK:>
Description:
def _create_markup_plugin(language, model):
"""
Create a new MarkupPlugin class that represents the plugin type.
""" |
form = type("{0}MarkupItemForm".format(language.capitalize()), (MarkupItemForm,), {
'default_language': language,
})
classname = "{0}MarkupPlugin".format(language.capitalize())
PluginClass = type(classname, (MarkupPluginBase,), {
'model': model,
'form': form,
})
return PluginClass |
<SYSTEM_TASK:>
Return a placeholder by key.
<END_TASK>
<USER_TASK:>
Description:
def get_by_slot(self, parent_object, slot):
"""
Return a placeholder by key.
""" |
placeholder = self.parent(parent_object).get(slot=slot)
placeholder.parent = parent_object # fill the reverse cache
return placeholder |
<SYSTEM_TASK:>
Create a placeholder with the given parameters
<END_TASK>
<USER_TASK:>
Description:
def create_for_object(self, parent_object, slot, role='m', title=None):
"""
Create a placeholder with the given parameters
""" |
from .db import Placeholder
parent_attrs = get_parent_lookup_kwargs(parent_object)
obj = self.create(
slot=slot,
role=role or Placeholder.MAIN,
title=title or slot.title().replace('_', ' '),
**parent_attrs
)
obj.parent = parent_object # fill the reverse cache
return obj |
<SYSTEM_TASK:>
Create a Content Item with the given parameters
<END_TASK>
<USER_TASK:>
Description:
def create_for_placeholder(self, placeholder, sort_order=1, language_code=None, **kwargs):
"""
Create a Content Item with the given parameters
If the language_code is not provided, the language code of the parent will be used.
This may perform an additional database query, unless
the :class:`~fluent_contents.models.managers.PlaceholderManager` methods were used to construct the object,
such as :func:`~fluent_contents.models.managers.PlaceholderManager.create_for_object`
or :func:`~fluent_contents.models.managers.PlaceholderManager.get_by_slot`
""" |
if language_code is None:
# Could also use get_language() or appsettings.FLUENT_CONTENTS_DEFAULT_LANGUAGE_CODE
# thus avoid the risk of performing an extra query here to the parent.
# However, this identical behavior to BaseContentItemFormSet,
# and the parent can be set already via Placeholder.objects.create_for_object()
language_code = get_parent_language_code(placeholder.parent)
obj = self.create(
placeholder=placeholder,
parent_type_id=placeholder.parent_type_id,
parent_id=placeholder.parent_id,
sort_order=sort_order,
language_code=language_code,
**kwargs
)
# Fill the reverse caches
obj.placeholder = placeholder
parent = getattr(placeholder, '_parent_cache', None) # by GenericForeignKey (_meta.virtual_fields[0].cache_attr)
if parent is not None:
obj.parent = parent
return obj |
<SYSTEM_TASK:>
Return the data of the placeholder fields.
<END_TASK>
<USER_TASK:>
Description:
def get_placeholder_data(self, request, obj=None):
"""
Return the data of the placeholder fields.
""" |
# Return all placeholder fields in the model.
if not hasattr(self.model, '_meta_placeholder_fields'):
return []
data = []
for name, field in self.model._meta_placeholder_fields.items():
assert isinstance(field, PlaceholderField)
data.append(PlaceholderData(
slot=field.slot,
title=field.verbose_name.capitalize(),
fallback_language=None, # Information cant' be known by "render_placeholder" in the template.
))
return data |
<SYSTEM_TASK:>
Return which plugins are allowed by the placeholder fields.
<END_TASK>
<USER_TASK:>
Description:
def get_all_allowed_plugins(self):
"""
Return which plugins are allowed by the placeholder fields.
""" |
# Get all allowed plugins of the various placeholders together.
if not hasattr(self.model, '_meta_placeholder_fields'):
# No placeholder fields in the model, no need for inlines.
return []
plugins = []
for name, field in self.model._meta_placeholder_fields.items():
assert isinstance(field, PlaceholderField)
if field.plugins is None:
# no limitations, so all is allowed
return extensions.plugin_pool.get_plugins()
else:
plugins += field.plugins
return list(set(plugins)) |
<SYSTEM_TASK:>
Create a new MarkupItem model that saves itself in a single language.
<END_TASK>
<USER_TASK:>
Description:
def _create_markup_model(fixed_language):
"""
Create a new MarkupItem model that saves itself in a single language.
""" |
title = backend.LANGUAGE_NAMES.get(fixed_language) or fixed_language
objects = MarkupLanguageManager(fixed_language)
def save(self, *args, **kwargs):
self.language = fixed_language
MarkupItem.save(self, *args, **kwargs)
class Meta:
verbose_name = title
verbose_name_plural = _('%s items') % title
proxy = True
classname = "{0}MarkupItem".format(fixed_language.capitalize())
new_class = type(str(classname), (MarkupItem,), {
'__module__': MarkupItem.__module__,
'objects': objects,
'save': save,
'Meta': Meta,
})
# Make easily browsable
return new_class |
<SYSTEM_TASK:>
Internal Django method to associate the field with the Model; it assigns the descriptor.
<END_TASK>
<USER_TASK:>
Description:
def contribute_to_class(self, cls, name, **kwargs):
"""
Internal Django method to associate the field with the Model; it assigns the descriptor.
""" |
super(PlaceholderField, self).contribute_to_class(cls, name, **kwargs)
# overwrites what instance.<colname> returns; give direct access to the placeholder
setattr(cls, name, PlaceholderFieldDescriptor(self.slot))
# Make placeholder fields easy to find
# Can't assign this to cls._meta because that gets overwritten by every level of model inheritance.
if not hasattr(cls, '_meta_placeholder_fields'):
cls._meta_placeholder_fields = {}
cls._meta_placeholder_fields[name] = self
# Configure the revere relation if possible.
# TODO: make sure reverse queries work properly
if django.VERSION >= (1, 11):
rel = self.remote_field
else:
rel = self.rel
if rel.related_name is None:
# Make unique for model (multiple models can use same slotnane)
rel.related_name = '{app}_{model}_{slot}_FIXME'.format(
app=cls._meta.app_label,
model=cls._meta.object_name.lower(),
slot=self.slot
)
# Remove attribute must exist for the delete page. Currently it's not actively used.
# The regular ForeignKey assigns a ForeignRelatedObjectsDescriptor to it for example.
# In this case, the PlaceholderRelation is already the reverse relation.
# Being able to move forward from the Placeholder to the derived models does not have that much value.
setattr(rel.to, self.rel.related_name, None) |
<SYSTEM_TASK:>
Get the set of plugins that this field may display.
<END_TASK>
<USER_TASK:>
Description:
def plugins(self):
"""
Get the set of plugins that this field may display.
""" |
from fluent_contents import extensions
if self._plugins is None:
return extensions.plugin_pool.get_plugins()
else:
try:
return extensions.plugin_pool.get_plugins_by_name(*self._plugins)
except extensions.PluginNotFound as e:
raise extensions.PluginNotFound(str(e) + " Update the plugin list of '{0}.{1}' field or FLUENT_CONTENTS_PLACEHOLDER_CONFIG['{2}'] setting.".format(self.model._meta.object_name, self.name, self.slot)) |
<SYSTEM_TASK:>
Internal Django method, used to return the placeholder ID when exporting the model instance.
<END_TASK>
<USER_TASK:>
Description:
def value_from_object(self, obj):
"""
Internal Django method, used to return the placeholder ID when exporting the model instance.
""" |
try:
# not using self.attname, access the descriptor instead.
placeholder = getattr(obj, self.name)
except Placeholder.DoesNotExist:
return None # Still allow ModelForm / admin to open and create a new Placeholder if the table was truncated.
return placeholder.id if placeholder else None |
<SYSTEM_TASK:>
Read the cached output - only when search needs it.
<END_TASK>
<USER_TASK:>
Description:
def can_use_cached_output(self, contentitem):
"""
Read the cached output - only when search needs it.
""" |
return contentitem.plugin.search_output and not contentitem.plugin.search_fields \
and super(SearchRenderingPipe, self).can_use_cached_output(contentitem) |
<SYSTEM_TASK:>
Render the item - but render as search text instead.
<END_TASK>
<USER_TASK:>
Description:
def render_item(self, contentitem):
"""
Render the item - but render as search text instead.
""" |
plugin = contentitem.plugin
if not plugin.search_output and not plugin.search_fields:
# Only render items when the item was output will be indexed.
raise SkipItem
if not plugin.search_output:
output = ContentItemOutput('', cacheable=False)
else:
output = super(SearchRenderingPipe, self).render_item(contentitem)
if plugin.search_fields:
# Just add the results into the output, but avoid caching that somewhere.
output.html += plugin.get_search_text(contentitem)
output.cacheable = False
return output |
<SYSTEM_TASK:>
Dynamically generate genuine django inlines for all registered content item types.
<END_TASK>
<USER_TASK:>
Description:
def get_content_item_inlines(plugins=None, base=BaseContentItemInline):
"""
Dynamically generate genuine django inlines for all registered content item types.
When the `plugins` parameter is ``None``, all plugin inlines are returned.
""" |
COPY_FIELDS = (
'form', 'raw_id_fields', 'filter_vertical', 'filter_horizontal',
'radio_fields', 'prepopulated_fields', 'formfield_overrides', 'readonly_fields',
)
if plugins is None:
plugins = extensions.plugin_pool.get_plugins()
inlines = []
for plugin in plugins: # self.model._supported_...()
# Avoid errors that are hard to trace
if not isinstance(plugin, extensions.ContentPlugin):
raise TypeError("get_content_item_inlines() expects to receive ContentPlugin instances, not {0}".format(plugin))
ContentItemType = plugin.model
# Create a new Type that inherits CmsPageItemInline
# Read the static fields of the ItemType to override default appearance.
# This code is based on FeinCMS, (c) Simon Meers, BSD licensed
class_name = '%s_AutoInline' % ContentItemType.__name__
attrs = {
'__module__': plugin.__class__.__module__,
'model': ContentItemType,
# Add metadata properties for template
'name': plugin.verbose_name,
'plugin': plugin,
'type_name': plugin.type_name,
'extra_fieldsets': plugin.fieldsets,
'cp_admin_form_template': plugin.admin_form_template,
'cp_admin_init_template': plugin.admin_init_template,
}
# Copy a restricted set of admin fields to the inline model too.
for name in COPY_FIELDS:
if getattr(plugin, name):
attrs[name] = getattr(plugin, name)
inlines.append(type(class_name, (base,), attrs))
# For consistency, enforce ordering
inlines.sort(key=lambda inline: inline.name.lower())
return inlines |
<SYSTEM_TASK:>
Get the list of OEmbed providers.
<END_TASK>
<USER_TASK:>
Description:
def get_oembed_providers():
"""
Get the list of OEmbed providers.
""" |
global _provider_list, _provider_lock
if _provider_list is not None:
return _provider_list
# Allow only one thread to build the list, or make request to embed.ly.
_provider_lock.acquire()
try:
# And check whether that already succeeded when the lock is granted.
if _provider_list is None:
_provider_list = _build_provider_list()
finally:
# Always release if there are errors
_provider_lock.release()
return _provider_list |
<SYSTEM_TASK:>
Construct the provider registry, using the app settings.
<END_TASK>
<USER_TASK:>
Description:
def _build_provider_list():
"""
Construct the provider registry, using the app settings.
""" |
registry = None
if appsettings.FLUENT_OEMBED_SOURCE == 'basic':
registry = bootstrap_basic()
elif appsettings.FLUENT_OEMBED_SOURCE == 'embedly':
params = {}
if appsettings.MICAWBER_EMBEDLY_KEY:
params['key'] = appsettings.MICAWBER_EMBEDLY_KEY
registry = bootstrap_embedly(**params)
elif appsettings.FLUENT_OEMBED_SOURCE == 'noembed':
registry = bootstrap_noembed(nowrap=1)
elif appsettings.FLUENT_OEMBED_SOURCE == 'list':
# Fill list manually in the settings, e.g. to have a fixed set of supported secure providers.
registry = ProviderRegistry()
for regex, provider in appsettings.FLUENT_OEMBED_PROVIDER_LIST:
registry.register(regex, Provider(provider))
else:
raise ImproperlyConfigured("Invalid value of FLUENT_OEMBED_SOURCE, only 'basic', 'list', 'noembed' or 'embedly' is supported.")
# Add any extra providers defined in the settings
for regex, provider in appsettings.FLUENT_OEMBED_EXTRA_PROVIDERS:
registry.register(regex, Provider(provider))
return registry |
<SYSTEM_TASK:>
Fetch the OEmbed object, return the response as dictionary.
<END_TASK>
<USER_TASK:>
Description:
def get_oembed_data(url, max_width=None, max_height=None, **params):
"""
Fetch the OEmbed object, return the response as dictionary.
""" |
if max_width: params['maxwidth'] = max_width
if max_height: params['maxheight'] = max_height
registry = get_oembed_providers()
return registry.request(url, **params) |
<SYSTEM_TASK:>
Returns a Request instance populated with cms specific attributes.
<END_TASK>
<USER_TASK:>
Description:
def get_dummy_request(language=None):
"""
Returns a Request instance populated with cms specific attributes.
""" |
if settings.ALLOWED_HOSTS and settings.ALLOWED_HOSTS != "*":
host = settings.ALLOWED_HOSTS[0]
else:
host = Site.objects.get_current().domain
request = RequestFactory().get("/", HTTP_HOST=host)
request.session = {}
request.LANGUAGE_CODE = language or settings.LANGUAGE_CODE
# Needed for plugin rendering.
request.current_page = None
if 'django.contrib.auth' in settings.INSTALLED_APPS:
from django.contrib.auth.models import AnonymousUser
request.user = AnonymousUser()
return request |
<SYSTEM_TASK:>
Tell which language should be used to render the content item.
<END_TASK>
<USER_TASK:>
Description:
def get_render_language(contentitem):
"""
Tell which language should be used to render the content item.
""" |
plugin = contentitem.plugin
if plugin.render_ignore_item_language \
or (plugin.cache_output and plugin.cache_output_per_language):
# Render the template in the current language.
# The cache also stores the output under the current language code.
#
# It would make sense to apply this for fallback content too,
# but that would be ambiguous however because the parent_object could also be a fallback,
# and that case can't be detected here. Hence, better be explicit when desiring multi-lingual content.
return get_language() # Avoid switching the content,
else:
# Render the template in the ContentItem language.
# This makes sure that {% trans %} tag output matches the language of the model field data.
return contentitem.language_code |
<SYSTEM_TASK:>
Extract the search fields from the model.
<END_TASK>
<USER_TASK:>
Description:
def get_search_field_values(contentitem):
"""
Extract the search fields from the model.
""" |
plugin = contentitem.plugin
values = []
for field_name in plugin.search_fields:
value = getattr(contentitem, field_name)
# Just assume all strings may contain HTML.
# Not checking for just the PluginHtmlField here.
if value and isinstance(value, six.string_types):
value = get_cleaned_string(value)
values.append(value)
return values |
<SYSTEM_TASK:>
Return the metadata about a layout
<END_TASK>
<USER_TASK:>
Description:
def get_layout_view(self, request):
"""
Return the metadata about a layout
""" |
template_name = request.GET['name']
# Check if template is allowed, avoid parsing random templates
templates = dict(appconfig.SIMPLECMS_TEMPLATE_CHOICES)
if template_name not in templates:
jsondata = {'success': False, 'error': 'Template not found'}
status = 404
else:
# Extract placeholders from the template, and pass to the client.
template = get_template(template_name)
placeholders = get_template_placeholder_data(template)
jsondata = {
'placeholders': [p.as_dict() for p in placeholders],
}
status = 200
jsonstr = json.dumps(jsondata)
return HttpResponse(jsonstr, content_type='application/json', status=status) |
<SYSTEM_TASK:>
Apply soft hyphenation to the text, which inserts ``­`` markers.
<END_TASK>
<USER_TASK:>
Description:
def softhyphen_filter(textitem, html):
"""
Apply soft hyphenation to the text, which inserts ``­`` markers.
""" |
language = textitem.language_code
# Make sure the Django language code gets converted to what django-softhypen 1.0.2 needs.
if language == 'en':
language = 'en-us'
elif '-' not in language:
language = "{0}-{0}".format(language)
return hyphenate(html, language=language) |
<SYSTEM_TASK:>
Return cached output for a placeholder, if available.
<END_TASK>
<USER_TASK:>
Description:
def get_cached_placeholder_output(parent_object, placeholder_name):
"""
Return cached output for a placeholder, if available.
This avoids fetching the Placeholder object.
""" |
if not PlaceholderRenderingPipe.may_cache_placeholders():
return None
language_code = get_parent_language_code(parent_object)
cache_key = get_placeholder_cache_key_for_parent(parent_object, placeholder_name, language_code)
return cache.get(cache_key) |
<SYSTEM_TASK:>
Render the placeholder field.
<END_TASK>
<USER_TASK:>
Description:
def render(self, name, value, attrs=None, renderer=None):
"""
Render the placeholder field.
""" |
other_instance_languages = None
if value and value != "-DUMMY-":
if get_parent_language_code(self.parent_object):
# Parent is a multilingual object, provide information
# for the copy dialog.
other_instance_languages = get_parent_active_language_choices(
self.parent_object, exclude_current=True)
context = {
'cp_plugin_list': list(self.plugins),
'placeholder_id': '',
'placeholder_slot': self.slot,
'other_instance_languages': other_instance_languages,
}
return mark_safe(render_to_string('admin/fluent_contents/placeholderfield/widget.html', context)) |
<SYSTEM_TASK:>
Get the set of plugins that this widget should display.
<END_TASK>
<USER_TASK:>
Description:
def plugins(self):
"""
Get the set of plugins that this widget should display.
""" |
from fluent_contents import extensions # Avoid circular reference because __init__.py imports subfolders too
if self._plugins is None:
return extensions.plugin_pool.get_plugins()
else:
return extensions.plugin_pool.get_plugins_by_name(*self._plugins) |
<SYSTEM_TASK:>
Render the text, reuses the template filters provided by Django.
<END_TASK>
<USER_TASK:>
Description:
def render_text(text, language=None):
"""
Render the text, reuses the template filters provided by Django.
""" |
# Get the filter
text_filter = SUPPORTED_LANGUAGES.get(language, None)
if not text_filter:
raise ImproperlyConfigured("markup filter does not exist: {0}. Valid options are: {1}".format(
language, ', '.join(list(SUPPORTED_LANGUAGES.keys()))
))
# Convert.
return text_filter(text) |
<SYSTEM_TASK:>
The main rendering sequence.
<END_TASK>
<USER_TASK:>
Description:
def render_items(self, placeholder, items, parent_object=None, template_name=None, cachable=None):
"""
The main rendering sequence.
""" |
# Unless it was done before, disable polymorphic effects.
is_queryset = False
if hasattr(items, "non_polymorphic"):
is_queryset = True
if not items.polymorphic_disabled and items._result_cache is None:
items = items.non_polymorphic()
# See if the queryset contained anything.
# This test is moved here, to prevent earlier query execution.
if not items:
logger.debug("- no items in placeholder '%s'", get_placeholder_debug_name(placeholder))
return ContentItemOutput(mark_safe(u"<!-- no items in placeholder '{0}' -->".format(escape(get_placeholder_name(placeholder)))), cacheable=True)
# Tracked data during rendering:
result = self.result_class(
request=self.request,
parent_object=parent_object,
placeholder=placeholder,
items=items,
all_cacheable=self._can_cache_merged_output(template_name, cachable),
)
if self.edit_mode:
result.set_uncachable()
if is_queryset:
# Phase 1: get cached output
self._fetch_cached_output(items, result=result)
result.fetch_remaining_instances()
else:
# The items is either a list of manually created items, or it's a QuerySet.
# Can't prevent reading the subclasses only, so don't bother with caching here.
result.add_remaining_list(items)
# Start the actual rendering of remaining items.
if result.remaining_items:
# Phase 2: render remaining items
self._render_uncached_items(result.remaining_items, result=result)
# And merge all items together.
return self.merge_output(result, items, template_name) |
<SYSTEM_TASK:>
First try to fetch all items from the cache.
<END_TASK>
<USER_TASK:>
Description:
def _fetch_cached_output(self, items, result):
"""
First try to fetch all items from the cache.
The items are 'non-polymorphic', so only point to their base class.
If these are found, there is no need to query the derived data from the database.
""" |
if not appsettings.FLUENT_CONTENTS_CACHE_OUTPUT or not self.use_cached_output:
result.add_remaining_list(items)
return
for contentitem in items:
result.add_ordering(contentitem)
output = None
try:
plugin = contentitem.plugin
except PluginNotFound as ex:
result.store_exception(contentitem, ex) # Will deal with that later.
logger.debug("- item #%s has no matching plugin: %s", contentitem.pk, str(ex))
continue
# Respect the cache output setting of the plugin
if self.can_use_cached_output(contentitem):
result.add_plugin_timeout(plugin)
output = plugin.get_cached_output(result.placeholder_name, contentitem)
# Support transition to new output format.
if output is not None and not isinstance(output, ContentItemOutput):
output = None
logger.debug("Flushed cached output of {0}#{1} to store new ContentItemOutput format (key: {2})".format(
plugin.type_name,
contentitem.pk,
get_placeholder_name(contentitem.placeholder)
))
# For debugging, ignore cached values when the template is updated.
if output and settings.DEBUG:
cachekey = get_rendering_cache_key(result.placeholder_name, contentitem)
if is_template_updated(self.request, contentitem, cachekey):
output = None
if output:
result.store_output(contentitem, output)
else:
result.add_remaining(contentitem) |
<SYSTEM_TASK:>
Tell whether the code should try reading cached output
<END_TASK>
<USER_TASK:>
Description:
def can_use_cached_output(self, contentitem):
"""
Tell whether the code should try reading cached output
""" |
plugin = contentitem.plugin
return appsettings.FLUENT_CONTENTS_CACHE_OUTPUT and plugin.cache_output and contentitem.pk |
<SYSTEM_TASK:>
Render a list of items, that didn't exist in the cache yet.
<END_TASK>
<USER_TASK:>
Description:
def _render_uncached_items(self, items, result):
"""
Render a list of items, that didn't exist in the cache yet.
""" |
for contentitem in items:
# Render the item.
# Allow derived classes to skip it.
try:
output = self.render_item(contentitem)
except PluginNotFound as ex:
result.store_exception(contentitem, ex)
logger.debug("- item #%s has no matching plugin: %s", contentitem.pk, str(ex))
continue
except SkipItem:
result.set_skipped(contentitem)
continue
# Try caching it.
self._try_cache_output(contentitem, output, result=result)
if self.edit_mode:
output.html = markers.wrap_contentitem_output(output.html, contentitem)
result.store_output(contentitem, output) |
<SYSTEM_TASK:>
Collect all HTML from the rendered items, in the correct ordering.
<END_TASK>
<USER_TASK:>
Description:
def get_html_output(self, result, items):
"""
Collect all HTML from the rendered items, in the correct ordering.
The media is also collected in the same ordering, in case it's handled by django-compressor for example.
""" |
html_output = []
merged_media = Media()
for contentitem, output in result.get_output(include_exceptions=True):
if output is ResultTracker.MISSING:
# Likely get_real_instances() didn't return an item for it.
# The get_real_instances() didn't return an item for the derived table. This happens when either:
# 1. that table is truncated/reset, while there is still an entry in the base ContentItem table.
# A query at the derived table happens every time the page is being rendered.
# 2. the model was completely removed which means there is also a stale ContentType object.
class_name = _get_stale_item_class_name(contentitem)
html_output.append(mark_safe(u"<!-- Missing derived model for ContentItem #{id}: {cls}. -->\n".format(id=contentitem.pk, cls=class_name)))
logger.warning("Missing derived model for ContentItem #{id}: {cls}.".format(id=contentitem.pk, cls=class_name))
elif isinstance(output, Exception):
html_output.append(u'<!-- error: {0} -->\n'.format(str(output)))
else:
html_output.append(output.html)
add_media(merged_media, output.media)
return html_output, merged_media |
<SYSTEM_TASK:>
Make a plugin known to the CMS.
<END_TASK>
<USER_TASK:>
Description:
def register(self, plugin):
"""
Make a plugin known to the CMS.
:param plugin: The plugin class, deriving from :class:`ContentPlugin`.
:type plugin: :class:`ContentPlugin`
The plugin will be instantiated once, just like Django does this with :class:`~django.contrib.admin.ModelAdmin` classes.
If a plugin is already registered, this will raise a :class:`PluginAlreadyRegistered` exception.
""" |
# Duck-Typing does not suffice here, avoid hard to debug problems by upfront checks.
assert issubclass(plugin, ContentPlugin), "The plugin must inherit from `ContentPlugin`"
assert plugin.model, "The plugin has no model defined"
assert issubclass(plugin.model, ContentItem), "The plugin model must inherit from `ContentItem`"
assert issubclass(plugin.form, ContentItemForm), "The plugin form must inherit from `ContentItemForm`"
name = plugin.__name__ # using class here, no instance created yet.
name = name.lower()
if name in self.plugins:
raise PluginAlreadyRegistered("{0}: a plugin with this name is already registered".format(name))
# Avoid registering 2 plugins to the exact same model. If you want to reuse code, use proxy models.
if plugin.model in self._name_for_model:
# Having 2 plugins for one model breaks ContentItem.plugin and the frontend code
# that depends on using inline-model names instead of plugins. Good luck fixing that.
# Better leave the model==plugin dependency for now.
existing_plugin = self.plugins[self._name_for_model[plugin.model]]
raise ModelAlreadyRegistered("Can't register the model {0} to {2}, it's already registered to {1}!".format(
plugin.model.__name__,
existing_plugin.name,
plugin.__name__
))
# Make a single static instance, similar to ModelAdmin.
plugin_instance = plugin()
self.plugins[name] = plugin_instance
self._name_for_model[plugin.model] = name # Track reverse for model.plugin link
# Only update lazy indexes if already created
if self._name_for_ctype_id is not None:
self._name_for_ctype_id[plugin.type_id] = name
return plugin |
<SYSTEM_TASK:>
Return the plugins which are supported in the given placeholder name.
<END_TASK>
<USER_TASK:>
Description:
def get_allowed_plugins(self, placeholder_slot):
"""
Return the plugins which are supported in the given placeholder name.
""" |
# See if there is a limit imposed.
slot_config = appsettings.FLUENT_CONTENTS_PLACEHOLDER_CONFIG.get(placeholder_slot) or {}
plugins = slot_config.get('plugins')
if not plugins:
return self.get_plugins()
else:
try:
return self.get_plugins_by_name(*plugins)
except PluginNotFound as e:
raise PluginNotFound(str(e) + " Update the plugin list of the FLUENT_CONTENTS_PLACEHOLDER_CONFIG['{0}'] setting.".format(placeholder_slot)) |
<SYSTEM_TASK:>
Return a list of plugins by plugin class, or name.
<END_TASK>
<USER_TASK:>
Description:
def get_plugins_by_name(self, *names):
"""
Return a list of plugins by plugin class, or name.
""" |
self._import_plugins()
plugin_instances = []
for name in names:
if isinstance(name, six.string_types):
try:
plugin_instances.append(self.plugins[name.lower()])
except KeyError:
raise PluginNotFound("No plugin named '{0}'.".format(name))
elif isinstance(name, type) and issubclass(name, ContentPlugin):
# Will also allow classes instead of strings.
plugin_instances.append(self.plugins[self._name_for_model[name.model]])
else:
raise TypeError("get_plugins_by_name() expects a plugin name or class, not: {0}".format(name))
return plugin_instances |
<SYSTEM_TASK:>
Return the corresponding plugin for a given model.
<END_TASK>
<USER_TASK:>
Description:
def get_plugin_by_model(self, model_class):
"""
Return the corresponding plugin for a given model.
You can also use the :attr:`ContentItem.plugin <fluent_contents.models.ContentItem.plugin>` property directly.
This is the low-level function that supports that feature.
""" |
self._import_plugins() # could happen during rendering that no plugin scan happened yet.
assert issubclass(model_class, ContentItem) # avoid confusion between model instance and class here!
try:
name = self._name_for_model[model_class]
except KeyError:
raise PluginNotFound("No plugin found for model '{0}'.".format(model_class.__name__))
return self.plugins[name] |
<SYSTEM_TASK:>
Internal function, ensure all plugin packages are imported.
<END_TASK>
<USER_TASK:>
Description:
def _import_plugins(self):
"""
Internal function, ensure all plugin packages are imported.
""" |
if self.detected:
return
# In some cases, plugin scanning may start during a request.
# Make sure there is only one thread scanning for plugins.
self.scanLock.acquire()
if self.detected:
return # previous threaded released + completed
try:
import_apps_submodule("content_plugins")
self.detected = True
finally:
self.scanLock.release() |
<SYSTEM_TASK:>
Run all filters for a given HTML snippet.
<END_TASK>
<USER_TASK:>
Description:
def apply_filters(instance, html, field_name):
"""
Run all filters for a given HTML snippet.
Returns the results of the pre-filter and post-filter as tuple.
This function can be called from the :meth:`~django.db.models.Model.full_clean` method in the model.
That function is called when the form values are assigned.
For example:
.. code-block:: python
def full_clean(self, *args, **kwargs):
super(TextItem, self).full_clean(*args, **kwargs)
self.html, self.html_final = apply_filters(self, self.html, field_name='html')
:type instance: fluent_contents.models.ContentItem
:raise ValidationError: when one of the filters detects a problem.
""" |
try:
html = apply_pre_filters(instance, html)
# Perform post processing. This does not effect the original 'html'
html_final = apply_post_filters(instance, html)
except ValidationError as e:
if hasattr(e, 'error_list'):
# The filters can raise a "dump" ValidationError with a single error.
# However, during post_clean it's expected that the fields are named.
raise ValidationError({
field_name: e.error_list
})
raise
return html, html_final |
<SYSTEM_TASK:>
Perform optimizations in the HTML source code.
<END_TASK>
<USER_TASK:>
Description:
def apply_pre_filters(instance, html):
"""
Perform optimizations in the HTML source code.
:type instance: fluent_contents.models.ContentItem
:raise ValidationError: when one of the filters detects a problem.
""" |
# Allow pre processing. Typical use-case is HTML syntax correction.
for post_func in appsettings.PRE_FILTER_FUNCTIONS:
html = post_func(instance, html)
return html |
<SYSTEM_TASK:>
Allow post processing functions to change the text.
<END_TASK>
<USER_TASK:>
Description:
def apply_post_filters(instance, html):
"""
Allow post processing functions to change the text.
This change is not saved in the original text.
:type instance: fluent_contents.models.ContentItem
:raise ValidationError: when one of the filters detects a problem.
""" |
for post_func in appsettings.POST_FILTER_FUNCTIONS:
html = post_func(instance, html)
return html |
<SYSTEM_TASK:>
Clean the plugin output cache of a rendered plugin.
<END_TASK>
<USER_TASK:>
Description:
def clear_commentarea_cache(comment):
"""
Clean the plugin output cache of a rendered plugin.
""" |
parent = comment.content_object
for instance in CommentsAreaItem.objects.parent(parent):
instance.clear_cache() |
<SYSTEM_TASK:>
Inspect a single model
<END_TASK>
<USER_TASK:>
Description:
def inspect_model(self, model):
"""
Inspect a single model
""" |
# See which interesting fields the model holds.
url_fields = sorted(f for f in model._meta.fields if isinstance(f, (PluginUrlField, models.URLField)))
file_fields = sorted(f for f in model._meta.fields if isinstance(f, (PluginImageField, models.FileField)))
html_fields = sorted(f for f in model._meta.fields if isinstance(f, (models.TextField, PluginHtmlField)))
all_fields = [f.name for f in (file_fields + html_fields + url_fields)]
if not all_fields:
return []
if model.__name__ in self.exclude:
self.stderr.write("Skipping {0} ({1})\n".format(model.__name__, ", ".join(all_fields)))
return []
sys.stderr.write("Inspecting {0} ({1})\n".format(model.__name__, ", ".join(all_fields)))
q_notnull = reduce(operator.or_, (Q(**{"{0}__isnull".format(f): False}) for f in all_fields))
qs = model.objects.filter(q_notnull).order_by('pk')
urls = []
for object in qs:
# HTML fields need proper html5lib parsing
for field in html_fields:
value = getattr(object, field.name)
if value:
html_images = self.extract_html_urls(value)
urls += html_images
for image in html_images:
self.show_match(object, image)
# Picture fields take the URL from the storage class.
for field in file_fields:
value = getattr(object, field.name)
if value:
value = unquote_utf8(value.url)
urls.append(value)
self.show_match(object, value)
# URL fields can be read directly.
for field in url_fields:
value = getattr(object, field.name)
if value:
if isinstance(value, six.text_type):
value = force_text(value)
else:
value = value.to_db_value() # AnyUrlValue
urls.append(value)
self.show_match(object, value)
return urls |
<SYSTEM_TASK:>
Make sure ContentItems are deleted when a translation in deleted.
<END_TASK>
<USER_TASK:>
Description:
def on_delete_model_translation(instance, **kwargs):
"""
Make sure ContentItems are deleted when a translation in deleted.
""" |
translation = instance
parent_object = translation.master
parent_object.set_current_language(translation.language_code)
# Also delete any associated plugins
# Placeholders are shared between languages, so these are not affected.
for item in ContentItem.objects.parent(parent_object, limit_parent_language=True):
item.delete() |
<SYSTEM_TASK:>
Make sure that the MarkupItem model actually points
<END_TASK>
<USER_TASK:>
Description:
def _forwards(apps, schema_editor):
"""
Make sure that the MarkupItem model actually points
to the correct proxy model, that implements the given language.
""" |
# Need to work on the actual models here.
from fluent_contents.plugins.markup.models import LANGUAGE_MODEL_CLASSES
from fluent_contents.plugins.markup.models import MarkupItem
from django.contrib.contenttypes.models import ContentType
ctype = ContentType.objects.get_for_model(MarkupItem)
for language, proxy_model in LANGUAGE_MODEL_CLASSES.items():
proxy_ctype = ContentType.objects.get_for_model(proxy_model, for_concrete_model=False)
MarkupItem.objects.filter(
polymorphic_ctype=ctype, language=language
).update(
polymorphic_ctype=proxy_ctype
) |
<SYSTEM_TASK:>
Pre-populate formset with the initial placeholders to display.
<END_TASK>
<USER_TASK:>
Description:
def get_formset(self, request, obj=None, **kwargs):
"""
Pre-populate formset with the initial placeholders to display.
""" |
def _placeholder_initial(p):
# p.as_dict() returns allowed_plugins too for the client-side API.
return {
'slot': p.slot,
'title': p.title,
'role': p.role,
}
# Note this method is called twice, the second time in get_fieldsets() as `get_formset(request).form`
initial = []
if request.method == "GET":
placeholder_admin = self._get_parent_modeladmin()
# Grab the initial data from the parent PlaceholderEditorBaseMixin
data = placeholder_admin.get_placeholder_data(request, obj)
initial = [_placeholder_initial(d) for d in data]
# Order initial properly,
# Inject as default parameter to the constructor
# This is the BaseExtendedGenericInlineFormSet constructor
FormSetClass = super(PlaceholderEditorInline, self).get_formset(request, obj, **kwargs)
FormSetClass.__init__ = curry(FormSetClass.__init__, initial=initial)
return FormSetClass |
<SYSTEM_TASK:>
Create the inlines for the admin, including the placeholder and contentitem inlines.
<END_TASK>
<USER_TASK:>
Description:
def get_inline_instances(self, request, *args, **kwargs):
"""
Create the inlines for the admin, including the placeholder and contentitem inlines.
""" |
inlines = super(PlaceholderEditorAdmin, self).get_inline_instances(request, *args, **kwargs)
extra_inline_instances = []
inlinetypes = self.get_extra_inlines()
for InlineType in inlinetypes:
inline_instance = InlineType(self.model, self.admin_site)
extra_inline_instances.append(inline_instance)
return extra_inline_instances + inlines |
<SYSTEM_TASK:>
Return the placeholder data as dictionary.
<END_TASK>
<USER_TASK:>
Description:
def get_placeholder_data_view(self, request, object_id):
"""
Return the placeholder data as dictionary.
This is used in the client for the "copy" functionality.
""" |
language = 'en' #request.POST['language']
with translation.override(language): # Use generic solution here, don't assume django-parler is used now.
obj = self.get_object(request, object_id)
if obj is None:
json = {'success': False, 'error': 'Page not found'}
status = 404
elif not self.has_change_permission(request, obj):
json = {'success': False, 'error': 'No access to page'}
status = 403
else:
# Fetch the forms that would be displayed,
# return the data as serialized form data.
status = 200
json = {
'success': True,
'object_id': object_id,
'language_code': language,
'formset_forms': self._get_object_formset_data(request, obj),
}
return JsonResponse(json, status=status) |
<SYSTEM_TASK:>
A decorator to use coroutine-like spider callbacks.
<END_TASK>
<USER_TASK:>
Description:
def inline_requests(method_or_func):
"""A decorator to use coroutine-like spider callbacks.
Example:
.. code:: python
class MySpider(Spider):
@inline_callbacks
def parse(self, response):
next_url = response.urjoin('?next')
try:
next_resp = yield Request(next_url)
except Exception as e:
self.logger.exception("An error occurred.")
return
else:
yield {"next_url": next_resp.url}
You must conform with the following conventions:
* The decorated method must be a spider method.
* The decorated method must use the ``yield`` keyword or return a generator.
* The decorated method must accept ``response`` as the first argument.
* The decorated method should yield ``Request`` objects without neither
``callback`` nor ``errback`` set.
If your requests don't come back to the generator try setting the flag to
handle all http statuses:
.. code:: python
request.meta['handle_httpstatus_all'] = True
""" |
args = get_args(method_or_func)
if not args:
raise TypeError("Function must accept at least one argument.")
# XXX: hardcoded convention of 'self' as first argument for methods
if args[0] == 'self':
def wrapper(self, response, **kwargs):
callback = create_bound_method(method_or_func, self)
genwrapper = RequestGenerator(callback, **kwargs)
return genwrapper(response)
else:
warnings.warn("Decorating a non-method function will be deprecated",
ScrapyDeprecationWarning, stacklevel=1)
def wrapper(response, **kwargs):
genwrapper = RequestGenerator(method_or_func, **kwargs)
return genwrapper(response)
return wraps(method_or_func)(wrapper) |
<SYSTEM_TASK:>
Returns method or function arguments.
<END_TASK>
<USER_TASK:>
Description:
def get_args(method_or_func):
"""Returns method or function arguments.""" |
try:
# Python 3.0+
args = list(inspect.signature(method_or_func).parameters.keys())
except AttributeError:
# Python 2.7
args = inspect.getargspec(method_or_func).args
return args |
<SYSTEM_TASK:>
If you decorate a view with this, it will ensure that the requester has a
<END_TASK>
<USER_TASK:>
Description:
def jwt_required(fn):
"""
If you decorate a view with this, it will ensure that the requester has a
valid JWT before calling the actual view.
:param fn: The view function to decorate
""" |
@wraps(fn)
def wrapper(*args, **kwargs):
jwt_data = _decode_jwt_from_headers()
ctx_stack.top.jwt = jwt_data
return fn(*args, **kwargs)
return wrapper |
<SYSTEM_TASK:>
If you decorate a view with this, it will check the request for a valid
<END_TASK>
<USER_TASK:>
Description:
def jwt_optional(fn):
"""
If you decorate a view with this, it will check the request for a valid
JWT and put it into the Flask application context before calling the view.
If no authorization header is present, the view will be called without the
application context being changed. Other authentication errors are not
affected. For example, if an expired JWT is passed in, it will still not
be able to access an endpoint protected by this decorator.
:param fn: The view function to decorate
""" |
@wraps(fn)
def wrapper(*args, **kwargs):
try:
jwt_data = _decode_jwt_from_headers()
ctx_stack.top.jwt = jwt_data
except (NoAuthorizationError, InvalidHeaderError):
pass
return fn(*args, **kwargs)
return wrapper |
<SYSTEM_TASK:>
Returns the decoded token from an encoded one. This does all the checks
<END_TASK>
<USER_TASK:>
Description:
def decode_jwt(encoded_token):
"""
Returns the decoded token from an encoded one. This does all the checks
to insure that the decoded token is valid before returning it.
""" |
secret = config.decode_key
algorithm = config.algorithm
audience = config.audience
return jwt.decode(encoded_token, secret, algorithms=[algorithm], audience=audience) |
<SYSTEM_TASK:>
Register this extension with the flask app
<END_TASK>
<USER_TASK:>
Description:
def init_app(self, app):
"""
Register this extension with the flask app
:param app: A flask application
""" |
# Save this so we can use it later in the extension
if not hasattr(app, 'extensions'): # pragma: no cover
app.extensions = {}
app.extensions['flask-jwt-simple'] = self
# Set all the default configurations for this extension
self._set_default_configuration_options(app)
self._set_error_handler_callbacks(app)
# Set propagate exceptions, so all of our error handlers properly
# work in production
app.config['PROPAGATE_EXCEPTIONS'] = True |
<SYSTEM_TASK:>
Create the URL path with the Fred endpoint and given arguments.
<END_TASK>
<USER_TASK:>
Description:
def _create_path(self, *args):
"""Create the URL path with the Fred endpoint and given arguments.""" |
args = filter(None, args)
path = self.endpoint + '/'.join(args)
return path |
<SYSTEM_TASK:>
Perform a GET request againt the Fred API endpoint.
<END_TASK>
<USER_TASK:>
Description:
def get(self, *args, **kwargs):
"""Perform a GET request againt the Fred API endpoint.""" |
location = args[0]
params = self._get_keywords(location, kwargs)
url = self._create_path(*args)
request = requests.get(url, params=params)
content = request.content
self._request = request
return self._output(content) |
<SYSTEM_TASK:>
Returns an extra keyword arguments dictionary that is used with
<END_TASK>
<USER_TASK:>
Description:
def item_extra_kwargs(self, item):
"""
Returns an extra keyword arguments dictionary that is used with
the 'add_item' call of the feed generator.
Add the fields of the item, to be used by the custom feed generator.
""" |
if use_feed_image:
feed_image = item.feed_image
if feed_image:
image_complete_url = urljoin(
self.get_site_url(), feed_image.file.url
)
else:
image_complete_url = ""
content_field = getattr(item, self.item_content_field)
try:
content = expand_db_html(content_field)
except:
content = content_field.__html__()
soup = BeautifulSoup(content, 'html.parser')
# Remove style attribute to remove large botton padding
for div in soup.find_all("div", {'class': 'responsive-object'}):
del div['style']
# Add site url to image source
for img_tag in soup.findAll('img'):
if img_tag.has_attr('src'):
img_tag['src'] = urljoin(self.get_site_url(), img_tag['src'])
fields_to_add = {
'content': soup.prettify(formatter="html"),
}
if use_feed_image:
fields_to_add['image'] = image_complete_url
else:
fields_to_add['image'] = ""
return fields_to_add |
<SYSTEM_TASK:>
Sample view demonstrating that you can provide custom handlers for
<END_TASK>
<USER_TASK:>
Description:
def treenav_undefined_url(request, item_slug):
"""
Sample view demonstrating that you can provide custom handlers for
undefined menu items on a per-item basis.
""" |
item = get_object_or_404(treenav.MenuItem, slug=item_slug) # noqa
# do something with item here and return an HttpResponseRedirect
raise Http404 |
<SYSTEM_TASK:>
This signal attempts to update the HREF of any menu items that point to
<END_TASK>
<USER_TASK:>
Description:
def treenav_save_other_object_handler(sender, instance, created, **kwargs):
"""
This signal attempts to update the HREF of any menu items that point to
another model object, when that objects is saved.
""" |
# import here so models don't get loaded during app loading
from django.contrib.contenttypes.models import ContentType
from .models import MenuItem
cache_key = 'django-treenav-menumodels'
if sender == MenuItem:
cache.delete(cache_key)
menu_models = cache.get(cache_key)
if not menu_models:
menu_models = []
for menu_item in MenuItem.objects.exclude(content_type__isnull=True):
menu_models.append(menu_item.content_type.model_class())
cache.set(cache_key, menu_models)
# only attempt to update MenuItem if sender is known to be referenced
if sender in menu_models:
ct = ContentType.objects.get_for_model(sender)
items = MenuItem.objects.filter(content_type=ct, object_id=instance.pk)
for item in items:
if item.href != instance.get_absolute_url():
item.href = instance.get_absolute_url()
item.save() |
<SYSTEM_TASK:>
Refresh all the cached menu item HREFs in the database.
<END_TASK>
<USER_TASK:>
Description:
def refresh_hrefs(self, request):
"""
Refresh all the cached menu item HREFs in the database.
""" |
for item in treenav.MenuItem.objects.all():
item.save() # refreshes the HREF
self.message_user(request, _('Menu item HREFs refreshed successfully.'))
info = self.model._meta.app_label, self.model._meta.model_name
changelist_url = reverse('admin:%s_%s_changelist' % info, current_app=self.admin_site.name)
return redirect(changelist_url) |
<SYSTEM_TASK:>
Remove all MenuItems from Cache.
<END_TASK>
<USER_TASK:>
Description:
def clean_cache(self, request):
"""
Remove all MenuItems from Cache.
""" |
treenav.delete_cache()
self.message_user(request, _('Cache menuitem cache cleaned successfully.'))
info = self.model._meta.app_label, self.model._meta.model_name
changelist_url = reverse('admin:%s_%s_changelist' % info, current_app=self.admin_site.name)
return redirect(changelist_url) |
<SYSTEM_TASK:>
Rebuilds the tree after saving items related to parent.
<END_TASK>
<USER_TASK:>
Description:
def save_related(self, request, form, formsets, change):
"""
Rebuilds the tree after saving items related to parent.
""" |
super(MenuItemAdmin, self).save_related(request, form, formsets, change)
self.model.objects.rebuild() |
<SYSTEM_TASK:>
Calculate the dispersion between actual points and their assigned centroids
<END_TASK>
<USER_TASK:>
Description:
def _calculate_dispersion(X: Union[pd.DataFrame, np.ndarray], labels: np.ndarray, centroids: np.ndarray) -> float:
"""
Calculate the dispersion between actual points and their assigned centroids
""" |
disp = np.sum(np.sum([np.abs(inst - centroids[label]) ** 2 for inst, label in zip(X, labels)])) # type: float
return disp |
<SYSTEM_TASK:>
Calculate the gap value of the given data, n_refs, and number of clusters.
<END_TASK>
<USER_TASK:>
Description:
def _calculate_gap(self, X: Union[pd.DataFrame, np.ndarray], n_refs: int, n_clusters: int) -> Tuple[float, int]:
"""
Calculate the gap value of the given data, n_refs, and number of clusters.
Return the resutling gap value and n_clusters
""" |
# Holder for reference dispersion results
ref_dispersions = np.zeros(n_refs) # type: np.ndarray
# For n_references, generate random sample and perform kmeans getting resulting dispersion of each loop
for i in range(n_refs):
# Create new random reference set
random_data = np.random.random_sample(size=X.shape) # type: np.ndarray
# Fit to it, getting the centroids and labels, and add to accumulated reference dispersions array.
centroids, labels = kmeans2(data=random_data,
k=n_clusters,
iter=10,
minit='points') # type: Tuple[np.ndarray, np.ndarray]
dispersion = self._calculate_dispersion(X=random_data, labels=labels, centroids=centroids) # type: float
ref_dispersions[i] = dispersion
# Fit cluster to original data and create dispersion calc.
centroids, labels = kmeans2(data=X, k=n_clusters, iter=10, minit='points')
dispersion = self._calculate_dispersion(X=X, labels=labels, centroids=centroids)
# Calculate gap statistic
gap_value = np.mean(np.log(ref_dispersions)) - np.log(dispersion)
return gap_value, int(n_clusters) |
<SYSTEM_TASK:>
Get the last migration batch.
<END_TASK>
<USER_TASK:>
Description:
def get_last(self):
"""
Get the last migration batch.
:rtype: list
""" |
query = self.table().where('batch', self.get_last_batch_number())
return query.order_by('migration', 'desc').get() |
<SYSTEM_TASK:>
Compile an insert SQL statement
<END_TASK>
<USER_TASK:>
Description:
def compile_insert(self, query, values):
"""
Compile an insert SQL statement
:param query: A QueryBuilder instance
:type query: QueryBuilder
:param values: The values to insert
:type values: dict or list
:return: The compiled statement
:rtype: str
""" |
# Essentially we will force every insert to be treated as a batch insert which
# simply makes creating the SQL easier for us since we can utilize the same
# basic routine regardless of an amount of records given to us to insert.
table = self.wrap_table(query.from__)
if not isinstance(values, list):
values = [values]
columns = self.columnize(values[0].keys())
# We need to build a list of parameter place-holders of values that are bound
# to the query. Each insert should have the exact same amount of parameter
# bindings so we can just go off the first list of values in this array.
parameters = self.parameterize(values[0].values())
value = ['(%s)' % parameters] * len(values)
parameters = ', '.join(value)
return 'INSERT INTO %s (%s) VALUES %s' % (table, columns, parameters) |
<SYSTEM_TASK:>
Compiled a date where based clause
<END_TASK>
<USER_TASK:>
Description:
def _date_based_where(self, type, query, where):
"""
Compiled a date where based clause
:param type: The date type
:type type: str
:param query: A QueryBuilder instance
:type query: QueryBuilder
:param where: The condition
:type where: dict
:return: The compiled clause
:rtype: str
""" |
value = str(where['value']).zfill(2)
value = self.parameter(value)
return 'strftime(\'%s\', %s) %s %s'\
% (type, self.wrap(where['column']),
where['operator'], value) |
<SYSTEM_TASK:>
Compile the lock into SQL
<END_TASK>
<USER_TASK:>
Description:
def _compile_lock(self, query, value):
"""
Compile the lock into SQL
:param query: A QueryBuilder instance
:type query: QueryBuilder
:param value: The lock value
:type value: bool or str
:return: The compiled lock
:rtype: str
""" |
if isinstance(value, basestring):
return value
if value is True:
return 'FOR UPDATE'
elif value is False:
return 'LOCK IN SHARE MODE' |
<SYSTEM_TASK:>
Get a list with the values of a given key
<END_TASK>
<USER_TASK:>
Description:
def lists(self, value, key=None):
"""
Get a list with the values of a given key
:rtype: list
""" |
results = map(lambda x: x[value], self._items)
return list(results) |
<SYSTEM_TASK:>
Compile a foreign key command.
<END_TASK>
<USER_TASK:>
Description:
def compile_foreign(self, blueprint, command, _):
"""
Compile a foreign key command.
:param blueprint: The blueprint
:type blueprint: Blueprint
:param command: The command
:type command: Fluent
:rtype: str
""" |
table = self.wrap_table(blueprint)
on = self.wrap_table(command.on)
columns = self.columnize(command.columns)
on_columns = self.columnize(command.references
if isinstance(command.references, list)
else [command.references])
sql = 'ALTER TABLE %s ADD CONSTRAINT %s ' % (table, command.index)
sql += 'FOREIGN KEY (%s) REFERENCES %s (%s)' % (columns, on, on_columns)
if command.get('on_delete'):
sql += ' ON DELETE %s' % command.on_delete
if command.get('on_update'):
sql += ' ON UPDATE %s' % command.on_update
return sql |
<SYSTEM_TASK:>
Add the column modifiers to the deifinition
<END_TASK>
<USER_TASK:>
Description:
def _add_modifiers(self, sql, blueprint, column):
"""
Add the column modifiers to the deifinition
""" |
for modifier in self._modifiers:
method = '_modify_%s' % modifier
if hasattr(self, method):
sql += getattr(self, method)(blueprint, column)
return sql |
<SYSTEM_TASK:>
Get the pivot attributes from a model.
<END_TASK>
<USER_TASK:>
Description:
def _clean_pivot_attributes(self, model):
"""
Get the pivot attributes from a model.
:type model: eloquent.Model
""" |
values = {}
delete_keys = []
for key, value in model.get_attributes().items():
if key.find('pivot_') == 0:
values[key[6:]] = value
delete_keys.append(key)
for key in delete_keys:
delattr(model, key)
return values |
<SYSTEM_TASK:>
Add the constraints for a relationship count query on the same table.
<END_TASK>
<USER_TASK:>
Description:
def get_relation_count_query_for_self_join(self, query, parent):
"""
Add the constraints for a relationship count query on the same table.
:type query: eloquent.orm.Builder
:type parent: eloquent.orm.Builder
:rtype: eloquent.orm.Builder
""" |
query.select(QueryExpression('COUNT(*)'))
table_prefix = self._query.get_query().get_connection().get_table_prefix()
hash_ = self.get_relation_count_hash()
query.from_('%s AS %s%s' % (self._table, table_prefix, hash_))
key = self.wrap(self.get_qualified_parent_key_name())
return query.where('%s.%s' % (hash_, self._foreign_key), '=', QueryExpression(key)) |
<SYSTEM_TASK:>
Get the pivot columns for the relation.
<END_TASK>
<USER_TASK:>
Description:
def _get_aliased_pivot_columns(self):
"""
Get the pivot columns for the relation.
:rtype: list
""" |
defaults = [self._foreign_key, self._other_key]
columns = []
for column in defaults + self._pivot_columns:
value = '%s.%s AS pivot_%s' % (self._table, column, column)
if value not in columns:
columns.append('%s.%s AS pivot_%s' % (self._table, column, column))
return columns |
<SYSTEM_TASK:>
Set the join clause for the relation query.
<END_TASK>
<USER_TASK:>
Description:
def _set_join(self, query=None):
"""
Set the join clause for the relation query.
:param query: The query builder
:type query: eloquent.orm.Builder
:return: self
:rtype: BelongsToMany
""" |
if not query:
query = self._query
base_table = self._related.get_table()
key = '%s.%s' % (base_table, self._related.get_key_name())
query.join(self._table, key, '=', self.get_other_key())
return self |
<SYSTEM_TASK:>
Save a new model and attach it to the parent model.
<END_TASK>
<USER_TASK:>
Description:
def save(self, model, joining=None, touch=True):
"""
Save a new model and attach it to the parent model.
:type model: eloquent.Model
:type joining: dict
:type touch: bool
:rtype: eloquent.Model
""" |
if joining is None:
joining = {}
model.save({'touch': False})
self.attach(model.get_key(), joining, touch)
return model |
<SYSTEM_TASK:>
Attach all of the IDs that aren't in the current dict.
<END_TASK>
<USER_TASK:>
Description:
def _attach_new(self, records, current, touch=True):
"""
Attach all of the IDs that aren't in the current dict.
""" |
changes = {
'attached': [],
'updated': []
}
for id, attributes in records.items():
if id not in current:
self.attach(id, attributes, touch)
changes['attached'].append(id)
elif len(attributes) > 0 and self.update_existing_pivot(id, attributes, touch):
changes['updated'].append(id)
return changes |
<SYSTEM_TASK:>
Update an existing pivot record on the table.
<END_TASK>
<USER_TASK:>
Description:
def update_existing_pivot(self, id, attributes, touch=True):
"""
Update an existing pivot record on the table.
""" |
if self.updated_at() in self._pivot_columns:
attributes = self.set_timestamps_on_attach(attributes, True)
updated = self._new_picot_statement_for_id(id).update(attributes)
if touch:
self.touch_if_touching()
return updated |
<SYSTEM_TASK:>
Add a join clause to the query
<END_TASK>
<USER_TASK:>
Description:
def join(self, table, one=None,
operator=None, two=None, type='inner', where=False):
"""
Add a join clause to the query
:param table: The table to join with, can also be a JoinClause instance
:type table: str or JoinClause
:param one: The first column of the join condition
:type one: str
:param operator: The operator of the join condition
:type operator: str
:param two: The second column of the join condition
:type two: str
:param type: The join type
:type type: str
:param where: Whether to use a "where" rather than a "on"
:type where: bool
:return: The current QueryBuilder instance
:rtype: QueryBuilder
""" |
if isinstance(table, JoinClause):
self.joins.append(table)
else:
if one is None:
raise ArgumentError('Missing "one" argument')
join = JoinClause(table, type)
self.joins.append(join.on(
one, operator, two, 'and', where
))
return self |
<SYSTEM_TASK:>
Add a "join where" clause to the query
<END_TASK>
<USER_TASK:>
Description:
def join_where(self, table, one, operator, two, type='inner'):
"""
Add a "join where" clause to the query
:param table: The table to join with, can also be a JoinClause instance
:type table: str or JoinClause
:param one: The first column of the join condition
:type one: str
:param operator: The operator of the join condition
:type operator: str
:param two: The second column of the join condition
:type two: str
:param type: The join type
:type type: str
:return: The current QueryBuilder instance
:rtype: QueryBuilder
""" |
return self.join(table, one, operator, two, type, True) |
<SYSTEM_TASK:>
Add a where in with a sub select to the query
<END_TASK>
<USER_TASK:>
Description:
def _where_in_sub(self, column, query, boolean, negate=False):
"""
Add a where in with a sub select to the query
:param column: The column
:type column: str
:param query: A QueryBuilder instance
:type query: QueryBuilder
:param boolean: The boolean operator
:type boolean: str
:param negate: Whether it is a not where in
:param negate: bool
:return: The current QueryBuilder instance
:rtype: QueryBuilder
""" |
if negate:
type = 'not_in_sub'
else:
type = 'in_sub'
self.wheres.append({
'type': type,
'column': column,
'query': query,
'boolean': boolean
})
self.merge_bindings(query)
return self |
<SYSTEM_TASK:>
Add a union statement to the query
<END_TASK>
<USER_TASK:>
Description:
def union(self, query, all=False):
"""
Add a union statement to the query
:param query: A QueryBuilder instance
:type query: QueryBuilder
:param all: Whether it is a "union all" statement
:type all: bool
:return: The query
:rtype: QueryBuilder
""" |
self.unions.append({
'query': query,
'all': all
})
return self.merge_bindings(query) |
<SYSTEM_TASK:>
Execute a query for a single record by id
<END_TASK>
<USER_TASK:>
Description:
def find(self, id, columns=None):
"""
Execute a query for a single record by id
:param id: The id of the record to retrieve
:type id: mixed
:param columns: The columns of the record to retrive
:type columns: list
:return: mixed
:rtype: mixed
""" |
if not columns:
columns = ['*']
return self.where('id', '=', id).first(1, columns) |
<SYSTEM_TASK:>
Execute the query as a fresh "select" statement
<END_TASK>
<USER_TASK:>
Description:
def get_fresh(self, columns=None):
"""
Execute the query as a fresh "select" statement
:param columns: The columns to get
:type columns: list
:return: The result
:rtype: list
""" |
if not columns:
columns = ['*']
if not self.columns:
self.columns = columns
return self._processor.process_select(self, self._run_select()) |
<SYSTEM_TASK:>
Get the columns that should be used in a list
<END_TASK>
<USER_TASK:>
Description:
def _get_list_select(self, column, key=None):
"""
Get the columns that should be used in a list
:param column: The column to get the values for
:type column: str
:param key: The key
:type key: str
:return: The list of values
:rtype: list
""" |
if key is None:
elements = [column]
else:
elements = [column, key]
select = []
for elem in elements:
dot = elem.find('.')
if dot >= 0:
select.append(column[dot + 1:])
else:
select.append(elem)
return select |
<SYSTEM_TASK:>
Delete a record from the database
<END_TASK>
<USER_TASK:>
Description:
def delete(self, id=None):
"""
Delete a record from the database
:param id: The id of the row to delete
:type id: mixed
:return: The number of rows deleted
:rtype: int
""" |
if id is not None:
self.where('id', '=', id)
sql = self._grammar.compile_delete(self)
return self._connection.delete(sql, self.get_bindings()) |
<SYSTEM_TASK:>
Merge a list of where clauses and bindings
<END_TASK>
<USER_TASK:>
Description:
def merge_wheres(self, wheres, bindings):
"""
Merge a list of where clauses and bindings
:param wheres: A list of where clauses
:type wheres: list
:param bindings: A list of bindings
:type bindings: list
:rtype: None
""" |
self.wheres = self.wheres + wheres
self._bindings['where'] = self._bindings['where'] + bindings |
<SYSTEM_TASK:>
Remove the scope from a given query builder.
<END_TASK>
<USER_TASK:>
Description:
def remove(self, builder, model):
"""
Remove the scope from a given query builder.
:param builder: The query builder
:type builder: eloquent.orm.builder.Builder
:param model: The model
:type model: eloquent.orm.Model
""" |
column = model.get_qualified_deleted_at_column()
query = builder.get_query()
wheres = []
for where in query.wheres:
# If the where clause is a soft delete date constraint,
# we will remove it from the query and reset the keys
# on the wheres. This allows the developer to include
# deleted model in a relationship result set that is lazy loaded.
if not self._is_soft_delete_constraint(where, column):
wheres.append(where)
query.wheres = wheres |
<SYSTEM_TASK:>
Extend the query builder with the needed functions.
<END_TASK>
<USER_TASK:>
Description:
def extend(self, builder):
"""
Extend the query builder with the needed functions.
:param builder: The query builder
:type builder: eloquent.orm.builder.Builder
""" |
for extension in self._extensions:
getattr(self, '_add_%s' % extension)(builder)
builder.on_delete(self._on_delete) |
<SYSTEM_TASK:>
The only-trashed extension.
<END_TASK>
<USER_TASK:>
Description:
def _only_trashed(self, builder):
"""
The only-trashed extension.
:param builder: The query builder
:type builder: eloquent.orm.builder.Builder
""" |
model = builder.get_model()
self.remove(builder, model)
builder.get_query().where_not_null(model.get_qualified_deleted_at_column()) |
<SYSTEM_TASK:>
Create a new big integer column on the table.
<END_TASK>
<USER_TASK:>
Description:
def big_integer(self, column, auto_increment=False, unsigned=False):
"""
Create a new big integer column on the table.
:param column: The column
:type column: str
:type auto_increment: bool
:type unsigned: bool
:rtype: Fluent
""" |
return self._add_column('big_integer', column,
auto_increment=auto_increment,
unsigned=unsigned) |
<SYSTEM_TASK:>
Create a new medium integer column on the table.
<END_TASK>
<USER_TASK:>
Description:
def medium_integer(self, column, auto_increment=False, unsigned=False):
"""
Create a new medium integer column on the table.
:param column: The column
:type column: str
:type auto_increment: bool
:type unsigned: bool
:rtype: Fluent
""" |
return self._add_column('medium_integer', column,
auto_increment=auto_increment,
unsigned=unsigned) |
<SYSTEM_TASK:>
Create a new tiny integer column on the table.
<END_TASK>
<USER_TASK:>
Description:
def tiny_integer(self, column, auto_increment=False, unsigned=False):
"""
Create a new tiny integer column on the table.
:param column: The column
:type column: str
:type auto_increment: bool
:type unsigned: bool
:rtype: Fluent
""" |
return self._add_column('tiny_integer', column,
auto_increment=auto_increment,
unsigned=unsigned) |
<SYSTEM_TASK:>
Add a new column to the blueprint.
<END_TASK>
<USER_TASK:>
Description:
def _add_column(self, type, name, **parameters):
"""
Add a new column to the blueprint.
:param type: The column type
:type type: str
:param name: The column name
:type name: str
:param parameters: The column parameters
:type parameters: dict
:rtype: Fluent
""" |
parameters.update({
'type': type,
'name': name
})
column = Fluent(**parameters)
self._columns.append(column)
return column |
<SYSTEM_TASK:>
Dissociate previously associated model from the given parent.
<END_TASK>
<USER_TASK:>
Description:
def dissociate(self):
"""
Dissociate previously associated model from the given parent.
:rtype: eloquent.Model
""" |
self._parent.set_attribute(self._foreign_key, None)
return self._parent.set_relation(self._relation, None) |
<SYSTEM_TASK:>
Get the value of the relationship by one or many type.
<END_TASK>
<USER_TASK:>
Description:
def _get_relation_value(self, dictionary, key, type):
"""
Get the value of the relationship by one or many type.
:type dictionary: dict
:type key: str
:type type: str
""" |
value = dictionary[key]
if type == 'one':
return value[0]
return self._related.new_collection(value) |
<SYSTEM_TASK:>
Get the first related record matching the attributes or create it.
<END_TASK>
<USER_TASK:>
Description:
def first_or_create(self, _attributes=None, **attributes):
"""
Get the first related record matching the attributes or create it.
:param attributes: The attributes
:type attributes: dict
:rtype: Model
""" |
if _attributes is not None:
attributes.update(_attributes)
instance = self.where(attributes).first()
if instance is None:
instance = self.create(**attributes)
return instance |
<SYSTEM_TASK:>
Eager load the relationship of the models.
<END_TASK>
<USER_TASK:>
Description:
def eager_load_relations(self, models):
"""
Eager load the relationship of the models.
:param models:
:type models: list
:return: The models
:rtype: list
""" |
for name, constraints in self._eager_load.items():
if name.find('.') == -1:
models = self._load_relation(models, name, constraints)
return models |
<SYSTEM_TASK:>
Eagerly load the relationship on a set of models.
<END_TASK>
<USER_TASK:>
Description:
def _load_relation(self, models, name, constraints):
"""
Eagerly load the relationship on a set of models.
:rtype: list
""" |
relation = self.get_relation(name)
relation.add_eager_constraints(models)
if callable(constraints):
constraints(relation)
else:
relation.merge_query(constraints)
models = relation.init_relation(models, name)
results = relation.get_eager()
return relation.match(models, results, name) |
Subsets and Splits