Port

FileEventIn

FileEventIn(path: str | Path, recursive: bool = False)

Bases: Input, FileSystemEventHandler

File system events input port. Watches file/directory modifications. Produces FileEventMsg objects.

Parameters:

• path (str | Path) –

  File/directory path to watch

• recursive (bool, default: False ) –

  True to watch directory path recursively

is_opened

is_opened: bool

True if port is listening messages / ready to send messages

subscribe

subscribe(
    type: None | Container[FileEvent] | FileEvent | str = None,
    path: None | Container[Path] | Path = None,
) -> Callable

Decorator to subscribe a callable to the input's messages.

Decorator without arguments subscribes a callable to all the input's messages.

Decorator with arguments subscribes a callable to the input's messages that match conditions set by arguments. It works the same way as message's matches method:

1. If condition is None or omitted it matches anything.

2. If condition equals the message's attribute value it matches the attribute.

3. If condition is a container (list, tuple) and contains the message's attribute value, it matches the attribute.

Examples

1. Calls function for all MIDI port's messages:

   @midi_input_instance.subscribe
   def function(msg: MidiMsg) -> None:
       pass
   

2. Calls function for OSC messages from specific address:

   @osc_input_instance.subscribe(address='/live/song/get/track_data')
   def function(msg: OscMsg) -> None:
       pass
   

3. Call object instance method for MIDI port's "note on" and "note off" messages:

   midi_input_instance.subscribe((MidiType.NOTE_ON, MidiType.NOTE_OFF))(object.method)
   

Returns:

• Callable –

  Subscribed callable.