Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html
eric7/Documentation/Source/eric7.CycloneDXInterface.CycloneDXUtilities.html
- branch
- eric7
- changeset 9123
- aefb731a4b4e
- parent 9117
- c6afba2049cf
- child 9141
- 7085ece52151
equal
deleted
inserted
replaced
| 9122:ddf8ed8f7387 | 9123:aefb731a4b4e |
|---|---|
| 28 <h3>Functions</h3> | 28 <h3>Functions</h3> |
| 29 | 29 |
| 30 <table> | 30 <table> |
| 31 | 31 |
| 32 <tr> | 32 <tr> |
| 33 <td><a href="#_addCycloneDXDependency">_addCycloneDXDependency</a></td> | |
| 34 <td>Function to add a dependency to the given list of components.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#addCycloneDXDependencies">addCycloneDXDependencies</a></td> | |
| 38 <td>Function to add dependency data to the list of created components.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#addCycloneDXVulnerabilities">addCycloneDXVulnerabilities</a></td> | |
| 42 <td>Function to add vulnerability data to the list of created components.</td> | |
| 43 </tr> | |
| 44 <tr> | |
| 33 <td><a href="#createCycloneDXFile">createCycloneDXFile</a></td> | 45 <td><a href="#createCycloneDXFile">createCycloneDXFile</a></td> |
| 34 <td>Function to create a CyccloneDX SBOM file.</td> | 46 <td>Function to create a CyccloneDX SBOM file.</td> |
| 47 </tr> | |
| 48 <tr> | |
| 49 <td><a href="#findCyccloneDXComponent">findCyccloneDXComponent</a></td> | |
| 50 <td>Function to find a component in a given list of components.</td> | |
| 35 </tr> | 51 </tr> |
| 36 </table> | 52 </table> |
| 37 <hr /> | 53 <hr /> |
| 38 <hr /> | 54 <hr /> |
| 39 <a NAME="CycloneDXEnvironmentParser" ID="CycloneDXEnvironmentParser"></a> | 55 <a NAME="CycloneDXEnvironmentParser" ID="CycloneDXEnvironmentParser"></a> |
| 84 </dd> | 100 </dd> |
| 85 </dl> | 101 </dl> |
| 86 <div align="right"><a href="#top">Up</a></div> | 102 <div align="right"><a href="#top">Up</a></div> |
| 87 <hr /> | 103 <hr /> |
| 88 <hr /> | 104 <hr /> |
| 105 <a NAME="_addCycloneDXDependency" ID="_addCycloneDXDependency"></a> | |
| 106 <h2>_addCycloneDXDependency</h2> | |
| 107 <b>_addCycloneDXDependency</b>(<i>dependency, components</i>) | |
| 108 | |
| 109 <p> | |
| 110 Function to add a dependency to the given list of components. | |
| 111 </p> | |
| 112 <dl> | |
| 113 | |
| 114 <dt><i>dependency</i> (dict)</dt> | |
| 115 <dd> | |
| 116 dependency to be added | |
| 117 </dd> | |
| 118 <dt><i>components</i> (list of Component)</dt> | |
| 119 <dd> | |
| 120 list of components | |
| 121 </dd> | |
| 122 </dl> | |
| 123 <div align="right"><a href="#top">Up</a></div> | |
| 124 <hr /> | |
| 125 <hr /> | |
| 126 <a NAME="addCycloneDXDependencies" ID="addCycloneDXDependencies"></a> | |
| 127 <h2>addCycloneDXDependencies</h2> | |
| 128 <b>addCycloneDXDependencies</b>(<i>parser, venvName</i>) | |
| 129 | |
| 130 <p> | |
| 131 Function to add dependency data to the list of created components. | |
| 132 </p> | |
| 133 <dl> | |
| 134 | |
| 135 <dt><i>parser</i> (BaseParser)</dt> | |
| 136 <dd> | |
| 137 reference to the parser object containing the list of | |
| 138 components | |
| 139 </dd> | |
| 140 <dt><i>venvName</i> (str)</dt> | |
| 141 <dd> | |
| 142 name of the virtual environment | |
| 143 </dd> | |
| 144 </dl> | |
| 145 <div align="right"><a href="#top">Up</a></div> | |
| 146 <hr /> | |
| 147 <hr /> | |
| 148 <a NAME="addCycloneDXVulnerabilities" ID="addCycloneDXVulnerabilities"></a> | |
| 149 <h2>addCycloneDXVulnerabilities</h2> | |
| 150 <b>addCycloneDXVulnerabilities</b>(<i>parser</i>) | |
| 151 | |
| 152 <p> | |
| 153 Function to add vulnerability data to the list of created components. | |
| 154 </p> | |
| 155 <dl> | |
| 156 | |
| 157 <dt><i>parser</i> (BaseParser)</dt> | |
| 158 <dd> | |
| 159 reference to the parser object containing the list of | |
| 160 components | |
| 161 </dd> | |
| 162 </dl> | |
| 163 <div align="right"><a href="#top">Up</a></div> | |
| 164 <hr /> | |
| 165 <hr /> | |
| 89 <a NAME="createCycloneDXFile" ID="createCycloneDXFile"></a> | 166 <a NAME="createCycloneDXFile" ID="createCycloneDXFile"></a> |
| 90 <h2>createCycloneDXFile</h2> | 167 <h2>createCycloneDXFile</h2> |
| 91 <b>createCycloneDXFile</b>(<i>venvName</i>) | 168 <b>createCycloneDXFile</b>(<i>venvName</i>) |
| 92 | 169 |
| 93 <p> | 170 <p> |
| 107 raised to indicate illegal creation parameters | 184 raised to indicate illegal creation parameters |
| 108 </dd> | 185 </dd> |
| 109 </dl> | 186 </dl> |
| 110 <div align="right"><a href="#top">Up</a></div> | 187 <div align="right"><a href="#top">Up</a></div> |
| 111 <hr /> | 188 <hr /> |
| 189 <hr /> | |
| 190 <a NAME="findCyccloneDXComponent" ID="findCyccloneDXComponent"></a> | |
| 191 <h2>findCyccloneDXComponent</h2> | |
| 192 <b>findCyccloneDXComponent</b>(<i>components, name</i>) | |
| 193 | |
| 194 <p> | |
| 195 Function to find a component in a given list of components. | |
| 196 </p> | |
| 197 <dl> | |
| 198 | |
| 199 <dt><i>components</i> (list of Component)</dt> | |
| 200 <dd> | |
| 201 list of components to scan | |
| 202 </dd> | |
| 203 <dt><i>name</i> (str)</dt> | |
| 204 <dd> | |
| 205 name of the component to search for | |
| 206 </dd> | |
| 207 </dl> | |
| 208 <dl> | |
| 209 <dt>Return:</dt> | |
| 210 <dd> | |
| 211 reference to the found component or None | |
| 212 </dd> | |
| 213 </dl> | |
| 214 <dl> | |
| 215 <dt>Return Type:</dt> | |
| 216 <dd> | |
| 217 Component or None | |
| 218 </dd> | |
| 219 </dl> | |
| 220 <div align="right"><a href="#top">Up</a></div> | |
| 221 <hr /> | |
| 112 </body></html> | 222 </body></html> |
