summaryrefslogtreecommitdiff
path: root/bs4/element.py
diff options
context:
space:
mode:
authorLeonard Richardson <leonardr@segfault.org>2019-12-24 09:59:42 -0500
committerLeonard Richardson <leonardr@segfault.org>2019-12-24 09:59:42 -0500
commit5952879a2458fdeb74673d3ccd61fd312c7d66df (patch)
treeabf4c1b06725b2a755b8121ff9fefc1b35619fce /bs4/element.py
parentb6c5db5c45cd38cd4df50f415d42f518fc821ca2 (diff)
Added docstrings to diagnose.py.
Diffstat (limited to 'bs4/element.py')
-rw-r--r--bs4/element.py17
1 files changed, 12 insertions, 5 deletions
diff --git a/bs4/element.py b/bs4/element.py
index bba3f7e..1d6ce3c 100644
--- a/bs4/element.py
+++ b/bs4/element.py
@@ -1784,8 +1784,9 @@ class Tag(PageElement):
def has_key(self, key):
"""Deprecated method. This was kind of misleading because has_key()
- (attributes) was different from __in__ (contents). has_key()
- is gone in Python 3, anyway.
+ (attributes) was different from __in__ (contents).
+
+ has_key() is gone in Python 3, anyway.
"""
warnings.warn('has_key is deprecated. Use has_attr("%s") instead.' % (
key))
@@ -1794,7 +1795,13 @@ class Tag(PageElement):
# Next, a couple classes to represent queries and their results.
class SoupStrainer(object):
"""Encapsulates a number of ways of matching a markup element (tag or
- text)."""
+ string).
+
+ This is primarily used to underpin the find_* methods, but you can
+ create one yourself and pass it in as `parse_only` to the
+ `BeautifulSoup` constructor, to parse a subset of a large
+ document.
+ """
def __init__(self, name=None, attrs={}, text=None, **kwargs):
"""Constructor.
@@ -1865,7 +1872,7 @@ class SoupStrainer(object):
return unicode(str(value))
def __str__(self):
- """A string representation of this SoupStrainer."""
+ """A human-readable representation of this SoupStrainer."""
if self.text:
return self.text
else:
@@ -2055,7 +2062,7 @@ class ResultSet(list):
self.source = source
def __getattr__(self, key):
- """Raise a helpful exception."""
+ """Raise a helpful exception to explain a common code fix."""
raise AttributeError(
"ResultSet object has no attribute '%s'. You're probably treating a list of elements like a single element. Did you call find_all() when you meant to call find()?" % key
)