bucket_DE/python-funcsigs

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-funcsigs
   4 VERSION=                1.0.2
   5 KEYWORDS=               python devel
   6 VARIANTS=               py27 py35 py36
   7 SDESC[py35]=            Signature functions backport from 3.3 (PY 35)
   8 SDESC[py36]=            Signature functions backport from 3.3 (PY 36)
   9 SDESC[py27]=            Signature functions backport from 3.3 (PY 27)
  10 HOMEPAGE=               http://funcsigs.readthedocs.org
  11 CONTACT=                Python_Automaton[python@ironwolf.systems]
  12
  13 DOWNLOAD_GROUPS=        main
  14 SITES[main]=            PYPI/f/funcsigs
  15 DISTFILE[1]=            funcsigs-1.0.2.tar.gz:main
  16 DF_INDEX=               1
  17 SPKGS[py35]=            single
  18 SPKGS[py36]=            single
  19 SPKGS[py27]=            single
  20
  21 OPTIONS_AVAILABLE=      PY27 PY35 PY36
  22 OPTIONS_STANDARD=       none
  23 VOPTS[py35]=            PY27=OFF PY35=ON PY36=OFF
  24 VOPTS[py36]=            PY27=OFF PY35=OFF PY36=ON
  25 VOPTS[py27]=            PY27=ON PY35=OFF PY36=OFF
  26
  27 DISTNAME=               funcsigs-1.0.2
  28
  29 LICENSE=                CUSTOM1:single
  30 LICENSE_NAME=           CUSTOM1:"ASL"
  31 LICENSE_SCHEME=         solo
  32 LICENSE_FILE=           CUSTOM1:{{WRKSRC}}/LICENSE
  33
  34 GENERATED=              yes
  35
  36 [PY35].BUILDRUN_DEPENDS_ON=             python-setuptools:single:py35
  37 [PY35].USES_ON=                         python:py35
  38
  39 [PY36].BUILDRUN_DEPENDS_ON=             python-setuptools:single:py36
  40 [PY36].USES_ON=                         python:py36
  41
  42 [PY27].BUILDRUN_DEPENDS_ON=             python-setuptools:single:py27
  43 [PY27].USES_ON=                         python:py27
  44
  45 [FILE:2960:descriptions/desc.single]
  46 .. funcsigs documentation master file, created by
  47    sphinx-quickstart on Fri Apr 20 20:27:52 2012.
  48    You can adapt this file completely to your liking, but it should at
  49 least
  50    contain the root `toctree` directive.
  51
  52 Introducing funcsigs
  53 ====================
  54
  55 The Funcsigs Package
  56 --------------------
  57
  58 ``funcsigs`` is a backport of the `PEP 362`_ function signature features
  59 from
  60 Python 3.3's `inspect`_ module. The backport is compatible with Python
  61 2.6, 2.7
  62 as well as 3.3 and up. 3.2 was supported by version 0.4, but with
  63 setuptools and
  64 pip no longer supporting 3.2, we cannot make any statement about 3.2
  65 compatibility.
  66
  67 Compatibility
  68 `````````````
  69
  70 The ``funcsigs`` backport has been tested against:
  71
  72 * CPython 2.6
  73 * CPython 2.7
  74 * CPython 3.3
  75 * CPython 3.4
  76 * CPython 3.5
  77 * CPython nightlies
  78 * PyPy and PyPy3(currently failing CI)
  79
  80 Continuous integration testing is provided by `Travis CI`_.
  81
  82 Under Python 2.x there is a compatibility issue when a function is
  83 assigned to
  84 the ``__wrapped__`` property of a class after it has been constructed.
  85 Similiarily there under PyPy directly passing the ``__call__`` method of a
  86 builtin is also a compatibility issues.  Otherwise the functionality is
  87 believed to be uniform between both Python2 and Python3.
  88
  89 Issues
  90 ``````
  91
  92 Source code for ``funcsigs`` is hosted on `GitHub`_. Any bug reports or
  93 feature
  94 requests can be made using GitHub's `issues system`_. |build_status|
  95 |coverage|
  96
  97 Example
  98 -------
  99
 100 To obtain a `Signature` object, pass the target function to the
 101 ``funcsigs.signature`` function.
 102
 103 .. code-block:: python
 104
 105     >>> from funcsigs import signature
 106     >>> def foo(a, b=None, *args, **kwargs):
 107     ...     pass
 108     ...
 109     >>> sig = signature(foo)
 110     >>> sig
 111     <funcsigs.Signature object at 0x...>
 112     >>> sig.parameters
 113     OrderedDict([('a', <Parameter at 0x... 'a'>), ('b', <Parameter at
 114 0x... 'b'>), ('args', <Parameter at 0x... 'args'>), ('kwargs', <Parameter
 115 at 0x... 'kwargs'>)])
 116     >>> sig.return_annotation
 117     <class 'funcsigs._empty'>
 118
 119 Introspecting callables with the Signature object
 120 -------------------------------------------------
 121
 122 .. note::
 123
 124    This section of documentation is a direct reproduction of the Python
 125    standard library documentation for the inspect module.
 126
 127 The Signature object represents the call signature of a callable object
 128 and its
 129 return annotation.  To retrieve a Signature object, use the
 130 :func:`signature`
 131 function.
 132
 133 .. function:: signature(callable)
 134
 135    Return a :class:`Signature` object for the given ``callable``::
 136
 137       >>> from funcsigs import signature
 138       >>> def foo(a, *, b:int, **kwargs):
 139       ...     pass
 140
 141       >>> sig = signature(foo)
 142
 143       >>> str(sig)
 144       '(a, *, b:int, **kwargs)'
 145
 146       >>> str(sig.parameters['b'])
 147       'b:int'
 148
 149       >>> sig.parameters['b'].annotation
 150       <class 'int'>
 151
 152    Accepts a wide range of python callables, from plain functions and
 153 classes to
 154    :func:`functools.partial` objects.
 155
 156    .. note::
 157
 158
 159
 160 [FILE:100:distinfo]
 161 a7bb0f2cf3a3fd1ab2732cb49eba4252c2af4240442415b4abce3b87022a8f50        27947 funcsigs-1.0.2.tar.gz
 162