Merge branch 'main' into patch-1

Author: pombredanne

NOTICE

@@ -2,6 +2,6 @@
 # Copyright (c) nexB Inc. and others. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 # See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
-# See https://github.com/nexB/commoncode for support or download.
+# See https://github.com/aboutcode-org/commoncode for support or download.
 # See https://aboutcode.org for more information about nexB OSS projects.
 #

README.rst

@@ -3,12 +3,12 @@ CommonCode
 
 - license: Apache-2.0
 - copyright: copyright (c) nexB. Inc. and others
-- homepage_url: https://github.com/nexB/commoncode
+- homepage_url: https://github.com/aboutcode-org/commoncode
 - keywords: utilities, scancode-toolkit, commoncode
 
 Commoncode provides a set of common functions and utilities for handling various things like paths,
 dates, files and hashes. It started as library in scancode-toolkit.
-Visit https://aboutcode.org and https://github.com/nexB/ for support and download.
+Visit https://aboutcode.org and https://github.com/aboutcode-org/ for support and download.
 
 
 To install this package use::

azure-pipelines.yml

@@ -1,118 +1,99 @@
-
 ################################################################################
 # We use Azure to run the full tests suites on multiple Python 3.x
 # on multiple Windows, macOS and Linux versions all on 64 bits
 # These jobs are using VMs with Azure-provided Python builds
 ################################################################################
 
 jobs:
-
-################################################################################
-# These jobs are using VMs and Azure-provided Pythons 3.8
-################################################################################
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: ubuntu20_cpython
-          image_name: ubuntu-20.04
-          python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: ubuntu22_cpython
-          image_name: ubuntu-22.04
-          python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: macos11_cpython
-          image_name: macOS-11
-          python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: macos12_cpython
-          image_name: macOS-12
-          python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: macos13_cpython
-          image_name: macOS-13
-          python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11']
-          test_suites:
-              all: venv/bin/pytest -n 2 -vvs
-
-    - template: etc/ci/azure-win.yml
-      parameters:
-          job_name: win2019_cpython
-          image_name: windows-2019
-          python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11']
-          test_suites:
-              all: venv\Scripts\pytest -n 2 -vvs
-
-    - template: etc/ci/azure-win.yml
-      parameters:
-          job_name: win2022_cpython
-          image_name: windows-2022
-          python_versions: ['3.7', '3.8', '3.9', '3.10', '3.11']
-          test_suites:
-              all: venv\Scripts\pytest -n 2 -vvs
-
-
-################################################################################
-# Test using many version of Click to work around regressions in API
-################################################################################
-
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: ubuntu20_test_all_supported_click_versions
-          image_name: ubuntu-20.04
-          python_versions: ['3.7', '3.8', '3.9', '3.10']
-          test_suites:
-              click_versions: |
-                for clk_ver in 8.1.3 8.1.2 8.1.1 8.1.0 8.0.4 8.0.2 8.0.3 8.0.1 7.1.2 7.1.1 7.1 6.7;
-                  do
-                    pip install click==$clk_ver;
-                    venv/bin/pytest -vvs tests/test_cliutils_progressbar.py;
-                  done
-
-
-################################################################################
-# Tests using a plain pip install to get the latest of all wheels
-################################################################################
-
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: ubuntu20_cpython_latest_from_pip
-          image_name: ubuntu-20.04
-          python_versions: ['3.7', '3.8', '3.9', '3.10']
-          test_suites:
-              all: venv/bin/pip install --upgrade-strategy eager --force-reinstall --upgrade -e . && venv/bin/pytest -n 2 -vvs
-
-
-    - template: etc/ci/azure-win.yml
-      parameters:
-          job_name: win2019_cpython_latest_from_pip
-          image_name: windows-2019
-          python_versions: ['3.7', '3.8', '3.9', '3.10']
-          test_suites:
-              all: venv\Scripts\pip install --upgrade-strategy eager --force-reinstall --upgrade -e . &&  venv\Scripts\pytest -n 2 -vvs
-
-    - template: etc/ci/azure-posix.yml
-      parameters:
-          job_name: macos11_cpython_latest_from_pip
-          image_name: macos-11
-          python_versions: ['3.7', '3.8', '3.9', '3.10']
-          test_suites:
-              all: venv/bin/pip install --upgrade-strategy eager --force-reinstall --upgrade -e . && venv/bin/pytest -n 2 -vvs
+  ################################################################################
+  # These jobs are using VMs and Azure-provided Pythons 3.8
+  ################################################################################
+
+  - template: etc/ci/azure-posix.yml
+    parameters:
+      job_name: ubuntu20_cpython
+      image_name: ubuntu-20.04
+      python_versions: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+      test_suites:
+        all: venv/bin/pytest -n 2 -vvs
+
+  - template: etc/ci/azure-posix.yml
+    parameters:
+      job_name: ubuntu22_cpython
+      image_name: ubuntu-22.04
+      python_versions: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+      test_suites:
+        all: venv/bin/pytest -n 2 -vvs
+
+  - template: etc/ci/azure-posix.yml
+    parameters:
+      job_name: macos12_cpython
+      image_name: macOS-12
+      python_versions: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+      test_suites:
+        all: venv/bin/pytest -n 2 -vvs
+
+  - template: etc/ci/azure-posix.yml
+    parameters:
+      job_name: macos13_cpython
+      image_name: macOS-13
+      python_versions: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+      test_suites:
+        all: venv/bin/pytest -n 2 -vvs
+
+  - template: etc/ci/azure-win.yml
+    parameters:
+      job_name: win2019_cpython
+      image_name: windows-2019
+      python_versions: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+      test_suites:
+        all: venv\Scripts\pytest -n 2 -vvs
+
+  - template: etc/ci/azure-win.yml
+    parameters:
+      job_name: win2022_cpython
+      image_name: windows-2022
+      python_versions: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+      test_suites:
+        all: venv\Scripts\pytest -n 2 -vvs
+
+  ################################################################################
+  # Test using many version of Click to work around regressions in API
+  ################################################################################
+
+  - template: etc/ci/azure-posix.yml
+    parameters:
+      job_name: ubuntu20_test_all_supported_click_versions
+      image_name: ubuntu-20.04
+      python_versions: ["3.7", "3.8", "3.9", "3.10"]
+      test_suites:
+        click_versions: |
+          for clk_ver in 8.1.3 8.1.2 8.1.1 8.1.0 8.0.4 8.0.2 8.0.3 8.0.1 7.1.2 7.1.1 7.1 6.7;
+            do
+              pip install click==$clk_ver;
+              venv/bin/pytest -vvs tests/test_cliutils_progressbar.py;
+            done
+
+  ################################################################################
+  # Tests using a plain pip install to get the latest of all wheels
+  ################################################################################
+
+  - template: etc/ci/azure-posix.yml
+    parameters:
+      job_name: ubuntu20_cpython_latest_from_pip
+      image_name: ubuntu-20.04
+      python_versions: ["3.7", "3.8", "3.9", "3.10"]
+      test_suites:
+        all:
+          venv/bin/pip install --upgrade-strategy eager --force-reinstall
+          --upgrade -e . && venv/bin/pytest -n 2 -vvs
+
+  - template: etc/ci/azure-win.yml
+    parameters:
+      job_name: win2019_cpython_latest_from_pip
+      image_name: windows-2019
+      python_versions: ["3.7", "3.8", "3.9", "3.10"]
+      test_suites:
+        all:
+          venv\Scripts\pip install --upgrade-strategy eager --force-reinstall
+          --upgrade -e . &&  venv\Scripts\pytest -n 2 -vvs

commoncode.ABOUT

@@ -4,10 +4,10 @@ description: Commoncode provides a set of common functions and utilities for
  handling various things like paths, dates, files and hashes. It started as
  library in scancode-toolkit.
 keywords: utilities, commoncode, scancode-toolkit
-homepage_url: https://github.com/nexB/commoncode
+homepage_url: https://github.com/aboutcode-org/commoncode
 holder: nexB. Inc. and others
 holder_contact: [email protected]
-homepage_url: https://github.com/nexB/commoncode
+homepage_url: https://github.com/aboutcode-org/commoncode
 license_expression: apache-2.0
 name: commoncode
 package_url: pkg:pypi/commoncode

configure

@@ -3,7 +3,7 @@
 # Copyright (c) nexB Inc. and others. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 # See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
-# See https://github.com/nexB/ for support or download.
+# See https://github.com/aboutcode-org/ for support or download.
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
 

configure.bat

@@ -4,7 +4,7 @@
 @rem Copyright (c) nexB Inc. and others. All rights reserved.
 @rem SPDX-License-Identifier: Apache-2.0
 @rem See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
-@rem See https://github.com/nexB/ for support or download.
+@rem See https://github.com/aboutcode-org/ for support or download.
 @rem See https://aboutcode.org for more information about nexB OSS projects.
 
 

setup.cfg

@@ -15,7 +15,7 @@ license = Apache-2.0
 description = Set of common utilities, originally split from ScanCode
 long_description = file:README.rst
 long_description_content_type = text/x-rst
-url = https://github.com/nexB/commoncode
+url = https://github.com/aboutcode-org/commoncode
 classifiers =
     Development Status :: 5 - Production/Stable
     Intended Audience :: Developers

src/commoncode/__init__.py

@@ -2,7 +2,7 @@
 # Copyright (c) nexB Inc. and others. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 # See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
-# See https://github.com/nexB/commoncode for support or download.
+# See https://github.com/aboutcode-org/commoncode for support or download.
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
 

src/commoncode/archive.py

@@ -2,7 +2,7 @@
 # Copyright (c) nexB Inc. and others. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 # See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
-# See https://github.com/nexB/commoncode for support or download.
+# See https://github.com/aboutcode-org/commoncode for support or download.
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
 

src/commoncode/cliutils.py

@@ -2,7 +2,7 @@
 # Copyright (c) nexB Inc. and others. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 # See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
-# See https://github.com/nexB/commoncode for support or download.
+# See https://github.com/aboutcode-org/commoncode for support or download.
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
 
@@ -154,18 +154,18 @@ def format_options(self, ctx, formatter):
 
 
 # overriden and copied from Click to work around Click woes for
-# https://github.com/nexB/scancode-toolkit/issues/2583
+# https://github.com/aboutcode-org/scancode-toolkit/issues/2583
 class DebuggedProgressBar(ProgressBar):
 
     # overriden and copied from Click to work around Click woes for
-    # https://github.com/nexB/scancode-toolkit/issues/2583
+    # https://github.com/aboutcode-org/scancode-toolkit/issues/2583
     def make_step(self, n_steps):
         # always increment
         self.pos += n_steps or 1
         super(DebuggedProgressBar, self).make_step(n_steps)
 
     # overriden and copied from Click to work around Click woes for
-    # https://github.com/nexB/scancode-toolkit/issues/2583
+    # https://github.com/aboutcode-org/scancode-toolkit/issues/2583
     def generator(self):
         if self.is_hidden:
             yield from self.iter
@@ -290,7 +290,7 @@ def progressmanager(
     # Click 8. See https://github.com/pallets/click/pull/1698
     # Note that we use this argument on Click 8 in order to fix a regression
     # that this same PR introduced by Click and tracked originally at
-    # https://github.com/nexB/scancode-toolkit/issues/2583
+    # https://github.com/aboutcode-org/scancode-toolkit/issues/2583
     # Here we create a dummy progress_class and then for the attribute presence.
     pb = progress_class([])
     if hasattr(pb, 'update_min_steps'):
@@ -328,7 +328,7 @@ def fixed_width_file_name(path, max_length=25):
     len_ext = len(ext)
     remaining_length = max_length - len_ext - dots
 
-    if remaining_length < 5  or remaining_length < (len_ext + dots):
+    if remaining_length < 5 or remaining_length < (len_ext + dots):
         return ''
 
     prefix_and_suffix_length = abs(remaining_length // 2)
@@ -473,8 +473,10 @@ def validate_dependencies(self, ctx, value):
         Validate `value` against declared `required_options` or
         `conflicting_options` dependencies.
         """
-        _validate_option_dependencies(ctx, self, value, self.required_options, required=True)
-        _validate_option_dependencies(ctx, self, value, self.conflicting_options, required=False)
+        _validate_option_dependencies(
+            ctx, self, value, self.required_options, required=True)
+        _validate_option_dependencies(
+            ctx, self, value, self.conflicting_options, required=False)
 
     def get_help_record(self, ctx):
         if not self.hidden:
@@ -497,11 +499,13 @@ def validate_option_dependencies(ctx):
             continue
         if not isinstance(param, PluggableCommandLineOption):
             if TRACE:
-                logger_debug('  validate_option_dependencies: skip param:', param)
+                logger_debug(
+                    '  validate_option_dependencies: skip param:', param)
             continue
         value = values.get(param.name)
         if TRACE:
-            logger_debug('  validate_option_dependencies: param:', param, 'value:', value)
+            logger_debug('  validate_option_dependencies: param:',
+                         param, 'value:', value)
         param.validate_dependencies(ctx, value)
 
 
@@ -534,7 +538,7 @@ def _is_set(_value, _param):
     if TRACE:
         logger_debug()
         logger_debug('Checking param:', param)
-        logger_debug('  value:', value, 'is_set:' , is_set)
+        logger_debug('  value:', value, 'is_set:', is_set)
 
     if not is_set:
         return
@@ -582,7 +586,7 @@ def _is_set(_value, _param):
 
         if TRACE:
             logger_debug('    Checking oparam:', oparam)
-            logger_debug('      value:', ovalue, 'ois_set:' , ois_set)
+            logger_debug('      value:', ovalue, 'ois_set:', ois_set)
 
         # by convention the last opt is the long form
         oopt = oparam.opts[-1]
@@ -594,7 +598,7 @@ def _is_set(_value, _param):
                    'You must set all of these options if you use this option.' % locals())
             raise click.UsageError(msg)
 
-        if not required  and ois_set:
+        if not required and ois_set:
             msg = ('The option %(opt)s cannot be used together with the %(oopts)s option(s) '
                    'and %(oopt)s is used. '
                    'You can set only one of these options at a time.' % locals())