types-lxml 2022.4.1

Type annotations for lxml

This repository contains external type annotations for lxml. It can be used by type-checking tools (currently supporting mypy and pyright) to check code that uses lxml, or used within IDEs like VSCode or PyCharm to facilitate development.

Installation

From PyPI

This is the normal choice for most people:

pip install -U types-lxml

From downloaded wheel file

Head over to release page and get wheel file (with extension .whl). Wheel files can be installed in the same way as PyPI package:

pip install -U types-lxml*.whl

Bleeding edge from GitHub

pip install -U git+https://github.com/abelcheung/types-lxml.git

Special notes

There are two special stub-only classes that do not exist as concrete class in lxml:

1. lxml.etree.ParserTarget
2. lxml.etree.SmartStr

They are intended as helpers when writing code, wrapped under if TYPE_CHECKING: .... Please consult their docstring in stub files for detail, or if you are using IDEs, the docstring might have been formatted nicely for reference.

History

Type annotations for lxml were initially included in typeshed, but as it was still incomplete, it was decided to be ripped out as a separate project. The code was extracted by Jelle Zijlstra and moved to lxml-stubs repository using git filter-branch.

types-lxml is a fork of lxml-stubs that strives for completeness, so that most people would at least find it usable; while the the original lxml-stubs aims to be stable.