From 34039bea6fdc5bd3dd6e992cd4dd023b7df8e453 Mon Sep 17 00:00:00 2001 From: Iacopo Spalletti Date: Fri, 12 Feb 2016 08:02:23 +0100 Subject: [PATCH] Add docstrings --- djangocms_blog/admin.py | 21 ++++++++++++++++++--- djangocms_blog/cms_toolbar.py | 3 +++ 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/djangocms_blog/admin.py b/djangocms_blog/admin.py index fc68837..e48f3f6 100755 --- a/djangocms_blog/admin.py +++ b/djangocms_blog/admin.py @@ -77,6 +77,9 @@ class PostAdmin(PlaceholderAdminMixin, FrontendEditableAdminMixin, } def get_urls(self): + """ + Customize the modeladmin urls + """ urls = [ url(r'^publish/([0-9]+)/$', self.admin_site.admin_view(self.publish_post), name='djangocms_blog_publish_article'), @@ -85,6 +88,12 @@ class PostAdmin(PlaceholderAdminMixin, FrontendEditableAdminMixin, return urls def publish_post(self, request, pk): + """ + Admin view to publish a single post + :param request: request + :param pk: primary key of the post to publish + :return: Redirect to the post itself (if found) or fallback urls + """ language = get_language_from_request(request, check_path=True) try: post = Post.objects.get(pk=int(pk)) @@ -97,9 +106,6 @@ class PostAdmin(PlaceholderAdminMixin, FrontendEditableAdminMixin, except KeyError: return HttpResponseRedirect(reverse('djangocms_blog:posts-latest')) - def languages(self, obj): - return ','.join(obj.get_available_languages()) - def formfield_for_dbfield(self, db_field, **kwargs): field = super(PostAdmin, self).formfield_for_dbfield(db_field, **kwargs) if db_field.name == 'meta_description': @@ -111,6 +117,12 @@ class PostAdmin(PlaceholderAdminMixin, FrontendEditableAdminMixin, return field def get_fieldsets(self, request, obj=None): + """ + Customize the fieldsets according to the app settings + :param request: request + :param obj: post + :return: fieldsets configuration + """ app_config_default = self._app_config_select(request, obj) if app_config_default is None and request.method == 'GET': return super(PostAdmin, self).get_fieldsets(request, obj) @@ -156,6 +168,9 @@ class BlogConfigAdmin(BaseAppHookConfig, TranslatableAdmin): @property def declared_fieldsets(self): + """ + Fieldsets configuration + """ return [ (None, { 'fields': ('type', 'namespace', 'app_title', 'object_name') diff --git a/djangocms_blog/cms_toolbar.py b/djangocms_blog/cms_toolbar.py index 00a3157..7dfd2cc 100644 --- a/djangocms_blog/cms_toolbar.py +++ b/djangocms_blog/cms_toolbar.py @@ -35,6 +35,9 @@ class BlogToolbar(CMSToolbar): active=True) def add_publish_button(self): + """ + Adds the publish button to the toolbar if the current post is unpublished + """ current_post = getattr(self.request, get_setting('CURRENT_POST_IDENTIFIER'), None) if (self.toolbar.edit_mode and current_post and not current_post.publish and