Skip to content

Instantly share code, notes, and snippets.

@nicwolff
Last active June 26, 2024 23:25
Show Gist options
  • Save nicwolff/b4da6ec84ba9c23c8e59 to your computer and use it in GitHub Desktop.
Save nicwolff/b4da6ec84ba9c23c8e59 to your computer and use it in GitHub Desktop.
Python script to break large XML files
import os
import sys
from xml.sax import parse
from xml.sax.saxutils import XMLGenerator
class CycleFile(object):
def __init__(self, filename):
self.basename, self.ext = os.path.splitext(filename)
self.index = 0
self.open_next_file()
def open_next_file(self):
self.index += 1
self.file = open(self.name(), 'w')
def name(self):
return '%s%s%s' % (self.basename, self.index, self.ext)
def cycle(self):
self.file.close()
self.open_next_file()
def write(self, str):
self.file.write(str)
def close(self):
self.file.close()
class XMLBreaker(XMLGenerator):
def __init__(self, break_into=None, break_after=1000, out=None, *args, **kwargs):
XMLGenerator.__init__(self, out, encoding='utf-8', *args, **kwargs)
self.out_file = out
self.break_into = break_into
self.break_after = break_after
self.context = []
self.count = 0
def startElement(self, name, attrs):
XMLGenerator.startElement(self, name, attrs)
self.context.append((name, attrs))
def endElement(self, name):
XMLGenerator.endElement(self, name)
self.context.pop()
if name == self.break_into:
self.count += 1
if self.count == self.break_after:
self.count = 0
for element in reversed(self.context):
self.out_file.write("\n")
XMLGenerator.endElement(self, element[0])
self.out_file.cycle()
XMLGenerator.startDocument(self)
for element in self.context:
XMLGenerator.startElement(self, *element)
filename, break_into, break_after = sys.argv[1:]
parse(filename, XMLBreaker(break_into, int(break_after), out=CycleFile(filename)))
@gadamvijay
Copy link

Call like:

python XML_breaker.py books.xml book 1000

where "books.xml" is the name of your input file, "book" is the element you want to split on, and 1000 is how many you want in each file. It will create "books1.xml", "books2.xml", &c.

I am pretty new to the python code, can you please hlep me where in the given python code i can put my xml file name with it's location.

@gadamvijay
Copy link

@nicwolff Great script! Thank you! I am trying to adapt the script but am at my limits. My file looks like this:

<?xml version="1.0" encoding="utf-8"?>
<tmx version="1.4">
<header creationtool="Olifant" creationtoolversion="3.0.8.0" datatype="unkown" segtype="paragraph" adminlang="EN" srclang="DE" creationdate="20170608T122356Z" creationid="DZ" changedate="20170608T132457Z" changeid="DZ">
</header>
<body>
<tu>bla</tu>
<tu>bla</tu>
</body>
</tmx>

Splitting by <tu> elements works just fine. However, in the generated files, only the first file contains the header. In all other files the header is gone. Any tip how to adjust the script to get the header into the other split files?
Any help is much appreciated!
Thanks!

I am in the same boat, can you please let me know if you have got any solution.

@gadamvijay
Copy link

Your script has been very useful once I figured out a little more python. One more question. If it comes across an XML that is missing a tag, it will crash. Fair enough. Where can I add try / except to explicitly ask this script to release the file that was being written when it came across a bad xml file with missing tag?
I'm trying to automate splitting. In case splitting fails, I want to automatically delete the splits that were created. Currently, I'm able to delete all splits except for the last one where the script crashed, at least until the python script is done running.

Can you please let me know where you are giving you the input file name, the element to split on etc..,

@xavierigneous
Copy link

Great job.

@magnatm
Copy link

magnatm commented Dec 28, 2020

Thank you very much!

@typonaut
Copy link

typonaut commented Jan 16, 2021

I think there is a bug in this script, in that it is not able to distinguish between elements named the same, that occur at different levels. If you feed it:

python38 my.xml name 25000

Where my.xml look like:

<root>
    <name>
        <cd>
            <name>
            </name>
        </cd>
       <cassette>
            <name>
             </name>
        </cassette>
    </name>
</root>

The script believes that there are three name elements, where you probably only want it to believe there is one. So it consequently splits the files in strange positions, and you'll probably end up with more records than you thought you had.

@alabrashJr
Copy link

@positivity13
for those who are getting the following error ,

self.file.write(str)
TypeError: write() argument must be str, not bytes

change the write function into

    def write(self, str_text):
        self.file.write(str_text.decode("utf-8") if isinstance(str_text,bytes) else str_text)

@11novi
Copy link

11novi commented Aug 2, 2022

Thank you so much. It works very well.

@havardox
Copy link

havardox commented Oct 8, 2022

@positivity13 for those who are getting the following error ,

self.file.write(str)
TypeError: write() argument must be str, not bytes

change the write function into

    def write(self, str_text):
        self.file.write(str_text.decode("utf-8") if isinstance(str_text,bytes) else str_text)

Thanks!

@ogirdorodrigo
Copy link

Hello Nic,
A licence would be great. I would like to know whether or not I can reuse your code and what are the terms.
Cheers!
R

@angiezyz
Copy link

angiezyz commented Mar 5, 2024

Thanks for sharing the script! One issue I got is that the last splitted file always failed to open, the error looked something like 'error on line {N} at column {C}: Premature end of data in tag debt line {N}'. Is there anywhere in the script that can be modified to resolve this issue?

@TancrediCogne
Copy link

Thanks for sharing this script! It works so well!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment