sentence1
stringlengths
52
3.87M
sentence2
stringlengths
1
47.2k
label
stringclasses
1 value
def write_byte(self, byte): """Write one byte.""" self.payload[self.pos] = byte self.pos = self.pos + 1
Write one byte.
entailment
def write_bytes(self, data, n): """Write n number of bytes to this packet.""" for pos in xrange(0, n): self.payload[self.pos + pos] = data[pos] self.pos += n
Write n number of bytes to this packet.
entailment
def read_byte(self): """Read a byte.""" if self.pos + 1 > self.remaining_length: return NC.ERR_PROTOCOL, None byte = self.payload[self.pos] self.pos += 1 return NC.ERR_SUCCESS, byte
Read a byte.
entailment
def read_uint16(self): """Read 2 bytes.""" if self.pos + 2 > self.remaining_length: return NC.ERR_PROTOCOL msb = self.payload[self.pos] self.pos += 1 lsb = self.payload[self.pos] self.pos += 1 word = (msb << 8) + lsb return NC...
Read 2 bytes.
entailment
def read_bytes(self, count): """Read count number of bytes.""" if self.pos + count > self.remaining_length: return NC.ERR_PROTOCOL, None ba = bytearray(count) for x in xrange(0, count): ba[x] = self.payload[self.pos] self.pos += 1 ...
Read count number of bytes.
entailment
def read_string(self): """Read string.""" rc, length = self.read_uint16() if rc != NC.ERR_SUCCESS: return rc, None if self.pos + length > self.remaining_length: return NC.ERR_PROTOCOL, None ba = bytearray(length) if ba is...
Read string.
entailment
def pop_event(self): """Pop an event from event_list.""" if len(self.event_list) > 0: evt = self.event_list.pop(0) return evt return None
Pop an event from event_list.
entailment
def mid_generate(self): """Generate mid. TODO : check.""" self.last_mid += 1 if self.last_mid == 0: self.last_mid += 1 return self.last_mid
Generate mid. TODO : check.
entailment
def packet_queue(self, pkt): """Enqueue packet to out_packet queue.""" pkt.pos = 0 pkt.to_process = pkt.packet_length self.out_packet.append(pkt) return NC.ERR_SUCCESS
Enqueue packet to out_packet queue.
entailment
def packet_write(self): """Write packet to network.""" bytes_written = 0 if self.sock == NC.INVALID_SOCKET: return NC.ERR_NO_CONN, bytes_written while len(self.out_packet) > 0: pkt = self.out_packet[0] write_length, status = nyamuk_ne...
Write packet to network.
entailment
def packet_read(self): """Read packet from network.""" bytes_received = 0 if self.sock == NC.INVALID_SOCKET: return NC.ERR_NO_CONN if self.in_packet.command == 0: ba_data, errnum, errmsg = nyamuk_net.read(self.sock, 1) if errnum == 0 ...
Read packet from network.
entailment
def socket_close(self): """Close our socket.""" if self.sock != NC.INVALID_SOCKET: self.sock.close() self.sock = NC.INVALID_SOCKET
Close our socket.
entailment
def build_publish_pkt(self, mid, topic, payload, qos, retain, dup): """Build PUBLISH packet.""" pkt = MqttPkt() payloadlen = len(payload) packetlen = 2 + len(topic) + payloadlen if qos > 0: packetlen += 2 pkt.mid = mid pkt.command = N...
Build PUBLISH packet.
entailment
def send_simple_command(self, cmd): """Send simple mqtt commands.""" pkt = MqttPkt() pkt.command = cmd pkt.remaining_length = 0 ret = pkt.alloc() if ret != NC.ERR_SUCCESS: return ret return self.packet_queue(pkt)
Send simple mqtt commands.
entailment
def real_ip(self): """ The actual public IP of this host. """ if self._real_ip is None: response = get(ICANHAZIP) self._real_ip = self._get_response_text(response) return self._real_ip
The actual public IP of this host.
entailment
def get_current_ip(self): """ Get the current IP Tor is using. :returns str :raises TorIpError """ response = get(ICANHAZIP, proxies={"http": self.local_http_proxy}) if response.ok: return self._get_response_text(response) raise TorIpError("...
Get the current IP Tor is using. :returns str :raises TorIpError
entailment
def get_new_ip(self): """ Try to obtain new a usable TOR IP. :returns bool :raises TorIpError """ attempts = 0 while True: if attempts == self.new_ip_max_attempts: raise TorIpError("Failed to obtain a new usable Tor IP") ...
Try to obtain new a usable TOR IP. :returns bool :raises TorIpError
entailment
def _ip_is_usable(self, current_ip): """ Check if the current Tor's IP is usable. :argument current_ip: current Tor IP :type current_ip: str :returns bool """ # Consider IP addresses only. try: ipaddress.ip_address(current_ip) except ...
Check if the current Tor's IP is usable. :argument current_ip: current Tor IP :type current_ip: str :returns bool
entailment
def _manage_used_ips(self, current_ip): """ Handle registering and releasing used Tor IPs. :argument current_ip: current Tor IP :type current_ip: str """ # Register current IP. self.used_ips.append(current_ip) # Release the oldest registred IP. i...
Handle registering and releasing used Tor IPs. :argument current_ip: current Tor IP :type current_ip: str
entailment
def _obtain_new_ip(self): """ Change Tor's IP. """ with Controller.from_port( address=self.tor_address, port=self.tor_port ) as controller: controller.authenticate(password=self.tor_password) controller.signal(Signal.NEWNYM) # Wait til...
Change Tor's IP.
entailment
def is_local_subsection(command_dict): """Returns True if command dict is "local subsection", meaning that it is "if", "else" or "for" (not a real call, but calls run_section recursively.""" for local_com in ['if ', 'for ', 'else ']: if list(command_dict.keys())[0].startswith(local_com): ...
Returns True if command dict is "local subsection", meaning that it is "if", "else" or "for" (not a real call, but calls run_section recursively.
entailment
def _process_req_txt(req): '''Returns a processed request or raises an exception''' if req.status_code == 404: return '' if req.status_code != 200: raise DapiCommError('Response of the server was {code}'.format(code=req.status_code)) return req.text
Returns a processed request or raises an exception
entailment
def _get_from_dapi_or_mirror(link): '''Tries to get the link form DAPI or the mirror''' exception = False try: req = requests.get(_api_url() + link, timeout=5) except requests.exceptions.RequestException: exception = True attempts = 1 while exception or str(req.status_code).star...
Tries to get the link form DAPI or the mirror
entailment
def _remove_api_url_from_link(link): '''Remove the API URL from the link if it is there''' if link.startswith(_api_url()): link = link[len(_api_url()):] if link.startswith(_api_url(mirror=True)): link = link[len(_api_url(mirror=True)):] return link
Remove the API URL from the link if it is there
entailment
def data(link): '''Returns a dictionary from requested link''' link = _remove_api_url_from_link(link) req = _get_from_dapi_or_mirror(link) return _process_req(req)
Returns a dictionary from requested link
entailment
def _unpaginated(what): '''Returns a dictionary with all <what>, unpaginated''' page = data(what) results = page['results'] count = page['count'] while page['next']: page = data(page['next']) results += page['results'] count += page['count'] return {'results': results, 'c...
Returns a dictionary with all <what>, unpaginated
entailment
def search(q, **kwargs): '''Returns a dictionary with the search results''' data = {'q': q} for key, value in kwargs.items(): if value: if type(value) == bool: data[key] = 'on' else: data[key] = value return _unpaginated('search/?' + urlenc...
Returns a dictionary with the search results
entailment
def format_users(): '''Formats a list of users available on Dapi''' lines = [] u = users() count = u['count'] if not count: raise DapiCommError('Could not find any users on DAPI.') for user in u['results']: line = user['username'] if user['full_name']: line +=...
Formats a list of users available on Dapi
entailment
def format_daps(simple=False, skip_installed=False): '''Formats a list of metadaps available on Dapi''' lines= [] m = metadaps() if not m['count']: logger.info('Could not find any daps') return for mdap in sorted(m['results'], key=lambda mdap: mdap['package_name']): if skip_i...
Formats a list of metadaps available on Dapi
entailment
def _get_metadap_dap(name, version=''): '''Return data for dap of given or latest version.''' m = metadap(name) if not m: raise DapiCommError('DAP {dap} not found.'.format(dap=name)) if not version: d = m['latest_stable'] or m['latest'] if d: d = data(d) else: ...
Return data for dap of given or latest version.
entailment
def format_dap_from_dapi(name, version='', full=False): '''Formats information about given DAP from DAPI in a human readable form to list of lines''' lines = [] m, d = _get_metadap_dap(name, version) if d: # Determining label width labels = BASIC_LABELS + ['average_rank'] # average_rank...
Formats information about given DAP from DAPI in a human readable form to list of lines
entailment
def format_local_dap(dap, full=False, **kwargs): '''Formaqts information about the given local DAP in a human readable form to list of lines''' lines = [] # Determining label width label_width = dapi.DapFormatter.calculate_offset(BASIC_LABELS) # Metadata lines.append(dapi.DapFormatter.format_m...
Formaqts information about the given local DAP in a human readable form to list of lines
entailment
def format_installed_dap(name, full=False): '''Formats information about an installed DAP in a human readable form to list of lines''' dap_data = get_installed_daps_detailed().get(name) if not dap_data: raise DapiLocalError('DAP "{dap}" is not installed, can not query for info.'.format(dap=name)) ...
Formats information about an installed DAP in a human readable form to list of lines
entailment
def format_installed_dap_list(simple=False): '''Formats all installed DAPs in a human readable form to list of lines''' lines = [] if simple: for pkg in sorted(get_installed_daps()): lines.append(pkg) else: for pkg, instances in sorted(get_installed_daps_detailed().items()): ...
Formats all installed DAPs in a human readable form to list of lines
entailment
def _get_assistants_snippets(path, name): '''Get Assistants and Snippets for a given DAP name on a given path''' result = [] subdirs = {'assistants': 2, 'snippets': 1} # Values used for stripping leading path tokens for loc in subdirs: for root, dirs, files in os.walk(os.path.join(path, loc)): ...
Get Assistants and Snippets for a given DAP name on a given path
entailment
def format_search(q, **kwargs): '''Formats the results of a search''' m = search(q, **kwargs) count = m['count'] if not count: raise DapiCommError('Could not find any DAP packages for your query.') return for mdap in m['results']: mdap = mdap['content_object'] return ...
Formats the results of a search
entailment
def get_installed_daps(location=None, skip_distro=False): '''Returns a set of all installed daps Either in the given location or in all of them''' if location: locations = [location] else: locations = _data_dirs() s = set() for loc in locations: if skip_distro and loc == ...
Returns a set of all installed daps Either in the given location or in all of them
entailment
def get_installed_daps_detailed(): '''Returns a dictionary with all installed daps and their versions and locations First version and location in the dap's list is the one that is preferred''' daps = {} for loc in _data_dirs(): s = get_installed_daps(loc) for dap in s: if dap...
Returns a dictionary with all installed daps and their versions and locations First version and location in the dap's list is the one that is preferred
entailment
def download_dap(name, version='', d='', directory=''): '''Download a dap to a given or temporary directory Return a path to that file together with information if the directory should be later deleted ''' if not d: m, d = _get_metadap_dap(name, version) if directory: _dir = director...
Download a dap to a given or temporary directory Return a path to that file together with information if the directory should be later deleted
entailment
def install_dap_from_path(path, update=False, update_allpaths=False, first=True, force=False, nodeps=False, reinstall=False, __ui__=''): '''Installs a dap from a given path''' will_uninstall = False dap_obj = dapi.Dap(path) name = dap_obj.meta['package_name'] if name in ge...
Installs a dap from a given path
entailment
def _strip_version_from_dependency(dep): '''For given dependency string, return only the package name''' usedmark = '' for mark in '< > ='.split(): split = dep.split(mark) if len(split) > 1: usedmark = mark break if usedmark: return split[0].strip() el...
For given dependency string, return only the package name
entailment
def get_installed_version_of(name, location=None): '''Gets the installed version of the given dap or None if not installed Searches in all dirs by default, otherwise in the given one''' if location: locations = [location] else: locations = _data_dirs() for loc in locations: ...
Gets the installed version of the given dap or None if not installed Searches in all dirs by default, otherwise in the given one
entailment
def _get_dependencies_of(name, location=None): ''' Returns list of first level dependencies of the given installed dap or dap from Dapi if not installed If a location is specified, this only checks for dap installed in that path and return [] if the dap is not located there ''' if not locat...
Returns list of first level dependencies of the given installed dap or dap from Dapi if not installed If a location is specified, this only checks for dap installed in that path and return [] if the dap is not located there
entailment
def _get_all_dependencies_of(name, deps=set(), force=False): '''Returns list of dependencies of the given dap from Dapi recursively''' first_deps = _get_api_dependencies_of(name, force=force) for dep in first_deps: dep = _strip_version_from_dependency(dep) if dep in deps: continu...
Returns list of dependencies of the given dap from Dapi recursively
entailment
def _get_api_dependencies_of(name, version='', force=False): '''Returns list of first level dependencies of the given dap from Dapi''' m, d = _get_metadap_dap(name, version=version) # We need the dependencies to install the dap, # if the dap is unsupported, raise an exception here if not force and n...
Returns list of first level dependencies of the given dap from Dapi
entailment
def install_dap(name, version='', update=False, update_allpaths=False, first=True, force=False, nodeps=False, reinstall=False, __ui__=''): '''Install a dap from dapi If update is True, it will remove previously installed daps of the same name''' m, d = _get_metadap_dap(name, version) if ...
Install a dap from dapi If update is True, it will remove previously installed daps of the same name
entailment
def get_dependency_metadata(): '''Returns list of strings with dependency metadata from Dapi''' link = os.path.join(_api_url(), 'meta.txt') return _process_req_txt(requests.get(link)).split('\n')
Returns list of strings with dependency metadata from Dapi
entailment
def create_frame(self): """ This function creates a frame """ frame = Gtk.Frame() frame.set_shadow_type(Gtk.ShadowType.IN) return frame
This function creates a frame
entailment
def create_box(self, orientation=Gtk.Orientation.HORIZONTAL, spacing=0): """ Function creates box. Based on orientation it can be either HORIZONTAL or VERTICAL """ h_box = Gtk.Box(orientation=orientation, spacing=spacing) h_box.set_homogeneous(False) retur...
Function creates box. Based on orientation it can be either HORIZONTAL or VERTICAL
entailment
def button_with_label(self, description, assistants=None): """ Function creates a button with lave. If assistant is specified then text is aligned """ btn = self.create_button() label = self.create_label(description) if assistants is not None: ...
Function creates a button with lave. If assistant is specified then text is aligned
entailment
def create_image(self, image_name=None, scale_ratio=1, window=None): """ The function creates a image from name defined in image_name """ size = 48 * scale_ratio pixbuf = GdkPixbuf.Pixbuf.new_from_file_at_scale(image_name, -1, size, True) image = Gtk.Image() ...
The function creates a image from name defined in image_name
entailment
def button_with_image(self, description, image=None, sensitive=True): """ The function creates a button with image """ btn = self.create_button() btn.set_sensitive(sensitive) h_box = self.create_box() try: img = self.create_image(image_name=image, ...
The function creates a button with image
entailment
def checkbutton_with_label(self, description): """ The function creates a checkbutton with label """ act_btn = Gtk.CheckButton(description) align = self.create_alignment() act_btn.add(align) return align
The function creates a checkbutton with label
entailment
def create_checkbox(self, name, margin=10): """ Function creates a checkbox with his name """ chk_btn = Gtk.CheckButton(name) chk_btn.set_margin_right(margin) return chk_btn
Function creates a checkbox with his name
entailment
def create_entry(self, text="", sensitive="False"): """ Function creates an Entry with corresponding text """ text_entry = Gtk.Entry() text_entry.set_sensitive(sensitive) text_entry.set_text(text) return text_entry
Function creates an Entry with corresponding text
entailment
def create_link_button(self, text="None", uri="None"): """ Function creates a link button with corresponding text and URI reference """ link_btn = Gtk.LinkButton(uri, text) return link_btn
Function creates a link button with corresponding text and URI reference
entailment
def create_button(self, style=Gtk.ReliefStyle.NORMAL): """ This is generalized method for creating Gtk.Button """ btn = Gtk.Button() btn.set_relief(style) return btn
This is generalized method for creating Gtk.Button
entailment
def create_image_menu_item(self, text, image_name): """ Function creates a menu item with an image """ menu_item = Gtk.ImageMenuItem(text) img = self.create_image(image_name) menu_item.set_image(img) return menu_item
Function creates a menu item with an image
entailment
def create_label(self, name, justify=Gtk.Justification.CENTER, wrap_mode=True, tooltip=None): """ The function is used for creating lable with HTML text """ label = Gtk.Label() name = name.replace('|', '\n') label.set_markup(name) label.set_justify(justify) ...
The function is used for creating lable with HTML text
entailment
def add_button(self, grid_lang, ass, row, column): """ The function is used for creating button with all features like signal on tooltip and signal on clicked The function does not have any menu. Button is add to the Gtk.Grid on specific row and column """ #print ...
The function is used for creating button with all features like signal on tooltip and signal on clicked The function does not have any menu. Button is add to the Gtk.Grid on specific row and column
entailment
def add_install_button(self, grid_lang, row, column): """ Add button that opens the window for installing more assistants """ btn = self.button_with_label('<b>Install more...</b>') if row == 0 and column == 0: grid_lang.add(btn) else: grid_lang.att...
Add button that opens the window for installing more assistants
entailment
def menu_item(self, sub_assistant, path): """ The function creates a menu item and assigns signal like select and button-press-event for manipulation with menu_item. sub_assistant and path """ if not sub_assistant[0].icon_path: menu_item = self.create_menu_ite...
The function creates a menu item and assigns signal like select and button-press-event for manipulation with menu_item. sub_assistant and path
entailment
def generate_menu(self, ass, text, path=None, level=0): """ Function generates menu from based on ass parameter """ menu = self.create_menu() for index, sub in enumerate(sorted(ass[1], key=lambda y: y[0].fullname.lower())): if index != 0: text += "|" ...
Function generates menu from based on ass parameter
entailment
def add_submenu(self, grid_lang, ass, row, column): """ The function is used for creating button with menu and submenu. Also signal on tooltip and signal on clicked are specified Button is add to the Gtk.Grid """ text = "Available subassistants:\n" # Generate menu...
The function is used for creating button with menu and submenu. Also signal on tooltip and signal on clicked are specified Button is add to the Gtk.Grid
entailment
def create_scrolled_window(self, layout_manager, horizontal=Gtk.PolicyType.NEVER, vertical=Gtk.PolicyType.ALWAYS): """ Function creates a scrolled window with layout manager """ scrolled_window = Gtk.ScrolledWindow() scrolled_window.add(layout_manager) scrolled_window.set...
Function creates a scrolled window with layout manager
entailment
def create_gtk_grid(self, row_spacing=6, col_spacing=6, row_homogenous=False, col_homogenous=True): """ Function creates a Gtk Grid with spacing and homogeous tags """ grid_lang = Gtk.Grid() grid_lang.set_column_spacing(row_spacing) grid_lang.set_row_spacing(col_s...
Function creates a Gtk Grid with spacing and homogeous tags
entailment
def create_notebook(self, position=Gtk.PositionType.TOP): """ Function creates a notebook """ notebook = Gtk.Notebook() notebook.set_tab_pos(position) notebook.set_show_border(True) return notebook
Function creates a notebook
entailment
def create_message_dialog(self, text, buttons=Gtk.ButtonsType.CLOSE, icon=Gtk.MessageType.WARNING): """ Function creates a message dialog with text and relevant buttons """ dialog = Gtk.MessageDialog(None, Gtk.DialogFlags.DESTROY_WITH_PARENT, ...
Function creates a message dialog with text and relevant buttons
entailment
def create_question_dialog(self, text, second_text): """ Function creates a question dialog with title text and second_text """ dialog = self.create_message_dialog( text, buttons=Gtk.ButtonsType.YES_NO, icon=Gtk.MessageType.QUESTION ) dialog.format_sec...
Function creates a question dialog with title text and second_text
entailment
def execute_dialog(self, title): """ Function executes a dialog """ msg_dlg = self.create_message_dialog(title) msg_dlg.run() msg_dlg.destroy() return
Function executes a dialog
entailment
def create_file_chooser_dialog(self, text, parent, name=Gtk.STOCK_OPEN): """ Function creates a file chooser dialog with title text """ text = None dialog = Gtk.FileChooserDialog( text, parent, Gtk.FileChooserAction.SELECT_FOLDER, (Gtk.STOCK_CA...
Function creates a file chooser dialog with title text
entailment
def create_alignment(self, x_align=0, y_align=0, x_scale=0, y_scale=0): """ Function creates an alignment """ align = Gtk.Alignment() align.set(x_align, y_align, x_scale, y_scale) return align
Function creates an alignment
entailment
def create_textview(self, wrap_mode=Gtk.WrapMode.WORD_CHAR, justify=Gtk.Justification.LEFT, visible=True, editable=True): """ Function creates a text view with wrap_mode and justification """ text_view = Gtk.TextView() text_view.set_wrap_mode(wrap_mode) text_view....
Function creates a text view with wrap_mode and justification
entailment
def create_tree_view(self, model=None): """ Function creates a tree_view with model """ tree_view = Gtk.TreeView() if model is not None: tree_view.set_model(model) return tree_view
Function creates a tree_view with model
entailment
def create_cell_renderer_text(self, tree_view, title="title", assign=0, editable=False): """ Function creates a CellRendererText with title """ renderer = Gtk.CellRendererText() renderer.set_property('editable', editable) column = Gtk.TreeViewColumn(title, renderer, text=...
Function creates a CellRendererText with title
entailment
def create_cell_renderer_combo(self, tree_view, title="title", assign=0, editable=False, model=None, function=None): """' Function creates a CellRendererCombo with title, model """ renderer_combo = Gtk.CellRendererCombo() renderer_combo.set_property('editable', editable) ...
Function creates a CellRendererCombo with title, model
entailment
def create_clipboard(self, text, selection=Gdk.SELECTION_CLIPBOARD): """ Function creates a clipboard """ clipboard = Gtk.Clipboard.get(selection) clipboard.set_text('\n'.join(text), -1) clipboard.store() return clipboard
Function creates a clipboard
entailment
def run_command(cls, cmd_str, log_level=logging.DEBUG, ignore_sigint=False, output_callback=None, as_user=None, log_secret=False, env=None): """Runs a command from string, ...
Runs a command from string, e.g. "cp foo bar" Args: cmd_str: the command to run as string log_level: level at which to log command output (DEBUG by default) ignore_sigint: should we ignore sigint during this command (False by default) output_callback: function tha...
entailment
def ask_for_password(cls, ui, prompt='Provide your password:', **options): """Returns the password typed by user as a string or None if user cancels the request (e.g. presses Ctrl + D on commandline or presses Cancel in GUI. """ # optionally set title, that may be used by some helpers li...
Returns the password typed by user as a string or None if user cancels the request (e.g. presses Ctrl + D on commandline or presses Cancel in GUI.
entailment
def ask_for_confirm_with_message(cls, ui, prompt='Do you agree?', message='', **options): """Returns True if user agrees, False otherwise""" return cls.get_appropriate_helper(ui).ask_for_confirm_with_message(prompt, message)
Returns True if user agrees, False otherwise
entailment
def ask_for_input_with_prompt(cls, ui, prompt='', **options): """Ask user for written input with prompt""" return cls.get_appropriate_helper(ui).ask_for_input_with_prompt(prompt=prompt, **options)
Ask user for written input with prompt
entailment
def add_argument_to(self, parser): """Used by cli to add this as an argument to argparse parser. Args: parser: parser to add this argument to """ from devassistant.cli.devassistant_argparse import DefaultIffUsedActionFactory if isinstance(self.kwargs.get('action', ''...
Used by cli to add this as an argument to argparse parser. Args: parser: parser to add this argument to
entailment
def get_gui_hint(self, hint): """Returns the value for specified gui hint (or a sensible default value, if this argument doesn't specify the hint). Args: hint: name of the hint to get value for Returns: value of the hint specified in yaml or a sensible default ...
Returns the value for specified gui hint (or a sensible default value, if this argument doesn't specify the hint). Args: hint: name of the hint to get value for Returns: value of the hint specified in yaml or a sensible default
entailment
def construct_arg(cls, name, params): """Construct an argument from name, and params (dict loaded from assistant/snippet). """ use_snippet = params.pop('use', None) if use_snippet: # if snippet is used, take this parameter from snippet and update # it with current...
Construct an argument from name, and params (dict loaded from assistant/snippet).
entailment
def get_subassistants(self): """Return list of instantiated subassistants. Usually, this needs not be overriden in subclasses, you should just override get_subassistant_classes Returns: list of instantiated subassistants """ if not hasattr(self, '_subassista...
Return list of instantiated subassistants. Usually, this needs not be overriden in subclasses, you should just override get_subassistant_classes Returns: list of instantiated subassistants
entailment
def get_subassistant_tree(self): """Returns a tree-like structure representing the assistant hierarchy going down from this assistant to leaf assistants. For example: [(<This Assistant>, [(<Subassistant 1>, [...]), (<Subassistant 2>, [...])] ...
Returns a tree-like structure representing the assistant hierarchy going down from this assistant to leaf assistants. For example: [(<This Assistant>, [(<Subassistant 1>, [...]), (<Subassistant 2>, [...])] )] Returns: ...
entailment
def get_selected_subassistant_path(self, **kwargs): """Recursively searches self._tree - has format of (Assistant: [list_of_subassistants]) - for specific path from first to last selected subassistants. Args: kwargs: arguments containing names of the given assistants in form of ...
Recursively searches self._tree - has format of (Assistant: [list_of_subassistants]) - for specific path from first to last selected subassistants. Args: kwargs: arguments containing names of the given assistants in form of subassistant_0 = 'name', subassistant_1 = 'another_name...
entailment
def is_run_as_leaf(self, **kwargs): """Returns True if this assistant was run as last in path, False otherwise.""" # find the last subassistant_N i = 0 while i < len(kwargs): # len(kwargs) is maximum of subassistant_N keys if settings.SUBASSISTANT_N_STRING.format(i) in kwarg...
Returns True if this assistant was run as last in path, False otherwise.
entailment
def load_all_yamls(cls, directories): """Loads yaml files from all given directories. Args: directories: list of directories to search Returns: dict of {fullpath: loaded_yaml_structure} """ yaml_files = [] loaded_yamls = {} for d in direc...
Loads yaml files from all given directories. Args: directories: list of directories to search Returns: dict of {fullpath: loaded_yaml_structure}
entailment
def load_yaml_by_relpath(cls, directories, rel_path, log_debug=False): """Load a yaml file with path that is relative to one of given directories. Args: directories: list of directories to search name: relative path of the yaml file to load log_debug: log all message...
Load a yaml file with path that is relative to one of given directories. Args: directories: list of directories to search name: relative path of the yaml file to load log_debug: log all messages as debug Returns: tuple (fullpath, loaded yaml structure) or...
entailment
def load_yaml_by_path(cls, path, log_debug=False): """Load a yaml file that is at given path, if the path is not a string, it is assumed it's a file-like object""" try: if isinstance(path, six.string_types): return yaml.load(open(path, 'r'), Loader=Loader) or {} ...
Load a yaml file that is at given path, if the path is not a string, it is assumed it's a file-like object
entailment
def _run_path_dependencies(self, parsed_args): """Installs dependencies from the leaf assistant. Raises: devassistant.exceptions.DependencyException with a cause if something goes wrong """ deps = self.path[-1].dependencies(parsed_args) lang.Command('dependencies', d...
Installs dependencies from the leaf assistant. Raises: devassistant.exceptions.DependencyException with a cause if something goes wrong
entailment
def run(self): """Runs all errors, dependencies and run methods of all *Assistant objects in self.path. Raises: devassistant.exceptions.ExecutionException with a cause if something goes wrong """ error = None # run 'pre_run', 'logging', 'dependencies' and 'run' ...
Runs all errors, dependencies and run methods of all *Assistant objects in self.path. Raises: devassistant.exceptions.ExecutionException with a cause if something goes wrong
entailment
def calculate_offset(cls, labels): '''Return the maximum length of the provided strings that have a nice variant in DapFormatter._nice_strings''' used_strings = set(cls._nice_strings.keys()) & set(labels) return max([len(cls._nice_strings[s]) for s in used_strings])
Return the maximum length of the provided strings that have a nice variant in DapFormatter._nice_strings
entailment
def format_dapi_score(cls, meta, offset): '''Format the line with DAPI user rating and number of votes''' if 'average_rank' and 'rank_count' in meta: label = (cls._nice_strings['average_rank'] + ':').ljust(offset + 2) score = cls._format_field(meta['average_rank']) vo...
Format the line with DAPI user rating and number of votes
entailment
def format_meta_lines(cls, meta, labels, offset, **kwargs): '''Return all information from a given meta dictionary in a list of lines''' lines = [] # Name and underline name = meta['package_name'] if 'version' in meta: name += '-' + meta['version'] if 'custom...
Return all information from a given meta dictionary in a list of lines
entailment
def _format_files(cls, files, kind): '''Format the list of files (e. g. assistants or snippets''' lines = [] if files: lines.append('The following {kind} are contained in this DAP:'.format(kind=kind.title())) for f in files: lines.append('* ' + strip_prefi...
Format the list of files (e. g. assistants or snippets
entailment
def format_assistants_lines(cls, assistants): '''Return formatted assistants from the given list in human readable form.''' lines = cls._format_files(assistants, 'assistants') # Assistant help if assistants: lines.append('') assistant = strip_prefix(random.choice...
Return formatted assistants from the given list in human readable form.
entailment
def format_platforms(cls, platforms): '''Formats supported platforms in human readable form''' lines = [] if platforms: lines.append('This DAP is only supported on the following platforms:') lines.extend([' * ' + platform for platform in platforms]) return lines
Formats supported platforms in human readable form
entailment
def check(cls, dap, network=False, yamls=True, raises=False, logger=logger): '''Checks if the dap is valid, reports problems Parameters: network -- whether to run checks that requires network connection output -- where to write() problems, might be None raises -- whe...
Checks if the dap is valid, reports problems Parameters: network -- whether to run checks that requires network connection output -- where to write() problems, might be None raises -- whether to raise an exception immediately after problem is detected
entailment