Rename dependency attribute is_resolved

Renaming the dependency attribute is_resolved to is_pinned to
more accurately represent this attribute accurately.
This is more relevant after the changes in aboutcode-org/scancode.io#1066

Reference: aboutcode-org/scancode.io#1066
Signed-off-by: Ayan Sinha Mahapatra <[email protected]>

Author: AyanSinhaMahapatra

docs/source/cli-reference/basic-options.rst

@@ -175,7 +175,7 @@
                     "scope": "dependencies",
                     "is_runtime": true,
                     "is_optional": false,
-                    "is_resolved": false,
+                    "is_pinned": false,
                     "resolved_package": {},
                     "extra_data": {},
                     "dependency_uid": "pkg:bower/get-size?uuid=fixed-uid-done-for-testing-5642512d1758",
@@ -341,7 +341,7 @@
                                     "scope": "dependencies",
                                     "is_runtime": true,
                                     "is_optional": false,
-                                    "is_resolved": false,
+                                    "is_pinned": false,
                                     "resolved_package": {},
                                     "extra_data": {}
                                 }

etc/scripts/sch2js/doc/DependentPackage-json-schema.json

@@ -63,7 +63,7 @@
         }
       ]
     }, 
-    "is_resolved": {
+    "is_pinned": {
       "oneOf": [
         {
           "type": "boolean", 

etc/scripts/sch2js/doc/Package-json-schema.json

@@ -455,7 +455,7 @@
                   }
                 ]
               }, 
-              "is_resolved": {
+              "is_pinned": {
                 "oneOf": [
                   {
                     "type": "boolean", 

src/formattedcode/output_cyclonedx.py

@@ -519,7 +519,7 @@ def from_package(cls, package, components_by_purl):
         for dependency in package.get('dependencies', []):
             dpurl = dependency['purl']
 
-            if dependency['is_resolved']:
+            if dependency['is_pinned']:
                 dependencies_by_dependent[purl].add(dpurl)
             else:
                 existing = components_by_purl.get(dpurl)

src/packagedcode/alpine.py

@@ -754,7 +754,7 @@ def parse_apkbuild_text(text, datasource_id, package_type, strict=False, package
     variables, errors = get_apkbuild_variables(text=text)
     unresolved = [
         v for v in variables
-        if not v.is_resolved()
+        if not v.is_pinned()
         and v.name in ESSENTIAL_APKBUILD_VARIABLES
     ]
 
@@ -1014,7 +1014,7 @@ def D_dependencies_handler(value, dependencies=None, **kwargs):
 
         requirement = None
         version = None
-        is_resolved = False
+        is_pinned = False
         segments = split_name_and_requirement(dep)
         if len(segments) == 1:
             # we have no requirement...just a plain name
@@ -1027,7 +1027,7 @@ def D_dependencies_handler(value, dependencies=None, **kwargs):
             operator = ''.join(sorted(operator))
             if operator == '=':
                 version = ver
-                is_resolved = True
+                is_pinned = True
 
             requirement = operator + ver
 
@@ -1042,7 +1042,7 @@ def D_dependencies_handler(value, dependencies=None, **kwargs):
             purl=purl,
             scope=scope,
             extracted_requirement=requirement,
-            is_resolved=is_resolved,
+            is_pinned=is_pinned,
         )
         if dependency not in dependencies:
             dependencies.append(dependency.to_dict())

src/packagedcode/bashparse.py

@@ -144,7 +144,7 @@ class ShellVariable:
     value = attr.ib()
     is_array = attr.ib(default=False, repr=False)
 
-    def is_resolved(self):
+    def is_pinned(self):
         """
         Return True if this variable is fully resolved and does not need further
         shell expansion.
@@ -243,15 +243,15 @@ def reportable(v):
         for var in variables:
 
             if not environment:
-                if reportable(var) and not var.is_resolved():
+                if reportable(var) and not var.is_pinned():
                     errors.append(f'Unresolvable first variable: {var}')
 
                 if not var.is_array:
                     # we do not know how to expand an array
                     environment[var.name] = var.value
                 continue
 
-            if var.is_resolved():
+            if var.is_pinned():
                 if not var.is_array:
                     # we do not know how to expand an array
                     environment[var.name] = var.value
@@ -282,7 +282,7 @@ def reportable(v):
                     # we do not know how to expand an array
                     environment[var.name] = expanded
 
-                if reportable(var) and not var.is_resolved():
+                if reportable(var) and not var.is_pinned():
                     errors.append(
                         f'Partially resolved variable: {var} envt: '
                         f'{environment}'

src/packagedcode/build_gradle.py

@@ -360,7 +360,7 @@ def build_package(cls, dependencies, package_only=False):
                 extracted_requirement=version,
                 is_runtime=is_runtime,
                 is_optional=is_optional,
-                is_resolved=bool(version),
+                is_pinned=bool(version),
             )
         )
 

src/packagedcode/cargo.py

@@ -299,7 +299,7 @@ def parse(cls, location, package_only=False):
                     scope='dependencies',
                     is_runtime=True,
                     is_optional=False,
-                    is_resolved=True,
+                    is_pinned=True,
                 )
             )
 
@@ -346,7 +346,7 @@ def dependency_mapper(dependencies, scope='dependencies'):
             scope=scope,
             is_runtime=is_runtime,
             is_optional=is_optional,
-            is_resolved=False,
+            is_pinned=False,
             extra_data=extra_data,
         )
 

src/packagedcode/cocoapods.py

@@ -345,7 +345,7 @@ def get_pods_dependency_with_resolved_package(
             extracted_requirement=xreq,
             is_runtime=False,
             is_optional=True,
-            is_resolved=True,
+            is_pinned=True,
             is_direct=is_direct,
             resolved_package=resolved_package,
         )
@@ -377,7 +377,7 @@ def get_dependencies_for_resolved_package(cls, dependency_data, dep_pods):
                 extracted_requirement=dep_xreq,
                 is_runtime=False,
                 is_optional=True,
-                is_resolved=True,
+                is_pinned=True,
                 is_direct=True,
             ).to_dict()
             dependencies_for_resolved.append(dependency_for_resolved)

src/packagedcode/conan.py

@@ -282,9 +282,9 @@ def get_dependencies(requires):
     dependent_packages = []
     for req in requires:
         name, constraint = req.split("/", 1)
-        is_resolved = is_constraint_resolved(constraint)
+        is_pinned = is_constraint_resolved(constraint)
         version = None
-        if is_resolved:
+        if is_pinned:
             version = constraint
         purl = PackageURL(type="conan", name=name, version=version)
         dependent_packages.append(
@@ -293,7 +293,7 @@ def get_dependencies(requires):
                 scope="install",
                 is_runtime=True,
                 is_optional=False,
-                is_resolved=is_resolved,
+                is_pinned=is_pinned,
                 extracted_requirement=constraint,
             )
         )