Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitDiffParser</h1> 23 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitDiffParser</h1>
24
23 <p> 25 <p>
24 Module implementing a class to store and parse diff output. 26 Module implementing a class to store and parse diff output.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#GitDiffParser">GitDiffParser</a></td> 38 <td><a href="#GitDiffParser">GitDiffParser</a></td>
34 <td>Class implementing a class to store and parse diff output.</td> 39 <td>Class implementing a class to store and parse diff output.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="GitDiffParser" ID="GitDiffParser"></a> 49 <a NAME="GitDiffParser" ID="GitDiffParser"></a>
43 <h2>GitDiffParser</h2> 50 <h2>GitDiffParser</h2>
51
44 <p> 52 <p>
45 Class implementing a class to store and parse diff output. 53 Class implementing a class to store and parse diff output.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 object 56 object
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>HunkHeaderRegexp</td></tr> 60 <tr><td>HunkHeaderRegexp</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#GitDiffParser.__init__">GitDiffParser</a></td> 72 <td><a href="#GitDiffParser.__init__">GitDiffParser</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#GitDiffParser.__generateHunkHeader">__generateHunkHeader</a></td> 76 <td><a href="#GitDiffParser.__generateHunkHeader">__generateHunkHeader</a></td>
64 <td>Private method to generate a hunk header line.</td> 77 <td>Private method to generate a hunk header line.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#GitDiffParser.__generateRange">__generateRange</a></td> 80 <td><a href="#GitDiffParser.__generateRange">__generateRange</a></td>
67 <td>Private method to generate a hunk header range.</td> 81 <td>Private method to generate a hunk header range.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#GitDiffParser.__initHunk">__initHunk</a></td> 84 <td><a href="#GitDiffParser.__initHunk">__initHunk</a></td>
70 <td>Private method to initialize a hunk data structure.</td> 85 <td>Private method to initialize a hunk data structure.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#GitDiffParser.__parseDiff">__parseDiff</a></td> 88 <td><a href="#GitDiffParser.__parseDiff">__parseDiff</a></td>
73 <td>Private method to parse the diff output.</td> 89 <td>Private method to parse the diff output.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#GitDiffParser.__parseRange">__parseRange</a></td> 92 <td><a href="#GitDiffParser.__parseRange">__parseRange</a></td>
76 <td>Private method to parse the hunk header range part.</td> 93 <td>Private method to parse the hunk header range part.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#GitDiffParser.createHunkPatch">createHunkPatch</a></td> 96 <td><a href="#GitDiffParser.createHunkPatch">createHunkPatch</a></td>
79 <td>Public method to create a hunk based patch.</td> 97 <td>Public method to create a hunk based patch.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#GitDiffParser.createLinesPatch">createLinesPatch</a></td> 100 <td><a href="#GitDiffParser.createLinesPatch">createLinesPatch</a></td>
82 <td>Public method to create a selected lines based patch.</td> 101 <td>Public method to create a selected lines based patch.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#GitDiffParser.headerLength">headerLength</a></td> 104 <td><a href="#GitDiffParser.headerLength">headerLength</a></td>
85 <td>Public method to get the header length.</td> 105 <td>Public method to get the header length.</td>
86 </tr> 106 </tr>
87 </table> 107 </table>
88 <h3>Static Methods</h3> 108 <h3>Static Methods</h3>
89 <table> 109
90 <tr><td>None</td></tr> 110 <table>
91 </table> 111 <tr><td>None</td></tr>
112 </table>
113
92 <a NAME="GitDiffParser.__init__" ID="GitDiffParser.__init__"></a> 114 <a NAME="GitDiffParser.__init__" ID="GitDiffParser.__init__"></a>
93 <h4>GitDiffParser (Constructor)</h4> 115 <h4>GitDiffParser (Constructor)</h4>
94 <b>GitDiffParser</b>(<i>diff</i>) 116 <b>GitDiffParser</b>(<i>diff</i>)
117
95 <p> 118 <p>
96 Constructor 119 Constructor
97 </p><dl> 120 </p>
121 <dl>
122
98 <dt><i>diff</i></dt> 123 <dt><i>diff</i></dt>
99 <dd> 124 <dd>
100 output of the diff command (list of string) 125 output of the diff command (list of string)
101 </dd> 126 </dd>
102 </dl><a NAME="GitDiffParser.__generateHunkHeader" ID="GitDiffParser.__generateHunkHeader"></a> 127 </dl>
128 <a NAME="GitDiffParser.__generateHunkHeader" ID="GitDiffParser.__generateHunkHeader"></a>
103 <h4>GitDiffParser.__generateHunkHeader</h4> 129 <h4>GitDiffParser.__generateHunkHeader</h4>
104 <b>__generateHunkHeader</b>(<i>oldStart, oldCount, newStart, newCount, heading=os.linesep</i>) 130 <b>__generateHunkHeader</b>(<i>oldStart, oldCount, newStart, newCount, heading=os.linesep</i>)
131
105 <p> 132 <p>
106 Private method to generate a hunk header line. 133 Private method to generate a hunk header line.
107 </p><dl> 134 </p>
135 <dl>
136
108 <dt><i>oldStart</i></dt> 137 <dt><i>oldStart</i></dt>
109 <dd> 138 <dd>
110 start line of the old part (integer) 139 start line of the old part (integer)
111 </dd><dt><i>oldCount</i></dt> 140 </dd>
141 <dt><i>oldCount</i></dt>
112 <dd> 142 <dd>
113 line count of the old part (integer) 143 line count of the old part (integer)
114 </dd><dt><i>newStart</i></dt> 144 </dd>
145 <dt><i>newStart</i></dt>
115 <dd> 146 <dd>
116 start line of the new part (integer) 147 start line of the new part (integer)
117 </dd><dt><i>newCount</i></dt> 148 </dd>
149 <dt><i>newCount</i></dt>
118 <dd> 150 <dd>
119 line count of the new part (integer) 151 line count of the new part (integer)
120 </dd><dt><i>heading</i></dt> 152 </dd>
153 <dt><i>heading</i></dt>
121 <dd> 154 <dd>
122 hunk heading (string) 155 hunk heading (string)
123 </dd> 156 </dd>
124 </dl><dl> 157 </dl>
158 <dl>
125 <dt>Returns:</dt> 159 <dt>Returns:</dt>
126 <dd> 160 <dd>
127 hunk header (string) 161 hunk header (string)
128 </dd> 162 </dd>
129 </dl><a NAME="GitDiffParser.__generateRange" ID="GitDiffParser.__generateRange"></a> 163 </dl>
164 <a NAME="GitDiffParser.__generateRange" ID="GitDiffParser.__generateRange"></a>
130 <h4>GitDiffParser.__generateRange</h4> 165 <h4>GitDiffParser.__generateRange</h4>
131 <b>__generateRange</b>(<i>start, count</i>) 166 <b>__generateRange</b>(<i>start, count</i>)
167
132 <p> 168 <p>
133 Private method to generate a hunk header range. 169 Private method to generate a hunk header range.
134 </p><dl> 170 </p>
171 <dl>
172
135 <dt><i>start</i></dt> 173 <dt><i>start</i></dt>
136 <dd> 174 <dd>
137 start line (integer) 175 start line (integer)
138 </dd><dt><i>count</i></dt> 176 </dd>
177 <dt><i>count</i></dt>
139 <dd> 178 <dd>
140 line count (integer) 179 line count (integer)
141 </dd> 180 </dd>
142 </dl><dl> 181 </dl>
182 <dl>
143 <dt>Returns:</dt> 183 <dt>Returns:</dt>
144 <dd> 184 <dd>
145 hunk header range (string) 185 hunk header range (string)
146 </dd> 186 </dd>
147 </dl><a NAME="GitDiffParser.__initHunk" ID="GitDiffParser.__initHunk"></a> 187 </dl>
188 <a NAME="GitDiffParser.__initHunk" ID="GitDiffParser.__initHunk"></a>
148 <h4>GitDiffParser.__initHunk</h4> 189 <h4>GitDiffParser.__initHunk</h4>
149 <b>__initHunk</b>(<i></i>) 190 <b>__initHunk</b>(<i></i>)
191
150 <p> 192 <p>
151 Private method to initialize a hunk data structure. 193 Private method to initialize a hunk data structure.
152 </p><dl> 194 </p>
195 <dl>
153 <dt>Returns:</dt> 196 <dt>Returns:</dt>
154 <dd> 197 <dd>
155 hunk data structure (dictionary) 198 hunk data structure (dictionary)
156 </dd> 199 </dd>
157 </dl><a NAME="GitDiffParser.__parseDiff" ID="GitDiffParser.__parseDiff"></a> 200 </dl>
201 <a NAME="GitDiffParser.__parseDiff" ID="GitDiffParser.__parseDiff"></a>
158 <h4>GitDiffParser.__parseDiff</h4> 202 <h4>GitDiffParser.__parseDiff</h4>
159 <b>__parseDiff</b>(<i></i>) 203 <b>__parseDiff</b>(<i></i>)
204
160 <p> 205 <p>
161 Private method to parse the diff output. 206 Private method to parse the diff output.
162 </p><dl> 207 </p>
208 <dl>
209
163 <dt>Raises <b>AssertionError</b>:</dt> 210 <dt>Raises <b>AssertionError</b>:</dt>
164 <dd> 211 <dd>
165 raised when a malformed hunk header is 212 raised when a malformed hunk header is
166 encountered 213 encountered
167 </dd> 214 </dd>
168 </dl><a NAME="GitDiffParser.__parseRange" ID="GitDiffParser.__parseRange"></a> 215 </dl>
216 <a NAME="GitDiffParser.__parseRange" ID="GitDiffParser.__parseRange"></a>
169 <h4>GitDiffParser.__parseRange</h4> 217 <h4>GitDiffParser.__parseRange</h4>
170 <b>__parseRange</b>(<i>headerRange</i>) 218 <b>__parseRange</b>(<i>headerRange</i>)
219
171 <p> 220 <p>
172 Private method to parse the hunk header range part. 221 Private method to parse the hunk header range part.
173 </p><dl> 222 </p>
223 <dl>
224
174 <dt><i>headerRange</i></dt> 225 <dt><i>headerRange</i></dt>
175 <dd> 226 <dd>
176 hunk header range (string) 227 hunk header range (string)
177 </dd> 228 </dd>
178 </dl><dl> 229 </dl>
230 <dl>
179 <dt>Returns:</dt> 231 <dt>Returns:</dt>
180 <dd> 232 <dd>
181 tuple of hunk start and hunk length (integer, integer) 233 tuple of hunk start and hunk length (integer, integer)
182 </dd> 234 </dd>
183 </dl><a NAME="GitDiffParser.createHunkPatch" ID="GitDiffParser.createHunkPatch"></a> 235 </dl>
236 <a NAME="GitDiffParser.createHunkPatch" ID="GitDiffParser.createHunkPatch"></a>
184 <h4>GitDiffParser.createHunkPatch</h4> 237 <h4>GitDiffParser.createHunkPatch</h4>
185 <b>createHunkPatch</b>(<i>lineIndex</i>) 238 <b>createHunkPatch</b>(<i>lineIndex</i>)
239
186 <p> 240 <p>
187 Public method to create a hunk based patch. 241 Public method to create a hunk based patch.
188 </p><dl> 242 </p>
243 <dl>
244
189 <dt><i>lineIndex</i></dt> 245 <dt><i>lineIndex</i></dt>
190 <dd> 246 <dd>
191 line number of the hunk (integer) 247 line number of the hunk (integer)
192 </dd> 248 </dd>
193 </dl><dl> 249 </dl>
250 <dl>
194 <dt>Returns:</dt> 251 <dt>Returns:</dt>
195 <dd> 252 <dd>
196 diff lines of the patch (string) 253 diff lines of the patch (string)
197 </dd> 254 </dd>
198 </dl><a NAME="GitDiffParser.createLinesPatch" ID="GitDiffParser.createLinesPatch"></a> 255 </dl>
256 <a NAME="GitDiffParser.createLinesPatch" ID="GitDiffParser.createLinesPatch"></a>
199 <h4>GitDiffParser.createLinesPatch</h4> 257 <h4>GitDiffParser.createLinesPatch</h4>
200 <b>createLinesPatch</b>(<i>startIndex, endIndex, reverse=False</i>) 258 <b>createLinesPatch</b>(<i>startIndex, endIndex, reverse=False</i>)
259
201 <p> 260 <p>
202 Public method to create a selected lines based patch. 261 Public method to create a selected lines based patch.
203 </p><dl> 262 </p>
263 <dl>
264
204 <dt><i>startIndex</i></dt> 265 <dt><i>startIndex</i></dt>
205 <dd> 266 <dd>
206 start line number (integer) 267 start line number (integer)
207 </dd><dt><i>endIndex</i></dt> 268 </dd>
269 <dt><i>endIndex</i></dt>
208 <dd> 270 <dd>
209 end line number (integer) 271 end line number (integer)
210 </dd><dt><i>reverse</i></dt> 272 </dd>
273 <dt><i>reverse</i></dt>
211 <dd> 274 <dd>
212 flag indicating a reverse patch (boolean) 275 flag indicating a reverse patch (boolean)
213 </dd> 276 </dd>
214 </dl><dl> 277 </dl>
278 <dl>
215 <dt>Returns:</dt> 279 <dt>Returns:</dt>
216 <dd> 280 <dd>
217 diff lines of the patch (string) 281 diff lines of the patch (string)
218 </dd> 282 </dd>
219 </dl><a NAME="GitDiffParser.headerLength" ID="GitDiffParser.headerLength"></a> 283 </dl>
284 <a NAME="GitDiffParser.headerLength" ID="GitDiffParser.headerLength"></a>
220 <h4>GitDiffParser.headerLength</h4> 285 <h4>GitDiffParser.headerLength</h4>
221 <b>headerLength</b>(<i></i>) 286 <b>headerLength</b>(<i></i>)
287
222 <p> 288 <p>
223 Public method to get the header length. 289 Public method to get the header length.
224 </p><dl> 290 </p>
291 <dl>
225 <dt>Returns:</dt> 292 <dt>Returns:</dt>
226 <dd> 293 <dd>
227 length of the header (integer) 294 length of the header (integer)
228 </dd> 295 </dd>
229 </dl> 296 </dl>

Mercurial Repository: eric

eric ide

mercurial