SAPsim package

Subpackages

• SAPsim.utils package
  • Submodules
  • SAPsim.utils.exceptions module
    • ARegisterNegativeInt
    • ARegisterNotEnoughBits
    • ArgButNoMnemonic
    • BRegisterNegativeInt
    • BRegisterNotEnoughBits
    • DroppedOffBottom
    • DuplicateAddress
    • FirstHexitGreaterThan15
    • FirstHexitNegative
    • InstructionRequiresArg
    • InvalidAddress
    • InvalidArg
    • InvalidFileExtension
    • InvalidFirstHexit
    • InvalidInstructionString
    • InvalidMnemonic
    • JumpToNegativeAddress
    • LoadFromUnmappedAddress
    • MnemonicButNoArg
    • MoreThan16MappedAddresses
    • NegativeAddress
    • NonNumericalAddress
    • RowWithNoAddress
    • SecondHexitGreaterThan15
    • SecondHexitNegative
    • print_debug_info()
  • SAPsim.utils.execute module
    • execute_full_speed()
    • execute_next()
  • SAPsim.utils.globs module
    • A
    • B
    • EXECUTING
    • FLAG_C
    • FLAG_Z
    • MAX_UNSIGNED_VAL_IN_REGISTERS
    • MNEMONIC_TO_OPCODE
    • NUM_BITS_IN_REGISTERS
    • OPCODE_TO_MNEMONIC
    • PC
    • RAM
    • table_fmt
  • SAPsim.utils.helpers module
    • check_state()
    • check_state_all()
    • clone_dict()
    • get_state()
    • i2b()
    • instruction_to_byte()
    • pad_hex()
    • parse_arg()
    • parse_byte()
    • parse_opcode()
    • print_RAM()
    • print_info()
    • reset_globals()
    • setup_4bit()
    • setup_8bit()
    • setup_n_bit()
  • SAPsim.utils.instructions module
    • OPCODE_TO_INSTR_PROCEDURE
    • add()
    • hlt()
    • jc()
    • jmp()
    • jz()
    • lda()
    • ldi()
    • nop()
    • out()
    • sta()
    • sub()
  • SAPsim.utils.parser module
    • parse_csv()
  • Module contents

Module contents

SAPsim.run(prog_path: str, **kwargs) → None

Run given .csv program.

Parameters:

• prog_path (str) – .csv file in SAPsim format.

• **kwargs – See below

Keyword Arguments:

• debug (bool) –

  • Whether to run in debug mode (True) or at full speed (False)

  • Default is full speed

• change (str) –

  • Comma-separated list of changes to RAM

  • Useful for debugging programs (edit a value without changing CSV)

  • Also useful for autograding programs (overwrite a reserved instruction/data value)

  • Format: <addr>:<base-10 value>,<addr>:<base-10 value>, …

• format (str) –

  • Table format

  • Options: https://github.com/astanin/python-tabulate#table-format

• bits (int) –

  • Number of bits in unsigned registers

  • Default 8

Returns:

dict containing all final values in globs.py, used for autograding

Return type:

dict

SAPsim.run_and_return_state(prog_path: str, **kwargs) → dict[str, Any]

Run given .csv program and return final state. Just a wrapper around run() that can be used for autograding.

The rest of the docstring is identical to that of run().

Parameters:

• prog_path (str) – .csv file in SAPsim format.

• **kwargs – See below

Keyword Arguments:

• debug (bool) –

  • Whether to run in debug mode (True) or at full speed (False)

• change (str) –

  • Comma-separated list of changes to RAM

  • Useful for debugging programs (edit a value without changing CSV)

  • Also useful for autograding programs (overwrite a reserved instruction/data value)

  • Format: <addr>:<base-10 value>,<addr>:<base-10 value>, …

• format (str) –

  • Table format

  • Options: https://github.com/astanin/python-tabulate#table-format

• bits (int) –

  • Number of bits in unsigned registers

Returns:

dict containing all final values in globs.py, used for autograding

Return type:

dict