# Buildsheet autogenerated by ravenadm tool -- Do not edit.

NAMEBASE=		python-funcsigs
VERSION=		1.0.2
KEYWORDS=		python devel
VARIANTS=		py27 py35 py36
SDESC[py35]=		Python function signatures from PEP362 for (PY 35)
SDESC[py36]=		Python function signatures from PEP362 for (PY 36)
SDESC[py27]=		Python function signatures from PEP362 for (PY 27)
HOMEPAGE=		http://funcsigs.readthedocs.org
CONTACT=		Python_Automaton[python@ironwolf.systems]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPI/f/funcsigs
DISTFILE[1]=		funcsigs-1.0.2.tar.gz:main
DF_INDEX=		1
SPKGS[py35]=		single
SPKGS[py36]=		single
SPKGS[py27]=		single

OPTIONS_AVAILABLE=	PY27 PY35 PY36
OPTIONS_STANDARD=	none
VOPTS[py35]=		PY27=OFF PY35=ON PY36=OFF
VOPTS[py36]=		PY27=OFF PY35=OFF PY36=ON
VOPTS[py27]=		PY27=ON PY35=OFF PY36=OFF

DISTNAME=		funcsigs-1.0.2

LICENSE=		CUSTOM1:single
LICENSE_NAME=		CUSTOM1:"ASL"
LICENSE_SCHEME=		solo
LICENSE_FILE=		CUSTOM1:{{WRKSRC}}/LICENSE

GENERATED=		yes

[PY35].BUILDRUN_DEPENDS_ON=		python-setuptools:single:py35
[PY35].USES_ON=				python:py35

[PY36].BUILDRUN_DEPENDS_ON=		python-setuptools:single:py36
[PY36].USES_ON=				python:py36

[PY27].BUILDRUN_DEPENDS_ON=		python-setuptools:single:py27
[PY27].USES_ON=				python:py27

[FILE:2960:descriptions/desc.single]
.. funcsigs documentation master file, created by
   sphinx-quickstart on Fri Apr 20 20:27:52 2012.
   You can adapt this file completely to your liking, but it should at
least
   contain the root `toctree` directive.

Introducing funcsigs
====================

The Funcsigs Package
--------------------

``funcsigs`` is a backport of the `PEP 362`_ function signature features
from
Python 3.3's `inspect`_ module. The backport is compatible with Python
2.6, 2.7
as well as 3.3 and up. 3.2 was supported by version 0.4, but with
setuptools and
pip no longer supporting 3.2, we cannot make any statement about 3.2
compatibility.

Compatibility
`````````````

The ``funcsigs`` backport has been tested against:

* CPython 2.6
* CPython 2.7
* CPython 3.3
* CPython 3.4
* CPython 3.5
* CPython nightlies
* PyPy and PyPy3(currently failing CI)

Continuous integration testing is provided by `Travis CI`_.

Under Python 2.x there is a compatibility issue when a function is
assigned to
the ``__wrapped__`` property of a class after it has been constructed.
Similiarily there under PyPy directly passing the ``__call__`` method of a
builtin is also a compatibility issues.  Otherwise the functionality is
believed to be uniform between both Python2 and Python3.

Issues
``````

Source code for ``funcsigs`` is hosted on `GitHub`_. Any bug reports or
feature
requests can be made using GitHub's `issues system`_. |build_status|
|coverage|

Example
-------

To obtain a `Signature` object, pass the target function to the
``funcsigs.signature`` function.

.. code-block:: python

    >>> from funcsigs import signature
    >>> def foo(a, b=None, *args, **kwargs):
    ...     pass
    ...
    >>> sig = signature(foo)
    >>> sig
    <funcsigs.Signature object at 0x...>
    >>> sig.parameters
    OrderedDict([('a', <Parameter at 0x... 'a'>), ('b', <Parameter at
0x... 'b'>), ('args', <Parameter at 0x... 'args'>), ('kwargs', <Parameter
at 0x... 'kwargs'>)])
    >>> sig.return_annotation
    <class 'funcsigs._empty'>

Introspecting callables with the Signature object
-------------------------------------------------

.. note::

   This section of documentation is a direct reproduction of the Python
   standard library documentation for the inspect module.

The Signature object represents the call signature of a callable object
and its
return annotation.  To retrieve a Signature object, use the
:func:`signature`
function.

.. function:: signature(callable)

   Return a :class:`Signature` object for the given ``callable``::

      >>> from funcsigs import signature
      >>> def foo(a, *, b:int, **kwargs):
      ...     pass

      >>> sig = signature(foo)

      >>> str(sig)
      '(a, *, b:int, **kwargs)'

      >>> str(sig.parameters['b'])
      'b:int'

      >>> sig.parameters['b'].annotation
      <class 'int'>

   Accepts a wide range of python callables, from plain functions and
classes to
   :func:`functools.partial` objects.

   .. note::



[FILE:100:distinfo]
a7bb0f2cf3a3fd1ab2732cb49eba4252c2af4240442415b4abce3b87022a8f50        27947 funcsigs-1.0.2.tar.gz