beautify code

.pre-commit-config.yaml

@@ -7,7 +7,15 @@ repos:
     -   id: check-added-large-files
     -   id: check-ast
 
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.1
+    hooks:
+    -   id: ruff
+        # enable auto-fixing of common errors
+        args: [--exit-non-zero-on-fix]
+
 -   repo: https://github.com/psf/black
     rev: 22.10.0
     hooks:
     -   id: black
+        args: [--line-length=120, --skip-string-normalization]

docs/conf.py

@@ -11,8 +11,6 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-
 try:
     import sphinx_rtd_theme
 
@@ -24,12 +22,12 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+# sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
@@ -42,7 +40,7 @@
 source_suffix = '.rst'
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = 'index'
@@ -62,37 +60,37 @@
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 
 # -- Options for HTML output ---------------------------------------------------
@@ -104,27 +102,27 @@
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 # html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -133,44 +131,44 @@
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'DjangoSuitdoc'
@@ -181,53 +179,47 @@
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-    ('index', 'DjangoSuit.tex', u'Django Suit Documentation',
-     u'Kaspars Sprogis (darklow)', 'manual'),
+    ('index', 'DjangoSuit.tex', u'Django Suit Documentation', u'Kaspars Sprogis (darklow)', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output --------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'djangosuit', u'Django Suit Documentation',
-     [u'Kaspars Sprogis (darklow)'], 1)
-]
+man_pages = [('index', 'djangosuit', u'Django Suit Documentation', [u'Kaspars Sprogis (darklow)'], 1)]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output ------------------------------------------------
@@ -236,17 +228,22 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'DjangoSuit', u'Django Suit Documentation',
-     u'Kaspars Sprogis (darklow)', 'DjangoSuit',
-     'One line description of project.',
-     'Miscellaneous'),
+    (
+        'index',
+        'DjangoSuit',
+        u'Django Suit Documentation',
+        u'Kaspars Sprogis (darklow)',
+        'DjangoSuit',
+        'One line description of project.',
+        'Miscellaneous',
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'

suit/admin.py

@@ -13,6 +13,7 @@ class SortableModelAdminBase(object):
     """
     Base class for SortableTabularInline and SortableModelAdmin
     """
+
     sortable = 'order'
 
     class Media:
@@ -25,10 +26,7 @@ class SortableListForm(ModelForm):
     """
 
     class Meta:
-        widgets = {
-            'order': NumberInput(
-                attrs={'class': 'hide input-mini suit-sortable'})
-        }
+        widgets = {'order': NumberInput(attrs={'class': 'hide input-mini suit-sortable'})}
 
 
 class SortableChangeList(ChangeList):
@@ -56,23 +54,22 @@ def __init__(self, *args, **kwargs):
     def formfield_for_dbfield(self, db_field, **kwargs):
         if db_field.name == self.sortable:
             kwargs['widget'] = SortableListForm.Meta.widgets['order']
-        return super(SortableTabularInlineBase, self).formfield_for_dbfield(
-            db_field, **kwargs)
+        return super(SortableTabularInlineBase, self).formfield_for_dbfield(db_field, **kwargs)
 
 
 class SortableTabularInline(SortableTabularInlineBase, admin.TabularInline):
     pass
 
 
-class SortableGenericTabularInline(SortableTabularInlineBase,
-                                   ct_admin.GenericTabularInline):
+class SortableGenericTabularInline(SortableTabularInlineBase, ct_admin.GenericTabularInline):
     pass
 
 
 class SortableStackedInlineBase(SortableModelAdminBase):
     """
     Sortable stacked inline
     """
+
     def __init__(self, *args, **kwargs):
         super(SortableStackedInlineBase, self).__init__(*args, **kwargs)
         self.ordering = (self.sortable,)
@@ -83,8 +80,7 @@ def get_fieldsets(self, *args, **kwargs):
         Remove sortable from every other fieldset, if by some reason someone
         has added it
         """
-        fieldsets = super(SortableStackedInlineBase, self).get_fieldsets(
-            *args, **kwargs)
+        fieldsets = super(SortableStackedInlineBase, self).get_fieldsets(*args, **kwargs)
 
         sortable_added = False
         for fieldset in fieldsets:
@@ -115,27 +111,25 @@ def get_fieldsets(self, *args, **kwargs):
 
     def formfield_for_dbfield(self, db_field, **kwargs):
         if db_field.name == self.sortable:
-            kwargs['widget'] = copy.deepcopy(
-                SortableListForm.Meta.widgets['order'])
+            kwargs['widget'] = copy.deepcopy(SortableListForm.Meta.widgets['order'])
             kwargs['widget'].attrs['class'] += ' suit-sortable-stacked'
             kwargs['widget'].attrs['rowclass'] = ' suit-sortable-stacked-row'
-        return super(SortableStackedInlineBase, self).formfield_for_dbfield(
-            db_field, **kwargs)
+        return super(SortableStackedInlineBase, self).formfield_for_dbfield(db_field, **kwargs)
 
 
 class SortableStackedInline(SortableStackedInlineBase, admin.StackedInline):
     pass
 
 
-class SortableGenericStackedInline(SortableStackedInlineBase,
-                                   ct_admin.GenericStackedInline):
+class SortableGenericStackedInline(SortableStackedInlineBase, ct_admin.GenericStackedInline):
     pass
 
 
 class SortableModelAdmin(SortableModelAdminBase, ModelAdmin):
     """
     Sortable tabular inline
     """
+
     list_per_page = 500
 
     def __init__(self, *args, **kwargs):
@@ -161,12 +155,10 @@ def merge_form_meta(self, form):
             form.Meta = SortableListForm.Meta
         if not getattr(form.Meta, 'widgets', None):
             form.Meta.widgets = {}
-        form.Meta.widgets[self.sortable] = SortableListForm.Meta.widgets[
-            'order']
+        form.Meta.widgets[self.sortable] = SortableListForm.Meta.widgets['order']
 
     def get_changelist_form(self, request, **kwargs):
-        form = super(SortableModelAdmin, self).get_changelist_form(request,
-                                                                   **kwargs)
+        form = super(SortableModelAdmin, self).get_changelist_form(request, **kwargs)
         self.merge_form_meta(form)
         return form
 
@@ -175,8 +167,7 @@ def get_changelist(self, request, **kwargs):
 
     def save_model(self, request, obj, form, change):
         if not obj.pk:
-            max_order = obj.__class__.objects.aggregate(
-                models.Max(self.sortable))
+            max_order = obj.__class__.objects.aggregate(models.Max(self.sortable))
             try:
                 next_order = max_order['%s__max' % self.sortable] + 1
             except TypeError:
@@ -197,4 +188,3 @@ def save_model(self, request, obj, form, change):
         }
     except ImportError:
         pass
-