diff --git a/MANIFEST.in b/MANIFEST.in index 79d13f22157c2ab4abaacf0d67b437a5e1e03bc0..76f800a4f8a7964b2515189bad313323bc0532a6 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,5 +1,5 @@ recursive-include contrib * include AUTHORS -include NEWS +include NEWS.rst include README.rst include ez_setup.py diff --git a/NEWS b/NEWS deleted file mode 100644 index 1eed5166c9919a7ea2d31eec80e852d289e6723b..0000000000000000000000000000000000000000 --- a/NEWS +++ /dev/null @@ -1,170 +0,0 @@ -version 5.0 final (10-April-2020): - * Added support for Python 3.8. - - Functions with positional-only arguments on Python 3.8 will now work - correctly, and the positional-only arguments will factor into any - spy matching. - - * Added several new unit test assertion methods: - - * assertHasSpy - * assertSpyCalled - * assertSpyNotCalled - * assertSpyCallCount - * assertSpyCalledWith - * assertSpyLastCalledWith - * assertSpyReturned - * assertSpyLastReturned - * assertSpyRaised - * assertSpyLastRaised - * assertSpyRaisedMessage - * assertSpyLastRaisedMessage - - We recommend using these for unit tests instead of checking individual - properties of calls, as they'll provide better output and help you find - out why spies have gone rogue. - - * Added support for spying on "slippery" functions. - - A slippery function is defined (by us) as a function on an object that is - actually a different function every time you access it. In other words, - if you were to just reference a slippery function as an attribute two - times, you'd end up with two separate copies of that function, each - with their own ID. - - This can happen if the "function" is actually some decorator that returns - a new function every time it's accessed. A real-world example would be - the Python Stripe module's API functions, like stripe.Customer.delete. - - In previous versions of KGB, you wouldn't be able to spy on these - functions. With 5.0, you can spy on them just fine by passing - owner= when setting up the spy: - - spy_on(myobj.slippery_func, - owner=myobj) - - * Lots of internal changes to help keep the codebase organized and - manageable, as Python support increases. - - -version 4.0 final (30-July-2019): - * Added call_original(), which calls the original spied-on function. - - The call will not be logged, and will invoke the original behavior of - the function. This is useful when a spy simply needs to wrap another - function. - - * Updated the Python 3 support to use the modern, non-deprecated support - for inspecting and formatting function/method signatures. - - -version 3.0 final (23-March-2019): - * Added an argument to spy_on() for specifying an explicit owner class - for unbound methods, and warn if missing. - - Python 3.x doesn't have a real way of determining the owning class for - unbound methods, and attempting to spy on an unbound method can end up - causing a number of problems, potentially interfering with spies that - are a subclass or superclass of the spied object. - - spy_on() now accepts an owner= parameter for unbound methods in order - to explicitly specify the class. It will warn if this is missing, - providing details on what it thinks the owner is and the recommended - changes to make to the call. - - * Fixed spying on unbound methods originally defined on the parent class - of a specified or determined owning class. - - * Fixed spying on old-syle classes (those not inheriting from object) - on Python 2.6 and early versions of 2.7. - - -version 2.0.3 final (18-August-2018): - * Added a version classifier for Python 3.7. - - * Fixed a regression on Python 2.6. - - -version 2.0.2 final (9-July-2018): - * Fixed spying on instances of classes with a custom __setattr__. - - * Fixed spying on classmethods defined in the parent of a class. - - -version 2.0.1 final (12-March-2018): - * Fixed a regression in spying on classmethods. - - * Fixed copying function annotations and keyword-only defaults in Python 3. - - * Fixed problems executing some types of functions on Python 3.6. - - -version 2.0 final (5-February-2018): - * Added compatibility with Python 3.6. - - * Spy methods for standard functions no longer need to be accessed like: - - func.spy.last_call - - Now you can call them the same way you could with methods: - - func.last_call - - * The args and kwargs information recorded for a spy now correspond to - the function signature and not the way the function was called. - - * called_with() now allows providing keyword arguments to check positional - arguments by name. - - * When spying on a function fails for some reason, the error output is a - lot more helpful. - - -version 1.1 final (5-December-2017): - * Added returned(), last_returned(), raised(), last_raised(), - raised_with_message(), and last_raised_with_message() methods to - function spies. - - See the README for how this works. - - * Added called_with(), returned(), raised(), and raised_with_message() - to the individual SpyCall objects. - - These are accessed through spy.calls, and allow for more conveniently - checking the results of specific calls in tests. - - * called_with() and last_called_with() now accept matching subsets of - arguments. - - Any number of leading positional arguments and any subset of keyword - arguments can be specified. Prior to 1.0, subsets of keyword arguments - were supported, but 1.0 temporarily made this more strict. - - This is helpful when testing function calls containing many default - arguments or when the function takes *args and **kwargs. - - -version 1.0 final (31-October-2017): - * Added support for Python 3, including keyword-only arguments. - - * Function signatures for spies now mimic that of the spied-on functions, - allowing Python's getargspec() to work. - - -version 0.5.3 final (28-November-2015): - * Objects that evaluate to false (such as objects inheriting from dict) - can now be spied upon. - - -version 0.5.2 final (17-March-2015): - * Expose the spy when using spy_on as a context manager. - - Patch by Todd Wolfson. - - -version 0.5.1 final (2-June-2014): - * Added support for spying on unbound member functions on classes. - - -version 0.5.0 final (23-May-2013): - * First public release. diff --git a/NEWS.rst b/NEWS.rst new file mode 100644 index 0000000000000000000000000000000000000000..6b5aea3236da11552c12d81d9b7e7bd18d314fd6 --- /dev/null +++ b/NEWS.rst @@ -0,0 +1,200 @@ +============ +KGB Releases +============ + +KGB 5.0 (10-April-2020) +======================= + +* Added support for Python 3.8. + + Functions with positional-only arguments on Python 3.8 will now work + correctly, and the positional-only arguments will factor into any spy + matching. + +* Added several new unit test assertion methods: + + * ``assertHasSpy`` + * ``assertSpyCalled`` + * ``assertSpyNotCalled`` + * ``assertSpyCallCount`` + * ``assertSpyCalledWith`` + * ``assertSpyLastCalledWith`` + * ``assertSpyReturned`` + * ``assertSpyLastReturned`` + * ``assertSpyRaised`` + * ``assertSpyLastRaised`` + * ``assertSpyRaisedMessage`` + * ``assertSpyLastRaisedMessage`` + + We recommend using these for unit tests instead of checking individual + properties of calls, as they'll provide better output and help you find out + why spies have gone rogue. + +* Added support for spying on "slippery" functions. + + A slippery function is defined (by us) as a function on an object that is + actually a different function every time you access it. In other words, if + you were to just reference a slippery function as an attribute two times, + you'd end up with two separate copies of that function, each with their own + ID. + + This can happen if the "function" is actually some decorator that returns a + new function every time it's accessed. A real-world example would be the + Python Stripe module's API functions, like ``stripe.Customer.delete``. + + In previous versions of KGB, you wouldn't be able to spy on these + functions. With 5.0, you can spy on them just fine by passing + ``owner=`` when setting up the spy:: + + spy_on(myobj.slippery_func, + owner=myobj) + +* Lots of internal changes to help keep the codebase organized and + manageable, as Python support increases. + + +KGB 4.0 (30-July-2019) +====================== + +* Added ``call_original()``, which calls the original spied-on function. + + The call will not be logged, and will invoke the original behavior of + the function. This is useful when a spy simply needs to wrap another + function. + +* Updated the Python 3 support to use the modern, non-deprecated support + for inspecting and formatting function/method signatures. + + +KGB 3.0 (23-March-2019) +======================= + +* Added an argument to ``spy_on()`` for specifying an explicit owner class + for unbound methods, and warn if missing. + + Python 3.x doesn't have a real way of determining the owning class for + unbound methods, and attempting to spy on an unbound method can end up + causing a number of problems, potentially interfering with spies that + are a subclass or superclass of the spied object. + + ``spy_on()`` now accepts an ``owner=`` parameter for unbound methods in + order to explicitly specify the class. It will warn if this is missing, + providing details on what it thinks the owner is and the recommended + changes to make to the call. + +* Fixed spying on unbound methods originally defined on the parent class + of a specified or determined owning class. + +* Fixed spying on old-syle classes (those not inheriting from ``object``) + on Python 2.6 and early versions of 2.7. + + +KGB 2.0.3 (18-August-2018) +========================== + +* Added a version classifier for Python 3.7. + +* Fixed a regression on Python 2.6. + + +KGB 2.0.2 (9-July-2018) +======================= + +* Fixed spying on instances of classes with a custom ``__setattr__``. + +* Fixed spying on classmethods defined in the parent of a class. + + +KGB 2.0.1 (12-March-2018) +========================= + +* Fixed a regression in spying on classmethods. + +* Fixed copying function annotations and keyword-only defaults in Python 3. + +* Fixed problems executing some types of functions on Python 3.6. + + +KGB 2.0 (5-February-2018) +========================= + +* Added compatibility with Python 3.6. + +* Spy methods for standard functions no longer need to be accessed like:: + + func.spy.last_call + + Now you can call them the same way you could with methods:: + + func.last_call + +* The ``args`` and ``kwargs`` information recorded for a spy now correspond to + the function signature and not the way the function was called. + +* ``called_with()`` now allows providing keyword arguments to check positional + arguments by name. + +* When spying on a function fails for some reason, the error output is a + lot more helpful. + + +KGB 1.1 (5-December-2017) +========================= + +* Added ``returned()``, ``last_returned()``, ``raised()``, ``last_raised()``, + ``raised_with_message()``, and ``last_raised_with_message()`` methods to + function spies. + + See the README for how this works. + +* Added ``called_with()``, ``returned()``, ``raised()``, and + ``raised_with_message()`` to the individual ``SpyCall`` objects. + + These are accessed through ``spy.calls``, and allow for more conveniently + checking the results of specific calls in tests. + +* ``called_with()`` and ``last_called_with()`` now accept matching subsets of + arguments. + + Any number of leading positional arguments and any subset of keyword + arguments can be specified. Prior to 1.0, subsets of keyword arguments + were supported, but 1.0 temporarily made this more strict. + + This is helpful when testing function calls containing many default + arguments or when the function takes ``*args`` and ``**kwargs``. + + +KGB 1.0 (31-October-2017) +========================= + +* Added support for Python 3, including keyword-only arguments. + +* Function signatures for spies now mimic that of the spied-on functions, + allowing Python's ``getargspec()`` to work. + + +KGB 0.5.3 (28-November-2015) +============================ + +* Objects that evaluate to false (such as objects inheriting from ``dict``) + can now be spied upon. + + +KGB 0.5.2 (17-March-2015) +========================= + +* Expose the spy when using ``spy_on`` as a context manager. + + Patch by Todd Wolfson. + + +KGB 0.5.1 (2-June-2014) +======================= + +* Added support for spying on unbound member functions on classes. + + +KGB 0.5.0 (23-May-2013) +======================= + +* First public release.