epubchooser
Set which parts of an epub should be omitted.
It is possible to filter away chapters and ranges of elements from an epub file. This is a helper program for that purpose.
EpubChooser
Class to determine which parts of an epub should be omitted.
Attributes:
Name | Type | Description |
---|---|---|
presenter |
EpubPresenter
|
the presenter of the metadata and content of the epub file. |
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
|
__init__(path)
Initialise the EpubChooser class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
str
|
path to the document |
required |
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
313 314 315 316 317 318 319 |
|
do_xpaths_exist()
Check if xpaths exist in this document.
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
346 347 348 349 350 351 352 353 354 355 356 357 |
|
exclude_chapters()
Choose which chapters should be omitted from the epub file.
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 |
|
exclude_tags()
Choose which html tags should be removed from epub file.
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
|
EpubPresenter
Class to present metadata and content.
Attributes:
Name | Type | Description |
---|---|---|
path |
str
|
path to the epub document |
book |
epub.Book
|
the epub document to handle. |
metadata |
xslsetter.MetadataHandler
|
the corpus metadata attached to the book. |
xpaths |
list of str
|
the xpaths of the remaining html document after unwanted chapters have been removed. |
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
|
book_titles
property
Get the all linear chapters of the epub book.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
book |
epub.Book
|
The epub book element |
required |
Returns:
Type | Description |
---|---|
list[str]
|
The body of an xhtml file found in the epub file. |
excluded_chapters
property
writable
Show the excluded chapters.
not_chosen
property
The chapter that are not excluded.
skip_elements
property
writable
Return a string representing the html elements that is omitted.
__init__(path)
Initialise the EpubPresenter class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
str
|
path to the epub document |
required |
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
145 146 147 148 149 150 151 152 153 154 |
|
present_html()
Print the html that is left after omitting chapters.
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
226 227 228 229 230 |
|
print_choice()
Present omitted and present chapters.
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
190 191 192 193 194 195 196 197 198 |
|
print_xpath(element, level, indent, out, xpath='', element_no=1)
Format an html document and write xpaths at tags openings.
This function formats html documents for readability and prints xpaths to at tag openings, to see the structure of the given document and make it possible to choose xpaths. It ruins white space in text parts.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
etree._Element
|
the element to format. |
required |
level |
int
|
indicate at what level this element is. |
required |
indent |
int
|
indicate how many spaces this element should be indented |
required |
out |
stream
|
a buffer where the formatted element is written. |
required |
xpath |
str
|
The xpath of the parent of this element. |
''
|
element_no |
int
|
the position of the element tag |
1
|
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
|
save()
Save metadata.
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
207 208 209 210 |
|
RangeHandler
Handle skip_elements ranges.
Attributes:
Name | Type | Description |
---|---|---|
xpaths |
list of str
|
the xpaths of the remaining html document after unwanted chapters have been removed. |
ranges |
set of tuple of int
|
Each tuple has a pair of ints pointing to places in the xpaths list. |
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
|
ranges
property
Return the textual version of the range.
add_range(xpath_pair)
Add a new range.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
xpath_pair |
tuple of str
|
a pair of xpaths. |
required |
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
|
as_text(pair)
Return a range as text.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pair |
tuple
|
pairs of indexes to elements in self.xpaths. The second part of the tuple may be empty. |
required |
Returns:
Type | Description |
---|---|
str
|
the string representation |
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
|
check_overlap(xpath_pair)
Check if xpath_pair overlaps any of the existing ranges.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
xpath_pair |
tuple of str
|
a pair of xpaths |
required |
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
|
check_range(xpath_pair)
Check that the xpath_pair is a valid range.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
xpath_pair |
tuple of str
|
a pair of xpaths |
required |
Raises:
Type | Description |
---|---|
KeyError
|
if invalid content is found. |
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
|
clear_ranges()
Clear the _ranges set.
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
47 48 49 |
|
main()
Set which parts of an epub should be omitted.
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
426 427 428 429 430 431 432 |
|
parse_options()
Parse the commandline options.
Returns:
Type | Description |
---|---|
argparse.Namespace
|
the parsed commandline arguments |
Source code in /home/anders/projects/CorpusTools/corpustools/epubchooser.py
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 |
|