sentence1
stringlengths 52
3.87M
| sentence2
stringlengths 1
47.2k
| label
stringclasses 1
value |
|---|---|---|
def getElementById(self, _id, root='root', useIndex=True):
'''
getElementById - Searches and returns the first (should only be one) element with the given ID.
@param id <str> - A string of the id attribute.
@param root <AdvancedTag/'root'> - Search starting at a specific node, if provided. if string 'root', the root of the parsed tree will be used.
@param useIndex <bool> If useIndex is True and ids are indexed [see constructor] only the index will be used. Otherwise a full search is performed.
'''
(root, isFromRoot) = self._handleRootArg(root)
if self.useIndex is True and self.indexIDs is True:
element = self._idMap.get(_id, None)
if isFromRoot is False and element is not None:
if self._hasTagInParentLine(element, root) is False:
element = None
return element
return AdvancedHTMLParser.getElementById(self, _id, root) | getElementById - Searches and returns the first (should only be one) element with the given ID.
@param id <str> - A string of the id attribute.
@param root <AdvancedTag/'root'> - Search starting at a specific node, if provided. if string 'root', the root of the parsed tree will be used.
@param useIndex <bool> If useIndex is True and ids are indexed [see constructor] only the index will be used. Otherwise a full search is performed. | entailment |
def getElementsByClassName(self, className, root='root', useIndex=True):
'''
getElementsByClassName - Searches and returns all elements containing a given class name.
@param className <str> - A one-word class name
@param root <AdvancedTag/'root'> - Search starting at a specific node, if provided. if string 'root', the root of the parsed tree will be used.
@param useIndex <bool> If useIndex is True and class names are indexed [see constructor] only the index will be used. Otherwise a full search is performed.
'''
(root, isFromRoot) = self._handleRootArg(root)
if useIndex is True and self.indexClassNames is True:
elements = self._classNameMap.get(className, [])
if isFromRoot is False:
_hasTagInParentLine = self._hasTagInParentLine
elements = [x for x in elements if _hasTagInParentLine(x, root)]
return TagCollection(elements)
return AdvancedHTMLParser.getElementsByClassName(self, className, root) | getElementsByClassName - Searches and returns all elements containing a given class name.
@param className <str> - A one-word class name
@param root <AdvancedTag/'root'> - Search starting at a specific node, if provided. if string 'root', the root of the parsed tree will be used.
@param useIndex <bool> If useIndex is True and class names are indexed [see constructor] only the index will be used. Otherwise a full search is performed. | entailment |
def getElementsByAttr(self, attrName, attrValue, root='root', useIndex=True):
'''
getElementsByAttr - Searches the full tree for elements with a given attribute name and value combination. If you want multiple potential values, see getElementsWithAttrValues
If you want an index on a random attribute, use the addIndexOnAttribute function.
@param attrName <lowercase str> - A lowercase attribute name
@param attrValue <str> - Expected value of attribute
@param root <AdvancedTag/'root'> - Search starting at a specific node, if provided. if string 'root', the root of the parsed tree will be used.
@param useIndex <bool> If useIndex is True and this specific attribute is indexed [see addIndexOnAttribute] only the index will be used. Otherwise a full search is performed.
'''
(root, isFromRoot) = self._handleRootArg(root)
if useIndex is True and attrName in self._otherAttributeIndexes:
elements = self._otherAttributeIndexes[attrName].get(attrValue, [])
if isFromRoot is False:
_hasTagInParentLine = self._hasTagInParentLine
elements = [x for x in elements if _hasTagInParentLine(x, root)]
return TagCollection(elements)
return AdvancedHTMLParser.getElementsByAttr(self, attrName, attrValue, root) | getElementsByAttr - Searches the full tree for elements with a given attribute name and value combination. If you want multiple potential values, see getElementsWithAttrValues
If you want an index on a random attribute, use the addIndexOnAttribute function.
@param attrName <lowercase str> - A lowercase attribute name
@param attrValue <str> - Expected value of attribute
@param root <AdvancedTag/'root'> - Search starting at a specific node, if provided. if string 'root', the root of the parsed tree will be used.
@param useIndex <bool> If useIndex is True and this specific attribute is indexed [see addIndexOnAttribute] only the index will be used. Otherwise a full search is performed. | entailment |
def getElementsWithAttrValues(self, attrName, values, root='root', useIndex=True):
'''
getElementsWithAttrValues - Returns elements with an attribute matching one of several values. For a single name/value combination, see getElementsByAttr
@param attrName <lowercase str> - A lowercase attribute name
@param attrValues set<str> - List of expected values of attribute
@param root <AdvancedTag/'root'> - Search starting at a specific node, if provided. if string 'root', the root of the parsed tree will be used.
@param useIndex <bool> If useIndex is True and this specific attribute is indexed [see addIndexOnAttribute] only the index will be used. Otherwise a full search is performed.
'''
(root, isFromRoot) = self._handleRootArg(root)
_otherAttributeIndexes = self._otherAttributeIndexes
if useIndex is True and attrName in _otherAttributeIndexes:
elements = TagCollection()
for value in values:
elements += TagCollection(_otherAttributeIndexes[attrName].get(value, []))
return elements
return AdvancedHTMLParser.getElementsWithAttrValues(self, attrName, values, root, useIndex) | getElementsWithAttrValues - Returns elements with an attribute matching one of several values. For a single name/value combination, see getElementsByAttr
@param attrName <lowercase str> - A lowercase attribute name
@param attrValues set<str> - List of expected values of attribute
@param root <AdvancedTag/'root'> - Search starting at a specific node, if provided. if string 'root', the root of the parsed tree will be used.
@param useIndex <bool> If useIndex is True and this specific attribute is indexed [see addIndexOnAttribute] only the index will be used. Otherwise a full search is performed. | entailment |
def uniqueTags(tagList):
'''
uniqueTags - Returns the unique tags in tagList.
@param tagList list<AdvancedTag> : A list of tag objects.
'''
ret = []
alreadyAdded = set()
for tag in tagList:
myUid = tag.getUid()
if myUid in alreadyAdded:
continue
ret.append(tag)
return TagCollection(ret) | uniqueTags - Returns the unique tags in tagList.
@param tagList list<AdvancedTag> : A list of tag objects. | entailment |
def toggleAttributesDOM(isEnabled):
'''
toggleAttributesDOM - Toggle if the old DOM tag.attributes NamedNodeMap model should be used for the .attributes method, versus
a more sane direct dict implementation.
The DOM version is always accessable as AdvancedTag.attributesDOM
The dict version is always accessable as AdvancedTag.attributesDict
Default for AdvancedTag.attributes is to be attributesDict implementation.
@param isEnabled <bool> - If True, .attributes will be changed to use the DOM-provider. Otherwise, it will use the dict provider.
'''
if isEnabled:
AdvancedTag.attributes = AdvancedTag.attributesDOM
else:
AdvancedTag.attributes = AdvancedTag.attributesDict | toggleAttributesDOM - Toggle if the old DOM tag.attributes NamedNodeMap model should be used for the .attributes method, versus
a more sane direct dict implementation.
The DOM version is always accessable as AdvancedTag.attributesDOM
The dict version is always accessable as AdvancedTag.attributesDict
Default for AdvancedTag.attributes is to be attributesDict implementation.
@param isEnabled <bool> - If True, .attributes will be changed to use the DOM-provider. Otherwise, it will use the dict provider. | entailment |
def cloneNode(self):
'''
cloneNode - Clone this node (tag name and attributes). Does not clone children.
Tags will be equal according to isTagEqual method, but will contain a different internal
unique id such tag origTag != origTag.cloneNode() , as is the case in JS DOM.
'''
return self.__class__(self.tagName, self.getAttributesList(), self.isSelfClosing) | cloneNode - Clone this node (tag name and attributes). Does not clone children.
Tags will be equal according to isTagEqual method, but will contain a different internal
unique id such tag origTag != origTag.cloneNode() , as is the case in JS DOM. | entailment |
def appendText(self, text):
'''
appendText - append some inner text
'''
# self.text is just raw string of the text
self.text += text
self.isSelfClosing = False # inner text means it can't self close anymo
# self.blocks is either text or tags, in order of appearance
self.blocks.append(text) | appendText - append some inner text | entailment |
def removeText(self, text):
'''
removeText - Removes the first occurace of given text in a text node (i.e. not part of a tag)
@param text <str> - text to remove
@return text <str/None> - The text in that block (text node) after remove, or None if not found
NOTE: To remove a node, @see removeChild
NOTE: To remove a block (maybe a node, maybe text), @see removeBlock
NOTE: To remove ALL occuraces of text, @see removeTextAll
'''
# TODO: This would be a good candidate for the refactor of text blocks
removedBlock = None
# Scan all text blocks for "text"
blocks = self.blocks
for i in range(len(blocks)):
block = blocks[i]
# We only care about text blocks
if issubclass(block.__class__, AdvancedTag):
continue
if text in block:
# We have a block that matches.
# Create a copy of the old text in this block for return
removedBlock = block[:]
# Remove first occurance of #text from matched block
blocks[i] = block.replace(text, '')
break # remove should only remove FIRST occurace, per other methods
# Regenerate the "text" property
self.text = ''.join([thisBlock for thisBlock in blocks if not issubclass(thisBlock.__class__, AdvancedTag)])
# Return None if no match, otherwise the text previously within the block we removed #text from
return removedBlock | removeText - Removes the first occurace of given text in a text node (i.e. not part of a tag)
@param text <str> - text to remove
@return text <str/None> - The text in that block (text node) after remove, or None if not found
NOTE: To remove a node, @see removeChild
NOTE: To remove a block (maybe a node, maybe text), @see removeBlock
NOTE: To remove ALL occuraces of text, @see removeTextAll | entailment |
def removeTextAll(self, text):
'''
removeTextAll - Removes ALL occuraces of given text in a text node (i.e. not part of a tag)
@param text <str> - text to remove
@return list <str> - All text node containing #text BEFORE the text was removed.
Empty list if no text removed
NOTE: To remove a node, @see removeChild
NOTE: To remove a block (maybe a node, maybe text), @see removeBlock
NOTE: To remove a single occurace of text, @see removeText
'''
# TODO: This would be a good candidate for the refactor of text blocks
removedBlocks = []
blocks = self.blocks
for i in range(len(blocks)):
block = blocks[i]
# We only care about text blocks
if issubclass(block.__class__, AdvancedTag):
continue
if text in block:
# Got a match, save a copy of the text block pre-replace for the return
removedBlocks.append( block[:] )
# And replace the text within this matched block
blocks[i] = block.replace(text, '')
# Regenerate self.text
self.text = ''.join([thisBlock for thisBlock in blocks if not issubclass(thisBlock.__class__, AdvancedTag)])
return removedBlocks | removeTextAll - Removes ALL occuraces of given text in a text node (i.e. not part of a tag)
@param text <str> - text to remove
@return list <str> - All text node containing #text BEFORE the text was removed.
Empty list if no text removed
NOTE: To remove a node, @see removeChild
NOTE: To remove a block (maybe a node, maybe text), @see removeBlock
NOTE: To remove a single occurace of text, @see removeText | entailment |
def remove(self):
'''
remove - Will remove this node from its parent, if it has a parent (thus taking it out of the HTML tree)
NOTE: If you are using an IndexedAdvancedHTMLParser, calling this will NOT update the index. You MUST call
reindex method manually.
@return <bool> - While JS DOM defines no return for this function, this function will return True if a
remove did happen, or False if no parent was set.
'''
if self.parentNode:
self.parentNode.removeChild(self)
# self.parentNode will now be None by 'removeChild' method
return True
return False | remove - Will remove this node from its parent, if it has a parent (thus taking it out of the HTML tree)
NOTE: If you are using an IndexedAdvancedHTMLParser, calling this will NOT update the index. You MUST call
reindex method manually.
@return <bool> - While JS DOM defines no return for this function, this function will return True if a
remove did happen, or False if no parent was set. | entailment |
def removeBlocks(self, blocks):
'''
removeBlock - Removes a list of blocks (the first occurance of each) from the direct children of this node.
@param blocks list<str/AdvancedTag> - List of AdvancedTags for tag nodes, else strings for text nodes
@return The removed blocks in each slot, or None if None removed.
@see removeChild
@see removeText
For multiple, @see removeBlocks
'''
ret = []
for block in blocks:
if issubclass(block.__class__, AdvancedTag):
ret.append( self.removeChild(block) )
else:
# TODO: Should this just forward to removeText?
ret.append( self.removeBlock(block) )
return ret | removeBlock - Removes a list of blocks (the first occurance of each) from the direct children of this node.
@param blocks list<str/AdvancedTag> - List of AdvancedTags for tag nodes, else strings for text nodes
@return The removed blocks in each slot, or None if None removed.
@see removeChild
@see removeText
For multiple, @see removeBlocks | entailment |
def appendChild(self, child):
'''
appendChild - Append a child to this element.
@param child <AdvancedTag> - Append a child element to this element
'''
# Associate parentNode of #child to this tag
child.parentNode = self
# Associate owner document to child and all children recursive
ownerDocument = self.ownerDocument
child.ownerDocument = ownerDocument
for subChild in child.getAllChildNodes():
subChild.ownerDocument = ownerDocument
# Our tag cannot be self-closing if we have a child tag
self.isSelfClosing = False
# Append to both "children" and "blocks"
self.children.append(child)
self.blocks.append(child)
return child | appendChild - Append a child to this element.
@param child <AdvancedTag> - Append a child element to this element | entailment |
def appendBlock(self, block):
'''
append / appendBlock - Append a block to this element. A block can be a string (text node), or an AdvancedTag (tag node)
@param <str/AdvancedTag> - block to add
@return - #block
NOTE: To add multiple blocks, @see appendBlocks
If you know the type, use either @see appendChild for tags or @see appendText for text
'''
# Determine block type and call appropriate method
if isinstance(block, AdvancedTag):
self.appendNode(block)
else:
self.appendText(block)
return block | append / appendBlock - Append a block to this element. A block can be a string (text node), or an AdvancedTag (tag node)
@param <str/AdvancedTag> - block to add
@return - #block
NOTE: To add multiple blocks, @see appendBlocks
If you know the type, use either @see appendChild for tags or @see appendText for text | entailment |
def appendBlocks(self, blocks):
'''
appendBlocks - Append blocks to this element. A block can be a string (text node), or an AdvancedTag (tag node)
@param blocks list<str/AdvancedTag> - A list, in order to append, of blocks to add.
@return - #blocks
NOTE: To add a single block, @see appendBlock
If you know the type, use either @see appendChild for tags or @see appendText for text
'''
for block in blocks:
if isinstance(block, AdvancedTag):
self.appendNode(block)
else:
self.appendText(block)
return blocks | appendBlocks - Append blocks to this element. A block can be a string (text node), or an AdvancedTag (tag node)
@param blocks list<str/AdvancedTag> - A list, in order to append, of blocks to add.
@return - #blocks
NOTE: To add a single block, @see appendBlock
If you know the type, use either @see appendChild for tags or @see appendText for text | entailment |
def appendInnerHTML(self, html):
'''
appendInnerHTML - Appends nodes from arbitrary HTML as if doing element.innerHTML += 'someHTML' in javascript.
@param html <str> - Some HTML
NOTE: If associated with a document ( AdvancedHTMLParser ), the html will use the encoding associated with
that document.
@return - None. A browser would return innerHTML, but that's somewhat expensive on a high-level node.
So just call .innerHTML explicitly if you need that
'''
# Late-binding to prevent circular import
from .Parser import AdvancedHTMLParser
# Inherit encoding from the associated document, if any.
encoding = None
if self.ownerDocument:
encoding = self.ownerDocument.encoding
# Generate blocks (text nodes and AdvancedTag's) from HTML
blocks = AdvancedHTMLParser.createBlocksFromHTML(html, encoding)
# Throw them onto this node
self.appendBlocks(blocks) | appendInnerHTML - Appends nodes from arbitrary HTML as if doing element.innerHTML += 'someHTML' in javascript.
@param html <str> - Some HTML
NOTE: If associated with a document ( AdvancedHTMLParser ), the html will use the encoding associated with
that document.
@return - None. A browser would return innerHTML, but that's somewhat expensive on a high-level node.
So just call .innerHTML explicitly if you need that | entailment |
def removeChild(self, child):
'''
removeChild - Remove a child tag, if present.
@param child <AdvancedTag> - The child to remove
@return - The child [with parentNode cleared] if removed, otherwise None.
NOTE: This removes a tag. If removing a text block, use #removeText function.
If you need to remove an arbitrary block (text or AdvancedTag), @see removeBlock
Removing multiple children? @see removeChildren
'''
try:
# Remove from children and blocks
self.children.remove(child)
self.blocks.remove(child)
# Clear parent node association on child
child.parentNode = None
# Clear document reference on removed child and all children thereof
child.ownerDocument = None
for subChild in child.getAllChildNodes():
subChild.ownerDocument = None
return child
except ValueError:
# TODO: What circumstances cause this to be raised? Is it okay to have a partial remove?
#
# Is it only when "child" is not found? Should that just be explicitly tested?
return None | removeChild - Remove a child tag, if present.
@param child <AdvancedTag> - The child to remove
@return - The child [with parentNode cleared] if removed, otherwise None.
NOTE: This removes a tag. If removing a text block, use #removeText function.
If you need to remove an arbitrary block (text or AdvancedTag), @see removeBlock
Removing multiple children? @see removeChildren | entailment |
def removeChildren(self, children):
'''
removeChildren - Remove multiple child AdvancedTags.
@see removeChild
@return list<AdvancedTag/None> - A list of all tags removed in same order as passed.
Item is "None" if it was not attached to this node, and thus was not removed.
'''
ret = []
for child in children:
ret.append( self.removeChild(child) )
return ret | removeChildren - Remove multiple child AdvancedTags.
@see removeChild
@return list<AdvancedTag/None> - A list of all tags removed in same order as passed.
Item is "None" if it was not attached to this node, and thus was not removed. | entailment |
def removeBlock(self, block):
'''
removeBlock - Removes a single block (text node or AdvancedTag) which is a child of this object.
@param block <str/AdvancedTag> - The block (text node or AdvancedTag) to remove.
@return Returns the removed block if one was removed, or None if requested block is not a child of this node.
NOTE: If you know you are going to remove an AdvancedTag, @see removeChild
If you know you are going to remove a text node, @see removeText
If removing multiple blocks, @see removeBlocks
'''
if issubclass(block.__class__, AdvancedTag):
return self.removeChild(block)
else:
return self.removeText(block) | removeBlock - Removes a single block (text node or AdvancedTag) which is a child of this object.
@param block <str/AdvancedTag> - The block (text node or AdvancedTag) to remove.
@return Returns the removed block if one was removed, or None if requested block is not a child of this node.
NOTE: If you know you are going to remove an AdvancedTag, @see removeChild
If you know you are going to remove a text node, @see removeText
If removing multiple blocks, @see removeBlocks | entailment |
def insertBefore(self, child, beforeChild):
'''
insertBefore - Inserts a child before #beforeChild
@param child <AdvancedTag/str> - Child block to insert
@param beforeChild <AdvancedTag/str> - Child block to insert before. if None, will be appended
@return - The added child. Note, if it is a text block (str), the return isl NOT be linked by reference.
@raises ValueError - If #beforeChild is defined and is not a child of this node
'''
# When the second arg is null/None, the node is appended. The argument is required per JS API, but null is acceptable..
if beforeChild is None:
return self.appendBlock(child)
# If #child is an AdvancedTag, we need to add it to both blocks and children.
isChildTag = isTagNode(child)
myBlocks = self.blocks
myChildren = self.children
# Find the index #beforeChild falls under current element
try:
blocksIdx = myBlocks.index(beforeChild)
if isChildTag:
childrenIdx = myChildren.index(beforeChild)
except ValueError:
# #beforeChild is not a child of this element. Raise error.
raise ValueError('Provided "beforeChild" is not a child of element, cannot insert.')
# Add to blocks in the right spot
self.blocks = myBlocks[:blocksIdx] + [child] + myBlocks[blocksIdx:]
# Add to child in the right spot
if isChildTag:
self.children = myChildren[:childrenIdx] + [child] + myChildren[childrenIdx:]
return child | insertBefore - Inserts a child before #beforeChild
@param child <AdvancedTag/str> - Child block to insert
@param beforeChild <AdvancedTag/str> - Child block to insert before. if None, will be appended
@return - The added child. Note, if it is a text block (str), the return isl NOT be linked by reference.
@raises ValueError - If #beforeChild is defined and is not a child of this node | entailment |
def insertAfter(self, child, afterChild):
'''
insertAfter - Inserts a child after #afterChild
@param child <AdvancedTag/str> - Child block to insert
@param afterChild <AdvancedTag/str> - Child block to insert after. if None, will be appended
@return - The added child. Note, if it is a text block (str), the return isl NOT be linked by reference.
'''
# If after child is null/None, just append
if afterChild is None:
return self.appendBlock(child)
isChildTag = isTagNode(child)
myBlocks = self.blocks
myChildren = self.children
# Determine where we need to insert this both in "blocks" and, if a tag, "children"
try:
blocksIdx = myBlocks.index(afterChild)
if isChildTag:
childrenIdx = myChildren.index(afterChild)
except ValueError:
raise ValueError('Provided "afterChild" is not a child of element, cannot insert.')
# Append child to requested spot
self.blocks = myBlocks[:blocksIdx+1] + [child] + myBlocks[blocksIdx+1:]
if isChildTag:
self.children = myChildren[:childrenIdx+1] + [child] + myChildren[childrenIdx+1:]
return child | insertAfter - Inserts a child after #afterChild
@param child <AdvancedTag/str> - Child block to insert
@param afterChild <AdvancedTag/str> - Child block to insert after. if None, will be appended
@return - The added child. Note, if it is a text block (str), the return isl NOT be linked by reference. | entailment |
def firstChild(self):
'''
firstChild - property, Get the first child block, text or tag.
@return <str/AdvancedTag/None> - The first child block, or None if no child blocks
'''
blocks = object.__getattribute__(self, 'blocks')
# First block is empty string for indent, but don't hardcode incase that changes
if blocks[0] == '':
firstIdx = 1
else:
firstIdx = 0
if len(blocks) == firstIdx:
# No first child
return None
return blocks[1] | firstChild - property, Get the first child block, text or tag.
@return <str/AdvancedTag/None> - The first child block, or None if no child blocks | entailment |
def lastChild(self):
'''
lastChild - property, Get the last child block, text or tag
@return <str/AdvancedTag/None> - The last child block, or None if no child blocks
'''
blocks = object.__getattribute__(self, 'blocks')
# First block is empty string for indent, but don't hardcode incase that changes
if blocks[0] == '':
firstIdx = 1
else:
firstIdx = 0
if len(blocks) <= firstIdx:
return None
return blocks[-1] | lastChild - property, Get the last child block, text or tag
@return <str/AdvancedTag/None> - The last child block, or None if no child blocks | entailment |
def nextSibling(self):
'''
nextSibling - Returns the next sibling. This is the child following this node in the parent's list of children.
This could be text or an element. use nextSiblingElement to ensure element
@return <None/str/AdvancedTag> - None if there are no nodes (text or tag) in the parent after this node,
Otherwise the following node (text or tag)
'''
parentNode = self.parentNode
# If no parent, no siblings.
if not parentNode:
return None
# Determine index in blocks
myBlockIdx = parentNode.blocks.index(self)
# If we are the last, no next sibling
if myBlockIdx == len(parentNode.blocks) - 1:
return None
# Else, return the next block in parent
return parentNode.blocks[ myBlockIdx + 1 ] | nextSibling - Returns the next sibling. This is the child following this node in the parent's list of children.
This could be text or an element. use nextSiblingElement to ensure element
@return <None/str/AdvancedTag> - None if there are no nodes (text or tag) in the parent after this node,
Otherwise the following node (text or tag) | entailment |
def nextElementSibling(self):
'''
nextElementSibling - Returns the next sibling that is an element.
This is the tag node following this node in the parent's list of children
@return <None/AdvancedTag> - None if there are no children (tag) in the parent after this node,
Otherwise the following element (tag)
'''
parentNode = self.parentNode
# If no parent, no siblings
if not parentNode:
return None
# Determine the index in children
myElementIdx = parentNode.children.index(self)
# If we are last child, no next sibling
if myElementIdx == len(parentNode.children) - 1:
return None
# Else, return the next child in parent
return parentNode.children[myElementIdx+1] | nextElementSibling - Returns the next sibling that is an element.
This is the tag node following this node in the parent's list of children
@return <None/AdvancedTag> - None if there are no children (tag) in the parent after this node,
Otherwise the following element (tag) | entailment |
def previousSibling(self):
'''
previousSibling - Returns the previous sibling. This would be the previous node (text or tag) in the parent's list
This could be text or an element. use previousSiblingElement to ensure element
@return <None/str/AdvancedTag> - None if there are no nodes (text or tag) in the parent before this node,
Otherwise the previous node (text or tag)
'''
parentNode = self.parentNode
# If no parent, no previous sibling
if not parentNode:
return None
# Determine block index on parent of this node
myBlockIdx = parentNode.blocks.index(self)
# If we are the first, no previous sibling
if myBlockIdx == 0:
return None
# Else, return the previous block in parent
return parentNode.blocks[myBlockIdx-1] | previousSibling - Returns the previous sibling. This would be the previous node (text or tag) in the parent's list
This could be text or an element. use previousSiblingElement to ensure element
@return <None/str/AdvancedTag> - None if there are no nodes (text or tag) in the parent before this node,
Otherwise the previous node (text or tag) | entailment |
def previousElementSibling(self):
'''
previousElementSibling - Returns the previous sibling that is an element.
This is the previous tag node in the parent's list of children
@return <None/AdvancedTag> - None if there are no children (tag) in the parent before this node,
Otherwise the previous element (tag)
'''
parentNode = self.parentNode
# If no parent, no siblings
if not parentNode:
return None
# Determine this node's index in the children of parent
myElementIdx = parentNode.children.index(self)
# If we are the first child, no previous element
if myElementIdx == 0:
return None
# Else, return previous element tag
return parentNode.children[myElementIdx-1] | previousElementSibling - Returns the previous sibling that is an element.
This is the previous tag node in the parent's list of children
@return <None/AdvancedTag> - None if there are no children (tag) in the parent before this node,
Otherwise the previous element (tag) | entailment |
def tagBlocks(self):
'''
tagBlocks - Property.
Returns all the blocks which are direct children of this node, where that block is a tag (not text)
NOTE: This is similar to .children , and you should probably use .children instead except within this class itself
@return list<AdvancedTag> - A list of direct children which are tags.
'''
myBlocks = self.blocks
return [block for block in myBlocks if issubclass(block.__class__, AdvancedTag)] | tagBlocks - Property.
Returns all the blocks which are direct children of this node, where that block is a tag (not text)
NOTE: This is similar to .children , and you should probably use .children instead except within this class itself
@return list<AdvancedTag> - A list of direct children which are tags. | entailment |
def getBlocksTags(self):
'''
getBlocksTags - Returns a list of tuples referencing the blocks which are direct children of this node, and the block is an AdvancedTag.
The tuples are ( block, blockIdx ) where "blockIdx" is the index of self.blocks wherein the tag resides.
@return list< tuple(block, blockIdx) > - A list of tuples of child blocks which are tags and their index in the self.blocks list
'''
myBlocks = self.blocks
return [ (myBlocks[i], i) for i in range( len(myBlocks) ) if issubclass(myBlocks[i].__class__, AdvancedTag) ] | getBlocksTags - Returns a list of tuples referencing the blocks which are direct children of this node, and the block is an AdvancedTag.
The tuples are ( block, blockIdx ) where "blockIdx" is the index of self.blocks wherein the tag resides.
@return list< tuple(block, blockIdx) > - A list of tuples of child blocks which are tags and their index in the self.blocks list | entailment |
def textBlocks(self):
'''
textBlocks - Property.
Returns all the blocks which are direct children of this node, where that block is a text (not a tag)
@return list<AdvancedTag> - A list of direct children which are text.
'''
myBlocks = self.blocks
return [block for block in myBlocks if not issubclass(block.__class__, AdvancedTag)] | textBlocks - Property.
Returns all the blocks which are direct children of this node, where that block is a text (not a tag)
@return list<AdvancedTag> - A list of direct children which are text. | entailment |
def textContent(self):
'''
textContent - property, gets the text of this node and all inner nodes.
Use .innerText for just this node's text
@return <str> - The text of all nodes at this level or lower
'''
def _collateText(curNode):
'''
_collateText - Recursive function to gather the "text" of all blocks
in the order that they appear
@param curNode <AdvancedTag> - The current AdvancedTag to process
@return list<str> - A list of strings in order. Join using '' to obtain text
as it would appear
'''
curStrLst = []
blocks = object.__getattribute__(curNode, 'blocks')
for block in blocks:
if isTagNode(block):
curStrLst += _collateText(block)
else:
curStrLst.append(block)
return curStrLst
return ''.join(_collateText(self)) | textContent - property, gets the text of this node and all inner nodes.
Use .innerText for just this node's text
@return <str> - The text of all nodes at this level or lower | entailment |
def containsUid(self, uid):
'''
containsUid - Check if the uid (unique internal ID) appears anywhere as a direct child to this node, or the node itself.
@param uid <uuid.UUID> - uuid to check
@return <bool> - True if #uid is this node's uid, or is the uid of any children at any level down
'''
# Check if this node is the match
if self.uid == uid:
return True
# Scan all children
for child in self.children:
if child.containsUid(uid):
return True
return False | containsUid - Check if the uid (unique internal ID) appears anywhere as a direct child to this node, or the node itself.
@param uid <uuid.UUID> - uuid to check
@return <bool> - True if #uid is this node's uid, or is the uid of any children at any level down | entailment |
def getAllChildNodes(self):
'''
getAllChildNodes - Gets all the children, and their children,
and their children, and so on, all the way to the end as a TagCollection.
Use .childNodes for a regular list
@return TagCollection<AdvancedTag> - A TagCollection of all children (and their children recursive)
'''
ret = TagCollection()
# Scan all the children of this node
for child in self.children:
# Append each child
ret.append(child)
# Append children's children recursive
ret += child.getAllChildNodes()
return ret | getAllChildNodes - Gets all the children, and their children,
and their children, and so on, all the way to the end as a TagCollection.
Use .childNodes for a regular list
@return TagCollection<AdvancedTag> - A TagCollection of all children (and their children recursive) | entailment |
def getAllChildNodeUids(self):
'''
getAllChildNodeUids - Returns all the unique internal IDs for all children, and there children,
so on and so forth until the end.
For performing "contains node" kind of logic, this is more efficent than copying the entire nodeset
@return set<uuid.UUID> A set of uuid objects
'''
ret = set()
# Iterate through all children
for child in self.children:
# Add child's uid
ret.add(child.uid)
# Add child's children's uid and their children, recursive
ret.update(child.getAllChildNodeUids())
return ret | getAllChildNodeUids - Returns all the unique internal IDs for all children, and there children,
so on and so forth until the end.
For performing "contains node" kind of logic, this is more efficent than copying the entire nodeset
@return set<uuid.UUID> A set of uuid objects | entailment |
def getAllNodeUids(self):
'''
getAllNodeUids - Returns all the unique internal IDs from getAllChildNodeUids, but also includes this tag's uid
@return set<uuid.UUID> A set of uuid objects
'''
# Start with a set including this tag's uuid
ret = { self.uid }
ret.update(self.getAllChildNodeUids())
return ret | getAllNodeUids - Returns all the unique internal IDs from getAllChildNodeUids, but also includes this tag's uid
@return set<uuid.UUID> A set of uuid objects | entailment |
def getPeers(self):
'''
getPeers - Get elements who share a parent with this element
@return - TagCollection of elements
'''
parentNode = self.parentNode
# If no parent, no peers
if not parentNode:
return None
peers = parentNode.children
# Otherwise, get all children of parent excluding this node
return TagCollection([peer for peer in peers if peer is not self]) | getPeers - Get elements who share a parent with this element
@return - TagCollection of elements | entailment |
def getStartTag(self):
'''
getStartTag - Returns the start tag represented as HTML
@return - String of start tag with attributes
'''
attributeStrings = []
# Get all attributes as a tuple (name<str>, value<str>)
for name, val in self._attributes.items():
# Get all attributes
if val:
val = tostr(val)
# Only binary attributes have a "present/not present"
if val or name not in TAG_ITEM_BINARY_ATTRIBUTES:
# Escape any quotes found in the value
val = escapeQuotes(val)
# Add a name="value" to the resulting string
attributeStrings.append('%s="%s"' %(name, val) )
else:
# This is a binary attribute, and thus only includes the name ( e.x. checked )
attributeStrings.append(name)
# Join together all the attributes in @attributeStrings list into a string
if attributeStrings:
attributeString = ' ' + ' '.join(attributeStrings)
else:
attributeString = ''
# If this is a self-closing tag, generate like <tag attr1="val" attr2="val2" /> with the close "/>"
# Include the indent prior to tag opening
if self.isSelfClosing is False:
return "%s<%s%s >" %(self._indent, self.tagName, attributeString)
else:
return "%s<%s%s />" %(self._indent, self.tagName, attributeString) | getStartTag - Returns the start tag represented as HTML
@return - String of start tag with attributes | entailment |
def getEndTag(self):
'''
getEndTag - returns the end tag representation as HTML string
@return - String of end tag
'''
# If this is a self-closing tag, we have no end tag (opens and closes in the start)
if self.isSelfClosing is True:
return ''
tagName = self.tagName
# Do not add any indentation to the end of preformatted tags.
if self._indent and tagName in PREFORMATTED_TAGS:
return "</%s>" %(tagName, )
# Otherwise, indent the end of this tag
return "%s</%s>" %(self._indent, tagName) | getEndTag - returns the end tag representation as HTML string
@return - String of end tag | entailment |
def innerHTML(self):
'''
innerHTML - Returns an HTML string of the inner contents of this tag, including children.
@return - String of inner contents HTML
'''
# If a self-closing tag, there are no contents
if self.isSelfClosing is True:
return ''
# Assemble all the blocks.
ret = []
# Iterate through blocks
for block in self.blocks:
# For each block:
# If a tag, append the outer html (start tag, contents, and end tag)
# Else, append the text node directly
if isinstance(block, AdvancedTag):
ret.append(block.outerHTML)
else:
ret.append(block)
return ''.join(ret) | innerHTML - Returns an HTML string of the inner contents of this tag, including children.
@return - String of inner contents HTML | entailment |
def getAttribute(self, attrName, defaultValue=None):
'''
getAttribute - Gets an attribute on this tag. Be wary using this for classname, maybe use addClass/removeClass. Attribute names are all lowercase.
@return - The attribute value, or None if none exists.
'''
if attrName in TAG_ITEM_BINARY_ATTRIBUTES:
if attrName in self._attributes:
attrVal = self._attributes[attrName]
if not attrVal:
return True # Empty valued binary attribute
return attrVal # optionally-valued binary attribute
else:
return False
else:
return self._attributes.get(attrName, defaultValue) | getAttribute - Gets an attribute on this tag. Be wary using this for classname, maybe use addClass/removeClass. Attribute names are all lowercase.
@return - The attribute value, or None if none exists. | entailment |
def getAttributesList(self):
'''
getAttributesList - Get a copy of all attributes as a list of tuples (name, value)
ALL values are converted to string and copied, so modifications will not affect the original attributes.
If you want types like "style" to work as before, you'll need to recreate those elements (like StyleAttribute(strValue) ).
@return list< tuple< str(name), str(value) > > - A list of tuples of attrName, attrValue pairs, all converted to strings.
This is suitable for passing back into AdvancedTag when creating a new tag.
'''
return [ (tostr(name)[:], tostr(value)[:]) for name, value in self._attributes.items() ] | getAttributesList - Get a copy of all attributes as a list of tuples (name, value)
ALL values are converted to string and copied, so modifications will not affect the original attributes.
If you want types like "style" to work as before, you'll need to recreate those elements (like StyleAttribute(strValue) ).
@return list< tuple< str(name), str(value) > > - A list of tuples of attrName, attrValue pairs, all converted to strings.
This is suitable for passing back into AdvancedTag when creating a new tag. | entailment |
def getAttributesDict(self):
'''
getAttributesDict - Get a copy of all attributes as a dict map of name -> value
ALL values are converted to string and copied, so modifications will not affect the original attributes.
If you want types like "style" to work as before, you'll need to recreate those elements (like StyleAttribute(strValue) ).
@return <dict ( str(name), str(value) )> - A dict of attrName to attrValue , all as strings and copies.
'''
return { tostr(name)[:] : tostr(value)[:] for name, value in self._attributes.items() } | getAttributesDict - Get a copy of all attributes as a dict map of name -> value
ALL values are converted to string and copied, so modifications will not affect the original attributes.
If you want types like "style" to work as before, you'll need to recreate those elements (like StyleAttribute(strValue) ).
@return <dict ( str(name), str(value) )> - A dict of attrName to attrValue , all as strings and copies. | entailment |
def hasAttribute(self, attrName):
'''
hasAttribute - Checks for the existance of an attribute. Attribute names are all lowercase.
@param attrName <str> - The attribute name
@return <bool> - True or False if attribute exists by that name
'''
attrName = attrName.lower()
# Check if requested attribute is present on this node
return bool(attrName in self._attributes) | hasAttribute - Checks for the existance of an attribute. Attribute names are all lowercase.
@param attrName <str> - The attribute name
@return <bool> - True or False if attribute exists by that name | entailment |
def removeAttribute(self, attrName):
'''
removeAttribute - Removes an attribute, by name.
@param attrName <str> - The attribute name
'''
attrName = attrName.lower()
# Delete provided attribute name ( #attrName ) from attributes map
try:
del self._attributes[attrName]
except KeyError:
pass | removeAttribute - Removes an attribute, by name.
@param attrName <str> - The attribute name | entailment |
def addClass(self, className):
'''
addClass - append a class name to the end of the "class" attribute, if not present
@param className <str> - The name of the class to add
'''
className = stripWordsOnly(className)
if not className:
return None
if ' ' in className:
# Multiple class names passed, do one at a time
for oneClassName in className.split(' '):
self.addClass(oneClassName)
return
myClassNames = self._classNames
# Do not allow duplicates
if className in myClassNames:
return
# Regenerate "classNames" and "class" attr.
# TODO: Maybe those should be properties?
myClassNames.append(className)
return None | addClass - append a class name to the end of the "class" attribute, if not present
@param className <str> - The name of the class to add | entailment |
def removeClass(self, className):
'''
removeClass - remove a class name if present. Returns the class name if removed, otherwise None.
@param className <str> - The name of the class to remove
@return <str> - The class name removed if one was removed, otherwise None if #className wasn't present
'''
className = stripWordsOnly(className)
if not className:
return None
if ' ' in className:
# Multiple class names passed, do one at a time
for oneClassName in className.split(' '):
self.removeClass(oneClassName)
return
myClassNames = self._classNames
# If not present, this is a no-op
if className not in myClassNames:
return None
myClassNames.remove(className)
return className | removeClass - remove a class name if present. Returns the class name if removed, otherwise None.
@param className <str> - The name of the class to remove
@return <str> - The class name removed if one was removed, otherwise None if #className wasn't present | entailment |
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()
styles = styleStr.split(';') # Won't work for strings containing semicolon..
styleDict = OrderedDict()
for item in styles:
try:
splitIdx = item.index(':')
name = item[:splitIdx].strip().lower()
value = item[splitIdx+1:].strip()
styleDict[name] = value
except:
continue
return styleDict | getStyleDict - Gets a dictionary of style attribute/value pairs.
@return - OrderedDict of "style" attribute. | entailment |
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)
To remove a style, set its value to empty string.
When all styles are removed, the "style" attribute will be nullified.
@param styleName - The name of the style element
@param styleValue - The value of which to assign the style element
@return - String of current value of "style" after change is made.
'''
myAttributes = self._attributes
if 'style' not in myAttributes:
myAttributes['style'] = "%s: %s" %(styleName, styleValue)
else:
setattr(myAttributes['style'], 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)
To remove a style, set its value to empty string.
When all styles are removed, the "style" attribute will be nullified.
@param styleName - The name of the style element
@param styleValue - The value of which to assign the style element
@return - String of current value of "style" after change is made. | entailment |
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 removed, the "style" attribute will be nullified.
@param styleUpdatesDict - Dictionary of attribute : value styles.
@return - String of current value of "style" after change is made.
'''
setStyleMethod = self.setStyle
for newName, newValue in styleUpdatesDict.items():
setStyleMethod(newName, newValue)
return self.style | 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 removed, the "style" attribute will be nullified.
@param styleUpdatesDict - Dictionary of attribute : value styles.
@return - String of current value of "style" after change is made. | entailment |
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:
return child
found = child.getElementById(_id)
if found is not None:
return found
return None | getElementById - Search children of this tag for a tag containing an id
@param _id - String of id
@return - AdvancedTag or None | entailment |
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 elements
'''
elements = []
for child in self.children:
if child.getAttribute(attrName) == attrValue:
elements.append(child)
elements += child.getElementsByAttr(attrName, attrValue)
return TagCollection(elements) | 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 elements | entailment |
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 self.children:
if child.hasClass(className) is True:
elements.append(child)
elements += child.getElementsByClassName(className)
return TagCollection(elements) | getElementsByClassName - Search children of this tag for tags containing a given class name
@param className - Class name
@return - TagCollection of matching elements | entailment |
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 acceptable attribute values
@return - TagCollection of matching elements
'''
elements = []
for child in self.children:
if child.getAttribute(attrName) in attrValues:
elements.append(child)
elements += child.getElementsWithAttrValues(attrName, attrValues)
return TagCollection(elements) | 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 acceptable attribute values
@return - TagCollection of matching elements | entailment |
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.
@return - TagCollection of matching results
@see getFirstElementCustomFilter
'''
elements = []
for child in self.children:
if filterFunc(child) is True:
elements.append(child)
elements += child.getElementsCustomFilter(filterFunc)
return TagCollection(elements) | 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.
@return - TagCollection of matching results
@see getFirstElementCustomFilter | entailment |
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> - A function or lambda expression that should return "True" if the passed node matches criteria.
@return <AdvancedTag/None> - First match, or None
@see getElementsCustomFilter
'''
for child in self.children:
if filterFunc(child) is True:
return child
childSearchResult = child.getFirstElementCustomFilter(filterFunc)
if childSearchResult is not None:
return childSearchResult
return None | 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> - A function or lambda expression that should return "True" if the passed node matches criteria.
@return <AdvancedTag/None> - First match, or None
@see getElementsCustomFilter | entailment |
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 function or lambda expression that should return "True" if the passed node matches criteria.
@return <AdvancedTag/None> - First match, or None
@see getFirstElementCustomFilter for matches against children
'''
parentNode = self.parentNode
while parentNode:
if filterFunc(parentNode) is True:
return parentNode
parentNode = parentNode.parentNode
return None | getParentElementCustomFilter - Runs through parent on up to document root, returning the
first tag which filterFunc(tag) returns True.
@param filterFunc <function/lambda> - A function or lambda expression that should return "True" if the passed node matches criteria.
@return <AdvancedTag/None> - First match, or None
@see getFirstElementCustomFilter for matches against children | entailment |
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 False.
@return <TagCollection> - Resulting peers, or None if no parent node.
'''
peers = self.peers
if peers is None:
return None
return TagCollection([peer for peer in peers if filterFunc(peer) is True]) | 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 False.
@return <TagCollection> - Resulting peers, or None if no parent node. | entailment |
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 (error condition), otherwise a TagCollection of peers that matched.
'''
peers = self.peers
if peers is None:
return None
return TagCollection([peer for peer in peers if peer.getAttribute(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 (error condition), otherwise a TagCollection of peers that matched. | entailment |
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 - List of possible values which will match
@return - None if no parent element (error condition), otherwise a TagCollection of peers that matched.
'''
peers = self.peers
if peers is None:
return None
return TagCollection([peer for peer in peers if peer.getAttribute(attrName) in 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 - List of possible values which will match
@return - None if no parent element (error condition), otherwise a TagCollection of peers that matched. | entailment |
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.peers
if peers is None:
return None
return TagCollection([peer for peer in peers if peer.name == 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. | entailment |
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 matched.
'''
peers = self.peers
if peers is None:
return None
return TagCollection([peer for peer in peers if peer.hasClass(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 matched. | entailment |
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 tag in the html (use regular == operator for that)
So for example:
tag1 = document.getElementById('something')
tag2 = copy.copy(tag1)
tag1 == tag2 # This is False
tag1.isTagEqual(tag2) # This is True
@return bool - True if tags have the same name and attributes, otherwise False
'''
# if type(other) != type(self):
# return False
# NOTE: Instead of type check,
# just see if we can get the needed attributes in case subclassing
try:
if self.tagName != other.tagName:
return False
myAttributes = self._attributes
otherAttributes = other._attributes
attributeKeysSelf = list(myAttributes.keys())
attributeKeysOther = list(otherAttributes.keys())
except:
return False
# Check that we have all the same attribute names
if set(attributeKeysSelf) != set(attributeKeysOther):
return False
for key in attributeKeysSelf:
if myAttributes.get(key) != otherAttributes.get(key):
return False
return True | 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 tag in the html (use regular == operator for that)
So for example:
tag1 = document.getElementById('something')
tag2 = copy.copy(tag1)
tag1 == tag2 # This is False
tag1.isTagEqual(tag2) # This is True
@return bool - True if tags have the same name and attributes, otherwise False | entailment |
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) | append - Append an item to this tag collection
@param tag - an AdvancedTag | entailment |
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) | remove - Remove an item from this tag collection
@param toRemove - an AdvancedTag | entailment |
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
@return TagCollection<AdvancedTag>
'''
ret = TagCollection()
if len(self) == 0:
return ret
for tag in self:
if filterFunc(tag) is True:
ret.append(tag)
return ret | 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
@return TagCollection<AdvancedTag> | entailment |
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
'''
ret = TagCollection()
if len(self) == 0:
return ret
tagName = tagName.lower()
_cmpFunc = lambda tag : bool(tag.tagName == tagName)
for tag in self:
TagCollection._subset(ret, _cmpFunc, tag)
return ret | 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 | entailment |
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 = TagCollection()
if len(self) == 0:
return ret
_cmpFunc = lambda tag : bool(tag.name == name)
for tag in self:
TagCollection._subset(ret, _cmpFunc, tag)
return ret | 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" | entailment |
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 class name
'''
ret = TagCollection()
if len(self) == 0:
return ret
_cmpFunc = lambda tag : tag.hasClass(className)
for tag in self:
TagCollection._subset(ret, _cmpFunc, tag)
return ret | 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 class name | entailment |
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:
return tag
for subtag in tag.children:
tmp = subtag.getElementById(_id)
if tmp is not None:
return tmp
return None | 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 | entailment |
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 name/value
'''
ret = TagCollection()
if len(self) == 0:
return ret
attr = attr.lower()
_cmpFunc = lambda tag : tag.getAttribute(attr) == value
for tag in self:
TagCollection._subset(ret, _cmpFunc, tag)
return ret | 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 name/value | entailment |
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 matching values
@return - TagCollection of all elements matching criteria
'''
ret = TagCollection()
if len(self) == 0:
return ret
if type(values) != set:
values = set(values)
attr = attr.lower()
_cmpFunc = lambda tag : tag.getAttribute(attr) in values
for tag in self:
TagCollection._subset(ret, _cmpFunc, tag)
return ret | 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 matching values
@return - TagCollection of all elements matching criteria | entailment |
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 elements that matched criteria
'''
ret = TagCollection()
if len(self) == 0:
return ret
_cmpFunc = lambda tag : filterFunc(tag) is True
for tag in self:
TagCollection._subset(ret, _cmpFunc, tag)
return ret | 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 elements that matched criteria | entailment |
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 | getAllNodes - Gets all the nodes, and all their children for every node within this collection | entailment |
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 | getAllNodeUids - Gets all the internal uids of all nodes, their children, and all their children so on..
@return set<uuid.UUID> | entailment |
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.
@param em <AdvancedTag> - Element of interest
@return <bool> - True if contained, otherwise False
'''
for node in self:
if node.contains(em):
return True
return False | 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.
@param em <AdvancedTag> - Element of interest
@return <bool> - True if contained, otherwise False | entailment |
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 <bool> - True if contained, otherwise False
'''
for node in self:
if node.containsUid(uid):
return True
return False | 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 <bool> - True if contained, otherwise False | entailment |
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 "filterAnd" on a TagCollection
For special filter keys, @see #AdvancedHTMLParser.AdvancedHTMLParser.filter
Requires the QueryableList module to be installed (i.e. AdvancedHTMLParser was installed
without '--no-deps' flag.)
For alternative without QueryableList,
consider #AdvancedHTMLParser.AdvancedHTMLParser.find method or the getElement* methods
@return TagCollection<AdvancedTag>
'''
if canFilterTags is False:
raise NotImplementedError('filter methods requires QueryableList installed, it is not. Either install QueryableList, or try the less-robust "find" method, or the getElement* methods.')
allNodes = self.getAllNodes()
filterableNodes = FilterableTagCollection(allNodes)
return filterableNodes.filterAnd(**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 "filterAnd" on a TagCollection
For special filter keys, @see #AdvancedHTMLParser.AdvancedHTMLParser.filter
Requires the QueryableList module to be installed (i.e. AdvancedHTMLParser was installed
without '--no-deps' flag.)
For alternative without QueryableList,
consider #AdvancedHTMLParser.AdvancedHTMLParser.find method or the getElement* methods
@return TagCollection<AdvancedTag> | entailment |
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 TagCollection
For special filter keys, @see #AdvancedHTMLParser.AdvancedHTMLParser.filter
Requires the QueryableList module to be installed (i.e. AdvancedHTMLParser was installed
without '--no-deps' flag.)
For alternative without QueryableList,
consider #AdvancedHTMLParser.AdvancedHTMLParser.find method or the getElement* methods
@return TagCollection<AdvancedTag>
'''
if canFilterTags is False:
raise NotImplementedError('filter methods requires QueryableList installed, it is not. Either install QueryableList, or try the less-robust "find" method, or the getElement* methods.')
allNodes = self.getAllNodes()
filterableNodes = FilterableTagCollection(allNodes)
return filterableNodes.filterOr(**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 TagCollection
For special filter keys, @see #AdvancedHTMLParser.AdvancedHTMLParser.filter
Requires the QueryableList module to be installed (i.e. AdvancedHTMLParser was installed
without '--no-deps' flag.)
For alternative without QueryableList,
consider #AdvancedHTMLParser.AdvancedHTMLParser.find method or the getElement* methods
@return TagCollection<AdvancedTag> | entailment |
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
newTag = AdvancedTag(tagName, attributeList, isSelfClosing)
if self.root is None:
self.root = newTag
elif len(inTag) > 0:
inTag[-1].appendChild(newTag)
else:
raise MultipleRootNodeException()
if self.inPreformatted is 0:
newTag._indent = self._getIndent()
if tagName in PREFORMATTED_TAGS:
self.inPreformatted += 1
if isSelfClosing is False:
inTag.append(newTag)
if tagName != INVISIBLE_ROOT_TAG:
self.currentIndentLevel += 1 | handle_starttag - Internal for parsing | entailment |
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].tagName == tagName:
foundIt = True
break
if not foundIt:
sys.stderr.write('WARNING: found close tag with no matching start.\n')
return
while inTag[-1].tagName != tagName:
oldTag = inTag.pop()
if oldTag.tagName in PREFORMATTED_TAGS:
self.inPreformatted -= 1
self.currentIndentLevel -= 1
inTag.pop()
if tagName != INVISIBLE_ROOT_TAG:
self.currentIndentLevel -= 1
if tagName in PREFORMATTED_TAGS:
self.inPreformatted -= 1
except:
pass | handle_endtag - Internal for parsing | entailment |
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')
if data.startswith(' '):
data = ' ' + data.lstrip()
if data.endswith(' '):
data = data.rstrip() + ' '
inTag[-1].appendText(data)
elif data.strip():
# Must be text prior to or after root node
raise MultipleRootNodeException() | handle_data - Internal for parsing | entailment |
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.__getattribute__(self, 'slimSelfClosing') and ret.endswith(' />'):
ret = ret[:-3] + '/>'
return ret | getStartTag - Override the end-spacing rules
@see AdvancedTag.getStartTag | entailment |
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.
'''
allMatches = IE_CONDITIONAL_PATTERN.findall(contents)
if not allMatches:
return contents
for match in allMatches:
contents = contents.replace(match, '')
if END_HTML.match(contents) and not START_HTML.match(contents):
contents = addStartTag(contents, '<html>')
return contents | 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. | entailment |
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:
idx = matchObj.end()
else:
idx = 0
return "%s\n%s\n%s" %(contents[:idx], startTag, contents[idx:]) | 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> | entailment |
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 >= 0:
if inTag[i].tagName == tagName:
foundIt = True
break
i -= 1
if not foundIt:
# Attempted to close, but did not match anything
raise InvalidCloseException(tagName, inTag)
if inTag[-1].tagName != tagName:
raise MissedCloseException(tagName, [x for x in inTag[-1 * (i+1): ] ] )
inTag.pop() | Internal for parsing | entailment |
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 "spellcheck") to a string of 'false',
# it gets set to true. But we will retain "false" here.
if val in ('false', '0'):
return 'false'
else:
return 'true'
try:
if bool(val):
return "true"
except:
pass
return "false" | convertToBooleanString - Converts a value to either a string of "true" or "false"
@param val <int/str/bool> - Value | entailment |
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
return True | convertBooleanStringToBoolean - Convert from a boolean attribute (string "true" / "false" ) into a booelan | entailment |
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:
return invalidDefault
return val | convertToPositiveInt - Convert to a positive integer, and if invalid use a given value | entailment |
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 #possibleValues
If instantiated Exception (like ValueError('blah')): Raise this exception
If an Exception type ( like ValueError ) - Instantiate and raise this exception type
Otherwise, use this raw value
'''
# If not
# If an instantiated Exception, raise that exception
try:
isInstantiatedException = bool( issubclass(invalidDefault.__class__, Exception) )
except:
isInstantiatedException = False
if isInstantiatedException:
raise invalidDefault
else:
try:
isExceptionType = bool( issubclass( invalidDefault, Exception) )
except TypeError:
isExceptionType = False
# If an Exception type, instantiate and raise
if isExceptionType:
raise invalidDefault()
else:
# Otherwise, just return invalidDefault itself
return 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 #possibleValues
If instantiated Exception (like ValueError('blah')): Raise this exception
If an Exception type ( like ValueError ) - Instantiate and raise this exception type
Otherwise, use this raw value | entailment |
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
@param possibleValues list<str> - A list of possible values
@param invalidDefault <None/str/Exception> - The value to return if "val" is not empty string/None
and "val" is not in #possibleValues
If instantiated Exception (like ValueError('blah')): Raise this exception
If an Exception type ( like ValueError ) - Instantiate and raise this exception type
Otherwise, use this raw value
@param emptyValue Default '', used for an empty value (empty string or None)
'''
from .utils import tostr
# If null, retain null
if val is None:
if emptyValue is EMPTY_IS_INVALID:
return _handleInvalid(invalidDefault)
return emptyValue
# Convert to a string
val = tostr(val).lower()
# If empty string, same as null
if val == '':
if emptyValue is EMPTY_IS_INVALID:
return _handleInvalid(invalidDefault)
return emptyValue
# Check if this is a valid value
if val not in possibleValues:
return _handleInvalid(invalidDefault)
return val | convertPossibleValues - Convert input value to one of several possible values,
with a default for invalid entries
@param val <None/str> - The input value
@param possibleValues list<str> - A list of possible values
@param invalidDefault <None/str/Exception> - The value to return if "val" is not empty string/None
and "val" is not in #possibleValues
If instantiated Exception (like ValueError('blah')): Raise this exception
If an Exception type ( like ValueError ) - Instantiate and raise this exception type
Otherwise, use this raw value
@param emptyValue Default '', used for an empty value (empty string or None) | entailment |
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), or None if no minimum
@param maxValue <None/int> - The maximum value (inclusive), or None if no maximum
@param invalidDefault <None/str/Exception> - The value to return if "val" is not empty string/None
and "val" is not in #possibleValues
If instantiated Exception (like ValueError('blah')): Raise this exception
If an Exception type ( like ValueError ) - Instantiate and raise this exception type
Otherwise, use this raw value
@param emptyValue Default '', used for an empty value (empty string or None)
'''
from .utils import tostr
# If null, retain null
if val is None or val == '':
if emptyValue is EMPTY_IS_INVALID:
return _handleInvalid(invalidDefault)
return emptyValue
try:
val = int(val)
except ValueError:
return _handleInvalid(invalidDefault)
if minValue is not None and val < minValue:
return _handleInvalid(invalidDefault)
if maxValue is not None and val > maxValue:
return _handleInvalid(invalidDefault)
return val | 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), or None if no minimum
@param maxValue <None/int> - The maximum value (inclusive), or None if no maximum
@param invalidDefault <None/str/Exception> - The value to return if "val" is not empty string/None
and "val" is not in #possibleValues
If instantiated Exception (like ValueError('blah')): Raise this exception
If an Exception type ( like ValueError ) - Instantiate and raise this exception type
Otherwise, use this raw value
@param emptyValue Default '', used for an empty value (empty string or None) | entailment |
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/None> - Either the AdvancedTag to associate, or None to clear current association
'''
if tag:
self._tagRef = weakref.ref(tag)
else:
self._tagRef = None | _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/None> - Either the AdvancedTag to associate, or None to clear current association | entailment |
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) > 0:
dict.__setitem__(self, "class", self.tag.className)
else:
try:
dict.__delitem__(self, "class")
except:
pass
styleAttr = self.tag.style
if styleAttr.isEmpty() is False:
dict.__setitem__(self, "style", styleAttr)
else:
try:
dict.__delitem__(self, "style")
except:
pass | _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. | entailment |
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 attribute at #key, or #default if not present.
'''
key = key.lower()
if key == 'class':
return self.tag.className
if key in ('style', 'class') or key in self.keys():
return self[key]
return default | 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 attribute at #key, or #default if not present. | entailment |
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 | _direct_set - INTERNAL USE ONLY!!!!
Directly sets a value on the underlying dict, without running through the setitem logic | entailment |
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 tag <AdvancedTag/None> - The new association. If None, the association is cleared, otherwise the passed tag
becomes associated with this style.
'''
if tag:
self._tagRef = weakref.ref(tag)
else:
self._tagRef = None | 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 tag <AdvancedTag/None> - The new association. If None, the association is cleared, otherwise the passed tag
becomes associated with this style. | entailment |
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 special linkage.
'''
tag = self.tag
if tag:
styleDict = self._styleDict
tagAttributes = tag._attributes
# If this is called before we have _attributes setup
if not issubclass(tagAttributes.__class__, SpecialAttributesDict):
return
# If we have any styles set, ensure we have the style="whatever" in the HTML representation,
# otherwise ensure we don't have style=""
if not styleDict:
tagAttributes._direct_del('style')
else: #if 'style' not in tagAttributes.keys():
tagAttributes._direct_set('style', 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 special linkage. | entailment |
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 expects the camel case names.
Example: name="font-weight" versus the dot-access style.fontWeight
@param value <str> - The style value, or empty string to remove property
'''
styleDict = self._styleDict
if value in ('', None):
try:
del styleDict[name]
except KeyError:
pass
else:
styleDict[name] = str(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 expects the camel case names.
Example: name="font-weight" versus the dot-access style.fontWeight
@param value <str> - The style value, or empty string to remove property | entailment |
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. kept for completeness.
@return <str> - The camel-case form
'''
nameParts = dashName.split('-')
for i in range(1, len(nameParts), 1):
nameParts[i][0] = nameParts[i][0].upper()
return ''.join(nameParts) | 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. kept for completeness.
@return <str> - The camel-case form | entailment |
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 = []
for ch in camelCaseList:
if ch.isupper():
ret.append('-')
ret.append(ch.lower())
else:
ret.append(ch)
return ''.join(ret) | 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 | entailment |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.