Fix spelling and some docstring improvements

Signed-off-by: John Vandenberg <[email protected]>

Author: jayvdb

Diff for: README.md

@@ -18,7 +18,7 @@ This library implements SPDX parsers, convertors, validators and handlers in Pyt
 
 - Home: https://github.com/spdx/tools-python
 - Issues: https://github.com/spdx/tools-python/issues
-- Pypi: https://pypi.python.org/pypi/spdx-tools
+- PyPI: https://pypi.python.org/pypi/spdx-tools
 
 
 # History

Diff for: spdx/creationinfo.py

@@ -19,15 +19,15 @@
 @total_ordering
 class Creator(object):
     """
-    Creator enity.
+    Creator entity.
     Fields:
     - name: creator's name/identifier
     """
 
     def __init__(self, name):
         self.name = name
 
-    # FIXME: do not overrride eq and not hash
+    # FIXME: do not override eq and not hash
     def __eq__(self, other):
         return isinstance(other, Creator) and self.name == other.name
 
@@ -48,7 +48,7 @@ def __init__(self, name, email=None):
         super(Organization, self).__init__(name)
         self.email = email
 
-    # FIXME: do not overrride eq and not hash
+    # FIXME: do not override eq and not hash
     def __eq__(self, other):
         return isinstance(other, Organization) and (self.name, self.email) == (
             other.name,
@@ -84,7 +84,7 @@ def __init__(self, name, email=None):
         super(Person, self).__init__(name)
         self.email = email
 
-    # FIXME: do not overrride eq and not hash
+    # FIXME: do not override eq and not hash
     def __eq__(self, other):
         return isinstance(other, Person) and (self.name, self.email) == (
             other.name,

Diff for: spdx/document.py

@@ -101,7 +101,7 @@ def from_identifier(cls, identifier):
     @classmethod
     def from_full_name(cls, full_name):
         """
-        Returna new License for a full_name. If the full_name exists in
+        Return a new License for a full_name. If the full_name exists in
         config.LICENSE_MAP the identifier is retrieved from it.
         Otherwise the identifier is the same as the full_name.
         """
@@ -286,7 +286,7 @@ class Document(object):
     - annotations: SPDX document annotation information, Optional zero or more.
       Type: Annotation.
     - snippet: Snippet information. Optional zero or more. Type: Snippet.
-    - relationships : Relationship between two SPDX elements. Optional zero or more.
+    - relationships: Relationship between two SPDX elements. Optional zero or more.
       Type: Relationship. 
     """
 

Diff for: spdx/package.py

@@ -24,7 +24,7 @@ class Package(object):
     """
     Represent an analyzed Package.
     Fields:
-     - name : Mandatory, string.
+     - name: Mandatory, string.
      - spdx_id: Uniquely identify any element in an SPDX document which may be
      referenced by other elements. Mandatory, one. Type: str.
      - version: Optional, string.
@@ -47,21 +47,21 @@ class Package(object):
      - source_info: Optional string.
      - conc_lics: Mandatory spdx.document.License or spdx.utils.SPDXNone or
      - spdx.utils.NoAssert.
-     - license_declared : Mandatory spdx.document.License or spdx.utils.SPDXNone or
-     - spdx.utils.NoAssert.
-     - license_comment  : optional string.
+     - license_declared: Mandatory spdx.document.License or spdx.utils.SPDXNone or
+     spdx.utils.NoAssert.
+     - license_comment: optional string.
      - licenses_from_files: list of spdx.document.License or spdx.utils.SPDXNone or
      - spdx.utils.NoAssert.
      - cr_text: Copyright text, string , utils.NoAssert or utils.SPDXNone. Mandatory.
      - summary: Optional str.
      - description: Optional str.
      - comment: Comments about the package being described, optional one.
      Type: str
-     - files: List of files in package, atleast one.
-     - verif_exc_files : list of file names excluded from verification code or None.
-     - ext_pkg_refs : External references referenced within the given package.
+     - files: List of files in package, at least one.
+     - verif_exc_files: list of file names excluded from verification code or None.
+     - ext_pkg_refs: External references referenced within the given package.
      Optional, one or many. Type: ExternalPackageRef
-     - attribution_text : optional string.
+     - attribution_text: optional string.
     """
 
     def __init__(

Diff for: spdx/parsers/jsonyamlxml.py

@@ -452,7 +452,7 @@ def parse_relationships(self, relationships):
     def parse_relationship(self, spdxelementid, relationshiptype, relatedspdxelement):
         """
         Parse Relationshiptype, spdxElementId and relatedSpdxElement
-        - relationship : Python str/unicode
+        - relationship: Python str/unicode
         """
         if isinstance(relationshiptype, str):
             relate = spdxelementid + " " + relationshiptype + " " + relatedspdxelement
@@ -555,7 +555,7 @@ def parse_snippet_comment(self, snippet_comment):
     def parse_snippet_attribution_text(self, snippet_attribution_texts):
         """
         Parse Snippet attribution texts
-        - snippet_attribution_texts : list in yaml, json and string in xml format
+        - snippet_attribution_texts: list in yaml, json and string in xml format
         """
         if isinstance(snippet_attribution_texts, list) or isinstance(
             snippet_attribution_texts, str
@@ -882,7 +882,7 @@ def parse_file_license_comments(self, license_comments):
     def parse_file_attribution_text(self, file_attribution_texts):
         """
         Parse File attribution texts
-        - file_attribution_texts : list in yaml, json and string in xml format
+        - file_attribution_texts: list in yaml, json and string in xml format
         """
         if isinstance(file_attribution_texts, list) or isinstance(
             file_attribution_texts, str
@@ -1357,7 +1357,7 @@ def parse_pkg_license_info_from_files(self, license_info_from_files):
     def parse_pkg_attribution_text(self, pkg_attribution_texts):
         """
         Parse Package attribution texts
-        - pkg_attribution_texts : list in yaml, json and string in xml format
+        - pkg_attribution_texts: list in yaml, json and string in xml format
         """
         if isinstance(pkg_attribution_texts, list) or isinstance(
             pkg_attribution_texts, str
@@ -1579,7 +1579,7 @@ def parse(self):
 
         validation_messages = ErrorMessages()
         # Report extra errors if self.error is False otherwise there will be
-        # redundent messages
+        # redundant messages
         validation_messages = self.document.validate(validation_messages)
         if not self.error:
             if validation_messages:

Diff for: spdx/parsers/loggers.py

@@ -30,7 +30,7 @@ def __init__(self):
         self.context = []
 
     def push_context(self, context):
-        """push some context information to better indentify where is the problem"""
+        """push some context information to better identify where is the problem"""
         self.context.append(context)
 
     def pop_context(self):

Diff for: spdx/parsers/parse_anything.py

@@ -22,14 +22,14 @@
 
 
 def parse_file(fn):
-    buildermodule = jsonyamlxmlbuilders
+    builder_module = jsonyamlxmlbuilders
     read_data = False
     if fn.endswith(".rdf") or fn.endswith(".rdf.xml"):
         parsing_module = rdf
-        buildermodule = rdfbuilders
+        builder_module = rdfbuilders
     elif fn.endswith(".tag") or fn.endswith(".spdx"):
         parsing_module = tagvalue
-        buildermodule = tagvaluebuilders
+        builder_module = tagvaluebuilders
         read_data = True
     elif fn.endswith(".json"):
         parsing_module = jsonparser
@@ -40,7 +40,7 @@ def parse_file(fn):
     else:
         raise FileTypeError("FileType Not Supported" + str(fn))
 
-    p = parsing_module.Parser(buildermodule.Builder(), StandardLogger())
+    p = parsing_module.Parser(builder_module.Builder(), StandardLogger())
     if hasattr(p, "build"):
         p.build()
     with open(fn) as f:

Diff for: spdx/parsers/rdf.py

@@ -43,7 +43,7 @@
     "PKG_DOWN_LOC": "Invalid package download location value '{0}'  must be a url or NONE or NOASSERTION",
     "PKG_FILES_ANALYZED_VALUE": "FilesAnalyzed must be a boolean value, line: {0}",
     "PKG_CONC_LIST": "Package concluded license list must have more than one member",
-    "LICS_LIST_MEMBER": "Declaritive or Conjunctive license set member must be a license url or identifier",
+    "LICS_LIST_MEMBER": "Declarative or Conjunctive license set member must be a license url or identifier",
     "PKG_SINGLE_LICS": "Package concluded license must be a license url or spdx:noassertion or spdx:none.",
     "PKG_LICS_INFO_FILES": "Package licenseInfoFromFiles must be a license or spdx:none or spdx:noassertion",
     "FILE_SPDX_ID_VALUE": 'SPDXID must be "SPDXRef-[idstring]" where [idstring] is a unique string containing '
@@ -159,43 +159,43 @@ def get_extr_license_ident(self, extr_lic):
         """
         Return a license identifier from an ExtractedLicense or None.
         """
-        identifier_tripples = list(
+        identifier_triples = list(
             self.graph.triples((extr_lic, self.spdx_namespace["licenseId"], None))
         )
 
-        if not identifier_tripples:
+        if not identifier_triples:
             self.error = True
             msg = "Extracted license must have licenseId property."
             self.logger.log(msg)
             return
 
-        if len(identifier_tripples) > 1:
-            self.more_than_one_error("extracted license identifier_tripples")
+        if len(identifier_triples) > 1:
+            self.more_than_one_error("extracted license identifier_triples")
             return
 
-        identifier_tripple = identifier_tripples[0]
-        _s, _p, identifier = identifier_tripple
+        identifier_triple = identifier_triples[0]
+        _s, _p, identifier = identifier_triple
         return str(identifier)
 
     def get_extr_license_text(self, extr_lic):
         """
         Return extracted text from an ExtractedLicense or None.
         """
-        text_tripples = list(
+        text_triples = list(
             self.graph.triples((extr_lic, self.spdx_namespace["extractedText"], None))
         )
-        if not text_tripples:
+        if not text_triples:
             self.error = True
             msg = "Extracted license must have extractedText property"
             self.logger.log(msg)
             return
 
-        if len(text_tripples) > 1:
+        if len(text_triples) > 1:
             self.more_than_one_error("extracted license text")
             return
 
-        text_tripple = text_tripples[0]
-        _s, _p, text = text_tripple
+        text_triple = text_triples[0]
+        _s, _p, text = text_triple
         return str(text)
 
     def get_extr_lic_name(self, extr_lic):
@@ -250,7 +250,7 @@ def parse_only_extr_license(self, extr_lic):
             return
 
         # Set fields
-        # FIXME: the constructor of the license should alwas accept a name
+        # FIXME: the constructor of the license should always accept a name
         lic = document.ExtractedLicense(ident)
         if text is not None:
             lic.text = text
@@ -318,7 +318,7 @@ def parse_package(self, p_term):
         """
         Parse package fields.
         """
-        # Check there is a pacakge name
+        # Check there is a package name
         if not (p_term, self.spdx_namespace["name"], None) in self.graph:
             self.error = True
             self.logger.log("Package must have a name.")
@@ -478,7 +478,7 @@ def p_pkg_verif_code(self, p_term, predicate):
                 try:
                     self.builder.set_pkg_verif_code(self.doc, str(code))
                 except CardinalityError:
-                    self.more_than_one_error("package verificaton code")
+                    self.more_than_one_error("package verification code")
                     break
             # Parse excluded file
             for _, _, filename in self.graph.triples(
@@ -491,7 +491,7 @@ def p_pkg_verif_code(self, p_term, predicate):
                 try:
                     self.builder.set_pkg_excl_file(self.doc, str(filename))
                 except CardinalityError:
-                    self.more_than_one_error("package verificaton code excluded file")
+                    self.more_than_one_error("package verification code excluded file")
                     break
 
     def p_pkg_src_info(self, p_term, predicate):
@@ -979,7 +979,7 @@ def get_review_date(self, r_term):
         )
         if len(reviewed_list) != 1:
             self.error = True
-            msg = "Review must have exactlyone review date"
+            msg = "Review must have exactly one review date"
             self.logger.log(msg)
             return
         return str(reviewed_list[0][2])

Diff for: spdx/parsers/tagvalue.py

@@ -92,7 +92,7 @@
     "FILE_CONTRIB_VALUE": "FileContributor must be a single line, line: {0}",
     "FILE_DEP_VALUE": "FileDependency must be a single line, line: {0}",
     "ART_PRJ_NAME_VALUE": "ArtifactOfProjectName must be a single line, line: {0}",
-    "FILE_ART_OPT_ORDER": "ArtificatOfProjectHomePage and ArtificatOfProjectURI must immediatly follow ArtifactOfProjectName, line: {0}",
+    "FILE_ART_OPT_ORDER": "ArtificatOfProjectHomePage and ArtificatOfProjectURI must immediately follow ArtifactOfProjectName, line: {0}",
     "ART_PRJ_HOME_VALUE": "ArtificatOfProjectHomePage must be a URL or UNKNOWN, line: {0}",
     "ART_PRJ_URI_VALUE": "ArtificatOfProjectURI must be a URI or UNKNOWN, line: {0}",
     "UNKNOWN_TAG": "Found unknown tag : {0} at line: {1}",
@@ -310,7 +310,7 @@ def p_extr_lic_id_2(self, p):
         msg = ERROR_MESSAGES["LICS_ID_VALUE"].format(p.lineno(1))
         self.logger.log(msg)
 
-    def p_uknown_tag(self, p):
+    def p_unknown_tag(self, p):
         """unknown_tag : UNKNOWN_TAG LINE"""
         self.error = True
         msg = ERROR_MESSAGES["UNKNOWN_TAG"].format(p[1], p.lineno(1))
@@ -322,7 +322,7 @@ def p_file_artifact_1(self, p):
         """
         pass
 
-    def p_file_artificat_2(self, p):
+    def p_file_artifact_2(self, p):
         """file_artifact : prj_name_art error"""
         self.error = True
         msg = ERROR_MESSAGES["FILE_ART_OPT_ORDER"].format(p.lineno(2))

Diff for: spdx/parsers/tagvaluebuilders.py

@@ -233,7 +233,7 @@ def build_org(self, doc, entity):
         """
         Build an organization object of of a string representation.
         Return built organization.
-        Raise SPDXValueError if failed to extractname.
+        Raise SPDXValueError if failed to extract name.
         """
         match = self.org_re.match(entity)
         if match and validations.validate_org_name(match.group(self.ORG_NAME_GROUP)):
@@ -359,7 +359,7 @@ def reset_reviews(self):
     def add_reviewer(self, doc, reviewer):
         """
         Adds a reviewer to the SPDX Document.
-        Reviwer is an entity created by an EntityBuilder.
+        Reviewer is an entity created by an EntityBuilder.
         Raise SPDXValueError if not a valid reviewer type.
         """
         # Each reviewer marks the start of a new review object.
@@ -644,7 +644,7 @@ def set_pkg_file_name(self, doc, name):
         Set the package file name, if not already set.
         name - Any string.
         Raise CardinalityError if already has a file_name.
-        Raise OrderError if no pacakge previously defined.
+        Raise OrderError if no package previously defined.
         """
         self.assert_package_exists()
         if not self.package_file_name_set:
@@ -800,7 +800,7 @@ def set_pkg_source_info(self, doc, text):
                 doc.packages[-1].source_info = str_from_text(text)
                 return True
             else:
-                raise SPDXValueError("Pacckage::SourceInfo")
+                raise SPDXValueError("Package::SourceInfo")
         else:
             raise CardinalityError("Package::SourceInfo")
 
@@ -1248,13 +1248,13 @@ def add_file_dep(self, doc, value):
 
     def set_file_atrificat_of_project(self, doc, symbol, value):
         """
-        Set a file name, uri or home artificat.
+        Set a file name, uri or home artifact.
         Raise OrderError if no package or file defined.
         """
         if self.has_package(doc) and self.has_file(doc):
             self.file(doc).add_artifact(symbol, value)
         else:
-            raise OrderError("File::Artificat")
+            raise OrderError("File::Artifact")
 
     def file(self, doc):
         """

Diff for: spdx/relationship.py

@@ -75,7 +75,7 @@ class Relationship(object):
     Document relationship information
     Fields:
     - relationship:  provides information about the relationship between two SPDX elements.
-    - relationship_comment :  place for the SPDX file creator to record any general comments. Optional, One
+    - relationship_comment:  place for the SPDX file creator to record any general comments. Optional, One
     """
 
     def __init__(self, relationship=None, relationship_comment=None):

Diff for: spdx/snippet.py

@@ -27,15 +27,14 @@ class Snippet(object):
      in to arriving at the Concluded License for a snippet. Optional, one.
      - snip_from_file_spdxid:  Uniquely identify the file in an SPDX document
      which this snippet is associated with. Mandatory, one. Type: str.
-     Type: str.
      - conc_lics: Contains the license the SPDX file creator has concluded as
      governing the snippet or alternative values if the governing license
      cannot be determined. Mandatory one. Type: document.License or
      utils.NoAssert or utils.SPDXNone.
      - licenses_in_snippet: The list of licenses found in the snippet.
      Mandatory, one or more. Type: document.License or utils.SPDXNone or
      utils.NoAssert.
-     - attribution_text : optional string.
+     - attribution_text: optional string.
     """
 
     def __init__(