Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitDiffParser.html

Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitDiffParser.html

changeset 6020
baf6da1ae288
equal deleted inserted replaced
6019:58ecdaf0b789 6020:baf6da1ae288
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsGit.GitDiffParser</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitDiffParser</h1>
23 <p>
24 Module implementing a class to store and parse diff output.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#GitDiffParser">GitDiffParser</a></td>
34 <td>Class implementing a class to store and parse diff output.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="GitDiffParser" ID="GitDiffParser"></a>
43 <h2>GitDiffParser</h2>
44 <p>
45 Class implementing a class to store and parse diff output.
46 </p>
47 <h3>Derived from</h3>
48 object
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>HunkHeaderRegexp</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#GitDiffParser.__init__">GitDiffParser</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#GitDiffParser.__generateHunkHeader">__generateHunkHeader</a></td>
64 <td>Private method to generate a hunk header line.</td>
65 </tr><tr>
66 <td><a href="#GitDiffParser.__generateRange">__generateRange</a></td>
67 <td>Private method to generate a hunk header range.</td>
68 </tr><tr>
69 <td><a href="#GitDiffParser.__initHunk">__initHunk</a></td>
70 <td>Private method to initialize a hunk data structure.</td>
71 </tr><tr>
72 <td><a href="#GitDiffParser.__parseDiff">__parseDiff</a></td>
73 <td>Private method to parse the diff output.</td>
74 </tr><tr>
75 <td><a href="#GitDiffParser.__parseRange">__parseRange</a></td>
76 <td>Private method to parse the hunk header range part.</td>
77 </tr><tr>
78 <td><a href="#GitDiffParser.createHunkPatch">createHunkPatch</a></td>
79 <td>Public method to create a hunk based patch.</td>
80 </tr><tr>
81 <td><a href="#GitDiffParser.createLinesPatch">createLinesPatch</a></td>
82 <td>Public method to create a selected lines based patch.</td>
83 </tr><tr>
84 <td><a href="#GitDiffParser.headerLength">headerLength</a></td>
85 <td>Public method to get the header length.</td>
86 </tr>
87 </table>
88 <h3>Static Methods</h3>
89 <table>
90 <tr><td>None</td></tr>
91 </table>
92 <a NAME="GitDiffParser.__init__" ID="GitDiffParser.__init__"></a>
93 <h4>GitDiffParser (Constructor)</h4>
94 <b>GitDiffParser</b>(<i>diff</i>)
95 <p>
96 Constructor
97 </p><dl>
98 <dt><i>diff</i></dt>
99 <dd>
100 output of the diff command (list of string)
101 </dd>
102 </dl><a NAME="GitDiffParser.__generateHunkHeader" ID="GitDiffParser.__generateHunkHeader"></a>
103 <h4>GitDiffParser.__generateHunkHeader</h4>
104 <b>__generateHunkHeader</b>(<i>oldStart, oldCount, newStart, newCount, heading=os.linesep</i>)
105 <p>
106 Private method to generate a hunk header line.
107 </p><dl>
108 <dt><i>oldStart</i></dt>
109 <dd>
110 start line of the old part (integer)
111 </dd><dt><i>oldCount</i></dt>
112 <dd>
113 line count of the old part (integer)
114 </dd><dt><i>newStart</i></dt>
115 <dd>
116 start line of the new part (integer)
117 </dd><dt><i>newCount</i></dt>
118 <dd>
119 line count of the new part (integer)
120 </dd><dt><i>heading</i></dt>
121 <dd>
122 hunk heading (string)
123 </dd>
124 </dl><dl>
125 <dt>Returns:</dt>
126 <dd>
127 hunk header (string)
128 </dd>
129 </dl><a NAME="GitDiffParser.__generateRange" ID="GitDiffParser.__generateRange"></a>
130 <h4>GitDiffParser.__generateRange</h4>
131 <b>__generateRange</b>(<i>start, count</i>)
132 <p>
133 Private method to generate a hunk header range.
134 </p><dl>
135 <dt><i>start</i></dt>
136 <dd>
137 start line (integer)
138 </dd><dt><i>count</i></dt>
139 <dd>
140 line count (integer)
141 </dd>
142 </dl><dl>
143 <dt>Returns:</dt>
144 <dd>
145 hunk header range (string)
146 </dd>
147 </dl><a NAME="GitDiffParser.__initHunk" ID="GitDiffParser.__initHunk"></a>
148 <h4>GitDiffParser.__initHunk</h4>
149 <b>__initHunk</b>(<i></i>)
150 <p>
151 Private method to initialize a hunk data structure.
152 </p><dl>
153 <dt>Returns:</dt>
154 <dd>
155 hunk data structure (dictionary)
156 </dd>
157 </dl><a NAME="GitDiffParser.__parseDiff" ID="GitDiffParser.__parseDiff"></a>
158 <h4>GitDiffParser.__parseDiff</h4>
159 <b>__parseDiff</b>(<i></i>)
160 <p>
161 Private method to parse the diff output.
162 </p><dl>
163 <dt>Raises <b>AssertionError</b>:</dt>
164 <dd>
165 raised when a malformed hunk header is
166 encountered
167 </dd>
168 </dl><a NAME="GitDiffParser.__parseRange" ID="GitDiffParser.__parseRange"></a>
169 <h4>GitDiffParser.__parseRange</h4>
170 <b>__parseRange</b>(<i>headerRange</i>)
171 <p>
172 Private method to parse the hunk header range part.
173 </p><dl>
174 <dt><i>headerRange</i></dt>
175 <dd>
176 hunk header range (string)
177 </dd>
178 </dl><dl>
179 <dt>Returns:</dt>
180 <dd>
181 tuple of hunk start and hunk length (integer, integer)
182 </dd>
183 </dl><a NAME="GitDiffParser.createHunkPatch" ID="GitDiffParser.createHunkPatch"></a>
184 <h4>GitDiffParser.createHunkPatch</h4>
185 <b>createHunkPatch</b>(<i>lineIndex</i>)
186 <p>
187 Public method to create a hunk based patch.
188 </p><dl>
189 <dt><i>lineIndex</i></dt>
190 <dd>
191 line number of the hunk (integer)
192 </dd>
193 </dl><dl>
194 <dt>Returns:</dt>
195 <dd>
196 diff lines of the patch (string)
197 </dd>
198 </dl><a NAME="GitDiffParser.createLinesPatch" ID="GitDiffParser.createLinesPatch"></a>
199 <h4>GitDiffParser.createLinesPatch</h4>
200 <b>createLinesPatch</b>(<i>startIndex, endIndex, reverse=False</i>)
201 <p>
202 Public method to create a selected lines based patch.
203 </p><dl>
204 <dt><i>startIndex</i></dt>
205 <dd>
206 start line number (integer)
207 </dd><dt><i>endIndex</i></dt>
208 <dd>
209 end line number (integer)
210 </dd><dt><i>reverse</i></dt>
211 <dd>
212 flag indicating a reverse patch (boolean)
213 </dd>
214 </dl><dl>
215 <dt>Returns:</dt>
216 <dd>
217 diff lines of the patch (string)
218 </dd>
219 </dl><a NAME="GitDiffParser.headerLength" ID="GitDiffParser.headerLength"></a>
220 <h4>GitDiffParser.headerLength</h4>
221 <b>headerLength</b>(<i></i>)
222 <p>
223 Public method to get the header length.
224 </p><dl>
225 <dt>Returns:</dt>
226 <dd>
227 length of the header (integer)
228 </dd>
229 </dl>
230 <div align="right"><a href="#top">Up</a></div>
231 <hr />
232 </body></html>

Mercurial Repository: eric

eric ide

mercurial