Asterisk - The Open Source Telephony Project  18.5.0
Public Member Functions | Data Fields
PathSegment Class Reference
Inheritance diagram for PathSegment:
Inheritance graph
[legend]
Collaboration diagram for PathSegment:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, name, parent)
 
def children (self)
 
def get_child (self, path)
 
def num_children (self)
 
- Public Member Functions inherited from Stringify
def __repr__ (self)
 

Data Fields

 full_name
 
 is_wildcard
 
 name
 
 operations
 

Detailed Description

Tree representation of a Swagger API declaration.

Definition at line 70 of file asterisk_processor.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  name,
  parent 
)
Ctor.

@param name: Name of this path segment. May have {pathVar} markers.
@param parent: Parent PathSegment.

Definition at line 73 of file asterisk_processor.py.

73  def __init__(self, name, parent):
74  """Ctor.
75 
76  @param name: Name of this path segment. May have {pathVar} markers.
77  @param parent: Parent PathSegment.
78  """
79  #: Segment name, with {pathVar} markers removed
80  self.name = simple_name(name)
81  #: True if segment is a {pathVar}, else None.
82  self.is_wildcard = None
83  #: Underscore seperated name all ancestor segments
84  self.full_name = None
85  #: Dictionary of child PathSegements
86  self.__children = OrderedDict()
87  #: List of operations on this segement
88  self.operations = []
89 
90  if self.name != name:
91  self.is_wildcard = True
92 
93  if not self.name:
94  assert(not parent)
95  self.full_name = ''
96  if not parent or not parent.name:
97  self.full_name = name
98  else:
99  self.full_name = "%s_%s" % (parent.full_name, self.name)
100 

Member Function Documentation

◆ children()

def children (   self)
Gets list of children.

Definition at line 116 of file asterisk_processor.py.

References PathSegment.__children.

116  def children(self):
117  """Gets list of children.
118  """
119  return self.__children.values()
120 

◆ get_child()

def get_child (   self,
  path 
)
Walks decendents to get path, creating it if necessary.

@param path: List of path names.
@return: PageSegment corresponding to path.

Definition at line 101 of file asterisk_processor.py.

References PathSegment.__children, len(), ast_imager.name, category_t.name, ast_var_t.name, ast_sip_api_tech.name, ast_dns_resolver.name, contact.name, ast_tone_zone_sound.name, ast_include.name, ast_sw.name, stasis_message_type.name, stasis_app_stored_recording.name, ast_format_def.name, ast_format.name, ast_codec.name, ast_bucket_metadata.name, confbridge_state.name, header.name, ast_netsock.name, ast_smdi_mwi_message.name, callerid_state.name, iax_template.name, ast_sip_cli_formatter_entry.name, bridge_metric_defs.name, ast_ari_bridges_create_args.name, odbc_cache_columns.name, video_codec_desc.name, ast_msg_tech.name, ast_bridge_technology.name, aco_option.name, ast_smdi_md_message.name, odbc_class.name, ast_sip_sched_task.name, ast_timing_interface.name, ast_acl.name, endpoint_metric_defs.name, stasis_app.name, ast_xml_doc_item.name, ast_speech_engine.name, ast_key.name, channel_metric_defs.name, iax_flag.name, PathSegment.name, grab_desc.name, group_entry.name, adsi_event.name, ast_variable.name, group.name, category_and_metric.name, ast_channel_snapshot_caller.name, parking_lot_cfg.name, ast_ari_bridges_create_with_id_args.name, misdn_cfg_spec.name, realtime_sqlite3_db.name, ast_taskprocessor.name, ast_channel_snapshot_connected.name, ast_unreal_pvt.name, column.name, parking_lot.name, prometheus_metrics_provider.name, media_info.name, columns.name, ast_bucket_scheme.name, ast_msg_handler.name, progalias.name, ael_extension.name, direntry.name, named_acl.name, exten_state_publisher.name, ast_channel_snapshot_base.name, ast_channel.name, ast_websocket_protocol.name, tables.name, ast_custom_function.name, logformatter.name, ast_stream.name, wait_bridge_wrapper.name, ast_jb_impl.name, ast_xmpp_client.name, aco_type.name, notify_option_item.name, ast_calendar.name, odbc_txn_frame.name, sorcery_memory_cache.name, ie_map.name, ast_config_engine.name, pickup_by_name_args.name, lock_frame.name, causes_map.name, cops_cmts.name, notify_option.name, wait_type.name, sip_options_endpoint_aor_status.name, ast_translator.name, moh_files_state.name, ast_tcptls_session_args.name, conf_menu.name, console_pvt.name, ast_sorcery_object_type.name, ast_dns_query.name, user_profile.name, dsn.name, prometheus_label.name, sip_options_endpoint_state_compositor.name, state.name, ast_switch.name, call_followme.name, ast_smdi_interface.name, mohclass.name, directory_item.name, ast_dns_query_recurring.name, skel_level.name, stasis_app_recording_options.name, Vardesc.name, Namelist.name, ast_config_map.name, ast_sorcery_object_field.name, prometheus_metric.name, permission.name, ast_category_template_instance.name, ast_test_info.name, msg_data.name, ast_category.name, bridge_profile.name, ast_exten.name, locale_entry.name, confbridge_conference.name, ast_applicationmap_item.name, aoc_ie_currency.name, chan_oss_pvt.name, ooh323_user.name, ast_bridge_methods.name, iax2_ie.name, ast_sorcery_wizard.name, jingle_endpoint.name, ooh323_peer.name, register_message.name, extension.name, misdn_party_id.name, ast_context.name, phone_profile.name, cdr_beitem.name, cel_backend.name, ast_party_id.name, mgcp_endpoint.name, ast_bridge_snapshot.name, load_results_map.name, dundi_ie.name, ast_module_info.name, ast_sip_contact_status.name, ast_ari_bridges_record_args.name, ast_set_party_id.name, mixmonitor.name, unistim_line.name, topic_proxy.name, mgcp_gateway.name, unistim_device.name, ast_bridge.name, prometheus_callback.name, cdr_object_fn_table.name, ast_xmpp_client_config.name, featuregroup.name, sqlite_cache_columns.name, sqlite_cache_tables.name, iax2_user.name, osp_provider.name, iax2_peer.name, ast_rtp_engine.name, ast_ari_channels_record_args.name, minivm_template.name, minivm_zone.name, chanvar.name, sip_proxy.name, cdr_object.name, profile_entry.name, vm_zone.name, adsi_key_cmd.name, dscp_codepoint.name, sla_trunk.name, sip_msg_hdr.name, event_state_compositor.name, ast_value_translation.name, sip_peer.name, thr_arg.name, strategy.name, autopause.name, skinny_subline.name, pbx_builtin.name, epa_static_data.name, call_queue.name, topic_pool_entry.name, rule_list.name, allowed_bearers.name, fake_context.name, stream_parameters.name, endpoint_identifier_list.name, cfg_hook.name, name, namedgroup_member.name, manager_channel_variable.name, ast_party_id_ies.name, and asterisk_processor.simple_name().

101  def get_child(self, path):
102  """Walks decendents to get path, creating it if necessary.
103 
104  @param path: List of path names.
105  @return: PageSegment corresponding to path.
106  """
107  assert simple_name(path[0]) == self.name
108  if (len(path) == 1):
109  return self
110  child = self.__children.get(path[1])
111  if not child:
112  child = PathSegment(path[1], self)
113  self.__children[path[1]] = child
114  return child.get_child(path[1:])
115 
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)

◆ num_children()

def num_children (   self)
Gets count of children.

Definition at line 121 of file asterisk_processor.py.

References PathSegment.__children, and len().

121  def num_children(self):
122  """Gets count of children.
123  """
124  return len(self.__children)
125 
126 
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)

Field Documentation

◆ full_name

full_name

Definition at line 84 of file asterisk_processor.py.

◆ is_wildcard

is_wildcard

Definition at line 82 of file asterisk_processor.py.

◆ name

name

◆ operations

operations

Definition at line 88 of file asterisk_processor.py.

Referenced by Api.load().


The documentation for this class was generated from the following file: