]> Frank Brehm's Git Trees - pixelpark/pp-admin-tools.git/commitdiff
Make the linter happy
authorFrank Brehm <frank.brehm@pixelpark.com>
Thu, 25 May 2023 11:44:10 +0000 (13:44 +0200)
committerFrank Brehm <frank.brehm@pixelpark.com>
Thu, 25 May 2023 11:44:10 +0000 (13:44 +0200)
lib/pp_admintools/__init__.py
lib/pp_admintools/app/barracuda_sync.py
lib/pp_admintools/errors.py
lib/pp_admintools/merge.py
lib/pp_admintools/xlate.py

index a42debde9f13de4515ee2e10a9b39ee2c5f39c72..4fc4bc2950a8a2e315554b1916f71a96d139a2b3 100644 (file)
@@ -1,5 +1,12 @@
 #!/bin/env python3
 # -*- coding: utf-8 -*-
+"""
+@summary: The init module for the DPX admin-tools package.
+
+@author: Frank Brehm
+@contact: frank.brehm@pixelpark.com
+@copyright: © 2023 by Frank Brehm, Berlin
+"""
 from __future__ import absolute_import
 
 # Standard modules
@@ -8,7 +15,7 @@ import shutil
 # Own modules
 import fb_tools.common
 
-__version__ = '0.8.7'
+__version__ = '0.8.8'
 
 MAX_PORT_NUMBER = (2 ** 16) - 1
 DEFAULT_CONFIG_DIR = 'pixelpark'
@@ -24,7 +31,6 @@ def pp(value, indent=4, width=None, depth=None):
     @return: pretty print string
     @rtype: str
     """
-
     if not width:
         term_size = shutil.get_terminal_size((DEFAULT_TERMINAL_WIDTH, DEFAULT_TERMINAL_HEIGHT))
         width = term_size.columns
index 3646c8670641a3d9da557a5c60caf9bcc0a17c3a..1dee5bbb85c275e0197660584007fa08ed1959cb 100644 (file)
@@ -12,8 +12,8 @@ from __future__ import absolute_import
 # import copy
 import logging
 import re
-import time
 import sys
+import time
 from functools import cmp_to_key
 from pathlib import Path
 
@@ -31,7 +31,7 @@ from ldap3 import MODIFY_ADD, MODIFY_DELETE, MODIFY_REPLACE
 from .ldap import BaseLdapApplication
 from ..xlate import XLATOR
 
-__version__ = '0.9.2'
+__version__ = '0.9.3'
 LOG = logging.getLogger(__name__)
 
 _ = XLATOR.gettext
index ec57c35436459d6a1f0d541d12651c8f1cc59e31..7175cafd39af4d18b04ad4adf1f26523e85c2e8b 100644 (file)
@@ -1,34 +1,34 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
+@summary: module for some common used error classes.
+
 @author: Frank Brehm
-@summary: module for some common used error classes
 """
 
 # own modules
-from fb_tools.errors import FbError, FbAppError
+from fb_tools.errors import FbAppError, FbError
 
 
-__version__ = '0.6.0'
+__version__ = '0.6.1'
 
 # =============================================================================
 class PpError(FbError):
-    """
-    Base error class for all other self defined exceptions.
-    """
+    """Base error class for all other self defined exceptions."""
 
     pass
 
 
 # =============================================================================
 class PpAppError(FbAppError):
+    """Base error class for all self defined exceptions in applications."""
 
     pass
 
 
 # =============================================================================
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     pass
 
 # =============================================================================
index 28103747d16529b8e2ed3696a0003157ceeb2fad..864e058d182709600df917a4b9898a568c59c7a7 100644 (file)
@@ -1,26 +1,35 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 """
+@summary: A module for functions to merge different data structures.
+
 @author: Frank Brehm
 @contact: frank.brehm@pixelpark.com
 """
 
 import itertools
 
-__version__ = '0.2.0'
+__version__ = '0.2.1'
 
 
 # =============================================================================
 class ZipExhausted(Exception):
+    """A special exception class to be used in izip_longest() on a counter overflow."""
+
     pass
 
 
 # =============================================================================
 def izip_longest(*args, **kwds):
-    '''
+    """
+    Print the values of iterables alternatively in sequence.
+
+    If one of the iterables is printed fully, the remaining values are filled
+    by the values assigned to fillvalue parameter.
+
     Function izip_longest() does not exists anymore in Python3 itertools.
     Taken from https://docs.python.org/2/library/itertools.html#itertools.izip_longest
-    '''
+    """
     # izip_longest('ABCD', 'xy', fillvalue='-') --> Ax By C- D-
 
     fillvalue = kwds.get('fillvalue')
@@ -45,9 +54,11 @@ def izip_longest(*args, **kwds):
 
 # =============================================================================
 def merge_structure(a, b):
-    '''
+    """
+    Merge the given structures in a deep manner.
+
     Taken from https://gist.github.com/saurabh-hirani/6f3f5d119076df70e0da
-    '''
+    """
     if isinstance(a, dict) and isinstance(b, dict):
         d = dict(a)
         d.update({k: merge_structure(a.get(k, None), b[k]) for k in b})
@@ -66,7 +77,7 @@ def merge_structure(a, b):
 
 # =============================================================================
 
-if __name__ == "__main__":
+if __name__ == '__main__':
 
     pass
 
index 0fc86997e5a57e57936df00f21ef5607bc77a861..066548ac22859a03ad13ab2f6ad186a822930895 100644 (file)
@@ -1,25 +1,24 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
+@summary: The module for i18n.
+
+It provides translation object, usable from all other modules in this package.
+
 @author: Frank Brehm
 @contact: frank@brehm-online.com
 @copyright: © 2023 by Frank Brehm, Berlin
-@summary: The module for i18n.
-          It provides translation object, usable from all other
-          modules in this package.
 """
 from __future__ import absolute_import, print_function
 
 # Standard modules
-import logging
-import gettext
 import copy
-
+import gettext
+import logging
 try:
     from pathlib import Path
 except ImportError:
     from pathlib2 import Path
-
 from distutils.version import LooseVersion
 
 # Third party modules
@@ -31,7 +30,7 @@ DOMAIN = 'pp_admintools'
 
 LOG = logging.getLogger(__name__)
 
-__version__ = '0.1.0'
+__version__ = '0.1.1'
 
 __me__ = Path(__file__).resolve()
 __module_dir__ = __me__.parent
@@ -73,6 +72,7 @@ _ = XLATOR.gettext
 def format_list(lst, do_repr=False, style='standard', locale=DEFAULT_LOCALE):
     """
     Format the items in `lst` as a list.
+
     :param lst: a sequence of items to format in to a list
     :param locale: the locale
     """
@@ -92,13 +92,13 @@ def format_list(lst, do_repr=False, style='standard', locale=DEFAULT_LOCALE):
 
 # =============================================================================
 
-if __name__ == "__main__":
+if __name__ == '__main__':
 
-    print(_("Module directory: {!r}").format(__module_dir__))
-    print(_("Base directory: {!r}").format(__base_dir__))
-    print(_("Locale directory: {!r}").format(LOCALE_DIR))
-    print(_("Locale domain: {!r}").format(DOMAIN))
-    print(_("Found .mo-file: {!r}").format(__mo_file__))
+    print(_('Module directory: {!r}').format(__module_dir__))
+    print(_('Base directory: {!r}').format(__base_dir__))
+    print(_('Locale directory: {!r}').format(LOCALE_DIR))
+    print(_('Locale domain: {!r}').format(DOMAIN))
+    print(_('Found .mo-file: {!r}').format(__mo_file__))
 
 # =============================================================================