Use parent dir basename as Package name

JonoYang · JonoYang · commit 6894fc8190d2 · 2021-04-05T12:38:57.000-07:00
* If no package name is detected in a README.* file, then use the parent directory basename as the package name
    * Update tests

Signed-off-by: Jono Yang &lt;jyang@nexb.com&gt;
diff --git a/src/packagedcode/readme.py b/src/packagedcode/readme.py
@@ -82,7 +82,16 @@ def parse(location):
     with open(location, encoding='utf-8') as loc:
         readme_manifest = loc.read()
 
-    return build_package(readme_manifest)
+    package = build_package(readme_manifest)
+
+    if not package.name:
+        # If no name was detected for the Package, then we use the basename of
+        # the parent directory as the Package name
+        parent_dir = fileutils.parent_directory(location)
+        parent_dir_basename = fileutils.file_base_name(parent_dir)
+        package.name = parent_dir_basename
+
+    return package
 
 
 def build_package(readme_manifest):
@@ -97,7 +106,7 @@ def build_package(readme_manifest):
 
         if not key or not value:
             continue
- 
+
         # Map the key, value pairs to the Package
         key, value = key.lower(), value.strip()
         if key in README_MAPPING['name']:
diff --git a/tests/packagedcode/data/readme/facebook/basic/README.facebook b/tests/packagedcode/data/readme/facebook/basic/README.facebook
@@ -1,4 +1,5 @@
 Project URL: https://pypi.python.org/packages/source/s/setuptools/setuptools-18.5.tar.gz#md5=533c868f01169a3085177dffe5e768bb
+Project: setuptools
 Version: 18.5
 License: PSF or ZPL
 Local modifications: kept only pkg_resources & _markerlib modules
diff --git a/tests/packagedcode/data/readme/facebook/basic/README.facebook.expected b/tests/packagedcode/data/readme/facebook/basic/README.facebook.expected
@@ -1,7 +1,7 @@
 {
   "type": "readme",
   "namespace": null,
-  "name": null,
+  "name": "setuptools",
   "version": "18.5",
   "qualifiers": {},
   "subpath": null,
@@ -28,7 +28,7 @@
   "dependencies": [],
   "contains_source_code": null,
   "source_packages": [],
-  "purl": null,
+  "purl": "pkg:readme/setuptools@18.5",
   "repository_homepage_url": null,
   "repository_download_url": null,
   "api_data_url": null
diff --git a/tests/packagedcode/data/readme/facebook/capital-filename/README.FACEBOOK b/tests/packagedcode/data/readme/facebook/capital-filename/README.FACEBOOK
@@ -1,4 +1,5 @@
 Project URL: https://pypi.python.org/packages/source/s/setuptools/setuptools-18.5.tar.gz#md5=533c868f01169a3085177dffe5e768bb
+Project: setuptools
 Version: 18.5
 License: PSF or ZPL
 Local modifications: kept only pkg_resources & _markerlib modules
diff --git a/tests/packagedcode/data/readme/facebook/capital-filename/README.FACEBOOK.expected b/tests/packagedcode/data/readme/facebook/capital-filename/README.FACEBOOK.expected
@@ -1,7 +1,7 @@
 {
   "type": "readme",
   "namespace": null,
-  "name": null,
+  "name": "setuptools",
   "version": "18.5",
   "qualifiers": {},
   "subpath": null,
@@ -28,7 +28,7 @@
   "dependencies": [],
   "contains_source_code": null,
   "source_packages": [],
-  "purl": null,
+  "purl": "pkg:readme/setuptools@18.5",
   "repository_homepage_url": null,
   "repository_download_url": null,
   "api_data_url": null
diff --git a/tests/packagedcode/data/readme/facebook/missing-type/README.facebook.expected b/tests/packagedcode/data/readme/facebook/missing-type/README.facebook.expected
@@ -1,7 +1,7 @@
 {
   "type": "readme",
   "namespace": null,
-  "name": null,
+  "name": "missing-type",
   "version": null,
   "qualifiers": {},
   "subpath": null,
@@ -28,7 +28,7 @@
   "dependencies": [],
   "contains_source_code": null,
   "source_packages": [],
-  "purl": null,
+  "purl": "pkg:readme/missing-type",
   "repository_homepage_url": null,
   "repository_download_url": null,
   "api_data_url": null
diff --git a/tests/packagedcode/data/readme/facebook/use-parent-dir-name-as-package-name/setuptools/README.facebook b/tests/packagedcode/data/readme/facebook/use-parent-dir-name-as-package-name/setuptools/README.facebook
@@ -0,0 +1,4 @@
+Project URL: https://pypi.python.org/packages/source/s/setuptools/setuptools-18.5.tar.gz#md5=533c868f01169a3085177dffe5e768bb
+Version: 18.5
+License: PSF or ZPL
+Local modifications: kept only pkg_resources & _markerlib modules
diff --git a/tests/packagedcode/data/readme/facebook/use-parent-dir-name-as-package-name/setuptools/README.facebook.expected b/tests/packagedcode/data/readme/facebook/use-parent-dir-name-as-package-name/setuptools/README.facebook.expected
@@ -0,0 +1,35 @@
+{
+  "type": "readme",
+  "namespace": null,
+  "name": "setuptools",
+  "version": "18.5",
+  "qualifiers": {},
+  "subpath": null,
+  "primary_language": null,
+  "description": null,
+  "release_date": null,
+  "parties": [],
+  "keywords": [],
+  "homepage_url": "https://pypi.python.org/packages/source/s/setuptools/setuptools-18.5.tar.gz#md5=533c868f01169a3085177dffe5e768bb",
+  "download_url": null,
+  "size": null,
+  "sha1": null,
+  "md5": null,
+  "sha256": null,
+  "sha512": null,
+  "bug_tracking_url": null,
+  "code_view_url": null,
+  "vcs_url": null,
+  "copyright": null,
+  "license_expression": "unknown",
+  "declared_license": "PSF or ZPL",
+  "notice_text": null,
+  "root_path": null,
+  "dependencies": [],
+  "contains_source_code": null,
+  "source_packages": [],
+  "purl": "pkg:readme/setuptools@18.5",
+  "repository_homepage_url": null,
+  "repository_download_url": null,
+  "api_data_url": null
+}
diff --git a/tests/packagedcode/data/readme/google/basic/README.google b/tests/packagedcode/data/readme/google/basic/README.google
@@ -1,4 +1,5 @@
 URL: https://github.com/dcurrie/lunit
+Name: lunit
 Version: 0.5
 License: MIT
 License File: LICENSE
diff --git a/tests/packagedcode/data/readme/google/basic/README.google.expected b/tests/packagedcode/data/readme/google/basic/README.google.expected
@@ -1,7 +1,7 @@
 {
   "type": "readme",
   "namespace": null,
-  "name": null,
+  "name": "lunit",
   "version": "0.5",
   "qualifiers": {},
   "subpath": null,
@@ -28,7 +28,7 @@
   "dependencies": [],
   "contains_source_code": null,
   "source_packages": [],
-  "purl": null,
+  "purl": "pkg:readme/lunit@0.5",
   "repository_homepage_url": null,
   "repository_download_url": null,
   "api_data_url": null
diff --git a/tests/packagedcode/test_readme.py b/tests/packagedcode/test_readme.py
@@ -10,7 +10,7 @@
 import os.path
 import saneyaml
 
-from packagedcode import readme 
+from packagedcode import readme
 from packages_test_utils import PackageTester
 
 
@@ -21,13 +21,13 @@ def test_parse_facebook_downloaded_from_as_download_url(self):
         test_file = self.get_test_loc('readme/facebook/downloaded-from-as-download_url/README.facebook')
         expected_loc = self.get_test_loc('readme/facebook/downloaded-from-as-download_url/README.facebook.expected')
         package = readme.parse(test_file)
-        self.check_package(package, expected_loc, regen=True)
+        self.check_package(package, expected_loc, regen=False)
 
     def test_parse_facebook_download_link_as_download_url(self):
         test_file = self.get_test_loc('readme/facebook/download-link-as-download_url/README.facebook')
         expected_loc = self.get_test_loc('readme/facebook/download-link-as-download_url/README.facebook.expected')
         package = readme.parse(test_file)
-        self.check_package(package, expected_loc, regen=True)
+        self.check_package(package, expected_loc, regen=False)
 
     def test_parse_facebook_source_as_homepage_url(self):
         test_file = self.get_test_loc('readme/facebook/repo-as-homepage_url/README.facebook')
@@ -65,6 +65,12 @@ def test_parse_facebook_capitalized_filename(self):
         package = readme.parse(test_file)
         self.check_package(package, expected_loc, regen=False)
 
+    def test_parse_facebook_use_parent_dir_name_as_package_name_if_no_package_name_detected(self):
+        test_file = self.get_test_loc('readme/facebook/use-parent-dir-name-as-package-name/setuptools/README.facebook')
+        expected_loc = self.get_test_loc('readme/facebook/use-parent-dir-name-as-package-name/setuptools/README.facebook.expected')
+        package = readme.parse(test_file)
+        self.check_package(package, expected_loc, regen=False)
+
     def test_parse_thirdparty_basic(self):
         test_file = self.get_test_loc('readme/thirdparty/basic/README.thirdparty')
         expected_loc = self.get_test_loc('readme/thirdparty/basic/README.thirdparty.expected')

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`URL: https://github.com/dcurrie/lunit`
	`2`	`+Name: lunit`
`2`	`3`	`Version: 0.5`
`3`	`4`	`License: MIT`
`4`	`5`	`License File: LICENSE`