pagesmith.HtmlPageSplitter
Split HTML into pages, preserving HTML tags while respecting the original document structure.
Source code in src/pagesmith/html_page_splitter.py
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 131 132 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 | |
__init__(content='', *, root=None, target_length=PAGE_LENGTH_TARGET, error_tolerance=PAGE_LENGTH_ERROR_TOLERANCE)
Initialize the HTML page splitter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
content
|
str
|
HTML content string to split (optional if root is provided) |
''
|
root
|
_Element | None
|
Parsed lxml element tree root (optional if content is provided) |
None
|
target_length
|
int
|
Target size for each page in characters |
PAGE_LENGTH_TARGET
|
error_tolerance
|
float
|
Tolerance for page size variation (default 0.25) |
PAGE_LENGTH_ERROR_TOLERANCE
|
Source code in src/pagesmith/html_page_splitter.py
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 | |
pages()
Split content into pages.
Source code in src/pagesmith/html_page_splitter.py
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 | |
pagesmith.PageSplitter
Split pure text into pages at natural break points such as paragraphs or sentences.
Source code in src/pagesmith/page_splitter.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 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 | |
find_nearest_page_end(page_start_index)
Find the nearest page end.
Source code in src/pagesmith/page_splitter.py
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | |
find_nearest_page_end_match(page_start_index, pattern)
Find the nearest regex match around expected end of page.
In no such match in the vicinity, return None. Calculate the vicinity based on the expected PAGE_LENGTH_TARGET and PAGE_LENGTH_ERROR_TOLERANCE.
Source code in src/pagesmith/page_splitter.py
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 | |
handle_p_tag_split(page_start_index, nearest_page_end)
Find the position of the last closing
tag before the split.Source code in src/pagesmith/page_splitter.py
117 118 119 120 121 122 123 124 125 126 127 128 129 130 | |
pages()
Split a text into pages of approximately equal length.
Also clear headings and recollect them during pages generation.
Source code in src/pagesmith/page_splitter.py
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 | |
pagesmith.ChapterDetector
Detect chapters in pure text to create a Table of Contents.
Source code in src/pagesmith/chapter_detector.py
20 21 22 23 24 25 26 27 28 29 30 31 32 33 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 131 132 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 | |
__init__(min_chapter_distance=MIN_CHAPTER_DISTANCE)
Minimum character distance required between chapters.
Chapter signatures detected within this threshold from previously detected chapters will be ignored. Default is 20 characters.
Source code in src/pagesmith/chapter_detector.py
23 24 25 26 27 28 29 | |
get_chapters(page_text)
Detect chapter headings in the text.
Return a list of Chapter objects containing: - title: The chapter title - position: The character position in the text where the chapter starts
Source code in src/pagesmith/chapter_detector.py
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | |
prepare_chapter_patterns()
Prepare regex patterns for detecting chapter headings.
Source code in src/pagesmith/chapter_detector.py
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 131 132 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 | |
pagesmith.refine_html
collapse_consecutive_br(root, keep_empty_tags_set, ids_to_keep_set)
From
tags sequence, keep only the first one.
This function searches for consecutive
tags and removes all but the first one
in each sequence. Whitespace between
tags is ignored for determining consecutive tags.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
root
|
Element
|
The root element of the lxml tree |
required |
Source code in src/pagesmith/refine_html.py
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 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 | |
has_meaningful_content(element, keep_empty_tags_set, ids_to_keep_set, check_tail=True)
Check if element/children has non-whitespace content or in the keep_empty_tags_set.
Source code in src/pagesmith/refine_html.py
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 | |
process_class_and_style(root, tags_with_classes)
Remove class and style attributes from elements not in tags_with_classes.
Source code in src/pagesmith/refine_html.py
308 309 310 311 312 313 314 315 316 317 | |
refine_html(input_html=None, *, root=None, allowed_tags=ALLOWED_TAGS, tags_to_remove_with_content=REMOVE_WITH_CONTENT, keep_empty_tags=KEEP_EMPTY_TAGS, ids_to_keep=(), tags_with_classes=None)
Sanitize and normalize HTML content.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input_html
|
str | None
|
HTML string to clean |
None
|
root
|
Optional[Element]
|
Alternatively instead of input_html - lxml tree root element |
None
|
allowed_tags
|
Iterable[str]
|
Tags that are allowed in the output HTML |
ALLOWED_TAGS
|
tags_to_remove_with_content
|
Iterable[str]
|
Tags to be completely removed along with their content |
REMOVE_WITH_CONTENT
|
keep_empty_tags
|
Iterable[str]
|
Tags that should be kept even if they have no content |
KEEP_EMPTY_TAGS
|
ids_to_keep
|
Iterable[str]
|
IDs that should be kept even if their tags are not in allowed_tags |
()
|
tags_with_classes
|
dict[str, str] | None
|
Dictionary mapping tag names to class strings to add |
None
|
Returns:
| Type | Description |
|---|---|
str
|
Cleaned HTML string |
Source code in src/pagesmith/refine_html.py
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 | |
remove_empty_elements(ids_to_keep_set, keep_empty_tags_set, root)
Remove empty elements and divs that contain only
tags and whitespace.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ids_to_keep_set
|
set[str]
|
Set of element IDs that should be preserved |
required |
keep_empty_tags_set
|
set[str]
|
Set of tags that should be kept even when empty |
required |
root
|
Element
|
The root element of the lxml tree |
required |
Returns:
| Type | Description |
|---|---|
None
|
List of removed elements |
Source code in src/pagesmith/refine_html.py
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 | |
remove_tags_with_content(root, tags_to_remove_set)
Remove specified tags along with their content.
Source code in src/pagesmith/refine_html.py
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 | |
unwrap_unknow_tags(allowed_tags_set, ids_to_keep_set, root)
Unwrap tags that are not in the allowed set but preserve their content.
Source code in src/pagesmith/refine_html.py
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 | |