Filesplit¤
The Filesplit
class allows the user to cut binary files into numbered file segments with the format filename_1.txt
, filename_2.txt
, etc. It would typically be used as a first step in a workflow if a large file needs to be divided into many smaller files.
The class is a fork of Ram Prakash Jayapalan's filesplit module with a few minor tweaks. The most important is that the split
function takes a sep
argument to allow the user to specify the separator between the filename and number in each generated file.
lexos.cutter.filesplit.Filesplit
¤
Filesplit class.
Source code in lexos\cutter\filesplit.py
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 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 300 301 302 303 304 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 |
|
__init__()
¤
Constructor.
Source code in lexos\cutter\filesplit.py
22 23 24 25 26 |
|
__process_split(fi, fo, split_size, carry_over, newline=False, output_encoding=None, include_header=False, header=None)
¤
Split. the incoming stream.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
fi |
IO
|
Input-file like object that implements read() and readline() |
required |
method. fo (IO): File-like object that implements write() method. split_size (int): File split size in bytes. newline (bool): When True, splits at newline on top of bytes. output_encoding (str): Split file encoding. include_header (bool): When True, first line is treated as header and each split receives the header. This flag is dependant on newline flag to be set to True as well. carry_over (str): Any carry over bytes to the next file. header (str): Header from the file if any.
Returns:
Name | Type | Description |
---|---|---|
tuple |
Tuple
|
carry_over, output_size, header |
Source code in lexos\cutter\filesplit.py
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 |
|
merge(input_dir, sep='_', output_file=None, manifest_file=None, callback=None, cleanup=False)
¤
Merge the split files based off manifest file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input_dir |
str
|
Directory containing the split files and manifest file |
required |
sep |
str
|
Separator used in the file names. |
'_'
|
output_file |
str
|
Final merged output file path. If not provided, the final merged filename is derived from the split filename and placed in the same input dir. |
None
|
manifest_file |
str
|
Path to the manifest file. If not provided, the process will look for the file within the input_dir. |
None
|
callback |
Callable
|
Callback function [func (str, long)] that accepts 2 arguments - path to destination, size of the file in bytes. |
None
|
cleanup |
bool
|
If True, all the split files and the manifest file will be deleted after the merge, leaving behind the merged file. |
False
|
Raises:
Type | Description |
---|---|
FileNotFoundError
|
If missing manifest and split files. |
NotADirectoryError
|
If input path is not a directory. |
Source code in lexos\cutter\filesplit.py
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 303 304 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 |
|
split(file, split_size, sep='_', output_dir='.', callback=None, **kwargs)
¤
Splits the file into chunks based on the newline char in the file.
By default uses binary mode.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file |
str
|
Path to the source file. |
required |
split_size |
int
|
File split size in bytes. |
required |
sep |
str
|
Separator to be used in the file name. |
'_'
|
output_dir |
str
|
Output dir to write the split files. |
'.'
|
callback |
Callable
|
Callback function [func (str, long, long)] that accepts three arguments - full file path to the destination, size of the file in bytes and line count. |
None
|
Source code in lexos\cutter\filesplit.py
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 |
|