Search is not available for this dataset
text
stringlengths
75
104k
def set_doc_spdx_id(self, doc, doc_spdx_id_line): """Sets the document SPDX Identifier. Raises value error if malformed value, CardinalityError if already defined. """ if not self.doc_spdx_id_set: if doc_spdx_id_line == 'SPDXRef-DOCUMENT': doc.spdx_id ...
def set_doc_comment(self, doc, comment): """Sets document comment, Raises CardinalityError if comment already set. Raises SPDXValueError if comment is not free form text. """ if not self.doc_comment_set: self.doc_comment_set = True if validations.validate_...
def set_doc_namespace(self, doc, namespace): """Sets the document namespace. Raise SPDXValueError if malformed value, CardinalityError if already defined. """ if not self.doc_namespace_set: self.doc_namespace_set = True if validations.validate_doc_namespac...
def reset_document(self): """Resets the state to allow building new documents""" # FIXME: this state does not make sense self.doc_version_set = False self.doc_comment_set = False self.doc_namespace_set = False self.doc_data_lics_set = False self.doc_name_set = Fal...
def set_spdx_doc_uri(self, doc, spdx_doc_uri): """ Sets the `spdx_document_uri` attribute of the `ExternalDocumentRef` object. """ if validations.validate_doc_namespace(spdx_doc_uri): doc.ext_document_references[-1].spdx_document_uri = spdx_doc_uri else: ...
def build_tool(self, doc, entity): """Builds a tool object out of a string representation. Returns built tool. Raises SPDXValueError if failed to extract tool name or name is malformed """ match = self.tool_re.match(entity) if match and validations.validate_tool_name(matc...
def build_org(self, doc, entity): """Builds an organization object of of a string representation. Returns built organization. Raises SPDXValueError if failed to extract name. """ match = self.org_re.match(entity) if match and validations.validate_org_name(match.group(self...
def build_person(self, doc, entity): """Builds an organization object of of a string representation. Returns built organization. Raises SPDXValueError if failed to extract name. """ match = self.person_re.match(entity) if match and validations.validate_person_name(match.g...
def add_creator(self, doc, creator): """Adds a creator to the document's creation info. Returns true if creator is valid. Creator must be built by an EntityBuilder. Raises SPDXValueError if not a creator type. """ if validations.validate_creator(creator): doc....
def set_created_date(self, doc, created): """Sets created date, Raises CardinalityError if created date already set. Raises SPDXValueError if created is not a date. """ if not self.created_date_set: self.created_date_set = True date = utils.datetime_from_i...
def set_creation_comment(self, doc, comment): """Sets creation comment, Raises CardinalityError if comment already set. Raises SPDXValueError if not free form text. """ if not self.creation_comment_set: self.creation_comment_set = True if validations.valid...
def set_lics_list_ver(self, doc, value): """Sets the license list version, Raises CardinalityError if already set, SPDXValueError if incorrect value. """ if not self.lics_list_ver_set: self.lics_list_ver_set = True vers = version.Version.from_str(value) ...
def reset_creation_info(self): """ Resets builder state to allow building new creation info.""" # FIXME: this state does not make sense self.created_date_set = False self.creation_comment_set = False self.lics_list_ver_set = False
def add_reviewer(self, doc, reviewer): """Adds a reviewer to the SPDX Document. Reviwer is an entity created by an EntityBuilder. Raises SPDXValueError if not a valid reviewer type. """ # Each reviewer marks the start of a new review object. # FIXME: this state does not m...
def add_review_date(self, doc, reviewed): """Sets the review date. Raises CardinalityError if already set. OrderError if no reviewer defined before. Raises SPDXValueError if invalid reviewed value. """ if len(doc.reviews) != 0: if not self.review_date_set: ...
def add_review_comment(self, doc, comment): """Sets the review comment. Raises CardinalityError if already set. OrderError if no reviewer defined before. Raises SPDXValueError if comment is not free form text. """ if len(doc.reviews) != 0: if not self.review_comment_s...
def reset_annotations(self): """Resets the builder's state to allow building new annotations.""" # FIXME: this state does not make sense self.annotation_date_set = False self.annotation_comment_set = False self.annotation_type_set = False self.annotation_spdx_id_set = Fal...
def add_annotator(self, doc, annotator): """Adds an annotator to the SPDX Document. Annotator is an entity created by an EntityBuilder. Raises SPDXValueError if not a valid annotator type. """ # Each annotator marks the start of a new annotation object. # FIXME: this stat...
def add_annotation_date(self, doc, annotation_date): """Sets the annotation date. Raises CardinalityError if already set. OrderError if no annotator defined before. Raises SPDXValueError if invalid value. """ if len(doc.annotations) != 0: if not self.annotation_date_s...
def add_annotation_comment(self, doc, comment): """Sets the annotation comment. Raises CardinalityError if already set. OrderError if no annotator defined before. Raises SPDXValueError if comment is not free form text. """ if len(doc.annotations) != 0: if not self.ann...
def add_annotation_type(self, doc, annotation_type): """Sets the annotation type. Raises CardinalityError if already set. OrderError if no annotator defined before. Raises SPDXValueError if invalid value. """ if len(doc.annotations) != 0: if not self.annotation_type_s...
def set_annotation_spdx_id(self, doc, spdx_id): """Sets the annotation SPDX Identifier. Raises CardinalityError if already set. OrderError if no annotator defined before. """ if len(doc.annotations) != 0: if not self.annotation_spdx_id_set: self.annota...
def reset_package(self): """Resets the builder's state in order to build new packages.""" # FIXME: this state does not make sense self.package_set = False self.package_vers_set = False self.package_file_name_set = False self.package_supplier_set = False self.packa...
def create_package(self, doc, name): """Creates a package for the SPDX Document. name - any string. Raises CardinalityError if package already defined. """ if not self.package_set: self.package_set = True doc.package = package.Package(name=name) ...
def set_pkg_vers(self, doc, version): """Sets package version, if not already set. version - Any string. Raises CardinalityError if already has a version. Raises OrderError if no package previously defined. """ self.assert_package_exists() if not self.package_vers...
def set_pkg_file_name(self, doc, name): """Sets the package file name, if not already set. name - Any string. Raises CardinalityError if already has a file_name. Raises OrderError if no pacakge previously defined. """ self.assert_package_exists() if not self.packa...
def set_pkg_supplier(self, doc, entity): """Sets the package supplier, if not already set. entity - Organization, Person or NoAssert. Raises CardinalityError if already has a supplier. Raises OrderError if no package previously defined. """ self.assert_package_exists() ...
def set_pkg_originator(self, doc, entity): """Sets the package originator, if not already set. entity - Organization, Person or NoAssert. Raises CardinalityError if already has an originator. Raises OrderError if no package previously defined. """ self.assert_package_exis...
def set_pkg_down_location(self, doc, location): """Sets the package download location, if not already set. location - A string Raises CardinalityError if already defined. Raises OrderError if no package previously defined. """ self.assert_package_exists() if not s...
def set_pkg_home(self, doc, location): """Sets the package homepage location if not already set. location - A string or None or NoAssert. Raises CardinalityError if already defined. Raises OrderError if no package previously defined. Raises SPDXValueError if location has incorrec...
def set_pkg_verif_code(self, doc, code): """Sets the package verification code, if not already set. code - A string. Raises CardinalityError if already defined. Raises OrderError if no package previously defined. Raises Value error if doesn't match verifcode form """ ...
def set_pkg_chk_sum(self, doc, chk_sum): """Sets the package check sum, if not already set. chk_sum - A string Raises CardinalityError if already defined. Raises OrderError if no package previously defined. """ self.assert_package_exists() if not self.package_chk_...
def set_pkg_source_info(self, doc, text): """Sets the package's source information, if not already set. text - Free form text. Raises CardinalityError if already defined. Raises OrderError if no package previously defined. SPDXValueError if text is not free form text. """...
def set_pkg_licenses_concluded(self, doc, licenses): """Sets the package's concluded licenses. licenses - License info. Raises CardinalityError if already defined. Raises OrderError if no package previously defined. Raises SPDXValueError if data malformed. """ sel...
def set_pkg_license_from_file(self, doc, lic): """Adds a license from a file to the package. Raises SPDXValueError if data malformed. Raises OrderError if no package previously defined. """ self.assert_package_exists() if validations.validate_lics_from_file(lic): ...
def set_pkg_license_declared(self, doc, lic): """Sets the package's declared license. Raises SPDXValueError if data malformed. Raises OrderError if no package previously defined. Raises CardinalityError if already set. """ self.assert_package_exists() if not self....
def set_pkg_license_comment(self, doc, text): """Sets the package's license comment. Raises OrderError if no package previously defined. Raises CardinalityError if already set. Raises SPDXValueError if text is not free form text. """ self.assert_package_exists() i...
def set_pkg_cr_text(self, doc, text): """Sets the package's copyright text. Raises OrderError if no package previously defined. Raises CardinalityError if already set. Raises value error if text is not one of [None, NOASSERT, TEXT]. """ self.assert_package_exists() ...
def set_pkg_summary(self, doc, text): """Set's the package summary. Raises SPDXValueError if text is not free form text. Raises CardinalityError if summary already set. Raises OrderError if no package previously defined. """ self.assert_package_exists() if not sel...
def set_pkg_desc(self, doc, text): """Set's the package's description. Raises SPDXValueError if text is not free form text. Raises CardinalityError if description already set. Raises OrderError if no package previously defined. """ self.assert_package_exists() if ...
def set_file_name(self, doc, name): """Raises OrderError if no package defined. """ if self.has_package(doc): doc.package.files.append(file.File(name)) # A file name marks the start of a new file instance. # The builder must be reset # FIXME: this ...
def set_file_spdx_id(self, doc, spdx_id): """ Sets the file SPDX Identifier. Raises OrderError if no package or no file defined. Raises SPDXValueError if malformed value. Raises CardinalityError if more than one spdx_id set. """ if self.has_package(doc) and self.h...
def set_file_comment(self, doc, text): """ Raises OrderError if no package or no file defined. Raises CardinalityError if more than one comment set. Raises SPDXValueError if text is not free form text. """ if self.has_package(doc) and self.has_file(doc): if no...
def set_file_type(self, doc, type_value): """ Raises OrderError if no package or file defined. Raises CardinalityError if more than one type set. Raises SPDXValueError if type is unknown. """ type_dict = { 'SOURCE': file.FileType.SOURCE, 'BINARY': ...
def set_file_chksum(self, doc, chksum): """ Raises OrderError if no package or file defined. Raises CardinalityError if more than one chksum set. """ if self.has_package(doc) and self.has_file(doc): if not self.file_chksum_set: self.file_chksum_set = T...
def set_concluded_license(self, doc, lic): """ Raises OrderError if no package or file defined. Raises CardinalityError if already set. Raises SPDXValueError if malformed. """ if self.has_package(doc) and self.has_file(doc): if not self.file_conc_lics_set: ...
def set_file_license_in_file(self, doc, lic): """ Raises OrderError if no package or file defined. Raises SPDXValueError if malformed value. """ if self.has_package(doc) and self.has_file(doc): if validations.validate_file_lics_in_file(lic): self.file(...
def set_file_license_comment(self, doc, text): """ Raises OrderError if no package or file defined. Raises SPDXValueError if text is not free form text. Raises CardinalityError if more than one per file. """ if self.has_package(doc) and self.has_file(doc): if ...
def set_file_copyright(self, doc, text): """Raises OrderError if no package or file defined. Raises SPDXValueError if not free form text or NONE or NO_ASSERT. Raises CardinalityError if more than one. """ if self.has_package(doc) and self.has_file(doc): if not self.fi...
def set_file_notice(self, doc, text): """Raises OrderError if no package or file defined. Raises SPDXValueError if not free form text. Raises CardinalityError if more than one. """ if self.has_package(doc) and self.has_file(doc): if not self.file_notice_set: ...
def add_file_contribution(self, doc, value): """Raises OrderError if no package or file defined. """ if self.has_package(doc) and self.has_file(doc): self.file(doc).add_contrib(value) else: raise OrderError('File::Contributor')
def add_file_dep(self, doc, value): """Raises OrderError if no package or file defined. """ if self.has_package(doc) and self.has_file(doc): self.file(doc).add_depend(value) else: raise OrderError('File::Dependency')
def set_file_atrificat_of_project(self, doc, symbol, value): """Sets a file name, uri or home artificat. Raises 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: ...
def reset_file_stat(self): """Resets the builder's state to enable building new files.""" # FIXME: this state does not make sense self.file_spdx_id_set = False self.file_comment_set = False self.file_type_set = False self.file_chksum_set = False self.file_conc_lic...
def set_lic_id(self, doc, lic_id): """Adds a new extracted license to the document. Raises SPDXValueError if data format is incorrect. """ # FIXME: this state does not make sense self.reset_extr_lics() if validations.validate_extracted_lic_id(lic_id): doc.add_...
def set_lic_text(self, doc, text): """Sets license extracted text. Raises SPDXValueError if text is not free form text. Raises OrderError if no license ID defined. """ if self.has_extr_lic(doc): if not self.extr_text_set: self.extr_text_set = True ...
def set_lic_name(self, doc, name): """Sets license name. Raises SPDXValueError if name is not str or utils.NoAssert Raises OrderError if no license id defined. """ if self.has_extr_lic(doc): if not self.extr_lic_name_set: self.extr_lic_name_set = True ...
def set_lic_comment(self, doc, comment): """Sets license comment. Raises SPDXValueError if comment is not free form text. Raises OrderError if no license ID defined. """ if self.has_extr_lic(doc): if not self.extr_lic_comment_set: self.extr_lic_comment...
def add_lic_xref(self, doc, ref): """Adds a license cross reference. Raises OrderError if no License ID defined. """ if self.has_extr_lic(doc): self.extr_lic(doc).add_xref(ref) return True else: raise OrderError('ExtractedLicense::CrossRef')
def reset(self): """Resets builder's state for building new documents. Must be called between usage with different documents. """ # FIXME: this state does not make sense self.reset_creation_info() self.reset_document() self.reset_package() self.reset_file_...
def datetime_iso_format(date): """ Return an ISO-8601 representation of a datetime object. """ return "{0:0>4}-{1:0>2}-{2:0>2}T{3:0>2}:{4:0>2}:{5:0>2}Z".format( date.year, date.month, date.day, date.hour, date.minute, date.second)
def datetime_from_iso_format(string): """ Return a datetime object from an iso 8601 representation. Return None if string is non conforming. """ match = DATE_ISO_REGEX.match(string) if match: date = datetime.datetime(year=int(match.group(DATE_ISO_YEAR_GRP)), ...
def build(self, **kwargs): """Must be called before parse.""" self.yacc = yacc.yacc(module=self, **kwargs)
def parse(self, data): """Parses a license list and returns a License or None if it failed.""" try: return self.yacc.parse(data, lexer=self.lex) except: return None
def write_document(document, out, validate=True): """ Write an SPDX RDF document. - document - spdx.document instance. - out - file like object that will be written to. Optionally `validate` the document before writing and raise InvalidDocumentError if document.validate returns False. """ ...
def create_checksum_node(self, chksum): """ Return a node representing spdx.checksum. """ chksum_node = BNode() type_triple = (chksum_node, RDF.type, self.spdx_namespace.Checksum) self.graph.add(type_triple) algorithm_triple = (chksum_node, self.spdx_namespace.alg...
def to_special_value(self, value): """ Return proper spdx term or Literal """ if isinstance(value, utils.NoAssert): return self.spdx_namespace.noassertion elif isinstance(value, utils.SPDXNone): return self.spdx_namespace.none else: ret...
def licenses_from_tree(self, tree): """ Traverse conjunctions and disjunctions like trees and return a set of all licenses in it as nodes. """ # FIXME: this is unordered! licenses = set() self.licenses_from_tree_helper(tree, licenses) return licenses
def create_conjunction_node(self, conjunction): """ Return a node representing a conjunction of licenses. """ node = BNode() type_triple = (node, RDF.type, self.spdx_namespace.ConjunctiveLicenseSet) self.graph.add(type_triple) licenses = self.licenses_from_tree(co...
def create_disjunction_node(self, disjunction): """ Return a node representing a disjunction of licenses. """ node = BNode() type_triple = (node, RDF.type, self.spdx_namespace.DisjunctiveLicenseSet) self.graph.add(type_triple) licenses = self.licenses_from_tree(di...
def create_license_helper(self, lic): """ Handle single(no conjunction/disjunction) licenses. Return the created node. """ if isinstance(lic, document.ExtractedLicense): return self.create_extracted_license(lic) if lic.identifier.rstrip('+') in config.LICENSE_...
def create_extracted_license(self, lic): """ Handle extracted license. Return the license node. """ licenses = list(self.graph.triples((None, self.spdx_namespace.licenseId, lic.identifier))) if len(licenses) != 0: return licenses[0][0] # return subject in fir...
def create_license_node(self, lic): """ Return a node representing a license. Could be a single license (extracted or part of license list.) or a conjunction/disjunction of licenses. """ if isinstance(lic, document.LicenseConjunction): return self.create_conju...
def license_or_special(self, lic): """ Check for special values spdx:none and spdx:noassertion. Return the term for the special value or the result of passing license to create_license_node. """ if isinstance(lic, utils.NoAssert): return self.spdx_namespace.no...
def create_file_node(self, doc_file): """ Create a node for spdx.file. """ file_node = URIRef('http://www.spdx.org/files#{id}'.format( id=str(doc_file.spdx_id))) type_triple = (file_node, RDF.type, self.spdx_namespace.File) self.graph.add(type_triple) ...
def add_file_dependencies_helper(self, doc_file): """ Handle dependencies for a single file. - doc_file - instance of spdx.file.File. """ subj_triples = list(self.graph.triples((None, self.spdx_namespace.fileName, Literal(doc_file.name)))) if len(subj_triples) != 1: ...
def create_review_node(self, review): """ Return a review node. """ review_node = BNode() type_triple = (review_node, RDF.type, self.spdx_namespace.Review) self.graph.add(type_triple) reviewer_node = Literal(review.reviewer.to_value()) self.graph.add((rev...
def create_annotation_node(self, annotation): """ Return an annotation node. """ annotation_node = URIRef(str(annotation.spdx_id)) type_triple = (annotation_node, RDF.type, self.spdx_namespace.Annotation) self.graph.add(type_triple) annotator_node = Literal(annot...
def creators(self): """ Return a list of creator nodes. Note: Does not add anything to the graph. """ return map(lambda c: Literal(c.to_value()), self.document.creation_info.creators)
def create_creation_info(self): """ Add and return a creation info node to graph """ ci_node = BNode() # Type property type_triple = (ci_node, RDF.type, self.spdx_namespace.CreationInfo) self.graph.add(type_triple) created_date = Literal(self.document.cre...
def create_external_document_ref_node(self, ext_document_references): """ Add and return a creation info node to graph """ ext_doc_ref_node = BNode() type_triple = (ext_doc_ref_node, RDF.type, self.spdx_namespace.ExternalDocumentRef) self.graph.add(type_triple) e...
def package_verif_node(self, package): """ Return a node representing package verification code. """ verif_node = BNode() type_triple = (verif_node, RDF.type, self.spdx_namespace.PackageVerificationCode) self.graph.add(type_triple) value_triple = (verif_node, self...
def handle_package_literal_optional(self, package, package_node, predicate, field): """ Check if optional field is set. If so it adds the triple (package_node, predicate, $) to the graph. Where $ is a literal or special value term of the value of the field. """ if package...
def handle_pkg_optional_fields(self, package, package_node): """ Write package optional fields. """ self.handle_package_literal_optional(package, package_node, self.spdx_namespace.versionInfo, 'version') self.handle_package_literal_optional(package, package_node, self.spdx_namesp...
def create_package_node(self, package): """ Return a Node representing the package. Files must have been added to the graph before this method is called. """ package_node = BNode() type_triple = (package_node, RDF.type, self.spdx_namespace.Package) self.graph.add(...
def handle_package_has_file_helper(self, pkg_file): """ Return node representing pkg_file pkg_file should be instance of spdx.file. """ nodes = list(self.graph.triples((None, self.spdx_namespace.fileName, Literal(pkg_file.name)))) if len(nodes) == 1: return no...
def handle_package_has_file(self, package, package_node): """ Add hasFile triples to graph. Must be called after files have been added. """ file_nodes = map(self.handle_package_has_file_helper, package.files) triples = [(package_node, self.spdx_namespace.hasFile, node) fo...
def create_doc(self): """ Add and return the root document node to graph. """ doc_node = URIRef('http://www.spdx.org/tools#SPDXRef-DOCUMENT') # Doc type self.graph.add((doc_node, RDF.type, self.spdx_namespace.SpdxDocument)) # Version vers_literal = Literal...
def load_license_list(file_name): """ Return the licenses list version tuple and a mapping of licenses name->id and id->name loaded from a JSON file from https://github.com/spdx/license-list-data """ licenses_map = {} with codecs.open(file_name, 'rb', encoding='utf-8') as lics: licen...
def validate(self, messages): """Returns True if the fields are valid according to the SPDX standard. Appends user friendly messages to the messages parameter. """ messages = self.validate_creators(messages) messages = self.validate_created(messages) return messages
def more_than_one_error(self, field): """Logs a more than one error. field is the field/property that has more than one defined. """ msg = 'More than one {0} defined.'.format(field) self.logger.log(msg) self.error = True
def value_error(self, key, bad_value): """Reports a value error using ERROR_MESSAGES dict. key - key to use for ERROR_MESSAGES. bad_value - is passed to format which is called on what key maps to in ERROR_MESSAGES. """ msg = ERROR_MESSAGES[key].format(bad_value) s...
def to_special_value(self, value): """Checks if value is a special SPDX value such as NONE, NOASSERTION or UNKNOWN if so returns proper model. else returns value""" if value == self.spdx_namespace.none: return utils.SPDXNone() elif value == self.spdx_namespace.noasser...
def handle_lics(self, lics): """ Return a License from a `lics` license resource. """ # Handle extracted licensing info type. if (lics, RDF.type, self.spdx_namespace['ExtractedLicensingInfo']) in self.graph: return self.parse_only_extr_license(lics) # Assume ...
def get_extr_license_ident(self, extr_lic): """ Return an a license identifier from an ExtractedLicense or None. """ identifier_tripples = list(self.graph.triples((extr_lic, self.spdx_namespace['licenseId'], None))) if not identifier_tripples: self.error = True ...
def get_extr_license_text(self, extr_lic): """ Return extracted text from an ExtractedLicense or None. """ text_tripples = list(self.graph.triples((extr_lic, self.spdx_namespace['extractedText'], None))) if not text_tripples: self.error = True msg = 'Extr...
def get_extr_lic_name(self, extr_lic): """ Return the license name from an ExtractedLicense or None """ extr_name_list = list(self.graph.triples((extr_lic, self.spdx_namespace['licenseName'], None))) if len(extr_name_list) > 1: self.more_than_one_error('extracted lice...
def get_extr_lics_xref(self, extr_lic): """ Return a list of cross references. """ xrefs = list(self.graph.triples((extr_lic, RDFS.seeAlso, None))) return map(lambda xref_triple: xref_triple[2], xrefs)
def get_extr_lics_comment(self, extr_lics): """ Return license comment or None. """ comment_list = list(self.graph.triples( (extr_lics, RDFS.comment, None))) if len(comment_list) > 1 : self.more_than_one_error('extracted license comment') retur...
def parse_only_extr_license(self, extr_lic): """ Return an ExtractedLicense object to represent a license object. But does not add it to the SPDXDocument model. Return None if failed. """ # Grab all possible values ident = self.get_extr_license_ident(extr_lic) ...