Official library for working with the BIN file format
Project description
What is NBIN
NBIN is a data serialization format that aims to make it easier to create and store bytecode for arbitrary programming languages. For this purpose, it has special data types, as well as its own binary file structure
NBIN has its own binary notation format, which can be broadly described as follows:
<i8> ::= 00h <byte>{1}
<i16> ::= 01h <byte>{2}
<i32> ::= 02h <byte>{4}
<i64> ::= 03h <byte>{8}
<u8> ::= 05h <byte>{1}
<u16> ::= 06h <byte>{2}
<u32> ::= 07h <byte>{4}
<u64> ::= 09h <byte>{8}
<float> ::= 10h <byte>{4}
<bool> ::= 11h <byte>
<str> ::= 12h <lenght> <byte>+
<null> ::= 13h
<list> ::= 14h <lenght> <exp>+
<block> ::= 15h <lenght> <command>+
<command> ::= 16h <lenght> <byte>+ <lenght> <exp>+
/* unsigned int */
<lenght> ::= <byte>{4}
What is written in "{ ... }" is the number of repetitions
Each version of NBIN defines its own specification, for example the current NBIN (NBIN 1) uses the following specification:
- Supported data types:
- i8 - 1 sign byte
- i16 - 2 sign bytes
- i32 - 4 sign bytes
- i64 - 8 sign bytes
- u8 - 1 unsigned byte
- u16 - 2 unsigned bytes
- u32 - 4 unsigned bytes
- u64 - 8 unsigned bytes
- str - UNICODE string
- bool - logical type
- float - 32-bit fractional number
- command - command
- block - block with commands
- list - not a typed list
- null - no value
- The length of any collection NBIN is a 32-bit unsigned number
- Any NBIN object can be written in a binary file (it is not necessary that everything be wrapped in a block)
- NBIN tries to support as many types as possible
- NBIN types should satisfy both low-level and high-level programming needs
NBIN library
There are two functions here:
load
- accepts bytes in NBIN format as input and returns a Python objectdump
- takes a Python object as input and returns bytes in NBIN format
In general, these two functions deal with object conversion
Usage example:
from NBIN.nbin import *
# An example of an abstract syntax tree in some programming language
code = [
Command('PRINT', ['Hello world!']),
[
'FUNC',
Block([
Command('SET', ['a', 14]),
Command('SET', ['b', 2]),
Command('SUM', ['a', 'b']),
]),
],
Command('CALL', ['FUNC'])
]
# Write to file
with open('test.bin', 'wb') as file:
result = dump(code)
file.write()
# Reading from a file
with open('test.bin', 'rb') as file:
result = load( file.write() )
NBIN data types in Python
NBIN ports the following types to Python:
INT
- data type, for fine-tuning the integer typeCommand
- command typeBlock
- a type that describes a block
INT
If you want to create an integer of 1 byte in size, and at the same time so that it can have a sign, then do this:
number = INT('i8', 52)
i8
here is the NBIN data type.
The entire list of these types is stored in the TYPES_INT
constant, and as an annotation - LITERAL_TYPES_INT
.
In this case, you need to observe the allowed ranges for each type; they can be taken from the RANGES_TYPES_INT
constant.
Command
Command
allows you to define your variable, with its name and parameters.
Usage example:
cmd = Command('echo', ['Hello world!'])
Here: name
(in the example it is equal to echo
) is the first parameter of Command
, and the parameters are passed to the second parameter Command
in the form of a list, and can be of any type.
Block
Block
allows you to combine a list of commands into one block.
Usage example:
func = Block([
Command('PRINT', ['Hello!']),
Command('EXIT'),
])
Only a list of commands can be passed into it!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file NBIN-1.2.tar.gz
.
File metadata
- Download URL: NBIN-1.2.tar.gz
- Upload date:
- Size: 7.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d4e0c5817a9e0f6230c58a304220428a5ab7ac7e575c93fab472e503be5c384 |
|
MD5 | a98fb56d0fcb2deab072e50bed7a554c |
|
BLAKE2b-256 | 288425566ff7c73bd69775d73acc20fae5700bb4f881a243d56fc10eb3b00e08 |
Provenance
File details
Details for the file NBIN-1.2-py3-none-any.whl
.
File metadata
- Download URL: NBIN-1.2-py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 109d0c36432f83ddb0be9f595d923a0d34418a0489924b0701a532b36d3a6b13 |
|
MD5 | 945822e70e716506b5768b90ef5ff43c |
|
BLAKE2b-256 | 942fcc1f6adb34b92a30bab551a62dae4888805989af21677cf3b85a4c91bce0 |