Documentation for Python

[ArekPiekarz]

Does the Python version of symbolic have any documentation? I couldn't find it on https://pypi.org/project/symbolic/ or in the source code. For instance I would like to know how to turn frame information like C++ binary name and address into a source file location with a line number. Is it possible to do?

[jan-auer]

You're right, the Python documentation is currently very insufficient. Until we catch up with this, you can have a look at this test for an example of how to symbolicate:

symbolic/py/tests/test_symcache.py

Lines 29 to 43 in bc5246b

	archive = Archive.open(path)
	obj = archive.get_object(arch="x86_64")
	symcache = obj.make_symcache()
	# Make sure our stream starts with the header
	stream = symcache.open_stream()
	assert stream.read(4) == b"SYMC"
	# Make s symcache from the entire thing
	stream = symcache.open_stream()
	cache = SymCache.from_bytes(stream.read())
	# Verify a known symbol
	symbol = cache.lookup(0x107BB9F25 - 0x107BB9000)[0]
	assert symbol.symbol == "main"

It's worth pointing out that symbolic does not help you to locate the files. You need a separate system to search them on your machine, potentially by loading a path pointed to in the crash, or by consulting a symbol server.