Separate the lib from scripts

Author: dolkow

.gitignore

@@ -1,2 +1,4 @@
 __pycache__
-/tests/
+.*
+*.xnb
+*.out

stardew.py

@@ -5,8 +5,8 @@
 
 import xnbread
 
-from readers import *
-from readers.basic import _read_str, _u32
+from xnbread.readers import *
+from xnbread.readers.basic import _read_str, _u32
 
 def _bmxml(factory):
 	# TODO: parse this xml? Nahhh.

xnbread.py

@@ -1,70 +1,7 @@
 #!/usr/bin/env python3
 #coding=utf8
 
-from readers import *
-from util import TODO, define_tuple, dumphex, log
-import struct
-
-KNOWN_FLAGS = 0x81
-FLAG_BIT_HIDEF      = 0x01
-FLAG_BIT_COMPRESSED = 0x80
-
-Header = define_tuple('Header', '<3scBBI', 10,
-		'magic target version flags fsize')
-
-def read_payload(f):
-	header = Header._make(struct.unpack(Header.format, f.read(Header.size)))
-	assert header.magic == b'XNB'
-	assert header.target in b'wmx'
-	assert header.version == 5
-	assert header.flags & KNOWN_FLAGS == header.flags
-	if header.flags & FLAG_BIT_COMPRESSED:
-		import lzx
-		dsize, = struct.unpack('<I', f.read(4))
-		csize = header.fsize - Header.size - 4
-		data = f.read(csize)
-		assert len(data) == csize
-		data = lzx.decompress(data, csize, dsize)
-		assert len(data) == dsize
-	else:
-		csize = header.fsize - Header.size
-		data = f.read(csize)
-		assert len(data) == csize
-	return data
-
-def decode_payload(data):
-	# now that we have the payload, let's decode it
-	stream = ByteStream(data)
-	nreaders = stream.read_7bitint()
-	reader_names = []
-	for i in range(nreaders):
-		name = stream.read_string()
-		version = stream.read_u32()
-		assert version == 0, "never seen a non-zero version before"
-		reader_names.append(name)
-	factory = ObjectFactory(stream, reader_names)
-	nshared = stream.read_7bitint()
-	primary = factory.read()
-	if nshared != 0:
-		TODO("Haven't implemented shared resources yet")
-	return primary
-
-def dump(f, raw=False):
-	data = read_payload(f)
-	if raw:
-		sys.stdout.buffer.write(data)
-		return
-	out = decode_payload(data)
-	if type(out) is dict:
-		for key in out:
-			print(key, '==>')
-			print(out[key])
-			print()
-	elif type(out) in (list, tuple):
-		for pair in enumerate(out):
-			print('%3d: %s' % pair)
-	else:
-		print(out)
+from xnbread import dump
 
 if __name__ == '__main__':
 	import sys

xnbread/__init__.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python3
+#coding=utf8
+
+from .container import read_payload, decode_payload, dump
+from . import readers

xnbread/container.py

@@ -0,0 +1,69 @@
+#!/usr/bin/env python3
+#coding=utf8
+
+from .readers import *
+from .util import TODO, define_tuple, dumphex, log
+import struct
+
+KNOWN_FLAGS = 0x81
+FLAG_BIT_HIDEF      = 0x01
+FLAG_BIT_COMPRESSED = 0x80
+
+Header = define_tuple('Header', '<3scBBI', 10,
+		'magic target version flags fsize')
+
+def read_payload(f):
+	header = Header._make(struct.unpack(Header.format, f.read(Header.size)))
+	assert header.magic == b'XNB'
+	assert header.target in b'wmx'
+	assert header.version == 5
+	assert header.flags & KNOWN_FLAGS == header.flags
+	if header.flags & FLAG_BIT_COMPRESSED:
+		from . import lzx
+		dsize, = struct.unpack('<I', f.read(4))
+		csize = header.fsize - Header.size - 4
+		data = f.read(csize)
+		assert len(data) == csize
+		data = lzx.decompress(data, csize, dsize)
+		assert len(data) == dsize
+	else:
+		csize = header.fsize - Header.size
+		data = f.read(csize)
+		assert len(data) == csize
+	return data
+
+def decode_payload(data):
+	# now that we have the payload, let's decode it
+	stream = ByteStream(data)
+	nreaders = stream.read_7bitint()
+	reader_names = []
+	for i in range(nreaders):
+		name = stream.read_string()
+		version = stream.read_u32()
+		assert version == 0, "never seen a non-zero version before"
+		reader_names.append(name)
+	factory = ObjectFactory(stream, reader_names)
+	nshared = stream.read_7bitint()
+	primary = factory.read()
+	if nshared != 0:
+		TODO("Haven't implemented shared resources yet")
+	return primary
+
+def dump(f, raw=False):
+	import sys
+	data = read_payload(f)
+	if raw:
+		sys.stdout.buffer.write(data)
+		return
+	out = decode_payload(data)
+	if type(out) is dict:
+		for key in out:
+			print(key, '==>')
+			print(out[key])
+			print()
+	elif type(out) in (list, tuple):
+		for pair in enumerate(out):
+			print('%3d: %s' % pair)
+	else:
+		print(out)
+

lzx.py xnbread/lzx.py

@@ -6,7 +6,7 @@
 
 import struct
 
-from util import TODO, clamp, dumphex, log
+from .util import TODO, clamp, dumphex, log
 
 # block types:
 VERBATIM     = 1

readers/__init__.py xnbread/readers/__init__.py

@@ -7,7 +7,8 @@
 from collections import namedtuple
 from functools import partial
 from inspect import signature
-from util import TODO, log, dumphex
+
+from ..util import TODO, log, dumphex
 
 GENERIC_READER_PTN = re.compile(r'([^[`]+)(?:`(\d+)\[(.*)\])?')
 PLAIN_TYPE_PTN = re.compile(r'([^,]+)(?:, ([^,]+), Version=([0-9.]+), Culture=([^,]+), PublicKeytoken=([a-f0-9]+))?')