Fix style check failures

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>

Author: AyanSinhaMahapatra

.github/workflows/docs-ci.yml

@@ -30,4 +30,4 @@ jobs:
         run: make doc8
 
       - name: Check for Code style errors
-        run: make check-ci
+        run: make check

CHANGELOG.rst

@@ -4,8 +4,9 @@ Release notes
 Version 32.3.0 - (2025-03-06)
 -----------------------------
 
-- migrate ``os.listdir()`` to ``os.scandir()`` to increase performance
-- Fix checksums for empty files
+- Fix ``click`` compatibililty issues.
+  https://github.com/aboutcode-org/commoncode/pull/89
+  https://github.com/aboutcode-org/commoncode/pull/86
 
 Version 32.2.1 - (2025-03-06)
 -----------------------------
@@ -41,7 +42,8 @@ Version 32.0.0 - (2024-09-05)
 Version 31.2.1 - (2024-05-16)
 -----------------------------
 
-- Remove ``commoncode.system.get_etc_os_release_info`` and replace it with ``commoncode.distro_os_release_parser``.
+- Remove ``commoncode.system.get_etc_os_release_info`` and replace it with
+  ``commoncode.distro_os_release_parser``.
 
 
 Version 31.2.0 - (2024-05-16)

src/commoncode/command.py

@@ -129,9 +129,9 @@ def execute2(
     log=TRACE,
 ):
     """
-    DEPRECATED: DO NOT USE. Use execute() instead
     Run a `cmd_loc` command with the `args` arguments list and return the return
     code, the stdout and stderr.
+    DEPRECATED: DO NOT USE. Use execute() instead
 
     To avoid RAM exhaustion, always write stdout and stderr streams to files.
 

src/commoncode/datautils.py

@@ -33,7 +33,7 @@ def attribute(
     metadata=None,
 ):  # NOQA
     """
-    A generic attribute with help metadata and that is not included in the
+    Return a generic attribute with help metadata and that is not included in the
     representation by default.
     """
     metadata = metadata or dict()
@@ -67,7 +67,7 @@ def Boolean(
     help=None,
 ):  # NOQA
     """
-    A boolean attribute.
+    Return a boolean attribute.
     """
     return attribute(
         default=default,
@@ -94,7 +94,7 @@ def TriBoolean(
     help=None,
 ):  # NOQA
     """
-    A tri-boolean attribute with possible values of None, True and False.
+    Return a tri-boolean attribute with possible values of None, True and False.
     """
     return attribute(
         default=default,
@@ -121,7 +121,7 @@ def String(
     help=None,
 ):  # NOQA
     """
-    A string attribute.
+    Return a string attribute.
     """
     return attribute(
         default=default,
@@ -148,7 +148,7 @@ def Integer(
     help=None,
 ):  # NOQA
     """
-    An integer attribute.
+    Return an integer attribute.
     """
     converter = converter or attr.converters.optional(int)
     return attribute(
@@ -176,7 +176,7 @@ def Float(
     help=None,
 ):  # NOQA
     """
-    A float attribute.
+    Return a float attribute.
     """
     return attribute(
         default=default,
@@ -204,7 +204,7 @@ def List(
     help=None,
 ):  # NOQA
     """
-    A list attribute: the optional item_type defines the type of items it stores.
+    Return a list attribute: the optional item_type defines the type of items it stores.
     """
     if default is attr.NOTHING:
         default = attr.Factory(list)
@@ -235,7 +235,7 @@ def Mapping(
     label=None,
 ):  # NOQA
     """
-    A mapping attribute: the optional value_type defines the type of values it
+    Return a mapping attribute: the optional value_type defines the type of values it
     stores. The key is always a string.
 
     Notes: in Python 2 the type is Dict as there is no typing available for
@@ -274,7 +274,7 @@ def Date(
     help=None,
 ):  # NOQA
     """
-    A date attribute. It always serializes to an ISO date string.
+    Return a date attribute. It always serializes to an ISO date string.
     Behavior is TBD and for now this is exactly a string.
     """
     return String(

src/commoncode/dict_utils.py

@@ -18,6 +18,7 @@ def sparsify(d):
     Example:
     >>> sparsify({1: 3, 4: 5})
     {1: 3, 4: 5}
+
     """
     e = d.copy()
     d.update(e)

src/commoncode/fetch.py

@@ -54,7 +54,7 @@ def download_url(url, file_name=None, verify=True, timeout=10):
 
 def ping_url(url):
     """
-    Returns True is `url` is reachable.
+    Return True is `url` is reachable.
     """
     try:
         from urlib.request import urlopen

src/commoncode/fileutils.py

@@ -70,7 +70,7 @@ def create_dir(location):
 
     if os.path.exists(location):
         if not os.path.isdir(location):
-            err = "Cannot create directory: existing file " "in the way " "%(location)s."
+            err = "Cannot create directory: existing file in the way %(location)s."
             raise OSError(err % locals())
     else:
         # may fail on win if the path is too long
@@ -140,7 +140,7 @@ def prepare_path(pth):
 
 
 def is_posixpath(location):
-    """
+    r"""
     Return True if the `location` path is likely a POSIX-like path using POSIX path
     separators (slash or "/")or has no path separator.
 
@@ -164,7 +164,7 @@ def is_posixpath(location):
 
 
 def as_posixpath(location):
-    """
+    r"""
     Return a POSIX-like path using POSIX path separators (slash or "/") for a
     `location` path. This converts Windows paths to look like POSIX paths: Python
     accepts gracefully POSIX paths on Windows.
@@ -174,7 +174,7 @@ def as_posixpath(location):
 
 
 def as_winpath(location):
-    """
+    r"""
     Return a Windows-like path using Windows path separators (backslash or "\") for a
     `location` path.
     """

src/commoncode/resource.py

@@ -120,8 +120,6 @@ def depth_walk(
     directory recursively up to ``max_depth`` path segments extending from the
     ``root_location``. The behaviour is similar of ``os.walk``.
 
-    Arguments:
-
     - root_location: Absolute, normalized path for the directory to be walked
     - max_depth: positive integer for fixed depth limit. 0 for no limit.
     - skip_ignored: Callback function that takes a location as argument and
@@ -829,7 +827,7 @@ def _dump_resource(self, resource):
 
         if not cache_location:
             raise TypeError(
-                "Resource cannot be dumped to disk and is used only" f"in memory: {resource}"
+                f"Resource cannot be dumped to disk and is used onlyin memory: {resource}"
             )
 
         # TODO: consider messagepack or protobuf for compact/faster processing?
@@ -1173,7 +1171,7 @@ def type(self, value):
 
     @classmethod
     def build_path(cls, root_location, location):
-        """
+        r"""
         Return a POSIX path string (using "/"  separators) of ``location`` relative
         to ``root_location`. Both locations are absolute native locations.
         The returned path has no leading and trailing slashes.  The first segment

src/commoncode/testcase.py

@@ -69,16 +69,15 @@ def get_test_loc(
 
     if not path.exists(test_data_dir):
         raise IOError(
-            "[Errno 2] No such directory: test_data_dir not found:"
-            " '%(test_data_dir)s'" % locals()
+            "[Errno 2] No such directory: test_data_dir not found: '%(test_data_dir)s'" % locals()
         )
 
     tpath = to_os_native_path(test_path)
     test_loc = path.abspath(path.join(test_data_dir, tpath))
 
     if must_exist and not path.exists(test_loc):
         raise IOError(
-            "[Errno 2] No such file or directory: " "test_path not found: '%(test_loc)s'" % locals()
+            "[Errno 2] No such file or directory: test_path not found: '%(test_loc)s'" % locals()
         )
 
     return test_loc

src/commoncode/text.py

@@ -27,7 +27,7 @@
 
 
 def lines(s):
-    """
+    r"""
     Split a string in lines using the following conventions:
     - a line ending \r\n or \n is a separator and yields a new list element
     - empty lines or lines with only white spaces are not returned.
@@ -54,7 +54,7 @@ def nopunc():
 
 def nopunctuation(text):
     """
-    Replaces any non alphanum symbol (i.e. punctuation) in text with space.
+    Replace any non alphanum symbol (i.e. punctuation) in text with space.
     Preserve the characters offsets by replacing punctuation with spaces.
     Warning: this also drops line endings.
     """
@@ -81,7 +81,7 @@ def unixlinesep(text, preserve=False):
 
 def nolinesep(text):
     """
-    Removes line separators, replacing them with spaces.
+    Remove line separators, replacing them with spaces.
     """
     if not isinstance(text, str):
         text = as_unicode(text)