freedak/Scrapling
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update doc strings with correct naming

Browse Source
This commit is contained in:
Karim shoair
2025-08-25 06:08:15 +03:00
parent 6ddabaa593
commit cf57af588e
3 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/contributing.md
+1 -1
View File
@@ -68,7 +68,7 @@ We use:
Example: Example:
``` ```
feat: add auto-matching for similar elements feat: add `adaptive` for similar elements
- Added find_similar() method - Added find_similar() method
- Implemented pattern matching - Implemented pattern matching
scrapling/parser.py
+17 -17
View File
@@ -103,9 +103,9 @@ class Selector(SelectorsGeneration):
Don't use it unless you know what you are doing! Don't use it unless you know what you are doing!
:param keep_comments: While parsing the HTML body, drop comments or not. Disabled by default for obvious reasons :param keep_comments: While parsing the HTML body, drop comments or not. Disabled by default for obvious reasons
:param keep_cdata: While parsing the HTML body, drop cdata or not. Disabled by default for cleaner HTML. :param keep_cdata: While parsing the HTML body, drop cdata or not. Disabled by default for cleaner HTML.
:param adaptive: Globally turn off the auto-match feature in all functions, this argument takes higher :param adaptive: Globally turn off the adaptive feature in all functions, this argument takes higher
priority over all auto-match related arguments/functions in the class. priority over all adaptive related arguments/functions in the class.
:param storage: The storage class to be passed for auto-matching functionalities, see ``Docs`` for more info. :param storage: The storage class to be passed for adaptive functionalities, see ``Docs`` for more info.
:param storage_args: A dictionary of ``argument->value`` pairs to be passed for the storage class. :param storage_args: A dictionary of ``argument->value`` pairs to be passed for the storage class.
If empty, default values will be used. If empty, default values will be used.
""" """
@@ -544,10 +544,10 @@ class Selector(SelectorsGeneration):
:param selector: The CSS3 selector to be used. :param selector: The CSS3 selector to be used.
:param adaptive: Enabled will make the function try to relocate the element if it was 'saved' before :param adaptive: Enabled will make the function try to relocate the element if it was 'saved' before
:param identifier: A string that will be used to save/retrieve element's data in auto-matching, :param identifier: A string that will be used to save/retrieve element's data in adaptive,
otherwise the selector will be used. otherwise the selector will be used.
:param auto_save: Automatically save new elements for `adaptive` later :param auto_save: Automatically save new elements for `adaptive` later
:param percentage: The minimum percentage to accept while auto-matching and not going lower than that. :param percentage: The minimum percentage to accept while `adaptive` is working and not going lower than that.
Be aware that the percentage calculation depends solely on the page structure, so don't play with this Be aware that the percentage calculation depends solely on the page structure, so don't play with this
number unless you must know what you are doing! number unless you must know what you are doing!
""" """
@@ -581,10 +581,10 @@ class Selector(SelectorsGeneration):
:param selector: The XPath selector to be used. :param selector: The XPath selector to be used.
:param adaptive: Enabled will make the function try to relocate the element if it was 'saved' before :param adaptive: Enabled will make the function try to relocate the element if it was 'saved' before
:param identifier: A string that will be used to save/retrieve element's data in auto-matching, :param identifier: A string that will be used to save/retrieve element's data in adaptive,
otherwise the selector will be used. otherwise the selector will be used.
:param auto_save: Automatically save new elements for `adaptive` later :param auto_save: Automatically save new elements for `adaptive` later
:param percentage: The minimum percentage to accept while auto-matching and not going lower than that. :param percentage: The minimum percentage to accept while `adaptive` is working and not going lower than that.
Be aware that the percentage calculation depends solely on the page structure, so don't play with this Be aware that the percentage calculation depends solely on the page structure, so don't play with this
number unless you must know what you are doing! number unless you must know what you are doing!
""" """
@@ -617,10 +617,10 @@ class Selector(SelectorsGeneration):
:param selector: The CSS3 selector to be used. :param selector: The CSS3 selector to be used.
:param adaptive: Enabled will make the function try to relocate the element if it was 'saved' before :param adaptive: Enabled will make the function try to relocate the element if it was 'saved' before
:param identifier: A string that will be used to save/retrieve element's data in auto-matching, :param identifier: A string that will be used to save/retrieve element's data in adaptive,
otherwise the selector will be used. otherwise the selector will be used.
:param auto_save: Automatically save new elements for `adaptive` later :param auto_save: Automatically save new elements for `adaptive` later
:param percentage: The minimum percentage to accept while auto-matching and not going lower than that. :param percentage: The minimum percentage to accept while `adaptive` is working and not going lower than that.
Be aware that the percentage calculation depends solely on the page structure, so don't play with this Be aware that the percentage calculation depends solely on the page structure, so don't play with this
number unless you must know what you are doing! number unless you must know what you are doing!
@@ -681,10 +681,10 @@ class Selector(SelectorsGeneration):
:param selector: The XPath selector to be used. :param selector: The XPath selector to be used.
:param adaptive: Enabled will make the function try to relocate the element if it was 'saved' before :param adaptive: Enabled will make the function try to relocate the element if it was 'saved' before
:param identifier: A string that will be used to save/retrieve element's data in auto-matching, :param identifier: A string that will be used to save/retrieve element's data in adaptive,
otherwise the selector will be used. otherwise the selector will be used.
:param auto_save: Automatically save new elements for `adaptive` later :param auto_save: Automatically save new elements for `adaptive` later
:param percentage: The minimum percentage to accept while auto-matching and not going lower than that. :param percentage: The minimum percentage to accept while `adaptive` is working and not going lower than that.
Be aware that the percentage calculation depends solely on the page structure, so don't play with this Be aware that the percentage calculation depends solely on the page structure, so don't play with this
number unless you must know what you are doing! number unless you must know what you are doing!
@@ -971,7 +971,7 @@ class Selector(SelectorsGeneration):
self._storage.save(element, identifier) self._storage.save(element, identifier)
else: else:
log.critical( log.critical(
"Can't use Auto-match features while disabled globally, you have to start a new class instance." "Can't use `adaptive` features while it's disabled globally, you have to start a new class instance."
) )
def retrieve(self, identifier: str) -> Optional[Dict[str, Any]]: def retrieve(self, identifier: str) -> Optional[Dict[str, Any]]:
@@ -985,7 +985,7 @@ class Selector(SelectorsGeneration):
return self._storage.retrieve(identifier) return self._storage.retrieve(identifier)
log.critical( log.critical(
"Can't use Auto-match features while disabled globally, you have to start a new class instance." "Can't use `adaptive` features while it's disabled globally, you have to start a new class instance."
) )
return None return None
@@ -1266,10 +1266,10 @@ class Selectors(List[Selector]):
Note: **Additional keyword arguments will be passed as XPath variables in the XPath expression!** Note: **Additional keyword arguments will be passed as XPath variables in the XPath expression!**
:param selector: The XPath selector to be used. :param selector: The XPath selector to be used.
:param identifier: A string that will be used to retrieve element's data in auto-matching, :param identifier: A string that will be used to retrieve element's data in adaptive,
otherwise the selector will be used. otherwise the selector will be used.
:param auto_save: Automatically save new elements for `adaptive` later :param auto_save: Automatically save new elements for `adaptive` later
:param percentage: The minimum percentage to accept while auto-matching and not going lower than that. :param percentage: The minimum percentage to accept while `adaptive` is working and not going lower than that.
Be aware that the percentage calculation depends solely on the page structure, so don't play with this Be aware that the percentage calculation depends solely on the page structure, so don't play with this
number unless you must know what you are doing! number unless you must know what you are doing!
@@ -1299,10 +1299,10 @@ class Selectors(List[Selector]):
and want to relocate the same element(s)** and want to relocate the same element(s)**
:param selector: The CSS3 selector to be used. :param selector: The CSS3 selector to be used.
:param identifier: A string that will be used to retrieve element's data in auto-matching, :param identifier: A string that will be used to retrieve element's data in adaptive,
otherwise the selector will be used. otherwise the selector will be used.
:param auto_save: Automatically save new elements for `adaptive` later :param auto_save: Automatically save new elements for `adaptive` later
:param percentage: The minimum percentage to accept while auto-matching and not going lower than that. :param percentage: The minimum percentage to accept while `adaptive` is working and not going lower than that.
Be aware that the percentage calculation depends solely on the page structure, so don't play with this Be aware that the percentage calculation depends solely on the page structure, so don't play with this
number unless you must know what you are doing! number unless you must know what you are doing!
tests/parser/test_adaptive.py
+2 -2
View File
@@ -47,7 +47,7 @@ class TestParserAdaptive:
new_page = Selector(changed_html, url="example.com", adaptive=True) new_page = Selector(changed_html, url="example.com", adaptive=True)
# 'p1' was used as ID and now it's not and all the path elements have changes # 'p1' was used as ID and now it's not and all the path elements have changes
# Also at the same time testing auto-match vs combined selectors # Also at the same time testing `adaptive` vs combined selectors
_ = old_page.css("#p1, #p2", auto_save=True)[0] _ = old_page.css("#p1, #p2", auto_save=True)[0]
relocated = new_page.css("#p1", adaptive=True) relocated = new_page.css("#p1", adaptive=True)
@@ -101,7 +101,7 @@ class TestParserAdaptive:
new_page = Selector(changed_html, url="example.com", adaptive=True) new_page = Selector(changed_html, url="example.com", adaptive=True)
# 'p1' was used as ID and now it's not and all the path elements have changes # 'p1' was used as ID and now it's not and all the path elements have changes
# Also at the same time testing auto-match vs combined selectors # Also at the same time testing `adaptive` vs combined selectors
_ = old_page.css("#p1, #p2", auto_save=True)[0] _ = old_page.css("#p1, #p2", auto_save=True)[0]
relocated = new_page.css("#p1", adaptive=True) relocated = new_page.css("#p1", adaptive=True)