fretwork package

Subpackages

• fretwork.midi package
  • Submodules
    • fretwork.midi.DataTypeConverters module
    • fretwork.midi.EventDispatcher module
    • fretwork.midi.MidiFileParser module
    • fretwork.midi.MidiInFile module
    • fretwork.midi.MidiInStream module
    • fretwork.midi.MidiOutFile module
    • fretwork.midi.MidiOutStream module
    • fretwork.midi.MidiToText module
    • fretwork.midi.RawInstreamFile module
    • fretwork.midi.RawOutstreamFile module
    • fretwork.midi.constants module
• fretwork.mixstream package
  • Module contents

Submodules

fretwork.audio module

fretwork.log module

Logging module

Usage

Configure the logger in your launcher:

from fretwork import log

# configure the logger
log.configure('file.log', logging.DEBUG)

Import and use it:

import logging

logger = logging.getLogger(__name__)

fretwork.log.configure(log_filename, log_level=20)

Configure logging.

Parameters:

• log_filename – name of the file where logs are saved.
• log_level – level of logs (default: logging.INFO).

fretwork.task module ++++++++++++++++++++-

class fretwork.task.Task

Bases: object

run(ticks)

started()

stopped()

class fretwork.task.TaskEngine(engine)

Bases: object

addTask(task, synced=True)

Add a task

checkTask(task)

Check if a task exists

exit()

Remove all tasks.

pauseTask(task)

Pause a task

removeTask(task)

Remove a task

resumeTask(task)

Resume a paused task

run()

Run one cycle of the task scheduler engine.

runTask(task, tick=0)

fretwork.timer module

class fretwork.timer.FpsTimer

Bases: fretwork.timer.Timer

delay(fps)

Reimplementation of pygame.time.Clock.tick() delay functionality. Needed for fps limiting.

get_fps()

Calculates and return the average fps then resets the counter.

tick()

Calculates time delta since last call. Also accumulates the delta and increments frame counter.

class fretwork.timer.Timer

Bases: object

delta_time()

Return time delta since startTime

tick()

Returns the delta between the current and previous ticks

time()

Get current time in milliseconds

fretwork.unicode module

Miscellaneous functions for helping us handle Unicode correctly in the face of what we’ve done in the past.

fretwork.unicode.unicodify(s)

Turns s into a Unicode string

Parameters:s – input string Returns:Unicode version of s

fretwork.unicode.utf8(s)

Turns s into a valid UTF-8 bytestring. @param s: input @return: UTF-8-encoded version of s

fretwork.version module