Skip to content

Commit a276d89

Browse files
committed
docs: add javadoc to the PythonPyprojectProvider
Signed-off-by: Ruben Romero Montes <rromerom@redhat.com>
1 parent b70c8dc commit a276d89

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

src/main/java/io/github/guacsec/trustifyda/providers/PythonPyprojectProvider.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,17 @@
4747
import org.tomlj.TomlParseResult;
4848
import org.tomlj.TomlTable;
4949

50+
/**
51+
* Provider for Python projects using {@code pyproject.toml} with <a
52+
* href="https://peps.python.org/pep-0621/">PEP 621</a> {@code [project.dependencies]}.
53+
*
54+
* <p>Dependency resolution is performed via {@code pip install --dry-run --ignore-installed
55+
* --report - .}, which produces a JSON installation report containing the full dependency graph.
56+
*
57+
* <p><strong>Poetry is not supported.</strong> If the manifest contains {@code
58+
* [tool.poetry.dependencies]}, both {@link #provideStack()} and {@link #provideComponent()} will
59+
* throw an {@link IllegalStateException}.
60+
*/
5061
public final class PythonPyprojectProvider extends PythonProvider {
5162

5263
private static final Logger log =

0 commit comments

Comments
 (0)