Skip to content

(Incomplete) type stubs for the lxml package

License

Notifications You must be signed in to change notification settings

boxingbeetle/lxml-stubs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

lxml-stubs

About

This repository contains external type annotations (see PEP 484) for the lxml package. Such type annotations are normally included in typeshed, but lxml's annotations were frequently problematic and have therefore been deleted from typeshed. In particular, the stubs are incomplete and it has been difficult to provide complete stubs.

This repo provides lxml stubs as they existed in typeshed for those who find them useful. Eventually, it should become a PEP 561-style stubs package.

Usage

To use these stubs with mypy, you have to install the lxml-stubs package.

If you want to use the stubs as-is, you can build and install the package directly from its repository:

$ pip install https://github.com/lxml/lxml-stubs.git

If you want to make local modifications, you can clone this repository and tell pip to install a link to the cloned source tree:

$ pip install -e /path/to/lxml-stubs

Contributing

Contributions should follow the same style guidelines as typeshed.

Git history

The early git history of this repo contains commits from typeshed, filtered to only changes that affect typeshed (using git filter-branch).

Authors

This repository was created by Jelle Zijlstra. Numerous others have contributed to the lxml stubs; see the git history for details.

TODOs

  • Provide testing (both a local test script and a Travis setup)
  • Provide a PEP 561-style setup script.

About

(Incomplete) type stubs for the lxml package

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%