# encoding: utf-8
# This file is part of CycloneDX Python Lib
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# Copyright (c) OWASP Foundation. All Rights Reserved.
from cyclonedx.exception.model import UnknownHashTypeException
from cyclonedx.model import ExternalReference, ExternalReferenceType, HashType, XsUri
from cyclonedx.model.component import Component
from cyclonedx.parser import BaseParser
# See https://github.com/package-url/packageurl-python/issues/65
from packageurl import PackageURL # type: ignore
from toml import loads as load_toml
[docs]class PoetryParser(BaseParser):
def __init__(self, poetry_lock_contents: str) -> None:
super().__init__()
poetry_lock = load_toml(poetry_lock_contents)
for package in poetry_lock['package']:
component = Component(
name=package['name'], version=package['version'], purl=PackageURL(
type='pypi', name=package['name'], version=package['version']
)
)
for file_metadata in poetry_lock['metadata']['files'][package['name']]:
try:
component.external_references.add(ExternalReference(
reference_type=ExternalReferenceType.DISTRIBUTION,
url=XsUri(component.get_pypi_url()),
comment=f'Distribution file: {file_metadata["file"]}',
hashes=[HashType.from_composite_str(file_metadata['hash'])]
))
except UnknownHashTypeException:
# @todo add logging for this type of exception?
pass
self._components.append(component)
[docs]class PoetryFileParser(PoetryParser):
def __init__(self, poetry_lock_filename: str) -> None:
with open(poetry_lock_filename) as r:
super(PoetryFileParser, self).__init__(poetry_lock_contents=r.read())