Skip to content

ableton.v3.control_surface.components.step_sequence (runtime)

Live 11 — Live Object Model & framework reference (descriptions and signatures).

Functions

create_sequencer_clip(track, slot=None, length=None)

depends(**dependencies)

get_bar_length(clip=None)

listens(event_path, *a, **k)

liveobj_changed(obj, other)

liveobj_valid(obj)

prepare_new_clip_slot(track, stop=False)

song()

Classes

class Component(ControlManager)

Properties

  • application
  • is_root
  • layer
  • parent
  • song

Methods

__init__(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=True, is_private=True, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_add_child(self, component)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_update_is_enabled(self)
add_any_clipboard_has_content_listener(self, slot, identify_sender=False, *a, **k)
add_children(self, *children)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
any_clipboard_has_content_has_listener(self, slot)
any_clipboard_has_content_listener_count(self)
control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
enabled_has_listener(self, slot)
enabled_listener_count(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_enabled(self, explicit=False)
notify_any_clipboard_has_content(self, *a, **k)
notify_enabled(self, *a, **k)
on_enabled_changed(self)
register_clipboard(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_any_clipboard_has_content_listener(self, slot)
remove_enabled_listener(self, slot)
set_enabled(self, enable)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _clipboard_component_instances = [] - Built-in mutable sequence.
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
  • any_clipboard_has_content = False - bool(x) -> bool
  • canonical_parent = None
  • num_layers = 0 - int([x]) -> integer

class EventObject(CompoundDisconnectable)

Methods

__init__(self, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
unregister_disconnectable(self, slot)

class LoopSelectorComponent(Component, Renderable)

Properties

  • application
  • bar_length
  • clipboard
  • is_root
  • layer
  • min_page_time
  • parent
  • song

Methods

__init__(self, name='Loop_Selector', target_track=None, sequencer_clip=None, paginator=None, clipboard_component_type=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_add_child(self, component)
_button_position(self, button_index)
_create_event_handler(self, property_name)
_get_layer_iterable(self)
_grab_all_layers(self)
_has_clip(self)
_increment_page_time(self, delta)
_init_state_from_controls(self, renderable_state)
_init_state_from_listenable_properties(self, renderable_state)
_internal_on_enabled_changed(self)
_on_clip_changed(self)
_on_matrix_pressed(self, button)
_on_page_time_changed_via_matrix(self)
_rectify_page_time(self)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_update_clipboard(self, button)
_update_is_enabled(self)
_update_matrix(self)
_update_matrix_button(self, button, selected, playing, inside_loop)
_update_page_buttons(self)
add_any_clipboard_has_content_listener(self, slot, identify_sender=False, *a, **k)
add_children(self, *children)
add_clipboard_listener(self, slot, identify_sender=False, *a, **k)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
any_clipboard_has_content_has_listener(self, slot)
any_clipboard_has_content_listener_count(self)
clipboard_has_listener(self, slot)
clipboard_listener_count(self)
control_base_type(extra_args=None, extra_kws=None, *a, **k)
control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
dispatch_event(self, name: 'str', value)
enabled_has_listener(self, slot)
enabled_listener_count(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_enabled(self, explicit=False)
notify(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')
notify_any_clipboard_has_content(self, *a, **k)
notify_clipboard(self, *a, **k)
notify_enabled(self, *a, **k)
on_enabled_changed(self)
register_clipboard(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_any_clipboard_has_content_listener(self, slot)
remove_clipboard_listener(self, slot)
remove_enabled_listener(self, slot)
set_clip(self, clip)
set_copy_button(self, button)
set_enabled(self, enable)
set_matrix(self, matrix)
suppress_notifications(self)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _LoopSelectorComponent__on_playing_position_changed = None
  • _LoopSelectorComponent__on_playing_status_changed = None
  • _LoopSelectorComponent__on_sequencer_clip_changed = None
  • _LoopSelectorComponent__on_target_track_color_changed = None
  • _clipboard_component_instances = [] - Built-in mutable sequence.
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
  • any_clipboard_has_content = False - bool(x) -> bool
  • canonical_parent = None
  • delete_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b53940>
  • include_in_top_level_state = True - bool(x) -> bool
  • matrix = <ableton.v2.base.util.Mixin_MatrixControl_ButtonControl object at 0x163b539e8>
  • next_page_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b538d0>
  • num_layers = 0 - int([x]) -> integer
  • prev_page_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b53908>
  • renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class NoteEditorComponent(Component, Renderable)

Properties

  • active_steps
  • application
  • can_change_page
  • clipboard
  • height
  • is_root
  • layer
  • page_length
  • page_time
  • parent
  • pitch_provider
  • song
  • step_count
  • step_length
  • width

Methods

__init__(self, name='Note_Editor', translation_channel=1, full_velocity=None, target_track=None, sequencer_clip=None, grid_resolution=None, clipboard_component_type=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_add_child(self, component)
_add_new_note_in_step(self, pitch, time)
_add_note_in_step(self, step, pitch)
_can_edit(self)
_can_press_or_release_step(self, step)
_create_event_handler(self, property_name)
_delete_notes_in_step(self, step)
_get_alternate_color_for_step(self, index, visible_steps)
_get_clip_notes_time_range(self)
_get_color_for_step(self, index, visible_steps)
_get_layer_iterable(self)
_get_notes_info_from_step(self, step)
_get_property_range_string(self, property_name, value_range_fn, str_fmt=<built-in method format of str object at 0x163b21c00>)
_get_step_offset_range_string(self, property_name)
_get_step_start_time(self, step)
_get_step_time_range(self, step)
_grab_all_layers(self)
_has_clip(self)
_init_state_from_controls(self, renderable_state)
_init_state_from_listenable_properties(self, renderable_state)
_internal_on_enabled_changed(self)
_modify_duration(time_step, duration_offset, note)
_modify_note(self, time_step, duration_offset, nudge_offset, note)
_modify_note_property(self, note_property, value)
_modify_step_notes(self, steps)
_on_pad_pressed(self, pad)
_on_pad_released(self, pad, **k)
_on_release_step(self, step, can_add_or_remove=False)
_refresh_active_steps(self)
_release_active_steps(self)
_release_all_layers(self)
_reset_modifications(self)
_set_enabled_recursive(self, enable)
_time_step(self, time)
_update_clipboard(self, pad)
_update_editor_matrix(self)
_update_from_grid(self)
_update_is_enabled(self)
_visible_steps(self)
active_steps_has_listener(self, slot)
active_steps_listener_count(self)
add_active_steps_listener(self, slot, identify_sender=False, *a, **k)
add_any_clipboard_has_content_listener(self, slot, identify_sender=False, *a, **k)
add_children(self, *children)
add_clip_notes_listener(self, slot, identify_sender=False, *a, **k)
add_clipboard_listener(self, slot, identify_sender=False, *a, **k)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
add_page_length_listener(self, slot, identify_sender=False, *a, **k)
add_pitch_provider_listener(self, slot, identify_sender=False, *a, **k)
any_clipboard_has_content_has_listener(self, slot)
any_clipboard_has_content_listener_count(self)
can_nudge_by_offset(self, offset)
clip_notes_has_listener(self, slot)
clip_notes_listener_count(self)
clipboard_has_listener(self, slot)
clipboard_listener_count(self)
control_base_type(extra_args=None, extra_kws=None, *a, **k)
control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
dispatch_event(self, name: 'str', value)
enabled_has_listener(self, slot)
enabled_listener_count(self)
find_disconnectable(self, predicate)
get_duration_fine_range_string(self)
get_duration_range_string(self)
get_note_property_ranges(self)
get_nudge_offset_range_string(self)
get_velocity_range_string(self)
has_disconnectable(self, slot)
is_enabled(self, explicit=False)
is_pitch_active(self, pitch)
notify(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')
notify_active_steps(self, *a, **k)
notify_any_clipboard_has_content(self, *a, **k)
notify_clip_notes(self, *a, **k)
notify_clipboard(self, *a, **k)
notify_enabled(self, *a, **k)
notify_page_length(self, *a, **k)
notify_pitch_provider(self, *a, **k)
on_enabled_changed(self)
page_length_has_listener(self, slot)
page_length_listener_count(self)
page_time_changed(self)
pitch_provider_has_listener(self, slot)
pitch_provider_listener_count(self)
register_clipboard(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_active_steps_listener(self, slot)
remove_any_clipboard_has_content_listener(self, slot)
remove_clip_notes_listener(self, slot)
remove_clipboard_listener(self, slot)
remove_enabled_listener(self, slot)
remove_page_length_listener(self, slot)
remove_pitch_provider_listener(self, slot)
set_clip(self, clip)
set_copy_button(self, button)
set_duration_offset(self, value)
set_enabled(self, enable)
set_matrix(self, matrix)
set_nudge_offset(self, value)
set_pitch_offset(self, value)
set_pitches(self, pitches)
set_velocity_offset(self, value)
suppress_notifications(self)
toggle_pitch_for_all_active_steps(self, pitch)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _NoteEditorComponent__on_clip_notes_changed = None
  • _NoteEditorComponent__on_provided_pitches_changed = None
  • _NoteEditorComponent__on_provider_polyphony_changed = None
  • _NoteEditorComponent__on_resolution_changed = None
  • _NoteEditorComponent__on_sequencer_clip_changed = None
  • _NoteEditorComponent__on_target_track_color_changed = None
  • _clipboard_component_instances = [] - Built-in mutable sequence.
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
  • any_clipboard_has_content = False - bool(x) -> bool
  • canonical_parent = None
  • include_in_top_level_state = True - bool(x) -> bool
  • matrix = <ableton.v2.base.util.Mixin_MatrixControl_StepButtonControl object at 0x163b33470>
  • num_layers = 0 - int([x]) -> integer
  • renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class NoteEditorPaginator(Component, Paginator)

Properties

  • application
  • is_root
  • layer
  • page_time
  • parent
  • song

Methods

__init__(self, note_editor=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_add_child(self, component)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_update_is_enabled(self)
add_any_clipboard_has_content_listener(self, slot, identify_sender=False, *a, **k)
add_children(self, *children)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
add_page_length_listener(self, slot, identify_sender=False, *a, **k)
add_page_listener(self, slot, identify_sender=False, *a, **k)
add_page_time_listener(self, slot, identify_sender=False, *a, **k)
any_clipboard_has_content_has_listener(self, slot)
any_clipboard_has_content_listener_count(self)
control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
enabled_has_listener(self, slot)
enabled_listener_count(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_enabled(self, explicit=False)
notify_any_clipboard_has_content(self, *a, **k)
notify_enabled(self, *a, **k)
notify_page(self, *a, **k)
notify_page_length(self, *a, **k)
notify_page_time(self, *a, **k)
on_enabled_changed(self)
page_has_listener(self, slot)
page_length_has_listener(self, slot)
page_length_listener_count(self)
page_listener_count(self)
page_time_has_listener(self, slot)
page_time_listener_count(self)
register_clipboard(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_any_clipboard_has_content_listener(self, slot)
remove_enabled_listener(self, slot)
remove_page_length_listener(self, slot)
remove_page_listener(self, slot)
remove_page_time_listener(self, slot)
set_enabled(self, enable)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _NoteEditorPaginator__on_active_steps_changed = None
  • _NoteEditorPaginator__on_page_length_changed = None
  • _clipboard_component_instances = [] - Built-in mutable sequence.
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
  • any_clipboard_has_content = False - bool(x) -> bool
  • can_change_page = <ableton.v2.base.util.forward_property.<locals>.Descriptor object at 0x163b65cc0>
  • canonical_parent = None
  • num_layers = 0 - int([x]) -> integer
  • page_length = <ableton.v2.base.util.forward_property.<locals>.Descriptor object at 0x163b702b0>

class PlayheadComponent(Component)

Properties

  • application
  • is_root
  • layer
  • parent
  • song

Methods

__init__(self, name='Playhead', playhead=None, sequencer_clip=None, grid_resolution=None, paginator=None, notes=None, triplet_notes=None, channels=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_add_child(self, component)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_update_is_enabled(self)
_update_playhead_notes(self)
add_any_clipboard_has_content_listener(self, slot, identify_sender=False, *a, **k)
add_children(self, *children)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
any_clipboard_has_content_has_listener(self, slot)
any_clipboard_has_content_listener_count(self)
control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
enabled_has_listener(self, slot)
enabled_listener_count(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_enabled(self, explicit=False)
notify_any_clipboard_has_content(self, *a, **k)
notify_enabled(self, *a, **k)
on_enabled_changed(self)
register_clipboard(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_any_clipboard_has_content_listener(self, slot)
remove_enabled_listener(self, slot)
set_enabled(self, enable)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _PlayheadComponent__on_sequencer_clip_playing_status_changed = None
  • _clipboard_component_instances = [] - Built-in mutable sequence.
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
  • any_clipboard_has_content = False - bool(x) -> bool
  • canonical_parent = None
  • num_layers = 0 - int([x]) -> integer

class Quantization(enum)

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

Methods

__init__(self, /, *args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

bit_length(self, /)

Number of bits necessary to represent self in binary.

bin(37) '0b100101' (37).bit_length() 6

conjugate(...)

Returns self, the complex conjugate of any int.

from_bytes(bytes, byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Indicates whether two's complement is used to represent the integer.

to_bytes(self, /, length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Determines whether two's complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

Attributes

  • denominator = <attribute 'denominator' of 'int' objects> - the denominator of a rational number in lowest terms
  • imag = <attribute 'imag' of 'int' objects> - the imaginary part of a complex number
  • name = <member 'name' of 'Boost.Python.enum' objects>
  • names = {'q_no_q': Song.Quantization.q_no_q, 'q_8_bars': Song.Quantization.q_8_bars, 'q_4_bars': Song.Quantization.q_4_bars, 'q_2_bars': Song.Quantization.q_2_bars, 'q_... - dict() -> new empty dictionary
  • numerator = <attribute 'numerator' of 'int' objects> - the numerator of a rational number in lowest terms
  • q_2_bars = Song.Quantization.q_2_bars
  • q_4_bars = Song.Quantization.q_4_bars
  • q_8_bars = Song.Quantization.q_8_bars
  • q_bar = Song.Quantization.q_bar
  • q_eight = Song.Quantization.q_eight
  • q_eight_triplet = Song.Quantization.q_eight_triplet
  • q_half = Song.Quantization.q_half
  • q_half_triplet = Song.Quantization.q_half_triplet
  • q_no_q = Song.Quantization.q_no_q
  • q_quarter = Song.Quantization.q_quarter
  • q_quarter_triplet = Song.Quantization.q_quarter_triplet
  • q_sixtenth = Song.Quantization.q_sixtenth
  • q_sixtenth_triplet = Song.Quantization.q_sixtenth_triplet
  • q_thirtytwoth = Song.Quantization.q_thirtytwoth
  • real = <attribute 'real' of 'int' objects> - the real part of a complex number
  • values = {0: Song.Quantization.q_no_q, 1: Song.Quantization.q_8_bars, 2: Song.Quantization.q_4_bars, 3: Song.Quantization.q_2_bars, 4: Song.Quantization.q_bar, 5: Song.Q... - dict() -> new empty dictionary

class SequencerClip(EventObject)

Properties

  • bar_length
  • clip
  • length
  • num_bars

Methods

__init__(self, target_track=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

add_bar_length_listener(self, slot, identify_sender=False, *a, **k)
add_clip_listener(self, slot, identify_sender=False, *a, **k)
add_length_listener(self, slot, identify_sender=False, *a, **k)
bar_length_has_listener(self, slot)
bar_length_listener_count(self)
clip_has_listener(self, slot)
clip_listener_count(self)
create_clip(self, length=None)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
length_has_listener(self, slot)
length_listener_count(self)
notify_bar_length(self, *a, **k)
notify_clip(self, *a, **k)
notify_length(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_bar_length_listener(self, slot)
remove_clip_listener(self, slot)
remove_length_listener(self, slot)
unregister_disconnectable(self, slot)

Attributes

  • _SequencerClip__on_loop_end_changed = None
  • _SequencerClip__on_loop_start_changed = None
  • _SequencerClip__on_looping_changed = None
  • _SequencerClip__on_signature_denominator_changed = None
  • _SequencerClip__on_signature_numerator_changed = None
  • _SequencerClip__on_target_clip_changed = None

class StepSequenceComponent(Component)

Properties

  • application
  • is_root
  • layer
  • note_editor
  • parent
  • song

Methods

__init__(self, name='Step_Sequence', grid_resolution=None, note_editor_component_type=None, note_editor_paginator_type=None, loop_selector_component_type=None, playhead_component_type=None, playhead_notes=None, playhead_triplet_notes=None, playhead_channels=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_add_child(self, component)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_update_is_enabled(self)
add_any_clipboard_has_content_listener(self, slot, identify_sender=False, *a, **k)
add_children(self, *children)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
any_clipboard_has_content_has_listener(self, slot)
any_clipboard_has_content_listener_count(self)
control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
enabled_has_listener(self, slot)
enabled_listener_count(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_enabled(self, explicit=False)
notify_any_clipboard_has_content(self, *a, **k)
notify_enabled(self, *a, **k)
on_enabled_changed(self)
register_clipboard(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_any_clipboard_has_content_listener(self, slot)
remove_enabled_listener(self, slot)
set_enabled(self, enable)
set_loop_buttons(self, matrix)
set_loop_copy_button(self, button)
set_loop_delete_button(self, button)
set_next_page_button(self, button)
set_note_copy_button(self, button)
set_pitch_provider(self, provider)
set_prev_page_button(self, button)
set_resolution_buttons(self, buttons)
set_step_buttons(self, buttons)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _clipboard_component_instances = [] - Built-in mutable sequence.
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
  • any_clipboard_has_content = False - bool(x) -> bool
  • canonical_parent = None
  • num_layers = 0 - int([x]) -> integer

class listenable_property(listenable_property_base, property)

Property attribute.

fget function to be used for getting an attribute value fset function to be used for setting an attribute value fdel function to be used for del'ing an attribute doc docstring

Typical use is to define a managed attribute x:

class C(object): def getx(self): return self._x def setx(self, value): self._x = value def delx(self): del self._x x = property(getx, setx, delx, "I'm the 'x' property.")

Decorators make defining new properties or modifying existing ones easy:

class C(object): @property def x(self): "I am the 'x' property." return self._x @x.setter def x(self, value): self._x = value @x.deleter def x(self): del self._x

Methods

__init__(self, /, *args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

deleter(...)

Descriptor to change the deleter on a property.

getter(...)

Descriptor to change the getter on a property.

managed(default_value)
set_property_name(self, name)
setter(...)

Descriptor to change the setter on a property.

Attributes

  • fdel = <member 'fdel' of 'property' objects>
  • fget = <member 'fget' of 'property' objects>
  • fset = <member 'fset' of 'property' objects>