eric7/Documentation/Source/eric7.PipInterface.PipLicensesDialog.html

Sat, 02 Apr 2022 17:07:56 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 02 Apr 2022 17:07:56 +0200
branch
eric7
changeset 9014
cdf68c00881d
parent 9007
01b73d9ef09e
child 9103
8ac26b4c4316
permissions
-rw-r--r--

pip Interface
- added the capability to save the licenses overview as a CSV file

9007
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric7.PipInterface.PipLicensesDialog</title>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <link rel="stylesheet" href="styles.css">
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 </head>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 <body>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 <a NAME="top" ID="top"></a>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 <h1>eric7.PipInterface.PipLicensesDialog</h1>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11 <p>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 Module implementing a dialog to show the licenses of an environment.
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 </p>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 <h3>Global Attributes</h3>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 <table>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 <tr><td>None</td></tr>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18 </table>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 <h3>Classes</h3>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <table>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <tr>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 <td><a href="#PipLicensesDialog">PipLicensesDialog</a></td>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 <td>Class implementing a dialog to show the licenses of an environment.</td>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 </tr>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 </table>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <h3>Functions</h3>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <table>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <tr><td>None</td></tr>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 </table>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <hr />
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <hr />
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <a NAME="PipLicensesDialog" ID="PipLicensesDialog"></a>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 <h2>PipLicensesDialog</h2>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <p>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 Class implementing a dialog to show the licenses of an environment.
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </p>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 <h3>Derived from</h3>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 QDialog, Ui_PipLicensesDialog
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <h3>Class Attributes</h3>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <table>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 <tr><td>LicensesLicenseColumn</td></tr><tr><td>LicensesPackageColumn</td></tr><tr><td>LicensesVersionColumn</td></tr><tr><td>SummaryCountColumn</td></tr><tr><td>SummaryLicenseColumn</td></tr>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 </table>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <h3>Class Methods</h3>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <table>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <tr><td>None</td></tr>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 </table>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 <h3>Methods</h3>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <table>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <tr>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <td><a href="#PipLicensesDialog.__init__">PipLicensesDialog</a></td>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <td>Constructor</td>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 </tr>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 <tr>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <td><a href="#PipLicensesDialog.__refreshLicenses">__refreshLicenses</a></td>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <td>Private slot to refresh the license lists.</td>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 </tr>
9014
cdf68c00881d pip Interface
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9007
diff changeset
65 <tr>
cdf68c00881d pip Interface
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9007
diff changeset
66 <td><a href="#PipLicensesDialog.__saveAsCSV">__saveAsCSV</a></td>
cdf68c00881d pip Interface
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9007
diff changeset
67 <td>Private slot to save the license information as a CSV file.</td>
cdf68c00881d pip Interface
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9007
diff changeset
68 </tr>
9007
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 </table>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <h3>Static Methods</h3>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <table>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 <tr><td>None</td></tr>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 </table>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <a NAME="PipLicensesDialog.__init__" ID="PipLicensesDialog.__init__"></a>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <h4>PipLicensesDialog (Constructor)</h4>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <b>PipLicensesDialog</b>(<i>pip, environment, localPackages=True, usersite=False, parent=None</i>)
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 <p>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 Constructor
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 </p>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 <dl>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 <dt><i>pip</i> (Pip)</dt>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 <dd>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 reference to the pip interface object
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 </dd>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 <dt><i>environment</i> (str)</dt>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <dd>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 name of the environment to show the licenses for
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 </dd>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 <dt><i>localPackages</i> (bool)</dt>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 <dd>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 flag indicating to show the licenses for local
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 packages only
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 </dd>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 <dt><i>usersite</i> (bool)</dt>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 <dd>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 flag indicating to show the licenses for packages
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 installed in user-site directory only
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 </dd>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 <dt><i>parent</i> (QWidget (optional))</dt>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 <dd>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 reference to the parent widget (defaults to None)
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 </dd>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 </dl>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 <a NAME="PipLicensesDialog.__refreshLicenses" ID="PipLicensesDialog.__refreshLicenses"></a>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 <h4>PipLicensesDialog.__refreshLicenses</h4>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 <b>__refreshLicenses</b>(<i></i>)
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 <p>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 Private slot to refresh the license lists.
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 </p>
9014
cdf68c00881d pip Interface
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9007
diff changeset
115 <a NAME="PipLicensesDialog.__saveAsCSV" ID="PipLicensesDialog.__saveAsCSV"></a>
cdf68c00881d pip Interface
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9007
diff changeset
116 <h4>PipLicensesDialog.__saveAsCSV</h4>
cdf68c00881d pip Interface
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9007
diff changeset
117 <b>__saveAsCSV</b>(<i></i>)
cdf68c00881d pip Interface
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9007
diff changeset
118
cdf68c00881d pip Interface
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9007
diff changeset
119 <p>
cdf68c00881d pip Interface
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9007
diff changeset
120 Private slot to save the license information as a CSV file.
cdf68c00881d pip Interface
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9007
diff changeset
121 </p>
9007
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122 <div align="right"><a href="#top">Up</a></div>
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 <hr />
01b73d9ef09e Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 </body></html>

eric ide

mercurial