Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | - | - | ||||
docs/ | 03-May-2024 | - | 732 | 387 | ||
funcsigs/ | 03-May-2024 | - | 1,114 | 810 | ||
requirements/ | 03-May-2024 | - | 7 | 6 | ||
tests/ | 03-May-2024 | - | 1,143 | 906 | ||
.coveragerc | D | 03-May-2024 | 71 | 7 | 5 | |
.travis.yml | D | 03-May-2024 | 342 | 18 | 17 | |
Android.bp | D | 03-May-2024 | 1.7 KiB | 60 | 57 | |
Android_tests.py | D | 03-May-2024 | 1.2 KiB | 34 | 9 | |
CHANGELOG | D | 03-May-2024 | 350 | 20 | 15 | |
LICENSE | D | 03-May-2024 | 549 | 14 | 10 | |
MANIFEST.in | D | 03-May-2024 | 140 | 8 | 7 | |
METADATA | D | 03-May-2024 | 568 | 22 | 20 | |
MODULE_LICENSE_APACHE2 | D | 03-May-2024 | 0 | |||
Makefile | D | 03-May-2024 | 698 | 40 | 29 | |
NOTICE | D | 03-May-2024 | 549 | 14 | 10 | |
OWNERS | D | 03-May-2024 | 205 | 5 | 4 | |
README.rst | D | 03-May-2024 | 2.8 KiB | 84 | 61 | |
setup.cfg | D | 03-May-2024 | 22 | 3 | 2 | |
setup.py | D | 03-May-2024 | 2 KiB | 56 | 50 |
README.rst
1funcsigs 2======== 3 4``funcsigs`` is a backport of the `PEP 362`_ function signature features from 5Python 3.3's `inspect`_ module. The backport is compatible with Python 2.6, 2.7 6as well as 3.2 and up. 7 8|pypi_version| 9 10Documentation 11------------- 12 13The reference documentation is standard library documentation for the 14`inspect`_ module in Python3. This documentation has been included in the 15``funcsigs`` package documentation hosted on `Read The Docs`_. 16 17Example 18------- 19 20To obtain a signature object, pass the target function to the 21``funcsigs.signature`` function. :: 22 23 >>> from funcsigs import signature 24 >>> def foo(a, b=None, *args, **kwargs): 25 ... pass 26 27 >>> sig = signature(foo) 28 29For the details of the signature object, refer to the either the package of 30standard library documentation. 31 32Compatability 33------------- 34 35The ``funcsigs`` backport has been tested against: 36 37* CPython 2.6 38* CPython 2.7 39* CPython 3.2 40* PyPy 1.9 41 42Continuous integration testing is provided by `Travis CI`_. 43 44Under Python 2.x there is a compatability issue when a function is assigned to 45the ``__wrapped__`` property of a class after it has been constructed. 46Similiarily there under PyPy directly passing the ``__call__`` method of a 47builtin is also a compatability issues. Otherwise the functionality is 48believed to be uniform between both Python2 and Python3. 49 50Issues 51------ 52 53Source code for ``funcsigs`` is hosted on `GitHub`_. Any bug reports or feature 54requests can be made using GitHub's `issues system`_. |build_status| |coverage| 55 56Copyright 57--------- 58 59This is a derived work of CPython under the terms of the `PSF License 60Agreement`_. The original CPython inspect module, its unit tests and 61documentation are the copyright of the Python Software Foundation. The derived 62work is distributed under the `Apache License Version 2.0`_. 63 64.. _Apache License Version 2.0: http://opensource.org/licenses/Apache-2.0 65.. _GitHub: https://github.com/aliles/funcsigs 66.. _PSF License Agreement: http://docs.python.org/3/license.html#terms-and-conditions-for-accessing-or-otherwise-using-python 67.. _Travis CI: http://travis-ci.org/ 68.. _Read The Docs: http://funcsigs.readthedocs.org/ 69.. _PEP 362: http://www.python.org/dev/peps/pep-0362/ 70.. _inspect: http://docs.python.org/3/library/inspect.html#introspecting-callables-with-the-signature-object 71.. _issues system: https://github.com/alies/funcsigs/issues 72 73.. |build_status| image:: https://secure.travis-ci.org/aliles/funcsigs.png?branch=master 74 :target: http://travis-ci.org/#!/aliles/funcsigs 75 :alt: Current build status 76 77.. |coverage| image:: https://coveralls.io/repos/aliles/funcsigs/badge.png?branch=master 78 :target: https://coveralls.io/r/aliles/funcsigs?branch=master 79 :alt: Coverage status 80 81.. |pypi_version| image:: https://pypip.in/v/funcsigs/badge.png 82 :target: https://crate.io/packages/funcsigs/ 83 :alt: Latest PyPI version 84