INSTRUCTION
stringlengths
1
8.43k
RESPONSE
stringlengths
75
104k
getStyleDict - Gets a dictionary of style attribute/ value pairs.
def getStyleDict(self): ''' getStyleDict - Gets a dictionary of style attribute/value pairs. @return - OrderedDict of "style" attribute. ''' # TODO: This method is not used and does not appear in any tests. styleStr = (self.getAttribute('style') or '').strip() ...
setStyle - Sets a style param. Example: display block
def setStyle(self, styleName, styleValue): ''' setStyle - Sets a style param. Example: "display", "block" If you need to set many styles on an element, use setStyles instead. It takes a dictionary of attribute, value pairs and applies it all in one go (faster) ...
setStyles - Sets one or more style params. This all happens in one shot so it is much much faster than calling setStyle for every value.
def setStyles(self, styleUpdatesDict): ''' setStyles - Sets one or more style params. This all happens in one shot, so it is much much faster than calling setStyle for every value. To remove a style, set its value to empty string. When all styles are...
getElementById - Search children of this tag for a tag containing an id
def getElementById(self, _id): ''' getElementById - Search children of this tag for a tag containing an id @param _id - String of id @return - AdvancedTag or None ''' for child in self.children: if child.getAttribute('id') == _id: ...
getElementsByAttr - Search children of this tag for tags with an attribute name/ value pair
def getElementsByAttr(self, attrName, attrValue): ''' getElementsByAttr - Search children of this tag for tags with an attribute name/value pair @param attrName - Attribute name (lowercase) @param attrValue - Attribute value @return - TagCollection of matching e...
getElementsByClassName - Search children of this tag for tags containing a given class name
def getElementsByClassName(self, className): ''' getElementsByClassName - Search children of this tag for tags containing a given class name @param className - Class name @return - TagCollection of matching elements ''' elements = [] for child in sel...
getElementsWithAttrValues - Search children of this tag for tags with an attribute name and one of several values
def getElementsWithAttrValues(self, attrName, attrValues): ''' getElementsWithAttrValues - Search children of this tag for tags with an attribute name and one of several values @param attrName <lowercase str> - Attribute name (lowercase) @param attrValues set<str> - set of a...
getElementsCustomFilter - Searches children of this tag for those matching a provided user function
def getElementsCustomFilter(self, filterFunc): ''' getElementsCustomFilter - Searches children of this tag for those matching a provided user function @param filterFunc <function> - A function or lambda expression that should return "True" if the passed node matches criteria. ...
getFirstElementCustomFilter - Gets the first element which matches a given filter func.
def getFirstElementCustomFilter(self, filterFunc): ''' getFirstElementCustomFilter - Gets the first element which matches a given filter func. Scans first child, to the bottom, then next child to the bottom, etc. Does not include "self" node. @param filterFunc <function...
getParentElementCustomFilter - Runs through parent on up to document root returning the
def getParentElementCustomFilter(self, filterFunc): ''' getParentElementCustomFilter - Runs through parent on up to document root, returning the first tag which filterFunc(tag) returns True. @param filterFunc <function/lambda> - A funct...
getPeersCustomFilter - Get elements who share a parent with this element and also pass a custom filter check
def getPeersCustomFilter(self, filterFunc): ''' getPeersCustomFilter - Get elements who share a parent with this element and also pass a custom filter check @param filterFunc <lambda/function> - Passed in an element, and returns True if it should be treated as a match, otherwise Fal...
getPeersByAttr - Gets peers ( elements on same level ) which match an attribute/ value combination.
def getPeersByAttr(self, attrName, attrValue): ''' getPeersByAttr - Gets peers (elements on same level) which match an attribute/value combination. @param attrName - Name of attribute @param attrValue - Value that must match @return - None if no parent element (...
getPeersWithAttrValues - Gets peers ( elements on same level ) whose attribute given by #attrName are in the list of possible vaues #attrValues
def getPeersWithAttrValues(self, attrName, attrValues): ''' getPeersWithAttrValues - Gets peers (elements on same level) whose attribute given by #attrName are in the list of possible vaues #attrValues @param attrName - Name of attribute @param attrValues - ...
getPeersByName - Gets peers ( elements on same level ) with a given name
def getPeersByName(self, name): ''' getPeersByName - Gets peers (elements on same level) with a given name @param name - Name to match @return - None if no parent element (error condition), otherwise a TagCollection of peers that matched. ''' peers = self.pe...
getPeersByClassName - Gets peers ( elements on same level ) with a given class name
def getPeersByClassName(self, className): ''' getPeersByClassName - Gets peers (elements on same level) with a given class name @param className - classname must contain this name @return - None if no parent element (error condition), otherwise a TagCollection of peers that...
isTagEqual - Compare if a tag contains the same tag name and attributes as another tag
def isTagEqual(self, other): ''' isTagEqual - Compare if a tag contains the same tag name and attributes as another tag, i.e. if everything between < and > parts of this tag are the same. Does NOT compare children, etc. Does NOT compare if these are the same exact t...
append - Append an item to this tag collection
def append(self, tag): ''' append - Append an item to this tag collection @param tag - an AdvancedTag ''' list.append(self, tag) self.uids.add(tag.uid)
remove - Remove an item from this tag collection
def remove(self, toRemove): ''' remove - Remove an item from this tag collection @param toRemove - an AdvancedTag ''' list.remove(self, toRemove) self.uids.remove(toRemove.uid)
filterCollection - Filters only the immediate objects contained within this Collection against a function not including any children
def filterCollection(self, filterFunc): ''' filterCollection - Filters only the immediate objects contained within this Collection against a function, not including any children @param filterFunc <function> - A function or lambda expression that returns True to have that element match ...
getElementsByTagName - Gets elements within this collection having a specific tag name
def getElementsByTagName(self, tagName): ''' getElementsByTagName - Gets elements within this collection having a specific tag name @param tagName - String of tag name @return - TagCollection of unique elements within this collection with given tag name ''' ...
getElementsByName - Get elements within this collection having a specific name
def getElementsByName(self, name): ''' getElementsByName - Get elements within this collection having a specific name @param name - String of "name" attribute @return - TagCollection of unique elements within this collection with given "name" ''' ret = TagCo...
getElementsByClassName - Get elements within this collection containing a specific class name
def getElementsByClassName(self, className): ''' getElementsByClassName - Get elements within this collection containing a specific class name @param className - A single class name @return - TagCollection of unique elements within this collection tagged with a specific cla...
getElementById - Gets an element within this collection by id
def getElementById(self, _id): ''' getElementById - Gets an element within this collection by id @param _id - string of "id" attribute @return - a single tag matching the id, or None if none found ''' for tag in self: if tag.id == _id: ...
getElementsByAttr - Get elements within this collection posessing a given attribute/ value pair
def getElementsByAttr(self, attr, value): ''' getElementsByAttr - Get elements within this collection posessing a given attribute/value pair @param attr - Attribute name (lowercase) @param value - Matching value @return - TagCollection of all elements matching n...
getElementsWithAttrValues - Get elements within this collection possessing an attribute name matching one of several values
def getElementsWithAttrValues(self, attr, values): ''' getElementsWithAttrValues - Get elements within this collection possessing an attribute name matching one of several values @param attr <lowercase str> - Attribute name (lowerase) @param values set<str> - Set of possible...
getElementsCustomFilter - Get elements within this collection that match a user - provided function.
def getElementsCustomFilter(self, filterFunc): ''' getElementsCustomFilter - Get elements within this collection that match a user-provided function. @param filterFunc <function> - A function that returns True if the element matches criteria @return - TagCollection of all e...
getAllNodes - Gets all the nodes and all their children for every node within this collection
def getAllNodes(self): ''' getAllNodes - Gets all the nodes, and all their children for every node within this collection ''' ret = TagCollection() for tag in self: ret.append(tag) ret += tag.getAllChildNodes() return ret
getAllNodeUids - Gets all the internal uids of all nodes their children and all their children so on..
def getAllNodeUids(self): ''' getAllNodeUids - Gets all the internal uids of all nodes, their children, and all their children so on.. @return set<uuid.UUID> ''' ret = set() for child in self: ret.update(child.getAllNodeUids()) return ret
contains - Check if #em occurs within any of the elements within this list as themselves or as a child any number of levels down.
def contains(self, em): ''' contains - Check if #em occurs within any of the elements within this list, as themselves or as a child, any number of levels down. To check if JUST an element is contained within this list directly, use the "in" operator. ...
containsUid - Check if #uid is the uid ( unique internal identifier ) of any of the elements within this list as themselves or as a child any number of levels down.
def containsUid(self, uid): ''' containsUid - Check if #uid is the uid (unique internal identifier) of any of the elements within this list, as themselves or as a child, any number of levels down. @param uid <uuid.UUID> - uuid of interest @return <...
filterAll aka filterAllAnd - Perform a filter operation on ALL nodes in this collection and all their children.
def filterAll(self, **kwargs): ''' filterAll aka filterAllAnd - Perform a filter operation on ALL nodes in this collection and all their children. Results must match ALL the filter criteria. for ANY, use the *Or methods For just the nodes in this collection, use "filter" or...
filterAllOr - Perform a filter operation on ALL nodes in this collection and all their children.
def filterAllOr(self, **kwargs): ''' filterAllOr - Perform a filter operation on ALL nodes in this collection and all their children. Results must match ANY the filter criteria. for ALL, use the *And methods For just the nodes in this collection, use "filterOr" on a TagColl...
handle_starttag - Internal for parsing
def handle_starttag(self, tagName, attributeList, isSelfClosing=False): ''' handle_starttag - Internal for parsing ''' tagName = tagName.lower() inTag = self._inTag if isSelfClosing is False and tagName in IMPLICIT_SELF_CLOSING_TAGS: isSelfClosing = True ...
handle_endtag - Internal for parsing
def handle_endtag(self, tagName): ''' handle_endtag - Internal for parsing ''' inTag = self._inTag try: # Handle closing tags which should have been closed but weren't foundIt = False for i in range(len(inTag)): if inTag[i]....
handle_data - Internal for parsing
def handle_data(self, data): ''' handle_data - Internal for parsing ''' if data: inTag = self._inTag if len(inTag) > 0: if inTag[-1].tagName not in PRESERVE_CONTENTS_TAGS: data = data.replace('\t', ' ').strip('\r\n') ...
getStartTag - Override the end - spacing rules
def getStartTag(self, *args, **kwargs): ''' getStartTag - Override the end-spacing rules @see AdvancedTag.getStartTag ''' ret = AdvancedTag.getStartTag(self, *args, **kwargs) if ret.endswith(' >'): ret = ret[:-2] + '>' elif object.__getatt...
stripIEConditionals - Strips Internet Explorer conditional statements.
def stripIEConditionals(contents, addHtmlIfMissing=True): ''' stripIEConditionals - Strips Internet Explorer conditional statements. @param contents <str> - Contents String @param addHtmlIfMissing <bool> - Since these normally encompass the "html" element, optionally add it back if missing....
addStartTag - Safetly add a start tag to the document taking into account the DOCTYPE
def addStartTag(contents, startTag): ''' addStartTag - Safetly add a start tag to the document, taking into account the DOCTYPE @param contents <str> - Contents @param startTag <str> - Fully formed tag, i.e. <html> ''' matchObj = DOCTYPE_MATCH.match(contents) if matchObj: ...
Internal for parsing
def handle_endtag(self, tagName): ''' Internal for parsing ''' inTag = self._inTag if len(inTag) == 0: # Attempted to close, but no open tags raise InvalidCloseException(tagName, []) foundIt = False i = len(inTag) - 1 while i >...
convertToBooleanString - Converts a value to either a string of true or false
def convertToBooleanString(val=None): ''' convertToBooleanString - Converts a value to either a string of "true" or "false" @param val <int/str/bool> - Value ''' if hasattr(val, 'lower'): val = val.lower() # Technically, if you set one of these attributes (like "spellch...
convertBooleanStringToBoolean - Convert from a boolean attribute ( string true/ false ) into a booelan
def convertBooleanStringToBoolean(val=None): ''' convertBooleanStringToBoolean - Convert from a boolean attribute (string "true" / "false" ) into a booelan ''' if not val: return False if hasattr(val, 'lower'): val = val.lower() if val == "false": return False r...
convertToPositiveInt - Convert to a positive integer and if invalid use a given value
def convertToPositiveInt(val=None, invalidDefault=0): ''' convertToPositiveInt - Convert to a positive integer, and if invalid use a given value ''' if val is None: return invalidDefault try: val = int(val) except: return invalidDefault if val < 0: retur...
_handleInvalid - Common code for raising/ returning an invalid value
def _handleInvalid(invalidDefault): ''' _handleInvalid - Common code for raising / returning an invalid value @param invalidDefault <None/str/Exception> - The value to return if "val" is not empty string/None and "val" is not in #possib...
convertPossibleValues - Convert input value to one of several possible values with a default for invalid entries
def convertPossibleValues(val, possibleValues, invalidDefault, emptyValue=''): ''' convertPossibleValues - Convert input value to one of several possible values, with a default for invalid entries @param val <None/str> - The input value ...
converToIntRange - Convert input value to an integer within a certain range @param val <None/ str/ int/ float > - The input value
def convertToIntRange(val, minValue, maxValue, invalidDefault, emptyValue=''): ''' converToIntRange - Convert input value to an integer within a certain range @param val <None/str/int/float> - The input value @param minValue <None/int> - The minimum value (inclusive), o...
_setTag - INTERNAL METHOD. Associated a given AdvancedTag to this attributes dict.
def _setTag(self, tag): ''' _setTag - INTERNAL METHOD. Associated a given AdvancedTag to this attributes dict. If bool(#tag) is True, will set the weakref to that tag. Otherwise, will clear the reference @param tag <AdvancedTag...
_handleClassAttr - Hack to ensure class and style show up in attributes when classes are set and doesn t when no classes are present on associated tag.
def _handleClassAttr(self): ''' _handleClassAttr - Hack to ensure "class" and "style" show up in attributes when classes are set, and doesn't when no classes are present on associated tag. TODO: I don't like this hack. ''' if len(self.tag._classNames)...
get - Gets an attribute by key with the chance to provide a default value
def get(self, key, default=None): ''' get - Gets an attribute by key with the chance to provide a default value @param key <str> - The key to query @param default <Anything> Default None - The value to return if key is not found @return - The value of ...
_direct_set - INTERNAL USE ONLY!!!!
def _direct_set(self, key, value): ''' _direct_set - INTERNAL USE ONLY!!!! Directly sets a value on the underlying dict, without running through the setitem logic ''' dict.__setitem__(self, key, value) return value
setTag - Set the tag association for this style. This will handle the underlying weakref to the tag.
def setTag(self, tag): ''' setTag - Set the tag association for this style. This will handle the underlying weakref to the tag. Call setTag(None) to clear the association, otherwise setTag(tag) to associate this style to that tag. @param ta...
_ensureHtmlAttribute - INTERNAL METHOD. Ensure the style attribute is present in the html attributes when is has a value and absent when it does not.
def _ensureHtmlAttribute(self): ''' _ensureHtmlAttribute - INTERNAL METHOD. Ensure the "style" attribute is present in the html attributes when is has a value, and absent when it does not. This requires speci...
setProperty - Set a style property to a value.
def setProperty(self, name, value): ''' setProperty - Set a style property to a value. NOTE: To remove a style, use a value of empty string, or None @param name <str> - The style name. NOTE: The dash names are expected here, whereas dot-access ...
dashNameToCamelCase - Converts a dash name ( like padding - top ) to its camel - case name ( like paddingTop )
def dashNameToCamelCase(dashName): ''' dashNameToCamelCase - Converts a "dash name" (like padding-top) to its camel-case name ( like "paddingTop" ) @param dashName <str> - A name containing dashes NOTE: This method is currently unused, but may be used in the future. kep...
camelCaseToDashName - Convert a camel case name to a dash - name ( like paddingTop to padding - top )
def camelCaseToDashName(camelCase): ''' camelCaseToDashName - Convert a camel case name to a dash-name (like paddingTop to padding-top) @param camelCase <str> - A camel-case string @return <str> - A dash-name ''' camelCaseList = list(camelCase) ret...
getStyleDict - Gets a dictionary of style attribute/ value pairs.
def styleToDict(styleStr): ''' getStyleDict - Gets a dictionary of style attribute/value pairs. NOTE: dash-names (like padding-top) are used here @return - OrderedDict of "style" attribute. ''' styleStr = styleStr.strip() styles = styleStr.split(';...
_asStr - Get the string representation of this style
def _asStr(self): ''' _asStr - Get the string representation of this style @return <str> - A string representation of this style (semicolon separated, key: value format) ''' styleDict = self._styleDict if styleDict: return '; '.join([name + ': ' + ...
_special_value_rows - Handle rows special attribute which differs if tagName is a textarea or frameset
def _special_value_rows(em): ''' _special_value_rows - Handle "rows" special attribute, which differs if tagName is a textarea or frameset ''' if em.tagName == 'textarea': return convertToIntRange(em.getAttribute('rows', 2), minValue=1, maxValue=None, invalidDefault=2) else: # fr...
_special_value_cols - Handle cols special attribute which differs if tagName is a textarea or frameset
def _special_value_cols(em): ''' _special_value_cols - Handle "cols" special attribute, which differs if tagName is a textarea or frameset ''' if em.tagName == 'textarea': return convertToIntRange(em.getAttribute('cols', 20), minValue=1, maxValue=None, invalidDefault=20) else: # ...
handle autocomplete property which has different behaviour for form vs input
def _special_value_autocomplete(em): ''' handle "autocomplete" property, which has different behaviour for form vs input" ''' if em.tagName == 'form': return convertPossibleValues(em.getAttribute('autocomplete', 'on'), POSSIBLE_VALUES_ON_OFF, invalidDefault='on', emptyValue=EMPTY_IS_INVALID)...
handle size property which has different behaviour for input vs everything else
def _special_value_size(em): ''' handle "size" property, which has different behaviour for input vs everything else ''' if em.tagName == 'input': # TODO: "size" on an input is implemented very weirdly. Negative values are treated as invalid, # A value of "0" raises an except...
_special_value_maxLength - Handle the special maxLength property
def _special_value_maxLength(em, newValue=NOT_PROVIDED): ''' _special_value_maxLength - Handle the special "maxLength" property @param em <AdvancedTag> - The tag element @param newValue - Default NOT_PROVIDED, if provided will use that value instead of the current ...
Converts a value into a corresponding data object. For files this looks up a file DataObject by name uuid and/ or md5. For other types it creates a new DataObject.
def get_by_value(cls, value, type): """ Converts a value into a corresponding data object. For files, this looks up a file DataObject by name, uuid, and/or md5. For other types, it creates a new DataObject. """ if type == 'file': return cls._get_file_by_value(value) ...
Look up a file DataObject by name uuid and/ or md5.
def _get_file_by_value(cls, value): """Look up a file DataObject by name, uuid, and/or md5. """ # Ignore any FileResource with no DataObject. This is a typical state # for a deleted file that has not yet been cleaned up. queryset = FileResource.objects.exclude(data_object__isnull...
Create a path for a given file in such a way that files end up being organized and browsable by run
def _get_run_breadcrumbs(cls, source_type, data_object, task_attempt): """Create a path for a given file, in such a way that files end up being organized and browsable by run """ # We cannot generate the path unless connect to a TaskAttempt # and a run if not task_attempt...
Find objects that match the identifier of form { name }
def filter_by_name_or_id_or_tag(self, query_string, queryset = None): """Find objects that match the identifier of form {name}@{ID}, {name}, or @{ID}, where ID may be truncated """ assert self.Model.NAME_FIELD, \ 'NAME_FIELD is missing on model %s' % self.Model.__name__ ...
This save method protects against two processesses concurrently modifying the same object. Normally the second save would silently overwrite the changes from the first. Instead we raise a ConcurrentModificationError.
def save(self, *args, **kwargs): """ This save method protects against two processesses concurrently modifying the same object. Normally the second save would silently overwrite the changes from the first. Instead we raise a ConcurrentModificationError. """ cls = self.__c...
If the object is being edited by other processes save may fail due to concurrent modification. This method recovers and retries the edit.
def setattrs_and_save_with_retries(self, assignments, max_retries=5): """ If the object is being edited by other processes, save may fail due to concurrent modification. This method recovers and retries the edit. assignments is a dict of {attribute: value} """ co...
This method implements retries for object deletion.
def delete(self, *args, **kwargs): """ This method implements retries for object deletion. """ count = 0 max_retries=3 while True: try: return super(BaseModel, self).delete(*args, **kwargs) except django.db.utils.OperationalError: ...
Checks server. ini for server type.
def get_server_type(): """Checks server.ini for server type.""" server_location_file = os.path.expanduser(SERVER_LOCATION_FILE) if not os.path.exists(server_location_file): raise Exception( "%s not found. Please run 'loom server set " "<servertype>' first." % server_location_...
Set file_data_object. file_resource. upload_status
def _set_upload_status(self, file_data_object, upload_status): """ Set file_data_object.file_resource.upload_status """ uuid = file_data_object['uuid'] return self.connection.update_data_object( uuid, {'uuid': uuid, 'value': { 'upload_status': upload_status}} ...
Anywhere in template that refers to a data object but does not give a specific UUID if a matching file can be found in file_dependencies we will change the data object reference to use that UUID. That way templates have a preference to connect to files nested under their. dependencies over files that were previously im...
def _substitute_file_uuids_throughout_template(self, template, file_dependencies): """Anywhere in "template" that refers to a data object but does not give a specific UUID, if a matching file can be found in "file_dependencies", we will change the data object reference to use that UUID. That wa...
Converts command line args into a list of template inputs
def _get_inputs(self): """Converts command line args into a list of template inputs """ # Convert file inputs to a dict, to make it easier to override # them with commandline inputs file_inputs = self._get_file_inputs() try: jsonschema.validate(file_inputs, fi...
e. g. convert [[ a b c ] [ d e ] [ f g ]] into [[ a b c ] [ d e ] [ f g ]]
def _parse_string_to_nested_lists(self, value): """e.g., convert "[[a,b,c],[d,e],[f,g]]" into [["a","b","c"],["d","e"],["f","g"]] """ if not re.match(r'\[.*\]', value.strip()): if '[' in value or ']' in value or ',' in value: raise Exception('Missing outer bra...
Converts command line args into a list of template inputs
def _get_inputs(self, old_inputs): """Converts command line args into a list of template inputs """ # Convert inputs to dict to facilitate overriding by channel name # Also, drop DataNode ID and keep only contents. input_dict = {} for input in old_inputs: # St...
This is a standard method called indirectly by calling save on the serializer.
def create(self, validated_data): """ This is a standard method called indirectly by calling 'save' on the serializer. This method expects the 'parent_field' and 'parent_instance' to be included in the Serializer context. """ if self.context.get('parent_field') \ ...
Suppress warning about untrusted SSL certificate.
def disable_insecure_request_warning(): """Suppress warning about untrusted SSL certificate.""" import requests from requests.packages.urllib3.exceptions import InsecureRequestWarning requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
Retry sending request until timeout or until receiving a response.
def _make_request_to_server(self, query_function, raise_for_status=True, time_limit_seconds=2, retry_delay_seconds=0.2): """Retry sending request until timeout or until receiving a response. """ start_time = datetime.datetime.now() while datetime.datetime....
Convenience function for retrieving a resource. If resource does not exist return None.
def _get_resource(self, relative_url, params=None): """Convenience function for retrieving a resource. If resource does not exist, return None. """ response = self._get(relative_url, params=params, raise_for_status=False) if response.status_code == 404: return None ...
Returns the correct Input class for a given data type and gather mode
def TaskAttemptInput(input, task_attempt): """Returns the correct Input class for a given data type and gather mode """ (data_type, mode) = _get_input_info(input) if data_type != 'file': return NoOpInput(None, task_attempt) if mode == 'no_gather': return FileInput(input['data'...
Run a task asynchronously
def execute(task_function, *args, **kwargs): """Run a task asynchronously """ if get_setting('TEST_DISABLE_ASYNC_DELAY'): # Delay disabled, run synchronously logger.debug('Running function "%s" synchronously because '\ 'TEST_DISABLE_ASYNC_DELAY is True' ...
Run a task asynchronously after at least delay_seconds
def execute_with_delay(task_function, *args, **kwargs): """Run a task asynchronously after at least delay_seconds """ delay = kwargs.pop('delay', 0) if get_setting('TEST_DISABLE_ASYNC_DELAY'): # Delay disabled, run synchronously logger.debug('Running function "%s" synchronously because '...
Check for tasks that are no longer sending a heartbeat
def check_for_stalled_tasks(): """Check for tasks that are no longer sending a heartbeat """ from api.models.tasks import Task for task in Task.objects.filter(status_is_running=True): if not task.is_responsive(): task.system_error() if task.is_timed_out(): task.ti...
Check for TaskAttempts that were never cleaned up
def check_for_missed_cleanup(): """Check for TaskAttempts that were never cleaned up """ if get_setting('PRESERVE_ALL'): return from api.models.tasks import TaskAttempt if get_setting('PRESERVE_ON_FAILURE'): for task_attempt in TaskAttempt.objects.filter( status_is_ru...
This attempts to execute retryable_function with exponential backoff on delay time. 10 retries adds up to about 34 minutes total delay before the last attempt. human_readable_action_name is an option input to customize retry message.
def execute_with_retries(retryable_function, retryable_errors, logger, human_readable_action_name='Action', nonretryable_errors=None): """This attempts to execute "retryable_function" with exponential backoff on ...
Export a file from Loom to some file storage location. Default destination_directory is cwd. Default destination_filename is the filename from the file data object associated with the given file_id.
def export_file(self, data_object, destination_directory=None, destination_filename=None, retry=False, export_metadata=False, export_raw_file=True): """Export a file from Loom to some file storage location. Default destination_directory is cwd. Default destination...
Like urlparse except it assumes file:// if no scheme is specified
def _urlparse(path): """Like urlparse except it assumes 'file://' if no scheme is specified """ url = urlparse.urlparse(path) _validate_url(url) if not url.scheme or url.scheme == 'file://': # Normalize path, and set scheme to "file" if missing path = os.path.abspath( os....
Factory method returns LocalFilePattern or GoogleStorageFilePattern
def FilePattern(pattern, settings, **kwargs): """Factory method returns LocalFilePattern or GoogleStorageFilePattern """ url = _urlparse(pattern) if url.scheme == 'gs': return GoogleStorageFilePattern(pattern, settings, **kwargs) else: assert url.scheme == 'file' return Local...
Factory method
def File(url, settings, retry=False): """Factory method """ parsed_url = _urlparse(url) if parsed_url.scheme == 'gs': return GoogleStorageFile(url, settings, retry=retry) elif parsed_url.scheme == 'file': if parsed_url.hostname == 'localhost' or parsed_url.hostname is None: ...
Factory method to select the right copier for a given source and destination.
def Copier(source, destination): """Factory method to select the right copier for a given source and destination. """ if source.type == 'local' and destination.type == 'local': return LocalCopier(source, destination) elif source.type == 'local' and destination.type == 'google_storage': ...
Scan the data tree on the given data_channel to create a corresponding InputSetGenerator tree.
def create_from_data_channel(cls, data_channel): """Scan the data tree on the given data_channel to create a corresponding InputSetGenerator tree. """ gather_depth = cls._get_gather_depth(data_channel) generator = InputSetGeneratorNode() for (data_path, data_node) in dat...
Returns the correct Output class for a given data type source type and scatter mode
def TaskAttemptOutput(output, task_attempt): """Returns the correct Output class for a given data type, source type, and scatter mode """ (data_type, mode, source_type) = _get_output_info(output) if data_type == 'file': if mode == 'scatter': assert source_type in ['filenames', ...
Adds a new leaf node at the given index with the given data_object
def add_leaf(self, index, data_object, save=False): """Adds a new leaf node at the given index with the given data_object """ assert self.type == data_object.type, 'data type mismatch' if self._get_child_by_index(index) is not None: raise NodeAlreadyExistsError( ...
Returns a list [ ( path1 data_node1 )... ] with entries only for existing nodes with DataObjects where is_ready == True. Missing nodes or those with non - ready or non - existing data are ignored.
def get_ready_data_nodes(self, seed_path, gather_depth): """Returns a list [(path1,data_node1),...] with entries only for existing nodes with DataObjects where is_ready==True. Missing nodes or those with non-ready or non-existing data are ignored. """ try: seed_node =...
Verify that the given index is consistent with the degree of the node.
def _check_index(self, index): """Verify that the given index is consistent with the degree of the node. """ if self.degree is None: raise UnknownDegreeError( 'Cannot access child DataNode on a parent with degree of None. '\ 'Set the degree on the pare...
Determines if we re running on a GCE instance.
def on_gcloud_vm(): """ Determines if we're running on a GCE instance.""" r = None try: r = requests.get('http://metadata.google.internal') except requests.ConnectionError: return False try: if r.headers['Metadata-Flavor'] == 'Google' and \ r.headers['Server'] == ...
Determine the cheapest instance type given a minimum number of cores and minimum amount of RAM ( in GB ).
def get_cheapest_instance_type(cores, memory): """Determine the cheapest instance type given a minimum number of cores and minimum amount of RAM (in GB). """ pricelist = get_gcloud_pricelist() # Filter out preemptible, shared-CPU, and non-US instance types us_instance_types = {k: v for k, v in...
Retrieve latest pricelist from Google Cloud or use cached copy if not reachable.
def get_gcloud_pricelist(): """Retrieve latest pricelist from Google Cloud, or use cached copy if not reachable. """ try: r = requests.get('http://cloudpricingcalculator.appspot.com' '/static/data/pricelist.json') content = json.loads(r.content) except Connec...
Create a base name for the worker instance that will run the specified task run attempt from this server. Since hostname and step name will be duplicated across workers ( reruns etc. ) ensure that at least MIN_TASK_ID_CHARS are preserved in the instance name. Also prevent names from ending with dashes.
def _get_base_name(hostname, step_name, attempt_id, max_length): """Create a base name for the worker instance that will run the specified task run attempt, from this server. Since hostname and step name will be duplicated across workers (reruns, etc.), ensure that at least MIN_TASK_ID_CHARS are preserv...
Instance names must start with a lowercase letter. All following characters must be a dash lowercase letter or digit.
def _sanitize_instance_name(name, max_length): """Instance names must start with a lowercase letter. All following characters must be a dash, lowercase letter, or digit. """ name = str(name).lower() # make all letters lowercase name = re.sub(r'[^-a-z0-9]', '', name) # remove inva...
Determines if the cache files have expired or if it is still valid
def is_valid(self, max_age=None): ''' Determines if the cache files have expired, or if it is still valid ''' if max_age is None: max_age = self.cache_max_age if os.path.isfile(self.cache_path_cache): mod_time = os.path.getmtime(self.cache_path_cache) curren...