- JMESPath support is now available: you can use :meth:`.WebPage.jmespath` and :meth:`.HttpResponse.jmespath` to run queries on JSON responses.
- The testing framework now supports page objects that raise exceptions from
the
to_item
method.
- New class :class:`~.Extractor` can be used for easier extraction of nested fields (see :ref:`default-processors-nested`).
- Exceptions raised while getting a response for an additional request are now saved in :ref:`test fixtures <web-poet-testing-additional-requests>`.
- Multiple documentation improvements and fixes.
- Add a
twine check
CI check.
- Standardized :ref:`input validation <input-validation>`.
- :ref:`Field processors <field-processors>` can now also be defined through a
nested
Processors
class, so that field redefinitions in subclasses can inherit them. See :ref:`default-processors`. - :ref:`Field processors <field-processors>` can now opt in to receive the page object whose field is being read.
- :class:`web_poet.fields.FieldsMixin` now keeps fields from all base classes when using multiple inheritance.
- Fixed the documentation build.
- Fix the error when calling :meth:`.to_item() <web_poet.pages.ItemPage.to_item>`,
:func:`item_from_fields_sync() <web_poet.fields.item_from_fields_sync>`, or
:func:`item_from_fields() <web_poet.fields.item_from_fields>` on page objects
defined as slotted attrs classes, while setting
skip_nonitem_fields=True
.
This release contains many improvements to the web-poet testing framework, as well as some other improvements and bug fixes.
Backward-incompatible changes:
- :func:`~.cached_method` no longer caches exceptions for
async def
methods. This makes the behavior the same for sync and async methods, and also makes it consistent with Python's stdlib caching (i.e. :func:`functools.lru_cache`, :func:`functools.cached_property`). - The testing framework now uses the
HttpResponse-info.json
file name instead ofHttpResponse-other.json
to store information about HttpResponse instances. To make tests generated with older web-poet work, rename these files on disk.
Testing framework improvements:
- Improved test reporting: better diffs and error messages.
- By default, the pytest plugin now generates a test per item attribute
(see :ref:`web-poet-testing-pytest`). There is also an option
(
--web-poet-test-per-item
) to run a test per item instead. - Page objects with the :class:`~.HttpClient` dependency are now supported (see :ref:`web-poet-testing-additional-requests`).
- Page objects with the :class:`~.PageParams` dependency are now supported.
- Added a new
python -m web_poet.testing rerun
command (see :ref:`web-poet-testing-tdd`). - Fixed support for nested (indirect) dependencies in page objects. Previously they were not handled properly by the testing framework.
- Non-ASCII output is now stored without escaping in the test fixtures, for better readability.
Other changes:
- Testing and CI fixes.
- Fixed a packaging issue:
tests
andtests_extra
packages were installed, not justweb_poet
.
- Restore the minimum version of
itemadapter
from 0.7.1 to 0.7.0, and prevent a similar issue from happening again in the future.
- Updated the :ref:`tutorial <tutorial>` to cover recent features and focus on best practices. Also, a new module was added, :mod:`web_poet.example`, that allows using page objects while following the tutorial.
- :ref:`web-poet-testing` now covers :ref:`Git LFS <git-lfs>` and
:ref:`scrapy-poet <web-poet-testing-scrapy-poet>`, and recommends
python -m pytest
instead ofpytest
. - Improved the warning message when duplicate
ApplyRule
objects are found. HttpResponse-other.json
content is now indented for better readability.- Improved test coverage for :ref:`fields <fields>`.
Add :ref:`a framework for creating tests and running them with pytest <web-poet-testing>`.
Support implementing fields in mixin classes.
Introduce new methods for :class:`web_poet.rules.RulesRegistry`:
Improved the performance of :meth:`web_poet.rules.RulesRegistry.search` where passing a single parameter of either
instead_of
orto_return
results in O(1) look-up time instead of O(N). Additionally, having eitherinstead_of
orto_return
present in multi-parameter search calls would filter the initial candidate results resulting in a faster search.Support :ref:`page object dependency serialization <dep-serialization>`.
Add new dependencies used in testing and serialization code:
andi
,python-dateutil
, andtime-machine
. Alsobackports.zoneinfo
on non-Windows platforms when the Python version is older than 3.9.
In this release, the @handle_urls
decorator gets an overhaul; it's not
required anymore to pass another Page Object class to
@handle_urls("...", overrides=...)
.
Also, the @web_poet.field
decorator gets support for output processing
functions, via the out
argument.
Full list of changes:
Backwards incompatible
PageObjectRegistry
is no longer supporting dict-like access.Official support for Python 3.11.
New
@web_poet.field(out=[...])
argument which allows to set output processing functions for web-poet fields.The
web_poet.overrides
module is deprecated and replaced withweb_poet.rules
.The
@handle_urls
decorator is now creatingApplyRule
instances instead ofOverrideRule
instances;OverrideRule
is deprecated.ApplyRule
is similar toOverrideRule
, but has the following differences:ApplyRule
accepts ato_return
parameter, which should be the data container (item) class that the Page Object returns.- Passing a string to
for_patterns
would auto-convert it intourl_matcher.Patterns
. - All arguments are now keyword-only except for
for_patterns
.
New signature and behavior of
handle_urls
:- The
overrides
parameter is made optional and renamed toinstead_of
. - If defined, the item class declared in a subclass of
web_poet.ItemPage
is used as theto_return
parameter ofApplyRule
. - Multiple
handle_urls
annotations are allowed.
- The
PageObjectRegistry
is replaced withRulesRegistry
; its API is changed:- backwards incompatible dict-like API is removed;
- backwards incompatible O(1) lookups using
.search(use=PagObject)
has become O(N); search_overrides
method is renamed tosearch
;get_overrides
method is renamed toget_rules
;from_override_rules
method is deprecated; useRulesRegistry(rules=...)
instead.
Typing improvements.
Documentation, test, and warning message improvements.
Deprecations:
- The
web_poet.overrides
module is deprecated. Useweb_poet.rules
instead. - The
overrides
parameter from@handle_urls
is now deprecated. Use theinstead_of
parameter instead. - The
OverrideRule
class is now deprecated. UseApplyRule
instead. PageObjectRegistry
is now deprecated. UseRulesRegistry
instead.- The
from_override_rules
method ofPageObjectRegistry
is now deprecated. UseRulesRegistry(rules=...)
instead. - The
PageObjectRegistry.get_overrides
method is deprecated. UsePageObjectRegistry.get_rules
instead. - The
PageObjectRegistry.search_overrides
method is deprecated. UsePageObjectRegistry.search
instead.
- The BOM encoding from the response body is now read before the response headers when deriving the response encoding.
- Minor typing improvements.
Web-poet now includes a mini-framework for organizing extraction code as Page Object properties:
import attrs from web_poet import field, ItemPage @attrs.define class MyItem: foo: str bar: list[str] class MyPage(ItemPage[MyItem]): @field def foo(self): return "..." @field def bar(self): return ["...", "..."]
Backwards incompatible changes:
web_poet.ItemPage
is no longer an abstract base class which requiresto_item
method to be implemented. Instead, it provides a defaultasync def to_item
method implementation which uses fields marked asweb_poet.field
to create an item. This change shouldn't affect the user code in a backwards incompatible way, but it might affect typing.
Deprecations:
web_poet.ItemWebPage
is deprecated. Useweb_poet.WebPage
instead.
Other changes:
- web-poet is declared as PEP 561 package which provides typing information; mypy is going to use it by default.
- Documentation, test, typing and CI improvements.
- New
HttpResponse.urljoin
method, which take page's base url in account. - New
HttpRequest.urljoin
method. - standardized
web_poet.exceptions.Retry
exception, which allows to initiate a retry from the Page Object, e.g. based on page content. - Documentation improvements.
Backwards Incompatible Change:
web_poet.requests.request_backend_var
is renamed toweb_poet.requests.request_downloader_var
.
Documentation and CI improvements.
Backward Incompatible Change:
ResponseData
is replaced withHttpResponse
.HttpResponse
exposes methods useful for web scraping (such as xpath and css selectors, json loading), and handles web page encoding detection. There are also new types likeHttpResponseBody
andHttpResponseHeaders
.
Added support for performing additional requests using
web_poet.HttpClient
.Introduced
web_poet.BrowserHtml
dependencyIntroduced
web_poet.PageParams
to pass arbitrary information inside a Page Object.Added
web_poet.handle_urls
decorator, which allows to declare which websites should be handled by the page objects. Lower-levelPageObjectRegistry
class is also available.removed support for Python 3.6
added support for Python 3.10
base_url
andurljoin
shortcuts
- Documentation
- WebPage, ItemPage, ItemWebPage, Injectable and ResponseData are available
as top-level imports (e.g.
web_poet.ItemPage
)
Initial release.