pylint compliant naming convension implemented

Author: monim67

bootstrap_datepicker_plus/DatePickerDictionary.py

@@ -1,5 +1,44 @@
-from .widgets import DatePickerInput
-from .widgets import TimePickerInput
-from .widgets import DateTimePickerInput
-from .widgets import MonthPickerInput
-from .widgets import YearPickerInput
+from bootstrap_datepicker_plus._base import BasePickerInput
+
+__all__ = (
+    'DatePickerInput',
+    'TimePickerInput',
+    'DateTimePickerInput',
+    'MonthPickerInput',
+    'YearPickerInput',
+)
+
+
+class DatePickerInput(BasePickerInput):
+    picker_type = 'DATE'
+    format = '%m/%d/%Y'
+    format_key = 'DATE_INPUT_FORMATS'
+
+
+class TimePickerInput(BasePickerInput):
+    picker_type = 'TIME'
+    format = '%H:%M'
+    format_key = 'TIME_INPUT_FORMATS'
+    template_name = 'bootstrap_datepicker_plus/time-picker.html'
+
+
+class DateTimePickerInput(BasePickerInput):
+    picker_type = 'DATETIME'
+    format = '%m/%d/%Y %H:%M'
+    format_key = 'DATETIME_INPUT_FORMATS'
+
+
+class MonthPickerInput(BasePickerInput):
+    picker_type = 'MONTH'
+    format = '%Y-%m-01'
+    format_key = 'DATE_INPUT_FORMATS'
+
+
+class YearPickerInput(BasePickerInput):
+    picker_type = 'YEAR'
+    format = '%Y-01-01'
+    format_key = 'DATE_INPUT_FORMATS'
+
+    def _link_to(self, linked_picker):
+        yformat = self.config['options']['format'].replace('-01-01', '-12-31')
+        self.config['options']['format'] = yformat

bootstrap_datepicker_plus/__init__.py

@@ -1,9 +1,12 @@
 # -*- coding: utf-8 -*-
 from json import dumps as json_dumps
-from .DatePickerDictionary import DatePickerDictionary
+from bootstrap_datepicker_plus._helpers import (
+    get_base_input,
+    DatePickerDictionary,
+)
 
 
-class DatePickerBaseInput(DatePickerDictionary.get_base_input()):
+class BasePickerInput(get_base_input()):
     template_name = 'bootstrap_datepicker_plus/date-picker.html'
     picker_type = 'DATE'
     format = '%m/%d/%Y'
@@ -22,7 +25,8 @@ class DatePickerBaseInput(DatePickerDictionary.get_base_input()):
         'showTodayButton': True,
     }
 
-    # source: https://github.com/tutorcruncher/django-bootstrap3-datetimepicker/blob/master/bootstrap3_datetime/widgets.py
+    # source: https://github.com/tutorcruncher/django-bootstrap3-datetimepicker
+    # file: /blob/31fbb09/bootstrap3_datetime/widgets.py#L33
     format_map = (
         ('DDD', r'%j'),
         ('DD', r'%d'),
@@ -41,28 +45,31 @@ class DatePickerBaseInput(DatePickerDictionary.get_base_input()):
 
     class Media:
         js = (
-            'https://cdnjs.cloudflare.com/ajax/libs/moment.js/2.9.0/moment-with-locales.min.js',
-            'https://cdnjs.cloudflare.com/ajax/libs/bootstrap-datetimepicker/4.17.47/js/bootstrap-datetimepicker.min.js',
+            'https://cdnjs.cloudflare.com/ajax/libs/moment.js/2.9.0/'
+            'moment-with-locales.min.js',
+            'https://cdnjs.cloudflare.com/ajax/libs/bootstrap-datetimepicker/'
+            '4.17.47/js/bootstrap-datetimepicker.min.js',
             'bootstrap_datepicker_plus/js/datepicker-widget.js'
         )
         css = {'all': (
-            'https://cdnjs.cloudflare.com/ajax/libs/bootstrap-datetimepicker/4.17.47/css/bootstrap-datetimepicker.css',
+            'https://cdnjs.cloudflare.com/ajax/libs/bootstrap-datetimepicker/'
+            '4.17.47/css/bootstrap-datetimepicker.css',
             'bootstrap_datepicker_plus/css/datepicker-widget.css'
         ), }
 
     @classmethod
-    def format_py2js(cls, format):
+    def format_py2js(cls, datetime_format):
         ''' convert python datetime format to moment format '''
-        for js, py in cls.format_map:
-            format = format.replace(py, js)
-        return format
+        for js_format, py_format in cls.format_map:
+            datetime_format = datetime_format.replace(py_format, js_format)
+        return datetime_format
 
     @classmethod
-    def format_js2py(cls, format):
+    def format_js2py(cls, datetime_format):
         ''' convert moment format to python datetime format '''
-        for js, py in cls.format_map:
-            format = format.replace(js, py)
-        return format
+        for js_format, py_format in cls.format_map:
+            datetime_format = datetime_format.replace(js_format, py_format)
+        return datetime_format
 
     def __init__(self, attrs={}, format=None, options={}):
         self.config = self._default_config.copy()
@@ -80,7 +87,7 @@ def __init__(self, attrs={}, format=None, options={}):
         # Initilize
         if 'class' not in attrs:
             attrs['class'] = 'form-control'
-        super(DatePickerBaseInput, self).__init__(attrs, format)
+        super().__init__(attrs, format)
 
     def _calculate_options(self, options):
         self.options_parameter = options
@@ -90,7 +97,7 @@ def _calculate_options(self, options):
         return _options
 
     def get_context(self, name, value, attrs):
-        context = super(DatePickerBaseInput, self).get_context(
+        context = super().get_context(
             name, value, attrs)
         context['widget']['attrs']['dp_config'] = json_dumps(self.config)
         return context
@@ -123,7 +130,8 @@ def end_of(self, event_id, import_options=True):
                     self.config['options']['format'] = backup_moment_format
                 else:
                     self.format = linked_picker.format
-            # Important! See https://github.com/Eonasdan/bootstrap-datetimepicker/issues/1075
+            # Setting useCurrent is necessary, see following issue
+            # https://github.com/Eonasdan/bootstrap-datetimepicker/issues/1075
             self.config['options']['useCurrent'] = False
             self._link_to(linked_picker)
         else:
@@ -132,4 +140,4 @@ def end_of(self, event_id, import_options=True):
         return self
 
     def _link_to(self, linked_picker):
-        ...
+        pass

…p_datepicker_plus/DatePickerBaseInput.py bootstrap_datepicker_plus/_base.pybootstrap_datepicker_plus/DatePickerBaseInput.py renamed to bootstrap_datepicker_plus/_base.py bootstrap_datepicker_plus/DatePickerBaseInput.py renamed to bootstrap_datepicker_plus/_base.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from functools import lru_cache
 from pathlib import Path
 
 from django.forms.widgets import DateTimeBaseInput
@@ -33,15 +34,20 @@ def engine(self):
         })
 
 
-class DjangoTemplatesEx(EngineMixin, BaseRenderer):
+class DjangoTemplateRenderer(EngineMixin, BaseRenderer):
     """
     Load Django templates from the built-in widget templates in
     django/forms/templates and from apps' 'templates' directory.
     """
     backend = DjangoTemplates
 
 
-class DateTimeBaseInputEx(DateTimeBaseInput):
+@lru_cache()
+def get_default_renderer():
+    return DjangoTemplateRenderer()
+
+
+class CompatibleDateTimeBaseInput(DateTimeBaseInput):
     format = '%m/%d/%Y'
     format_key = 'DATE_INPUT_FORMATS'
     template_name = 'bootstrap_datepicker_plus/date-picker.html'
@@ -71,5 +77,5 @@ def render(self, name, value, attrs=None, renderer=None):
 
     def _render(self, template_name, context, renderer=None):
         if renderer is None:
-            renderer = DjangoTemplatesEx()
+            renderer = get_default_renderer()
         return mark_safe(renderer.render(template_name, context))

…p_datepicker_plus/DateTimeBaseInputEx.py …tstrap_datepicker_plus/_compatibility.pybootstrap_datepicker_plus/DateTimeBaseInputEx.py renamed to bootstrap_datepicker_plus/_compatibility.py bootstrap_datepicker_plus/DateTimeBaseInputEx.py renamed to bootstrap_datepicker_plus/_compatibility.py

@@ -0,0 +1,22 @@
+def get_base_input(test=False):
+    from django.forms.widgets import DateTimeBaseInput
+    if 'get_context' in dir(DateTimeBaseInput) and not test:
+        # django version 1.11 and above
+        base_input = DateTimeBaseInput
+    else:
+        # django version below 1.11
+        from bootstrap_datepicker_plus._compatibility import (
+            CompatibleDateTimeBaseInput
+        )
+        base_input = CompatibleDateTimeBaseInput
+    return base_input
+
+
+class DatePickerDictionary:
+    _i = 0
+    items = dict()
+
+    @classmethod
+    def generate_id(cls):
+        cls._i += 1
+        return 'dp_%s' % cls._i

bootstrap_datepicker_plus/_helpers.py

@@ -1,17 +1,14 @@
 from django.test import SimpleTestCase
 
-from bootstrap_datepicker_plus.DateTimeBaseInputEx import BaseRenderer
-from bootstrap_datepicker_plus.DatePickerDictionary import DatePickerDictionary
-
-from json import dumps as json_dumps
-import re
+from bootstrap_datepicker_plus._compatibility import BaseRenderer
+from bootstrap_datepicker_plus._helpers import get_base_input
 
 
 class TestCompatibilityPatch(SimpleTestCase):
 
     def setUp(self):
-        self.DatePickerInputEx = DatePickerDictionary.get_base_input(True)
-        self.dp_input = self.DatePickerInputEx()
+        self.CompatibleDatePickerInput = get_base_input(True)
+        self.dp_input = self.CompatibleDatePickerInput()
 
     def test_raise_on_get_template(self):
         self.assertRaises(NotImplementedError,

bootstrap_datepicker_plus/widgets.py

@@ -1,18 +1,18 @@
 from django.test import SimpleTestCase
 
-from bootstrap_datepicker_plus import DatePickerInput
+from bootstrap_datepicker_plus._base import BasePickerInput
 
 
 class TestDateFormatConversion(SimpleTestCase):
 
     def test_format_py2js(self):
-        self.assertEqual(DatePickerInput.format_py2js(
+        self.assertEqual(BasePickerInput.format_py2js(
             '%Y-%m-%d'), 'YYYY-MM-DD')
-        self.assertEqual(DatePickerInput.format_py2js(
+        self.assertEqual(BasePickerInput.format_py2js(
             '%d/%m/%Y'), 'DD/MM/YYYY')
 
     def test_format_js2py(self):
-        self.assertEqual(DatePickerInput.format_js2py(
+        self.assertEqual(BasePickerInput.format_js2py(
             'YYYY-MM-DD'), '%Y-%m-%d')
-        self.assertEqual(DatePickerInput.format_js2py(
+        self.assertEqual(BasePickerInput.format_js2py(
             'DD/MM/YYYY'), '%d/%m/%Y')

tests/test_compatibility_patch.py

@@ -1,26 +1,26 @@
 from django.test import SimpleTestCase
 
-from bootstrap_datepicker_plus.DatePickerBaseInput import DatePickerBaseInput
+from bootstrap_datepicker_plus._base import BasePickerInput
 from bootstrap_datepicker_plus import YearPickerInput
 
 
 class TestLinkedInputs(SimpleTestCase):
 
     def test_raising_error_on_no_start_of_key(self):
-        endpicker = DatePickerBaseInput()
+        endpicker = BasePickerInput()
         self.assertRaises(KeyError, lambda: endpicker.end_of('undefined'))
 
     def test_format_copy(self):
-        dp_input1 = DatePickerBaseInput(
+        dp_input1 = BasePickerInput(
             format='%Y-%m-%d').start_of('format_copy')
-        dp_input2 = DatePickerBaseInput().end_of('format_copy')
+        dp_input2 = BasePickerInput().end_of('format_copy')
         self.assertEqual(dp_input1.format, '%Y-%m-%d')
         self.assertEqual(dp_input2.format, '%Y-%m-%d')
 
     def test_format_copy_override(self):
-        dp_input1 = DatePickerBaseInput(
+        dp_input1 = BasePickerInput(
             format='%Y-%m-%d').start_of('format_copy_override')
-        dp_input2 = DatePickerBaseInput(
+        dp_input2 = BasePickerInput(
             format='%m/%d/%Y').end_of('format_copy_override')
         self.assertEqual(dp_input1.format, '%Y-%m-%d')
         self.assertEqual(dp_input2.format, '%m/%d/%Y')

tests/test_format_pyjs.py

@@ -1,24 +1,24 @@
 from django.test import SimpleTestCase
 
-from bootstrap_datepicker_plus.DatePickerBaseInput import DatePickerBaseInput
+from bootstrap_datepicker_plus._base import BasePickerInput
 
 
-class custom_input(DatePickerBaseInput):
+class custom_input(BasePickerInput):
     format = '%Y-%m-%d'
 
 
 class TestOptionOverrides(SimpleTestCase):
 
     def test_format_as_parameter(self):
-        dp_input = DatePickerBaseInput(format='%Y-%m-%d')
+        dp_input = BasePickerInput(format='%Y-%m-%d')
         self.assertEqual(dp_input.format, '%Y-%m-%d')
 
     def test_format_as_option(self):
-        dp_input = DatePickerBaseInput(options={'format': 'YYYY-MM-DD'})
+        dp_input = BasePickerInput(options={'format': 'YYYY-MM-DD'})
         self.assertEqual(dp_input.format, '%Y-%m-%d')
 
     def test_format_as_both(self):
-        dp_input = DatePickerBaseInput(
+        dp_input = BasePickerInput(
             format='%m/%d/%Y', options={'format': 'YYYY-MM-DD'})
         self.assertEqual(dp_input.format, '%Y-%m-%d')