py-deprecation: added version 1.0.1

The deprecation library provides a deprecated decorator and a
fail_if_not_removed decorator for your tests. Together, the two enable the
automation of several things:

1. The docstring of a deprecated method gets the deprecation details appended to
the end of it. If you generate your API docs direct from your source, you don't
need to worry about writing your own notification. You also don't need to worry
about forgetting to write it. It's done for you.

2. Rather than having code live on forever because you only deprecated it but
never actually moved on from it, you can have your tests tell you when it's
time to remove the code. The @deprecated decorator can be told when it's time
to entirely remove the code, which causes @fail_if_not_removed to raise an
AssertionError, causing either your unittest or py.test tests to fail.
This commit is contained in:
adam 2017-12-31 18:47:08 +00:00
parent 80b5d176ed
commit 304fbcc030
5 changed files with 48 additions and 1 deletions

View file

@ -1,4 +1,4 @@
# $NetBSD: Makefile,v 1.2587 2017/12/31 13:38:18 wiz Exp $
# $NetBSD: Makefile,v 1.2588 2017/12/31 18:47:08 adam Exp $
#
COMMENT= Development utilities
@ -1901,6 +1901,7 @@ SUBDIR+= py-daemonize
SUBDIR+= py-darcsver
SUBDIR+= py-ddt
SUBDIR+= py-decorator
SUBDIR+= py-deprecation
SUBDIR+= py-dialog
SUBDIR+= py-dialog2
SUBDIR+= py-distorm3

View file

@ -0,0 +1,14 @@
The deprecation library provides a deprecated decorator and a
fail_if_not_removed decorator for your tests. Together, the two enable the
automation of several things:
1. The docstring of a deprecated method gets the deprecation details appended to
the end of it. If you generate your API docs direct from your source, you don't
need to worry about writing your own notification. You also don't need to worry
about forgetting to write it. It's done for you.
2. Rather than having code live on forever because you only deprecated it but
never actually moved on from it, you can have your tests tell you when it's
time to remove the code. The @deprecated decorator can be told when it's time
to entirely remove the code, which causes @fail_if_not_removed to raise an
AssertionError, causing either your unittest or py.test tests to fail.

View file

@ -0,0 +1,18 @@
# $NetBSD: Makefile,v 1.1 2017/12/31 18:47:08 adam Exp $
DISTNAME= deprecation-1.0.1
PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
CATEGORIES= devel python
MASTER_SITES= ${MASTER_SITE_PYPI:=d/deprecation/}
MAINTAINER= pkgsrc-users@NetBSD.org
HOMEPAGE= http://deprecation.readthedocs.io/
COMMENT= Library to handle automated deprecations
LICENSE= apache-2.0
#DEPENDS+= ${PYPKGPREFIX}-six-[0-9]*:../../lang/py-six
USE_LANGUAGES= # none
.include "../../lang/python/egg.mk"
.include "../../mk/bsd.pkg.mk"

View file

@ -0,0 +1,8 @@
@comment $NetBSD: PLIST,v 1.1 2017/12/31 18:47:08 adam Exp $
${PYSITELIB}/${EGG_INFODIR}/PKG-INFO
${PYSITELIB}/${EGG_INFODIR}/SOURCES.txt
${PYSITELIB}/${EGG_INFODIR}/dependency_links.txt
${PYSITELIB}/${EGG_INFODIR}/top_level.txt
${PYSITELIB}/deprecation.py
${PYSITELIB}/deprecation.pyc
${PYSITELIB}/deprecation.pyo

View file

@ -0,0 +1,6 @@
$NetBSD: distinfo,v 1.1 2017/12/31 18:47:08 adam Exp $
SHA1 (deprecation-1.0.1.tar.gz) = 54e669246915e6b24abd1f5c55767dea62b84cb2
RMD160 (deprecation-1.0.1.tar.gz) = 1085136c3468139081a0404d77af85072f58e968
SHA512 (deprecation-1.0.1.tar.gz) = fc35e6516e1617e2baad598a91e5d83ca95ab8a2d6a2753751d6752675de93cb44210109450a2aad9eb52b3c772a8b753c1d42ab2356c6663d2a03c4f779f086
Size (deprecation-1.0.1.tar.gz) = 9596 bytes