types-clang


Nametypes-clang JSON
Version 0.14.3 PyPI version JSON
download
home_pagehttps://github.com/tgockel/types-clang
SummaryStubs package for Clang Python bindings
upload_time2023-03-15 17:37:24
maintainer
docs_urlNone
authorTravis Gockel
requires_python>=3.6,<4.0
licenseApache-2.0
keywords clang stubs typing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ###########
types-clang
###########
==========================================
Type Information for Clang Python Bindings
==========================================

Have you used the `Clang Python Bindings <https://pypi.org/project/clang/>`_, but wanted type hints in your IDE?
Have you ever wanted to use `mypy <http://mypy-lang.org/>`_ tools on a project that uses Clang but gotten errors due to
lack of type annotations?
This package is a `PEP 561 <https://www.python.org/dev/peps/pep-0561>`_ stub package which provides type information for
Clang.

In other words, transform your IDE from:

.. image:: https://raw.githubusercontent.com/tgockel/types-clang/trunk/doc/before.png

to:

.. image:: https://raw.githubusercontent.com/tgockel/types-clang/trunk/doc/after.png

To utilize this, add it globally with::

    pip3 install types-clang

Or add ``types-clang`` to ``dev-requirements.txt`` or ``pyproject.toml`` or whatever you use for dependency management.

Versioning
==========

.. note::
    This project is still ``0.x``, so add a ``0.`` in front of the descriptions here.
    In other words, for ``clang`` ``12.0.1``, use ``types-clang`` ``0.12.2``.

The published ``types-clang`` packages correspond with the type information of the ``{major}.{minor}`` of the ``clang``
package.
The patch version of ``types-clang`` does not correspond with any patch version of ``clang``, as they use semantic
versioning correctly and will not add functionality in a patch release.
So, if you install ``clang==13.0.1``, then ``types-clang>=13.0, <13.1`` will have the appropriate stubs.

Best practice is to write the version specification for ``types-clang`` to be the same as the ``clang`` package, but
without the patch.
For `Poetry <https://python-poetry.org/>`_::

    [tool.poetry.dependencies]
    clang = "14.0"

    [tool.poetry.dev-dependencies]
    types-clang = "14.0"

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/tgockel/types-clang",
    "name": "types-clang",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6,<4.0",
    "maintainer_email": "",
    "keywords": "clang,stubs,typing",
    "author": "Travis Gockel",
    "author_email": "travis@gockelhut.com",
    "download_url": "https://files.pythonhosted.org/packages/4d/a9/a2edb5cefd1d50a033054724ed150fcb17d1e9c7150fde72fd96c714877b/types-clang-0.14.3.tar.gz",
    "platform": null,
    "description": "###########\ntypes-clang\n###########\n==========================================\nType Information for Clang Python Bindings\n==========================================\n\nHave you used the `Clang Python Bindings <https://pypi.org/project/clang/>`_, but wanted type hints in your IDE?\nHave you ever wanted to use `mypy <http://mypy-lang.org/>`_ tools on a project that uses Clang but gotten errors due to\nlack of type annotations?\nThis package is a `PEP 561 <https://www.python.org/dev/peps/pep-0561>`_ stub package which provides type information for\nClang.\n\nIn other words, transform your IDE from:\n\n.. image:: https://raw.githubusercontent.com/tgockel/types-clang/trunk/doc/before.png\n\nto:\n\n.. image:: https://raw.githubusercontent.com/tgockel/types-clang/trunk/doc/after.png\n\nTo utilize this, add it globally with::\n\n    pip3 install types-clang\n\nOr add ``types-clang`` to ``dev-requirements.txt`` or ``pyproject.toml`` or whatever you use for dependency management.\n\nVersioning\n==========\n\n.. note::\n    This project is still ``0.x``, so add a ``0.`` in front of the descriptions here.\n    In other words, for ``clang`` ``12.0.1``, use ``types-clang`` ``0.12.2``.\n\nThe published ``types-clang`` packages correspond with the type information of the ``{major}.{minor}`` of the ``clang``\npackage.\nThe patch version of ``types-clang`` does not correspond with any patch version of ``clang``, as they use semantic\nversioning correctly and will not add functionality in a patch release.\nSo, if you install ``clang==13.0.1``, then ``types-clang>=13.0, <13.1`` will have the appropriate stubs.\n\nBest practice is to write the version specification for ``types-clang`` to be the same as the ``clang`` package, but\nwithout the patch.\nFor `Poetry <https://python-poetry.org/>`_::\n\n    [tool.poetry.dependencies]\n    clang = \"14.0\"\n\n    [tool.poetry.dev-dependencies]\n    types-clang = \"14.0\"\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Stubs package for Clang Python bindings",
    "version": "0.14.3",
    "split_keywords": [
        "clang",
        "stubs",
        "typing"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c80d81718cf5ad04ba420f01fbc4caa390a12c7c3136962bed1e8493ac3d5a11",
                "md5": "f00a1a08331c085e2a3364ffe90eb911",
                "sha256": "5b52a7258bbf69b1376594fb0fad1bef526de9f6c4ed27cabd382557ac3896c2"
            },
            "downloads": -1,
            "filename": "types_clang-0.14.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f00a1a08331c085e2a3364ffe90eb911",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6,<4.0",
            "size": 7749,
            "upload_time": "2023-03-15T17:37:26",
            "upload_time_iso_8601": "2023-03-15T17:37:26.602214Z",
            "url": "https://files.pythonhosted.org/packages/c8/0d/81718cf5ad04ba420f01fbc4caa390a12c7c3136962bed1e8493ac3d5a11/types_clang-0.14.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4da9a2edb5cefd1d50a033054724ed150fcb17d1e9c7150fde72fd96c714877b",
                "md5": "6563c5f33a594408f87ccab702806ad5",
                "sha256": "d0a093530f763f56e563ed7be79937308a4bdc4a5aa2be195615ac746b4dedec"
            },
            "downloads": -1,
            "filename": "types-clang-0.14.3.tar.gz",
            "has_sig": false,
            "md5_digest": "6563c5f33a594408f87ccab702806ad5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6,<4.0",
            "size": 8616,
            "upload_time": "2023-03-15T17:37:24",
            "upload_time_iso_8601": "2023-03-15T17:37:24.372966Z",
            "url": "https://files.pythonhosted.org/packages/4d/a9/a2edb5cefd1d50a033054724ed150fcb17d1e9c7150fde72fd96c714877b/types-clang-0.14.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-15 17:37:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "tgockel",
    "github_project": "types-clang",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "types-clang"
}
        
Elapsed time: 0.05847s