This part of the documentation covers the internal interfaces of reader, which are useful for plugins, or if you want to use low-level functionality without using :class:`~reader.Reader` itself.
Warning
As of version |version|, the internal API is not part of the public API; it is not stable yet and might change without any notice.
.. autoattribute:: reader.Reader._parser
.. module:: reader._parser
.. autofunction:: default_parser
.. autoclass:: Parser
:members:
:special-members: __call__
.. module:: reader._parser.requests
.. autoclass:: SessionFactory(...)
:members:
:special-members: __call__
.. autoclass:: SessionWrapper(...)
:members:
.. module:: reader._parser
:noindex:
.. autoclass:: FeedArgument
:members:
.. autoclass:: RetrieverType
:members:
:special-members: __call__
.. autoclass:: FeedForUpdateRetrieverType
:members:
:show-inheritance:
.. autoclass:: ParserType
:members:
:special-members: __call__
.. autoclass:: HTTPAcceptParserType
:members:
:show-inheritance:
.. autoclass:: EntryPairsParserType
:members:
:show-inheritance:
.. module:: reader._parser.requests
:noindex:
.. autoclass:: RequestHook
:members:
:special-members: __call__
.. autoclass:: ResponseHook
:members:
:special-members: __call__
.. module:: reader._parser
:noindex:
.. autoclass:: RetrieveResult
:members:
.. module:: reader._types
.. autoclass:: ParsedFeed
:members:
.. autoclass:: FeedData
:members:
:undoc-members:
.. autoclass:: EntryData
:members:
:undoc-members:
.. todo:: the following should be in the storage section, when we get one
.. autoclass:: FeedForUpdate
:members:
.. autoclass:: EntryForUpdate
:members:
reader storage is abstracted by two :abbr:`DAO (data access object)` protocols: :class:`StorageType`, which provides the main storage, and :class:`SearchType`, which provides search-related operations.
Currently, there's only one supported implementation, based on SQLite.
That said, it is possible to use an alternate implementation
by passing a :class:`StorageType` instance
via the _storage :func:`.make_reader` argument:
reader = make_reader('unused', _storage=MyStorage(...))
The protocols are mostly stable, but some backwards-incompatible changes are expected in the future (known ones are marked below with Unstable). The long term goal is for the storage API to become stable, but at least one other implementation needs to exists before that. (Working on one? :doc:`Let me know! <contributing>`)
Unstable
Currently, search is tightly-bound to a storage implementation (see :meth:`~.BoundSearchStorageType.make_search`). While the :ref:`change tracking API <changes>` allows search implementations to keep in sync with text content changes, there is no convenient way for :meth:`SearchType.search_entries` to filter/sort results without storage cooperation; :class:`StorageType` will need additional capabilities to support this.
.. autoattribute:: reader.Reader._storage
.. autoattribute:: reader.Reader._search
.. module:: reader._types
:noindex:
.. autoclass:: StorageType()
:members:
:special-members: __enter__, __exit__
.. autoclass:: BoundSearchStorageType()
:members:
:show-inheritance:
.. autoclass:: SearchType()
:members:
.. autoclass:: ChangeTrackingStorageType()
:members:
:show-inheritance:
.. autoclass:: ChangeTrackerType()
:members:
.. autoclass:: Change
:members:
.. autoclass:: Action
:members:
.. autoattribute:: reader.Entry._sequence
.. autoexception:: reader.exceptions.ChangeTrackingNotEnabledError
:show-inheritance:
.. autoclass:: FeedFilter
:members:
.. autoclass:: EntryFilter
:members:
.. autoclass:: FeedUpdateIntent
:members:
.. autoclass:: EntryUpdateIntent
:members:
.. autodata:: TagFilter
.. autodata:: TristateFilter
.. literalinclude:: ../examples/parser_only.py
:start-after: """ # docstring-end